data_shares_for_producers
Creates, updates, deletes, gets or lists a data_shares_for_producers resource.
Overview
| Name | data_shares_for_producers |
| Type | Resource |
| Id | aws.redshift.data_shares_for_producers |
Fields
The following fields are returned by SELECT queries:
- describe_data_shares_for_producer
| Name | Datatype | Description |
|---|---|---|
allow_publicly_accessible_consumers | boolean | A value that specifies whether the datashare can be shared to a publicly accessible cluster. |
data_share_arn | string | The Amazon Resource Name (ARN) of the datashare that the consumer is to use. |
data_share_associations | string | A value that specifies when the datashare has an association between producer and data consumers. |
data_share_type | string | The type of the datashare created by RegisterNamespace. |
managed_by | string | The identifier of a datashare to show its managing entity. |
producer_arn | string | The Amazon Resource Name (ARN) of the producer namespace. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_data_shares_for_producer | select | region | ProducerArn, Status, MaxRecords, Marker | Returns a list of datashares when the account identifier being called is a producer account identifier. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
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. |
MaxRecords | integer | 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. |
ProducerArn | string | The Amazon Resource Name (ARN) of the producer namespace that returns in the list of datashares. |
Status | string | 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. |
SELECT examples
- describe_data_shares_for_producer
Returns a list of datashares when the account identifier being called is a producer account identifier.
SELECT
allow_publicly_accessible_consumers,
data_share_arn,
data_share_associations,
data_share_type,
managed_by,
producer_arn
FROM aws.redshift.data_shares_for_producers
WHERE region = '{{ region }}' -- required
AND ProducerArn = '{{ ProducerArn }}'
AND Status = '{{ Status }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
;