Spec-Zone.ru › AWS CLI v2

[ aws . gamelift ]

create-game-session-queue

Описание

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

Очередь игровой сессии настраивается с набором пунктов назначения (флотов или псевдонимов Amazon GameLift), которые определяют, где очередь может разместить новые игровые сессии. Эти пункты назначения могут охватывать несколько областей Amazon Web Services, могут использовать разные типы экземпляров и могут включать как Spot, так и On-Demand флоты. Если очередь включает флоты с несколькими местоположениями, очередь может разместить игровые сессии в любом из удаленных местоположений флота.

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

Параметры запроса

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

  • Создать очередь с минимально необходимыми параметрами.
    • Name
    • Destinations (Этот параметр не обязателен, но очередь не может выполнять размещения без хотя бы одного пункта назначения.)
  • Создать очередь с уведомлениями о размещении. Очереди с высокой активностью размещения должны использовать систему уведомлений, например, с использованием Amazon Simple Notification Service (Amazon SNS) или Amazon CloudWatch.
    • Обязательные параметры Name и Destinations
    • NotificationTarget
  • Создать очередь с настраиваемыми параметрами приоритезации. Эти настраиваемые параметры заменяют стандартную конфигурацию приоритетов для очереди.
    • Обязательные параметры Name и Destinations
    • PriorityConfiguration
  • Создать очередь со специальными правилами для обработки данных о задержке игроков.
    • Обязательные параметры Name и Destinations
    • PlayerLatencyPolicies
Результаты

При успешном выполнении этой операции возвращается новый GameSessionQueue объект с назначенным ARN очереди. Используйте имя или ARN очереди при отправке новых запросов на игровые сессии с помощью StartGameSessionPlacement или StartMatchmaking .

Дополнительная информация

Проектирование очереди игровой сессии

Создание очереди игровой сессии

Связанные действия

CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue | DeleteGameSessionQueue | Все API по задачам

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

Синтаксис

  create-game-session-queue
--name <value>
[--timeout-in-seconds <value>]
[--player-latency-policies <value>]
[--destinations <value>]
[--filter-configuration <value>]
[--priority-configuration <value>]
[--custom-event-data <value>]
[--notification-target <value>]
[--tags <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]

Параметры

--name (строка)

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

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

Максимальное время в секундах, в течение которого запрос на размещение новой игровой сессии остается в очереди. Когда запрос превышает это время, размещение игровой сессии изменяется на статус TIMED_OUT. Если вы не укажете таймаут запроса, очередь использует значение по умолчанию.

--player-latency-policies (список)

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

(структура)

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

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

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

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

Продолжительность в секундах, в течение которой политика применяется при размещении новой игровой сессии. Значение null для этого свойства означает, что политика применяется до истечения времени ожидания очереди.

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

MaximumIndividualPlayerLatencyMilliseconds=integer,PolicyDurationSeconds=integer ...

Синтаксис JSON:

[
  {
    "MaximumIndividualPlayerLatencyMilliseconds": integer,
    "PolicyDurationSeconds": integer
  }
  ...
]

--destinations (список)

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

(структура)

Флот или псевдоним, указанный в очереди игровой сессии. Очереди удовлетворяют запросы на новые игровые сессии, размещая новую игровой сессию в любом из пунктов назначения очереди.

DestinationArn -> (строка)

Amazon Resource Name (ARN), назначенный флоту или псевдониму флота. ARNs, которые включают идентификатор флота или псевдонима и имя области, обеспечивают уникальный идентификатор во всех областях.

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

DestinationArn=string ...

Синтаксис JSON:

[
  {
    "DestinationArn": "string"
  }
  ...
]

--filter-configuration (структура)

Список местоположений, в которых очередь разрешено размещать новые игровые сессии. Местоположения указаны в виде кодов областей Amazon Web Services, таких как us-west-2 . Если этот параметр не задан, игровые сессии могут размещаться в любом местоположении очереди.

AllowedLocations -> (список)

Список местоположений для размещения игровых сессий в виде кодов областей Amazon Web Services, таких как us-west-2 .

(строка)

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

AllowedLocations=string,string

Синтаксис JSON:

{
  "AllowedLocations": ["string", ...]
}

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

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

PriorityOrder -> (список)

