Spec-Zone.ru › AWS CLI v2

[ aws . dynamodb ]

describe-table

Описание

Возвращает информацию о таблице, включая текущий статус таблицы, дату её создания, схему первичного ключа и все индексы в таблице.

Предупреждение

Для глобальных таблиц данная операция применяется только к глобальным таблицам, использующим версию 2019.11.21 (текущая версия).

Примечание

Если вы выполните запрос DescribeTable сразу после запроса CreateTable, DynamoDB может вернуть ResourceNotFoundException. Это связано с тем, что DescribeTable использует запросы с неявной консистенцией, и метаданные вашей таблицы могут быть недоступны в этот момент. Подождите несколько секунд и повторите запрос DescribeTable.

См. также: Документацию API AWS

Синтаксис

  describe-table
--table-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--table-name (строка)

Имя таблицы для описания. Вы также можете указать Amazon Resource Name (ARN) таблицы в этом параметре.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON следует формату, указанному в --generate-cli-skeleton. Если другие аргументы указаны в командной строке, эти значения перекроют значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения JSON, так как строка будет интерпретирована буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если указано без значения или со значением input, выводит пример JSON-ввода, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, будет напечатан образец YAML-ввода, который можно использовать с --cli-input-yaml. Если задано значение output, он валидирует входные данные команды и возвращает JSON-образец вывода для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости для сгенерированного JSON-скелета.

Глобальные параметры

--debug (логическое)

Включить отладочную запись.

--endpoint-url (строка)

Переопределить URL по умолчанию для команды заданным URL.

--no-verify-ssl (логическое)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI проверит сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.

--no-paginate (логическое)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

  • json
  • text
  • таблица
  • yaml
  • yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • включено
  • выключено
  • автоматически

--no-sign-request (логическое)

Не подписывать запросы. Учетные данные не будут загружены, если этот параметр указан.

--ca-bundle (строка)

Файл сертификатов CA для проверки сертификатов SSL. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 предполагает, что двоичные блоки предоставляются как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, которое отображается как двоичный блок, fileb:// всегда будет обрабатываться как двоичный и использовать содержимое файла непосредственно, независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (логическое)

Автоматически запрашивать параметры CLI.

--no-cli-auto-prompt (логическое)

Отключить автоматический запрос параметров CLI.

Примеры

Примечание

Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Дополнительные сведения см. в руководстве по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.

Для описания таблицы

Следующий describe-table пример описывает MusicCollection таблицу.

aws dynamodb describe-table \
    --table-name MusicCollection

Вывод:

{
    "Table": {
        "AttributeDefinitions": [
            {
                "AttributeName": "Artist",
                "AttributeType": "S"
            },
            {
                "AttributeName": "SongTitle",
                "AttributeType": "S"
            }
        ],
        "ProvisionedThroughput": {
            "NumberOfDecreasesToday": 0,
            "WriteCapacityUnits": 5,
            "ReadCapacityUnits": 5
        },
        "TableSizeBytes": 0,
        "TableName": "MusicCollection",
        "TableStatus": "ACTIVE",
        "KeySchema": [
            {
                "KeyType": "HASH",
                "AttributeName": "Artist"
            },
            {
                "KeyType": "RANGE",
                "AttributeName": "SongTitle"
            }
        ],
        "ItemCount": 0,
        "CreationDateTime": 1421866952.062
    }
}

Дополнительную информацию см. в разделе «Описание таблицы» в Руководстве разработчика Amazon DynamoDB.

Вывод

Таблица -> (структура)

Свойства таблицы.

AttributeDefinitions -> (список)

Массив объектов AttributeDefinition. Каждый объект описывает один атрибут в таблице и схеме ключей индексов.

Каждый объект AttributeDefinition в этом массиве состоит из:

  • AttributeName - Название атрибута.
  • AttributeType - Тип данных атрибута.

(структура)

Представляет атрибут для описания схемы таблицы и индексов.

AttributeName -> (строка)

Название атрибута.

AttributeType -> (строка)

Тип данных атрибута, где:

  • S - атрибут типа Строка
  • N - атрибут типа Число
  • B - атрибут типа Двоичные данные

TableName -> (строка)

Название таблицы.

KeySchema -> (список)

Структура первичного ключа таблицы. Каждый элемент KeySchemaElement состоит из:

  • AttributeName - Название атрибута.
  • KeyType - Роль атрибута:
    • HASH - ключ разбиения
    • RANGE - ключ сортировки

Примечание

Ключ разбиения элемента также известен как атрибут хеширования. Термин «атрибут хеширования» происходит от использования DynamoDB внутренней хеш-функции для равномерного распределения элементов данных по разделам на основе значений ключа разбиения.

Ключ сортировки элемента также известен как атрибут диапазона. Термин «атрибут диапазона» происходит от способа хранения DynamoDB элементов с одинаковым ключом разбиения физически близко друг к другу в отсортированном порядке по значению ключа сортировки.

