You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing GetTraceSummariesRequest as input to an Aws::Client method, you can use a vanilla 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) —

    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.

Returns:

  • (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.

Returns:

  • (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.

Returns:

  • (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. Input parameters are Name and Value.

Returns:

#start_time ⇒ Time

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

Returns:

  • (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 or Event time.

Possible values:

  • TraceId
  • Event

Returns:

  • (String) —

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