Class: Aws::CloudTrail::Types::LookupEventsRequest

Inherits:

Struct

• Object
• Struct
• Aws::CloudTrail::Types::LookupEventsRequest

Defined in:

gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb

Overview

Contains a request for LookupEvents.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

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

Returns:

• (Time)

# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 3688

class LookupEventsRequest < Struct.new(
  :lookup_attributes,
  :start_time,
  :end_time,
  :event_category,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (String)

# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 3688

class LookupEventsRequest < Struct.new(
  :lookup_attributes,
  :start_time,
  :end_time,
  :event_category,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#lookup_attributes ⇒ Array<Types::LookupAttribute>

Contains a list of lookup attributes. Currently the list can contain only one item.

Returns:

• (Array<Types::LookupAttribute>)

# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 3688

class LookupEventsRequest < Struct.new(
  :lookup_attributes,
  :start_time,
  :end_time,
  :event_category,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The number of events to return. Possible values are 1 through 50. The default is 50.

Returns:

• (Integer)

# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 3688

class LookupEventsRequest < Struct.new(
  :lookup_attributes,
  :start_time,
  :end_time,
  :event_category,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (String)

# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 3688

class LookupEventsRequest < Struct.new(
  :lookup_attributes,
  :start_time,
  :end_time,
  :event_category,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (Time)

# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 3688

class LookupEventsRequest < Struct.new(
  :lookup_attributes,
  :start_time,
  :end_time,
  :event_category,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end