Для получения дополнительной информации о первичных ключах см. раздел Первичный ключ в Руководстве разработчика Amazon DynamoDB.

(структура)

Представляет один элемент схемы ключа. Схема ключа определяет атрибуты, которые составляют первичный ключ таблицы или атрибуты ключа индекса.

Элемент KeySchemaElement представляет ровно один атрибут первичного ключа. Например, простой первичный ключ будет представлен одним KeySchemaElement (для ключа разбиения). Составной первичный ключ потребует одного KeySchemaElement для ключа разбиения и другого KeySchemaElement для ключа сортировки.

Элемент KeySchemaElement должен быть скалярным атрибутом верхнего уровня (не вложенным атрибутом). Тип данных должен быть одним из Строка, Число или Двоичные данные. Атрибут не может быть вложен в список или словарь.

AttributeName -> (строка)

Название атрибута ключа.

KeyType -> (строка)

Роль, которую будет выполнять этот атрибут ключа:

  • HASH - ключ разбиения
  • RANGE - ключ сортировки

Примечание

Ключ разбиения элемента также известен как атрибут хеширования. Термин «атрибут хеширования» происходит от использования DynamoDB внутренней хеш-функции для равномерного распределения элементов данных по разделам на основе значений ключа разбиения.

Ключ сортировки элемента также известен как атрибут диапазона. Термин «атрибут диапазона» происходит от способа хранения DynamoDB элементов с одинаковым ключом разбиения физически близко друг к другу в отсортированном порядке по значению ключа сортировки.

TableStatus -> (строка)

Текущее состояние таблицы:

  • CREATING - Таблица создается.
  • UPDATING - Настройка таблицы/индекса обновляется. Таблица/индекс остаются доступными для операций с данными, когда UPDATING.
  • DELETING - Таблица удаляется.
  • ACTIVE - Таблица готова к использованию.
  • INACCESSIBLE_ENCRYPTION_CREDENTIALS - Ключ KMS, используемый для шифрования таблицы, недоступен. Операции с таблицей могут завершиться ошибкой из-за невозможности использовать ключ KMS. DynamoDB инициирует процесс архивации таблицы, если ключ KMS таблицы остается недоступным более семи дней.
  • ARCHIVING - Таблица архивируется. Операции не разрешены, пока архивация не завершится.
  • ARCHIVED - Таблица была архивирована. Для получения дополнительной информации см. причину архивации.

CreationDateTime -> (метка времени)

Дата и время создания таблицы в формате временной метки Unix.

ProvisionedThroughput -> (структура)

Параметры пропускной способности предварительно выделенных ресурсов для таблицы, включающие единицы пропускной способности чтения и записи, а также информацию об увеличениях и уменьшениях.

LastIncreaseDateTime -> (метка времени)

Дата и время последнего увеличения пропускной способности предварительно выделенных ресурсов для этой таблицы.

LastDecreaseDateTime -> (метка времени)

Дата и время последнего уменьшения пропускной способности предварительно выделенных ресурсов для этой таблицы.

NumberOfDecreasesToday -> (целое число)

Количество уменьшений пропускной способности предварительно выделенных ресурсов для этой таблицы в течение текущего UTC-календарного дня. Максимальные значения уменьшений пропускной способности предварительно выделенных ресурсов см. в разделе «Квоты службы, учетной записи и таблицы» в Руководстве разработчика Amazon DynamoDB.

ReadCapacityUnits -> (целое число)

Максимальное количество чтений с сильной согласованностью, потребляемых в секунду, прежде чем DynamoDB вернёт ThrottlingException. Чтения с нестрогой согласованностью требуют меньших затрат, чем чтения с сильной согласованностью, поэтому значение 50 ReadCapacityUnits в секунду обеспечивает 100 чтений с нестрогой согласованностью ReadCapacityUnits в секунду.

WriteCapacityUnits -> (целое число)

Максимальное количество записей, потребляемых в секунду, прежде чем DynamoDB вернёт ThrottlingException.

TableSizeBytes -> (целое число)

Общий размер указанной таблицы в байтах. DynamoDB обновляет это значение примерно каждые шесть часов. Недавние изменения могут не отражаться в этом значении.

ItemCount -> (целое число)

Количество элементов в указанной таблице. DynamoDB обновляет это значение примерно каждые шесть часов. Недавние изменения могут не отражаться в этом значении.

TableArn -> (строка)

Amazon Resource Name (ARN), уникально идентифицирующий таблицу.

TableId -> (строка)

Уникальный идентификатор таблицы, для которой был создан резервный экземпляр.

BillingModeSummary -> (структура)

Содержит сведения о режиме пропускной способности чтения/записи.

BillingMode -> (строка)

