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

GetFindings

Returns a list of all findings generated by a particular scan.

Request Syntax


GET /findings/scanName?maxResults=maxResults&nextToken=nextToken&status=status HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of results to return in the response. Use this parameter when paginating results. If additional results exist beyond the number you specify, the nextToken element is returned in the response. Use nextToken in a subsequent request to retrieve additional results. If not specified, returns 1000 results.

Valid Range: Minimum value of 1. Maximum value of 1000.

nextToken

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

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

Pattern: ^[\S]+$

scanName

The name of the scan you want to retrieve findings from.

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

Pattern: ^[a-zA-Z0-9-_$:.]*$

Required: Yes

status

The status of the findings you want to get. Pass either Open, Closed, or All.

Valid Values: Closed | Open | All

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "findings": [ 
      { 
         "createdAt": number,
         "description": "string",
         "detectorId": "string",
         "detectorName": "string",
         "detectorTags": [ "string" ],
         "generatorId": "string",
         "id": "string",
         "remediation": { 
            "recommendation": { 
               "text": "string",
               "url": "string"
            },
            "suggestedFixes": [ 
               { 
                  "code": "string",
                  "description": "string"
               }
            ]
         },
         "resource": { 
            "id": "string",
            "subResourceId": "string"
         },
         "ruleId": "string",
         "severity": "string",
         "status": "string",
         "title": "string",
         "type": "string",
         "updatedAt": number,
         "vulnerability": { 
            "filePath": { 
               "codeSnippet": [ 
                  { 
                     "content": "string",
                     "number": number
                  }
               ],
               "endLine": number,
               "name": "string",
               "path": "string",
               "startLine": number
            },
            "id": "string",
            "itemCount": number,
            "referenceUrls": [ "string" ],
            "relatedVulnerabilities": [ "string" ]
         }
      }
   ],
   "nextToken": "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.

findings

A list of findings generated by the specified scan.

Type: Array of Finding objects

nextToken

A pagination token. You can use this in future calls to GetFindings to continue listing results after the current page.

Type: String

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

Pattern: ^[\S]+$

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

ConflictException

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

HTTP Status Code: 409

InternalServerException

The server encountered an internal error and is unable to complete the request.

HTTP Status Code: 500

ResourceNotFoundException

The resource specified in the request was not found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the specified constraints.

HTTP Status Code: 400