Yandex Cloud
  • Services
  • Solutions
  • Why Yandex Cloud
  • Blog
  • Pricing
  • Documentation
  • Contact us
Get started
Language / Region
Yandex project
© 2023 Intertech Services AG
Yandex Managed Service for YDB
  • Getting started
  • Step-by-step guides
  • Tutorials
  • Concepts
  • Access management
  • Pricing policy
  • Amazon DynamoDB-compatible Document API
    • Tools
    • Document API reference
      • All methods
      • Actions
        • BatchGetItem
        • BatchWriteItem
        • CreateTable
        • DeleteItem
        • DeleteTable
        • DescribeTable
        • DescribeTimeToLive
        • GetItem
        • ListTables
        • PutItem
        • Query
        • Scan
        • TransactGetItems
        • TransactWriteItems
        • UpdateItem
        • UpdateTimeToLive
    • Common errors when working with the Document API
  • API Reference Yandex Cloud for Managed Service for YDB
  • Questions and answers
  1. Amazon DynamoDB-compatible Document API
  2. Document API reference
  3. Actions
  4. DescribeTimeToLive

DescribeTimeToLive method

Written by
Yandex Cloud
  • Request
    • Parameters
  • Response
    • Parameters
  • Errors

Returns information about the TTL status in the specified table.

Request

The request contains data in JSON format.

{
  "TableName": "string"
}

Parameters

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

Response

If successful, HTTP code 200 is returned.
The response is returned 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 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.

Was the article helpful?

Language / Region
Yandex project
© 2023 Intertech Services AG
In this article:
  • Request
  • Parameters
  • Response
  • Parameters
  • Errors