You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::CloudTrail::Types::LookupEventsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudTrail::Types::LookupEventsRequest
- Defined in:
- (unknown)
Overview
When passing LookupEventsRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
lookup_attributes: [
{
attribute_key: "EventId", # required, accepts EventId, EventName, ReadOnly, Username, ResourceType, ResourceName, EventSource, AccessKeyId
attribute_value: "String", # required
},
],
start_time: Time.now,
end_time: Time.now,
event_category: "insight", # accepts insight
max_results: 1,
next_token: "NextToken",
}
Contains a request for LookupEvents.
Instance Attribute Summary collapse
-
#end_time ⇒ Time
Specifies that only events that occur before or at the specified time are returned.
-
#event_category ⇒ String
Specifies the event category.
-
#lookup_attributes ⇒ Array<Types::LookupAttribute>
Contains a list of lookup attributes.
-
#max_results ⇒ Integer
The number of events to return.
-
#next_token ⇒ String
The token to use to get the next page of results after a previous API call.
-
#start_time ⇒ Time
Specifies that only events that occur after or at the specified time are returned.
Instance Attribute Details
#end_time ⇒ Time
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.
#event_category ⇒ String
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.
Possible values:
- insight
#lookup_attributes ⇒ Array<Types::LookupAttribute>
Contains a list of lookup attributes. Currently the list can contain only one item.
#max_results ⇒ Integer
The number of events to return. Possible values are 1 through 50. The default is 50.
#next_token ⇒ String
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 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.
#start_time ⇒ Time
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.