describe_time_to_live `async` ¶

describe_time_to_live(
    table_name: TableArn,
    *,
    config_overrides: Optional[AsyncDynamoDBClientConfig] = None,
) -> DescribeTimeToLiveOutput

Gives a description of the Time to Live (TTL) status on the specified table.

Parameters:

table_name (TableArn) –

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

Raises:

InternalServerError –

An error occurred on the server side.
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/async_dynamo_db.py

async def describe_time_to_live(
    self,
    table_name: "capo_dynamodb.types.table_arn.TableArn",
    *,
    config_overrides: Optional[AsyncDynamoDBClientConfig] = None,
) -> "capo_dynamodb.types.describe_time_to_live_output.DescribeTimeToLiveOutput":
    """<p>Gives a description of the Time to Live (TTL) status on the specified table. </p>

    Args:
        table_name: <p>The name of the table to be described. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.</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.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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_dynamodb.types.describe_time_to_live_input.DescribeTimeToLiveInput]",
    ) -> AsyncOperationResponse[
        "capo_dynamodb.types.describe_time_to_live_output.DescribeTimeToLiveOutput"
    ]:
        import capo_dynamodb._operations.dynamo_db_20120810.describe_time_to_live

        (
            output,
            http_response,
        ) = await capo_dynamodb._operations.dynamo_db_20120810.describe_time_to_live.async_describe_time_to_live(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeTimeToLive")
    )
    input_: capo_dynamodb.types.describe_time_to_live_input.DescribeTimeToLiveInput = {
        "table_name": table_name
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

describe_time_to_live async ¶

describe_time_to_live `async` ¶