Управляет тем, как вы оплачиваете пропускную способность чтения и записи и как управляете емкостью. Это значение можно изменить позже.

  • PROVISIONED - Устанавливает режим пропускной способности чтения/записи в PROVISIONED. Рекомендуется использовать PROVISIONED для предсказуемых рабочих нагрузок.
  • PAY_PER_REQUEST - Устанавливает режим пропускной способности чтения/записи в PAY_PER_REQUEST. Рекомендуется использовать PAY_PER_REQUEST для непредсказуемых рабочих нагрузок.

LastUpdateToPayPerRequestDateTime -> (метка времени)

Представляет время, когда PAY_PER_REQUEST был в последний раз установлен в качестве режима пропускной способности чтения/записи.

LocalSecondaryIndexes -> (список)

Представляет один или несколько локальных вторичных индексов в таблице. Каждый индекс ограничен определенным значением ключа разбиения. Таблицы с одним или несколькими локальными вторичными индексами ограничены размером коллекции элементов, где количество данных в данной коллекции элементов не может превышать 10 ГБ. Каждый элемент состоит из:

  • IndexName - Имя локального вторичного индекса.
  • KeySchema - Указывает полную схему ключа индекса. Имена атрибутов в схеме ключа должны быть от 1 до 255 символов (включительно). Схема ключа должна начинаться с того же ключа разбиения, что и таблица.
  • Projection - Указывает атрибуты, которые копируются (проектируются) из таблицы в индекс. Они дополняют атрибуты первичного ключа и ключа индекса, которые автоматически проектируются. Каждое указание атрибута состоит из:
    • ProjectionType - Один из следующих вариантов:
      • KEYS_ONLY - В индекс проектируются только ключи индекса и первичные ключи.
      • INCLUDE - В индекс проектируются только указанные атрибуты таблицы. Список проектируемых атрибутов находится в NonKeyAttributes .
      • ALL - В индекс проектируются все атрибуты таблицы.
    • NonKeyAttributes - Список одного или нескольких имен атрибутов, не являющихся ключами, которые проектируются во вторичный индекс. Общее количество атрибутов, указанных в NonKeyAttributes , суммированное по всем вторичным индексам, не должно превышать 100. Если один и тот же атрибут проектируется в два разных индекса, это считается двумя отдельными атрибутами при определении общего количества. Это ограничение применяется только при указании типа проекции INCLUDE . Вы по-прежнему можете указать тип проекции ALL для проекции всех атрибутов из исходной таблицы, даже если таблица содержит более 100 атрибутов.
  • IndexSizeBytes - Представляет общий размер индекса в байтах. DynamoDB обновляет это значение примерно каждые шесть часов. Недавние изменения могут не отражаться в этом значении.
  • ItemCount - Представляет количество элементов в индексе. DynamoDB обновляет это значение примерно каждые шесть часов. Недавние изменения могут не отражаться в этом значении.

Если таблица находится в состоянии DELETING , информация об индексах не будет возвращена.

(структура)

Представляет свойства локального вторичного индекса.

IndexName -> (строка)

Представляет имя локального вторичного индекса.

KeySchema -> (список)

Полная схема ключа локального вторичного индекса, состоящая из одного или нескольких пар имен атрибутов и типов ключей:

  • HASH - ключ разбиения
  • RANGE - сортировочный ключ

Примечание

Ключ разбиения элемента также известен как его атрибут хеширования. Термин «атрибут хеширования» происходит от использования DynamoDB внутренней хеш-функции для равномерного распределения элементов данных по разделам на основе их значений ключа разбиения.

Сортировочный ключ элемента также известен как его атрибут диапазона. Термин «атрибут диапазона» происходит от способа, которым DynamoDB хранит элементы с одинаковым ключом разбиения физически близко друг к другу в отсортированном порядке по значению сортировочного ключа.

(структура)

Представляет один элемент схемы ключа. Схема ключа определяет атрибуты, составляющие первичный ключ таблицы или атрибуты ключа индекса.

KeySchemaElement представляет ровно один атрибут первичного ключа. Например, простой первичный ключ будет представлен одним KeySchemaElement (для ключа разбиения). Составной первичный ключ потребует одного KeySchemaElement для ключа разбиения и другого KeySchemaElement для сортировочного ключа.

KeySchemaElement должен быть скалярным атрибутом верхнего уровня (не вложенным атрибутом). Тип данных должен быть одним из String, Number или Binary. Атрибут не может быть вложен в список или карту.

AttributeName -> (строка)

Имя атрибута ключа.

KeyType -> (строка)

Роль, которую этот атрибут ключа будет играть:

  • HASH - ключ разбиения
  • RANGE - сортировочный ключ

Примечание

Ключ разбиения элемента также известен как его атрибут хеширования. Термин «атрибут хеширования» происходит от использования DynamoDB внутренней хеш-функции для равномерного распределения элементов данных по разделам на основе их значений ключа разбиения.

