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

ListCisScanResultsAggregatedByTargetResource

Lists scan results aggregated by a target resource.

Request Syntax


POST /cis/scan-result/resource/list HTTP/1.1
Content-type: application/json

{
   "filterCriteria": { 
      "accountIdFilters": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "checkIdFilters": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "failedChecksFilters": [ 
         { 
            "lowerInclusive": number,
            "upperInclusive": number
         }
      ],
      "platformFilters": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "statusFilters": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "targetResourceIdFilters": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "targetResourceTagFilters": [ 
         { 
            "comparison": "string",
            "key": "string",
            "value": "string"
         }
      ],
      "targetStatusFilters": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "targetStatusReasonFilters": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ]
   },
   "maxResults": number,
   "nextToken": "string",
   "scanArn": "string",
   "sortBy": "string",
   "sortOrder": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

filterCriteria

The filter criteria.

Type: CisScanResultsAggregatedByTargetResourceFilterCriteria object

Required: No

maxResults

The maximum number of scan results aggregated by a target resource to be returned in a single page of results.

Type: Integer

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

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

Required: No

sortOrder

The sort order.

Type: String

Valid Values: ASC | DESC

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "targetResourceAggregations": [ 
      { 
         "accountId": "string",
         "platform": "string",
         "scanArn": "string",
         "statusCounts": { 
            "failed": number,
            "passed": number,
            "skipped": number
         },
         "targetResourceId": "string",
         "targetResourceTags": { 
            "string" : [ "string" ]
         },
         "targetStatus": "string",
         "targetStatusReason": "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.

targetResourceAggregations

The resource aggregations.

Type: Array of CisTargetResourceAggregation 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