Spec-Zone.ru › AWS CLI v2

[ aws . amplify ]

list-apps

Описание

Возвращает список существующих приложений Amplify.

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

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

Синтаксис

  list-apps
[--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]

Параметры

--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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Выражение JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла аутентификации.

--region (строка)

Используемый регион. Переопределяет настройки конфигурации/окружения.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включение/выключение цветного вывода.

  • on
  • off
  • auto

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

Вывод

apps -> (список)

Список приложений Amplify.

(структура)

Представляет разные ветви репозитория для разработки, развертывания и размещения приложения Amplify.

appId -> (строка)

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

appArn -> (строка)

Amazon Resource Name (ARN) приложения Amplify.

name -> (строка)

Название приложения Amplify.

tags -> (карта)

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

key -> (строка)

value -> (строка)

description -> (строка)

Описание приложения Amplify.

repository -> (строка)

Git репозиторий приложения Amplify.

platform -> (строка)

Платформа приложения Amplify. Для статического приложения установите тип платформы в WEB. Для динамического приложения с серверной отрисовкой (SSR) установите тип платформы в WEB_COMPUTE. Для приложения, требующего только исходную поддержку SSR от Amplify Hosting, установите тип платформы в WEB_DYNAMIC.

Если вы развертываете приложение только с SSG с Next.js 14 или более поздней версией, вы должны использовать тип платформы WEB_COMPUTE.

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

Метка времени создания приложения Amplify.

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

Метка времени обновления приложения Amplify.

computeRoleArn -> (строка)

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

iamServiceRoleArn -> (строка)

Amazon Resource Name (ARN) роли службы IAM для приложения Amplify.

environmentVariables -> (карта)

Переменные окружения для приложения Amplify.

Список переменных окружения, к которым Amplify имеет доступ по умолчанию, см. в разделе «Переменные окружения Amplify» в руководстве пользователя Amplify Hosting.

key -> (строка)

value -> (строка)

defaultDomain -> (строка)

Домен по умолчанию для приложения Amplify.

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

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

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

Автоматически отключает ветку в консоли Amplify при удалении ветки из вашего Git репозитория.

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

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

basicAuthCredentials -> (строка)

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

customRules -> (список)

Описание пользовательских правил перенаправления и переписывания для приложения Amplify.

(структура)

Описание пользовательского правила переписывания или перенаправления.

source -> (строка)

Шаблон исходного URL для правила переписывания или перенаправления.

target -> (строка)

Шаблон целевого URL для правила переписывания или перенаправления.

status -> (строка)

Код состояния для правила переписывания или перенаправления URL.

200

Представляет правило переписывания 200.

301

Представляет правило перенаправления 301 (навсегда перемещено). Все последующие запросы должны быть направлены на целевой URL.

302

Представляет временное правило перенаправления 302.

404

Представляет правило перенаправления 404.

404-200

Представляет правило переписывания 404.

condition -> (строка)

Условие для правила переписывания или перенаправления URL, например, код страны.

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

Описание информации о ветке «производство» приложения Amplify.

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

Последнее время развертывания ветки «производство».

status -> (строка)

Статус ветки «производство».

thumbnailUrl -> (строка)

URL миниатюры для ветки «производство».

branchName -> (строка)

Имя ветки «производство».

buildSpec -> (строка)

Описание содержимого спецификации сборки (build spec) приложения Amplify.

customHeaders -> (строка)

Описание пользовательских HTTP-заголовков приложения Amplify.

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

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

autoBranchCreationPatterns -> (список)

Описание шаблонов создания веток с использованием glob для приложения Amplify.

(строка)

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

Описание конфигурации автоматического создания ветвей для приложения Amplify.

stage -> (строка)

Описание текущей стадии для автоматически созданной ветки.

framework -> (строка)

Фреймворк для автоматически созданной ветки.

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

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

environmentVariables -> (карта)

Переменные окружения для автоматически созданной ветки.

key -> (строка)

value -> (строка)

basicAuthCredentials -> (строка)

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

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

Включает базовый аутентификацию для автоматически созданной ветки.

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

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

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

buildSpec -> (строка)

Спецификация сборки (build spec) для автоматически созданной ветки.

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

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

pullRequestEnvironmentName -> (строка)

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

repositoryCloneMethod -> (строка)

Примечание

Это предназначено для внутреннего использования.

Служба Amplify использует этот параметр для указания протокола аутентификации, который будет использоваться для доступа к Git репозиторию приложения Amplify. Для репозитория GitHub Amplify указывает TOKEN, для репозитория Amazon Web Services CodeCommit - SIGV4, а для репозиториев GitLab и Bitbucket - SSH.

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

Конфигурация кэша приложения Amplify. Если вы не указываете конфигурацию кэша type, Amplify использует значение по умолчанию AMPLIFY_MANAGED.

type -> (строка)

Тип конфигурации кэша, который использовать для приложения Amplify.

Конфигурация кэша AMPLIFY_MANAGED автоматически применяет оптимизированную конфигурацию кэша для вашего приложения на основе его платформы, правил маршрутизации и правил переписывания. Это значение по умолчанию.

Тип конфигурации кэша AMPLIFY_MANAGED_NO_COOKIES такой же, как AMPLIFY_MANAGED, за исключением того, что все cookie исключены из ключа кэша.

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

Метка времени создания webhook в вашем Git репозитории.

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

Описание конфигурации Firewall для приложения Amplify. Поддержка Firewall позволяет защитить размещённые приложения с помощью прямой интеграции с WAF.

webAclArn -> (строка)

Amazon Resource Name (ARN) для web ACL, связанного с приложением Amplify.

wafStatus -> (строка)

Статус процесса добавления или удаления web ACL для приложения Amplify.

statusReason -> (строка)

Причина текущего статуса конфигурации Firewall.

nextToken -> (строка)

Токен для пагинации. Установите в null, чтобы начать перечисление приложений с начала. Если не null, токен для пагинации возвращается в результате. Передайте его значение здесь, чтобы перечислить больше проектов.

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

Spec-Zone.ru

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