Skip to content

Get Workgroup

redshiftserverless_get_workgroup R Documentation

Returns information about a specific workgroup

Description

Returns information about a specific workgroup.

Usage

redshiftserverless_get_workgroup(workgroupName)

Arguments

workgroupName

[required] The name of the workgroup to return information for.

Value

A list with the following syntax:

list(
  workgroup = 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$get_workgroup(
  workgroupName = "string"
)