[ aws . dynamodb ]

describe-kinesis-streaming-destination

Description

Returns information about the status of Kinesis streaming.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-kinesis-streaming-destination
--table-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--table-name (string)

The name of the table being described.

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

TableName -> (string)

The name of the table being described.

KinesisDataStreamDestinations -> (list)

The list of replica structures for the table being described.

(structure)

Describes a Kinesis data stream destination.

StreamArn -> (string)

The ARN for a specific Kinesis data stream.

DestinationStatus -> (string)

The current status of replication.

DestinationStatusDescription -> (string)

The human-readable string that corresponds to the replica status.