lookup_events¶
Operation¶
async
¶
lookup_events(input: LookupEventsInput, plugins: list[Plugin] | None = None) -> LookupEventsOutput
Looks up management events or CloudTrail Insights events that are captured by CloudTrail. You can look up events that occurred in a Region within the last 90 days.
Note
LookupEvents returns recent Insights events for trails that enable
Insights. To view Insights events for an event data store, you can run
queries on your Insights event data store, and you can also view the
Lake dashboard for Insights.
Lookup supports the following attributes for management events:
-
Amazon Web Services access key
-
Event ID
-
Event name
-
Event source
-
Read only
-
Resource name
-
Resource type
-
User name
Lookup supports the following attributes for Insights events:
-
Event ID
-
Event name
-
Event source
All attributes are optional. The default number of results returned is 50, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.
Warning
The rate of lookup requests is limited to two per second, per account, per Region. If this limit is exceeded, a throttling error occurs.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
LookupEventsInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
LookupEventsOutput
|
An instance of |
Input¶
dataclass
¶
Contains a request for LookupEvents.
Attributes¶
class-attribute
instance-attribute
¶
end_time: datetime | None = None
Specifies that only events that occur before or at the specified time are returned. If the specified end time is before the specified start time, an error is returned.
class-attribute
instance-attribute
¶
event_category: EventCategory | None = None
Specifies the event category. If you do not specify an event category,
events of the category are not returned in the response. For example, if
you do not specify insight as the value of EventCategory, no
Insights events are returned.
class-attribute
instance-attribute
¶
lookup_attributes: list[LookupAttribute] | None = None
Contains a list of lookup attributes. Currently the list can contain only one item.
class-attribute
instance-attribute
¶
max_results: int | None = None
The number of events to return. Possible values are 1 through 50. The default is 50.
class-attribute
instance-attribute
¶
next_token: str | None = None
The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.
Output¶
dataclass
¶
Contains a response to a LookupEvents action.
Attributes¶
class-attribute
instance-attribute
¶
A list of events returned based on the lookup attributes specified and the CloudTrail event. The events list is sorted by time. The most recent event is listed first.
class-attribute
instance-attribute
¶
next_token: str | None = None
The token to use to get the next page of results after a previous API call. If the token does not appear, there are no more results to return. The token must be passed in with the same parameters as the previous call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.