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.
Type: String
Length Constraints: Maximum length of 2147483647.
Required: Yes
- AllowWrites
-
If set to true, allows write operations for a datashare.
Type: Boolean
Required: No
- 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 namespace associated with the datashare.
Type: String
Length Constraints: Maximum length of 2147483647.
Required: No
- ConsumerRegion
-
From a datashare consumer account, associates a datashare with all existing and future namespaces in the specified AWS Region.
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
-
The Amazon Resource Name (ARN) of the datashare that the consumer is to use.
Type: String
Length Constraints: Maximum length of 2147483647.
- DataShareAssociations.member.N
-
A value that specifies when the datashare has an association between producer and data consumers.
Type: Array of DataShareAssociation objects
- DataShareType
-
The type of the datashare created by RegisterNamespace.
Type: String
Valid Values:
INTERNAL - ManagedBy
-
The identifier of a datashare to show its managing entity.
Type: String
Length Constraints: Maximum length of 2147483647.
- ProducerArn
-
The Amazon Resource Name (ARN) of the producer namespace.
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-01Sample 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:
