DescribeTimeToLive method
Written by
Updated at April 24, 2026
Returns the time-to-live (TTL) status for the specified table.
Request
The request contains data in JSON format.
{
"TableName": "string"
}
Parameters
| Parameter | Description |
|---|---|
TableName |
Name of the table whose TTL status is requested. It may contain a path in the hierarchical directory structure in path/to/table format.Type: String Length: 3 to 255 characters. Template: [a-zA-Z0-9_.-]+ Required: Yes |
Response
If successful, HTTP code 200 is returned.
You will get data in JSON format.
{
"TimeToLiveDescription": {
"AttributeName": "string",
"TimeToLiveStatus": "string"
}
}
Parameters
| Parameter | Description |
|---|---|
TimeToLiveSpecification |
TTL status. Type: Object of the TimeToLiveSpecification type. |
Errors
| Parameter | Description |
|---|---|
InternalServerError |
An internal error occurred on the server side. HTTP status code: 500 |
ResourceNotFoundException |
The specified table does not exist or its status is different from ACTIVE.HTTP status code: 400 |
There may be some common errors as well shared by all methods.