AccessAnalyzer / Client / get_archive_rule

get_archive_rule#

AccessAnalyzer.Client.get_archive_rule(**kwargs)#

Retrieves information about an archive 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.get_archive_rule(
    analyzerName='string',
    ruleName='string'
)
Parameters:

  • analyzerName (string) –

    [REQUIRED]

    The name of the analyzer to retrieve rules from.

  • ruleName (string) –

    [REQUIRED]

    The name of the rule to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'archiveRule': {
        'ruleName': 'string',
        'filter': {
            'string': {
                'eq': [
                    'string',
                ],
                'neq': [
                    'string',
                ],
                'contains': [
                    'string',
                ],
                'exists': True|False
            }
        },
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    The response to the request.

    • archiveRule (dict) –

      Contains information about an archive rule. Archive rules automatically archive new findings that meet the criteria you define when you create the rule.

      • ruleName (string) –

        The name of the archive rule.

      • filter (dict) –

        A filter used to define the archive 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.

      • createdAt (datetime) –

        The time at which the archive rule was created.

      • updatedAt (datetime) –

        The time at which the archive rule was last updated.

Exceptions