Spec-Zone.ru › AWS CLI v2

[ aws . cloudtrail ]

get-insight-selectors

Описание

Описывает настройки селекторов событий Insights, которые вы настроили для вашего трейла или хранилища событий. GetInsightSelectors показывает, включено ли ведение журнала событий CloudTrail Insights в трейле или хранилище событий, и если да, то какие типы Insights включены. Если вы выполняете GetInsightSelectors для трейла или хранилища событий, для которых не включены события Insights, операция вызывает исключение InsightNotEnabledException

Укажите параметр EventDataStore, чтобы получить селекторы событий Insights для хранилища событий, или параметр TrailName, чтобы получить селекторы событий Insights для трейла. Эти параметры нельзя указывать вместе.

Дополнительную информацию см. в разделе Работа с CloudTrail Insights в руководстве пользователя CloudTrail .

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

Синтаксис

  get-insight-selectors
[--trail-name <value>]
[--event-data-store <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 (строка)

Указывает имя трейла или ARN трейла. Если вы указываете имя трейла, строка должна соответствовать следующим требованиям:

  • Содержать только буквы ASCII (a-z, A-Z), цифры (0-9), точки (.), подчеркивания (_) или дефисы (-)
  • Начинаться с буквы или цифры и заканчиваться буквой или цифрой
  • Содержать от 3 до 128 символов
  • Не содержать смежных точек, подчеркиваний или дефисов. Имена, такие как my-_namespace и my--namespace, недопустимы.
  • Не быть в формате IP-адреса (например, 192.168.5.4)

Если вы указываете ARN трейла, он должен быть в формате:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

Этот параметр нельзя использовать с параметром EventDataStore.

--event-data-store (строка)

Указывает ARN (или суффикс ID ARN) хранилища событий, для которого необходимо получить селекторы Insights.

Этот параметр нельзя использовать с параметром 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
  • текст
  • таблица
  • 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.

Вывод

TrailARN -> (строка)

Amazon Resource Name (ARN) трейла, для которого необходимо получить селекторы Insights.

InsightSelectors -> (список)

JSON-строка, содержащая типы Insights, которые требуется регистрировать в трейле или хранилище событий. ApiErrorRateInsight и ApiCallRateInsight поддерживаются в качестве типов Insights.

(структура)

JSON-строка, содержащая список типов Insights, регистрируемых в трейле или хранилище событий.

InsightType -> (строка)

Тип событий Insights, которые необходимо регистрировать в трейле или хранилище событий. ApiCallRateInsight и ApiErrorRateInsight являются допустимыми типами Insights.

Тип Insights ApiCallRateInsight анализирует вызовы управляющих API только для записи, которые агрегируются каждую минуту по отношению к базовому объему вызовов API.

Тип Insights ApiErrorRateInsight анализирует управляющие вызовы API, которые приводят к ошибкам кодов. Ошибка отображается, если вызов API завершился неудачно.

EventDataStoreArn -> (строка)

ARN исходного хранилища событий, для которого включены события Insights.

InsightsDestination -> (строка)

ARN целевого хранилища событий, в котором регистрируются события Insights.

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

Spec-Zone.ru

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