Spec-Zone.ru › AWS CLI v2

[ aws . appstream ]

start-image-builder

Описание

Запускает указанный создатель изображений.

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

Синтаксис

  start-image-builder
--name <value>
[--appstream-agent-version <value>]
[--cli-input-json | --cli-input-yaml]
[--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]

Параметры

--name (строка)

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

--appstream-agent-version (строка)

Версия агента AppStream 2.0, которую следует использовать для этого создателя изображений. Чтобы использовать последнюю версию агента AppStream 2.0, укажите [LATEST].

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

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

Вывод

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

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

Name -> (строка)

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

Arn -> (строка)

ARN создателя изображений.

ImageArn -> (строка)

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

Description -> (строка)

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

DisplayName -> (строка)

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

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

Настройка VPC создателя изображений.

SubnetIds -> (список)

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

(строка)

SecurityGroupIds -> (список)

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

(строка)

InstanceType -> (строка)

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

  • 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 -> (строка)

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

IamRoleArn -> (строка)

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

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

State -> (строка)

Состояние создателя изображений.

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

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

Code -> (строка)

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

Message -> (строка)

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

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

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

EnableDefaultInternetAccess -> (логическое значение)

Включает или отключает доступ к интернету по умолчанию для создателя изображений.

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

Имя каталога и организационной единицы (OU) для присоединения создателя изображений к домену Microsoft Active Directory.

DirectoryName -> (строка)

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

OrganizationalUnitDistinguishedName -> (строка)

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

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

Описание сетевых данных экземпляра флeета или создателя изображений.

EniPrivateIpAddress -> (строка)

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

EniId -> (строка)

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

ImageBuilderErrors -> (список)

Ошибки создателя изображений.

(структура)

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

ErrorCode -> (строка)

Код ошибки.

ErrorMessage -> (строка)

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

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

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

AppstreamAgentVersion -> (строка)

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

AccessEndpoints -> (список)

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

(структура)

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

EndpointType -> (строка)

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

VpceId -> (строка)

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

LatestAppstreamAgentVersion -> (строка)

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

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

Spec-Zone.ru

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