Spec-Zone.ru › AWS CLI v2

[ aws . lookoutmetrics ]

создать-сигнал

Описание

Создаёт сигнал об аномалии для детектора аномалий.

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

Синтаксис

  create-alert
--alert-name <value>
[--alert-sensitivity-threshold <value>]
[--alert-description <value>]
--anomaly-detector-arn <value>
--action <value>
[--tags <value>]
[--alert-filters <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-name (строка)

Имя сигнала.

--alert-sensitivity-threshold (целое число)

Целое число от 0 до 100, определяющее порог чувствительности сигнала.

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

Описание сигнала.

--anomaly-detector-arn (строка)

ARN детектора, к которому прикреплён сигнал.

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

Сокращенный синтаксис:

SNSConfiguration={RoleArn=string,SnsTopicArn=string,SnsFormat=string},LambdaConfiguration={RoleArn=string,LambdaArn=string}

Синтаксис JSON:

{
  "SNSConfiguration": {
    "RoleArn": "string",
    "SnsTopicArn": "string",
    "SnsFormat": "LONG_TEXT"|"SHORT_TEXT"|"JSON"
  },
  "LambdaConfiguration": {
    "RoleArn": "string",
    "LambdaArn": "string"
  }
}

--tags (массив)

Список тегов для применения к сигналу.

ключ -> (строка)

значение -> (строка)

Сокращенный синтаксис:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--alert-filters (структура)

Конфигурация фильтров сигнала, содержащая MetricList и DimensionFilterList.

MetricList -> (список)

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

(строка)

DimensionFilterList -> (список)

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

(структура)

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

DimensionName -> (строка)

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

DimensionValueList -> (список)

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

(строка)

Синтаксис JSON:

{
  "MetricList": ["string", ...],
  "DimensionFilterList": [
    {
      "DimensionName": "string",
      "DimensionValueList": ["string", ...]
    }
    ...
  ]
}

--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
  • текст
  • таблица
  • 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.

Вывод

AlertArn -> (строка)

ARN сигнала.

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

Spec-Zone.ru

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