Spec-Zone.ru › AWS CLI v2

[ aws . gamelift ]

describe-matchmaking-rule-sets

Описание

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

Дополнительная информация
  • Создание набора правил

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

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

Синтаксис

  describe-matchmaking-rule-sets
[--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 для вывода.

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

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

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

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

Вывод

RuleSets -> (список)

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

(структура)

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

Набор правил может определять следующие элементы для матча. Подробную информацию и примеры по созданию набора правил см. в разделе Создание набора правил FlexMatch.

  • Команды — Обязательно. Набор правил должен определять одну или несколько команд для матча и устанавливать минимальное и максимальное количество игроков в команде. Например, набор правил может описывать матч 4x4, в котором требуется заполнить все восемь мест.
  • Атрибуты игроков — Необязательно. Эти атрибуты определяют набор характеристик игроков, которые оцениваются при поиске матча. Запросы подбора игроков, использующие набор правил с атрибутами игроков, должны предоставлять соответствующие значения атрибутов. Например, атрибут может указывать навык или уровень игрока.
  • Правила — Необязательно. Правила определяют, как оцениваются потенциальные игроки для матча на основе атрибутов игроков. Правило может задавать минимальные требования к отдельным игрокам, командам или всему матчу. Например, правило может требовать, чтобы каждый игрок соответствовал определённому уровню навыков, чтобы каждая команда имела как минимум одного игрока определённой роли или чтобы матч имел минимальный средний уровень навыков. или может описывать целую группу — например, все команды должны быть сбалансированы или иметь как минимум одного игрока определённой роли.
  • Расширения — Необязательно. Расширения позволяют смягчать правила после определенного периода времени, когда подходящие матчи не найдены. Эта функция позволяет сбалансировать ввод игроков в игры за разумное время, а не заставлять их бесконечно ждать лучшего матча. Например, вы можете использовать расширение для увеличения максимального разброса навыков между игроками после 30 секунд.

RuleSetName -> (строка)

Уникальный идентификатор набора правил подбора игроков

RuleSetArn -> (строка)

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

RuleSetBody -> (строка)

Коллекция правил подбора игроков, отформатированная как JSON-строка. Комментарии в JSON не допускаются, но большинство элементов поддерживают поле описания.

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

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

NextToken -> (строка)

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

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

Spec-Zone.ru

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