Spec-Zone.ru › AWS CLI v2

[ aws . lookoutmetrics ]

describe-alert

Описание

Описывает оповещение.

Действия API Amazon Lookout for Metrics обладают свойством конечной согласованности. Если вы выполняете операцию чтения ресурса сразу после его создания или изменения, используйте повторные попытки, чтобы дать время для завершения операции записи.

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

Синтаксис

  describe-alert
--alert-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]

Параметры

--alert-arn (строка)

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
  • 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 версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, 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.

Вывод

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

Содержит информацию об оповещении.

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

Действие, которое будет выполнено при возникновении оповещения.

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

Настройка канала Amazon SNS.

RoleArn -> (строка)

ARN роли IAM, которая имеет доступ к целевой теме SNS.

SnsTopicArn -> (строка)

ARN целевой темы SNS.

SnsFormat -> (строка)

Формат темы SNS.

  • JSON – Отправка оповещений JSON с идентификатором аномалии и ссылкой на страницу подробностей аномалии. Это значение по умолчанию.
  • LONG_TEXT – Отправка удобочитаемых оповещений с информацией о затронутых временных рядах и ссылкой на страницу подробностей аномалии. Рекомендуется для электронной почты.
  • SHORT_TEXT – Отправка удобочитаемых оповещений со ссылкой на страницу подробностей аномалии. Рекомендуется для SMS.

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

Настройка канала AWS Lambda.

RoleArn -> (строка)

ARN роли IAM, имеющей разрешение на вызов функции Lambda.

LambdaArn -> (строка)

ARN функции Lambda.

AlertDescription -> (строка)

Описание оповещения.

AlertArn -> (строка)

ARN оповещения.

AnomalyDetectorArn -> (строка)

ARN детектора, к которому прикреплено оповещение.

AlertName -> (строка)

Имя оповещения.

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

Минимальный уровень серьезности аномалии для срабатывания оповещения.

AlertType -> (строка)

Тип оповещения.

AlertStatus -> (строка)

Статус оповещения.

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

Время последнего изменения оповещения.

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

Время создания оповещения.

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

Настройка фильтров оповещения, содержащая MetricList и DimensionFilter.

MetricList -> (список)

Список метрик, для которых требуется получать оповещения.

(строка)

DimensionFilterList -> (список)

Список объектов DimensionFilter, используемых для фильтрации по измерениям.

(структура)

Фильтр измерения, содержащий DimensionName и DimensionValueList.

DimensionName -> (строка)

Имя измерения для фильтрации.

DimensionValueList -> (список)

Список значений для измерения, указанного в DimensionName, для фильтрации.

(строка)

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

Spec-Zone.ru

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