BatchGetIncidentFindingsCommand

Suggest an Edit

Retrieves details about all specified findings for an incident, including descriptive details about each finding. A finding represents a recent application environment change made by an CodeDeploy deployment or an CloudFormation stack creation or update that can be investigated as a potential cause of the incident.

Example Syntax

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

import { SSMIncidentsClient, BatchGetIncidentFindingsCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
// const { SSMIncidentsClient, BatchGetIncidentFindingsCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
const client = new SSMIncidentsClient(config);
const input = { // BatchGetIncidentFindingsInput
  incidentRecordArn: "STRING_VALUE", // required
  findingIds: [ // FindingIdList // required
    "STRING_VALUE",
  ],
};
const command = new BatchGetIncidentFindingsCommand(input);
const response = await client.send(command);
// { // BatchGetIncidentFindingsOutput
//   findings: [ // FindingList // required
//     { // Finding
//       id: "STRING_VALUE", // required
//       creationTime: new Date("TIMESTAMP"), // required
//       lastModifiedTime: new Date("TIMESTAMP"), // required
//       details: { // FindingDetails Union: only one key present
//         codeDeployDeployment: { // CodeDeployDeployment
//           startTime: new Date("TIMESTAMP"), // required
//           endTime: new Date("TIMESTAMP"),
//           deploymentGroupArn: "STRING_VALUE", // required
//           deploymentId: "STRING_VALUE", // required
//         },
//         cloudFormationStackUpdate: { // CloudFormationStackUpdate
//           startTime: new Date("TIMESTAMP"), // required
//           endTime: new Date("TIMESTAMP"),
//           stackArn: "STRING_VALUE", // required
//         },
//       },
//     },
//   ],
//   errors: [ // BatchGetIncidentFindingsErrorList // required
//     { // BatchGetIncidentFindingsError
//       findingId: "STRING_VALUE", // required
//       code: "STRING_VALUE", // required
//       message: "STRING_VALUE", // required
//     },
//   ],
// };

BatchGetIncidentFindingsCommand Input

See BatchGetIncidentFindingsCommandInput for more details

Parameter
Type
Description
findingIds
Required
string[] | undefined

A list of IDs of findings for which you want to view details.

incidentRecordArn
Required
string | undefined

The Amazon Resource Name (ARN) of the incident for which you want to view finding details.

BatchGetIncidentFindingsCommand Output

See BatchGetIncidentFindingsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
errors
Required
BatchGetIncidentFindingsError[] | undefined

A list of errors encountered during the operation.

findings
Required
Finding[] | undefined

Information about the requested findings.

Throws

Name
Fault
Details
AccessDeniedException
client

You don't have sufficient access to perform this operation.

InternalServerException
server

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException
client

Request references a resource which doesn't exist.

ThrottlingException
client

The request was denied due to request throttling.

ValidationException
client

The input fails to satisfy the constraints specified by an Amazon Web Services service.

SSMIncidentsServiceException
Base exception class for all service exceptions from SSMIncidents service.