EnableKinesisStreamingDestination
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.
Request Syntax
{
"EnableKinesisStreamingConfiguration": {
"ApproximateCreationDateTimePrecision": "string
"
},
"StreamArn": "string
",
"TableName": "string
"
}
Request Parameters
The request accepts the following data in JSON format.
Note
In the following list, the required parameters are described first.
- StreamArn
-
The ARN for a Kinesis data stream.
Type: String
Length Constraints: Minimum length of 37. Maximum length of 1024.
Required: Yes
- TableName
-
The name of the DynamoDB table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
- EnableKinesisStreamingConfiguration
-
The source for the Kinesis streaming information that is being enabled.
Type: EnableKinesisStreamingConfiguration object
Required: No
Response Syntax
{
"DestinationStatus": "string",
"EnableKinesisStreamingConfiguration": {
"ApproximateCreationDateTimePrecision": "string"
},
"StreamArn": "string",
"TableName": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- DestinationStatus
-
The current status of the replication.
Type: String
Valid Values:
ENABLING | ACTIVE | DISABLING | DISABLED | ENABLE_FAILED | UPDATING
- EnableKinesisStreamingConfiguration
-
The destination for the Kinesis streaming information that is being enabled.
Type: EnableKinesisStreamingConfiguration object
- StreamArn
-
The ARN for the specific Kinesis data stream.
Type: String
Length Constraints: Minimum length of 37. Maximum length of 1024.
- TableName
-
The name of the table being modified.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern:
[a-zA-Z0-9_.-]+
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerError
-
An error occurred on the server side.
HTTP Status Code: 500
- LimitExceededException
-
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
, andRestoreTableToPointInTime
.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.
HTTP Status Code: 400
- ResourceInUseException
-
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.
HTTP Status Code: 400
-
- ResourceNotFoundException
-
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be
ACTIVE
.HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: