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 ]

create-analyzer

Description

Creates an analyzer for your account.

See also: AWS API Documentation

Synopsis

  create-analyzer
--analyzer-name <value>
--type <value>
[--archive-rules <value>]
[--tags <value>]
[--client-token <value>]
[--configuration <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--analyzer-name (string)

The name of the analyzer to create.

--type (string)

The type of analyzer to create. Only ACCOUNT , ORGANIZATION , ACCOUNT_UNUSED_ACCESS , and ORGANIZATION_UNUSED_ACCESS 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:

  • ACCOUNT
  • ORGANIZATION
  • ACCOUNT_UNUSED_ACCESS
  • ORGANIZATION_UNUSED_ACCESS

--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.

(structure)

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

ruleName -> (string)

The name of the rule.

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. For more information on available filter keys, see IAM Access Analyzer filter keys .

eq -> (list)

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

(string)

neq -> (list)

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

(string)

contains -> (list)

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

(string)

exists -> (boolean)

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

Shorthand Syntax:

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

JSON Syntax:

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

--tags (map)

An array of key-value pairs to apply to the analyzer.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--client-token (string)

A client token.

--configuration (tagged union structure)

Specifies the configuration of the analyzer. If the analyzer is an unused access analyzer, the specified scope of unused access is used for the configuration. If the analyzer is an external access analyzer, this field is not used.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: unusedAccess.

unusedAccess -> (structure)

Specifies the configuration of an unused access analyzer for an Amazon Web Services organization or account. External access analyzers do not support any configuration.

unusedAccessAge -> (integer)

The specified access age in days for which to generate findings for unused access. For example, if you specify 90 days, the analyzer will generate findings for IAM entities within the accounts of the selected organization for any access that hasn't been used in 90 or more days since the analyzer's last scan. You can choose a value between 1 and 180 days.

Shorthand Syntax:

unusedAccess={unusedAccessAge=integer}

JSON Syntax:

{
  "unusedAccess": {
    "unusedAccessAge": integer
  }
}

--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.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To create an analyzer

The following create-analyzer example creates an analyzer in your AWS account.

aws accessanalyzer create-analyzer \
    --analyzer-name example \
    --type ACCOUNT

Output:

{
    "arn": "arn:aws:access-analyzer:us-east-2:111122223333:analyzer/example"
}

For more information, see Getting started with AWS Identity and Access Management Access Analyzer findings in the AWS IAM User Guide.

Output

arn -> (string)

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