Сортировочный ключ элемента также известен как его атрибут диапазона. Термин «атрибут диапазона» происходит от способа, которым DynamoDB хранит элементы с одинаковым ключом разбиения физически близко друг к другу в отсортированном порядке по значению сортировочного ключа.

Projection -> (структура)

Представляет атрибуты, которые копируются (проектируются) из таблицы во вторичный глобальный индекс. Они дополняют атрибуты первичного ключа и ключа индекса, которые автоматически проектируются.

ProjectionType -> (строка)

Набор атрибутов, которые проектируются в индекс:

  • KEYS_ONLY - В индекс проектируются только ключи индекса и первичные ключи.
  • INCLUDE - В дополнение к атрибутам, описанным в KEYS_ONLY , вторичный индекс будет содержать другие атрибуты, не являющиеся ключами, которые вы укажете.
  • ALL - В индекс проектируются все атрибуты таблицы.

При использовании консоли DynamoDB ALL выбирается по умолчанию.

NonKeyAttributes -> (список)

Представляет имена атрибутов, не являющихся ключами, которые будут спроецированы в индекс.

Для глобальных и локальных вторичных индексов общее количество NonKeyAttributes , суммированное по всем вторичным индексам, не должно превышать 100. Если один и тот же атрибут проектируется в два разных индекса, это считается двумя отдельными атрибутами при определении общего количества. Это ограничение применяется только при указании типа проекции INCLUDE . Вы по-прежнему можете указать тип проекции ALL для проекции всех атрибутов из исходной таблицы, даже если таблица содержит более 100 атрибутов.

(строка)

IndexSizeBytes -> (целое число)

Общий размер указанного индекса в байтах. DynamoDB обновляет это значение примерно каждые шесть часов. Недавние изменения могут не отражаться в этом значении.

ItemCount -> (целое число)

Количество элементов в указанном индексе. DynamoDB обновляет это значение примерно каждые шесть часов. Недавние изменения могут не отражаться в этом значении.

IndexArn -> (строка)

Уникальный Amazon Resource Name (ARN) индекса.

GlobalSecondaryIndexes -> (список)

Глобальные вторичные индексы (если есть) в таблице. Каждый индекс ограничен определенным значением ключа разбиения. Каждый элемент состоит из:

  • Backfilling - Если значение равно true, то индекс в настоящее время находится на стадии заполнения. Заполнение происходит только при добавлении нового глобального вторичного индекса в таблицу. Это процесс, посредством которого DynamoDB заполняет новый индекс данными из таблицы. (Этот атрибут не отображается для индексов, созданных во время операции CreateTable). Вы можете удалить индекс, который создается на стадии Backfilling, когда IndexStatus имеет значение CREATING, а Backfilling имеет значение true. Вы не можете удалить индекс, который создается, когда IndexStatus имеет значение CREATING, а Backfilling имеет значение false. (Этот атрибут не отображается для индексов, созданных во время операции CreateTable).
  • IndexName - Имя глобального вторичного индекса.
  • IndexSizeBytes - Общий размер глобального вторичного индекса в байтах. DynamoDB обновляет это значение примерно каждые шесть часов. Недавние изменения могут не отражаться в этом значении.
  • IndexStatus - Текущий статус глобального вторичного индекса:
    • CREATING - Индекс создается.
    • UPDATING - Индекс обновляется.
    • DELETING - Индекс удаляется.
    • ACTIVE - Индекс готов к использованию.
  • ItemCount - Количество элементов в глобальном вторичном индексе. DynamoDB обновляет это значение примерно каждые шесть часов. Недавние изменения могут не отражаться в этом значении.
  • KeySchema - Указывает полную схему ключа индекса. Имена атрибутов в схеме ключа должны быть от 1 до 255 символов (включительно). Схема ключа должна начинаться с того же ключа разбиения, что и таблица.
  • Projection - Указывает атрибуты, которые копируются (проектируются) из таблицы в индекс. Они дополняют атрибуты первичного ключа и ключа индекса, которые автоматически проектируются. Каждое указание атрибута состоит из:
    • ProjectionType - Один из следующих вариантов:
      • KEYS_ONLY - В индекс проектируются только ключи индекса и первичные ключи.
      • INCLUDE - В дополнение к атрибутам, описанным в KEYS_ONLY , вторичный индекс будет содержать другие атрибуты, не являющиеся ключами, которые вы укажете.
      • ALL - В индекс проектируются все атрибуты таблицы.
    • NonKeyAttributes - Список одного или нескольких имен атрибутов, не являющихся ключами, которые проектируются во вторичный индекс. Общее количество атрибутов, указанных в NonKeyAttributes , суммированное по всем вторичным индексам, не должно превышать 100. Если один и тот же атрибут проектируется в два разных индекса, это считается двумя отдельными атрибутами при определении общего количества. Это ограничение применяется только при указании типа проекции INCLUDE . Вы по-прежнему можете указать тип проекции ALL для проекции всех атрибутов из исходной таблицы, даже если таблица содержит более 100 атрибутов.
  • ProvisionedThroughput - Параметры пропускной способности для глобального вторичного индекса, состоящие из единиц емкости чтения и записи, а также информации об увеличении и уменьшении.

