search-game-sessions

Описание

Возвращает все активные игровые сессии, соответствующие набору критериев поиска, и сортирует их в указанном порядке.

Данная операция не предназначена для постоянного отслеживания статуса игровых сессий, так как это может привести к превышению лимита API и появлению ошибок. Вместо этого настройте тему Amazon Simple Notification Service (Amazon SNS) для получения уведомлений от системы подбора матчей или очереди размещения игровых сессий.

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

Данную операцию можно использовать следующим образом:

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

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

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

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

• gameSessionId – Уникальный идентификатор игровой сессии. Вы можете использовать значение GameSessionId или GameSessionArn.
• gameSessionName – Название, назначенное игровой сессии. Имена игровых сессий не обязательно должны быть уникальными для каждой сессии.
• gameSessionProperties – Набор пар ключ-значение, которые могут хранить пользовательские данные в игровой сессии. Например: {"Key": "difficulty", "Value": "novice"}. Выражение фильтра должно указать https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameProperty – Key и строку Value для поиска игровых сессий. Например, для поиска указанной пары ключ-значение укажите следующий фильтр поиска: gameSessionProperties.difficulty = "novice". Все значения свойств игры ищутся как строки. Примеры поиска игровых сессий см. ниже, а также см. Поиск игровых сессий по свойствам игры.
• maximumSessions – Максимальное количество игровых сессий, разрешённых для игровой сессии.
• creationTimeMillis – Значение, указывающее время создания игровой сессии. Оно выражено в формате Unix с точностью до миллисекунд.
• playerSessionCount – Количество игроков, подключённых к игровой сессии в данный момент. Это значение быстро меняется, поскольку игроки присоединяются к сессии или отсоединяются.
• hasAvailablePlayerSessions – Булево значение, указывающее, достигла ли игровая сессия максимального числа игроков. Настоятельно рекомендуется, чтобы все запросы поиска включали этот атрибут фильтра для оптимизации производительности поиска и возвращения только сессий, к которым могут присоединиться игроки.

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

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

Синтаксис

  search-game-sessions
[--fleet-id <value>]
[--alias-id <value>]
[--location <value>]
[--filter-expression <value>]
[--sort-expression <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]

Параметры

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

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

--location (строка)

--filter-expression (строка)

--sort-expression (строка)

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

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

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

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

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

Вывод

GameSessions -> (список)

NextToken -> (строка)