EnableKinesisStreamingDestinationCommand

Suggest an Edit

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.

Example Syntax

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

import { DynamoDBClient, EnableKinesisStreamingDestinationCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import
// const { DynamoDBClient, EnableKinesisStreamingDestinationCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import
const client = new DynamoDBClient(config);
const input = { // KinesisStreamingDestinationInput
  TableName: "STRING_VALUE", // required
  StreamArn: "STRING_VALUE", // required
  EnableKinesisStreamingConfiguration: { // EnableKinesisStreamingConfiguration
    ApproximateCreationDateTimePrecision: "MILLISECOND" || "MICROSECOND",
  },
};
const command = new EnableKinesisStreamingDestinationCommand(input);
const response = await client.send(command);
// { // KinesisStreamingDestinationOutput
//   TableName: "STRING_VALUE",
//   StreamArn: "STRING_VALUE",
//   DestinationStatus: "ENABLING" || "ACTIVE" || "DISABLING" || "DISABLED" || "ENABLE_FAILED" || "UPDATING",
//   EnableKinesisStreamingConfiguration: { // EnableKinesisStreamingConfiguration
//     ApproximateCreationDateTimePrecision: "MILLISECOND" || "MICROSECOND",
//   },
// };

EnableKinesisStreamingDestinationCommand Input

See EnableKinesisStreamingDestinationCommandInput for more details

Parameter
Type
Description
StreamArn
Required
string | undefined

The ARN for a Kinesis data stream.

TableName
Required
string | undefined

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

EnableKinesisStreamingConfiguration
EnableKinesisStreamingConfiguration | undefined

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

EnableKinesisStreamingDestinationCommand Output

See EnableKinesisStreamingDestinationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
DestinationStatus
DestinationStatus | undefined

The current status of the replication.

EnableKinesisStreamingConfiguration
EnableKinesisStreamingConfiguration | undefined

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

StreamArn
string | undefined

The ARN for the specific Kinesis data stream.

TableName
string | undefined

The name of the table being modified.

Throws

Name
Fault
Details
InternalServerError
server

An error occurred on the server side.

InvalidEndpointException
client
LimitExceededException
client

There is no limit to the number of daily on-demand backups that can be taken.

For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.

When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.

There is a soft account quota of 2,500 tables.

GetRecords was called with a value of more than 1000 for the limit request parameter.

More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.

ResourceInUseException
client

The operation conflicts with the resource's availability. For example:

  • You attempted to recreate an existing table.

  • You tried to delete a table currently in the CREATING state.

  • You tried to update a resource that was already being updated.

When appropriate, wait for the ongoing update to complete and attempt the request again.

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.