put-metric-stream

Описание

Создаёт или обновляет поток метрик. Потоки метрик могут автоматически передавать метрики CloudWatch в пункты назначения Amazon Web Services, включая Amazon S3, и во многие сторонние решения.

Дополнительную информацию см. в разделе Использование потоков метрик.

Для создания потока метрик необходимо войти в учётную запись, у которой есть разрешение iam:PassRole, и либо политика CloudWatchFullAccess, либо разрешение cloudwatch:PutMetricStream.

При создании или обновлении потока метрик выбирается один из следующих вариантов:

• Передача метрик из всех пространств имён метрик в учётной записи.
• Передача метрик из всех пространств имён метрик в учётной записи, за исключением пространств имён, перечисленных в ExcludeFilters.
• Передача метрик только из пространств имён метрик, перечисленных в IncludeFilters.

По умолчанию поток метрик всегда отправляет статистики MAX, MIN, SUM и SAMPLECOUNT для каждой передаваемой метрики. Можно использовать параметр StatisticsConfigurations, чтобы поток метрик отправлял дополнительные статистики в потоке. Передача дополнительных статистик влечёт дополнительные расходы. Дополнительную информацию см. в разделе Цены на Amazon CloudWatch.

При использовании PutMetricStream для создания нового потока метрик поток создаётся в состоянии running. Если используется для обновления существующего потока, состояние потока не изменяется.

Если используется межсчётная наблюдаемость CloudWatch и поток метрик создаётся в учётной записи мониторинга, можно выбрать, включать ли метрики из исходных учётных записей в поток. Дополнительную информацию см. в разделе Межсчётная наблюдаемость CloudWatch.

См. также: AWS API Documentation

Синтаксис

  put-metric-stream
--name <value>
[--include-filters <value>]
[--exclude-filters <value>]
--firehose-arn <value>
--role-arn <value>
--output-format <value>
[--tags <value>]
[--statistics-configurations <value>]
[--include-linked-accounts-metrics | --no-include-linked-accounts-metrics]
[--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]

Параметры

--name (строка)

--include-filters (список)

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

Namespace=string,MetricNames=string,string ...

JSON-синтаксис:

[
  {
    "Namespace": "string",
    "MetricNames": ["string", ...]
  }
  ...
]

--exclude-filters (список)

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

Namespace=string,MetricNames=string,string ...

JSON-синтаксис:

[
  {
    "Namespace": "string",
    "MetricNames": ["string", ...]
  }
  ...
]

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

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

--output-format (строка)

--tags (список)

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

Key=string,Value=string ...

JSON-синтаксис:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--statistics-configurations (список)

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

IncludeMetrics=[{Namespace=string,MetricName=string},{Namespace=string,MetricName=string}],AdditionalStatistics=string,string ...

JSON-синтаксис:

[
  {
    "IncludeMetrics": [
      {
        "Namespace": "string",
        "MetricName": "string"
      }
      ...
    ],
    "AdditionalStatistics": ["string", ...]
  }
  ...
]

--include-linked-accounts-metrics | --no-include-linked-accounts-metrics (булево)

--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 (boolean)

Включить отладовую запись журнала.

--endpoint-url (string)

Переопределить стандартный URL команды заданным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого подключения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет стандартное поведение проверки сертификатов SSL.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команды.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определённый профиль из файла учетных данных.

--region (string)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/отключить цветной вывод.

• on
• off
• auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (string)

Файл с сертификатами CA для проверки сертификатов SSL. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения к сокету в секундах. Если значение установлено в 0, подключение к сокету будет выполняться блокирующим образом без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для бинарных блоков. По умолчанию используется формат 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 (boolean)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Примеры

Для создания потока метрик

Следующий put-metric-stream пример создаёт поток метрик с именем QuickFull-GuaFb в указанном аккаунте.

aws cloudwatch put-metric-stream \
    --name QuickFull-GuaFbs \
    --firehose-arn arn:aws:firehose:us-east-1:123456789012:deliverystream/MetricStreams-QuickFull-GuaFbs-WnySbECG \
    --role-arn arn:aws:iam::123456789012:role/service-role/MetricStreams-FirehosePutRecords-JN10W9B3 \
    --output-format json \
    --no-include-linked-accounts-metrics

Вывод:

{
    "Arn": "arn:aws:cloudwatch:us-east-1:123456789012:metric-stream/QuickFull-GuaFbs"
}

Дополнительную информацию см. в разделе Настройка потока метрик в руководстве пользователя Amazon CloudWatch.

Вывод

Arn -> (строка)