Если таблица находится в состоянии DELETING , информация об индексах не будет возвращена.

(структура)

Представляет свойства глобального вторичного индекса.

IndexName -> (строка)

Имя глобального вторичного индекса.

KeySchema -> (список)

Полная схема ключа для глобального вторичного индекса, которая состоит из одной или нескольких пар имен атрибутов и типов ключей:

  • HASH — ключ разбиения
  • RANGE — сортировочный ключ

Примечание

Ключ разбиения элемента также известен как его атрибут хеширования. Термин «атрибут хеширования» происходит от использования DynamoDB внутренней функции хеширования для равномерного распределения элементов данных по разделам на основе значений ключа разбиения.

Сортировочный ключ элемента также известен как его атрибут диапазона. Термин «атрибут диапазона» происходит от способа, которым DynamoDB хранит элементы с одинаковым ключом разбиения физически близко друг к другу в отсортированном порядке по значению сортировочного ключа.

(структура)

Представляет один элемент схемы ключа. Схема ключа определяет атрибуты, составляющие первичный ключ таблицы или ключевые атрибуты индекса.

KeySchemaElement представляет ровно один атрибут первичного ключа. Например, простой первичный ключ будет представлен одним KeySchemaElement (для ключа разбиения). Составной первичный ключ потребует одного KeySchemaElement для ключа разбиения и другого KeySchemaElement для сортировочного ключа.

KeySchemaElement должен быть скалярным атрибутом верхнего уровня (а не вложенным атрибутом). Тип данных должен быть String, Number или Binary. Атрибут не может быть вложен в список или карту.

AttributeName -> (строка)

Имя ключевого атрибута.

KeyType -> (строка)

Роль, которую этот ключевой атрибут будет выполнять:

  • HASH — ключ разбиения
  • RANGE — сортировочный ключ

Примечание

Ключ разбиения элемента также известен как его атрибут хеширования. Термин «атрибут хеширования» происходит от использования DynamoDB внутренней функции хеширования для равномерного распределения элементов данных по разделам на основе значений ключа разбиения.

Сортировочный ключ элемента также известен как его атрибут диапазона. Термин «атрибут диапазона» происходит от способа, которым DynamoDB хранит элементы с одинаковым ключом разбиения физически близко друг к другу в отсортированном порядке по значению сортировочного ключа.

Projection -> (структура)

Представляет атрибуты, которые копируются (проецируются) из таблицы в глобальный вторичный индекс. Это дополнительно к атрибутам первичного ключа и ключу индекса, которые проецируются автоматически.

ProjectionType -> (строка)

Набор атрибутов, проецируемых в индекс:

  • KEYS_ONLY — В индекс проецируются только индекс и первичные ключи.
  • INCLUDE — В дополнение к атрибутам, описанным в KEYS_ONLY, вторичный индекс будет включать другие атрибуты, не являющиеся ключами, которые вы укажете.
  • ALL — Все атрибуты таблицы проецируются в индекс.

При использовании консоли DynamoDB ALL выбрано по умолчанию.

NonKeyAttributes -> (список)

Представляет имена атрибутов, не являющихся ключами, которые будут проецироваться в индекс.

Для глобальных и локальных вторичных индексов общее количество NonKeyAttributes, суммированное по всем вторичным индексам, не должно превышать 100. Если вы проецируете один и тот же атрибут в два разных индекса, это учитывается как два разных атрибута при определении общего итога. Это ограничение применяется только тогда, когда вы указываете ProjectionType INCLUDE. Вы все равно можете указать ProjectionType ALL, чтобы спроецировать все атрибуты из исходной таблицы, даже если таблица содержит более 100 атрибутов.

(строка)

IndexStatus -> (строка)

Текущее состояние глобального вторичного индекса:

  • CREATING — индекс создается.
  • UPDATING — индекс обновляется.
  • DELETING — индекс удаляется.
  • ACTIVE — индекс готов к использованию.

Backfilling -> (логическое значение)

Указывает, выполняется ли в данный момент заполнение индекса. Заполнение — это процесс чтения элементов из таблицы и определения, могут ли они быть добавлены в индекс. (Не все элементы подходят: например, ключ разбиения не может иметь дублирующихся значений.) Если элемент может быть добавлен в индекс, DynamoDB добавит его. После обработки всех элементов операция заполнения завершена, и Backfilling равно false.

Вы можете удалить индекс, который создается на этапе Backfilling, когда IndexStatus установлено в CREATING и Backfilling равно true. Вы не можете удалить индекс, который создается, когда IndexStatus установлено в CREATING и Backfilling равно false.

Примечание

