Spec-Zone.ru › AWS CLI v2

[ aws . gameliftstreams ]

create-stream-session-connection

Описание

Позволяет клиентам повторно подключиться к недавно отключённой сессии потоковой передачи без потери данных с последней сессии.

Клиент может повторно подключиться к сессии потоковой передачи, которая находится в состоянии PENDING_CLIENT_RECONNECTION или ACTIVE. В жизненном цикле сессии потоковой передачи, при отключении клиента от сессии потоковой передачи, состояние сессии потоковой передачи переходит из состояния CONNECTED в состояние PENDING_CLIENT_RECONNECTION. При запросе повторного подключения клиентом путём вызова CreateStreamSessionConnection, состояние сессии потоковой передачи переходит в состояние RECONNECTING. При успешном повторном подключении состояние сессии потоковой передачи переходит в состояние ACTIVE. После того, как сессия потоковой передачи была отключена на срок более ConnectionTimeoutSeconds, состояние сессии потоковой передачи переходит в состояние TERMINATED.

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

ConnectionTimeoutSeconds определяет период времени после отключения сессии потоковой передачи, в течение которого разрешено повторное подключение. Если клиент отключен от потока на срок более ConnectionTimeoutSeconds, сессия потоковой передачи завершается.

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

Синтаксис

  create-stream-session-connection
[--client-token <value>]
--identifier <value>
--signal-request <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]

Параметры

--client-token (строка)

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

--identifier (строка)

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

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

--signal-request (строка)

Строка WebRTC ICE предложения, которую следует использовать при инициализации подключения WebRTC. Предложение — это очень длинная строка JSON. Укажите строку как текстовое значение в кавычках. Предложение должно быть сгенерировано заново, а не быть тем же предложением, которое предоставлялось StartStreamSession.

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

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

--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
  • 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 (булево)

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

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

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

Вывод

SignalResponse -> (строка)

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

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

Spec-Zone.ru

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