Spec-Zone.ru › AWS CLI v2

[ aws . appstream ]

остановка-строителя-изображений

Описание

Останавливает указанный строитель изображений.

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

Синтаксис

  stop-image-builder
--name <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 (строка)

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

--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 -> (список)

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

(строка)

SecurityGroupIds -> (список)

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

(строка)

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, применённой к строителю изображений. Для выполнения роли строитель изображений вызывает операцию API AWS Security Token Service (STS) AssumeRole и передаёт 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 -> (структура)

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

EniPrivateIpAddress -> (строка)

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

EniId -> (строка)

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

ImageBuilderErrors -> (список)

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

(структура)

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

ErrorCode -> (строка)

Код ошибки.

ErrorMessage -> (строка)

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

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

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

AppstreamAgentVersion -> (строка)

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

AccessEndpoints -> (список)

Список объектов конечных точек виртуальной частной сети (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