Skip to content

enable_kinesis_streaming_destination

Operation

enable_kinesis_streaming_destination

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
request EnableKinesisStreamingDestinationInput | EnableKinesisStreamingDestinationInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[EnableKinesisStreamingDestinationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
EnableKinesisStreamingDestinationOutput

An instance of EnableKinesisStreamingDestinationOutput.

enable_kinesis_streaming_destination async

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
request EnableKinesisStreamingDestinationInput | EnableKinesisStreamingDestinationInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[EnableKinesisStreamingDestinationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
EnableKinesisStreamingDestinationOutput

An instance of EnableKinesisStreamingDestinationOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

EnableKinesisStreamingDestinationInputDict

Bases: TypedDict

Dictionary form of EnableKinesisStreamingDestinationInput.

Attributes

enable_kinesis_streaming_configuration instance-attribute
enable_kinesis_streaming_configuration: EnableKinesisStreamingConfiguration | EnableKinesisStreamingConfigurationDict | None

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

stream_arn instance-attribute
stream_arn: Required[str]

The ARN for a Kinesis data stream.

table_name instance-attribute
table_name: Required[str]

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

EnableKinesisStreamingDestinationInput dataclass

Bases: _SerdeShape

Dataclass for EnableKinesisStreamingDestinationInput structure.

Attributes

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

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

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

The ARN for a Kinesis data stream.

table_name class-attribute instance-attribute
table_name: str | 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

Bases: _SerdeShape

Dataclass for EnableKinesisStreamingDestinationOutput structure.

Attributes

destination_status class-attribute instance-attribute
destination_status: str | None = ...

The current status of the replication.

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

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

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

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

The ARN for the specific Kinesis data stream.

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

The name of the table being modified.