Spec-Zone.ru › AWS CLI v2

[ aws . gamelift ]

list-fleet-deployments

Описание

Возвращает коллекцию развертываний контейнерных флотов в регионе Amazon Web Services. Используйте параметры постраничной обработки для получения результатов в виде последовательности страниц.

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

При успешном выполнении операция возвращает список развертываний, соответствующих параметрам запроса. Значение NextToken также возвращается, если есть дополнительные страницы результатов для извлечения.

Примечание

Развертывания возвращаются, начиная с последнего.

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

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

Синтаксис

  list-fleet-deployments
[--fleet-id <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 (строка)

Уникальный идентификатор контейнерного флота. Вы можете использовать либо идентификатор, либо значение 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.

Вывод

FleetDeployments -> (список)

Запрашиваемая информация о развертывании.

(структура)

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

DeploymentId -> (строка)

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

FleetId -> (строка)

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

GameServerBinaryArn -> (строка)

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

RollbackGameServerBinaryArn -> (строка)

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

PerInstanceBinaryArn -> (строка)

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

RollbackPerInstanceBinaryArn -> (строка)

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

DeploymentStatus -> (строка)

Статус активности развертывания флота в месте расположения.

  • IN_PROGRESS – Развертывание выполняется.
  • IMPAIRED – Развертывание завершилось неудачно, и в флоте имеются некоторые неисправные контейнеры.
  • COMPLETE – Развертывание успешно завершено.
  • ROLLBACK_IN_PROGRESS – Развертывание завершилось неудачно, и начат откат.
  • ROLLBACK_IN_COMPLETE – Развертывание завершилось неудачно, и откат завершен.
  • CANCELLED – Развертывание было отменено.

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

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

ProtectionStrategy -> (строка)

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

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

Устанавливает минимальный уровень здоровых задач для поддержания во время развертывания.

ImpairmentStrategy -> (строка)

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

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

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

NextToken -> (строка)

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

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

Spec-Zone.ru

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