Настраиваемая последовательность использования при приоритезации места размещения новых игровых сессий. Каждый тип приоритета указан один раз.

  • LATENCY – Amazon GameLift отдает приоритет местоположениям с наименьшей средней задержкой игроков. Данные о задержке игроков предоставляются в каждом запросе на размещение игровой сессии.
  • COST – Amazon GameLift отдает приоритет пунктам назначения очереди с наименьшими текущими затратами на размещение. Стоимость оценивается на основе местоположения пункта назначения, типа экземпляра и типа флота (Spot или On-Demand).
  • DESTINATION – Amazon GameLift отдает приоритет на основе порядка расположения пунктов назначения в конфигурации очереди.
  • LOCATION – Amazon GameLift отдает приоритет на основе предоставленного порядка расположения, определенного в LocationOrder .

(строка)

LocationOrder -> (список)

Порядок приоритезации местоположений флотов, когда свойство PriorityOrder содержит LOCATION . Местоположения могут включать коды областей Amazon Web Services (например, us-west-2 ), локальные зоны и настраиваемые местоположения (для Anywhere флотов). Каждое местоположение должно быть указано только один раз. Для получения подробной информации см. местоположения сервиса Amazon GameLift.

(строка)

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

PriorityOrder=string,string,LocationOrder=string,string

Синтаксис JSON:

{
  "PriorityOrder": ["LATENCY"|"COST"|"DESTINATION"|"LOCATION", ...],
  "LocationOrder": ["string", ...]
}

--custom-event-data (строка)

Информация, которая будет добавлена ко всем событиям, связанным с этой очередью игровой сессии.

--notification-target (строка)

ARN темы SNS, настроенной для получения уведомлений о размещении игровой сессии. См. Настройка уведомлений для размещения игровой сессии .

--tags (список)

Список меток для назначения новому ресурсу очереди игровой сессии. Метки — это заданные разработчиком пары «ключ-значение». Использование меток ресурсов Amazon Web Services полезно для управления ресурсами, управления доступом и распределения затрат. Дополнительная информация доступна в документе «Помечание ресурсов Amazon Web Services» в разделе «Общие сведения об Amazon Web Services» .

(структура)

Метка, которую вы можете назначить ресурсу Amazon GameLift.

Дополнительная информация

Помечание ресурсов Amazon Web Services в «Общие сведения об Amazon Web Services»

Стратегии использования меток Amazon Web Services

Связанные действия

Все API по задачам

Key -> (строка)

Ключ для пары «ключ-значение», заданной разработчиком для помечания ресурса Amazon Web Services.

Value -> (строка)

Значение для пары «ключ-значение», заданной разработчиком для помечания ресурса Amazon Web Services.

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

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "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 V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, 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.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Подробную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.

За исключением случаев, когда указано иное, все примеры используют правила цитирования, характерные для Unix. Эти примеры потребуется адаптировать к правилам цитирования вашей оболочки. См. Раздел "Использование кавычек со строками" в Руководстве пользователя AWS CLI.

Пример 1: Создание очереди сессий игры в заданном порядке

Следующий create-game-session-queue пример создает новую очередь сессий игры с направлениями в двух регионах. Он также настраивает очередь таким образом, чтобы запросы сессий игры завершались с истечением времени ожидания размещения через 10 минут. Поскольку политики задержки не определены, GameLift пытается разместить все сессии игры с первым указанным направлением.

aws gamelift create-game-session-queue \
    --name MegaFrogRaceServer-NA \
    --destinations file://destinations.json \
    --timeout-in-seconds 600

Содержимое destinations.json:

{
    "Destinations": [
        {"DestinationArn": "arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" },
        {"DestinationArn": "arn:aws:gamelift:us-west-1::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222" }
    ]
}

Вывод:

{
    "GameSessionQueues": [
        {
            "Name": "MegaFrogRaceServer-NA",
            "GameSessionQueueArn": "arn:aws:gamelift:us-west-2:123456789012:gamesessionqueue/MegaFrogRaceServer-NA",
            "TimeoutInSeconds": 600,
            "Destinations": [
                {"DestinationArn": "arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"},
                {"DestinationArn": "arn:aws:gamelift:us-west-1::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"}
            ]
        }
    ]
}

Пример 2: Создание очереди сессий игры с политиками задержки игроков

Следующий create-game-session-queue пример создает новую очередь сессий игры с двумя политиками задержки игроков. Первая политика устанавливает предел задержки в 100 мс, который применяется в течение первой минуты попытки размещения сессии игры. Вторая политика увеличивает предел задержки до 200 мс до истечения времени ожидания запроса размещения через 3 минуты.

