Amazon Redshift

2024/12/03 - Amazon Redshift - 2 new8 updated api methods

Changes  Adds support for Amazon Redshift RegisterNamespace and DeregisterNamespace APIs to share data to AWS Glue Data Catalog.

DeregisterNamespace (new) Link ¶

Deregisters a cluster or serverless namespace from the Amazon Web Services Glue Data Catalog.

See also: AWS API Documentation

Request Syntax

client.deregister_namespace(
    NamespaceIdentifier={
        'ServerlessIdentifier': {
            'NamespaceIdentifier': 'string',
            'WorkgroupIdentifier': 'string'
        },
        'ProvisionedIdentifier': {
            'ClusterIdentifier': 'string'
        }
    },
    ConsumerIdentifiers=[
        'string',
    ]
)
type NamespaceIdentifier:

dict

param NamespaceIdentifier:

[REQUIRED]

The unique identifier of the cluster or serverless namespace that you want to deregister.

  • ServerlessIdentifier (dict) --

    The identifier for a serverless namespace.

    • NamespaceIdentifier (string) -- [REQUIRED]

      The unique identifier for the serverless namespace.

    • WorkgroupIdentifier (string) -- [REQUIRED]

      The unique identifier for the workgroup associated with the serverless namespace.

  • ProvisionedIdentifier (dict) --

    The identifier for a provisioned cluster.

    • ClusterIdentifier (string) -- [REQUIRED]

      The unique identifier for the provisioned cluster.

type ConsumerIdentifiers:

list

param ConsumerIdentifiers:

[REQUIRED]

An array containing the ID of the consumer account that you want to deregister the cluster or serverless namespace from.

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'Status': 'Registering'|'Deregistering'
}

Response Structure

  • (dict) --

    • Status (string) --

      The registration status of the cluster or serverless namespace.

RegisterNamespace (new) Link ¶

Registers a cluster or serverless namespace to the Amazon Web Services Glue Data Catalog.

See also: AWS API Documentation

Request Syntax

client.register_namespace(
    NamespaceIdentifier={
        'ServerlessIdentifier': {
            'NamespaceIdentifier': 'string',
            'WorkgroupIdentifier': 'string'
        },
        'ProvisionedIdentifier': {
            'ClusterIdentifier': 'string'
        }
    },
    ConsumerIdentifiers=[
        'string',
    ]
)
type NamespaceIdentifier:

dict

param NamespaceIdentifier:

[REQUIRED]

The unique identifier of the cluster or serverless namespace that you want to register.

  • ServerlessIdentifier (dict) --

    The identifier for a serverless namespace.

    • NamespaceIdentifier (string) -- [REQUIRED]

      The unique identifier for the serverless namespace.

    • WorkgroupIdentifier (string) -- [REQUIRED]

      The unique identifier for the workgroup associated with the serverless namespace.

  • ProvisionedIdentifier (dict) --

    The identifier for a provisioned cluster.

    • ClusterIdentifier (string) -- [REQUIRED]

      The unique identifier for the provisioned cluster.

type ConsumerIdentifiers:

list

param ConsumerIdentifiers:

[REQUIRED]

An array containing the ID of the consumer account that you want to register the namespace to.

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'Status': 'Registering'|'Deregistering'
}

Response Structure

  • (dict) --

    • Status (string) --

      The registration status of the cluster or serverless namespace.

AssociateDataShareConsumer (updated) Link ¶
Changes (response)
{'DataShareType': 'INTERNAL'}

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

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

string

param DataShareArn:

[REQUIRED]

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

type AssociateEntireAccount:

boolean

param AssociateEntireAccount:

A value that specifies whether the datashare is associated with the entire account.

type ConsumerArn:

string

param ConsumerArn:

The Amazon Resource Name (ARN) of the consumer namespace associated with the datashare.

type ConsumerRegion:

string

param ConsumerRegion:

From a datashare consumer account, associates a datashare with all existing and future namespaces in the specified Amazon Web Services Region.

type AllowWrites:

boolean

param AllowWrites:

If set to true, allows write operations for a datashare.

rtype:

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

Response Structure

  • (dict) --

    • DataShareArn (string) --

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

    • ProducerArn (string) --

      The Amazon Resource Name (ARN) of the producer namespace.

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

    • DataShareType (string) --

      The type of the datashare created by RegisterNamespace.

AuthorizeDataShare (updated) Link ¶
Changes (response)
{'DataShareType': 'INTERNAL'}

From a data producer account, authorizes the sharing of a datashare with one or more consumer accounts or managing entities. To authorize a datashare for a data consumer, the producer account must have the correct access permissions.

See also: AWS API Documentation

Request Syntax

client.authorize_data_share(
    DataShareArn='string',
    ConsumerIdentifier='string',
    AllowWrites=True|False
)
type DataShareArn:

string

param DataShareArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the datashare namespace that producers are to authorize sharing for.

type ConsumerIdentifier:

string

param ConsumerIdentifier:

[REQUIRED]

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

type AllowWrites:

boolean

param AllowWrites:

If set to true, allows write operations for a datashare.

rtype:

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

Response Structure

  • (dict) --

    • DataShareArn (string) --

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

    • ProducerArn (string) --

      The Amazon Resource Name (ARN) of the producer namespace.

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

    • DataShareType (string) --

      The type of the datashare created by RegisterNamespace.

DeauthorizeDataShare (updated) Link ¶
Changes (response)
{'DataShareType': 'INTERNAL'}

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

See also: AWS API Documentation

Request Syntax

client.deauthorize_data_share(
    DataShareArn='string',
    ConsumerIdentifier='string'
)
type DataShareArn:

string

param DataShareArn:

[REQUIRED]

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

type ConsumerIdentifier:

string

param ConsumerIdentifier:

[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.

rtype:

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

Response Structure

  • (dict) --

    • DataShareArn (string) --

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

    • ProducerArn (string) --

      The Amazon Resource Name (ARN) of the producer namespace.

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

    • DataShareType (string) --

      The type of the datashare created by RegisterNamespace.

DescribeDataShares (updated) Link ¶
Changes (response)
{'DataShares': {'DataShareType': 'INTERNAL'}}

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

See also: AWS API Documentation

Request Syntax

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

string

param DataShareArn:

The Amazon resource name (ARN) of the datashare to describe details of.

type MaxRecords:

integer

param MaxRecords:

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.

type Marker:

string

param Marker:

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.

rtype:

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',
            'DataShareType': 'INTERNAL'
        },
    ],
    'Marker': 'string'
}

Response Structure

  • (dict) --

    • DataShares (list) --

      The results returned from describing datashares.

      • (dict) --

        • DataShareArn (string) --

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

        • ProducerArn (string) --

          The Amazon Resource Name (ARN) of the producer namespace.

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

        • DataShareType (string) --

          The type of the datashare created by RegisterNamespace.

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

DescribeDataSharesForConsumer (updated) Link ¶
Changes (response)
{'DataShares': {'DataShareType': 'INTERNAL'}}

Returns a list of datashares where the account identifier being called is a consumer account identifier.

See also: AWS API Documentation

Request Syntax

client.describe_data_shares_for_consumer(
    ConsumerArn='string',
    Status='ACTIVE'|'AVAILABLE',
    MaxRecords=123,
    Marker='string'
)
type ConsumerArn:

string

param ConsumerArn:

The Amazon Resource Name (ARN) of the consumer namespace that returns in the list of datashares.

type Status:

string

param Status:

An identifier giving the status of a datashare in the consumer cluster. If this field is specified, Amazon Redshift returns the list of datashares that have the specified status.

type MaxRecords:

integer

param MaxRecords:

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.

type Marker:

string

