List Workgroups

redshiftserverless_list_workgroups

R Documentation

Returns information about a list of specified workgroups

Description

Returns information about a list of specified workgroups.

Usage

redshiftserverless_list_workgroups(maxResults, nextToken, ownerAccount)

Arguments

maxResults

An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

nextToken

If your initial ListWorkgroups operation returns a nextToken, you can include the returned nextToken in following ListNamespaces operations, which returns results in the next page.

ownerAccount

The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup.

Value

A list with the following syntax:

list(
  nextToken = "string",
  workgroups = list(
    list(
      baseCapacity = 123,
      configParameters = list(
        list(
          parameterKey = "string",
          parameterValue = "string"
        )
      ),
      creationDate = as.POSIXct(
        "2015-01-01"
      ),
      crossAccountVpcs = list(
        "string"
      ),
      customDomainCertificateArn = "string",
      customDomainCertificateExpiryTime = as.POSIXct(
        "2015-01-01"
      ),
      customDomainName = "string",
      endpoint = list(
        address = "string",
        port = 123,
        vpcEndpoints = list(
          list(
            networkInterfaces = list(
              list(
                availabilityZone = "string",
                ipv6Address = "string",
                networkInterfaceId = "string",
                privateIpAddress = "string",
                subnetId = "string"
              )
            ),
            vpcEndpointId = "string",
            vpcId = "string"
          )
        )
      ),
      enhancedVpcRouting = TRUE|FALSE,
      ipAddressType = "string",
      maxCapacity = 123,
      namespaceName = "string",
      patchVersion = "string",
      port = 123,
      publiclyAccessible = TRUE|FALSE,
      securityGroupIds = list(
        "string"
      ),
      status = "CREATING"|"AVAILABLE"|"MODIFYING"|"DELETING",
      subnetIds = list(
        "string"
      ),
      workgroupArn = "string",
      workgroupId = "string",
      workgroupName = "string",
      workgroupVersion = "string"
    )
  )
)

Request syntax

svc$list_workgroups(
  maxResults = 123,
  nextToken = "string",
  ownerAccount = "string"
)