list-branches
Описание
Выводит список ветвей приложения Amplify.
См. также: Документацию API AWS
list-branches это постраничная операция. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничностью, аргумент --query должен извлекать данные из результатов следующих выражений запроса: branches
Синтаксис
list-branches
--app-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]
Параметры
--app-id (строка)
--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 (булево)
Автоматически запрашивать параметры ввода командной строки.
--no-cli-auto-prompt (булево)
Отключить автоматическое запросить параметров ввода командной строки.
Вывод
branches -> (список)
Список ветвей приложения Amplify.
(структура)
Ветка приложения Amplify, которая отображается в ветке стороннего репозитория.
branchArn -> (строка)
branchName -> (строка)
description -> (строка)
tags -> (карта)
Тег ветки приложения Amplify.
ключ -> (строка)
значение -> (строка)
stage -> (строка)
displayName -> (строка)
enableNotification -> (булево)
createTime -> (метка времени)
updateTime -> (метка времени)
environmentVariables -> (карта)
Переменные среды, специфичные для ветки приложения Amplify.
ключ -> (строка)
значение -> (строка)
enableAutoBuild -> (булево)
enableSkewProtection -> (булево)
Указывает, включена ли функция защиты смещения для ветки.
Защита смещения развертывания доступна для приложений Amplify для устранения проблем со смещением версий между клиентом и серверами в веб-приложениях. При применении защиты смещения к ветке вы можете гарантировать, что ваши клиенты всегда взаимодействуют с правильной версией серверных ресурсов независимо от того, когда происходит развертывание. Дополнительную информацию о защите смещения см. в разделе Защита смещения при развертывании Amplify в Руководстве пользователя Amplify.
customDomains -> (список)
Пользовательские домены для ветки приложения Amplify.
(строка)
framework -> (строка)
activeJobId -> (строка)
totalNumberOfJobs -> (строка)
enableBasicAuth -> (булево)
enablePerformanceMode -> (булево)
Включает режим производительности для ветки.
Режим производительности оптимизирован для более быстрого времени хостинга, храня контент в кэше на границе на более длительный срок. Когда режим производительности включен, изменения конфигурации хостинга или кода могут занять до 10 минут для внедрения.
thumbnailUrl -> (строка)
basicAuthCredentials -> (строка)
user:password.buildSpec -> (строка)
ttl -> (строка)
associatedResources -> (список)
Список пользовательских ресурсов, связанных с этой веткой.
(строка)
enablePullRequestPreview -> (булево)
pullRequestEnvironmentName -> (строка)
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 -> (строка)
computeRoleArn -> (строка)
nextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.