ListCisScanConfigurations
Lists CIS scan configurations.
Request Syntax
POST /cis/scan-configuration/list HTTP/1.1
Content-type: application/json
{
"filterCriteria": {
"scanConfigurationArnFilters": [
{
"comparison": "string",
"value": "string"
}
],
"scanNameFilters": [
{
"comparison": "string",
"value": "string"
}
],
"targetResourceTagFilters": [
{
"comparison": "string",
"key": "string",
"value": "string"
}
]
},
"maxResults": number,
"nextToken": "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 CIS scan configuration filter criteria.
Type: ListCisScanConfigurationsFilterCriteria object
Required: No
- maxResults
-
The maximum number of CIS scan configurations 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
- sortBy
-
The CIS scan configuration sort by order.
Type: String
Valid Values:
SCAN_NAME | SCAN_CONFIGURATION_ARNRequired: No
- sortOrder
-
The CIS scan configuration sort order order.
Type: String
Valid Values:
ASC | DESCRequired: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"scanConfigurations": [
{
"ownerId": "string",
"scanConfigurationArn": "string",
"scanName": "string",
"schedule": { ... },
"securityLevel": "string",
"tags": {
"string" : "string"
},
"targets": {
"accountIds": [ "string" ],
"targetResourceTags": {
"string" : [ "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.
- scanConfigurations
-
The CIS scan configuration scan configurations.
Type: Array of CisScanConfiguration objects
Array Members: Minimum number of 0 items. Maximum number of 100 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
