describe-backup
Описание
Описывает существующую резервную копию таблицы.
Вы можете вызвать DescribeBackup не чаще, чем 10 раз в секунду.
См. также: Документацию API AWS
Синтаксис
describe-backup
--backup-arn <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]
Параметры
--backup-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
- текст
- таблица
- 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.
Чтобы получить информацию о существующей резервной копии таблицы
Следующий describe-backup пример отображает информацию о заданной существующей резервной копии.
aws dynamodb describe-backup \
--backup-arn arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/backup/01576616366715-b4e58d3a
Вывод:
{
"BackupDescription": {
"BackupDetails": {
"BackupArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/backup/01576616366715-b4e58d3a",
"BackupName": "MusicCollectionBackup",
"BackupSizeBytes": 0,
"BackupStatus": "AVAILABLE",
"BackupType": "USER",
"BackupCreationDateTime": 1576616366.715
},
"SourceTableDetails": {
"TableName": "MusicCollection",
"TableId": "b0c04bcc-309b-4352-b2ae-9088af169fe2",
"TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection",
"TableSizeBytes": 0,
"KeySchema": [
{
"AttributeName": "Artist",
"KeyType": "HASH"
},
{
"AttributeName": "SongTitle",
"KeyType": "RANGE"
}
],
"TableCreationDateTime": 1576615228.571,
"ProvisionedThroughput": {
"ReadCapacityUnits": 5,
"WriteCapacityUnits": 5
},
"ItemCount": 0,
"BillingMode": "PROVISIONED"
},
"SourceTableFeatureDetails": {}
}
}
Дополнительную информацию см. в разделе «Резервное копирование и восстановление по требованию для DynamoDB» в Руководстве разработчика Amazon DynamoDB.
Вывод
BackupDescription -> (структура)
Содержит описание резервной копии, созданной для таблицы.
BackupDetails -> (структура)
Содержит детали резервной копии, созданной для таблицы.
BackupArn -> (строка)
BackupName -> (строка)
BackupSizeBytes -> (длинное целое)
BackupStatus -> (строка)
BackupType -> (строка)
Тип резервной копии:
-
USER- Вы создаете и управляете ими с помощью функции резервного копирования по требованию. -
SYSTEM- Если вы удаляете таблицу с включенной функцией восстановления по состоянию на определенный момент времени, резервная копияSYSTEMавтоматически создается и сохраняется в течение 35 дней (без дополнительной платы). Системные резервные копии позволяют восстановить удаленную таблицу в состоянии, в котором она находилась непосредственно перед удалением. -
AWS_BACKUP- Резервная копия по требованию, созданная вами из службы резервного копирования.
BackupCreationDateTime -> (метка времени)
BackupExpiryDateTime -> (метка времени)
SYSTEM резервная копия по требованию истекает автоматически через 35 дней после ее создания.SourceTableDetails -> (структура)
Содержит детали таблицы на момент создания резервной копии.
TableName -> (строка)
TableId -> (строка)
TableArn -> (строка)
TableSizeBytes -> (длинное целое)
KeySchema -> (список)
Схема таблицы.
(структура)
Представляет один элемент схемы ключа. Схема ключа определяет атрибуты, составляющие первичный ключ таблицы или атрибуты ключа индекса.
KeySchemaElement представляет ровно один атрибут первичного ключа. Например, простой первичный ключ будет представлен одним KeySchemaElement (для ключа разделения). Составной первичный ключ потребует один KeySchemaElement для ключа разделения и другой KeySchemaElement для ключа сортировки.
KeySchemaElement должен быть скалярным атрибутом верхнего уровня (не вложенным атрибутом). Тип данных должен быть строкой, числом или двоичным. Атрибут не может быть вложен в список или карту.
AttributeName -> (строка)
KeyType -> (строка)
Роль, которую будет выполнять этот атрибут ключа:
-
HASH- ключ разделения -
RANGE- ключ сортировки
Примечание
Ключ разделения элемента также известен как его атрибут хеширования . Термин «атрибут хеширования» происходит от использования DynamoDB внутренней функции хеширования для равномерного распределения элементов данных по разделам на основе значений ключа разделения.
Ключ сортировки элемента также известен как его атрибут диапазона . Термин «атрибут диапазона» происходит от того, как DynamoDB хранит элементы с одинаковым ключом разделения физически близко друг к другу в отсортированном порядке по значению ключа сортировки.
TableCreationDateTime -> (метка времени)
ProvisionedThroughput -> (структура)
Вводно-вывод операций чтения и записи в таблице на момент создания резервной копии.
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.
ItemCount -> (длинное целое)
BillingMode -> (строка)
Управляет тем, как вы оплачиваете пропускную способность чтения и записи и как управляете емкостью. Это значение можно изменить позже.
-
PROVISIONED- Устанавливает режим емкости чтения/записи вPROVISIONED. Мы рекомендуем использоватьPROVISIONEDдля предсказуемых рабочих нагрузок. -
PAY_PER_REQUEST- Устанавливает режим емкости чтения/записи вPAY_PER_REQUEST. Мы рекомендуем использоватьPAY_PER_REQUESTдля непредсказуемых рабочих нагрузок.
SourceTableFeatureDetails -> (структура)
Содержит подробности о включенных функциях в таблице при создании резервной копии. Например, LSIs, GSIs, потоки, TTL.
LocalSecondaryIndexes -> (список)
Представляет свойства LSI для таблицы при создании резервной копии. Включает IndexName, KeySchema и Projection для LSIs в таблице на момент резервного копирования.
(структура)
Представляет свойства локального вторичного индекса для таблицы при создании резервной копии.
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. Если вы проектируете один и тот же атрибут в два разных индекса, это учитывается как два разных атрибута при определении общего количества. Это ограничение применяется только при указании типа Projection INCLUDE. Вы все равно можете указать тип Projection ALL, чтобы спроектировать все атрибуты из исходной таблицы, даже если таблица имеет более 100 атрибутов.
(строка)
GlobalSecondaryIndexes -> (список)
Представляет свойства GSI для таблицы при создании резервной копии. Включает IndexName, KeySchema, Projection и ProvisionedThroughput для GSI в таблице на момент резервного копирования.
(структура)
Представляет свойства глобального вторичного индекса для таблицы при создании резервной копии.
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. Если вы проектируете один и тот же атрибут в два разных индекса, это учитывается как два разных атрибута при определении общего количества. Это ограничение применяется только при указании типа Projection INCLUDE. Вы все равно можете указать тип Projection ALL, чтобы спроектировать все атрибуты из исходной таблицы, даже если таблица имеет более 100 атрибутов.
(строка)
ProvisionedThroughput -> (структура)
Представляет настройки пропускной способности для указанного глобального вторичного индекса.
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.
StreamDescription -> (структура)
Настройки потока в таблице на момент создания резервной копии.
StreamEnabled -> (boolean)
StreamViewType -> (string)
Когда элемент в таблице изменяется, StreamViewType определяет, какая информация записывается в поток для этой таблицы. Допустимые значения для StreamViewType:
-
KEYS_ONLY- В поток записываются только атрибуты ключа изменённого элемента. -
NEW_IMAGE- В поток записывается весь элемент в виде, в котором он существует после изменения. -
OLD_IMAGE- В поток записывается весь элемент в виде, в котором он существовал до изменения. -
NEW_AND_OLD_IMAGES- В поток записываются как новый, так и старый вид элемента.
TimeToLiveDescription -> (structure)
Настройки Time to Live в таблице на момент создания резервной копии.
TimeToLiveStatus -> (string)
AttributeName -> (string)
SSEDescription -> (structure)
Описание состояния шифрования на стороне сервера в таблице на момент создания резервной копии.
Status -> (string)
Представляет текущее состояние шифрования на стороне сервера. Поддерживаются только следующие значения:
-
ENABLED- Шифрование на стороне сервера включено. -
UPDATING- Шифрование на стороне сервера обновляется.
SSEType -> (string)
Тип шифрования на стороне сервера. Поддерживается только одно значение:
-
KMS- Шифрование на стороне сервера с использованием Key Management Service. Ключ хранится в вашем аккаунте и управляется KMS (применяются сборы KMS).
KMSMasterKeyArn -> (string)
InaccessibleEncryptionDateTime -> (timestamp)
© Copyright 2025, Amazon Web Services. Created using Sphinx.