Class GetRecommendationsCommandProtected

Returns a list of Recommendation objects that contain recommendations for a profiling group for a given time period. A list of Anomaly objects that contains details about anomalies detected in the profiling group for the same time period is also returned.

Example

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

import { CodeGuruProfilerClient, GetRecommendationsCommand } from "@aws-sdk/client-codeguruprofiler"; // ES Modules import
// const { CodeGuruProfilerClient, GetRecommendationsCommand } = require("@aws-sdk/client-codeguruprofiler"); // CommonJS import
const client = new CodeGuruProfilerClient(config);
const input = { // GetRecommendationsRequest
  profilingGroupName: "STRING_VALUE", // required
  startTime: new Date("TIMESTAMP"), // required
  endTime: new Date("TIMESTAMP"), // required
  locale: "STRING_VALUE",
};
const command = new GetRecommendationsCommand(input);
const response = await client.send(command);
// { // GetRecommendationsResponse
//   profilingGroupName: "STRING_VALUE", // required
//   profileStartTime: new Date("TIMESTAMP"), // required
//   profileEndTime: new Date("TIMESTAMP"), // required
//   recommendations: [ // Recommendations // required
//     { // Recommendation
//       allMatchesCount: Number("int"), // required
//       allMatchesSum: Number("double"), // required
//       pattern: { // Pattern
//         id: "STRING_VALUE",
//         name: "STRING_VALUE",
//         description: "STRING_VALUE",
//         resolutionSteps: "STRING_VALUE",
//         targetFrames: [ // TargetFrames
//           [ // TargetFrame
//             "STRING_VALUE",
//           ],
//         ],
//         thresholdPercent: Number("double"),
//         countersToAggregate: [ // Strings
//           "STRING_VALUE",
//         ],
//       },
//       topMatches: [ // Matches // required
//         { // Match
//           targetFramesIndex: Number("int"),
//           frameAddress: "STRING_VALUE",
//           thresholdBreachValue: Number("double"),
//         },
//       ],
//       startTime: new Date("TIMESTAMP"), // required
//       endTime: new Date("TIMESTAMP"), // required
//     },
//   ],
//   anomalies: [ // Anomalies // required
//     { // Anomaly
//       metric: { // Metric
//         frameName: "STRING_VALUE", // required
//         type: "STRING_VALUE", // required
//         threadStates: [ // required
//           "STRING_VALUE",
//         ],
//       },
//       reason: "STRING_VALUE", // required
//       instances: [ // AnomalyInstances // required
//         { // AnomalyInstance
//           id: "STRING_VALUE", // required
//           startTime: new Date("TIMESTAMP"), // required
//           endTime: new Date("TIMESTAMP"),
//           userFeedback: { // UserFeedback
//             type: "STRING_VALUE", // required
//           },
//         },
//       ],
//     },
//   ],
// };

Param

GetRecommendationsCommandInput

Returns

GetRecommendationsCommandOutput

See

• GetRecommendationsCommandInput for command's input shape.
• GetRecommendationsCommandOutput 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.