describe-fleets

Описание

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

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

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

Синтаксис

  describe-fleets
[--names <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <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.

--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 (целое число)

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

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

Флоты -> (список)

Информация о флотах.

(структура)

Описание флота.

Arn -> (строка)

Amazon Resource Name (ARN) флота.

Name -> (строка)

Имя флота.

DisplayName -> (строка)

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

Description -> (строка)

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

ImageName -> (строка)

Имя образа, используемого для создания флота.

ImageArn -> (строка)

ARN для публичного, частного или общего образа.

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

FleetType -> (строка)

Тип флота.

ALWAYS_ON

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

ON_DEMAND

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

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

Статус ресурсов флота.

Desired -> (целое число)

Желаемое количество потоковых экземпляров.

Running -> (целое число)

Общее количество одновременных работающих потоковых экземпляров.

InUse -> (целое число)

Количество используемых экземпляров для потоковой передачи.

Available -> (целое число)

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

DesiredUserSessions -> (целое число)

Общее количество слотов сессий, которые выполняются или находятся в ожидании. Это общее количество одновременных сессий потоковой передачи, которые может поддерживать ваш флот в устойчивом состоянии.

DesiredUserSessionCapacity = ActualUserSessionCapacity + PendingUserSessionCapacity

Это относится только к многопользовательским флотам.

AvailableUserSessions -> (целое число)

Количество свободных слотов сессий, доступных для пользовательских сессий.

AvailableUserSessionCapacity = ActualUserSessionCapacity - ActiveUserSessions

Это относится только к многопользовательским флотам.

ActiveUserSessions -> (целое число)

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

ActualUserSessions -> (целое число)

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

ActualUserSessionCapacity = AvailableUserSessionCapacity + ActiveUserSessions

Это относится только к многопользовательским флотам.

MaxUserDurationInSeconds -> (целое число)

Максимальное время активности сессии потоковой передачи в секундах. Если пользователи по-прежнему подключены к экземпляру потоковой передачи за пять минут до достижения этого предела, им предлагается сохранить все открытые документы перед отключением. По истечении этого времени экземпляр завершается и заменяется новым.

Укажите значение от 600 до 360000.

DisconnectTimeoutInSeconds -> (целое число)

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

Укажите значение от 60 до 36000.

State -> (строка)

Текущее состояние флота.

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

Конфигурация VPC для флота.

SubnetIds -> (список)

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

(строка)

SecurityGroupIds -> (список)

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

(строка)

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

Время создания флота.

FleetErrors -> (список)

Ошибки флота.

(структура)

Описание ошибки флота.

ErrorCode -> (строка)

Код ошибки.

ErrorMessage -> (строка)

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

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

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

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

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

DirectoryName -> (строка)

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

OrganizationalUnitDistinguishedName -> (строка)

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

IdleDisconnectTimeoutInSeconds -> (целое число)

Время, в течение которого пользователи могут быть бездействующими (неактивными), прежде чем они будут отключены от сессии потоковой передачи, и начнется интервал времени DisconnectTimeoutInSeconds. Пользователи получают уведомление до отключения из-за бездействия. Если пользователи пытаются повторно подключиться к сессии потоковой передачи до истечения интервала времени, указанного в DisconnectTimeoutInSeconds, они подключаются к своей предыдущей сессии. Пользователи считаются бездействующими, когда они прекращают ввод с клавиатуры или мыши во время сессии потоковой передачи. Загрузка и загрузка файлов, аудиоввод, аудиовывод и изменение пикселей не считаются активностью пользователя. Если пользователи продолжают бездействовать после истечения интервала времени в IdleDisconnectTimeoutInSeconds, они отключаются.

Чтобы предотвратить отключение пользователей из-за бездействия, укажите значение 0. В противном случае укажите значение от 60 до 36000. Значение по умолчанию — 0.

Примечание

Если вы включите эту функцию, мы рекомендуем указать значение, которое точно соответствует целому числу минут (например, 60, 120 и 180). Если вы этого не сделаете, значение округляется до ближайшей минуты. Например, если вы укажете значение 70, пользователи отключаются после 1 минуты бездействия. Если вы укажете значение, находящееся посередине между двумя разными минутами, значение округляется вверх. Например, если вы укажете значение 90, пользователи отключаются после 2 минут бездействия.

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.

StreamView -> (строка)

Представление AppStream 2.0, отображаемое пользователям при потоковой передаче с флота. Если указано APP, отображаются только окна приложений, открытых пользователями. Если указано DESKTOP, отображается стандартный рабочий стол, предоставляемый операционной системой.

Значение по умолчанию — APP.

Platform -> (строка)

Платформа флота.

MaxConcurrentSessions -> (целое число)

Максимальное количество одновременных сессий для флота.

UsbDeviceFilterStrings -> (список)

Строки фильтра USB-устройств, связанные с флотом.

(строка)

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

Расположение в S3 конфигурации сценариев сеанса в формате zip-файла. Это применимо только к эластичным флотам.

S3Bucket -> (строка)

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

S3Key -> (строка)

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

Это необходимо при использовании для следующих целей:

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

MaxSessionsPerInstance -> (целое число)

Максимальное количество пользовательских сессий на экземпляре. Это относится только к многопользовательским флотам.

NextToken -> (строка)

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