DescribeTimeToLive method

Written by

Returns information about the TTL status in the specified table.

Request

The request contains data in JSON format.

{
  "TableName": "string"
}

Parameter	Description
`TableName`	Name of the table that the TTL state is requested for. May contain a path in the directory hierarchy like path/to/table. Type: String Length: 3 - 255 characters Pattern: [a-zA-Z0-9_.-]+ Required: Yes

If successful, HTTP code 200 is returned.
The response is returned in JSON format.

{
  "TimeToLiveDescription": {
    "AttributeName": "string",
    "TimeToLiveStatus": "string"
  }
}

Parameter	Description
`TimeToLiveSpecification`	TTL status. Type: Object of the `TimeToLiveSpecification` type.

Parameter	Description
`InternalServerError`	An internal error occurred on the server side. HTTP status code: 500
`ResourceNotFoundException`	The specified table doesn't exist or its state is different from `ACTIVE`. HTTP status code: 400

There may be common errors as well. These are errors that are common to all methods.