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

BatchGetCodeSnippet

Retrieves code snippets from findings that Amazon Inspector detected code vulnerabilities in.

Request Syntax


POST /codesnippet/batchget HTTP/1.1
Content-type: application/json

{
   "findingArns": [ "string" ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

findingArns

An array of finding ARNs for the findings you want to retrieve code snippets from.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^arn:(aws[a-zA-Z-]*)?:inspector2:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:finding/[a-f0-9]{32}$

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "codeSnippetResults": [ 
      { 
         "codeSnippet": [ 
            { 
               "content": "string",
               "lineNumber": number
            }
         ],
         "endLine": number,
         "findingArn": "string",
         "startLine": number,
         "suggestedFixes": [ 
            { 
               "code": "string",
               "description": "string"
            }
         ]
      }
   ],
   "errors": [ 
      { 
         "errorCode": "string",
         "errorMessage": "string",
         "findingArn": "string"
      }
   ]
}

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.

codeSnippetResults

The retrieved code snippets associated with the provided finding ARNs.

Type: Array of CodeSnippetResult objects

errors

Any errors Amazon Inspector encountered while trying to retrieve the requested code snippets.

Type: Array of CodeSnippetError objects

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The request has failed due to an internal failure of the Amazon Inspector service.

HTTP Status Code: 500

ThrottlingException

The limit on the number of requests per second was exceeded.

HTTP Status Code: 429

ValidationException

The request has failed validation due to missing required fields or having invalid inputs.

HTTP Status Code: 400