Spec-Zone.ru › AWS CLI v2

[ aws . gamelift ]

describe-matchmaking-configurations

Описание

Получает подробные сведения о конфигурациях подбора игроков FlexMatch.

Данная операция предлагает следующие варианты: (1) получить все конфигурации подбора, (2) получить конфигурации для указанного списка или (3) получить все конфигурации, использующие указанное имя набора правил. При запросе нескольких элементов используйте параметры постраничной навигации для получения результатов в виде набора последовательных страниц.

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

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

Настройка подборщиков FlexMatch

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

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

Синтаксис

  describe-matchmaking-configurations
[--names <value>]
[--rule-set-name <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" ...

--rule-set-name (строка)

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

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

Вывод

Конфигурации -> (список)

Коллекция запрошенных конфигураций подбора игроков.

(структура)

Руководство по использованию FlexMatch для подбора игроков в игры. Все запросы подбора должны указывать конфигурацию подбора.

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

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

ConfigurationArn -> (строка)

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

Описание -> (строка)

Дескриптор, связанный с конфигурацией подбора.

GameSessionQueueArns -> (список)

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

(строка)

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

Максимальная продолжительность (в секундах), в течение которой тикет подбора может оставаться в процессе обработки перед истечением времени. Запросы, завершившиеся из-за истечения времени, могут быть повторно отправлены по мере необходимости.

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

Продолжительность ожидания (в секундах) принятия предложенного матча игроками, если это требуется. Если игрок отклонит матч или не примет его до истечения срока, тикет продолжит поиск подходящего матча.

AcceptanceRequired -> (булево значение)

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

RuleSetName -> (строка)

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

RuleSetArn -> (строка)

Amazon Resource Name (ARN), связанный с ресурсом набора правил подбора GameLift, используемым этой конфигурацией.

NotificationTarget -> (строка)

ARN темы SNS, настроенной для получения уведомлений о подборе.

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

Количество игровых слотов в матче, которые необходимо оставить открытыми для будущих игроков. Например, если набор правил конфигурации задает матч для одной команды из 12 человек, а количество дополнительных игроков установлено в 2, только 10 игроков выбираются для матча. Этот параметр не используется, когда FlexMatchMode установлено в значение STANDALONE.

CustomEventData -> (строка)

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

CreationTime -> (отметка времени)

Отметка времени, указывающая, когда этот объект данных был создан. Формат — число, выраженное в Unix-времени в миллисекундах (например, "1469498468.057").

GameProperties -> (список)

Набор пар «ключ-значение», которые могут хранить пользовательские данные в игровой сессии. Например: {"Key": "difficulty", "Value": "novice"}. Эта информация добавляется к новому объекту GameSession, создаваемому для успешного матча. Этот параметр не используется, когда FlexMatchMode установлено в значение STANDALONE.

(структура)

Эта пара «ключ-значение» может хранить пользовательские данные об игровой сессии. Например, можно использовать GameProperty для отслеживания карты игровой сессии, уровня сложности или оставшегося времени. Уровень сложности можно указать так: {"Key": "difficulty", "Value":"Novice"}.

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

Примеры работы со свойствами игры см. в разделе Создайте игровой сессии со свойствами.

Ключ -> (строка)

Идентификатор свойства игры.

Значение -> (строка)

Значение свойства игры.

GameSessionData -> (строка)

Набор пользовательских свойств игровой сессии, отформатированных как единственное строковое значение. Эти данные передаются процессу сервера игры с запросом на запуск новой игровой сессии. Дополнительная информация приведена в разделе Запуск игровой сессии. Эта информация добавляется к новому объекту GameSession, создаваемому для успешного матча. Этот параметр не используется, когда FlexMatchMode установлено в значение STANDALONE.

BackfillMode -> (строка)

Способ заполнения игровых сессий, созданных с помощью этой конфигурации подбора. MANUAL указывает, что игра выполняет запросы заполнения или не использует функцию заполнения матчей. AUTOMATIC указывает, что GameLift создает запросы заполнения всякий раз, когда игровая сессия имеет один или несколько открытых слотов. Подробнее о ручном и автоматическом заполнении см. в разделе Заполнение существующих игр с помощью FlexMatch. Автоматическое заполнение недоступно, когда FlexMatchMode установлено в значение STANDALONE.

FlexMatchMode -> (строка)

Указывает, используется ли эта конфигурация подбора с Amazon GameLift или как автономное решение для подбора игроков.

  • STANDALONE - FlexMatch формирует матчи и возвращает информацию о матче, включая игроков и распределение по командам, в событии MatchmakingSucceeded.
  • WITH_QUEUE - FlexMatch формирует матчи и использует указанную очередь Amazon GameLift для запуска игровой сессии для матча.

NextToken -> (строка)

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

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

Spec-Zone.ru

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