start-stream-session

Описание

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

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

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

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

• Amazon GameLift Streams определяет доступный вычислительный ресурс для запуска содержимого приложения и запуска потока. Когда поток готов, состояние сессии потоковой передачи изменяется на ACTIVE и включает информацию о подключении к потоку. Предоставьте информацию о подключении запрашивающему клиенту для присоединения к сессии потоковой передачи.
• Amazon GameLift Streams не определяет доступный ресурс в течение определенного времени, установленного ClientToken . В этом случае Amazon GameLift Streams прекращает обработку запроса, а состояние объекта сессии потоковой передачи изменяется на ERROR с причиной состояния placementTimeout .

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

Синтаксис

  start-stream-session
[--additional-environment-variables <value>]
[--additional-launch-args <value>]
--application-identifier <value>
[--client-token <value>]
[--connection-timeout-seconds <value>]
[--description <value>]
--identifier <value>
[--locations <value>]
--protocol <value>
[--session-length-seconds <value>]
--signal-request <value>
[--user-id <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]

Параметры

--additional-environment-variables (массив)

Сокращенный синтаксис:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--additional-launch-args (список)

Синтаксис:

"string" "string" ...

--application-identifier (строка)

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

--connection-timeout-seconds (целое число)

--description (строка)

--identifier (строка)

--locations (список)

Синтаксис:

"string" "string" ...

--protocol (строка)

--session-length-seconds (целое число)

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

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

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

Вывод

AdditionalEnvironmentVariables -> (map)

AdditionalLaunchArgs -> (список)

ApplicationArn -> (строка)

Arn -> (строка)

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

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

Description -> (строка)

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

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

Location -> (строка)

LogFileLocationUri -> (строка)

Protocol -> (строка)

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

SignalRequest -> (строка)

SignalResponse -> (строка)

Status -> (строка)

StatusReason -> (строка)

StreamGroupId -> (строка)

UserId -> (строка)

WebSdkProtocolUrl -> (строка)