DynamoDB / Client / enable_kinesis_streaming_destination

enable_kinesis_streaming_destination#

DynamoDB.Client.enable_kinesis_streaming_destination(**kwargs)#

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

Request Syntax

response = client.enable_kinesis_streaming_destination(
    TableName='string',
    StreamArn='string',
    EnableKinesisStreamingConfiguration={
        'ApproximateCreationDateTimePrecision': 'MILLISECOND'|'MICROSECOND'
    }
)
Parameters:

  • TableName (string) –

    [REQUIRED]

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

  • StreamArn (string) –

    [REQUIRED]

    The ARN for a Kinesis data stream.

  • EnableKinesisStreamingConfiguration (dict) –

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

    • ApproximateCreationDateTimePrecision (string) –

      Toggle for the precision of Kinesis data stream timestamp. The values are either MILLISECOND or MICROSECOND.

Return type:

dict

Returns:

Response Syntax

{
    'TableName': 'string',
    'StreamArn': 'string',
    'DestinationStatus': 'ENABLING'|'ACTIVE'|'DISABLING'|'DISABLED'|'ENABLE_FAILED'|'UPDATING',
    'EnableKinesisStreamingConfiguration': {
        'ApproximateCreationDateTimePrecision': 'MILLISECOND'|'MICROSECOND'
    }
}

Response Structure

  • (dict) –

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

    • EnableKinesisStreamingConfiguration (dict) –

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

      • ApproximateCreationDateTimePrecision (string) –

        Toggle for the precision of Kinesis data stream timestamp. The values are either MILLISECOND or MICROSECOND.

Exceptions