Skip to content

OrganizationManagedRuleMetadata

Source code in docs_src/capo_config_service/types/organization_managed_rule_metadata.py
class OrganizationManagedRuleMetadata(TypedDict, closed=True):
    description: NotRequired[
        "capo_config_service.types.string_with_char_limit256_min0.StringWithCharLimit256Min0"
    ]
    """<p>The description that you provide for your organization Config rule.</p>"""
    rule_identifier: (
        "capo_config_service.types.string_with_char_limit256.StringWithCharLimit256"
    )
    """<p>For organization config managed rules, a predefined identifier from a list. For example, <code>IAM_PASSWORD_POLICY</code> is a managed rule. To reference a managed rule, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html">Using Config managed rules</a>.</p>"""
    input_parameters: NotRequired[
        "capo_config_service.types.string_with_char_limit1024.StringWithCharLimit1024"
    ]
    """<p>A string, in JSON format, that is passed to your organization Config rule Lambda function.</p>"""
    maximum_execution_frequency: NotRequired[
        "capo_config_service.types.maximum_execution_frequency.MaximumExecutionFrequency"
    ]
    """<p>The maximum frequency with which Config runs evaluations for a rule. This is for an Config managed rule that is triggered at a periodic frequency.</p> <note> <p>By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the <code>MaximumExecutionFrequency</code> parameter.</p> </note>"""
    resource_types_scope: NotRequired[
        "capo_config_service.types.resource_types_scope.ResourceTypesScope"
    ]
    """<p>The type of the Amazon Web Services resource that was evaluated.</p>"""
    resource_id_scope: NotRequired[
        "capo_config_service.types.string_with_char_limit768.StringWithCharLimit768"
    ]
    """<p>The ID of the Amazon Web Services resource that was evaluated.</p>"""
    tag_key_scope: NotRequired[
        "capo_config_service.types.string_with_char_limit128.StringWithCharLimit128"
    ]
    """<p>One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values. </p>"""
    tag_value_scope: NotRequired[
        "capo_config_service.types.string_with_char_limit256.StringWithCharLimit256"
    ]
    """<p>The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).</p>"""

description instance-attribute

description: NotRequired[StringWithCharLimit256Min0]

The description that you provide for your organization Config rule.

input_parameters instance-attribute

input_parameters: NotRequired[StringWithCharLimit1024]

A string, in JSON format, that is passed to your organization Config rule Lambda function.

maximum_execution_frequency instance-attribute

maximum_execution_frequency: NotRequired[MaximumExecutionFrequency]

The maximum frequency with which Config runs evaluations for a rule. This is for an Config managed rule that is triggered at a periodic frequency.

By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

resource_id_scope instance-attribute

resource_id_scope: NotRequired[StringWithCharLimit768]

The ID of the Amazon Web Services resource that was evaluated.

resource_types_scope instance-attribute

resource_types_scope: NotRequired[ResourceTypesScope]

The type of the Amazon Web Services resource that was evaluated.

rule_identifier instance-attribute

rule_identifier: StringWithCharLimit256

For organization config managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see Using Config managed rules.

tag_key_scope instance-attribute

tag_key_scope: NotRequired[StringWithCharLimit128]

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

tag_value_scope instance-attribute

tag_value_scope: NotRequired[StringWithCharLimit256]

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).