get-insight-rule-report

Описание

Эта операция возвращает временные ряды данных, собранные правилом Contributor Insights. Данные включают идентификатор и количество участников в группе журналов.

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

• UniqueContributors – количество уникальных участников для каждой точки данных.
• MaxContributorValue – значение ведущего участника для каждой точки данных. Идентификатор участника может меняться для каждой точки данных на графике. Если это правило агрегирует по COUNT, ведущий участник для каждой точки данных – участник с наибольшим количеством появлений в этом периоде. Если правило агрегирует по SUM, ведущий участник – участник с наибольшей суммой в поле журнала, указанном в правиле Value, в течение этого периода.
• SampleCount – количество точек данных, соответствующих правилу.
• Sum – сумма значений от всех участников в течение периода времени, представленного этой точкой данных.
• Minimum – минимальное значение из одной записи в течение периода времени, представленного этой точкой данных.
• Maximum – максимальное значение из одной записи в течение периода времени, представленного этой точкой данных.
• Average – среднее значение от всех участников в течение периода времени, представленного этой точкой данных.

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

Синтаксис

  get-insight-rule-report
--rule-name <value>
--start-time <value>
--end-time <value>
--period <value>
[--max-contributor-count <value>]
[--metrics <value>]
[--order-by <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]

Параметры

--rule-name (строка)

--start-time (метка времени)

--end-time (метка времени)

--period (целое число)

--max-contributor-count (целое число)

--metrics (список)

Синтаксис:

"string" "string" ...

--order-by (строка)

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

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Для получения временных рядов данных, собранных правилом Contributor Insights

Следующий пример get-insight-rule-report возвращает временные ряды данных, собранные правилом Contributor Insights.

aws cloudwatch get-insight-rule-report \
    --rule-name Rule-A \
    --start-time 2024-10-13T20:15:00Z \
    --end-time 2024-10-13T20:30:00Z \
    --period 300

Вывод:

{
    "KeyLabels": [
        "PartitionKey"
    ],
    "AggregationStatistic": "Sum",
    "AggregateValue": 0.5,
    "ApproximateUniqueCount": 1,
    "Contributors": [
        {
            "Keys": [
                "RequestID"
            ],
            "ApproximateAggregateValue": 0.5,
            "Datapoints": [
                {
                    "Timestamp": "2024-10-13T21:00:00+00:00",
                    "ApproximateValue": 0.5
                }
            ]
        }
    ],
    "RuleAttributes": []
}

Дополнительная информация: Использование Contributor Insights для анализа данных с высокой кардинальностью в Руководстве пользователя Amazon CloudWatch.

Вывод

KeyLabels -> (список)

AggregationStatistic -> (строка)

AggregateValue -> (двойное)

ApproximateUniqueCount -> (длинное)

Contributors -> (список)

MetricDatapoints -> (список)