Spec-Zone.ru › AWS CLI v2

[ aws . amplify ]

удалить-ветвь

Описание

Удаляет ветвь для приложения Amplify.

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

Синтаксис

  delete-branch
--app-id <value>
--branch-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]

Параметры

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

Уникальный идентификатор приложения Amplify.

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

Имя ветви.

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

Вывод

ветвь -> (структура)

Ветвь приложения Amplify, которая сопоставляется с ветвью репозитория третьей стороны.

branchArn -> (строка)

Amazon Resource Name (ARN) ветви, которая является частью приложения Amplify.

branchName -> (строка)

Имя ветви, которая является частью приложения Amplify.

description -> (строка)

Описание ветви, которая является частью приложения Amplify.

tags -> (словарь)

Тег ветви приложения Amplify.

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

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

stage -> (строка)

Текущая фаза ветви, которая является частью приложения Amplify.

displayName -> (строка)

Имя для отображения ветви. Используется в качестве префикса домена по умолчанию.

enableNotification -> (логическое значение)

Включает уведомления для ветви, которая является частью приложения Amplify.

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

Отметка времени создания ветви Amplify.

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

Отметка времени последнего обновления ветви.

environmentVariables -> (словарь)

Переменные среды, специфичные для ветви приложения Amplify.

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

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

enableAutoBuild -> (логическое значение)

Включает автоматическое построение при push для ветви приложения Amplify.

enableSkewProtection -> (логическое значение)

Указывает, включена ли функция защиты от смещения для ветви.

Защита от смещения при развертывании доступна для приложений Amplify, чтобы устранить проблемы смещения версий между клиентом и серверами в веб-приложениях. При применении защиты от смещения к ветви вы можете гарантировать, что клиенты всегда взаимодействуют с правильной версией серверных ресурсов, независимо от времени развертывания. Дополнительную информацию о защите от смещения см. в разделе "Защита от смещения при развертывании Amplify" в руководстве пользователя Amplify.

customDomains -> (список)

Настраиваемые домены для ветви приложения Amplify.

(строка)

framework -> (строка)

Фреймворк для ветви приложения Amplify.

activeJobId -> (строка)

Идентификатор активной задачи для ветви приложения Amplify.

totalNumberOfJobs -> (строка)

Общее количество задач, которые являются частью приложения Amplify.

enableBasicAuth -> (логическое значение)

Включает базовый авторизацию для ветви приложения Amplify.

enablePerformanceMode -> (логическое значение)

Включает режим производительности для ветви.

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

thumbnailUrl -> (строка)

URL миниатюры для ветви приложения Amplify.

basicAuthCredentials -> (строка)

Учетные данные для базовой авторизации для ветви приложения Amplify. Необходимо закодировать учетные данные авторизации в base64 и предоставить их в формате user:password.

buildSpec -> (строка)

Содержимое спецификации построения (build spec) для ветви приложения Amplify.

ttl -> (строка)

Время жизни содержимого (TTL) веб-сайта в секундах.

associatedResources -> (список)

Список пользовательских ресурсов, связанных с этой ветвью.

(строка)

enablePullRequestPreview -> (логическое значение)

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

pullRequestEnvironmentName -> (строка)

Имя среды Amplify для запроса на вытягивание.

destinationBranch -> (строка)

Целевая ветвь, если ветвь является ветвью запроса на вытягивание.

sourceBranch -> (строка)

Исходная ветвь, если ветвь является ветвью запроса на вытягивание.

backendEnvironmentArn -> (строка)

Amazon Resource Name (ARN) для среды бэкенда, которая является частью приложения Amplify.

Это свойство доступно только для приложений Amplify Gen 1. При развертывании приложения с Amplify Gen 2 вы снабжаете бэкенд инфраструктуру приложения с помощью кода Typescript.

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

Описывает бэкенд, связанный с приложением Amplify Branch.

Это свойство доступно только для приложений Amplify Gen 2. При развертывании приложения с Amplify Gen 2 вы снабжаете бэкенд инфраструктуру приложения с помощью кода Typescript.

stackArn -> (строка)

Amazon Resource Name (ARN) стека CloudFormation.

computeRoleArn -> (строка)

Amazon Resource Name (ARN) роли IAM для ветви приложения SSR. Роль вычислений позволяет службе вычислений Amplify Hosting безопасно получать доступ к определенным ресурсам Amazon Web Services на основе разрешений роли. Дополнительную информацию о роли вычислений SSR см. в разделе "Добавление роли вычислений SSR" в руководстве пользователя Amplify.

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

Spec-Zone.ru

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