Skip to content

list_configuration_recorders async

list_configuration_recorders(
    *,
    config_overrides: Optional[AsyncConfigServiceClientConfig] = None,
    filters: Optional[ConfigurationRecorderFilterList] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListConfigurationRecordersResponse

Returns a list of configuration recorders depending on the filters you specify.

Parameters:

  • filters (Optional[ConfigurationRecorderFilterList], default: None ) –

    Filters the results based on a list of ConfigurationRecorderFilter objects that you specify.

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of results to include in the response.

  • next_token (Optional[NextToken], 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:

  • ValidationException –

    The requested operation is not valid. You will see this exception if there are missing required fields or if the input value fails the validation.

    For PutStoredQuery, one of the following errors:

    • There are missing required fields.

    • The input value fails the validation.

    • You are trying to create more than 300 queries.

    For DescribeConfigurationRecorders and DescribeConfigurationRecorderStatus, one of the following errors:

    • You have specified more than one configuration recorder.

    • You have provided a service principal for service-linked configuration recorder that is not valid.

    For AssociateResourceTypes and DisassociateResourceTypes, one of the following errors:

    • Your configuraiton recorder has a recording strategy that does not allow the association or disassociation of resource types.

    • One or more of the specified resource types are already associated or disassociated with the configuration recorder.

    • For service-linked configuration recorders, the configuration recorder does not record one or more of the specified resource types.

    For DeleteServiceLinkedConfigurationRecorder, one of the following errors:

    • You have provided both Arn and ServicePrincipal. Only one of Arn or ServicePrincipal can be specified.

    • You have provided a service principal for service-linked configuration recorder that is not valid.

  • 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 list_configuration_recorders(
    self,
    *,
    config_overrides: Optional[AsyncConfigServiceClientConfig] = None,
    filters: Optional[
        "capo_config_service.types.configuration_recorder_filter_list.ConfigurationRecorderFilterList"
    ] = None,
    max_results: Optional[
        "capo_config_service.types.max_results.MaxResults"
    ] = None,
    next_token: Optional["capo_config_service.types.next_token.NextToken"] = None,
) -> "capo_config_service.types.list_configuration_recorders_response.ListConfigurationRecordersResponse":
    """<p>Returns a list of configuration recorders depending on the filters you specify.</p>

    Args:
        filters: <p>Filters the results based on a list of <code>ConfigurationRecorderFilter</code> objects that you specify.</p>
        max_results: <p>The maximum number of results to include in the response.</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.validation_exception.ValidationException: <p>The requested operation is not valid. You will see this exception if there are missing required fields or if the input value fails the validation.</p> <p>For <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_PutStoredQuery.html">PutStoredQuery</a>, one of the following errors:</p> <ul> <li> <p>There are missing required fields.</p> </li> <li> <p>The input value fails the validation.</p> </li> <li> <p>You are trying to create more than 300 queries.</p> </li> </ul> <p>For <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_DescribeConfigurationRecorders.html">DescribeConfigurationRecorders</a> and <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_DescribeConfigurationRecorderStatus.html">DescribeConfigurationRecorderStatus</a>, one of the following errors:</p> <ul> <li> <p>You have specified more than one configuration recorder.</p> </li> <li> <p>You have provided a service principal for service-linked configuration recorder that is not valid.</p> </li> </ul> <p>For <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_AssociateResourceTypes.html">AssociateResourceTypes</a> and <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_DisassociateResourceTypes.html">DisassociateResourceTypes</a>, one of the following errors:</p> <ul> <li> <p>Your configuraiton recorder has a recording strategy that does not allow the association or disassociation of resource types.</p> </li> <li> <p>One or more of the specified resource types are already associated or disassociated with the configuration recorder.</p> </li> <li> <p>For service-linked configuration recorders, the configuration recorder does not record one or more of the specified resource types.</p> </li> </ul> <p>For <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_DeleteServiceLinkedConfigurationRecorder.html">DeleteServiceLinkedConfigurationRecorder</a>, one of the following errors:</p> <ul> <li> <p>You have provided both <code>Arn</code> and <code>ServicePrincipal</code>. Only one of <code>Arn</code> or <code>ServicePrincipal</code> can be specified.</p> </li> <li> <p>You have provided a service principal for service-linked configuration recorder that is not valid.</p> </li> </ul>
        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.list_configuration_recorders_request.ListConfigurationRecordersRequest]",
    ) -> AsyncOperationResponse[
        "capo_config_service.types.list_configuration_recorders_response.ListConfigurationRecordersResponse"
    ]:
        import capo_config_service._operations.starling_dove_service.list_configuration_recorders

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListConfigurationRecorders")
    )
    input_: capo_config_service.types.list_configuration_recorders_request.ListConfigurationRecordersRequest = {}
    if filters is not None:
        input_["filters"] = filters
    if max_results is not None:
        input_["max_results"] = max_results
    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