Метод DescribeTable
Статья создана
Обновлена 5 февраля 2024 г.
Возвращает информацию о таблице, включая текущее состояние, время создания, схему первичного ключа и индексы.
Запрос
Запрос содержит данные в формате JSON.
{
"TableName": "string"
}
Параметры
| Параметр | Описание |
|---|---|
TableName |
Имя таблицы, о которой запрашивается информация. Может содержать путь в иерархии каталогов вида path/to/table. Тип: Строка Длина: 3 - 255 символов Шаблон: [a-zA-Z0-9_.-]+ Обязательно: Да |
Ответ
В случае успеха вернется HTTP с кодом 200.
Запрос возвращает данные в формате JSON.
{
"Table": {
"AttributeDefinitions": [
{
"AttributeName": "string",
"AttributeType": "string"
}
],
"CreationDateTime": number,
"ItemCount": number,
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"StreamSpecification": {
"StreamEnabled": boolean,
"StreamViewType": "string"
},
"TableName": "string",
"TableSizeBytes": number,
"TableStatus": "string"
}
}
Параметры
| Параметр | Описание |
|---|---|
Table |
Свойства таблицы. Тип: объект типа TableDescription. |
Ошибки
| Параметр | Описание |
|---|---|
InternalServerError |
Произошла внутренняя ошибка на стороне сервера. Код состояния HTTP: 500 |
ResourceNotFoundException |
Указанная таблица не существует, или она еще создается методом createTable Код состояния HTTP: 400 |
Также могут возникать Общие ошибки, одинаковые для всех методов.