Spec-Zone.ru › AWS CLI v2

[ aws . gamelift ]

describe-game-session-queues

Описание

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

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

Просмотр Ваших очередей

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

describe-game-session-queues является пагинацией. Для получения всего набора результатов могут быть выполнены несколько API-запросов. Вы можете отключить пагинацию, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответном пагинационном сообщении, аргумент --query должен извлекать данные из результатов следующих выражений запроса: GameSessionQueues

Синтаксис

  describe-game-session-queues
[--names <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

--names (список)

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

(строка)

Синтаксис:

"string" "string" ...

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, указанному в --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

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

Токен для указания места начала пагинации. Это NextToken из ранее усечённого ответа.

Примеры использования см. в разделе Пагинация в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

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

Примеры использования см. в разделе Пагинация в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов, которые должны быть возвращены в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Чтобы продолжить пагинацию, укажите значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Пагинация в Руководстве пользователя AWS Command Line Interface.

--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
  • текст
  • таблица
  • 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.

Просмотр очередей игровых сессий

Следующий пример describe-game-session-queues извлекает свойства для двух указанных очередей.

aws gamelift describe-game-session-queues \
    --names MegaFrogRace-NA MegaFrogRace-EU

Вывод:

{
    "GameSessionQueues": [{
            "Destinations": [{
                    "DestinationArn": "arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
                },
                {
                    "DestinationArn": "arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
                }
            ],
            "Name": "MegaFrogRace-NA",
            "TimeoutInSeconds": 600,
            "GameSessionQueueArn": "arn:aws:gamelift:us-west-2::gamesessionqueue/MegaFrogRace-NA",
            "PlayerLatencyPolicies": [{
                    "MaximumIndividualPlayerLatencyMilliseconds": 200
                },
                {
                    "MaximumIndividualPlayerLatencyMilliseconds": 100,
                    "PolicyDurationSeconds": 60
                }
            ],
            "FilterConfiguration": {
                "AllowedLocations": ["us-west-2", "ap-south-1", "us-east-1"]
            },
            "PriorityConfiguration": {
                "PriorityOrder": ["LOCATION", "FLEET_TYPE", "DESTINATION"],
                "LocationOrder": ["us-west-2", "ap-south-1", "us-east-1"]
            }
        },
        {
            "Destinations": [{
                "DestinationArn": "arn:aws:gamelift:eu-west-3::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
            }],
            "Name": "MegaFrogRace-EU",
            "TimeoutInSeconds": 600,
            "GameSessionQueueArn": "arn:aws:gamelift:us-west-2::gamesessionqueue/MegaFrogRace-EU"
        }
    ]
}

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

Вывод

GameSessionQueues -> (список)

Коллекция объектов, описывающих запрошенные очереди игровых сессий.

(структура)

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

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

NextToken -> (строка)

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

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

Spec-Zone.ru

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