Для индексов, созданных во время операции CreateTable, атрибут Backfilling не отображается в выводе DescribeTable.

ProvisionedThroughput -> (структура)

Представляет настройки пропускной способности для указанного глобального вторичного индекса.

См. минимальные и максимальные значения пропускной способности в руководстве разработчика Amazon DynamoDB «Квоты сервиса, учетной записи и таблицы».

LastIncreaseDateTime -> (отметка времени)

Дата и время последнего увеличения пропускной способности для этой таблицы.

LastDecreaseDateTime -> (отметка времени)

Дата и время последнего уменьшения пропускной способности для этой таблицы.

NumberOfDecreasesToday -> (целое число)

Количество уменьшений пропускной способности для этой таблицы в течение текущего UTC-календарного дня. См. максимальные значения уменьшений пропускной способности в руководстве разработчика Amazon DynamoDB «Квоты сервиса, учетной записи и таблицы».

ReadCapacityUnits -> (целое число)

Максимальное количество сильных последовательных чтений, потребляемых в секунду, прежде чем DynamoDB вернет ThrottlingException. Чтения с нестрогой последовательностью требуют меньших затрат, чем сильные последовательные чтения, поэтому значение 50 ReadCapacityUnits в секунду обеспечивает 100 чтений с нестрогой последовательностью в секунду.

WriteCapacityUnits -> (целое число)

Максимальное количество записей, потребляемых в секунду, прежде чем DynamoDB вернет ThrottlingException.

IndexSizeBytes -> (целое число)

Общий размер указанного индекса в байтах. DynamoDB обновляет это значение примерно каждые шесть часов. Недавние изменения могут не отражаться в этом значении.

ItemCount -> (целое число)

Количество элементов в указанном индексе. DynamoDB обновляет это значение примерно каждые шесть часов. Недавние изменения могут не отражаться в этом значении.

IndexArn -> (строка)

Идентификатор ресурса Amazon (ARN), уникально идентифицирующий индекс.

OnDemandThroughput -> (структура)

Максимальное количество единиц чтений и записей для указанного глобального вторичного индекса. Если вы используете этот параметр, вы должны указать MaxReadRequestUnits, MaxWriteRequestUnits или оба.

MaxReadRequestUnits -> (целое число)

Максимальное количество единиц запросов на чтение для указанной таблицы.

Чтобы задать максимальное количество OnDemandThroughput в вашей таблице, установите значение MaxReadRequestUnits как больше или равно 1. Чтобы убрать максимальное количество OnDemandThroughput, которое в данный момент установлено на вашей таблице, установите значение MaxReadRequestUnits в -1.

MaxWriteRequestUnits -> (целое число)

Максимальное количество единиц запросов на запись для указанной таблицы.

Чтобы задать максимальное количество OnDemandThroughput в вашей таблице, установите значение MaxWriteRequestUnits как больше или равно 1. Чтобы убрать максимальное количество OnDemandThroughput, которое в данный момент установлено на вашей таблице, установите значение MaxWriteRequestUnits в -1.

WarmThroughput -> (структура)

Представляет значение пропускной способности для подогрева (в единицах чтений в секунду и единицах записей в секунду) для указанного вторичного индекса.

ReadUnitsPerSecond -> (целое число)

Представляет значение пропускной способности для подогрева, чтений в секунду, для глобального вторичного индекса.

WriteUnitsPerSecond -> (целое число)

Представляет значение пропускной способности для подогрева, записей в секунду, для глобального вторичного индекса.

Status -> (строка)

Представляет состояние пропускной способности для подогрева, создаваемой или обновляемой в глобальном вторичном индексе. Статус может быть только UPDATING или ACTIVE.

StreamSpecification -> (структура)

Текущая конфигурация DynamoDB Streams для таблицы.

StreamEnabled -> (логическое значение)

Указывает, включены (true) или выключены (false) DynamoDB Streams для таблицы.

StreamViewType -> (строка)

Когда элемент в таблице изменяется, StreamViewType определяет, какая информация записывается в поток для этой таблицы. Допустимые значения для StreamViewType:

  • KEYS_ONLY — В поток записываются только атрибуты ключа измененного элемента.
  • NEW_IMAGE — В поток записывается весь элемент в виде, в котором он появился после изменения.
  • OLD_IMAGE — В поток записывается весь элемент в виде, в котором он существовал до изменения.
  • NEW_AND_OLD_IMAGES — В поток записываются и старая, и новая версии элемента.

LatestStreamLabel -> (строка)

Отметка времени в формате ISO 8601 для этого потока.

Обратите внимание, что LatestStreamLabel не является уникальным идентификатором потока, поскольку возможно, что поток из другой таблицы может иметь ту же отметку времени. Однако комбинация следующих трех элементов гарантированно уникальна:

  • Идентификатор клиента Amazon Web Services
  • Имя таблицы
  • StreamLabel

LatestStreamArn -> (строка)

