describe_config_rules `async` ¶

describe_config_rules(
    *,
    config_overrides: Optional[AsyncConfigServiceClientConfig] = None,
    config_rule_names: Optional[ConfigRuleNames] = None,
    filters: Optional[DescribeConfigRulesFilters] = None,
    next_token: Optional[String] = None,
) -> DescribeConfigRulesResponse

Returns details about your Config rules.

Parameters:

config_rule_names (Optional[ConfigRuleNames], default: None ) –

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 (Optional[DescribeConfigRulesFilters], default: None ) –

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 (Optional[String], default: None ) –

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

Raises:

InvalidNextTokenException –

The specified next token is not valid. Specify the nextToken string that was returned in the previous response to get the next page of results.
InvalidParameterValueException –

One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
NoSuchConfigRuleException –

The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_config_service/_services/async_config_service.py

async def describe_config_rules(
    self,
    *,
    config_overrides: Optional[AsyncConfigServiceClientConfig] = None,
    config_rule_names: Optional[
        "capo_config_service.types.config_rule_names.ConfigRuleNames"
    ] = None,
    filters: Optional[
        "capo_config_service.types.describe_config_rules_filters.DescribeConfigRulesFilters"
    ] = None,
    next_token: Optional["capo_config_service.types.string.String"] = None,
) -> "capo_config_service.types.describe_config_rules_response.DescribeConfigRulesResponse":
    """<p>Returns details about your Config rules.</p>

    Args:
        config_rule_names: <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: <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: <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>

    Raises:
        capo_config_service.errors.invalid_next_token_exception.InvalidNextTokenException: <p>The specified next token is not valid. Specify the <code>nextToken</code> string that was returned in the previous response to get the next page of results.</p>
        capo_config_service.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.</p>
        capo_config_service.errors.no_such_config_rule_exception.NoSuchConfigRuleException: <p>The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.</p>
        capo_config_service.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_config_service.types.describe_config_rules_request.DescribeConfigRulesRequest]",
    ) -> AsyncOperationResponse[
        "capo_config_service.types.describe_config_rules_response.DescribeConfigRulesResponse"
    ]:
        import capo_config_service._operations.starling_dove_service.describe_config_rules

        (
            output,
            http_response,
        ) = await capo_config_service._operations.starling_dove_service.describe_config_rules.async_describe_config_rules(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeConfigRules")
    )
    input_: capo_config_service.types.describe_config_rules_request.DescribeConfigRulesRequest = {}
    if config_rule_names is not None:
        input_["config_rule_names"] = config_rule_names
    if filters is not None:
        input_["filters"] = filters
    if next_token is not None:
        input_["next_token"] = next_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

describe_config_rules async ¶

describe_config_rules `async` ¶