DescribeKinesisStreamingDestinationCommand

Suggest an Edit

Returns information about the status of Kinesis streaming.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DynamoDBClient, DescribeKinesisStreamingDestinationCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
// const { DynamoDBClient, DescribeKinesisStreamingDestinationCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
const client = new DynamoDBClient(config);
const input = { // DescribeKinesisStreamingDestinationInput
  TableName: "STRING_VALUE", // required
};
const command = new DescribeKinesisStreamingDestinationCommand(input);
const response = await client.send(command);
// { // DescribeKinesisStreamingDestinationOutput
//   TableName: "STRING_VALUE",
//   KinesisDataStreamDestinations: [ // KinesisDataStreamDestinations
//     { // KinesisDataStreamDestination
//       StreamArn: "STRING_VALUE",
//       DestinationStatus: "ENABLING" || "ACTIVE" || "DISABLING" || "DISABLED" || "ENABLE_FAILED" || "UPDATING",
//       DestinationStatusDescription: "STRING_VALUE",
//       ApproximateCreationDateTimePrecision: "MILLISECOND" || "MICROSECOND",
//     },
//   ],
// };

DescribeKinesisStreamingDestinationCommand Input

See DescribeKinesisStreamingDestinationCommandInput for more details

Parameter
Type
Description
TableName
Required
string | undefined

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

DescribeKinesisStreamingDestinationCommand Output

See DescribeKinesisStreamingDestinationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
KinesisDataStreamDestinations
KinesisDataStreamDestination[] | undefined

The list of replica structures for the table being described.

TableName
string | undefined

The name of the table being described.

Throws

Name
Fault
Details
InternalServerError
server

An error occurred on the server side.

InvalidEndpointException
client
ResourceNotFoundException
client

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

DynamoDBServiceException
Base exception class for all service exceptions from DynamoDB service.