RedshiftServerless / Paginator / ListManagedWorkgroups

ListManagedWorkgroups#

class RedshiftServerless.Paginator.ListManagedWorkgroups#
paginator = client.get_paginator('list_managed_workgroups')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from RedshiftServerless.Client.list_managed_workgroups().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    sourceArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • sourceArn (string) – The Amazon Resource Name (ARN) for the managed workgroup in the AWS Glue Data Catalog.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

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) –

      A token to resume pagination.