Class BatchGetFrameMetricDataCommandProtected

Returns the time series of values for a requested list of frame metrics from a time period.

Example

Use a bare-bones client and the command you need to make an API call.

import { CodeGuruProfilerClient, BatchGetFrameMetricDataCommand } from "@aws-sdk/client-codeguruprofiler"; // ES Modules import
// const { CodeGuruProfilerClient, BatchGetFrameMetricDataCommand } = require("@aws-sdk/client-codeguruprofiler"); // CommonJS import
const client = new CodeGuruProfilerClient(config);
const input = { // BatchGetFrameMetricDataRequest
  profilingGroupName: "STRING_VALUE", // required
  startTime: new Date("TIMESTAMP"),
  endTime: new Date("TIMESTAMP"),
  period: "STRING_VALUE",
  targetResolution: "STRING_VALUE",
  frameMetrics: [ // FrameMetrics
    { // FrameMetric
      frameName: "STRING_VALUE", // required
      type: "STRING_VALUE", // required
      threadStates: [ // ThreadStates // required
        "STRING_VALUE",
      ],
    },
  ],
};
const command = new BatchGetFrameMetricDataCommand(input);
const response = await client.send(command);
// { // BatchGetFrameMetricDataResponse
//   startTime: new Date("TIMESTAMP"), // required
//   endTime: new Date("TIMESTAMP"), // required
//   resolution: "STRING_VALUE", // required
//   endTimes: [ // ListOfTimestamps // required
//     { // TimestampStructure
//       value: new Date("TIMESTAMP"), // required
//     },
//   ],
//   unprocessedEndTimes: { // UnprocessedEndTimeMap // required
//     "<keys>": [
//       {
//         value: new Date("TIMESTAMP"), // required
//       },
//     ],
//   },
//   frameMetricData: [ // FrameMetricData // required
//     { // FrameMetricDatum
//       frameMetric: { // FrameMetric
//         frameName: "STRING_VALUE", // required
//         type: "STRING_VALUE", // required
//         threadStates: [ // ThreadStates // required
//           "STRING_VALUE",
//         ],
//       },
//       values: [ // FrameMetricValues // required
//         Number("double"),
//       ],
//     },
//   ],
// };

Param

BatchGetFrameMetricDataCommandInput

Returns

BatchGetFrameMetricDataCommandOutput

See

• BatchGetFrameMetricDataCommandInput for command's input shape.
• BatchGetFrameMetricDataCommandOutput for command's response shape.
• config for CodeGuruProfilerClient's config shape.

Throws

InternalServerException (server fault)

The server encountered an internal error and is unable to complete the request.

Throws

ResourceNotFoundException (client fault)

The resource specified in the request does not exist.

Throws

ThrottlingException (client fault)

The request was denied due to request throttling.

Throws

ValidationException (client fault)

The parameter is not valid.

Throws

CodeGuruProfilerServiceException

Base exception class for all service exceptions from CodeGuruProfiler service.