ListIncidentFindingsCommand

Suggest an Edit

Retrieves a list of the IDs of findings, plus their last modified times, that have been identified for a specified incident. A finding represents a recent application environment change made by an CloudFormation stack creation or update or an CodeDeploy deployment 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, ListIncidentFindingsCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
// const { SSMIncidentsClient, ListIncidentFindingsCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
const client = new SSMIncidentsClient(config);
const input = { // ListIncidentFindingsInput
  incidentRecordArn: "STRING_VALUE", // required
  maxResults: Number("int"),
  nextToken: "STRING_VALUE",
};
const command = new ListIncidentFindingsCommand(input);
const response = await client.send(command);
// { // ListIncidentFindingsOutput
//   findings: [ // FindingSummaryList // required
//     { // FindingSummary
//       id: "STRING_VALUE", // required
//       lastModifiedTime: new Date("TIMESTAMP"), // required
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListIncidentFindingsCommand Input

See ListIncidentFindingsCommandInput for more details

Parameter
Type
Description
incidentRecordArn
Required
string | undefined

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

maxResults
number | undefined

The maximum number of findings to retrieve per call.

nextToken
string | undefined

The pagination token for the next set of items to return. (You received this token from a previous call.)

ListIncidentFindingsCommand Output

See ListIncidentFindingsCommandOutput for details

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

A list of findings that represent deployments that might be the potential cause of the incident.

nextToken
string | undefined

The pagination token to use when requesting the next set of items. If there are no additional items to return, the string is null.

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.