Class: Aws::CodeGuruProfiler::Types::BatchGetFrameMetricDataRequest

Inherits:

Struct

• Object
• Struct
• Aws::CodeGuruProfiler::Types::BatchGetFrameMetricDataRequest

Includes:

Structure

Defined in:

lib/aws-sdk-codeguruprofiler/types.rb

Overview

The structure representing the BatchGetFrameMetricDataRequest.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #end_time ⇒ Time

  The end time of the time period for the returned time series values.

• #frame_metrics ⇒ Array<Types::FrameMetric>

  The details of the metrics that are used to request a time series of values.

• #period ⇒ String

  The duration of the frame metrics used to return the time series values.

• #profiling_group_name ⇒ String

  The name of the profiling group associated with the the frame metrics used to return the time series values.

• #start_time ⇒ Time

  The start time of the time period for the frame metrics used to return the time series values.

• #target_resolution ⇒ String

  The requested resolution of time steps for the returned time series of values.

Instance Attribute Details

#end_time ⇒ Time

The end time of the time period for the returned time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

Returns:

• (Time)

# File 'lib/aws-sdk-codeguruprofiler/types.rb', line 278

class BatchGetFrameMetricDataRequest < Struct.new(
  :end_time,
  :frame_metrics,
  :period,
  :profiling_group_name,
  :start_time,
  :target_resolution)
  SENSITIVE = []
  include Aws::Structure
end

#frame_metrics ⇒ Array<Types::FrameMetric>

The details of the metrics that are used to request a time series of values. The metric includes the name of the frame, the aggregation type to calculate the metric value for the frame, and the thread states to use to get the count for the metric value of the frame.

Returns:

• (Array<Types::FrameMetric>)

# File 'lib/aws-sdk-codeguruprofiler/types.rb', line 278

class BatchGetFrameMetricDataRequest < Struct.new(
  :end_time,
  :frame_metrics,
  :period,
  :profiling_group_name,
  :start_time,
  :target_resolution)
  SENSITIVE = []
  include Aws::Structure
end

#period ⇒ String

The duration of the frame metrics used to return the time series values. Specify using the ISO 8601 format. The maximum period duration is one day (‘PT24H` or `P1D`).

Returns:

• (String)

# File 'lib/aws-sdk-codeguruprofiler/types.rb', line 278

class BatchGetFrameMetricDataRequest < Struct.new(
  :end_time,
  :frame_metrics,
  :period,
  :profiling_group_name,
  :start_time,
  :target_resolution)
  SENSITIVE = []
  include Aws::Structure
end

#profiling_group_name ⇒ String

The name of the profiling group associated with the the frame metrics used to return the time series values.

Returns:

• (String)

# File 'lib/aws-sdk-codeguruprofiler/types.rb', line 278

class BatchGetFrameMetricDataRequest < Struct.new(
  :end_time,
  :frame_metrics,
  :period,
  :profiling_group_name,
  :start_time,
  :target_resolution)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The start time of the time period for the frame metrics used to return the time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

Returns:

• (Time)

# File 'lib/aws-sdk-codeguruprofiler/types.rb', line 278

class BatchGetFrameMetricDataRequest < Struct.new(
  :end_time,
  :frame_metrics,
  :period,
  :profiling_group_name,
  :start_time,
  :target_resolution)
  SENSITIVE = []
  include Aws::Structure
end

#target_resolution ⇒ String

The requested resolution of time steps for the returned time series of values. If the requested target resolution is not available due to data not being retained we provide a best effort result by falling back to the most granular available resolution after the target resolution. There are 3 valid values.

• ‘P1D` — 1 day

• ‘PT1H` — 1 hour

• ‘PT5M` — 5 minutes

Returns:

• (String)

# File 'lib/aws-sdk-codeguruprofiler/types.rb', line 278

class BatchGetFrameMetricDataRequest < Struct.new(
  :end_time,
  :frame_metrics,
  :period,
  :profiling_group_name,
  :start_time,
  :target_resolution)
  SENSITIVE = []
  include Aws::Structure
end