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

GetCisScanResultDetails

Retrieves CIS scan result details.

Request Syntax


POST /cis/scan-result/details/get HTTP/1.1
Content-type: application/json

{
   "accountId": "string",
   "filterCriteria": { 
      "checkIdFilters": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "findingArnFilters": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "findingStatusFilters": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "securityLevelFilters": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "titleFilters": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ]
   },
   "maxResults": number,
   "nextToken": "string",
   "scanArn": "string",
   "sortBy": "string",
   "sortOrder": "string",
   "targetResourceId": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

accountId

The account ID.

Type: String

Length Constraints: Fixed length of 12.

Pattern: ^\d{12}$

Required: Yes

filterCriteria

The filter criteria.

Type: CisScanResultDetailsFilterCriteria object

Required: No

maxResults

The maximum number of CIS scan result details to be returned in a single page of results.

Type: Integer

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

Required: No

nextToken

The pagination token from a previous request that's used to retrieve the next page of results.

Type: String

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

Required: No

scanArn

The scan ARN.

Type: String

Pattern: ^arn:aws(-us-gov|-cn)?:inspector2:[-.a-z0-9]{0,20}:\d{12}:owner/(\d{12}|o-[a-z0-9]{10,32})/cis-scan/[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Required: Yes

sortBy

The sort by order.

Type: String

Valid Values: CHECK_ID | STATUS

Required: No

sortOrder

The sort order.

Type: String

Valid Values: ASC | DESC

Required: No

targetResourceId

The target resource ID.

Type: String

Length Constraints: Minimum length of 10. Maximum length of 341.

Pattern: (^arn:.*:ecr:.*:\d{12}:repository\/(?:[a-z0-9]+(?:[._-][a-z0-9]+)*\/)*[a-z0-9]+(?:[._-][a-z0-9]+)*(\/sha256:[a-z0-9]{64})?$)|(^i-([a-z0-9]{8}|[a-z0-9]{17}|\\*)$|(^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_\.]+(:(\$LATEST|[a-zA-Z0-9-_]+))?$))

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "scanResultDetails": [ 
      { 
         "accountId": "string",
         "checkDescription": "string",
         "checkId": "string",
         "findingArn": "string",
         "level": "string",
         "platform": "string",
         "remediation": "string",
         "scanArn": "string",
         "status": "string",
         "statusReason": "string",
         "targetResourceId": "string",
         "title": "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.

nextToken

The pagination token from a previous request that's used to retrieve the next page of results.

Type: String

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

scanResultDetails

The scan result details.

Type: Array of CisScanResultDetails objects

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

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