Describe Data Shares For Consumer

redshift_describe_data_shares_for_consumer

R Documentation

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

Description¶

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

Usage¶

redshift_describe_data_shares_for_consumer(ConsumerArn, Status,
  MaxRecords, Marker)

Arguments¶

ConsumerArn

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

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.

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.

Marker

An optional parameter that specifies the starting point to return a set of response records. When the results of a describe_data_shares_for_consumer 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.

Value¶

A list with the following syntax:

list(
  DataShares = list(
    list(
      DataShareArn = "string",
      ProducerArn = "string",
      AllowPubliclyAccessibleConsumers = TRUE|FALSE,
      DataShareAssociations = list(
        list(
          ConsumerIdentifier = "string",
          Status = "ACTIVE"|"PENDING_AUTHORIZATION"|"AUTHORIZED"|"DEAUTHORIZED"|"REJECTED"|"AVAILABLE",
          ConsumerRegion = "string",
          CreatedDate = as.POSIXct(
            "2015-01-01"
          ),
          StatusChangeDate = as.POSIXct(
            "2015-01-01"
          ),
          ProducerAllowedWrites = TRUE|FALSE,
          ConsumerAcceptedWrites = TRUE|FALSE
        )
      ),
      ManagedBy = "string",
      DataShareType = "INTERNAL"
    )
  ),
  Marker = "string"
)

Request syntax¶

svc$describe_data_shares_for_consumer(
  ConsumerArn = "string",
  Status = "ACTIVE"|"AVAILABLE",
  MaxRecords = 123,
  Marker = "string"
)