Spec-Zone.ru › AWS CLI v2

[ aws . appstream ]

describe-images

Описание

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

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

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

Синтаксис

  describe-images
[--names <value>]
[--arns <value>]
[--type <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]

Параметры

--names (список)

Имена общедоступных или закрытых образов для описания.

(строка)

Синтаксис:

"string" "string" ...

--arns (список)

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

(строка)

Синтаксис:

"string" "string" ...

--type (строка)

Тип образа (общедоступный, закрытый или общий) для описания.

Возможные значения:

  • PUBLIC
  • PRIVATE
  • SHARED

--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 (int)

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

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 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-auto-prompt (булево)

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

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

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

Вывод

Изображения -> (список)

Информация об изображениях.

(структура)

Описание изображения.

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

Имя изображения.

Arn -> (строка)

ARN изображения.

BaseImageArn -> (строка)

ARN изображения, из которого было создано это изображение.

DisplayName -> (строка)

Имя изображения для отображения.

Состояние -> (строка)

Изображение начинает работу в состоянии PENDING. Если создание изображения прошло успешно, состояние равно AVAILABLE. Если создание изображения завершилось ошибкой, состояние равно FAILED.

Видимость -> (строка)

Указывает, является ли изображение публичным или частным.

Поддерживается Image Builder -> (булево)

Указывает, можно ли запустить Image Builder из этого изображения.

ImageBuilderName -> (строка)

Имя Image Builder, которое было использовано для создания частного изображения. Если изображение общее, это значение равно null.

Платформа -> (строка)

Платформа операционной системы изображения.

Описание -> (строка)

Описание для отображения.

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

Причина последнего изменения состояния.

Код -> (строка)

Код причины изменения состояния.

Сообщение -> (строка)

Сообщение причины изменения состояния.

Приложения -> (список)

Приложения, связанные с изображением.

(структура)

Описание приложения в каталоге приложений.

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

Имя приложения.

DisplayName -> (строка)

Имя приложения для отображения.

IconURL -> (строка)

URL иконки приложения. Этот URL может быть ограничен по времени.

LaunchPath -> (строка)

Путь к исполняемому файлу приложения в экземпляре.

LaunchParameters -> (строка)

Аргументы, передаваемые при запуске приложения.

Включено -> (булево)

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

Metadata -> (карта)

Дополнительные атрибуты, описывающие приложение.

ключ -> (строка)

значение -> (строка)

Рабочая папка -> (строка)

Рабочая папка приложения.

Описание -> (строка)

Описание приложения.

Arn -> (строка)

ARN приложения.

AppBlockArn -> (строка)

ARN блока приложения.

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

Расположение иконки приложения в S3.

S3Bucket -> (строка)

Ведро S3 объекта.

S3Key -> (строка)

Ключ S3 объекта.

Требуется при использовании для:

  • IconS3Location (Действия: CreateApplication и UpdateApplication)
  • SessionScriptS3Location (Действия: CreateFleet и UpdateFleet)
  • ScriptDetails (Действия: CreateAppBlock)
  • SourceS3Location при создании блока приложения с CUSTOM PackagingType (Действия: CreateAppBlock)
  • SourceS3Location при создании блока приложения с APPSTREAM2 PackagingType и использовании существующего пакета приложения (файл VHD). В этом случае S3Key относится к файлу VHD. Если требуется новый пакет приложения, тогда S3Key не требуется. (Действия: CreateAppBlock)

Платформы -> (список)

Платформы, на которых может работать приложение.

(строка)

InstanceFamilies -> (список)

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

(строка)

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

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

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

Время создания изображения.

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

Дата выпуска публичного базового изображения. Для частных изображений эта дата является датой выпуска базового изображения, из которого было создано изображение.

AppstreamAgentVersion -> (строка)

Версия агента AppStream 2.0 для использования в экземплярах, запущенных из этого изображения.

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

Разрешения для предоставления целевому учетной записи AWS для указанного изображения.

allowFleet -> (булево)

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

allowImageBuilder -> (булево)

Указывает, можно ли использовать изображение для Image Builder.

ImageErrors -> (список)

Описание ошибок, возвращаемых, когда новое изображение не может быть создано.

(структура)

Описание ошибки ресурса.

ErrorCode -> (строка)

Код ошибки.

ErrorMessage -> (строка)

Сообщение об ошибке.

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

Время возникновения ошибки.

LatestAppstreamAgentVersion -> (строка)

Указывает, использует ли изображение последнюю версию агента AppStream 2.0 или нет.

SupportedInstanceFamilies -> (список)

Поддерживаемые семейства экземпляров, которые определяют, какое изображение пользователь может использовать при запуске флота или Image Builder. Поддерживаются следующие семейства экземпляров:

  • Общего назначения
  • Оптимизированные для вычислений
  • Оптимизированные по памяти
  • Графические
  • Графический дизайн
  • Графический Pro
  • Графический G4
  • Графический G5

(строка)

DynamicAppProvidersEnabled -> (строка)

Указывает, включены ли динамические поставщики приложений в изображении AppStream 2.0 или нет.

ImageSharedWithOthers -> (строка)

Указывает, разделено ли изображение с другим идентификатором учетной записи.

NextToken -> (строка)

Маркер постраничной навигации для получения следующей страницы результатов для данной операции. Если больше страниц нет, это значение равно null.

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

Spec-Zone.ru

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