Spec-Zone.ru › AWS CLI v2

[ aws . appstream ]

describe-sessions

Описание

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

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

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

Синтаксис

  describe-sessions
--stack-name <value>
--fleet-name <value>
[--user-id <value>]
[--authentication-type <value>]
[--instance-id <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]

Параметры

--stack-name (строка)

Имя стека. Это значение чувствительно к регистру.

--fleet-name (строка)

Имя флота. Это значение чувствительно к регистру.

--user-id (строка)

Идентификатор пользователя (ID). Если вы указываете идентификатор пользователя, вы также должны указать тип аутентификации.

--authentication-type (строка)

Метод аутентификации. Укажите API для пользователя, авторизованного с помощью URL-адреса потоковой передачи, или SAML для пользователя с федерацией SAML. По умолчанию используется аутентификация пользователей с помощью URL-адреса потоковой передачи.

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

  • API
  • SAML
  • USERPOOL
  • AWS_AD

--instance-id (строка)

Идентификатор экземпляра, на котором размещена сессия.

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

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

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

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

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

Вывод

Сессии -> (список)

Информация о сессиях потоковой передачи.

(структура)

Описывает сессию потоковой передачи.

Id -> (строка)

Идентификатор сессии потоковой передачи.

UserId -> (строка)

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

StackName -> (строка)

Имя стека для сессии потоковой передачи.

FleetName -> (строка)

Имя флота для сессии потоковой передачи.

State -> (строка)

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

ConnectionState -> (строка)

Указывает, подключен ли пользователь к сессии потоковой передачи.

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

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

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

Время истечения срока действия сессии потоковой передачи. Это время основано на значении MaxUserDurationinSeconds, которое определяет максимальную длительность работы сессии потоковой передачи. Сессия потоковой передачи может закончиться раньше, чем указано в SessionMaxExpirationTime, когда истекает срок действия DisconnectTimeOutInSeconds, или пользователь выбирает завершение своей сессии. Если истекает срок действия DisconnectTimeOutInSeconds или пользователь выбирает завершение своей сессии, экземпляр потоковой передачи завершается, и сессия потоковой передачи заканчивается.

AuthenticationType -> (строка)

Метод аутентификации. Пользователь аутентифицируется с помощью URL-адреса потоковой передачи (API) или федерации SAML 2.0 (SAML).

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

Сетевые данные для сессии потоковой передачи.

EniPrivateIpAddress -> (строка)

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

EniId -> (строка)

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

InstanceId -> (строка)

Идентификатор экземпляра, на котором размещена сессия.

NextToken -> (строка)

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

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

Spec-Zone.ru

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