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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-xray/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",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#end_timeTime

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

Returns:

  • (Time)


1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1122

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

#filter_expressionString

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

Returns:

  • (String)


1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1122

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

#next_tokenString

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

Returns:

  • (String)


1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1122

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

#samplingBoolean

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

Returns:

  • (Boolean)


1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1122

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

#sampling_strategyTypes::SamplingStrategy

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



1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1122

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

#start_timeTime

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

Returns:

  • (Time)


1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1122

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

#time_range_typeString

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

Returns:

  • (String)


1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1122

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