| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.CloudTrail.LookupEvents
Description
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. 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.
The rate of lookup requests is limited to two per second, per account, per region. If this limit is exceeded, a throttling error occurs.
This operation returns paginated results.
Synopsis
- data LookupEvents = LookupEvents' {}
- newLookupEvents :: LookupEvents
- lookupEvents_endTime :: Lens' LookupEvents (Maybe UTCTime)
- lookupEvents_eventCategory :: Lens' LookupEvents (Maybe EventCategory)
- lookupEvents_lookupAttributes :: Lens' LookupEvents (Maybe [LookupAttribute])
- lookupEvents_maxResults :: Lens' LookupEvents (Maybe Natural)
- lookupEvents_nextToken :: Lens' LookupEvents (Maybe Text)
- lookupEvents_startTime :: Lens' LookupEvents (Maybe UTCTime)
- data LookupEventsResponse = LookupEventsResponse' {}
- newLookupEventsResponse :: Int -> LookupEventsResponse
- lookupEventsResponse_events :: Lens' LookupEventsResponse (Maybe [Event])
- lookupEventsResponse_nextToken :: Lens' LookupEventsResponse (Maybe Text)
- lookupEventsResponse_httpStatus :: Lens' LookupEventsResponse Int
Creating a Request
data LookupEvents Source #
Contains a request for LookupEvents.
See: newLookupEvents smart constructor.
Constructors
| LookupEvents' | |
Fields
| |
Instances
newLookupEvents :: LookupEvents Source #
Create a value of LookupEvents with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endTime:LookupEvents', lookupEvents_endTime - 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.
$sel:eventCategory:LookupEvents', lookupEvents_eventCategory - 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.
$sel:lookupAttributes:LookupEvents', lookupEvents_lookupAttributes - Contains a list of lookup attributes. Currently the list can contain
only one item.
$sel:maxResults:LookupEvents', lookupEvents_maxResults - The number of events to return. Possible values are 1 through 50. The
default is 50.
LookupEvents, lookupEvents_nextToken - 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.
$sel:startTime:LookupEvents', lookupEvents_startTime - Specifies that only events that occur after or at the specified time are
returned. If the specified start time is after the specified end time,
an error is returned.
Request Lenses
lookupEvents_endTime :: Lens' LookupEvents (Maybe UTCTime) Source #
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.
lookupEvents_eventCategory :: Lens' LookupEvents (Maybe EventCategory) Source #
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.
lookupEvents_lookupAttributes :: Lens' LookupEvents (Maybe [LookupAttribute]) Source #
Contains a list of lookup attributes. Currently the list can contain only one item.
lookupEvents_maxResults :: Lens' LookupEvents (Maybe Natural) Source #
The number of events to return. Possible values are 1 through 50. The default is 50.
lookupEvents_nextToken :: Lens' LookupEvents (Maybe Text) Source #
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.
lookupEvents_startTime :: Lens' LookupEvents (Maybe UTCTime) Source #
Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned.
Destructuring the Response
data LookupEventsResponse Source #
Contains a response to a LookupEvents action.
See: newLookupEventsResponse smart constructor.
Constructors
| LookupEventsResponse' | |
Fields
| |
Instances
newLookupEventsResponse Source #
Arguments
| :: Int | |
| -> LookupEventsResponse |
Create a value of LookupEventsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:events:LookupEventsResponse', lookupEventsResponse_events - 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.
LookupEvents, lookupEventsResponse_nextToken - 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.
$sel:httpStatus:LookupEventsResponse', lookupEventsResponse_httpStatus - The response's http status code.
Response Lenses
lookupEventsResponse_events :: Lens' LookupEventsResponse (Maybe [Event]) Source #
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.
lookupEventsResponse_nextToken :: Lens' LookupEventsResponse (Maybe Text) Source #
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.
lookupEventsResponse_httpStatus :: Lens' LookupEventsResponse Int Source #
The response's http status code.