Skip to content

Describe Data Shares

redshift_describe_data_shares R Documentation

Shows the status of any inbound or outbound datashares available in the specified account

Description

Shows the status of any inbound or outbound datashares available in the specified account.

Usage

redshift_describe_data_shares(DataShareArn, MaxRecords, Marker)

Arguments

DataShareArn

The Amazon resource name (ARN) of the datashare to describe details of.

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 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"
    )
  ),
  Marker = "string"
)

Request syntax

svc$describe_data_shares(
  DataShareArn = "string",
  MaxRecords = 123,
  Marker = "string"
)