AccessAnalyzer / Client / create_analyzer

create_analyzer

AccessAnalyzer.Client.create_analyzer(**kwargs)

Creates an analyzer for your account.

See also: AWS API Documentation

Request Syntax

response = client.create_analyzer(
    analyzerName='string',
    type='ACCOUNT'|'ORGANIZATION'|'ACCOUNT_UNUSED_ACCESS'|'ORGANIZATION_UNUSED_ACCESS',
    archiveRules=[
        {
            'ruleName': 'string',
            'filter': {
                'string': {
                    'eq': [
                        'string',
                    ],
                    'neq': [
                        'string',
                    ],
                    'contains': [
                        'string',
                    ],
                    'exists': True|False
                }
            }
        },
    ],
    tags={
        'string': 'string'
    },
    clientToken='string',
    configuration={
        'unusedAccess': {
            'unusedAccessAge': 123,
            'analysisRule': {
                'exclusions': [
                    {
                        'accountIds': [
                            'string',
                        ],
                        'resourceTags': [
                            {
                                'string': 'string'
                            },
                        ]
                    },
                ]
            }
        }
    }
)

Parameters:

• analyzerName (string) –

  [REQUIRED]

  The name of the analyzer to create.

• type (string) –

  [REQUIRED]

  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.

• archiveRules (list) –

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

  • (dict) –

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

    • ruleName (string) – [REQUIRED]

      The name of the rule.

    • filter (dict) – [REQUIRED]

      The condition and values for a criterion.

      • (string) –

        • (dict) –

          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.

• tags (dict) –

  An array of key-value pairs to apply to the analyzer. You can use the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

  For the tag key, you can specify a value that is 1 to 128 characters in length and cannot be prefixed with aws:.

  For the tag value, you can specify a value that is 0 to 256 characters in length.

  • (string) –

    • (string) –

• clientToken (string) –

  A client token.

  This field is autopopulated if not provided.

• configuration (dict) –

  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.

  Note

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

  • unusedAccess (dict) –

    Specifies the configuration of an unused access analyzer for an Amazon Web Services organization or account.

    • 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 365 days.

    • analysisRule (dict) –

      Contains information about analysis rules for the analyzer. Analysis rules determine which entities will generate findings based on the criteria you define when you create the rule.

      • exclusions (list) –

        A list of rules for the analyzer containing criteria to exclude from analysis. Entities that meet the rule criteria will not generate findings.

        • (dict) –

          The criteria for an analysis rule for an analyzer. The criteria determine which entities will generate findings.

          • accountIds (list) –

            A list of Amazon Web Services account IDs to apply to the analysis rule criteria. The accounts cannot include the organization analyzer owner account. Account IDs can only be applied to the analysis rule criteria for organization-level analyzers. The list cannot include more than 2,000 account IDs.

            • (string) –

          • resourceTags (list) –

            An array of key-value pairs to match for your resources. You can use the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

            For the tag key, you can specify a value that is 1 to 128 characters in length and cannot be prefixed with aws:.

            For the tag value, you can specify a value that is 0 to 256 characters in length. If the specified tag value is 0 characters, the rule is applied to all principals with the specified tag key.

            • (dict) –

              • (string) –

                • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string'
}

Response Structure

• (dict) –

  The response to the request to create an analyzer.

  • arn (string) –

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

Exceptions

• AccessAnalyzer.Client.exceptions.ConflictException

• AccessAnalyzer.Client.exceptions.ValidationException

• AccessAnalyzer.Client.exceptions.InternalServerException

• AccessAnalyzer.Client.exceptions.ServiceQuotaExceededException

• AccessAnalyzer.Client.exceptions.ThrottlingException

• AccessAnalyzer.Client.exceptions.AccessDeniedException