Spec-Zone.ru › AWS CLI v2

[ aws . cloudtrail ]

lookup-events

Описание

Ищет события управления или события CloudTrail Insights, которые захватываются CloudTrail. Вы можете искать события, произошедшие в Регионе в течение последних 90 дней.

Примечание

LookupEvents возвращает последние события Insights для трейлов, которые включают Insights. Чтобы просмотреть события Insights для хранилища данных событий, вы можете запускать запросы к вашему хранилищу данных событий Insights, а также просматривать панель Lake для Insights.

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

  • Ключ доступа к Amazon Web Services
  • Идентификатор события
  • Имя события
  • Источник события
  • Только для чтения
  • Имя ресурса
  • Тип ресурса
  • Имя пользователя

Поиск поддерживает следующие атрибуты для событий Insights:

  • Идентификатор события
  • Имя события
  • Источник события

Все атрибуты являются необязательными. По умолчанию возвращается 50 результатов, с максимальным значением 50. Ответ включает маркер, который вы можете использовать для получения следующей страницы результатов.

Предупреждение

Скорость запросов поиска ограничена двумя в секунду на учетную запись, на Регион. Если этот предел превышен, возникает ошибка ограничений.

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

lookup-events является постраничной операцией. Для получения всего набора результатов могут быть выпущены несколько API-вызовов. Вы можете отключить постраничную обработку, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной обработкой, аргумент --query должен извлечь данные из результатов следующих выражений запроса: Events

Синтаксис

  lookup-events
