Access Analyzer
API Reference (API Version 2019-11-01)

CreateArchiveRule

Creates an archive rule for the specified analyzer. Archive rules automatically archive findings that meet the criteria you define when you create the rule.

Request Syntax

PUT /analyzer/analyzerName/archive-rule HTTP/1.1 Content-type: application/json { "clientToken": "string", "filter": { "string" : { "contains": [ "string" ], "eq": [ "string" ], "exists": boolean, "neq": [ "string" ] } }, "ruleName": "string" }

URI Request Parameters

The request requires the following URI parameters.

analyzerName

The name of the created analyzer.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[A-Za-z][A-Za-z0-9_.-]*$

Request Body

The request accepts the following data in JSON format.

clientToken

A client token.

Type: String

Required: No

filter

The criteria for the rule.

Type: String to Criterion object map

Required: Yes

ruleName

The name of the rule to create.

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

ConflictException

A conflict exception error.

HTTP Status Code: 409

InternalServerException

Internal server error.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource could not be found.

HTTP Status Code: 404

ServiceQuotaExceededException

Service quote met error.

HTTP Status Code: 402

ThrottlingException

Throttling limit exceeded error.

HTTP Status Code: 429

ValidationException

Validation exception error.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: