AssociateDataShareConsumer - Amazon Redshift

AssociateDataShareConsumer

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.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

DataShareArn

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

Type: String

Length Constraints: Maximum length of 2147483647.

Required: Yes

AssociateEntireAccount

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

Type: Boolean

Required: No

ConsumerArn

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

Type: String

Length Constraints: Maximum length of 2147483647.

Required: No

Response Elements

The following elements are returned by the service.

AllowPubliclyAccessibleConsumers

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

Type: Boolean

DataShareArn

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.

Type: String

Length Constraints: Maximum length of 2147483647.

DataShareAssociations.member.N

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

Type: Array of DataShareAssociation objects

ProducerArn

The Amazon Resource Name (ARN) of the producer.

Type: String

Length Constraints: Maximum length of 2147483647.

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidDataShareFault

There is an error with the datashare.

HTTP Status Code: 400

InvalidNamespaceFault

The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of AssociateDataShareConsumer.

Sample Request

AssociateDataShareConsumer&AssociateEntireAccount=true&DataShareArn=arn%3Aaws%3Aredshift%3Aus-east-1%3A827630067164%3Adatashare%3Aa1c54ed4-8323-4d14-b5dd-927cb596dc0e%2Ftestshare&Version=2012-12-01

Sample Response

<AssociateDataShareConsumerResponse xmlns="http://redshift.amazonaws.com/doc/2012-12-01/"> <AssociateDataShareConsumerResult> <ProducerNamespaceArn>arn:aws:redshift:us-east-1:827630067164:namespace:a1c54ed4-8323-4d14-b5dd-927cb596dc0e</ProducerNamespaceArn> <AllowPubliclyAccessibleConsumers>false</AllowPubliclyAccessibleConsumers> <DataShareArn>arn:aws:redshift:us-east-1:827630067164:datashare:a1c54ed4-8323-4d14-b5dd-927cb596dc0e/testshare</DataShareArn> <DataShareAssociations> <member> <StatusChangeDate>2021-01-11T23:39:25.485605</StatusChangeDate> <ConsumerIdentifier>827630067164</ConsumerIdentifier> <CreatedDate>2021-01-11T22:12:23.038612</CreatedDate> <Status>ACTIVE</Status> </member> </DataShareAssociations> </AssociateDataShareConsumerResult> <ResponseMetadata> <RequestId>c125d0e3-72de-4938-a919-e6a0c3f8489d</RequestId> </ResponseMetadata> </AssociateDataShareConsumerResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: