Redshift / Paginator / DescribeDataShares

DescribeDataShares#

class Redshift.Paginator.DescribeDataShares#
paginator = client.get_paginator('describe_data_shares')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from Redshift.Client.describe_data_shares().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DataShareArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • DataShareArn (string) – The identifier of the datashare to describe details of.

  • 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

{
    'DataShares': [
        {
            'DataShareArn': 'string',
            'ProducerArn': 'string',
            'AllowPubliclyAccessibleConsumers': True|False,
            'DataShareAssociations': [
                {
                    'ConsumerIdentifier': 'string',
                    'Status': 'ACTIVE'|'PENDING_AUTHORIZATION'|'AUTHORIZED'|'DEAUTHORIZED'|'REJECTED'|'AVAILABLE',
                    'ConsumerRegion': 'string',
                    'CreatedDate': datetime(2015, 1, 1),
                    'StatusChangeDate': datetime(2015, 1, 1)
                },
            ],
            'ManagedBy': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • DataShares (list) –

      The results returned from describing datashares.

      • (dict) –

        • DataShareArn (string) –

          An Amazon Resource Name (ARN) that references the datashare that is owned by a specific namespace of the producer cluster. A datashare ARN is in the arn:aws:redshift:{region}:{account-id}:{datashare}:{namespace-guid}/{datashare-name} format.

        • ProducerArn (string) –

          The Amazon Resource Name (ARN) of the producer.

        • AllowPubliclyAccessibleConsumers (boolean) –

          A value that specifies whether the datashare can be shared to a publicly accessible cluster.

        • DataShareAssociations (list) –

          A value that specifies when the datashare has an association between producer and data consumers.

          • (dict) –

            The association of a datashare from a producer account with a data consumer.

            • ConsumerIdentifier (string) –

              The name of the consumer accounts that have an association with a producer datashare.

            • Status (string) –

              The status of the datashare that is associated.

            • ConsumerRegion (string) –

              The Amazon Web Services Region of the consumer accounts that have an association with a producer datashare.

            • CreatedDate (datetime) –

              The creation date of the datashare that is associated.

            • StatusChangeDate (datetime) –

              The status change data of the datashare that is associated.

        • ManagedBy (string) –

          The identifier of a datashare to show its managing entity.

    • NextToken (string) –

      A token to resume pagination.