[--lookup-attributes <value>]
[--start-time <value>]
[--end-time <value>]
[--event-category <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

--lookup-attributes (список)

Содержит список атрибутов поиска. В настоящее время список может содержать только один элемент.

(структура)

Указывает атрибут и значение, которые фильтруют возвращаемые события.

AttributeKey -> (строка)

Указывает атрибут, по которому фильтровать возвращаемые события.

AttributeValue -> (строка)

Указывает значение для указанного AttributeKey .

Максимальная длина AttributeValue составляет 2000 символов. Следующие символы (’_ ‘, ‘```` ‘, ‘, ‘, ‘\\n ‘) учитываются как два символа в пределе 2000 символов.

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

AttributeKey=string,AttributeValue=string ...

Синтаксис JSON:

[
  {
    "AttributeKey": "EventId"|"EventName"|"ReadOnly"|"Username"|"ResourceType"|"ResourceName"|"EventSource"|"AccessKeyId",
    "AttributeValue": "string"
  }
  ...
]

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

Указывает, что возвращаются только события, которые происходят после или в указанное время. Если указанное начальное время позже указанного конечного времени, возвращается ошибка.

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

Указывает, что возвращаются только события, которые происходят до или в указанное время. Если указанное конечное время раньше указанного начального времени, возвращается ошибка.

--event-category (строка)

Указывает категорию события. Если вы не укажете категорию события, события этой категории не будут возвращены в ответе. Например, если вы не укажете insight в качестве значения EventCategory, события Insights не будут возвращены.

Возможные значения:

  • insight

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного JSON-значения, так как строка будет принята буквально. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Маркер для указания места начала постраничной обработки. Это NextToken из ранее усеченного ответа.

Примеры использования см. в разделе Постраничная обработка в руководстве пользователя AWS CLI.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-службы. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-службы, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-службы.

Примеры использования см. в разделе Постраничная обработка в руководстве пользователя AWS CLI.

--max-items (целое число)

Общее количество элементов, которые нужно вернуть в выводе команды. Если общее количество доступных элементов больше указанного значения, предоставляется NextToken в выводе команды. Чтобы продолжить постраничную обработку, укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую за пределами AWS CLI.

Примеры использования см. в разделе Постраничная обработка в руководстве пользователя AWS CLI.

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

Примеры

Примечание

Для использования следующих примеров вам необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в руководстве пользователя AWS CLI.

Если не указано иное, все примеры имеют правила цитирования, характерные для систем Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной среды. Дополнительную информацию см. в разделе Использование кавычек со строками в руководстве пользователя AWS CLI.

Для поиска событий для трейла

Следующая команда lookup-events ищет события API-активности по атрибуту EventName:

aws cloudtrail lookup-events --lookup-attributes AttributeKey=EventName,AttributeValue=ConsoleLogin

Вывод:

{
  "Events": [
     {
         "EventId": "654ccbc0-ba0d-486a-9076-dbf7274677a7",
         "Username": "my-session-name",
         "EventTime": "2021-11-18T09:41:02-08:00",
         "CloudTrailEvent": "{\"eventVersion\":\"1.02\",\"userIdentity\":{\"type\":\"AssumedRole\",\"principalId\":\"AROAJIKPFTA72SWU4L7T4:my-session-name\",\"arn\":\"arn:aws:sts::123456789012:assumed-role/my-role/my-session-name\",\"accountId\":\"123456789012\",\"sessionContext\":{\"attributes\":{\"mfaAuthenticated\":\"false\",\"creationDate\":\"2016-01-26T21:42:12Z\"},\"sessionIssuer\":{\"type\":\"Role\",\"principalId\":\"AROAJIKPFTA72SWU4L7T4\",\"arn\":\"arn:aws:iam::123456789012:role/my-role\",\"accountId\":\"123456789012\",\"userName\":\"my-role\"}}},\"eventTime\":\"2016-01-26T21:42:12Z\",\"eventSource\":\"signin.amazonaws.com\",\"eventName\":\"ConsoleLogin\",\"awsRegion\":\"us-east-1\",\"sourceIPAddress\":\"72.21.198.70\",\"userAgent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.111 Safari/537.36\",\"requestParameters\":null,\"responseElements\":{\"ConsoleLogin\":\"Success\"},\"additionalEventData\":{\"MobileVersion\":\"No\",\"MFAUsed\":\"No\"},\"eventID\":\"654ccbc0-ba0d-486a-9076-dbf7274677a7\",\"eventType\":\"AwsConsoleSignIn\",\"recipientAccountId\":\"123456789012\"}",
         "EventName": "ConsoleLogin",
         "Resources": []
     }
  ]
}

Вывод

События -> (список)

Список событий, возвращённых на основе атрибутов поиска и события CloudTrail. Список событий отсортирован по времени. Наиболее недавнее событие указано в начале списка.

(структура)

Содержит информацию о событии, возвращённом в результате запроса поиска. Результат включает представление события CloudTrail.

EventId -> (строка)

Идентификатор события CloudTrail, возвращённого в результате.

EventName -> (строка)

Название возвращённого события.

ReadOnly -> (строка)

Информация о том, является ли событие событием записи или чтения.

AccessKeyId -> (строка)

Идентификатор ключа доступа Amazon Web Services, используемый для подписания запроса. Если запрос был сделан с временными учетными данными безопасности, это идентификатор ключа доступа временных учетных данных.

EventTime -> (отметка времени)

Дата и время возвращённого события.

EventSource -> (строка)

Услуга Amazon Web Services, к которой был обращён запрос.

Username -> (строка)

Имя пользователя или имя роли запросителя, вызвавшего API в возвращённом событии.

Resources -> (список)

Список ресурсов, на которые ссылается возвращённое событие.

(структура)

Определяет тип и имя ресурса, на который ссылается событие.

ResourceType -> (строка)

Тип ресурса, на который ссылается возвращённое событие. Если тип ресурса определить невозможно, возвращается null. Некоторые примеры типов ресурсов: Instance для EC2, Trail для CloudTrail, DBInstance для Amazon RDS и AccessKey для IAM. Чтобы узнать больше о поиске и фильтрации событий по типам ресурсов, поддерживаемым службой, см. статью Фильтрация событий CloudTrail.

ResourceName -> (строка)

Имя ресурса, на который ссылается возвращённое событие. Это имена, создаваемые пользователем, значения которых зависят от среды. Например, имя ресурса может быть «auto-scaling-test-group» для группы автоматического масштабирования или «i-1234567» для экземпляра EC2.

CloudTrailEvent -> (строка)

Строка JSON, содержащая представление возвращённого события.

NextToken -> (строка)

Маркер для получения следующей страницы результатов после предыдущего вызова API. Если маркер не появляется, больше результатов нет. Маркер должен передаваться с теми же параметрами, что и предыдущий вызов. Например, если в исходном вызове был указан AttributeKey «Username» со значением «root», в вызове с NextToken должны быть указаны те же параметры.

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

Spec-Zone.ru

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