describe_kinesis_streaming_destination

describe_kinesis_streaming_destination(**kwargs)

Returns information about the status of Kinesis streaming.

See also: AWS API Documentation

Request Syntax

response = client.describe_kinesis_streaming_destination(
    TableName='string'
)
Parameters
TableName (string) --

[REQUIRED]

The name of the table being described.

Return type
dict
Returns
Response Syntax
{
    'TableName': 'string',
    'KinesisDataStreamDestinations': [
        {
            'StreamArn': 'string',
            'DestinationStatus': 'ENABLING'|'ACTIVE'|'DISABLING'|'DISABLED'|'ENABLE_FAILED',
            'DestinationStatusDescription': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • TableName (string) --

      The name of the table being described.

    • KinesisDataStreamDestinations (list) --

      The list of replica structures for the table being described.

      • (dict) --

        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.

Exceptions

  • DynamoDB.Client.exceptions.ResourceNotFoundException
  • DynamoDB.Client.exceptions.InternalServerError