Spec-Zone.ru › AWS CLI v2

[ aws . proton ]

cancel-environment-deployment

Описание

Попытка отменить развертывание среды в действии UpdateEnvironment, если развертывание находится в состоянии IN_PROGRESS. Дополнительную информацию см. в разделе «Обновление среды» в руководстве пользователя Proton.

Ниже приведен список возможных сценариев отмены.

  • Если попытка отмены завершится успешно, состояние развертывания станет CANCELLED.
  • Если попытка отмены завершится неудачно, состояние развертывания станет FAILED.
  • Если действие UpdateEnvironment завершится успешно до начала попытки отмены, состояние развертывания станет SUCCEEDED, и попытка отмены не повлияет на него.

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

Синтаксис

  cancel-environment-deployment
--environment-name <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]

Параметры

--environment-name (строка)

Имя среды с развертыванием, которое нужно отменить.

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

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если предоставлено значение null или 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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого файла, сопоставленного с двоичным блоком, 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.

Вывод

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

Данные сводки среды, возвращаемые Proton.

arn -> (строка)

Amazon Resource Name (ARN) среды.

codebuildRoleArn -> (строка)

Amazon Resource Name (ARN) роли сервиса IAM, которая позволяет Proton обеспечивать развертывание инфраструктуры с использованием CodeBuild от вашего имени.

componentRoleArn -> (строка)

Amazon Resource Name (ARN) роли сервиса IAM, которую Proton использует при развертывании явно определенных компонентов в этой среде. Она определяет объем инфраструктуры, которую может развернуть компонент.

Для использования явно определенных компонентов в среде необходима componentRoleArn.

Дополнительную информацию о компонентах см. в разделе «Компоненты Proton» в руководстве пользователя Proton.

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

Время создания среды.

deploymentStatus -> (строка)

Статус развертывания среды.

deploymentStatusMessage -> (строка)

Сообщение о статусе развертывания среды.

description -> (строка)

Описание среды.

environmentAccountConnectionId -> (строка)

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

environmentAccountId -> (строка)

Идентификатор учетной записи среды, в которой развернуты ресурсы инфраструктуры среды.

lastAttemptedDeploymentId -> (строка)

Идентификатор последней попытки развертывания этой среды.

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

Время последней попытки развертывания среды.

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

Время последнего успешного развертывания среды.

lastSucceededDeploymentId -> (строка)

Идентификатор последнего успешного развертывания этой среды.

name -> (строка)

Имя среды.

protonServiceRoleArn -> (строка)

Amazon Resource Name (ARN) роли Proton-сервиса, которая позволяет Proton делать вызовы к другим сервисам от вашего имени.

provisioning -> (строка)

Если указано, указывает, что шаблон среды предназначен для клиенто-управляемой и управляемой инфраструктуры.

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

Связанный репозиторий, в котором вы храните свои отрендеренные шаблоны инфраструктуры для самообслуживаемого развертывания. Связанный репозиторий — это репозиторий, зарегистрированный в Proton. Дополнительные сведения см. в разделе «Создать репозиторий».

arn -> (строка)

Amazon Resource Name (ARN) связанного репозитория.

branch -> (строка)

Ветка репозитория.

name -> (строка)

Имя репозитория.

provider -> (строка)

Поставщик репозитория.

spec -> (строка)

Спецификация среды.

templateMajorVersion -> (строка)

Основная версия шаблона среды.

templateMinorVersion -> (строка)

Дополнительная версия шаблона среды.

templateName -> (строка)

Amazon Resource Name (ARN) шаблона среды.

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

Spec-Zone.ru

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