start-game-session-placement

Описание

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

Используйте эту операцию для выполнения следующих типов запросов.

• Запросить размещение, используя стандартный процесс приоритезации очереди (см. стандартную приоритезацию, описанную в PriorityConfiguration ). Включите эти обязательные параметры:
  • GameSessionQueueName
  • MaximumPlayerSessionCount
  • PlacementID
• Запросить размещение и установить приоритет, основываясь на задержке. Включите эти параметры:
  • Обязательные параметры GameSessionQueueName , MaximumPlayerSessionCount , PlacementID .
  • PlayerLatencies . Включите набор значений задержки для целевых расположений в очереди. Когда запрос содержит данные о задержке, Amazon GameLift автоматически переупорядочивает список приоритетов расположений очереди, основываясь на наименьших доступных значениях задержки. Если запрос содержит данные о задержке для нескольких игроков, Amazon GameLift вычисляет среднюю задержку каждого расположения для всех игроков и переупорядочивает, чтобы найти минимальную задержку для всех игроков.
  • Не включайте PriorityConfigurationOverride .
  • Установить приоритет на основе пользовательского списка расположений. Если вы используете очередь, настроенную на приоритет расположения (см. PriorityConfiguration для очередей игровых сессий), вы можете дополнительно использовать параметр PriorityConfigurationOverride для подстановки другого списка приоритетов расположения для этого запроса на размещение. Amazon GameLift ищет в каждом расположении в списке переопределения приоритетов доступный ресурс размещения для новой игровой сессии. Укажите стратегию резервного копирования, которую использовать в случае, если Amazon GameLift не сможет разместить игровую сессию ни в одном из расположений в списке переопределения приоритетов.
• Запросить размещение и установить приоритет на основе пользовательского списка расположений.
• Вы можете запросить новые игровые сессии для группы игроков. Включите параметр DesiredPlayerSessions и включите по меньшей мере уникальный идентификатор игрока для каждого. Вы также можете включить данные, специфичные для игрока, для передачи новой игровой сессии.

В случае успеха эта операция генерирует новый запрос на размещение игровой сессии и добавляет его в очередь игровых сессий для обработки. Вы можете отслеживать статус отдельных запросов на размещение, вызывая DescribeGameSessionPlacement или отслеживая уведомления о состоянии очереди. Когда статус запроса равен FULFILLED , новая игровая сессия запущена, и запрос на размещение обновлен с информацией о подключении к игровой сессии (IP-адрес и порт). Если запрос содержал данные игровой сессии, Amazon GameLift создает игровые сессии для каждого идентификатора игрока в запросе.

Запрос приведет к InvalidRequestException в следующих ситуациях:

• Если запрос включает параметры PlayerLatencies и PriorityConfigurationOverride.
• Если запрос включает параметр PriorityConfigurationOverride и указывает очередь, не имеющую приоритета расположения.

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

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

Краткое описание

  start-game-session-placement
--placement-id <value>
--game-session-queue-name <value>
[--game-properties <value>]
--maximum-player-session-count <value>
[--game-session-name <value>]
[--player-latencies <value>]
[--desired-player-sessions <value>]
[--game-session-data <value>]
[--priority-configuration-override <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]

Параметры

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

--game-session-queue-name (строка)

--game-properties (список)

Краткий синтаксис:

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--maximum-player-session-count (целое число)

--game-session-name (строка)

--player-latencies (список)

Краткий синтаксис:

PlayerId=string,RegionIdentifier=string,LatencyInMilliseconds=float ...

Синтаксис JSON:

[
  {
    "PlayerId": "string",
    "RegionIdentifier": "string",
    "LatencyInMilliseconds": float
  }
  ...
]

--desired-player-sessions (список)

Краткий синтаксис:

PlayerId=string,PlayerData=string ...

Синтаксис JSON:

[
  {
    "PlayerId": "string",
    "PlayerData": "string"
  }
  ...
]

--game-session-data (строка)

--priority-configuration-override (структура)

Краткий синтаксис:

PlacementFallbackStrategy=string,LocationOrder=string,string

Синтаксис JSON:

{
  "PlacementFallbackStrategy": "DEFAULT_AFTER_SINGLE_PASS"|"NONE",
  "LocationOrder": ["string", ...]
}

--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 (boolean)

Включить отладочную запись в журнал.

--endpoint-url (string)

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

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI проверяет SSL-сертификаты. Этот параметр переопределяет стандартное поведение проверки SSL-сертификатов.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI сделает только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команды.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определённый профиль из файла учетных данных.

--region (string)

Регион для использования. Переопределяет настройки из конфигурации/среды.

--version (string)

Показать версию этого инструмента.

--color (string)

Включить/выключить цветной вывод.

• on
• off
• auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.

--ca-bundle (string)

Файл сертификата CA для проверки SSL-сертификатов. Переопределяет настройки из конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI версии 1, а двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, отображающего двоичный блок fileb://, всегда будет рассматриваться как двоичный и использовать содержимое файла напрямую независимо от параметра cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного формата cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Отключить вывод страницы CLI.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Вывод

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