Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . accessanalyzer ]



Creates an analyzer for your account.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--analyzer-name <value>
[--archive-rules <value>]
[--client-token <value>]
[--tags <value>]
--type <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--analyzer-name (string)

The name of the analyzer to create.

--archive-rules (list)

Specifies the archive rules to add for the analyzer. Archive rules automatically archive findings that meet the criteria you define for the rule.


An criterion statement in an archive rule. Each archive rule may have multiple criteria.

filter -> (map)

The condition and values for a criterion.

key -> (string)

value -> (structure)

The criteria to use in the filter that defines the archive rule.

contains -> (list)

A "contains" operator to match for the filter used to create the rule.


eq -> (list)

An "equals" operator to match for the filter used to create the rule.


exists -> (boolean)

An "exists" operator to match for the filter used to create the rule.

neq -> (list)

A "not equals" operator to match for the filter used to create the rule.


ruleName -> (string)

The name of the rule.

Shorthand Syntax:

filter={KeyName1={contains=[string,string],eq=[string,string],exists=boolean,neq=[string,string]},KeyName2={contains=[string,string],eq=[string,string],exists=boolean,neq=[string,string]}},ruleName=string ...

JSON Syntax:

    "filter": {"string": {
          "contains": ["string", ...],
          "eq": ["string", ...],
          "exists": true|false,
          "neq": ["string", ...]
    "ruleName": "string"

--client-token (string)

A client token.

--tags (map)

The tags to apply to the analyzer.

key -> (string)

value -> (string)

Shorthand Syntax:


JSON Syntax:

{"string": "string"

--type (string)

The type of analyzer to create. Only ACCOUNT and ORGANIZATION analyzers are supported. You can create only one analyzer per account per Region. You can create up to 5 analyzers per organization per Region.

Possible values:


--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


arn -> (string)

The ARN of the analyzer that was created by the request.