Spec-Zone.ru › AWS CLI v2

[ aws . transfer ]

describe-web-app

Описание

Описывает веб-приложение, идентифицированное по WebAppId.

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

Синтаксис

  describe-web-app
--web-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]

Параметры

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

Укажите уникальный идентификатор веб-приложения.

--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-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запросы параметров ввода CLI.

Вывод

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

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

Arn -> (строка)

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

WebAppId -> (строка)

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

DescribedIdentityProviderDetails -> (структура помеченного объединения)

Структура, содержащая сведения об идентификаторе пользователя, используемом веб-приложением.

Примечание

Это структура помеченного объединения. Только один из следующих ключевых элементов верхнего уровня может быть задан: IdentityCenterConfig.

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

Возвращает структуру для данных вашего идентификатора пользователя. Эта структура содержит ARN экземпляра и роль, используемые для веб-приложения.

ApplicationArn -> (строка)

Amazon Resource Name (ARN) приложения IAM Identity Center: это значение устанавливается автоматически при создании веб-приложения.

InstanceArn -> (строка)

Amazon Resource Name (ARN) IAM Identity Center, используемого для веб-приложения.

Role -> (строка)

Роль IAM в IAM Identity Center, используемая для веб-приложения.

AccessEndpoint -> (строка)

AccessEndpoint — это URL-адрес, который вы предоставляете своим пользователям для взаимодействия с веб-приложением Transfer Family. Вы можете указать пользовательский URL-адрес или использовать значение по умолчанию.

WebAppEndpoint -> (строка)

WebAppEndpoint — это уникальный URL-адрес вашего веб-приложения Transfer Family. Это значение используется при настройке **Origins** в CloudFront.

WebAppUnits -> (структура помеченного объединения)

Объединение, содержащее значение количества одновременных подключений или пользовательских сеансов в вашем веб-приложении.

Примечание

Это структура помеченного объединения. Только один из следующих ключевых элементов верхнего уровня может быть задан: Provisioned.

Provisioned -> (целое число)

Целое число, представляющее количество единиц для желаемого количества одновременных подключений или количества пользовательских сеансов в вашем веб-приложении одновременно.

Каждое увеличение позволяет на 250 дополнительных одновременных сеансов: значение 1 устанавливает количество одновременных сеансов на 250; 2 устанавливает значение в 500 и т.д.

Tags -> (список)

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

(структура)

Создаёт пару ключ-значение для определённого ресурса. Теги — это метаданные, которые можно использовать для поиска и группировки ресурса в различных целях. Вы можете применять теги к серверам, пользователям и ролям. Ключ тега может принимать более одного значения. Например, чтобы сгруппировать серверы в бухгалтерских целях, вы можете создать тег под названием Group и назначить ему значения Research и Accounting для этой группы.

Key -> (строка)

Имя, назначенное созданному тегу.

Value -> (строка)

Содержит одно или несколько значений, которые вы назначили созданному имени ключа.

WebAppEndpointPolicy -> (строка)

Параметр типа политики конечной точки для веб-приложения. Значение по умолчанию — STANDARD.

Если ваше веб-приложение было создано в регионе Amazon Web Services GovCloud (US), значение этого параметра может быть FIPS, что указывает на то, что конечная точка веб-приложения соответствует требованиям FIPS.

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

Spec-Zone.ru

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