RedshiftServerless / Client / list_managed_workgroups

list_managed_workgroups#

RedshiftServerless.Client.list_managed_workgroups(**kwargs)#

Returns information about a list of specified managed workgroups in your account.

See also: AWS API Documentation

Request Syntax

response = client.list_managed_workgroups(
    maxResults=123,
    nextToken='string',
    sourceArn='string'
)
Parameters:

  • maxResults (integer) – An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

  • nextToken (string) – If your initial ListManagedWorkgroups operation returns a nextToken, you can include the returned nextToken in following ListManagedWorkgroups operations, which returns results in the next page.

  • sourceArn (string) – The Amazon Resource Name (ARN) for the managed workgroup in the AWS Glue Data Catalog.

Return type:

dict

Returns:

Response Syntax

{
    'managedWorkgroups': [
        {
            'creationDate': datetime(2015, 1, 1),
            'managedWorkgroupId': 'string',
            'managedWorkgroupName': 'string',
            'sourceArn': 'string',
            'status': 'CREATING'|'DELETING'|'MODIFYING'|'AVAILABLE'|'NOT_AVAILABLE'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • managedWorkgroups (list) –

      The returned array of managed workgroups.

      • (dict) –

        A collection of Amazon Redshift compute resources managed by AWS Glue.

        • creationDate (datetime) –

          The creation date of the managed workgroup.

        • managedWorkgroupId (string) –

          The unique identifier of the managed workgroup.

        • managedWorkgroupName (string) –

          The name of the managed workgroup.

        • sourceArn (string) –

          The Amazon Resource Name (ARN) for the managed workgroup in the AWS Glue Data Catalog.

        • status (string) –

          The status of the managed workgroup.

    • nextToken (string) –

      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.

Exceptions

  • RedshiftServerless.Client.exceptions.InternalServerException

  • RedshiftServerless.Client.exceptions.AccessDeniedException