[ aws . dynamodb ]

enable-kinesis-streaming-destination

Description

Starts table data replication to the specified Kinesis data stream at a timestamp chosen during the enable workflow. If this operation doesn’t return results immediately, use DescribeKinesisStreamingDestination to check if streaming to the Kinesis data stream is ACTIVE.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

--table-name (string)

The name of the DynamoDB table.

--stream-arn (string)

The ARN for a Kinesis data stream.

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

TableName -> (string)

The name of the table being modified.

StreamArn -> (string)

The ARN for the specific Kinesis data stream.

DestinationStatus -> (string)

The current status of the replication.