Redshift / Client / describe_data_shares

describe_data_shares

Redshift.Client.describe_data_shares(**kwargs)

Shows the status of any inbound or outbound datashares available in the specified account.

See also: AWS API Documentation

Request Syntax

response = client.describe_data_shares(
    DataShareArn='string',
    MaxRecords=123,
    Marker='string'
)

Parameters:

• DataShareArn (string) – The identifier of the datashare to describe details of.

• MaxRecords (integer) – The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

• Marker (string) – An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataShares request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

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),
                    'ProducerAllowedWrites': True|False,
                    'ConsumerAcceptedWrites': True|False
                },
            ],
            'ManagedBy': 'string'
        },
    ],
    'Marker': '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.

          • ProducerAllowedWrites (boolean) –

            Specifies whether write operations were allowed during data share authorization.

          • ConsumerAcceptedWrites (boolean) –

            Specifies whether write operations were allowed during data share association.

      • ManagedBy (string) –

        The identifier of a datashare to show its managing entity.

  • Marker (string) –

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataShares request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Exceptions

• Redshift.Client.exceptions.InvalidDataShareFault