Spec-Zone.ru › AWS CLI v2

[ aws . gamelift ]

update-game-session

Описание

Обновляет изменяемые свойства сессии игры.

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

При успешном выполнении возвращается обновленный GameSession объект.

Все API по задаче

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

Синтаксис

  update-game-session
--game-session-id <value>
[--maximum-player-session-count <value>]
[--name <value>]
[--player-session-creation-policy <value>]
[--protection-policy <value>]
[--game-properties <value>]
[--cli-input-json | --cli-input-yaml]
[--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]

Параметры

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

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

--maximum-player-session-count (целое число)

Максимальное количество игроков, которые могут одновременно подключиться к сессии игры.

--name (строка)

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

--player-session-creation-policy (строка)

Политика, определяющая, принимает ли сессия игры новых игроков.

Возможные значения:

  • ACCEPT_ALL
  • DENY_ALL

--protection-policy (строка)

Политика защиты сессии игры, применяемая только к этой сессии игры.

  • NoProtection – Сессия игры может быть завершена во время события уменьшения масштаба.
  • FullProtection – Если сессия игры находится в состоянии ACTIVE, она не может быть завершена во время события уменьшения масштаба.

Возможные значения:

  • NoProtection
  • FullProtection

--game-properties (список)

Набор пар «ключ-значение», которые могут хранить пользовательские данные в сессии игры. Например: {"Key": "difficulty", "Value": "novice"} . Вы можете использовать этот параметр для изменения свойств игры в активной сессии игры. Этот действие добавляет новые свойства и изменяет существующие свойства. Удалить свойства нельзя. Пример смотрите в Update the value of a game property.

(структура)

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

Вы можете задать свойства игры при создании сессии игры. Также вы можете изменить свойства игры активной сессии. При поиске сессий игры можно фильтровать по ключам и значениям свойств игры. Свойства игры из сессии удалить нельзя.

Примеры работы со свойствами игры смотрите в Create a game session with properties.

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

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

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

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

Сокращенный синтаксис:

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

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

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

Вывод

GameSession -> (структура)

Обновленные свойства игровой сессии.

GameSessionId -> (строка)

Уникальный идентификатор игровой сессии. ARN игровой сессии имеет следующий формат: arn:aws:gamelift:<location>::gamesession/<fleet ID>/<custom ID string or idempotency token> .

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

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

FleetId -> (строка)

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

FleetArn -> (строка)

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

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

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

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

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

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

Количество игроков, в настоящее время находящихся в игровой сессии.

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

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

Статус -> (строка)

Текущий статус игровой сессии. Игровая сессия должна иметь статус ACTIVE, чтобы иметь игровые сессии пользователей.

StatusReason -> (строка)

Предоставляет дополнительную информацию о статусе игровой сессии.

  • INTERRUPTED – Игровая сессия была размещена на экземпляре EC2 Spot, который был возвращен, что привело к остановке активной игровой сессии.
  • TRIGGERED_ON_PROCESS_TERMINATE – Игровая сессия была остановлена вызовом TerminateGameSession с режимом завершения TRIGGER_ON_PROCESS_TERMINATE .
  • FORCE_TERMINATED – Игровая сессия была остановлена вызовом TerminateGameSession с режимом завершения FORCE_TERMINATE .

GameProperties -> (список)

Набор пар ключ-значение, которые могут хранить пользовательские данные в игровой сессии. Например: {"Key": "difficulty", "Value": "novice"} .

(структура)

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

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

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

Key -> (строка)

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

Value -> (строка)

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

IpAddress -> (строка)

IP-адрес игровой сессии. Для подключения к игровому серверу Amazon GameLift приложение должно знать как IP-адрес, так и номер порта.

DnsName -> (строка)

Идентификатор DNS, назначенный экземпляру, на котором выполняется игровая сессия. Значения имеют следующий формат:

  • Флоты с включенным TLS: <unique identifier>.<region identifier>.amazongamelift.com .
  • Флоты без TLS: ec2-<unique identifier>.compute.amazonaws.com . (См. Amazon EC2 Instance IP Addressing .)

При подключении к игровой сессии, выполняющейся на флоте с включенным TLS, необходимо использовать имя DNS, а не IP-адрес.

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

Номер порта для игровой сессии. Для подключения к игровому серверу Amazon GameLift приложение должно знать как IP-адрес, так и номер порта.

PlayerSessionCreationPolicy -> (строка)

Указывает, принимает ли игровая сессия новых игроков.

CreatorId -> (строка)

Уникальный идентификатор игрока. Этот идентификатор используется для применения политики защиты ресурсов (если она существует), которая ограничивает количество игровых сессий, которые может создать игрок.

GameSessionData -> (строка)

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

MatchmakerData -> (строка)

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

Location -> (строка)

Местоположение флота, на котором выполняется игровая сессия. Это значение может указывать домашнюю зону региона Amazon Web Services или удаленное местоположение. Местоположение указывается в виде кода региона Amazon Web Services, например, us-west-2 .

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

Spec-Zone.ru

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