Spec-Zone.ru › AWS CLI v2

[ aws . gameliftstreams ]

list-stream-sessions-by-account

Описание

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

В возвращаемом списке сессий потоковой передачи свойство ExportFilesMetadata отображает только значение Status. Чтобы получить значения OutpurUri и StatusReason, используйте GetStreamSession.

Не рекомендуется использовать эту операцию для регулярной проверки статуса сессий потоковой передачи, так как она затратная. Вместо этого, для проверки обновлений статуса конкретной сессии потоковой передачи используйте GetStreamSession.

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

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

Синтаксис

  list-stream-sessions-by-account
[--export-files-status <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
  • FAILED
  • PENDING

--status (строка)

Фильтрация по статусу сессии потоковой передачи. Можно указать один статус в каждом запросе, чтобы получить только сессии, которые в настоящее время имеют этот статус.

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

  • ACTIVATING
  • ACTIVE
  • CONNECTED
  • PENDING_CLIENT_RECONNECTION
  • RECONNECTING
  • TERMINATING
  • TERMINATED
  • ERROR

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

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

Автоматическое запрос ввода параметров командной строки.

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

Отключение автоматического запроса ввода параметров командной строки.

Вывод

Элементы -> (список)

Коллекция сессий потоковой передачи Amazon GameLift Streams, связанных с группой потоковой передачи и возвращаемых в ответ на запрос списка. Каждый элемент включает метаданные и статус сессии потоковой передачи.

(структура)

Описание сессии потоковой передачи Amazon GameLift Streams. Для получения дополнительных данных о сессии потоковой передачи вызовите GetStreamSession.

ApplicationArn -> (строка)

Amazon Resource Name (ARN) или идентификатор, однозначно идентифицирующий ресурс приложения. Пример формата: ARN-arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6 или ID-a-9ZY8X7Wv6.

Arn -> (строка)

Amazon Resource Name (ARN), однозначно идентифицирующий ресурс сессии потоковой передачи. Пример формата: 1AB2C3De4.

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

Метка времени, указывающая время создания этого ресурса. Метки времени выражаются в формате ISO8601, например: 2022-12-27T22:29:40+00:00 (UTC).

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

Предоставляет подробности об экспортированных файлах сессии потоковой передачи.

OutputUri -> (строка)

URI-адрес S3-ведра, в котором Amazon GameLift Streams загрузили набор сжатых экспортированных файлов для сессии потоковой передачи. Amazon GameLift Streams генерирует имя ZIP-файла на основе метаданных сессии потоковой передачи. В качестве альтернативы, вы можете предоставить пользовательское имя файла с расширением .zip.

Пример 1: Если вы предоставите S3-URI под названием s3://MyBucket/MyGame_Session1.zip, тогда Amazon GameLift Streams сохранит файлы в этом местоположении.

Пример 2: Если вы предоставите S3-URI под названием s3://MyBucket/MyGameSessions_ExportedFiles/, тогда Amazon GameLift Streams сохранит файлы в s3://MyBucket/MyGameSessions_ExportedFiles/YYYYMMDD-HHMMSS-appId-sg-Id-sessionId.zip или другом аналогичном имени.

Status -> (строка)

Результат операции ExportStreamSessionFiles.

StatusReason -> (строка)

Краткое описание причины, по которой экспорт находится в статусе FAILED.

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

Метка времени, указывающая время последнего обновления этого ресурса. Метки времени выражаются в формате ISO8601, например: 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.

Spec-Zone.ru

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