ApplyArchiveRule
Retroactively applies the archive rule to existing findings that meet the archive rule criteria.
Request Syntax
PUT /archive-rule HTTP/1.1
Content-type: application/json
{
"analyzerArn": "string",
"clientToken": "string",
"ruleName": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- analyzerArn
-
The Amazon resource name (ARN) of the analyzer.
Type: String
Pattern:
[^:]*:[^:]*:[^:]*:[^:]*:[^:]*:analyzer/.{1,255}Required: Yes
- clientToken
-
A client token.
Type: String
Required: No
- ruleName
-
The name of the rule to apply.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[A-Za-z][A-Za-z0-9_.-]*Required: Yes
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
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
-
Internal server error.
- retryAfterSeconds
-
The seconds to wait to retry.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource could not be found.
- resourceId
-
The ID of the resource.
- resourceType
-
The type of the resource.
HTTP Status Code: 404
- ThrottlingException
-
Throttling limit exceeded error.
- retryAfterSeconds
-
The seconds to wait to retry.
HTTP Status Code: 429
- ValidationException
-
Validation exception error.
- fieldList
-
A list of fields that didn't validate.
- reason
-
The reason for the exception.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
