Skip to content

enable_kinesis_streaming_destination

enable_kinesis_streaming_destination(
    table_name: TableArn,
    stream_arn: StreamArn,
    *,
    config_overrides: Optional[DynamoDBClientConfig] = None,
    enable_kinesis_streaming_configuration: Optional[
        EnableKinesisStreamingConfiguration
    ] = None,
) -> KinesisStreamingDestinationOutput

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.

Parameters:

  • table_name (TableArn) –

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

  • stream_arn (StreamArn) –

    The ARN for a Kinesis data stream.

  • enable_kinesis_streaming_configuration (Optional[EnableKinesisStreamingConfiguration], default: None ) –

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

Raises:

  • InternalServerError –

    An error occurred on the server side.

  • 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, 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 –

    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 –

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

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_dynamodb/_services/dynamo_db.py
def enable_kinesis_streaming_destination(
    self,
    table_name: "capo_dynamodb.types.table_arn.TableArn",
    stream_arn: "capo_dynamodb.types.stream_arn.StreamArn",
    *,
    config_overrides: Optional[DynamoDBClientConfig] = None,
    enable_kinesis_streaming_configuration: Optional[
        "capo_dynamodb.types.enable_kinesis_streaming_configuration.EnableKinesisStreamingConfiguration"
    ] = None,
) -> "capo_dynamodb.types.kinesis_streaming_destination_output.KinesisStreamingDestinationOutput":
    """<p>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.</p>

    Args:
        table_name: <p>The name of the DynamoDB table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.</p>
        stream_arn: <p>The ARN for a Kinesis data stream.</p>
        enable_kinesis_streaming_configuration: <p>The source for the Kinesis streaming information that is being enabled.</p>

    Raises:
        capo_dynamodb.errors.internal_server_error.InternalServerError: <p>An error occurred on the server side.</p>
        capo_dynamodb.errors.invalid_endpoint_exception.InvalidEndpointException
        capo_dynamodb.errors.limit_exceeded_exception.LimitExceededException: <p>There is no limit to the number of daily on-demand backups that can be taken. </p> <p>For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include <code>CreateTable</code>, <code>UpdateTable</code>, <code>DeleteTable</code>,<code>UpdateTimeToLive</code>, <code>RestoreTableFromBackup</code>, and <code>RestoreTableToPointInTime</code>. </p> <p>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.</p> <p>When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.</p> <p>There is a soft account quota of 2,500 tables.</p> <p>GetRecords was called with a value of more than 1000 for the limit request parameter.</p> <p>More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.</p>
        capo_dynamodb.errors.resource_in_use_exception.ResourceInUseException: <p>The operation conflicts with the resource's availability. For example:</p> <ul> <li> <p>You attempted to recreate an existing table.</p> </li> <li> <p>You tried to delete a table currently in the <code>CREATING</code> state.</p> </li> <li> <p>You tried to update a resource that was already being updated.</p> </li> </ul> <p>When appropriate, wait for the ongoing update to complete and attempt the request again.</p>
        capo_dynamodb.errors.resource_not_found_exception.ResourceNotFoundException: <p>The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
        capo_dynamodb.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_dynamodb.types.kinesis_streaming_destination_input.KinesisStreamingDestinationInput]",
    ) -> OperationResponse[
        "capo_dynamodb.types.kinesis_streaming_destination_output.KinesisStreamingDestinationOutput"
    ]:
        import capo_dynamodb._operations.dynamo_db_20120810.enable_kinesis_streaming_destination

        output, http_response = (
            capo_dynamodb._operations.dynamo_db_20120810.enable_kinesis_streaming_destination.enable_kinesis_streaming_destination(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("EnableKinesisStreamingDestination")
    )
    input_: capo_dynamodb.types.kinesis_streaming_destination_input.KinesisStreamingDestinationInput = {
        "table_name": table_name,
        "stream_arn": stream_arn,
    }
    if enable_kinesis_streaming_configuration is not None:
        input_["enable_kinesis_streaming_configuration"] = (
            enable_kinesis_streaming_configuration
        )

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output