Redshift / Client / deauthorize_data_share

deauthorize_data_share#

Redshift.Client.deauthorize_data_share(**kwargs)#

From a datashare producer account, removes authorization from the specified datashare.

See also: AWS API Documentation

Request Syntax

response = client.deauthorize_data_share(
    DataShareArn='string',
    ConsumerIdentifier='string'
)
Parameters:
  • DataShareArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the datashare to remove authorization from.

  • ConsumerIdentifier (string) –

    [REQUIRED]

    The identifier of the data consumer that is to have authorization removed from the datashare. This identifier is an Amazon Web Services account ID or a keyword, such as ADX.

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