DescribeDataSharesForConsumer - Amazon Redshift

DescribeDataSharesForConsumer

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

Request Parameters

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

ConsumerArn

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

Type: String

Length Constraints: Maximum length of 2147483647.

Required: No

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

Type: String

Length Constraints: Maximum length of 2147483647.

Required: No

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: Integer

Required: No

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: String

Valid Values: ACTIVE | AVAILABLE

Required: No

Response Elements

The following elements are returned by the service.

DataShares.member.N

Shows the results of datashares available for consumers.

Type: Array of DataShare objects

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

Type: String

Length Constraints: Maximum length of 2147483647.

Errors

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

InvalidNamespaceFault

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

HTTP Status Code: 400

See Also

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