Spec-Zone.ru › AWS CLI v2

[ aws . dynamodb ]

удаление резервной копии

Описание

Удаляет существующую резервную копию таблицы.

Вы можете вызывать DeleteBackup не чаще, чем 10 раз в секунду.

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

Синтаксис

  delete-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 (строка)

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 для вывода.

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Примечание

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

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

Удаление существующей резервной копии DynamoDB

Следующий delete-backup пример удаляет указанную существующую резервную копию.

aws dynamodb delete-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": "DELETED",
            "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 -> (строка)

ARN, связанный с резервной копией.

BackupName -> (строка)

Имя запрошенной резервной копии.

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

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

BackupStatus -> (строка)

Резервная копия может находиться в одном из следующих состояний: CREATING, ACTIVE, DELETED.

BackupType -> (строка)

BackupType:

  • USER - Вы создаете и управляете ими с помощью функции резервного копирования по требованию.
  • SYSTEM - Если вы удаляете таблицу с включенной функцией восстановления в определенный момент времени, автоматически создается резервная копия SYSTEM и сохраняется в течение 35 дней (без дополнительных затрат). Системные резервные копии позволяют восстановить удаленную таблицу в состоянии, в котором она находилась непосредственно перед удалением.
  • AWS_BACKUP - Резервная копия по требованию, созданная вами из службы резервного копирования.

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

Время создания резервной копии. Это время запроса на создание резервной копии.

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

Время, в которое истекает срок действия автоматической резервной копии по требованию, созданной DynamoDB. Эта резервная копия по требованию SYSTEM автоматически истекает через 35 дней после ее создания.

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

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

TableName -> (строка)

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

TableId -> (строка)

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

TableArn -> (строка)

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

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

Размер таблицы в байтах. Обратите внимание, что это приблизительное значение.

KeySchema -> (список)

Схема таблицы.

(структура)

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

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

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

AttributeName -> (строка)

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

KeyType -> (строка)

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

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

Примечание

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

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

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

Время создания исходной таблицы.

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

Read IOPs и Write IOPS в таблице на момент создания резервной копии.

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. Атрибут не может быть вложен в список или карту.

AttributeName -> (строка)

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

KeyType -> (строка)

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

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

Примечание

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

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

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

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

ProjectionType -> (строка)

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

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

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

NonKeyAttributes -> (список)

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

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

(строка)

GlobalSecondaryIndexes -> (список)

Представляет свойства GSI для таблицы при создании резервной копии. Включает IndexName, KeySchema, Projection и ProvisionedThroughput для GSI в таблице на момент создания резервной копии.

(структура)

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

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 атрибутов.

(строка)

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)

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

StreamViewType -> (string)

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

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

TimeToLiveDescription -> (structure)

Настройки Time to Live на таблице во время создания резервной копии.

TimeToLiveStatus -> (string)

Статус TTL для таблицы.

AttributeName -> (string)

Имя атрибута TTL для элементов в таблице.

SSEDescription -> (structure)

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

Status -> (string)

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

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

SSEType -> (string)

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

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

KMSMasterKeyArn -> (string)

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

InaccessibleEncryptionDateTime -> (timestamp)

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

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

Spec-Zone.ru

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