GetWorkgroup

Returns information about a specific workgroup.

Request Syntax

{
   "workgroupName": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Response Syntax

{
   "workgroup": { 
      "baseCapacity": number,
      "configParameters": [ 
         { 
            "parameterKey": "string",
            "parameterValue": "string"
         }
      ],
      "creationDate": "string",
      "crossAccountVpcs": [ "string" ],
      "customDomainCertificateArn": "string",
      "customDomainCertificateExpiryTime": "string",
      "customDomainName": "string",
      "endpoint": { 
         "address": "string",
         "port": number,
         "vpcEndpoints": [ 
            { 
               "networkInterfaces": [ 
                  { 
                     "availabilityZone": "string",
                     "ipv6Address": "string",
                     "networkInterfaceId": "string",
                     "privateIpAddress": "string",
                     "subnetId": "string"
                  }
               ],
               "vpcEndpointId": "string",
               "vpcId": "string"
            }
         ]
      },
      "enhancedVpcRouting": boolean,
      "ipAddressType": "string",
      "maxCapacity": number,
      "namespaceName": "string",
      "patchVersion": "string",
      "pendingTrackName": "string",
      "port": number,
      "pricePerformanceTarget": { 
         "level": number,
         "status": "string"
      },
      "publiclyAccessible": boolean,
      "securityGroupIds": [ "string" ],
      "status": "string",
      "subnetIds": [ "string" ],
      "trackName": "string",
      "workgroupArn": "string",
      "workgroupId": "string",
      "workgroupName": "string",
      "workgroupVersion": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Errors

For information about the errors that are common to all actions, see Common Errors.

Examples

Example

This example illustrates one usage of GetWorkgroup.

Sample Request

aws redshift-serverless get-workgroup 
--workgroup-name test-wg
--region us-east-1

Sample Response

{
  "workgroup": {
    "workgroupId": "875083e4-50b5-4ad7-bd8b-b01beb74d912",
    "workgroupArn": "arn:aws:redshift-serverless:us-east-1:012345678901:workgroup/875083e4-50b5-4ad7-bd8b-b01beb74d912",
    "workgroupName": "test-wg",
    "namespaceName": "test-ns",
    "baseCapacity": 32,
    "enhancedVpcRouting": false,
    ...
    "ipAddressType": "ipv4",
    "trackName": "current",
    "pendingTrackName": "trailing"
  }
}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: