AccessAnalyzer / Client / create_archive_rule

create_archive_rule#

AccessAnalyzer.Client.create_archive_rule(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.create_archive_rule(
    analyzerName='string',
    ruleName='string',
    filter={
        'string': {
            'eq': [
                'string',
            ],
            'neq': [
                'string',
            ],
            'contains': [
                'string',
            ],
            'exists': True|False
        }
    },
    clientToken='string'
)
Parameters:

  • analyzerName (string) –

    [REQUIRED]

    The name of the created analyzer.

  • ruleName (string) –

    [REQUIRED]

    The name of the rule to create.

  • filter (dict) –

    [REQUIRED]

    The criteria for the rule.

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

  • clientToken (string) –

    A client token.

    This field is autopopulated if not provided.

Returns:

None

Exceptions