aws gamelift create-game-session-queue \
    --name MegaFrogRaceServer-NA \
    --destinations file://destinations.json \
    --player-latency-policies file://latency-policies.json \
    --timeout-in-seconds 180

Содержимое destinations.json:

{
    "Destinations": [
        { "DestinationArn": "arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" },
        { "DestinationArn": "arn:aws:gamelift:us-east-1::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222" }
    ]
}

Содержимое latency-policies.json:

{
    "PlayerLatencyPolicies": [
        {"MaximumIndividualPlayerLatencyMilliseconds": 200},
        {"MaximumIndividualPlayerLatencyMilliseconds": 100, "PolicyDurationSeconds": 60}
    ]
}

Вывод:

{
    "GameSessionQueue": {
        "Name": "MegaFrogRaceServer-NA",
        "GameSessionQueueArn": "arn:aws:gamelift:us-west-2:111122223333:gamesessionqueue/MegaFrogRaceServer-NA",
        "TimeoutInSeconds": 600,
        "PlayerLatencyPolicies": [
            {
                "MaximumIndividualPlayerLatencyMilliseconds": 100,
                "PolicyDurationSeconds": 60
            },
            {
                "MaximumIndividualPlayerLatencyMilliseconds": 200
            }
        ]
        "Destinations": [
            {"DestinationArn": "arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"},
            {"DestinationArn": "arn:aws:gamelift:us-east-1::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"}
        ],
    }
}

Дополнительную информацию см. в разделе "Создание очереди" в Руководстве разработчика Amazon GameLift.

Вывод

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

Объект, описывающий только что созданную очередь сессий игры.

Имя -> (строка)

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

GameSessionQueueArn -> (строка)

Уникальный идентификатор ресурса Amazon GameLift очереди сессий игры. ARNs уникальны во всех регионах. Формат - arn:aws:gamelift:<region>::gamesessionqueue/<queue name> . В Amazon GameLift ARN очереди сессий игры идентификатор ресурса соответствует значению Имя.

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

Максимальное время (в секундах), в течение которого запрос на размещение новой сессии игры остается в очереди. Когда запрос превышает это время, размещение сессии игры переходит в статус TIMED_OUT.

PlayerLatencyPolicies -> (список)

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

(структура)

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

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

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

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

Продолжительность действия политики в секундах при размещении новой сессии игры. Значение null для этого свойства означает, что политика действует до истечения времени ожидания очереди.

Destinations -> (список)

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

(структура)

Флот или псевдоним, назначенный в очереди сессий игры. Очереди выполняют запросы на новые сессии игры, размещая новую сессию игры в любом из направлений очереди.

DestinationArn -> (строка)

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

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

Список расположений, где очередь разрешено размещать новые сессии игры. Расположения указываются в виде кодов региона Amazon Web Services, таких как us-west-2. Если этот параметр не установлен, сессии игры могут быть размещены в любом расположении очереди.

AllowedLocations -> (список)

Список расположений для разрешения размещения сессий игры, в формате кодов регионов Amazon Web Services, таких как us-west-2.

(строка)

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

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

PriorityOrder -> (список)

Настраиваемая последовательность для приоритезации места размещения новых сессий игры. Каждый тип приоритета указан один раз.

  • LATENCY – Amazon GameLift приоритезирует расположения, где средняя задержка игроков минимальна. Данные о задержке игроков предоставляются в каждом запросе на размещение сессий игры.
  • COST – Amazon GameLift приоритезирует направления очереди с наименьшими текущими затратами на хостинг. Стоимость оценивается на основе местоположения направления, типа экземпляра и типа флота (Spot или On-Demand).
  • DESTINATION – Amazon GameLift приоритезирует в соответствии с порядком перечисления направлений в конфигурации очереди.
  • LOCATION – Amazon GameLift приоритезирует на основе предоставленного порядка расположений, определенного в LocationOrder.

(строка)

LocationOrder -> (список)

Порядок приоритетов для расположений флота, когда свойство PriorityOrder включает LOCATION. Местоположения могут включать коды регионов Amazon Web Services (такие как us-west-2), локальные зоны и настраиваемые местоположения (для флотов Anywhere). Каждое местоположение должно быть указано только один раз. Подробности см. в расположениях сервиса Amazon GameLift.

(строка)

CustomEventData -> (строка)

Информация, добавляемая ко всем событиям, связанным с этой очередью сессий игры.

NotificationTarget -> (строка)

ARN темы SNS, настроенной для получения уведомлений о размещении сессий игры. См. Настройка уведомлений о размещении сессий игры.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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