[ aws . cloudtrail ]
put-insight-selectors
Описание
Позволяет включить журналирование событий Insights, указав селекторы Insights, которые вы хотите включить для существующей записи событий или хранилища данных событий. Вы также используете PutInsightSelectors, чтобы отключить журналирование событий Insights, передав пустой список типов Insights. Допустимые типы событий Insights — это ApiErrorRateInsight и ApiCallRateInsight.
Чтобы включить Insights в хранилище данных событий, необходимо указать ARN (или суффикс ID ARN) для источника хранилища данных событий (EventDataStore) и целевого хранилища данных событий (InsightsDestination). Источник хранилища данных событий регистрирует управляющие события и включает Insights. Целевое хранилище данных событий регистрирует события Insights на основе активности управляющих событий источника хранилища данных событий. Источник и целевое хранилища данных событий должны принадлежать одному и тому же аккаунту Amazon Web Services.
Чтобы регистрировать события Insights для записи событий, вы должны указать имя (TrailName) записи событий CloudTrail, для которой вы хотите изменить или добавить селекторы Insights.
Чтобы регистрировать события CloudTrail Insights по объёму вызовов API, запись событий или хранилище данных событий должны регистрировать write управляющие события. Чтобы регистрировать события CloudTrail Insights по частоте ошибок API, запись событий или хранилище данных событий должны регистрировать read или write управляющие события. Вы можете вызвать GetEventSelectors для записи событий, чтобы проверить, регистрирует ли запись событий управляющие события. Вы можете вызвать GetEventDataStore для хранилища данных событий, чтобы проверить, регистрирует ли хранилище данных событий управляющие события.
Дополнительную информацию см. в разделе Работа с CloudTrail Insights в Руководстве пользователя CloudTrail.
См. также: Документация AWS API
Синтаксис
put-insight-selectors
[--trail-name <value>]
--insight-selectors <value>
[--event-data-store <value>]
[--insights-destination <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]
Параметры
--trail-name (строка)
Имя записи событий CloudTrail, для которой вы хотите изменить или добавить селекторы Insights.
Вы не можете использовать этот параметр вместе с параметрами EventDataStore и InsightsDestination.
--insight-selectors (список)
Строка JSON, содержащая типы Insights, которые вы хотите регистрировать в записи событий или хранилище данных событий. ApiCallRateInsight и ApiErrorRateInsight являются допустимыми типами Insights.
Тип Insights ApiCallRateInsight анализирует только управляющие API-вызовы, которые агрегируются каждую минуту относительно базового объема вызовов API.
Тип Insights ApiErrorRateInsight анализирует управляющие API-вызовы, которые приводят к ошибкам. Ошибка отображается, если вызов API неуспешен.
(структура)
Строка JSON, содержащая список типов Insights, которые регистрируются в записи событий или хранилище данных событий.
InsightType -> (строка)
Тип событий Insights, которые следует регистрировать в записи событий или хранилище данных событий. ApiCallRateInsight и ApiErrorRateInsight являются допустимыми типами Insights.
Тип Insights ApiCallRateInsight анализирует только управляющие API-вызовы, которые агрегируются каждую минуту относительно базового объема вызовов API.
Тип Insights ApiErrorRateInsight анализирует управляющие API-вызовы, которые приводят к ошибкам. Ошибка отображается, если вызов API неуспешен.
Сокращенный синтаксис:
InsightType=string ...
Синтаксис JSON:
[
{
"InsightType": "ApiCallRateInsight"|"ApiErrorRateInsight"
}
...
]
--event-data-store (строка)
ARN (или суффикс ID ARN) исходного хранилища данных событий, для которого вы хотите изменить или добавить селекторы Insights. Чтобы включить Insights в хранилище данных событий, необходимо указать оба параметра EventDataStore и InsightsDestination.
Вы не можете использовать этот параметр вместе с параметром TrailName.
--insights-destination (строка)
ARN (или суффикс ID ARN) целевого хранилища данных событий, которое регистрирует события Insights. Чтобы включить Insights в хранилище данных событий, необходимо указать оба параметра EventDataStore и InsightsDestination.
Вы не можете использовать этот параметр вместе с параметром TrailName.
--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.
Вывод
TrailARN -> (строка)
InsightSelectors -> (список)
Строка JSON, содержащая типы событий Insights, которые вы хотите регистрировать в записи событий или хранилище данных событий. Допустимые типы Insights — это ApiErrorRateInsight и ApiCallRateInsight.
(структура)
Строка JSON, содержащая список типов Insights, которые регистрируются в записи событий или хранилище данных событий.
InsightType -> (строка)
Тип событий Insights, которые следует регистрировать в записи событий или хранилище данных событий. ApiCallRateInsight и ApiErrorRateInsight являются допустимыми типами Insights.
Тип Insights ApiCallRateInsight анализирует только управляющие API-вызовы, которые агрегируются каждую минуту относительно базового объема вызовов API.
Тип Insights ApiErrorRateInsight анализирует управляющие API-вызовы, которые приводят к ошибкам. Ошибка отображается, если вызов API неуспешен.
EventDataStoreArn -> (строка)
InsightsDestination -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|