[ aws . resiliencehub ]
describe-app
Описание
Описывает приложение Resilience Hub.
См. также: Документацию API AWS
Синтаксис
describe-app
--app-arn <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-arn (строка)
partition :resiliencehub:region :account :app/app-id . Дополнительную информацию об ARN см. в руководстве Amazon Web Services General Reference (Имена ресурсов Amazon (ARN)).--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
- таблица
- 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.
Вывод
app -> (структура)
Указанное приложение, возвращаемое в виде объекта с деталями, включая состояние соответствия, время создания, описание, рейтинг устойчивости и многое другое.
appArn -> (строка)
partition :resiliencehub:region :account :app/app-id . Дополнительную информацию об ARN см. в руководстве Amazon Web Services General Reference (Имена ресурсов Amazon (ARN)).assessmentSchedule -> (строка)
awsApplicationArn -> (строка)
complianceStatus -> (строка)
creationTime -> (метка времени)
description -> (строка)
driftStatus -> (строка)
eventSubscriptions -> (список)
Список событий, на которые вы хотите подписаться и получать уведомления. В настоящее время Resilience Hub поддерживает уведомления только для событий Обнаружено отклонение и Неудачная запланированная оценка.
(структура)
Указывает событие, на которое вы хотите подписаться и получать уведомления. В настоящее время Resilience Hub поддерживает уведомления только для событий Обнаружено отклонение (DriftDetected ) и Неудачная запланированная оценка (ScheduledAssessmentFailure ).
eventType -> (строка)
DriftDetected ) и Неудачная запланированная оценка (ScheduledAssessmentFailure ).name -> (строка)
snsTopicArn -> (строка)
arn:partition:sns:region:account:topic-name . Дополнительную информацию об ARN см. в руководстве Amazon Web Services General Reference (Имена ресурсов Amazon (ARN)).lastAppComplianceEvaluationTime -> (метка времени)
lastDriftEvaluationTime -> (метка времени)
lastResiliencyScoreEvaluationTime -> (метка времени)
name -> (строка)
permissionModel -> (структура)
Определяет роли и учетные данные, которые Resilience Hub будет использовать при создании приложения, импорте его ресурсов и проведении оценки.
crossAccountRoleArns -> (список)
Определяет список имен ресурсов Amazon (ARN) ролей, которые будут использоваться в других учетных записях. Эти ARN используются для запросов при импорте ресурсов и оценке вашего приложения.
Примечание
- Эти ARN необходимы только тогда, когда ваши ресурсы находятся в других учетных записях, и у вас есть другое имя роли в этих учетных записях. В противном случае имя роли вызывающего будет использоваться в других учетных записях.
- Эти роли должны иметь политику доверия с
iam:AssumeRoleразрешением на роль вызывающего в основной учетной записи.
(строка)
invokerRoleName -> (строка)
Существующее имя роли AWS IAM в основной учетной записи AWS, которое будет принято принципом обслуживания Resilience Hub для получения только для чтения доступа к ресурсам вашего приложения при выполнении оценки.
Если ваша роль IAM включает путь, вы должны включить путь в параметр invokerRoleName. Например, если ARN вашей роли IAM — arn:aws:iam:123456789012:role/my-path/role-name, вы должны передать my-path/role-name .
Примечание
- Вы должны иметь
iam:passRoleразрешение для этой роли при создании или обновлении приложения. - В настоящее время
invokerRoleNameпринимает только[A-Za-z0-9_+=,.@-]символов.
type -> (строка)
policyArn -> (строка)
partition :resiliencehub:region :account :resiliency-policy/policy-id . Дополнительную информацию об ARN см. в руководстве Amazon Web Services General Reference (Имена ресурсов Amazon (ARN)).resiliencyScore -> (двойное значение)
rpoInSecs -> (целое число)
rtoInSecs -> (целое число)
status -> (строка)
tags -> (массив)
Теги, назначенные ресурсу. Тег — это метка, которую вы назначаете ресурсу AWS. Каждый тег состоит из пары ключ/значение.
key -> (строка)
value -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|