Spec-Zone.ru › AWS CLI v2

[ aws . appstream ]

describe-image-builders

Описание

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

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

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

Синтаксис

  describe-image-builders
[--names <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" ...

--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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Выражение JMESPath для фильтрации данных ответа.

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

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

Вывод

ImageBuilders -> (список)

Информация об Image Builders.

(структура)

Описывает виртуальную машину, используемую для создания образа.

Name -> (строка)

Имя Image Builder.

Arn -> (строка)

ARN Image Builder.

ImageArn -> (строка)

ARN образа, из которого был создан этот Image Builder.

Description -> (строка)

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

DisplayName -> (строка)

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

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

Конфигурация VPC Image Builder.

SubnetIds -> (список)

Идентификаторы подсетей, к которым подключен сетевой интерфейс с экземпляра флота или экземпляра Image Builder. Экземпляры флотов используют одну или несколько подсетей. Экземпляры Image Builder используют одну подсеть.

(строка)

SecurityGroupIds -> (список)

Идентификаторы групп безопасности для флота или Image Builder.

(строка)

InstanceType -> (строка)

Тип экземпляра для Image Builder. Доступны следующие типы экземпляров:

  • stream.standard.small
  • stream.standard.medium
  • stream.standard.large
  • stream.compute.large
  • stream.compute.xlarge
  • stream.compute.2xlarge
  • stream.compute.4xlarge
  • stream.compute.8xlarge
  • stream.memory.large
  • stream.memory.xlarge
  • stream.memory.2xlarge
  • stream.memory.4xlarge
  • stream.memory.8xlarge
  • stream.memory.z1d.large
  • stream.memory.z1d.xlarge
  • stream.memory.z1d.2xlarge
  • stream.memory.z1d.3xlarge
  • stream.memory.z1d.6xlarge
  • stream.memory.z1d.12xlarge
  • stream.graphics-design.large
  • stream.graphics-design.xlarge
  • stream.graphics-design.2xlarge
  • stream.graphics-design.4xlarge
  • stream.graphics-desktop.2xlarge
  • stream.graphics.g4dn.xlarge
  • stream.graphics.g4dn.2xlarge
  • stream.graphics.g4dn.4xlarge
  • stream.graphics.g4dn.8xlarge
  • stream.graphics.g4dn.12xlarge
  • stream.graphics.g4dn.16xlarge
  • stream.graphics-pro.4xlarge
  • stream.graphics-pro.8xlarge
  • stream.graphics-pro.16xlarge

Platform -> (строка)

Платформа операционной системы Image Builder.

IamRoleArn -> (строка)

ARN роли IAM, применяемой к Image Builder. Для получения роли Image Builder обращается к API AWS Security Token Service (STS) AssumeRole и передает ARN используемой роли. Данная операция создает новую сессию с временными учетными данными. AppStream 2.0 получает временные учетные данные и создает профиль учетных данных appstream_machine_role на экземпляре.

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

State -> (строка)

Состояние Image Builder.

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

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

Code -> (строка)

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

Message -> (строка)

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

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

Метка времени создания Image Builder.

EnableDefaultInternetAccess -> (булево)

Включает или отключает доступ к Интернету по умолчанию для Image Builder.

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

Имя каталога и организационной единицы (OU) для подключения Image Builder к домену Microsoft Active Directory.

DirectoryName -> (строка)

Полное доменное имя каталога (например, corp.example.com).

OrganizationalUnitDistinguishedName -> (строка)

Идентификатор организационной единицы для учетных записей компьютеров.

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

Описание сетевых данных экземпляра флота или Image Builder.

EniPrivateIpAddress -> (строка)

Приватный IP-адрес эластического сетевого интерфейса, подключенного к экземплярам в вашей VPC.

EniId -> (строка)

Идентификатор эластического сетевого интерфейса, подключенного к экземплярам в вашей VPC. Все сетевые интерфейсы имеют идентификатор ресурса eni-xxxxxxxx.

ImageBuilderErrors -> (список)

Ошибки Image Builder.

(структура)

Описывает ошибку ресурса.

ErrorCode -> (строка)

Код ошибки.

ErrorMessage -> (строка)

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

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

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

AppstreamAgentVersion -> (строка)

Версия агента AppStream 2.0, которая используется в данный момент Image Builder.

AccessEndpoints -> (список)

Список объектов виртуальных частных облаков (VPC) интерфейсных точек. Администраторы могут подключаться к Image Builder только через указанные точки доступа.

(структура)

Описывает интерфейсную точку доступа виртуального частного облака (VPC), которая позволяет создавать частное подключение между указанной виртуальной частной областью (VPC) и AppStream 2.0. При указании интерфейсной точки доступа для стека пользователи стека могут подключаться к AppStream 2.0 только через эту точку доступа. При указании интерфейсной точки доступа для Image Builder администраторы могут подключаться к Image Builder только через эту точку доступа.

EndpointType -> (строка)

Тип интерфейсной точки доступа.

VpceId -> (строка)

Идентификатор VPC, в котором используется интерфейсная точка доступа.

LatestAppstreamAgentVersion -> (строка)

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

NextToken -> (строка)

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

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

Spec-Zone.ru

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