Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

BatchGetIncidentFindings

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 AWS CodeDeploy deployment or an AWS CloudFormation stack creation or update that can be investigated as a potential cause of the incident.

Request Syntax


POST /batchGetIncidentFindings HTTP/1.1
Content-type: application/json

{
   "findingIds": [ "string" ],
   "incidentRecordArn": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

findingIds

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

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 20 items.

Length Constraints: Minimum length of 0. Maximum length of 128.

Required: Yes

incidentRecordArn

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000.

Pattern: ^arn:aws(-cn|-us-gov)?:[a-z0-9-]*:[a-z0-9-]*:([0-9]{12})?:.+$

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "errors": [ 
      { 
         "code": "string",
         "findingId": "string",
         "message": "string"
      }
   ],
   "findings": [ 
      { 
         "creationTime": number,
         "details": { ... },
         "id": "string",
         "lastModifiedTime": number
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

errors

A list of errors encountered during the operation.

Type: Array of BatchGetIncidentFindingsError objects

findings

Information about the requested findings.

Type: Array of Finding objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

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

HTTP Status Code: 403

InternalServerException

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

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource which doesn't exist.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of BatchGetIncidentFindings.

Sample Request


POST /batchGetIncidentFindings HTTP/1.1
Host: ssm-incidents.us-east-2.amazonaws.com
Accept-Encoding: identity
User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.129-72.229.amzn2int.x86_64 exe/x86_64.amzn.2 prompt/off command/ssm-incidents.batch-get-incident-findings
X-Amz-Date: 20231210T104650Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20231210/us-east-2/ssm-incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 154

{
  "incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/my-incident/c6c59324-8fee-34eb-2ea1-1a279EXAMPLE",
  "findingIds": [
    "08c5c945-b204-adaa-f0ef-2f212INVALID",
    "92c59324-ad98-c955-ebe1-35779EXAMPLE",
    "96c59324-ad98-2f5b-f74b-b6c3aEXAMPLE",
    "64c5c950-1d68-8b04-7852-c471dEXAMPLE"
  ]
}

Sample Response


{
  "errors": [
    {
      "code": "ResourceNotFoundException",
      "findingId": "08c5c945-b204-adaa-f0ef-2f212INVALID",
      "message": "Finding with ID '08c5c945-b204-adaa-f0ef-2f212INVALID' is not accessible"
    }
  ],
  "findings": [
    {
      "creationTime": "2023-12-13T10:47:03.560000+11:00",
      "details": {
        "cloudFormationStackUpdate": {
          "endTime": "2023-12-13T10:46:05.616000+11:00",
          "stackArn": "arn:aws:cloudformation:us-east-2:111122223333:stack/my-test-stack/54ae4890-6632-11ee-8958-0ac64EXAMPLE",
          "startTime": "2023-12-13T10:45:53.850000+11:00"
        }
      },
      "id": "92c59324-ad98-c955-ebe1-35779EXAMPLE",
      "lastModifiedTime": "2023-12-13T10:47:03.560000+11:00"
    },
    {
      "creationTime": "2023-12-13T10:47:03.560000+11:00",
      "details": {
        "cloudFormationStackUpdate": {
          "endTime": "2023-12-13T10:46:33.015000+11:00",
          "stackArn": "arn:aws:cloudformation:us-east-2:111122223333:stack/my-test-stack/54ae4890-6632-11ee-8958-0ac64EXAMPLE",
          "startTime": "2023-12-13T10:46:21.480000+11:00"
        }
      },
      "id": "96c59324-ad98-2f5b-f74b-b6c3aEXAMPLE",
      "lastModifiedTime": "2023-12-13T10:47:03.560000+11:00"
    },
    {
      "creationTime": "2023-12-13T11:40:56.273000+11:00",
      "details": {
        "codeDeployDeployment": {
          "deploymentGroupArn": "arn:aws:codedeploy:us-east-2:111122223333:deploymentgroup:my-ServerlessDeploymentApplication-7lLr2EXAMPLE/myLambdaFunctionDeploymentGroup-ID2K1EXAMPLE",
          "deploymentId": "d-RI2EXAMPLE",
          "endTime": "2023-12-13T11:37:03.174000+11:00",
          "startTime": "2023-12-13T11:37:00.790000+11:00"
        }
      },
      "id": "64c5c950-1d68-8b04-7852-c471dEXAMPLE",
      "lastModifiedTime": "2023-12-13T11:40:56.273000+11:00"
    }
  ]
}