Spec-Zone.ru › AWS CLI v2

[ aws . rds . wait ]

db-snapshot-completed

Описание

Ожидание, пока при опросе с помощью describe-db-snapshots будет брошено исключение DBSnapshotNotFound. Будет происходить опрос каждые 15 секунд до достижения успешного состояния. Выполнение завершится с кодом возврата 255 после 40 неудачных проверок.

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

db-snapshot-completed — это постраничная операция. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответ на постраничный вывод, аргумент --query должен извлекать данные из результатов следующих выражений запроса: DBSnapshots

Синтаксис

  db-snapshot-completed
[--db-instance-identifier <value>]
[--db-snapshot-identifier <value>]
[--snapshot-type <value>]
[--filters <value>]
[--include-shared | --no-include-shared]
[--include-public | --no-include-public]
[--dbi-resource-id <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

--db-instance-identifier (строка)

Идентификатор экземпляра БД для получения списка снимков БД. Этот параметр нечувствителен к регистру.

Ограничения:

  • Если указан, должен соответствовать идентификатору существующего DBInstance.

--db-snapshot-identifier (строка)

Уникальный идентификатор снимка БД для описания. Это значение хранится в виде строчной строки.

Ограничения:

  • Если указан, должен соответствовать идентификатору существующего DBSnapshot.
  • Если этот идентификатор относится к автоматическому снимку, также должен быть указан параметр SnapshotType.

--snapshot-type (строка)

Тип снимков, которые должны быть возвращены. Вы можете указать одно из следующих значений:

  • automated — вернуть все снимки БД, автоматически созданные Amazon RDS для моей учетной записи Amazon Web Services.
  • manual — вернуть все снимки БД, созданные моей учетной записью Amazon Web Services.
  • shared — вернуть все ручные снимки БД, которые были предоставлены для моей учетной записи Amazon Web Services.
  • public — вернуть все снимки БД, помеченные как публичные.
  • awsbackup — вернуть снимки БД, управляемые службой резервного копирования Amazon Web Services. Для получения информации о службе резервного копирования Amazon Web Services, см. « Руководство разработчика службы резервного копирования Amazon Web Services. https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html`__ Тип awsbackup не применим к Aurora.

Если вы не указываете значение SnapshotType, то возвращаются как автоматические, так и ручные снимки. По умолчанию, общие и публичные снимки БД не включаются в результаты. Вы можете включить общие снимки в эти результаты, включив параметр IncludeShared. Вы можете включить публичные снимки в эти результаты, включив параметр IncludePublic.

Параметры IncludeShared и IncludePublic не применяются для значений SnapshotType manual или automated . Параметр IncludePublic не применяется, когда SnapshotType установлено в значение shared . Параметр IncludeShared не применяется, когда SnapshotType установлено в значение public .

--filters (список)

Фильтр, который указывает один или несколько снимков БД для описания.

Поддерживаемые фильтры:

  • db-instance-id — принимает идентификаторы экземпляров БД и Amazon Resource Names (ARN) экземпляров БД.
  • db-snapshot-id — принимает идентификаторы снимков БД.
  • dbi-resource-id — принимает идентификаторы исходных экземпляров БД.
  • snapshot-type — принимает типы снимков БД.
  • engine — принимает имена баз данных.

(структура)

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

Примечание

В настоящее время в фильтрах не поддерживаются подстановочные знаки.

Следующие действия могут быть отфильтрованы:

  • DescribeDBClusterBacktracks
  • DescribeDBClusterEndpoints
  • DescribeDBClusters
  • DescribeDBInstances
  • DescribeDBRecommendations
  • DescribeDBShardGroups
  • DescribePendingMaintenanceActions

Имя -> (строка)

Имя фильтра. Имена фильтров чувствительны к регистру.

Значения -> (список)

Одно или несколько значений фильтра. Значения фильтров чувствительны к регистру.

(строка)

Сокращенный синтаксис:

Name=string,Values=string,string ...

Синтаксис JSON:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--include-shared | --no-include-shared (логическое значение)

Указывает, следует ли включать общие ручные снимки кластеров БД из других учетных записей Amazon Web Services, для копирования или восстановления которых этой учетной записи Amazon Web Services предоставлены разрешения. По умолчанию эти снимки не включаются.

Вы можете предоставить учетной записи Amazon Web Services разрешения на восстановление ручного снимка БД из другой учетной записи Amazon Web Services, используя действие API ModifyDBSnapshotAttribute.

Это настройка не применима к RDS Custom.

--include-public | --no-include-public (логическое значение)

Указывает, следует ли включать ручные снимки кластеров БД, которые являются публичными и могут быть скопированы или восстановлены любой учетной записью Amazon Web Services. По умолчанию публичные снимки не включаются.

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

Это настройка не применима к RDS Custom.

--dbi-resource-id (строка)

Уникальный идентификатор ресурса БД для описания.

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

--starting-token (строка)

Токен для указания точки начала постраничного вывода. Это NextToken из ранее урезанного ответа.

Примеры использования см. в разделе «Постраничный вывод» в руководстве пользователя AWS CLI.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-службы. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-службы, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-службы.

Примеры использования см. в разделе «Постраничный вывод» в руководстве пользователя AWS CLI.

--max-items (целое число)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Чтобы продолжить постраничный вывод, предоставьте значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую за пределами AWS CLI.

Примеры использования см. в разделе «Постраничный вывод» в руководстве пользователя AWS CLI.

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

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

--debug (boolean)

Включить отладку логирования.

--endpoint-url (string)

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

--no-verify-ssl (boolean)

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

--no-paginate (boolean)

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

--output (string)

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

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

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

--profile (string)

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

--region (string)

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

--version (string)

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

--color (string)

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

  • on
  • off
  • auto

--no-sign-request (boolean)

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

--ca-bundle (string)

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

--cli-read-timeout (int)

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

--cli-connect-timeout (int)

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

--cli-binary-format (string)

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

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Отключить пагинатор CLI для вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Вывод

Нет

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

Spec-Zone.ru

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