Идентификатор ресурса Amazon (ARN), уникально идентифицирующий последний поток для этой таблицы.

GlobalTableVersion -> (строка)

Представляет версию глобальных таблиц, используемую, если таблица реплицируется по областям Amazon Web Services.

Replicas -> (список)

Представляет реплики таблицы.

(структура)

Содержит детали реплики.

RegionName -> (строка)

Имя региона.

ReplicaStatus -> (строка)

Текущее состояние реплики:

  • CREATING - Реплика создается.
  • UPDATING - Реплика обновляется.
  • DELETING - Реплика удаляется.
  • ACTIVE - Реплика готова к использованию.
  • REGION_DISABLED - Реплика недоступна, так как регион Amazon Web Services отключен.

Примечание

Если регион Amazon Web Services остается недоступным более 20 часов, DynamoDB удалит эту реплику из группы репликации. Реплика не будет удалена, и репликация будет остановлена в этот и из этого региона.
  • INACCESSIBLE_ENCRYPTION_CREDENTIALS - Ключ KMS, используемый для шифрования таблицы, недоступен.

Примечание

Если ключ KMS остается недоступным более 20 часов, DynamoDB удалит эту реплику из группы репликации. Реплика не будет удалена, и репликация будет остановлена в этот и из этого региона.

ReplicaStatusDescription -> (строка)

Подробная информация о статусе реплики.

ReplicaStatusPercentProgress -> (строка)

Указывает прогресс действия Create, Update или Delete на реплике в процентах.

KMSMasterKeyId -> (строка)

Ключ KMS реплики, который будет использоваться для шифрования KMS.

ProvisionedThroughputOverride -> (структура)

Пропускная способность с выделенными ресурсами, специфичная для реплики. Если не указано, используется пропускная способность таблицы-источника.

ReadCapacityUnits -> (длинное целое)

Единицы пропускной способности чтения, специфичные для реплики. Если не указано, используются настройки пропускной способности чтения таблицы-источника.

OnDemandThroughputOverride -> (структура)

Переопределяет максимальные настройки пропускной способности по требованию для указанной таблицы-реплики.

MaxReadRequestUnits -> (длинное целое)

Максимальное количество единиц запросов на чтение для указанной таблицы-реплики.

WarmThroughput -> (структура)

Представляет значение тепловой пропускной способности для этой реплики.

ReadUnitsPerSecond -> (длинное целое)

Представляет значение тепловой пропускной способности базовой таблицы в единицах чтения в секунду.

WriteUnitsPerSecond -> (длинное целое)

Представляет значение тепловой пропускной способности базовой таблицы в единицах записи в секунду.

Status -> (строка)

Представляет значение тепловой пропускной способности базовой таблицы.

GlobalSecondaryIndexes -> (список)

Настройки глобального вторичного индекса, специфичные для реплики.

(структура)

Представляет свойства глобального вторичного индекса реплики.

IndexName -> (строка)

Имя глобального вторичного индекса.

ProvisionedThroughputOverride -> (структура)

Если не указано, используются настройки пропускной способности чтения GSI таблицы-источника.

ReadCapacityUnits -> (длинное целое)

Единицы пропускной способности чтения, специфичные для реплики. Если не указано, используются настройки пропускной способности чтения таблицы-источника.

OnDemandThroughputOverride -> (структура)

Переопределяет максимальную пропускную способность по требованию для указанного глобального вторичного индекса в указанной таблице-реплики.

MaxReadRequestUnits -> (длинное целое)

Максимальное количество единиц запросов на чтение для указанной таблицы-реплики.

WarmThroughput -> (структура)

Представляет тепловую пропускную способность глобального вторичного индекса для этой реплики.

ReadUnitsPerSecond -> (длинное целое)

Представляет значение тепловой пропускной способности чтения в секунду для глобального вторичного индекса.

WriteUnitsPerSecond -> (длинное целое)

Представляет значение тепловой пропускной способности записи в секунду для глобального вторичного индекса.

Status -> (строка)

Представляет состояние тепловой пропускной способности, которое создается или обновляется для глобального вторичного индекса. Статус может быть только UPDATING или ACTIVE.

ReplicaInaccessibleDateTime -> (временная метка)

Время, в которое реплика была впервые обнаружена как недоступная. Для определения причины недоступности проверьте свойство ReplicaStatus.

ReplicaTableClassSummary -> (структура)

Содержит сведения о классе таблицы.

TableClass -> (строка)

Класс таблицы указанной таблицы. Допустимые значения - STANDARD и STANDARD_INFREQUENT_ACCESS.

LastUpdateDateTime -> (временная метка)

Дата и время последнего обновления класса таблицы.

RestoreSummary -> (структура)

Содержит сведения о восстановлении.

SourceBackupArn -> (строка)

Amazon Resource Name (ARN) резервной копии, из которой была восстановлена таблица.

