ListCoverage
Lists coverage details for you environment.
Request Syntax
POST /coverage/list HTTP/1.1
Content-type: application/json
{
"filterCriteria": {
"accountId": [
{
"comparison": "string
",
"value": "string
"
}
],
"ec2InstanceTags": [
{
"comparison": "string
",
"key": "string
",
"value": "string
"
}
],
"ecrImageTags": [
{
"comparison": "string
",
"value": "string
"
}
],
"ecrRepositoryName": [
{
"comparison": "string
",
"value": "string
"
}
],
"resourceId": [
{
"comparison": "string
",
"value": "string
"
}
],
"resourceType": [
{
"comparison": "string
",
"value": "string
"
}
],
"scanStatusCode": [
{
"comparison": "string
",
"value": "string
"
}
],
"scanStatusReason": [
{
"comparison": "string
",
"value": "string
"
}
],
"scanType": [
{
"comparison": "string
",
"value": "string
"
}
]
},
"maxResults": number
,
"nextToken": "string
"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- filterCriteria
-
An object that contains details on the filters to apply to the coverage data for your environment.
Type: CoverageFilterCriteria object
Required: No
- maxResults
-
The maximum number of results to return in the response.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 200.
Required: No
- 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 to a list action. For subsequent calls, use the
NextToken
value returned from the previous request to continue listing results after the first page.Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000000.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"coveredResources": [
{
"accountId": "string",
"resourceId": "string",
"resourceMetadata": {
"ec2": {
"amiId": "string",
"platform": "string",
"tags": {
"string" : "string"
}
},
"ecrImage": {
"tags": [ "string" ]
},
"ecrRepository": {
"name": "string",
"scanFrequency": "string"
}
},
"resourceType": "string",
"scanStatus": {
"reason": "string",
"statusCode": "string"
},
"scanType": "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.
- coveredResources
-
An object that contains details on the covered resources in your environment.
Type: Array of CoveredResource objects
- 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 to a list action. For subsequent calls, use the
NextToken
value returned from the previous request to continue listing results after the first page.Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000000.
Errors
For information about the errors that are common to all actions, see Common Errors.
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: