Spec-Zone.ru › AWS CLI v2

[ aws . redshift . wait ]

snapshot-available

Описание

Дождитесь, пока запрос JMESPath Snapshots[].Status вернёт значение available для всех элементов при опросе с помощью describe-cluster-snapshots. Будет происходить опрос каждые 15 секунд, пока не будет достигнут успешный статус. Команда завершится с кодом возврата 255 после 20 неудачных проверок.

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

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

Синтаксис

  snapshot-available
[--cluster-identifier <value>]
[--snapshot-identifier <value>]
[--snapshot-arn <value>]
[--snapshot-type <value>]
[--start-time <value>]
[--end-time <value>]
[--owner-account <value>]
[--tag-keys <value>]
[--tag-values <value>]
[--cluster-exists | --no-cluster-exists]
[--sorting-entities <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]

Параметры

--cluster-identifier (строка)

Идентификатор кластера, который сгенерировал запрошенные снимки.

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

Идентификатор снимка, о котором требуется вернуть информацию.

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

Amazon Resource Name (ARN) снимка, связанного с сообщением для описания снимков кластеров.

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

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

Допустимые значения: automated | manual

--start-time (метка времени)

Значение, запрашивающее только снимки, созданные в или после указанного времени. Значение времени указывается в формате ISO 8601. Более подробную информацию о формате ISO 8601 можно найти на странице ISO8601 в Википедии.

Пример: 2012-07-16T18:00:00Z

--end-time (метка времени)

Значение времени, запрашивающее только снимки, созданные в или до указанного времени. Значение времени указывается в формате ISO 8601. Более подробную информацию о формате ISO 8601 можно найти на странице ISO8601 в Википедии.

Пример: 2012-07-16T18:00:00Z

--owner-account (строка)

Amazon Web Services учётная запись, используемая для создания или копирования снимка. Используйте это поле для фильтрации результатов, чтобы получить снимки, принадлежащие определённой учётной записи. Для описания ваших снимков, либо укажите свою Amazon Web Services учётную запись, либо не указывайте параметр.

--tag-keys (список)

Ключ(и) тега, для которых требуется вернуть все соответствующие снимки кластера, связанные с указанным ключом(ами). Например, предположим, что у вас есть снимки, помеченные ключами owner и environment. Если вы укажете оба этих ключа тега в запросе, Amazon Redshift вернёт ответ со снимками, у которых ассоциированы либо один, либо оба из этих ключей тегов.

(строка)

Синтаксис:

"string" "string" ...

--tag-values (список)

Значение(я) тега, для которых требуется вернуть все соответствующие снимки кластера, связанные с указанным значением(ями) тега. Например, предположим, что у вас есть снимки, помеченные значениями admin и test. Если вы укажете оба этих значения тега в запросе, Amazon Redshift вернёт ответ со снимками, у которых ассоциированы либо один, либо оба из этих значений тега.

(строка)

Синтаксис:

"string" "string" ...

--cluster-exists | --no-cluster-exists (булево)

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

  • Если ClusterExists установлено в true, необходимо указать ClusterIdentifier.
  • Если ClusterExists установлено в false и ClusterIdentifier не указано, возвращаются все снимки, связанные с удалёнными кластерами (осиротевшие снимки).
  • Если ClusterExists установлено в false и ClusterIdentifier указано для удалённого кластера, возвращаются снимки, связанные с этим кластером.
  • Если ClusterExists установлено в false и ClusterIdentifier указано для существующего кластера, снимки не возвращаются.

--sorting-entities (список)

(структура)

Описание сортируемого элемента

Атрибут -> (строка)

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

Порядок сортировки -> (строка)

Порядок вывода атрибутов.

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

Attribute=string,SortOrder=string ...

Синтаксис JSON:

[
  {
    "Attribute": "SOURCE_TYPE"|"TOTAL_SIZE"|"CREATE_TIME",
    "SortOrder": "ASC"|"DESC"
  }
  ...
]

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

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

Токен для указания, где начать постраничную обработку. Это NextToken из ранее усечённого ответа.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

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

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

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

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

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

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

--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.

Для ожидания готовности снимка

Следующий пример wait snapshot-available приостанавливает выполнение и продолжает только после подтверждения готовности указанного снимка.

aws redshift wait snapshot-available \
    --snapshot-identifier mycluster-2019-11-06-16-31

Эта команда не выводит никакого результата.

Вывод

Нет

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

Spec-Zone.ru

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