SourceTableArn -> (строка)

ARN таблицы-источника резервной копии, которая восстанавливается.

RestoreDateTime -> (временная метка)

Точка времени или время резервной копии источника.

RestoreInProgress -> (булево)

Указывает, выполняется ли восстановление или нет.

SSEDescription -> (структура)

Описание состояния шифрования на стороне сервера для указанной таблицы.

Status -> (строка)

Представляет текущее состояние шифрования на стороне сервера. Допустимые значения:

  • ENABLED - Шифрование на стороне сервера включено.
  • UPDATING - Шифрование на стороне сервера обновляется.

SSEType -> (строка)

Тип шифрования на стороне сервера. Допустимое значение:

  • KMS - Шифрование на стороне сервера, использующее Key Management Service. Ключ хранится в вашем аккаунте и управляется KMS (применяются платы KMS).

KMSMasterKeyArn -> (строка)

ARN ключа KMS, используемого для шифрования KMS.

InaccessibleEncryptionDateTime -> (временная метка)

Указывает время, в формате UNIX epoch date, когда DynamoDB обнаружил, что ключ KMS таблицы недоступен. Это свойство автоматически очищается, когда DynamoDB обнаруживает, что ключ KMS таблицы снова доступен. DynamoDB инициирует процесс архивации таблицы, если ключ KMS таблицы остается недоступным более семи дней с этой даты.

ArchivalSummary -> (структура)

Содержит информацию об архиве таблицы.

ArchivalDateTime -> (временная метка)

Дата и время инициирования архивации таблицы DynamoDB в формате временной метки UNIX epoch.

ArchivalReason -> (строка)

Причина архивации таблицы DynamoDB. В настоящее время единственное возможное значение:

  • INACCESSIBLE_ENCRYPTION_CREDENTIALS - Таблица была архивирована из-за того, что ключ KMS таблицы был недоступен более семи дней. В момент архивации была создана резервная копия по требованию.

ArchivalBackupArn -> (строка)

Amazon Resource Name (ARN) резервной копии, в которую была архивирована таблица, если это применимо к причине архивации. Если вы хотите восстановить эту резервную копию в ту же таблицу, вам необходимо удалить исходную таблицу.

TableClassSummary -> (структура)

Содержит сведения о классе таблицы.

TableClass -> (строка)

Класс таблицы указанной таблицы. Допустимые значения - STANDARD и STANDARD_INFREQUENT_ACCESS.

LastUpdateDateTime -> (временная метка)

Дата и время последнего обновления класса таблицы.

DeletionProtectionEnabled -> (булево)

Указывает, включена ли защита от удаления (true) или отключена (false) для таблицы.

OnDemandThroughput -> (структура)

Максимальное количество единиц чтения и записи для указанной таблицы по требованию. Если вы используете этот параметр, вы должны указать MaxReadRequestUnits, MaxWriteRequestUnits или оба.

MaxReadRequestUnits -> (длинное целое)

Максимальное количество единиц запросов на чтение для указанной таблицы.

Чтобы задать максимальное количество OnDemandThroughput для вашей таблицы, установите значение MaxReadRequestUnits как большее или равное 1. Чтобы удалить текущую максимальную OnDemandThroughput, установленную для вашей таблицы, установите значение MaxReadRequestUnits в -1.

MaxWriteRequestUnits -> (длинное целое)

Максимальное количество единиц запросов на запись для указанной таблицы.

Чтобы задать максимальное количество OnDemandThroughput для вашей таблицы, установите значение MaxWriteRequestUnits как большее или равное 1. Чтобы удалить текущую максимальную OnDemandThroughput, установленную для вашей таблицы, установите значение MaxWriteRequestUnits в -1.

WarmThroughput -> (структура)

Описывает значение тепловой пропускной способности базовой таблицы.

ReadUnitsPerSecond -> (длинное целое)

Представляет значение тепловой пропускной способности базовой таблицы в единицах чтения в секунду.

WriteUnitsPerSecond -> (длинное целое)

Представляет значение тепловой пропускной способности базовой таблицы в единицах записи в секунду.

Status -> (строка)

Представляет значение тепловой пропускной способности базовой таблицы.

MultiRegionConsistency -> (строка)

Указывает один из следующих режимов согласованности для глобальной таблицы:

  • EVENTUAL: Указывает, что глобальная таблица настроена на согласованность с задержкой в нескольких регионах.
  • STRONG: Указывает, что глобальная таблица настроена на жесткую согласованность в нескольких регионах (превью).

Примечание

Жесткая согласованность в нескольких регионах (MRSC) — это новая возможность DynamoDB для глобальных таблиц, которая в настоящее время доступна в режиме предварительной версии. Дополнительные сведения см. в разделе Согласованность нескольких регионов для глобальных таблиц.

Если этот параметр не указан, режим согласованности глобальной таблицы по умолчанию устанавливается в EVENTUAL.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API