CreateArchiveRule - IAM Access Analyzer


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

To learn about filter keys that you can use to create an archive rule, see IAM Access Analyzer filter keys in the IAM User Guide.

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 uses the following URI parameters.


The name of the created analyzer.

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

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

Required: Yes

Request Body

The request accepts the following data in JSON format.


A client token.

Type: String

Required: No


The criteria for the rule.

Type: String to Criterion object map

Required: Yes


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.


For information about the errors that are common to all actions, see Common Errors.


You do not have sufficient access to perform this action.

HTTP Status Code: 403


A conflict exception error.

HTTP Status Code: 409


Internal server error.

HTTP Status Code: 500


The specified resource could not be found.

HTTP Status Code: 404


Service quote met error.

HTTP Status Code: 402


Throttling limit exceeded error.

HTTP Status Code: 429


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: