Spec-Zone.ru › AWS CLI v2

[ aws . gameliftstreams ]

get-stream-session

Описание

Получает свойства ресурса сеанса потоковой передачи Amazon GameLift Streams. Укажите Amazon Resource Name (ARN) сеанса потоковой передачи, который вы хотите получить, и ARN его группы потоков. Если операция выполнена успешно, она возвращает свойства запрошенного ресурса.

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

Синтаксис

  get-stream-session
--identifier <value>
--stream-session-identifier <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]

Параметры

--identifier (строка)

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

Это значение представляет собой Amazon Resource Name (ARN) или идентификатор, уникально определяющий ресурс группы потоков. Пример формата: ARN-arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4 или ID-sg-1AB2C3De4 .

--stream-session-identifier (строка)

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

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

Вывод

AdditionalEnvironmentVariables -> (массив)

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

Примечание

Если вы хотите отладить приложение с переменными среды, мы рекомендуем сделать это в локальной среде вне Amazon GameLift Streams. Дополнительную информацию см. в разделе «Руководство по совместимости» в разделе «Устранение неполадок» руководства разработчика.

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

ключ -> (строка)

значение -> (строка)

AdditionalLaunchArgs -> (список)

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

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

(строка)

ApplicationArn -> (строка)

Приложение, выполняющее потоковую передачу в этом сеансе.

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

Arn -> (строка)

Amazon Resource Name (ARN), назначенный ресурсу сеанса потоковой передачи. В сочетании с ARN группы потоков это значение уникально определяет его во всех регионах Amazon Web Services. Формат: arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamsession/[resource ID] .

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

Максимальная продолжительность (в секундах), в течение которой Amazon GameLift Streams удерживает сеанс потоковой передачи открытым. В этот момент Amazon GameLift Streams завершает сеанс потоковой передачи независимо от любых существующих подключений клиента.

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

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

Description -> (строка)

Читаемый человеком ярлык для сеанса потоковой передачи. Вы можете обновить это значение в любое время.

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

Результат операции 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.

LogFileLocationUri -> (строка)

Местоположение доступа к журналам, генерируемым вашим контентом во время сеанса потоковой передачи. Эти журналы загружаются в хранилище облачных данных в конце сеанса потоковой передачи. Ресурс приложения Amazon GameLift Streams определяет, какие журналы загружать.

Protocol -> (строка)

Протокол передачи данных, используемый с сеансом потоковой передачи.

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

Продолжительность времени, в течение которого Amazon GameLift Streams удерживает сеанс игры открытым.

SignalRequest -> (строка)

Строка предложения ICE WebRTC, генерируемая клиентом для инициации подключения к сеансу потоковой передачи.

SignalResponse -> (строка)

Строка ответа WebRTC, генерируемая сервером потоковой передачи в ответ на предложение SignalRequest .

Status -> (строка)

Текущий статус сеанса потоковой передачи. Сеанс потоковой передачи может принимать клиентов, когда находится в состоянии ACTIVE.

StatusReason -> (строка)

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

StreamGroupId -> (строка)

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

UserId -> (строка)

Непрозрачный, уникальный идентификатор конечного пользователя, определенный разработчиком.

WebSdkProtocolUrl -> (строка)

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

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

Spec-Zone.ru

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