stop-game-session-placement
Описание
Отменяет размещение игровой сессии, находящейся в статусе PENDING. Для отмены размещения укажите значение идентификатора размещения.
Результаты
В случае успеха данная операция удаляет запрос на размещение из очереди и переводит GameSessionPlacement в статус CANCELLED.
Эта операция приводит к ошибке InvalidRequestExecption (400), если для этого размещения уже была создана игровая сессия. Вы можете очистить ненужную игровую сессию, вызвав TerminateGameSession .
См. также: Документацию API AWS
Синтаксис
stop-game-session-placement
--placement-id <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]
Параметры
--placement-id (строка)
--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
- текст
- таблица
- 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.
Вывод
GameSessionPlacement -> (структура)
Объект, описывающий отменленное размещение игровой сессии, со статусом CANCELLED и отметкой времени окончания.
PlacementId -> (строка)
GameSessionQueueName -> (строка)
Status -> (строка)
Текущий статус запроса на размещение игровой сессии.
- PENDING – Запрос на размещение находится в очереди ожидания обработки. Свойства игровой сессии пока не окончательные.
- FULFILLED – Новая игровая сессия успешно размещена. Свойства игровой сессии теперь окончательные.
- CANCELLED – Запрос на размещение был отменен.
- TIMED_OUT – Новая игровая сессия не была успешно создана до истечения лимита времени. Вы можете повторно отправить запрос на размещение по мере необходимости.
- FAILED – Amazon GameLift не может завершить процесс размещения игровой сессии. Распространенные причины – завершение игровой сессии до завершения процесса размещения или непредвиденная внутренняя ошибка.
GameProperties -> (список)
Набор пар ключ-значение, которые могут хранить пользовательские данные в игровой сессии. Например: {"Key": "difficulty", "Value": "novice"} .
(структура)
Эта пара ключ-значение может хранить пользовательские данные об игровой сессии. Например, вы можете использовать GameProperty для отслеживания карты игровой сессии, уровня сложности или оставшегося времени. Уровень сложности можно указать так: {"Key": "difficulty", "Value":"Novice"} .
Вы можете задавать свойства игры при создании игровой сессии. Вы также можете изменять свойства игры активной игровой сессии. При поиске игровых сессий вы можете фильтровать по ключам и значениям свойств игры. Вы не можете удалять свойства игры из игровой сессии.
Примеры работы со свойствами игры см. в Create a game session with properties .
Key -> (строка)
Value -> (строка)
MaximumPlayerSessionCount -> (целое число)
GameSessionName -> (строка)
GameSessionId -> (строка)
FULFILLED .GameSessionArn -> (строка)
FULFILLED .GameSessionRegion -> (строка)
FULFILLED .PlayerLatencies -> (список)
Набор значений, выраженных в миллисекундах, указывающих на количество задержки, которое испытывает игрок при подключении к Amazon Web Services регионам.
(структура)
Региональная информация о задержке для игрока, используемая при запросе новой игровой сессии. Это значение указывает на количество задержки, которое существует, когда игрок подключен к флоту в указанном регионе. Относительная разница между значениями задержки игрока для нескольких регионов используется для определения, какие флоты наиболее подходят для размещения новой игровой сессии для игрока.
PlayerId -> (строка)
RegionIdentifier -> (строка)
LatencyInMilliseconds -> (вещественное число)
StartTime -> (отметка времени)
"1469498468.057").EndTime -> (отметка времени)
IpAddress -> (строка)
FULFILLED .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 -> (целое число)
FULFILLED .PlacedPlayerSessions -> (список)
Коллекция информации о сессиях игроков, созданных в ответ на запрос на размещение игровой сессии. Эти сессии игроков создаются только после успешного размещения новой игровой сессии (статус размещения FULFILLED). Эта информация включает идентификатор игрока, предоставленный в запросе на размещение, и соответствующий идентификатор сессии игрока.
(структура)
Информация о сессии игрока. Этот объект содержит только идентификатор игрока и идентификатор сессии игрока. Для получения полной информации о сессии игрока вызовите DescribePlayerSessions с идентификатором сессии игрока.
PlayerId -> (строка)
PlayerSessionId -> (строка)
GameSessionData -> (строка)
MatchmakerData -> (строка)
PriorityConfigurationOverride -> (структура)
Альтернативный приоритетный список расположений, включенный в запрос на размещение игровой сессии. При предоставлении список переопределяет список порядка расположения очереди только для этого запроса на размещение игровой сессии. Список может включать Amazon Web Services регионы, локальные зоны и пользовательские расположения (для флотов Anywhere). Стратегия падения сообщает Amazon GameLift о действиях (если таковые имеются), которые нужно предпринять в случае, если размещение новой игровой сессии не удалось.
PlacementFallbackStrategy -> (строка)
Инструкции о том, как действовать в случае неудачи размещения в каждом расположении в списке приоритетного переопределения. Допустимые стратегии включают:
-
DEFAULT_AFTER_SINGLE_PASS– После попытки размещения новой игровой сессии в каждом расположении в списке приоритетного переопределения, попробуйте разместить игровые сессии в других расположениях очереди. Это поведение по умолчанию. -
NONE– Ограничить размещения только расположениями в списке приоритетного переопределения.
LocationOrder -> (список)
Приоритетный список расположений хостинга. Список может включать Amazon Web Services регионы (например, us-west-2 ), локальные зоны и пользовательские расположения (для флотов Anywhere). Каждое расположение должно быть указано только один раз. Подробности см. в расположениях сервиса Amazon GameLift.
(строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.