Class: Aws::XRay::Types::GetTraceSummariesRequest

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

Overview

Note:

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

{
  start_time: Time.now, # required
  end_time: Time.now, # required
  time_range_type: "TraceId", # accepts TraceId, Event
  sampling: false,
  sampling_strategy: {
    name: "PartialScan", # accepts PartialScan, FixedRate
    value: 1.0,
  },
  filter_expression: "FilterExpression",
  next_token: "String",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#end_time ⇒ Time

The end of the time frame for which to retrieve traces.

Returns:

  • (Time) 


1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
 
# File 'lib/aws-sdk-xray/types.rb', line 1069

class GetTraceSummariesRequest < Struct.new(
  :start_time,
  :end_time,
  :time_range_type,
  :sampling,
  :sampling_strategy,
  :filter_expression,
  :next_token)
  include Aws::Structure
end

#filter_expression ⇒ String

Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements.

Returns:

  • (String) 


1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
 
# File 'lib/aws-sdk-xray/types.rb', line 1069

class GetTraceSummariesRequest < Struct.new(
  :start_time,
  :end_time,
  :time_range_type,
  :sampling,
  :sampling_strategy,
  :filter_expression,
  :next_token)
  include Aws::Structure
end

#next_token ⇒ String

Specify the pagination token returned by a previous request to retrieve the next page of results.

Returns:

  • (String) 


1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
 
# File 'lib/aws-sdk-xray/types.rb', line 1069

class GetTraceSummariesRequest < Struct.new(
  :start_time,
  :end_time,
  :time_range_type,
  :sampling,
  :sampling_strategy,
  :filter_expression,
  :next_token)
  include Aws::Structure
end

#sampling ⇒ Boolean

Set to ‘true` to get summaries for only a subset of available traces.

Returns:

  • (Boolean) 


1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
 
# File 'lib/aws-sdk-xray/types.rb', line 1069

class GetTraceSummariesRequest < Struct.new(
  :start_time,
  :end_time,
  :time_range_type,
  :sampling,
  :sampling_strategy,
  :filter_expression,
  :next_token)
  include Aws::Structure
end

#sampling_strategy ⇒ Types::SamplingStrategy

A paramater to indicate whether to enable sampling on trace summaries. Input parameters are Name and Value.

Returns:



1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
 
# File 'lib/aws-sdk-xray/types.rb', line 1069

class GetTraceSummariesRequest < Struct.new(
  :start_time,
  :end_time,
  :time_range_type,
  :sampling,
  :sampling_strategy,
  :filter_expression,
  :next_token)
  include Aws::Structure
end

#start_time ⇒ Time

The start of the time frame for which to retrieve traces.

Returns:

  • (Time) 


1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
 
# File 'lib/aws-sdk-xray/types.rb', line 1069

class GetTraceSummariesRequest < Struct.new(
  :start_time,
  :end_time,
  :time_range_type,
  :sampling,
  :sampling_strategy,
  :filter_expression,
  :next_token)
  include Aws::Structure
end

#time_range_type ⇒ String

A parameter to indicate whether to query trace summaries by TraceId or Event time.

Returns:

  • (String) 


1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
 
# File 'lib/aws-sdk-xray/types.rb', line 1069

class GetTraceSummariesRequest < Struct.new(
  :start_time,
  :end_time,
  :time_range_type,
  :sampling,
  :sampling_strategy,
  :filter_expression,
  :next_token)
  include Aws::Structure
end