param Marker:

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataSharesForConsumer 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.

rtype:

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',
            'DataShareType': 'INTERNAL'
        },
    ],
    'Marker': 'string'
}

Response Structure

  • (dict) --

    • DataShares (list) --

      Shows the results of datashares available for consumers.

      • (dict) --

        • DataShareArn (string) --

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

        • ProducerArn (string) --

          The Amazon Resource Name (ARN) of the producer namespace.

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

        • DataShareType (string) --

          The type of the datashare created by RegisterNamespace.

    • Marker (string) --

      An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataSharesForConsumer 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.

DescribeDataSharesForProducer (updated) Link ¶
Changes (response)
{'DataShares': {'DataShareType': 'INTERNAL'}}

Returns a list of datashares when the account identifier being called is a producer account identifier.

See also: AWS API Documentation

Request Syntax

client.describe_data_shares_for_producer(
    ProducerArn='string',
    Status='ACTIVE'|'AUTHORIZED'|'PENDING_AUTHORIZATION'|'DEAUTHORIZED'|'REJECTED',
    MaxRecords=123,
    Marker='string'
)
type ProducerArn:

string

param ProducerArn:

The Amazon Resource Name (ARN) of the producer namespace that returns in the list of datashares.

type Status:

string

param Status:

An identifier giving the status of a datashare in the producer. If this field is specified, Amazon Redshift returns the list of datashares that have the specified status.

type MaxRecords:

integer

param MaxRecords:

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.

type Marker:

string

param Marker:

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataSharesForProducer 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.

rtype:

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',
            'DataShareType': 'INTERNAL'
        },
    ],
    'Marker': 'string'
}

Response Structure

  • (dict) --

    • DataShares (list) --

      Shows the results of datashares available for producers.

      • (dict) --

        • DataShareArn (string) --

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

        • ProducerArn (string) --

          The Amazon Resource Name (ARN) of the producer namespace.

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

        • DataShareType (string) --

          The type of the datashare created by RegisterNamespace.

    • Marker (string) --

      An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataSharesForProducer 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.

DisassociateDataShareConsumer (updated) Link ¶
Changes (response)
{'DataShareType': 'INTERNAL'}

From a datashare consumer account, remove association for the specified datashare.

See also: AWS API Documentation

Request Syntax

client.disassociate_data_share_consumer(
    DataShareArn='string',
    DisassociateEntireAccount=True|False,
    ConsumerArn='string',
    ConsumerRegion='string'
)
type DataShareArn:

string

param DataShareArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the datashare to remove association for.

type DisassociateEntireAccount:

boolean

param DisassociateEntireAccount:

A value that specifies whether association for the datashare is removed from the entire account.

type ConsumerArn:

string

param ConsumerArn:

The Amazon Resource Name (ARN) of the consumer namespace that association for the datashare is removed from.

type ConsumerRegion:

string

param ConsumerRegion:

From a datashare consumer account, removes association of a datashare from all the existing and future namespaces in the specified Amazon Web Services Region.

rtype:

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

Response Structure

  • (dict) --

    • DataShareArn (string) --

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

    • ProducerArn (string) --

      The Amazon Resource Name (ARN) of the producer namespace.

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

    • DataShareType (string) --

      The type of the datashare created by RegisterNamespace.

RejectDataShare (updated) Link ¶
Changes (response)
{'DataShareType': 'INTERNAL'}

From a datashare consumer account, rejects the specified datashare.

See also: AWS API Documentation

Request Syntax

client.reject_data_share(
    DataShareArn='string'
)
type DataShareArn:

string

param DataShareArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the datashare to reject.

rtype:

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

Response Structure

  • (dict) --

    • DataShareArn (string) --

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

    • ProducerArn (string) --

      The Amazon Resource Name (ARN) of the producer namespace.

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

    • DataShareType (string) --

      The type of the datashare created by RegisterNamespace.