[ aws . gameliftstreams ]
list-stream-sessions
Описание
Получает список сессий потоковой передачи Amazon GameLift Streams, которые размещает группа потоков.
Для получения сессий потоковой передачи укажите группу потоков и, необязательно, отфильтруйте по статусу сессии потоковой передачи. По мере необходимости вы можете выполнить постраничный вывод результатов.
Данный оператор возвращает запрошенные сессии потоковой передачи в произвольном порядке.
См. также: Документацию AWS API
list-stream-sessions это операция с постраничным выводом. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничным выводом, аргумент --query должен извлекать данные из результатов следующих выражений запросов: Items
Синтаксис
list-stream-sessions
[--export-files-status <value>]
--identifier <value>
[--status <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]
Параметры
--export-files-status (строка)
Фильтр по статусу экспортированных файлов. В каждом запросе можно указать один статус, чтобы получить только сессии, которые в данный момент имеют этот статус экспортированных файлов.
Экспортированные файлы могут находиться в одном из следующих состояний:
- SUCCEEDED : Экспортированные файлы успешно сохранены в ведре S3.
- FAILED : Сессия завершилась, но Amazon GameLift Streams не удалось собрать и загрузить файлы в S3.
- PENDING : Либо сессия потоковой передачи всё ещё в процессе, либо загрузка экспортированных файлов в ведро S3 находится в процессе.
Возможные значения:
SUCCEEDEDFAILEDPENDING
--identifier (строка)
--status (строка)
Фильтр по статусу сессии потоковой передачи. В каждом запросе можно указать один статус, чтобы получить только сессии, которые в данный момент находятся в этом статусе.
Возможные значения:
ACTIVATINGACTIVECONNECTEDPENDING_CLIENT_RECONNECTIONRECONNECTINGTERMINATINGTERMINATEDERROR
--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
- текст
- таблица
- 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 (булево)
Автоматически запрашивать параметры командной строки.
--no-cli-auto-prompt (булево)
Отключить автоматическое запросы параметров командной строки.
Вывод
Элементы -> (список)
Коллекция сессий потоков Amazon GameLift Streams, связанных с группой потоков и возвращаемых в ответ на запрос списка. Каждый элемент включает метаданные и статус сессии потока.
(структура)
Описание сессии потока Amazon GameLift Streams. Для получения дополнительной информации о сессии потока, вызовите GetStreamSession .
ApplicationArn -> (строка)
arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6 или ID-a-9ZY8X7Wv6 .Arn -> (строка)
1AB2C3De4 . .CreatedAt -> (метка времени)
2022-12-27T22:29:40+00:00 (UTC).ExportFilesMetadata -> (структура)
Предоставляет сведения об экспортированных файлах сессии потока.
OutputUri -> (строка)
URI хранилища S3, куда Amazon GameLift Streams загрузил набор сжатых экспортированных файлов для сессии потока. Amazon GameLift Streams генерирует имя файла ZIP, основанное на метаданных сессии потока. Кроме того, вы можете указать имя файла с расширением .zip.
Пример 1: Если вы предоставите URI S3 под названием s3://MyBucket/MyGame_Session1.zip, то Amazon GameLift Streams сохранит файлы в этом месте.
Пример 2: Если вы предоставите URI S3 под названием s3://MyBucket/MyGameSessions_ExportedFiles/, то Amazon GameLift Streams сохранит файлы по адресу s3://MyBucket/MyGameSessions_ExportedFiles/YYYYMMDD-HHMMSS-appId-sg-Id-sessionId.zip или аналогичному имени.
Status -> (строка)
StatusReason -> (строка)
FAILED.LastUpdatedAt -> (метка времени)
2022-12-27T22:29:40+00:00 (UTC).Location -> (строка)
Расположение, где Amazon GameLift Streams размещает сессию потока.
Название расположения. Например, us-east-1. Полный список поддерживаемых Amazon GameLift Streams расположений см. в разделе «Регионы и квоты» в руководстве разработчика Amazon GameLift Streams.
Protocol -> (строка)
Status -> (строка)
Текущий статус ресурса сессии потока. Возможные статусы включают следующие:
-
ACTIVATING: Сессия потока запускается и готовится к потоковой передаче. -
ACTIVE: Сессия потока готова принять подключения клиентов. -
CONNECTED: В сессии потока есть подключенный клиент. -
PENDING_CLIENT_RECONNECTION: Клиент недавно отключился, и сессия потока ожидает его повторного подключения. Через некоторое время, если клиент не подключится, статус сессии потока перейдет вTERMINATED. -
TERMINATING: Сессия потока завершается. -
TERMINATED: Сессия потока завершена. -
ERROR: Сессия потока не смогла активироваться.
UserId -> (строка)
NextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.