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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing BatchGetFrameMetricDataRequest as input to an Aws::Client method, you can use a vanilla 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: "P1D", # accepts P1D, PT1H, PT5M
}

The structure representing the BatchGetFrameMetricDataRequest.

See Also:

Instance Attribute Summary collapse

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) —

    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. 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>) —

    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. Specify using the ISO 8601 format. The maximum period duration is one day (PT24H or P1D).

Returns:

  • (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.

Returns:

  • (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. 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) —

    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. 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

    Possible values:

    • P1D
    • PT1H
    • PT5M

Returns:

  • (String) —

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