describe-game-sessions

Описание

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

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

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

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

В случае успеха, для каждой игровой сессии, соответствующей запросу, возвращается объект GameSession.

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

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

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

Синтаксис

  describe-game-sessions
[--fleet-id <value>]
[--game-session-id <value>]
[--alias-id <value>]
[--location <value>]
[--status-filter <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 (строка)

--game-session-id (строка)

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

--location (строка)

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

--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 (логическое значение)

Включить отладку протоколирования.

--endpoint-url (строка)

Переопределить URL по умолчанию команды на указанный URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (логическое значение)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI сделает только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

• json
• text
• table
• yaml
• yaml-stream

--query (строка)

Запрос JMESPath для использования при фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

• on
• off
• auto

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

Выходные данные

GameSessions -> (список)

NextToken -> (строка)