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

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
  sampling: false,
  filter_expression: "FilterExpression",
  next_token: "String",
}

Instance Attribute Summary collapse

Instance Attribute Details

#end_timeTime

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

Returns:

  • (Time)


401
402
403
404
405
406
407
408
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 401

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

#filter_expressionString

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

Returns:

  • (String)


401
402
403
404
405
406
407
408
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 401

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

#next_tokenString

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

Returns:

  • (String)


401
402
403
404
405
406
407
408
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 401

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

#samplingBoolean

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

Returns:

  • (Boolean)


401
402
403
404
405
406
407
408
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 401

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

#start_timeTime

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

Returns:

  • (Time)


401
402
403
404
405
406
407
408
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 401

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