обновить-таблицу
Описание
Изменяет параметры пропускной способности, глобальные вторичные индексы или параметры потоков DynamoDB для заданной таблицы.
Предупреждение
Для глобальных таблиц данная операция применяется только к глобальным таблицам, использующим версию 2019.11.21 (текущая версия).Вы можете выполнить только одну из следующих операций за раз:
- Изменить параметры пропускной способности таблицы.
- Удалить глобальный вторичный индекс из таблицы.
- Создать новый глобальный вторичный индекс в таблице. После начала заполнения индекса вы можете использовать
UpdateTableдля выполнения других операций.
UpdateTable — асинхронная операция; во время её выполнения состояние таблицы изменяется с ACTIVE на UPDATING. Пока оно UPDATING, вы не можете выполнить другой запрос UpdateTable. Когда таблица вернётся в состояние ACTIVE, операция UpdateTable завершена.См. также: Документация API AWS
Синтаксис
update-table
[--attribute-definitions <value>]
--table-name <value>
[--billing-mode <value>]
[--provisioned-throughput <value>]
[--global-secondary-index-updates <value>]
[--stream-specification <value>]
[--sse-specification <value>]
[--replica-updates <value>]
[--table-class <value>]
[--deletion-protection-enabled | --no-deletion-protection-enabled]
[--multi-region-consistency <value>]
[--on-demand-throughput <value>]
[--warm-throughput <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]
Параметры
--attribute-definitions (список)
Массив атрибутов, описывающих схему ключей таблицы и индексов. Если вы добавляете новый глобальный вторичный индекс в таблицу, AttributeDefinitions должен включать ключ(и) нового индекса.
(структура)
Представляет атрибут для описания схемы таблицы и индексов.
AttributeName -> (строка)
AttributeType -> (строка)
Тип данных атрибута, где:
-
S— атрибут типа Строка -
N— атрибут типа Число -
B— атрибут типа Двоичные данные
Сокращённый синтаксис:
AttributeName=string,AttributeType=string ...
Синтаксис JSON:
[
{
"AttributeName": "string",
"AttributeType": "S"|"N"|"B"
}
...
]
--table-name (строка)
--billing-mode (строка)
Управляет тем, как вы оплачиваете пропускную способность чтения и записи и как управляете емкостью. При переходе от оплаты за запросы к пропускной способности с выделенными значениями необходимо установить начальные значения выделенной емкости. Начальные значения выделенной емкости оцениваются на основе потребляемой пропускной способности чтения и записи вашей таблицы и глобальных вторичных индексов за последние 30 минут.
-
PAY_PER_REQUEST— мы рекомендуем использоватьPAY_PER_REQUESTдля большинства рабочих нагрузок DynamoDB.PAY_PER_REQUESTустанавливает режим выставления счетов на режим запросов по требованию. -
PROVISIONED— мы рекомендуем использоватьPROVISIONEDдля стабильных рабочих нагрузок с прогнозируемым ростом, где требования к емкости можно надежно спрогнозировать.PROVISIONEDустанавливает режим выставления счетов на режим пропускной способности с выделенными значениями.
Возможные значения:
PROVISIONEDPAY_PER_REQUEST
--provisioned-throughput (структура)
Новые параметры пропускной способности с выделенными значениями для указанной таблицы или индекса.
ReadCapacityUnits -> (длинное целое)
Максимальное количество чтений с сильной последовательностью, потребляемых в секунду, прежде чем DynamoDB вернёт ThrottlingException. Дополнительную информацию см. в разделе Указание требований к чтению и записи в Руководстве разработчика Amazon DynamoDB.
Если режим пропускной способности чтения/записи PAY_PER_REQUEST, значение установлено в 0.
WriteCapacityUnits -> (длинное целое)
Максимальное количество записей, потребляемых в секунду, прежде чем DynamoDB вернёт ThrottlingException. Дополнительную информацию см. в разделе Указание требований к чтению и записи в Руководстве разработчика Amazon DynamoDB.
Если режим пропускной способности чтения/записи PAY_PER_REQUEST, значение установлено в 0.
Сокращённый синтаксис:
ReadCapacityUnits=long,WriteCapacityUnits=long
Синтаксис JSON:
{
"ReadCapacityUnits": long,
"WriteCapacityUnits": long
}
--global-secondary-index-updates (список)
Массив одного или нескольких глобальных вторичных индексов для таблицы. Для каждого индекса в массиве можно запросить одно действие:
-
Create- добавить новый глобальный вторичный индекс в таблицу. -
Update- изменить параметры пропускной способности существующего глобального вторичного индекса. -
Delete- удалить глобальный вторичный индекс из таблицы.
Можно создать или удалить только один глобальный вторичный индекс за одну операцию UpdateTable.
Дополнительную информацию см. в руководстве разработчика Amazon DynamoDB в разделе «Управление глобальными вторичными индексами».
(структура)
Представляет одно из следующих значений:
- Новый глобальный вторичный индекс, который нужно добавить в существующую таблицу.
- Новые параметры пропускной способности для существующего глобального вторичного индекса.
- Существующий глобальный вторичный индекс, который нужно удалить из существующей таблицы.
Update -> (структура)
Имя существующего глобального вторичного индекса вместе с новыми параметрами пропускной способности, которые нужно применить к этому индексу.
IndexName -> (строка)
ProvisionedThroughput -> (структура)
Представляет параметры пропускной способности для указанного глобального вторичного индекса.
Текущие минимальные и максимальные значения пропускной способности см. в разделе «Квоты сервиса, учетной записи и таблиц» в руководстве разработчика Amazon DynamoDB.
ReadCapacityUnits -> (длинное целое число)
Максимальное количество чтений со строгой консистентностью, потребляемых в секунду, прежде чем DynamoDB вернёт ThrottlingException. Дополнительные сведения см. в разделе «Указание требований к чтению и записи» в руководстве разработчика Amazon DynamoDB.
Если режим пропускной способности «чтение/запись» — PAY_PER_REQUEST, значение установлено в 0.
WriteCapacityUnits -> (длинное целое число)
Максимальное количество записей, потребляемых в секунду, прежде чем DynamoDB вернёт ThrottlingException. Дополнительные сведения см. в разделе «Указание требований к чтению и записи» в руководстве разработчика Amazon DynamoDB.
Если режим пропускной способности «чтение/запись» — PAY_PER_REQUEST, значение установлено в 0.
OnDemandThroughput -> (структура)
Обновляет максимальное количество единиц чтения и записи для указанного глобального вторичного индекса. Если вы используете этот параметр, вы должны указать MaxReadRequestUnits, MaxWriteRequestUnits или оба.
MaxReadRequestUnits -> (длинное целое число)
Максимальное количество единиц запросов чтения для указанной таблицы.
Чтобы указать максимальное OnDemandThroughput для вашей таблицы, установите значение MaxReadRequestUnits как больше или равно 1. Чтобы удалить максимальное OnDemandThroughput, которое в настоящее время установлено для вашей таблицы, установите значение MaxReadRequestUnits в -1.
MaxWriteRequestUnits -> (длинное целое число)
Максимальное количество единиц запросов записи для указанной таблицы.
Чтобы указать максимальное OnDemandThroughput для вашей таблицы, установите значение MaxWriteRequestUnits как больше или равно 1. Чтобы удалить максимальное OnDemandThroughput, которое в настоящее время установлено для вашей таблицы, установите значение MaxWriteRequestUnits в -1.
WarmThroughput -> (структура)
Представляет значение пропускной способности для разогрева новых параметров пропускной способности, которые будут применены к глобальному вторичному индексу.
ReadUnitsPerSecond -> (длинное целое число)
WriteUnitsPerSecond -> (длинное целое число)
Create -> (структура)
Параметры, необходимые для создания глобального вторичного индекса в существующей таблице:
IndexNameKeySchemaAttributeDefinitionsProjectionProvisionedThroughput
IndexName -> (строка)
KeySchema -> (список)
Схема ключей для глобального вторичного индекса.
(структура)
Представляет один элемент схемы ключей. Схема ключей определяет атрибуты, которые составляют первичный ключ таблицы или атрибуты ключей индекса.
KeySchemaElement представляет ровно один атрибут первичного ключа. Например, простой первичный ключ будет представлен одним KeySchemaElement (для партиционного ключа). Составной первичный ключ потребует одного KeySchemaElement для партиционного ключа и другого KeySchemaElement для ключа сортировки.
KeySchemaElement должен быть скалярным атрибутом верхнего уровня (не вложенным атрибутом). Тип данных должен быть String, Number или Binary. Атрибут не может быть вложен в List или Map.
AttributeName -> (строка)
KeyType -> (строка)
Роль, которую этот атрибут ключа будет выполнять:
-
HASH- партиционный ключ -
RANGE- ключ сортировки
Примечание
Партиционный ключ элемента также известен как его атрибут хеширования. Термин «атрибут хеширования» происходит от использования DynamoDB внутренней хеш-функции для равномерного распределения элементов данных по разделам на основе значений их партиционного ключа.
Ключ сортировки элемента также известен как его атрибут диапазона. Термин «атрибут диапазона» происходит от того, как DynamoDB хранит элементы с одинаковым партиционным ключом физически близко друг к другу в отсортированном порядке по значениям ключа сортировки.
Projection -> (структура)
Представляет атрибуты, которые копируются (проектируются) из таблицы в индекс. Это в дополнение к атрибутам первичного ключа и ключа индекса, которые автоматически проектируются.
ProjectionType -> (строка)
Набор атрибутов, которые проектируются в индекс:
-
KEYS_ONLY- Проектируются только атрибуты индекса и первичные ключи. -
INCLUDE- В дополнение к атрибутам, описанным вKEYS_ONLY, вторичный индекс будет включать другие атрибуты, не являющиеся ключами, которые вы укажете. -
ALL- Все атрибуты таблицы проектируются в индекс.
При использовании консоли DynamoDB ALL выбрано по умолчанию.
NonKeyAttributes -> (список)
Представляет имена атрибутов, не являющихся ключами, которые будут спроецированы в индекс.
Для глобальных и локальных вторичных индексов общее количество NonKeyAttributes по всем вторичным индексам не должно превышать 100. Если вы проектируете один и тот же атрибут в два разных индекса, это считается двумя различными атрибутами при определении общего числа. Это ограничение применяется только когда вы указывает ProjectionType INCLUDE. Вы все еще можете указать ProjectionType ALL, чтобы спроецировать все атрибуты из исходной таблицы, даже если таблица содержит более 100 атрибутов.
(строка)
ProvisionedThroughput -> (структура)
Представляет параметры пропускной способности для указанного глобального вторичного индекса.
Текущие минимальные и максимальные значения пропускной способности см. в разделе «Квоты сервиса, учетной записи и таблиц» в руководстве разработчика Amazon DynamoDB.
ReadCapacityUnits -> (длинное целое число)
Максимальное количество чтений со строгой консистентностью, потребляемых в секунду, прежде чем DynamoDB вернёт ThrottlingException. Дополнительные сведения см. в разделе «Указание требований к чтению и записи» в руководстве разработчика Amazon DynamoDB.
Если режим пропускной способности «чтение/запись» — PAY_PER_REQUEST, значение установлено в 0.
WriteCapacityUnits -> (длинное целое число)
Максимальное количество записей, потребляемых в секунду, прежде чем DynamoDB вернёт ThrottlingException. Дополнительные сведения см. в разделе «Указание требований к чтению и записи» в руководстве разработчика Amazon DynamoDB.
Если режим пропускной способности «чтение/запись» — PAY_PER_REQUEST, значение установлено в 0.
OnDemandThroughput -> (структура)
Максимальное количество единиц чтения и записи для создаваемого глобального вторичного индекса. Если вы используете этот параметр, вы должны указать MaxReadRequestUnits, MaxWriteRequestUnits или оба. Вы должны использовать либо OnDemand Throughput, либо ProvisionedThroughput в зависимости от режима пропускной способности вашей таблицы.
MaxReadRequestUnits -> (длинное целое число)
Максимальное количество единиц запросов чтения для указанной таблицы.
Чтобы указать максимальное OnDemandThroughput для вашей таблицы, установите значение MaxReadRequestUnits как больше или равно 1. Чтобы удалить максимальное OnDemandThroughput, которое в настоящее время установлено для вашей таблицы, установите значение MaxReadRequestUnits в -1.
MaxWriteRequestUnits -> (длинное целое число)
Максимальное количество единиц запросов записи для указанной таблицы.
Чтобы указать максимальное OnDemandThroughput для вашей таблицы, установите значение MaxWriteRequestUnits как больше или равно 1. Чтобы удалить максимальное OnDemandThroughput, которое в настоящее время установлено для вашей таблицы, установите значение MaxWriteRequestUnits в -1.
WarmThroughput -> (структура)
Представляет значение пропускной способности для разогрева (в единицах чтения в секунду и единицах записи в секунду) при создании вторичного индекса.
ReadUnitsPerSecond -> (длинное целое число)
WriteUnitsPerSecond -> (длинное целое число)
Delete -> (структура)
Имя существующего глобального вторичного индекса, который нужно удалить.
IndexName -> (строка)
Синтаксис JSON:
[
{
"Update": {
"IndexName": "string",
"ProvisionedThroughput": {
"ReadCapacityUnits": long,
"WriteCapacityUnits": long
},
"OnDemandThroughput": {
"MaxReadRequestUnits": long,
"MaxWriteRequestUnits": long
},
"WarmThroughput": {
"ReadUnitsPerSecond": long,
"WriteUnitsPerSecond": long
}
},
"Create": {
"IndexName": "string",
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "HASH"|"RANGE"
}
...
],
"Projection": {
"ProjectionType": "ALL"|"KEYS_ONLY"|"INCLUDE",
"NonKeyAttributes": ["string", ...]
},
"ProvisionedThroughput": {
"ReadCapacityUnits": long,
"WriteCapacityUnits": long
},
"OnDemandThroughput": {
"MaxReadRequestUnits": long,
"MaxWriteRequestUnits": long
},
"WarmThroughput": {
"ReadUnitsPerSecond": long,
"WriteUnitsPerSecond": long
}
},
"Delete": {
"IndexName": "string"
}
}
...
]
--stream-specification (структура)
Представляет конфигурацию DynamoDB Streams для таблицы.
Примечание
Вы получитеValidationException, если попытаетесь включить поток для таблицы, которая уже имеет поток, или если попытаетесь отключить поток для таблицы, у которой нет потока.StreamEnabled -> (булево значение)
StreamViewType -> (строка)
При изменении элемента в таблице StreamViewType определяет, какая информация записывается в поток для этой таблицы. Допустимые значения для StreamViewType:
-
KEYS_ONLY- В поток записываются только атрибуты ключа измененного элемента. -
NEW_IMAGE- В поток записывается весь элемент в виде, в котором он появляется после изменения. -
OLD_IMAGE- В поток записывается весь элемент в виде, в котором он существовал до изменения. -
NEW_AND_OLD_IMAGES- В поток записываются как новые, так и старые изображения элемента.
Краткая форма синтаксиса:
StreamEnabled=boolean,StreamViewType=string
Синтаксис JSON:
{
"StreamEnabled": true|false,
"StreamViewType": "NEW_IMAGE"|"OLD_IMAGE"|"NEW_AND_OLD_IMAGES"|"KEYS_ONLY"
}
--sse-specification (структура)
Новые параметры шифрования на стороне сервера для указанной таблицы.
Enabled -> (boolean)
KMS, и используется управляемый ключ Amazon Web Services (применяются сборы KMS). Если отключено (false) или не указано, шифрование на стороне сервера устанавливается в ключ, принадлежащий Amazon Web Services.SSEType -> (string)
Тип шифрования на стороне сервера. Поддерживается только одно значение:
-
KMS— Шифрование на стороне сервера с использованием Key Management Service. Ключ хранится в вашем аккаунте и управляется KMS (применяются сборы KMS).
KMSMasterKeyId -> (string)
alias/aws/dynamodb .Сокращенный синтаксис:
Enabled=boolean,SSEType=string,KMSMasterKeyId=string
Синтаксис JSON:
{
"Enabled": true|false,
"SSEType": "AES256"|"KMS",
"KMSMasterKeyId": "string"
}
--replica-updates (список)
Список действий обновления реплики таблицы (создание, удаление или обновление).
Примечание
Для глобальных таблиц этот параметр относится только к глобальным таблицам, использующим версию 2019.11.21 (текущая версия).(структура)
Представляет одно из следующих действий:
- Новая реплика, добавляемая к существующей региональной таблице или глобальной таблице. Этот запрос вызывает действие
CreateTableReplicaв целевом регионе. - Новые параметры для существующей реплики. Этот запрос вызывает действие
UpdateTableв целевом регионе. - Существующая реплика, подлежащая удалению. Запрос вызывает действие
DeleteTableReplicaв целевом регионе, удаляя реплику и все ее элементы в целевом регионе.
Примечание
При ручном удалении реплики таблицы или глобальной таблицы связанные масштабируемые цели, политики масштабирования или оповещения CloudWatch не удаляются автоматически.Create -> (структура)
Параметры, необходимые для создания реплики таблицы.
RegionName -> (строка)
KMSMasterKeyId -> (строка)
alias/aws/dynamodb .ProvisionedThroughputOverride -> (структура)
Производительность пропускной способности, специфичная для реплики. Если не указано, используются параметры пропускной способности исходной таблицы.
ReadCapacityUnits -> (целое число)
OnDemandThroughputOverride -> (структура)
Максимальные параметры пропускной способности по требованию для указанной реплики таблицы, которая создается. Вы можете изменить только MaxReadRequestUnits, потому что вы не можете изменить MaxWriteRequestUnits для отдельных таблиц реплик.
MaxReadRequestUnits -> (целое число)
GlobalSecondaryIndexes -> (список)
Параметры глобального вторичного индекса, специфичные для реплики.
(структура)
Представляет свойства глобального вторичного индекса реплики.
IndexName -> (строка)
ProvisionedThroughputOverride -> (структура)
Производительность пропускной способности, специфичная для GSI реплики таблицы. Если не указано, используются параметры пропускной способности чтения GSI исходной таблицы.
ReadCapacityUnits -> (целое число)
OnDemandThroughputOverride -> (структура)
Переопределяет максимальные параметры пропускной способности по требованию для указанного глобального вторичного индекса в указанной таблице реплики.
MaxReadRequestUnits -> (целое число)
TableClassOverride -> (строка)
Update -> (структура)
Параметры, необходимые для обновления реплики таблицы.
RegionName -> (строка)
KMSMasterKeyId -> (строка)
alias/aws/dynamodb .ProvisionedThroughputOverride -> (структура)
Производительность пропускной способности, специфичная для реплики. Если не указано, используются параметры пропускной способности исходной таблицы.
ReadCapacityUnits -> (целое число)
OnDemandThroughputOverride -> (структура)
Переопределяет максимальную пропускную способность по требованию для таблицы реплики.
MaxReadRequestUnits -> (целое число)
GlobalSecondaryIndexes -> (список)
Параметры глобального вторичного индекса, специфичные для реплики.
(структура)
Представляет свойства глобального вторичного индекса реплики.
IndexName -> (строка)
ProvisionedThroughputOverride -> (структура)
Производительность пропускной способности, специфичная для GSI реплики таблицы. Если не указано, используются параметры пропускной способности чтения GSI исходной таблицы.
ReadCapacityUnits -> (целое число)
OnDemandThroughputOverride -> (структура)
Переопределяет максимальные параметры пропускной способности по требованию для указанного глобального вторичного индекса в указанной таблице реплики.
MaxReadRequestUnits -> (целое число)
TableClassOverride -> (строка)
Delete -> (структура)
Параметры, необходимые для удаления реплики таблицы.
RegionName -> (строка)
Синтаксис JSON:
[
{
"Create": {
"RegionName": "string",
"KMSMasterKeyId": "string",
"ProvisionedThroughputOverride": {
"ReadCapacityUnits": long
},
"OnDemandThroughputOverride": {
"MaxReadRequestUnits": long
},
"GlobalSecondaryIndexes": [
{
"IndexName": "string",
"ProvisionedThroughputOverride": {
"ReadCapacityUnits": long
},
"OnDemandThroughputOverride": {
"MaxReadRequestUnits": long
}
}
...
],
"TableClassOverride": "STANDARD"|"STANDARD_INFREQUENT_ACCESS"
},
"Update": {
"RegionName": "string",
"KMSMasterKeyId": "string",
"ProvisionedThroughputOverride": {
"ReadCapacityUnits": long
},
"OnDemandThroughputOverride": {
"MaxReadRequestUnits": long
},
"GlobalSecondaryIndexes": [
{
"IndexName": "string",
"ProvisionedThroughputOverride": {
"ReadCapacityUnits": long
},
"OnDemandThroughputOverride": {
"MaxReadRequestUnits": long
}
}
...
],
"TableClassOverride": "STANDARD"|"STANDARD_INFREQUENT_ACCESS"
},
"Delete": {
"RegionName": "string"
}
}
...
]
--table-class (строка)
Класс таблицы обновляемой таблицы. Допустимые значения — STANDARD и STANDARD_INFREQUENT_ACCESS.
Возможные значения:
STANDARDSTANDARD_INFREQUENT_ACCESS
--deletion-protection-enabled | --no-deletion-protection-enabled (boolean)
--multi-region-consistency (строка)
Указывает режим согласованности для новой глобальной таблицы. Этот параметр действителен только при создании глобальной таблицы путем указания одного или нескольких действий Create в списке действия ReplicaUpdates.
Вы можете указать один из следующих режимов согласованности:
-
EVENTUAL: Настраивает новую глобальную таблицу для многорегиональной согласованности по умолчанию. Это режим согласованности по умолчанию для глобальных таблиц. -
STRONG: Настраивает новую глобальную таблицу для многорегиональной сильной согласованности (предварительный просмотр).
Примечание
Многорегиональная сильная согласованность (MRSC) — это новая возможность глобальных таблиц DynamoDB, доступная в режиме предварительного просмотра. Дополнительная информация приведена в разделе Многорегиональная сильная согласованность глобальных таблиц.Если этот параметр не указан, режим согласованности глобальной таблицы по умолчанию — EVENTUAL.
Возможные значения:
EVENTUALSTRONG
--on-demand-throughput (структура)
Обновляет максимальное количество единиц чтения и записи для указанной таблицы в режиме пропускной способности по требованию. Если вы используете этот параметр, вы должны указать MaxReadRequestUnits, MaxWriteRequestUnits или оба.
MaxReadRequestUnits -> (целое число)
Максимальное количество единиц запросов на чтение для указанной таблицы.
Чтобы указать максимальное количество OnDemandThroughput для вашей таблицы, установите значение MaxReadRequestUnits как больше или равно 1. Чтобы удалить максимальное значение OnDemandThroughput, которое в настоящее время установлено в вашей таблице, установите значение MaxReadRequestUnits в -1.
MaxWriteRequestUnits -> (целое число)
Максимальное количество единиц запросов на запись для указанной таблицы.
Чтобы указать максимальное значение OnDemandThroughput для вашей таблицы, установите значение MaxWriteRequestUnits как больше или равно 1. Чтобы удалить максимальное значение OnDemandThroughput, которое в настоящее время установлено в вашей таблице, установите значение MaxWriteRequestUnits в -1.
Сокращенный синтаксис:
MaxReadRequestUnits=long,MaxWriteRequestUnits=long
Синтаксис JSON:
{
"MaxReadRequestUnits": long,
"MaxWriteRequestUnits": long
}
--warm-throughput (структура)
Представляет тепловую пропускную способность (в единицах чтения в секунду и единицах записи в секунду) для обновления таблицы.
ReadUnitsPerSecond -> (целое число)
WriteUnitsPerSecond -> (целое число)
Сокращенный синтаксис:
ReadUnitsPerSecond=long,WriteUnitsPerSecond=long
Синтаксис JSON:
{
"ReadUnitsPerSecond": long,
"WriteUnitsPerSecond": long
}
--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
- текст
- таблица
- 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-auto-prompt (логическое значение)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическую запрос параметров ввода CLI.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей консоли. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.
Пример 1: Изменение режима выставления счетов таблицы
Следующий update-table пример увеличивает заданный объем памяти для чтения и записи в таблице MusicCollection.
aws dynamodb update-table \
--table-name MusicCollection \
--billing-mode PROVISIONED \
--provisioned-throughput ReadCapacityUnits=15,WriteCapacityUnits=10
Вывод:
{
"TableDescription": {
"AttributeDefinitions": [
{
"AttributeName": "AlbumTitle",
"AttributeType": "S"
},
{
"AttributeName": "Artist",
"AttributeType": "S"
},
{
"AttributeName": "SongTitle",
"AttributeType": "S"
}
],
"TableName": "MusicCollection",
"KeySchema": [
{
"AttributeName": "Artist",
"KeyType": "HASH"
},
{
"AttributeName": "SongTitle",
"KeyType": "RANGE"
}
],
"TableStatus": "UPDATING",
"CreationDateTime": "2020-05-26T15:59:49.473000-07:00",
"ProvisionedThroughput": {
"LastIncreaseDateTime": "2020-07-28T13:18:18.921000-07:00",
"NumberOfDecreasesToday": 0,
"ReadCapacityUnits": 15,
"WriteCapacityUnits": 10
},
"TableSizeBytes": 182,
"ItemCount": 2,
"TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection",
"TableId": "abcd0123-01ab-23cd-0123-abcdef123456",
"BillingModeSummary": {
"BillingMode": "PROVISIONED",
"LastUpdateToPayPerRequestDateTime": "2020-07-28T13:14:48.366000-07:00"
}
}
}
Дополнительную информацию см. в разделе Обновление таблицы в Руководстве разработчика Amazon DynamoDB.
Пример 2: Создание глобального вторичного индекса
В следующем примере к таблице MusicCollection добавляется глобальный вторичный индекс.
aws dynamodb update-table \
--table-name MusicCollection \
--attribute-definitions AttributeName=AlbumTitle,AttributeType=S \
--global-secondary-index-updates file://gsi-updates.json
Содержимое gsi-updates.json:
[
{
"Create": {
"IndexName": "AlbumTitle-index",
"KeySchema": [
{
"AttributeName": "AlbumTitle",
"KeyType": "HASH"
}
],
"ProvisionedThroughput": {
"ReadCapacityUnits": 10,
"WriteCapacityUnits": 10
},
"Projection": {
"ProjectionType": "ALL"
}
}
}
]
Вывод:
{
"TableDescription": {
"AttributeDefinitions": [
{
"AttributeName": "AlbumTitle",
"AttributeType": "S"
},
{
"AttributeName": "Artist",
"AttributeType": "S"
},
{
"AttributeName": "SongTitle",
"AttributeType": "S"
}
],
"TableName": "MusicCollection",
"KeySchema": [
{
"AttributeName": "Artist",
"KeyType": "HASH"
},
{
"AttributeName": "SongTitle",
"KeyType": "RANGE"
}
],
"TableStatus": "UPDATING",
"CreationDateTime": "2020-05-26T15:59:49.473000-07:00",
"ProvisionedThroughput": {
"LastIncreaseDateTime": "2020-07-28T12:59:17.537000-07:00",
"NumberOfDecreasesToday": 0,
"ReadCapacityUnits": 15,
"WriteCapacityUnits": 10
},
"TableSizeBytes": 182,
"ItemCount": 2,
"TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection",
"TableId": "abcd0123-01ab-23cd-0123-abcdef123456",
"BillingModeSummary": {
"BillingMode": "PROVISIONED",
"LastUpdateToPayPerRequestDateTime": "2020-07-28T13:14:48.366000-07:00"
},
"GlobalSecondaryIndexes": [
{
"IndexName": "AlbumTitle-index",
"KeySchema": [
{
"AttributeName": "AlbumTitle",
"KeyType": "HASH"
}
],
"Projection": {
"ProjectionType": "ALL"
},
"IndexStatus": "CREATING",
"Backfilling": false,
"ProvisionedThroughput": {
"NumberOfDecreasesToday": 0,
"ReadCapacityUnits": 10,
"WriteCapacityUnits": 10
},
"IndexSizeBytes": 0,
"ItemCount": 0,
"IndexArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/index/AlbumTitle-index"
}
]
}
}
Дополнительную информацию см. в разделе Обновление таблицы в Руководстве разработчика Amazon DynamoDB.
Пример 3: Включение DynamoDB Streams для таблицы
Следующая команда включает DynamoDB Streams для таблицы MusicCollection.
aws dynamodb update-table \
--table-name MusicCollection \
--stream-specification StreamEnabled=true,StreamViewType=NEW_IMAGE
Вывод:
{
"TableDescription": {
"AttributeDefinitions": [
{
"AttributeName": "AlbumTitle",
"AttributeType": "S"
},
{
"AttributeName": "Artist",
"AttributeType": "S"
},
{
"AttributeName": "SongTitle",
"AttributeType": "S"
}
],
"TableName": "MusicCollection",
"KeySchema": [
{
"AttributeName": "Artist",
"KeyType": "HASH"
},
{
"AttributeName": "SongTitle",
"KeyType": "RANGE"
}
],
"TableStatus": "UPDATING",
"CreationDateTime": "2020-05-26T15:59:49.473000-07:00",
"ProvisionedThroughput": {
"LastIncreaseDateTime": "2020-07-28T12:59:17.537000-07:00",
"NumberOfDecreasesToday": 0,
"ReadCapacityUnits": 15,
"WriteCapacityUnits": 10
},
"TableSizeBytes": 182,
"ItemCount": 2,
"TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection",
"TableId": "abcd0123-01ab-23cd-0123-abcdef123456",
"BillingModeSummary": {
"BillingMode": "PROVISIONED",
"LastUpdateToPayPerRequestDateTime": "2020-07-28T13:14:48.366000-07:00"
},
"LocalSecondaryIndexes": [
{
"IndexName": "AlbumTitleIndex",
"KeySchema": [
{
"AttributeName": "Artist",
"KeyType": "HASH"
},
{
"AttributeName": "AlbumTitle",
"KeyType": "RANGE"
}
],
"Projection": {
"ProjectionType": "INCLUDE",
"NonKeyAttributes": [
"Year",
"Genre"
]
},
"IndexSizeBytes": 139,
"ItemCount": 2,
"IndexArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/index/AlbumTitleIndex"
}
],
"GlobalSecondaryIndexes": [
{
"IndexName": "AlbumTitle-index",
"KeySchema": [
{
"AttributeName": "AlbumTitle",
"KeyType": "HASH"
}
],
"Projection": {
"ProjectionType": "ALL"
},
"IndexStatus": "ACTIVE",
"ProvisionedThroughput": {
"NumberOfDecreasesToday": 0,
"ReadCapacityUnits": 10,
"WriteCapacityUnits": 10
},
"IndexSizeBytes": 0,
"ItemCount": 0,
"IndexArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/index/AlbumTitle-index"
}
],
"StreamSpecification": {
"StreamEnabled": true,
"StreamViewType": "NEW_IMAGE"
},
"LatestStreamLabel": "2020-07-28T21:53:39.112",
"LatestStreamArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/stream/2020-07-28T21:53:39.112"
}
}
Дополнительную информацию см. в разделе Обновление таблицы в Руководстве разработчика Amazon DynamoDB.
Пример 4: Включение шифрования на стороне сервера
В следующем примере включено шифрование на стороне сервера для таблицы MusicCollection.
aws dynamodb update-table \
--table-name MusicCollection \
--sse-specification Enabled=true,SSEType=KMS
Вывод:
{
"TableDescription": {
"AttributeDefinitions": [
{
"AttributeName": "AlbumTitle",
"AttributeType": "S"
},
{
"AttributeName": "Artist",
"AttributeType": "S"
},
{
"AttributeName": "SongTitle",
"AttributeType": "S"
}
],
"TableName": "MusicCollection",
"KeySchema": [
{
"AttributeName": "Artist",
"KeyType": "HASH"
},
{
"AttributeName": "SongTitle",
"KeyType": "RANGE"
}
],
"TableStatus": "ACTIVE",
"CreationDateTime": "2020-05-26T15:59:49.473000-07:00",
"ProvisionedThroughput": {
"LastIncreaseDateTime": "2020-07-28T12:59:17.537000-07:00",
"NumberOfDecreasesToday": 0,
"ReadCapacityUnits": 15,
"WriteCapacityUnits": 10
},
"TableSizeBytes": 182,
"ItemCount": 2,
"TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection",
"TableId": "abcd0123-01ab-23cd-0123-abcdef123456",
"BillingModeSummary": {
"BillingMode": "PROVISIONED",
"LastUpdateToPayPerRequestDateTime": "2020-07-28T13:14:48.366000-07:00"
},
"LocalSecondaryIndexes": [
{
"IndexName": "AlbumTitleIndex",
"KeySchema": [
{
"AttributeName": "Artist",
"KeyType": "HASH"
},
{
"AttributeName": "AlbumTitle",
"KeyType": "RANGE"
}
],
"Projection": {
"ProjectionType": "INCLUDE",
"NonKeyAttributes": [
"Year",
"Genre"
]
},
"IndexSizeBytes": 139,
"ItemCount": 2,
"IndexArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/index/AlbumTitleIndex"
}
],
"GlobalSecondaryIndexes": [
{
"IndexName": "AlbumTitle-index",
"KeySchema": [
{
"AttributeName": "AlbumTitle",
"KeyType": "HASH"
}
],
"Projection": {
"ProjectionType": "ALL"
},
"IndexStatus": "ACTIVE",
"ProvisionedThroughput": {
"NumberOfDecreasesToday": 0,
"ReadCapacityUnits": 10,
"WriteCapacityUnits": 10
},
"IndexSizeBytes": 0,
"ItemCount": 0,
"IndexArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/index/AlbumTitle-index"
}
],
"StreamSpecification": {
"StreamEnabled": true,
"StreamViewType": "NEW_IMAGE"
},
"LatestStreamLabel": "2020-07-28T21:53:39.112",
"LatestStreamArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/stream/2020-07-28T21:53:39.112",
"SSEDescription": {
"Status": "UPDATING"
}
}
}
Дополнительную информацию см. в разделе Обновление таблицы в Руководстве разработчика Amazon DynamoDB.
Вывод
Описание таблицы -> (структура)
Представляет свойства таблицы.
Определения атрибутов -> (список)
Массив объектов AttributeDefinition. Каждый из этих объектов описывает один атрибут в таблице и схеме индексов.
Каждый объект AttributeDefinition в этом массиве состоит из:
-
AttributeName- Название атрибута. -
AttributeType- Тип данных для атрибута.
(структура)
Представляет атрибут для описания схемы таблицы и индексов.
Имя атрибута -> (строка)
Тип атрибута -> (строка)
Тип данных для атрибута, где:
-
S- атрибут типа Строка -
N- атрибут типа Число -
B- атрибут типа Двоичные данные
Имя таблицы -> (строка)
Схема ключей -> (список)
Структура первичного ключа таблицы. Каждый элемент KeySchemaElement состоит из:
-
AttributeName- Название атрибута. -
KeyType- Роль атрибута:-
HASH- ключ разбиения -
RANGE- ключ сортировки
-
Примечание
Ключ разбиения элемента также известен как его атрибут хеширования. Термин «атрибут хеширования» происходит от использования DynamoDB внутренней функции хеширования для равномерного распределения элементов данных по разделам на основе значений ключа разбиения.
Ключ сортировки элемента также известен как его атрибут диапазона. Термин «атрибут диапазона» происходит от способа хранения DynamoDB элементов с одинаковым ключом разбиения физически близко друг к другу в отсортированном порядке по значению ключа сортировки.
Дополнительную информацию о первичных ключах см. в разделе «Первичный ключ» в руководстве разработчика Amazon DynamoDB.
(структура)
Представляет отдельный элемент схемы ключей. Схема ключей определяет атрибуты, составляющие первичный ключ таблицы или ключевые атрибуты индекса.
Элемент KeySchemaElement представляет ровно один атрибут первичного ключа. Например, простой первичный ключ будет представлен одним элементом KeySchemaElement (для ключа разбиения). Составной первичный ключ потребует одного элемента KeySchemaElement для ключа разбиения и другого элемента KeySchemaElement для ключа сортировки.
Элемент KeySchemaElement должен быть скалярным атрибутом верхнего уровня (не вложенным атрибутом). Тип данных должен быть одним из String, Number или Binary. Атрибут не может быть вложен в список или карту.
Имя атрибута -> (строка)
Тип ключа -> (строка)
Роль, которую будет выполнять этот ключевой атрибут:
-
HASH- ключ разбиения -
RANGE- ключ сортировки
Примечание
Ключ разбиения элемента также известен как его атрибут хеширования. Термин «атрибут хеширования» происходит от использования DynamoDB внутренней функции хеширования для равномерного распределения элементов данных по разделам на основе значений ключа разбиения.
Ключ сортировки элемента также известен как его атрибут диапазона. Термин «атрибут диапазона» происходит от способа хранения DynamoDB элементов с одинаковым ключом разбиения физически близко друг к другу в отсортированном порядке по значению ключа сортировки.
Статус таблицы -> (строка)
Текущее состояние таблицы:
-
CREATING- Таблица создается. -
UPDATING- Конфигурация таблицы/индекса обновляется. Таблица/индекс остаются доступными для операций с данными, когдаUPDATING. -
DELETING- Таблица удаляется. -
ACTIVE- Таблица готова к использованию. -
INACCESSIBLE_ENCRYPTION_CREDENTIALS- Ключ KMS, используемый для шифрования таблицы, недоступен. Операции с таблицей могут завершиться неудачей из-за невозможности использования ключа KMS. DynamoDB инициирует процесс архивации таблицы, если ключ KMS таблицы остается недоступным более семи дней. -
ARCHIVING- Таблица архивируется. Операции запрещены до завершения архивации. -
ARCHIVED- Таблица архивирована. Дополнительную информацию см. в поле ArchivalReason.
Дата создания -> (временная метка)
Зарезервированная пропускная способность -> (структура)
Настройки зарезервированной пропускной способности для таблицы, состоящие из единиц пропускной способности чтения и записи, а также данных об увеличении и уменьшении.
Последняя дата увеличения -> (временная метка)
Последняя дата уменьшения -> (временная метка)
Количество уменьшений сегодня -> (целое число)
Единицы пропускной способности чтения -> (целое число)
ThrottlingException. Чтения с нестрогой консистентностью требуют меньших затрат, чем чтения с сильной консистентностью, поэтому значение 50 ReadCapacityUnits в секунду обеспечивает 100 чтений с нестрогой консистентностью в секунду.Единицы пропускной способности записи -> (целое число)
ThrottlingException.Размер таблицы (байты) -> (целое число)
Количество элементов -> (целое число)
ARN таблицы -> (строка)
Идентификатор таблицы -> (строка)
Резюме режима оплаты -> (структура)
Содержит сведения о режиме пропускной способности чтения/записи.
Режим оплаты -> (строка)
Управляет тем, как вы оплачиваете пропускную способность чтения и записи и как управляете емкостью. Это значение можно изменить позже.
-
PROVISIONED- Устанавливает режим пропускной способности чтения/записи в режимPROVISIONED. Рекомендуется использоватьPROVISIONEDдля предсказуемых рабочих нагрузок. -
PAY_PER_REQUEST- Устанавливает режим пропускной способности чтения/записи в режимPAY_PER_REQUEST. Рекомендуется использоватьPAY_PER_REQUESTдля непредсказуемых рабочих нагрузок.
Последняя дата изменения на оплату за запрос -> (временная метка)
PAY_PER_REQUEST был в последний раз установлен как режим пропускной способности чтения/записи.Дополнительные локальные индексы -> (список)
Представляет один или несколько локальных вторичных индексов в таблице. Каждый индекс ограничен значением ключа разбиения. Таблицы с одним или несколькими локальными вторичными индексами ограничены размером коллекции элементов, где объём данных в данной коллекции не должен превышать 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 -> (целое число)
ItemCount -> (целое число)
IndexArn -> (строка)
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. Атрибут не может быть вложен в List или Map.
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 -> (целое число)
ReadCapacityUnits -> (целое число)
ThrottlingException. Чтения со слабой согласованностью требуют меньше усилий, чем чтения с сильной согласованностью, поэтому значение 50 ReadCapacityUnits в секунду обеспечивает 100 чтений со слабой согласованностью ReadCapacityUnits в секунду.WriteCapacityUnits -> (целое число)
ThrottlingException.IndexSizeBytes -> (целое число)
ItemCount -> (целое число)
IndexArn -> (строка)
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 -> (булево)
StreamViewType -> (строка)
При изменении элемента в таблице StreamViewType определяет, какая информация записывается в поток для этой таблицы. Допустимые значения для StreamViewType:
-
KEYS_ONLY- В поток записываются только атрибуты ключа изменённого элемента. -
NEW_IMAGE- В поток записывается весь элемент в виде, в котором он появляется после изменения. -
OLD_IMAGE- В поток записывается весь элемент в виде, в котором он был до изменения. -
NEW_AND_OLD_IMAGES- В поток записываются и новая, и старая версии элемента.
LatestStreamLabel -> (строка)
Временная метка в формате ISO 8601 для этого потока.
Обратите внимание, что LatestStreamLabel не является уникальным идентификатором потока, так как возможно, что поток из другой таблицы может иметь ту же временную метку. Однако комбинация следующих трех элементов гарантированно уникальна:
- Идентификатор клиента Amazon Web Services
- Имя таблицы
StreamLabel
LatestStreamArn -> (строка)
GlobalTableVersion -> (строка)
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 -> (строка)
KMSMasterKeyId -> (строка)
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 -> (строка)
SourceTableArn -> (строка)
RestoreDateTime -> (метка времени)
RestoreInProgress -> (булево)
SSEDescription -> (структура)
Описание состояния шифрования на стороне сервера для указанной таблицы.
Status -> (строка)
Представляет текущее состояние шифрования на стороне сервера. Допустимые значения:
-
ENABLED- Шифрование на стороне сервера включено. -
UPDATING- Шифрование на стороне сервера обновляется.
SSEType -> (строка)
Тип шифрования на стороне сервера. Допустимое значение:
-
KMS- Шифрование на стороне сервера, использующее Key Management Service. Ключ хранится в вашем аккаунте и управляется KMS (применяются сборы KMS).
KMSMasterKeyArn -> (строка)
InaccessibleEncryptionDateTime -> (метка времени)
ArchivalSummary -> (структура)
Содержит информацию об архиве таблицы.
ArchivalDateTime -> (метка времени)
ArchivalReason -> (строка)
Причина архивации таблицы DynamoDB. В настоящее время единственное возможное значение:
-
INACCESSIBLE_ENCRYPTION_CREDENTIALS- Таблица была архивирована из-за недоступности ключа KMS таблицы более семи дней. В момент архивации была создана резервная копия по требованию.
ArchivalBackupArn -> (строка)
TableClassSummary -> (структура)
Содержит данные о классе таблицы.
TableClass -> (строка)
STANDARD и STANDARD_INFREQUENT_ACCESS.LastUpdateDateTime -> (метка времени)
DeletionProtectionEnabled -> (булево)
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 для глобальных таблиц, которая в настоящее время доступна в режиме предварительной версии. Дополнительную информацию см. в Global tables multi-Region strong consistency.Если вы не укажете это поле, режим согласованности глобальной таблицы будет по умолчанию EVENTUAL.
© Copyright 2025, Amazon Web Services. Created using Sphinx.