Skip to content

DynamoDB  >  Operations  >  enable_kinesis_streaming_destination

enable_kinesis_streaming_destination

Operation

enable_kinesis_streaming_destination async

enable_kinesis_streaming_destination(input: EnableKinesisStreamingDestinationInput, plugins: list[Plugin] | None = None) -> EnableKinesisStreamingDestinationOutput

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.

Parameters:

Name Type Description Default
input EnableKinesisStreamingDestinationInput

An instance of EnableKinesisStreamingDestinationInput.

required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
EnableKinesisStreamingDestinationOutput

An instance of EnableKinesisStreamingDestinationOutput.

Input

EnableKinesisStreamingDestinationInput dataclass

Dataclass for EnableKinesisStreamingDestinationInput structure.

Attributes

enable_kinesis_streaming_configuration class-attribute instance-attribute
enable_kinesis_streaming_configuration: EnableKinesisStreamingConfiguration | None = None

The source for the Kinesis streaming information that is being enabled.

stream_arn class-attribute instance-attribute
stream_arn: str | None = None

The ARN for a Kinesis data stream.

table_name class-attribute instance-attribute
table_name: str | None = None

The name of the DynamoDB table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

Output

EnableKinesisStreamingDestinationOutput dataclass

Dataclass for EnableKinesisStreamingDestinationOutput structure.

Attributes

destination_status class-attribute instance-attribute
destination_status: DestinationStatus | None = None

The current status of the replication.

enable_kinesis_streaming_configuration class-attribute instance-attribute
enable_kinesis_streaming_configuration: EnableKinesisStreamingConfiguration | None = None

The destination for the Kinesis streaming information that is being enabled.

stream_arn class-attribute instance-attribute
stream_arn: str | None = None

The ARN for the specific Kinesis data stream.

table_name class-attribute instance-attribute
table_name: str | None = None

The name of the table being modified.