Class: Aws::InternetMonitor::Types::StartQueryInput

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#end_time ⇒ Time

The timestamp that is the end of the period that you want to retrieve data for with your query.

Returns:

  • (Time) 


1500
1501
1502
1503
1504
1505
1506
1507
1508
 
# File 'gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/types.rb', line 1500

class StartQueryInput < Struct.new(
  :monitor_name,
  :start_time,
  :end_time,
  :query_type,
  :filter_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#filter_parameters ⇒ Array<Types::FilterParameter>

The FilterParameters field that you use with Amazon CloudWatch Internet Monitor queries is a string the defines how you want a query to be filtered. The filter parameters that you can specify depend on the query type, since each query type returns a different set of Internet Monitor data.

For more information about specifying filter parameters, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.

Returns:



1500
1501
1502
1503
1504
1505
1506
1507
1508
 
# File 'gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/types.rb', line 1500

class StartQueryInput < Struct.new(
  :monitor_name,
  :start_time,
  :end_time,
  :query_type,
  :filter_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#monitor_name ⇒ String

The name of the monitor to query.

Returns:

  • (String) 


1500
1501
1502
1503
1504
1505
1506
1507
1508
 
# File 'gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/types.rb', line 1500

class StartQueryInput < Struct.new(
  :monitor_name,
  :start_time,
  :end_time,
  :query_type,
  :filter_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#query_type ⇒ String

The type of query to run. The following are the three types of queries that you can run using the Internet Monitor query interface:

  • MEASUREMENTS: TBD definition

  • TOP_LOCATIONS: TBD definition

  • TOP_LOCATION_DETAILS: TBD definition

For lists of the fields returned with each query type and more information about how each type of query is performed, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.

Returns:

  • (String) 


1500
1501
1502
1503
1504
1505
1506
1507
1508
 
# File 'gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/types.rb', line 1500

class StartQueryInput < Struct.new(
  :monitor_name,
  :start_time,
  :end_time,
  :query_type,
  :filter_parameters)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The timestamp that is the beginning of the period that you want to retrieve data for with your query.

Returns:

  • (Time) 


1500
1501
1502
1503
1504
1505
1506
1507
1508
 
# File 'gems/aws-sdk-internetmonitor/lib/aws-sdk-internetmonitor/types.rb', line 1500

class StartQueryInput < Struct.new(
  :monitor_name,
  :start_time,
  :end_time,
  :query_type,
  :filter_parameters)
  SENSITIVE = []
  include Aws::Structure
end