Skip to content

DescribeConfigRulesRequest

Source code in docs_src/capo_config_service/types/describe_config_rules_request.py
class DescribeConfigRulesRequest(TypedDict, closed=True):
    config_rule_names: NotRequired[
        "capo_config_service.types.config_rule_names.ConfigRuleNames"
    ]
    """<p>The names of the Config rules for which you want details. If you do not specify any names, Config returns details for all your rules.</p>"""
    filters: NotRequired[
        "capo_config_service.types.describe_config_rules_filters.DescribeConfigRulesFilters"
    ]
    """<p>Returns a list of Detective or Proactive Config rules. By default, this API returns an unfiltered list. For more information on Detective or Proactive Config rules, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config-rules.html"> <b>Evaluation Mode</b> </a> in the <i>Config Developer Guide</i>.</p>"""
    next_token: NotRequired["capo_config_service.types.string.String"]
    """<p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>"""

config_rule_names instance-attribute

config_rule_names: NotRequired[ConfigRuleNames]

The names of the Config rules for which you want details. If you do not specify any names, Config returns details for all your rules.

filters instance-attribute

filters: NotRequired[DescribeConfigRulesFilters]

Returns a list of Detective or Proactive Config rules. By default, this API returns an unfiltered list. For more information on Detective or Proactive Config rules, see Evaluation Mode in the Config Developer Guide.

next_token instance-attribute

next_token: NotRequired[String]

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.