ListWorkgroups - Amazon Redshift Serverless


Returns information about a list of specified workgroups.

Request Syntax

{ "maxResults": number, "nextToken": "string", "ownerAccount": "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.


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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No


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.

Type: String

Required: No


The owner AWS account for the Amazon Redshift Serverless workgroup.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 12.

Pattern: (\d{12})

Required: No

Response Syntax

{ "nextToken": "string", "workgroups": [ { "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", "networkInterfaceId": "string", "privateIpAddress": "string", "subnetId": "string" } ], "vpcEndpointId": "string", "vpcId": "string" } ] }, "enhancedVpcRouting": boolean, "maxCapacity": number, "namespaceName": "string", "patchVersion": "string", "port": number, "publiclyAccessible": boolean, "securityGroupIds": [ "string" ], "status": "string", "subnetIds": [ "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.


If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token.

Type: String


The returned array of workgroups.

Type: Array of Workgroup objects


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


The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500


The input failed to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

See Also

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