Class: Aws::XRay::Types::GetTimeSeriesServiceStatisticsRequest

Inherits:

Struct

• Object
• Struct
• Aws::XRay::Types::GetTimeSeriesServiceStatisticsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-xray/types.rb

Overview

Note:

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

{
  start_time: Time.now, # required
  end_time: Time.now, # required
  group_name: "GroupName",
  group_arn: "GroupARN",
  entity_selector_expression: "EntitySelectorExpression",
  period: 1,
  forecast_statistics: false,
  next_token: "String",
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #end_time ⇒ Time

  The end of the time frame for which to aggregate statistics.

• #entity_selector_expression ⇒ String

  A filter expression defining entities that will be aggregated for statistics.

• #forecast_statistics ⇒ Boolean

  The forecasted high and low fault count values.

• #group_arn ⇒ String

  The Amazon Resource Name (ARN) of the group for which to pull statistics from.

• #group_name ⇒ String

  The case-sensitive name of the group for which to pull statistics from.

• #next_token ⇒ String

  Pagination token.

• #period ⇒ Integer

  Aggregation period in seconds.

• #start_time ⇒ Time

  The start of the time frame for which to aggregate statistics.

Instance Attribute Details

#end_time ⇒ Time

The end of the time frame for which to aggregate statistics.

Returns:

• (Time)

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

class GetTimeSeriesServiceStatisticsRequest < Struct.new(
  :start_time,
  :end_time,
  :group_name,
  :group_arn,
  :entity_selector_expression,
  :period,
  :forecast_statistics,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#entity_selector_expression ⇒ String

A filter expression defining entities that will be aggregated for statistics. Supports ID, service, and edge functions. If no selector expression is specified, edge statistics are returned.

Returns:

• (String)

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

class GetTimeSeriesServiceStatisticsRequest < Struct.new(
  :start_time,
  :end_time,
  :group_name,
  :group_arn,
  :entity_selector_expression,
  :period,
  :forecast_statistics,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#forecast_statistics ⇒ Boolean

The forecasted high and low fault count values. Forecast enabled requests require the EntitySelectorExpression ID be provided.

Returns:

• (Boolean)

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

class GetTimeSeriesServiceStatisticsRequest < Struct.new(
  :start_time,
  :end_time,
  :group_name,
  :group_arn,
  :entity_selector_expression,
  :period,
  :forecast_statistics,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#group_arn ⇒ String

The Amazon Resource Name (ARN) of the group for which to pull statistics from.

Returns:

• (String)

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

class GetTimeSeriesServiceStatisticsRequest < Struct.new(
  :start_time,
  :end_time,
  :group_name,
  :group_arn,
  :entity_selector_expression,
  :period,
  :forecast_statistics,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#group_name ⇒ String

The case-sensitive name of the group for which to pull statistics from.

Returns:

• (String)

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

class GetTimeSeriesServiceStatisticsRequest < Struct.new(
  :start_time,
  :end_time,
  :group_name,
  :group_arn,
  :entity_selector_expression,
  :period,
  :forecast_statistics,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

Pagination token.

Returns:

• (String)

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

class GetTimeSeriesServiceStatisticsRequest < Struct.new(
  :start_time,
  :end_time,
  :group_name,
  :group_arn,
  :entity_selector_expression,
  :period,
  :forecast_statistics,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#period ⇒ Integer

Aggregation period in seconds.

Returns:

• (Integer)

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

class GetTimeSeriesServiceStatisticsRequest < Struct.new(
  :start_time,
  :end_time,
  :group_name,
  :group_arn,
  :entity_selector_expression,
  :period,
  :forecast_statistics,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The start of the time frame for which to aggregate statistics.

Returns:

• (Time)

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

class GetTimeSeriesServiceStatisticsRequest < Struct.new(
  :start_time,
  :end_time,
  :group_name,
  :group_arn,
  :entity_selector_expression,
  :period,
  :forecast_statistics,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end