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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-codeguruprofiler/lib/aws-sdk-codeguruprofiler/types.rb

Overview

Note:

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

{
  end_time: Time.now,
  frame_metrics: [
    {
      frame_name: "String", # required
      thread_states: ["String"], # required
      type: "AggregatedRelativeTotalTime", # required, accepts AggregatedRelativeTotalTime
    },
  ],
  period: "Period",
  profiling_group_name: "ProfilingGroupName", # required
  start_time: Time.now,
  target_resolution: "PT5M", # accepts PT5M, PT1H, P1D
}

The structure representing the BatchGetFrameMetricDataRequest.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#end_timeTime

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)


317
318
319
320
321
322
323
324
325
326
# File 'gems/aws-sdk-codeguruprofiler/lib/aws-sdk-codeguruprofiler/types.rb', line 317

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

#frame_metricsArray<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:



317
318
319
320
321
322
323
324
325
326
# File 'gems/aws-sdk-codeguruprofiler/lib/aws-sdk-codeguruprofiler/types.rb', line 317

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

#periodString

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)


317
318
319
320
321
322
323
324
325
326
# File 'gems/aws-sdk-codeguruprofiler/lib/aws-sdk-codeguruprofiler/types.rb', line 317

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

#profiling_group_nameString

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

Returns:

  • (String)


317
318
319
320
321
322
323
324
325
326
# File 'gems/aws-sdk-codeguruprofiler/lib/aws-sdk-codeguruprofiler/types.rb', line 317

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

#start_timeTime

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)


317
318
319
320
321
322
323
324
325
326
# File 'gems/aws-sdk-codeguruprofiler/lib/aws-sdk-codeguruprofiler/types.rb', line 317

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

#target_resolutionString

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)


317
318
319
320
321
322
323
324
325
326
# File 'gems/aws-sdk-codeguruprofiler/lib/aws-sdk-codeguruprofiler/types.rb', line 317

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