Spec-Zone.ru › AWS CLI v2

[ aws . ec2 . wait ]

image-exists

Описание

Ожидание, пока длина запроса JMESPath (Images[]) > 0 вернёт True при опросе с помощью describe-images. Будет производиться опрос каждые 15 секунд, пока не будет достигнуто успешное состояние. Операция завершится с кодом возврата 255 после 40 неудачных проверок.

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

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

Синтаксис

  image-exists
[--executable-users <value>]
[--image-ids <value>]
[--owners <value>]
[--include-deprecated | --no-include-deprecated]
[--include-disabled | --no-include-disabled]
[--dry-run | --no-dry-run]
[--filters <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]

Параметры

--executable-users (список)

Ограничивает изображения пользователями с явными правами запуска. Укажите идентификатор учетной записи Amazon Web Services, self (отправитель запроса) или all (общедоступные AMI).

  • Если вы укажете идентификатор учетной записи Amazon Web Services, не являющейся вашей, будут возвращены только AMI, общий доступ к которым разрешен для этой конкретной учетной записи Amazon Web Services. Однако AMI, общий доступ к которым разрешен для организации или организационной единицы (OU) учетной записи, не будут возвращены.
  • Если вы укажете self или свой собственный идентификатор учетной записи Amazon Web Services, будут возвращены AMI, общий доступ к которым разрешен для вашей учетной записи. Кроме того, будут возвращены AMI, общий доступ к которым разрешен для организации или OU, членом которой вы являетесь.
  • Если вы укажете all, будут возвращены все общедоступные AMI.

(строка)

Синтаксис:

"string" "string" ...

--image-ids (список)

Идентификаторы изображений.

По умолчанию описывает все доступные вам изображения.

(строка)

Синтаксис:

"string" "string" ...

--owners (список)

Ограничивает результаты изображениями с указанными владельцами. Вы можете указать комбинацию идентификаторов учетных записей Amazon Web Services, self , amazon , aws-backup-vault и aws-marketplace . Если этот параметр опущен, результаты включают все изображения, для которых у вас есть права запуска, независимо от владения.

(строка)

Синтаксис:

"string" "string" ...

--include-deprecated | --no-include-deprecated (булево)

Указывает, нужно ли включать устаревшие AMI.

По умолчанию устаревшие AMI в ответе не включаются.

Примечание

Если вы владелец AMI, все устаревшие AMI появятся в ответе независимо от того, что вы указали для этого параметра.

--include-disabled | --no-include-disabled (булево)

Указывает, нужно ли включать отключенные AMI.

По умолчанию отключенные AMI в ответе не включаются.

--dry-run | --no-dry-run (булево)

Проверяет наличие необходимых разрешений для действия без фактического выполнения запроса и предоставляет ответ об ошибке. Если у вас есть необходимые разрешения, ответ об ошибке DryRunOperation . В противном случае - UnauthorizedOperation .

--filters (список)

