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

Inherits:

Struct

• Object
• Struct
• Aws::XRay::Types::GetTraceSummariesRequest

Includes:

Structure

Defined in:

lib/aws-sdk-xray/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #end_time ⇒ Time

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

• #filter_expression ⇒ String

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

• #next_token ⇒ String

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

• #sampling ⇒ Boolean

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

• #sampling_strategy ⇒ Types::SamplingStrategy

  A parameter to indicate whether to enable sampling on trace summaries.

• #start_time ⇒ Time

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

• #time_range_type ⇒ String

  A parameter to indicate whether to query trace summaries by TraceId, Event (trace update time), or Service (segment end time).

Instance Attribute Details

#end_time ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-xray/types.rb', line 1328

class GetTraceSummariesRequest < Struct.new(
  :start_time,
  :end_time,
  :time_range_type,
  :sampling,
  :sampling_strategy,
  :filter_expression,
  :next_token)
  SENSITIVE = []
  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)

# File 'lib/aws-sdk-xray/types.rb', line 1328

class GetTraceSummariesRequest < Struct.new(
  :start_time,
  :end_time,
  :time_range_type,
  :sampling,
  :sampling_strategy,
  :filter_expression,
  :next_token)
  SENSITIVE = []
  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)

# File 'lib/aws-sdk-xray/types.rb', line 1328

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

#sampling ⇒ Boolean

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-xray/types.rb', line 1328

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

#sampling_strategy ⇒ Types::SamplingStrategy

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

Returns:

• (Types::SamplingStrategy)

# File 'lib/aws-sdk-xray/types.rb', line 1328

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

#start_time ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-xray/types.rb', line 1328

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_type ⇒ String

A parameter to indicate whether to query trace summaries by TraceId, Event (trace update time), or Service (segment end time).

Returns:

• (String)

# File 'lib/aws-sdk-xray/types.rb', line 1328

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