Spec-Zone.ru › AWS CLI v2

[ aws . gamelift ]

update-game-session-queue

Описание

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

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

Использование очередей по многим регионам

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

Синтаксис

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

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

--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), назначенный флоту или алиасу флота. ARN, включающий идентификатор флота или алиаса и имя региона, обеспечивают уникальный идентификатор во всех регионах.

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

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, настроенной для получения уведомлений о размещении сеансов игры. См. Настройка уведомлений для размещения сеансов игры.

--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
  • таблица
  • 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-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Примеры

Примечание

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

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

Чтобы обновить конфигурацию очереди игровых сессий

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

aws gamelift update-game-session-queue \
    --name MegaFrogRace-NA \
    --destinations file://destinations.json \
    --player-latency-policies file://latency-policies.json

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

{
    "Destinations": [
        {"DestinationArn": "arn:aws:gamelift:us-west-2::fleet/fleet-1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"},
        {"DestinationArn": "arn:aws:gamelift:us-east-1::fleet/fleet-5c6d3c4d-5e6f-7a8b-9c0d-1e2f3a4b5a2b"},
        {"DestinationArn": "arn:aws:gamelift:us-east-1::alias/alias-11aa22bb-3c4d-5e6f-000a-1111aaaa22bb"}
    ]
}

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

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

Вывод:

{
    "GameSessionQueue": {
        "Destinations": [
            {"DestinationArn": "arn:aws:gamelift:us-west-2::fleet/fleet-1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"},
            {"DestinationArn": "arn:aws:gamelift:us-east-1::fleet/fleet-5c6d3c4d-5e6f-7a8b-9c0d-1e2f3a4b5a2b"},
            {"DestinationArn": "arn:aws:gamelift:us-east-1::alias/alias-11aa22bb-3c4d-5e6f-000a-1111aaaa22bb"}
        ],
        "GameSessionQueueArn": "arn:aws:gamelift:us-west-2:111122223333:gamesessionqueue/MegaFrogRace-NA",
        "Name": "MegaFrogRace-NA",
        "TimeoutInSeconds": 600,
        "PlayerLatencyPolicies": [
            {"MaximumIndividualPlayerLatencyMilliseconds": 200},
            {"MaximumIndividualPlayerLatencyMilliseconds": 150, "PolicyDurationSeconds": 120},
            {"MaximumIndividualPlayerLatencyMilliseconds": 100, "PolicyDurationSeconds": 120}
        ]
    }
}

Дополнительную информацию см. в разделе «Использование очередей в нескольких регионах» в руководстве разработчика Amazon GameLift.

Вывод

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

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

Name -> (строка)

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

GameSessionQueueArn -> (строка)

Amazon Resource Name (ARN), присвоенный ресурсу очереди игровых сессий Amazon GameLift, уникально его идентифицирующий. ARNs уникальны для всех регионов. Формат: arn:aws:gamelift:<region>::gamesessionqueue/<queue name> . В ARN очереди игровых сессий Amazon GameLift идентификатор ресурса соответствует значению Name.

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.

Spec-Zone.ru

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