Фильтры.

  • architecture - Архитектура изображения (i386 | x86_64 | arm64 | x86_64_mac | arm64_mac ).
  • block-device-mapping.delete-on-termination - Булево значение, указывающее, удаляется ли том Amazon EBS при завершении работы экземпляра.
  • block-device-mapping.device-name - Имя устройства, указанное в отображении устройств блочного хранилища (например, /dev/sdh или xvdh ).
  • block-device-mapping.snapshot-id - Идентификатор моментального снимка, используемого для тома Amazon EBS.
  • block-device-mapping.volume-size - Размер тома Amazon EBS в ГБ.
  • block-device-mapping.volume-type - Тип тома Amazon EBS (io1 | io2 | gp2 | gp3 | sc1 | st1 | standard ).
  • block-device-mapping.encrypted - Булево значение, указывающее, зашифрован ли том Amazon EBS.
  • creation-date - Время создания изображения в формате ISO 8601 в часовом поясе UTC (ГГГГ-ММ-ДДЧЧ:ММ:СС.ССЗ), например, 2021-09-29T11:04:43.305Z . Вы можете использовать подстановочный знак (*), например, 2021-09-29T*, который соответствует целому дню.
  • description - Описание изображения (предоставленное при создании изображения).
  • ena-support - Булево значение, указывающее, включена ли расширенная сеть с ENA.
  • hypervisor - Тип гипервизора (ovm | xen ).
  • image-allowed - Булево значение, указывающее, соответствует ли изображение критериям, указанным для разрешенных AMI.
  • image-id - Идентификатор изображения.
  • image-type - Тип изображения (machine | kernel | ramdisk ).
  • is-public - Булево значение, указывающее, является ли изображение общедоступным.
  • kernel-id - Идентификатор ядра.
  • manifest-location - Расположение манифеста изображения.
  • name - Название AMI (предоставленное при создании изображения).
  • owner-alias - Псевдоним владельца (amazon | aws-backup-vault | aws-marketplace ). Действительные псевдонимы определены в поддерживаемом Amazon списке. Это не псевдоним учетной записи Amazon Web Services, который можно установить с помощью консоли IAM. Рекомендуется использовать параметр запроса Owner вместо этого фильтра.
  • owner-id - Идентификатор учетной записи Amazon Web Services владельца. Рекомендуется использовать параметр запроса Owner вместо этого фильтра.
  • platform - Платформа. Поддерживается только значение windows .
  • product-code - Код продукта.
  • product-code.type - Тип кода продукта (marketplace ).
  • ramdisk-id - Идентификатор диска RAM.
  • root-device-name - Имя устройства тома корневого устройства (например, /dev/sda1 ).
  • root-device-type - Тип тома корневого устройства (ebs | instance-store ).
  • source-image-id - Идентификатор исходного AMI, из которого был создан AMI.
  • source-image-region - Регион исходного AMI.
  • source-instance-id - Идентификатор экземпляра, из которого был создан AMI, если AMI был создан с помощью CreateImage. Этот фильтр применим только в случае, если AMI был создан с помощью CreateImage.
  • state - Состояние изображения (available | pending | failed ).
  • state-reason-code - Код причины изменения состояния.
  • state-reason-message - Сообщение о изменении состояния.
  • sriov-net-support - Значение simple указывает, что включена расширенная сеть с интерфейсом Intel 82599 VF.
  • tag:<key> - Комбинация ключ/значение тега, назначенного ресурсу. Используйте ключ тега в имени фильтра и значение тега в качестве значения фильтра. Например, чтобы найти все ресурсы, имеющие тег с ключом Owner и значением TeamA, укажите tag:Owner для имени фильтра и TeamA для значения фильтра.
  • tag-key - Ключ тега, назначенного ресурсу. Используйте этот фильтр, чтобы найти все ресурсы, которым назначен тег с определенным ключом, независимо от значения тега.
  • virtualization-type - Тип виртуализации (paravirtual | hvm ).

(структура)

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

Если вы указываете несколько фильтров, фильтры объединяются с помощью AND, и запрос возвращает только результаты, соответствующие всем указанным фильтрам.

Дополнительную информацию см. в разделе «Список и фильтрация с помощью командной строки и API» в руководстве пользователя Amazon EC2.

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

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

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

Значения фильтра. Значения фильтров чувствительны к регистру. Если вы указываете несколько значений для фильтра, значения объединяются с помощью OR, и запрос возвращает все результаты, которые соответствуют любому из указанных значений.

(строка)

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

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

Синтаксис JSON:

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

--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 (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 V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, сопоставляющегося с двоичным блоком, 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.

Примеры

Примечание

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

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

Для ожидания, пока изображение не появится

Следующий wait image-exists пример приостанавливает и возобновляет выполнение только после подтверждения существования указанного образа Amazon Machine Image. Он не выводит никаких данных.

aws ec2 wait image-exists \
    --image-ids ami-0abcdef1234567890

Вывод

Нет

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

Spec-Zone.ru

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