associate_data_share_consumer

associate_data_share_consumer(**kwargs)

From a datashare consumer account, associates a datashare with the account (AssociateEntireAccount) or the specified namespace (ConsumerArn). If you make this association, the consumer can consume the datashare.

See also: AWS API Documentation

Request Syntax

response = client.associate_data_share_consumer(
    DataShareArn='string',
    AssociateEntireAccount=True|False,
    ConsumerArn='string',
    ConsumerRegion='string'
)

Parameters

• DataShareArn (string) --

  [REQUIRED]

  The Amazon Resource Name (ARN) of the datashare that the consumer is to use with the account or the namespace.

• AssociateEntireAccount (boolean) -- A value that specifies whether the datashare is associated with the entire account.
• ConsumerArn (string) -- The Amazon Resource Name (ARN) of the consumer that is associated with the datashare.
• ConsumerRegion (string) -- From a datashare consumer account, associates a datashare with all existing and future namespaces in the specified Amazon Web Services Region.

Return type

dict

Returns

Response Syntax

{
    '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'
}

Response Structure

• (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.

Exceptions

• Redshift.Client.exceptions.InvalidDataShareFault
• Redshift.Client.exceptions.InvalidNamespaceFault