Spec-Zone.ru › AWS CLI v2

[ aws . amplify ]

get-app

Описание

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

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

Синтаксис

  get-app
--app-id <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.

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

Вывод

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

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

appId -> (строка)

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

appArn -> (строка)

Идентификатор ресурса Amazon (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 (ARN) роли IAM для приложения SSR. Роль Compute позволяет службе вычислений Amplify Hosting безопасно получать доступ к определенным ресурсам Amazon Web Services на основе разрешений роли. Дополнительную информацию о роли вычислений SSR см. в разделе «Добавление роли вычислений SSR» в руководстве пользователя Amplify.

iamServiceRoleArn -> (строка)

Идентификатор ресурса Amazon (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. Amplify задает TOKEN для репозитория GitHub, SIGV4 для репозитория Amazon Web Services CodeCommit и SSH для репозиториев GitLab и Bitbucket.

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

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

type -> (строка)

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

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

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

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

Метка времени создания веб-хука в вашем репозитории Git.

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

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

webAclArn -> (строка)

Идентификатор ресурса Amazon (ARN) для веб-ACL, связанной с приложением Amplify.

wafStatus -> (строка)

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

statusReason -> (строка)

Причина текущего статуса конфигурации брандмауэра.

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

Spec-Zone.ru

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