[ aws . redshift ]

describe-data-shares-for-producer

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-data-shares-for-producer
[--producer-arn <value>]
[--status <value>]
[--max-records <value>]
[--marker <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--producer-arn (string)

The Amazon Resource Name (ARN) of the producer 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.

Possible values:

• ACTIVE

• AUTHORIZED

• PENDING_AUTHORIZATION

• DEAUTHORIZED

• REJECTED

--max-records (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.

--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 , AWS 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.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

DataShares -> (list)

Shows the results of datashares available for producers.

(structure)

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 a producer and data consumers.

(structure)

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.

CreatedDate -> (timestamp)

The creation date of the datashare that is associated.

StatusChangeDate -> (timestamp)

The status change data of the datashare that is associated.

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 , AWS 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.