Class: Aws::CloudTrail::Types::ListQueriesRequest

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

Overview

Note:

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

{
  event_data_store: "EventDataStoreArn", # required
  next_token: "PaginationToken",
  max_results: 1,
  start_time: Time.now,
  end_time: Time.now,
  query_status: "QUEUED", # accepts QUEUED, RUNNING, FINISHED, FAILED, CANCELLED, TIMED_OUT
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#end_timeTime

Use with `StartTime` to bound a `ListQueries` request, and limit its results to only those queries run within a specified time period.

Returns:

  • (Time)

2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
# File 'lib/aws-sdk-cloudtrail/types.rb', line 2852

class ListQueriesRequest < Struct.new(
  :event_data_store,
  :next_token,
  :max_results,
  :start_time,
  :end_time,
  :query_status)
  SENSITIVE = []
  include Aws::Structure
end

#event_data_storeString

The ARN (or the ID suffix of the ARN) of an event data store on which queries were run.

Returns:

  • (String)

2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
# File 'lib/aws-sdk-cloudtrail/types.rb', line 2852

class ListQueriesRequest < Struct.new(
  :event_data_store,
  :next_token,
  :max_results,
  :start_time,
  :end_time,
  :query_status)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of queries to show on a page.

Returns:

  • (Integer)

2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
# File 'lib/aws-sdk-cloudtrail/types.rb', line 2852

class ListQueriesRequest < Struct.new(
  :event_data_store,
  :next_token,
  :max_results,
  :start_time,
  :end_time,
  :query_status)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

A token you can use to get the next page of results.

Returns:

  • (String)

2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
# File 'lib/aws-sdk-cloudtrail/types.rb', line 2852

class ListQueriesRequest < Struct.new(
  :event_data_store,
  :next_token,
  :max_results,
  :start_time,
  :end_time,
  :query_status)
  SENSITIVE = []
  include Aws::Structure
end

#query_statusString

The status of queries that you want to return in results. Valid values for `QueryStatus` include `QUEUED`, `RUNNING`, `FINISHED`, `FAILED`, `TIMED_OUT`, or `CANCELLED`.

Returns:

  • (String)

2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
# File 'lib/aws-sdk-cloudtrail/types.rb', line 2852

class ListQueriesRequest < Struct.new(
  :event_data_store,
  :next_token,
  :max_results,
  :start_time,
  :end_time,
  :query_status)
  SENSITIVE = []
  include Aws::Structure
end

#start_timeTime

Use with `EndTime` to bound a `ListQueries` request, and limit its results to only those queries run within a specified time period.

Returns:

  • (Time)

2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
# File 'lib/aws-sdk-cloudtrail/types.rb', line 2852

class ListQueriesRequest < Struct.new(
  :event_data_store,
  :next_token,
  :max_results,
  :start_time,
  :end_time,
  :query_status)
  SENSITIVE = []
  include Aws::Structure
end