image-available

Описание

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

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

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

Синтаксис

  image-available
[--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 (общедоступные AMIs).

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

(строка)

Синтаксис:

"string" "string" ...

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

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

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

(строка)

Синтаксис:

"string" "string" ...

--owners (список)

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

(строка)

Синтаксис:

"string" "string" ...

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

Указывает, следует ли включать устаревшие AMIs.

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

Примечание

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

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

Указывает, следует ли включать отключенные AMIs.

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

--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 (ГГГГ-ММ-ДДТчч:мм:сс.сссZ), например, 2021-09-29T11:04:43.305Z . Можно использовать подстановку (* ), например, 2021-09-29T* , которая соответствует целому дню.
description - Описание изображения (предоставленное при создании изображения).
ena-support - Булево значение, указывающее, включена ли расширенная сеть с ENA.
hypervisor - Тип гипервизора (ovm | xen ).
image-allowed - Булево значение, указывающее, соответствует ли изображение критериям, указанным для разрешенных AMIs.
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)

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

вкл
выкл
авто

--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-available примере выполнение приостанавливается и возобновляется только после подтверждения готовности указанного Amazon Machine Image. Вывод отсутствует.

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

Вывод

Нет