CreateExclusionsPreview
Starts the generation of an exclusions preview for the specified assessment template. The exclusions preview lists the potential exclusions (ExclusionPreview) that Inspector Classic can detect before it runs the assessment.
Request Syntax
{
"assessmentTemplateArn": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- assessmentTemplateArn
-
The ARN that specifies the assessment template for which you want to create an exclusions preview.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: Yes
Response Syntax
{
"previewToken": "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.
- previewToken
-
Specifies the unique identifier of the requested exclusions preview. You can use the unique identifier to retrieve the exclusions preview when running the GetExclusionsPreview API.
Type: String
Pattern:
[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalException
-
Internal server error.
HTTP Status Code: 500
- InvalidInputException
-
The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
HTTP Status Code: 400
- NoSuchEntityException
-
The request was rejected because it referenced an entity that does not exist. The error code describes the entity.
HTTP Status Code: 400
- PreviewGenerationInProgressException
-
The request is rejected. The specified assessment template is currently generating an exclusions preview.
HTTP Status Code: 400
- ServiceTemporarilyUnavailableException
-
The serice is temporary unavailable.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
