You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb

Overview

Note:

When making an API call, you may pass LookupEventsRequest data as a hash:

{
  lookup_attributes: [
    {
      attribute_key: "EventId", # required, accepts EventId, EventName, Username, ResourceType, ResourceName, EventSource
      attribute_value: "String", # required
    },
  ],
  start_time: Time.now,
  end_time: Time.now,
  max_results: 1,
  next_token: "NextToken",
}

Contains a request for LookupEvents.

Instance Attribute Summary collapse

Instance Attribute Details

#end_timeTime

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)


932
933
934
935
936
937
938
939
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 932

class LookupEventsRequest < Struct.new(
  :lookup_attributes,
  :start_time,
  :end_time,
  :max_results,
  :next_token)
  include Aws::Structure
end

#lookup_attributesArray<Types::LookupAttribute>

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

Returns:



932
933
934
935
936
937
938
939
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 932

class LookupEventsRequest < Struct.new(
  :lookup_attributes,
  :start_time,
  :end_time,
  :max_results,
  :next_token)
  include Aws::Structure
end

#max_resultsInteger

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

Returns:

  • (Integer)


932
933
934
935
936
937
938
939
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 932

class LookupEventsRequest < Struct.new(
  :lookup_attributes,
  :start_time,
  :end_time,
  :max_results,
  :next_token)
  include Aws::Structure
end

#next_tokenString

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.

Returns:

  • (String)


932
933
934
935
936
937
938
939
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 932

class LookupEventsRequest < Struct.new(
  :lookup_attributes,
  :start_time,
  :end_time,
  :max_results,
  :next_token)
  include Aws::Structure
end

#start_timeTime

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)


932
933
934
935
936
937
938
939
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 932

class LookupEventsRequest < Struct.new(
  :lookup_attributes,
  :start_time,
  :end_time,
  :max_results,
  :next_token)
  include Aws::Structure
end