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

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 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",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#end_timeTime

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

Returns:

  • (Time)


1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
# File 'gems/aws-sdk-xray/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_expressionString

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)


1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
# File 'gems/aws-sdk-xray/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_statisticsBoolean

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

Returns:

  • (Boolean)


1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
# File 'gems/aws-sdk-xray/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_arnString

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

Returns:

  • (String)


1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
# File 'gems/aws-sdk-xray/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_nameString

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

Returns:

  • (String)


1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
# File 'gems/aws-sdk-xray/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_tokenString

Pagination token.

Returns:

  • (String)


1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
# File 'gems/aws-sdk-xray/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

#periodInteger

Aggregation period in seconds.

Returns:

  • (Integer)


1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
# File 'gems/aws-sdk-xray/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_timeTime

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

Returns:

  • (Time)


1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
# File 'gems/aws-sdk-xray/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