DescribeInsightCommand

Suggest an Edit

Returns details about an insight that you specify using its ID.

Example Syntax

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

import { DevOpsGuruClient, DescribeInsightCommand } from "@aws-sdk/client-devops-guru"; // ES Modules import
// const { DevOpsGuruClient, DescribeInsightCommand } = require("@aws-sdk/client-devops-guru"); // CommonJS import
const client = new DevOpsGuruClient(config);
const input = { // DescribeInsightRequest
  Id: "STRING_VALUE", // required
  AccountId: "STRING_VALUE",
};
const command = new DescribeInsightCommand(input);
const response = await client.send(command);
// { // DescribeInsightResponse
//   ProactiveInsight: { // ProactiveInsight
//     Id: "STRING_VALUE",
//     Name: "STRING_VALUE",
//     Severity: "LOW" || "MEDIUM" || "HIGH",
//     Status: "ONGOING" || "CLOSED",
//     InsightTimeRange: { // InsightTimeRange
//       StartTime: new Date("TIMESTAMP"), // required
//       EndTime: new Date("TIMESTAMP"),
//     },
//     PredictionTimeRange: { // PredictionTimeRange
//       StartTime: new Date("TIMESTAMP"), // required
//       EndTime: new Date("TIMESTAMP"),
//     },
//     ResourceCollection: { // ResourceCollection
//       CloudFormation: { // CloudFormationCollection
//         StackNames: [ // StackNames
//           "STRING_VALUE",
//         ],
//       },
//       Tags: [ // TagCollections
//         { // TagCollection
//           AppBoundaryKey: "STRING_VALUE", // required
//           TagValues: [ // TagValues // required
//             "STRING_VALUE",
//           ],
//         },
//       ],
//     },
//     SsmOpsItemId: "STRING_VALUE",
//     Description: "STRING_VALUE",
//   },
//   ReactiveInsight: { // ReactiveInsight
//     Id: "STRING_VALUE",
//     Name: "STRING_VALUE",
//     Severity: "LOW" || "MEDIUM" || "HIGH",
//     Status: "ONGOING" || "CLOSED",
//     InsightTimeRange: {
//       StartTime: new Date("TIMESTAMP"), // required
//       EndTime: new Date("TIMESTAMP"),
//     },
//     ResourceCollection: {
//       CloudFormation: {
//         StackNames: [
//           "STRING_VALUE",
//         ],
//       },
//       Tags: [
//         {
//           AppBoundaryKey: "STRING_VALUE", // required
//           TagValues: [ // required
//             "STRING_VALUE",
//           ],
//         },
//       ],
//     },
//     SsmOpsItemId: "STRING_VALUE",
//     Description: "STRING_VALUE",
//   },
// };

DescribeInsightCommand Input

See DescribeInsightCommandInput for more details

Parameter
Type
Description
Id
Required
string | undefined

The ID of the insight.

AccountId
string | undefined

The ID of the member account in the organization.

DescribeInsightCommand Output

See DescribeInsightCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
ProactiveInsight
ProactiveInsight | undefined

A ProactiveInsight object that represents the requested insight.

ReactiveInsight
ReactiveInsight | undefined

A ReactiveInsight object that represents the requested insight.

Throws

Name
Fault
Details
AccessDeniedException
client

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management  in the IAM User Guide.

InternalServerException
server

An internal failure in an Amazon service occurred.

ResourceNotFoundException
client

A requested resource could not be found

ThrottlingException
client

The request was denied due to a request throttling.

ValidationException
client

Contains information about data passed in to a field during a request that is not valid.

DevOpsGuruServiceException
Base exception class for all service exceptions from DevOpsGuru service.