Skip to content

CreateAnalyzerRequest

Source code in docs_src/capo_accessanalyzer/types/create_analyzer_request.py
class CreateAnalyzerRequest(TypedDict, closed=True):
    analyzer_name: "capo_accessanalyzer.types.analyzer_name.AnalyzerName"
    """<p>The name of the analyzer to create.</p>"""
    type: "capo_accessanalyzer.types.type.Type"
    """<p>The type of analyzer to create. You can create only one analyzer per account per Region. You can create up to 5 analyzers per organization per Region.</p>"""
    archive_rules: NotRequired[
        "capo_accessanalyzer.types.inline_archive_rules_list.InlineArchiveRulesList"
    ]
    """<p>Specifies the archive rules to add for the analyzer. Archive rules automatically archive findings that meet the criteria you define for the rule.</p>"""
    tags: NotRequired["capo_accessanalyzer.types.tags_map.TagsMap"]
    """<p>An array of key-value pairs to apply to the analyzer. You can use the set of Unicode letters, digits, whitespace, <code>_</code>, <code>.</code>, <code>/</code>, <code>=</code>, <code>+</code>, and <code>-</code>.</p> <p>For the tag key, you can specify a value that is 1 to 128 characters in length and cannot be prefixed with <code>aws:</code>.</p> <p>For the tag value, you can specify a value that is 0 to 256 characters in length.</p>"""
    client_token: NotRequired["str"]
    """<p>A client token.</p>"""
    configuration: NotRequired[
        "capo_accessanalyzer.types.analyzer_configuration.AnalyzerConfiguration"
    ]
    """<p>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 internal access analyzer, the specified internal access analysis rules are used for the configuration.</p>"""

analyzer_name instance-attribute

analyzer_name: AnalyzerName

The name of the analyzer to create.

archive_rules instance-attribute

archive_rules: NotRequired[InlineArchiveRulesList]

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

client_token instance-attribute

client_token: NotRequired[str]

A client token.

configuration instance-attribute

configuration: NotRequired[AnalyzerConfiguration]

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 internal access analyzer, the specified internal access analysis rules are used for the configuration.

tags instance-attribute

tags: NotRequired[TagsMap]

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.

type instance-attribute

type: Type

The type of analyzer to create. You can create only one analyzer per account per Region. You can create up to 5 analyzers per organization per Region.