describe_configuration_recorders `async` ¶

describe_configuration_recorders(
    *,
    config_overrides: Optional[AsyncConfigServiceClientConfig] = None,
    configuration_recorder_names: Optional[ConfigurationRecorderNameList] = None,
    service_principal: Optional[ServicePrincipal] = None,
    arn: Optional[AmazonResourceName] = None,
) -> DescribeConfigurationRecordersResponse

Returns details for the configuration recorder you specify.

If a configuration recorder is not specified, this operation returns details for the customer managed configuration recorder configured for the account, if applicable.

When making a request to this operation, you can only specify one configuration recorder.

Parameters:

configuration_recorder_names (Optional[ConfigurationRecorderNameList], default: None ) –

A list of names of the configuration recorders that you want to specify.

When making a request to this operation, you can only specify one configuration recorder.
service_principal (Optional[ServicePrincipal], default: None ) –

For service-linked configuration recorders, you can use the service principal of the linked Amazon Web Services service to specify the configuration recorder. This field is only supported for Amazon Web Services service principals. For third-party service-linked configuration recorders, use Arn instead.
arn (Optional[AmazonResourceName], default: None ) –

The Amazon Resource Name (ARN) of the configuration recorder that you want to specify.

Raises:

NoSuchConfigurationRecorderException –

You have specified a configuration recorder that does not exist.
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 describe_configuration_recorders(
    self,
    *,
    config_overrides: Optional[AsyncConfigServiceClientConfig] = None,
    configuration_recorder_names: Optional[
        "capo_config_service.types.configuration_recorder_name_list.ConfigurationRecorderNameList"
    ] = None,
    service_principal: Optional[
        "capo_config_service.types.service_principal.ServicePrincipal"
    ] = None,
    arn: Optional[
        "capo_config_service.types.amazon_resource_name.AmazonResourceName"
    ] = None,
) -> "capo_config_service.types.describe_configuration_recorders_response.DescribeConfigurationRecordersResponse":
    """<p>Returns details for the configuration recorder you specify.</p> <p>If a configuration recorder is not specified, this operation returns details for the customer managed configuration recorder configured for the account, if applicable.</p> <note> <p>When making a request to this operation, you can only specify one configuration recorder.</p> </note>

    Args:
        configuration_recorder_names: <p>A list of names of the configuration recorders that you want to specify.</p> <note> <p>When making a request to this operation, you can only specify one configuration recorder.</p> </note>
        service_principal: <p>For service-linked configuration recorders, you can use the service principal of the linked Amazon Web Services service to specify the configuration recorder. This field is only supported for Amazon Web Services service principals. For third-party service-linked configuration recorders, use <code>Arn</code> instead.</p>
        arn: <p>The Amazon Resource Name (ARN) of the configuration recorder that you want to specify.</p>

    Raises:
        capo_config_service.errors.no_such_configuration_recorder_exception.NoSuchConfigurationRecorderException: <p>You have specified a configuration recorder that does not exist.</p>
        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.describe_configuration_recorders_request.DescribeConfigurationRecordersRequest]",
    ) -> AsyncOperationResponse[
        "capo_config_service.types.describe_configuration_recorders_response.DescribeConfigurationRecordersResponse"
    ]:
        import capo_config_service._operations.starling_dove_service.describe_configuration_recorders

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeConfigurationRecorders")
    )
    input_: capo_config_service.types.describe_configuration_recorders_request.DescribeConfigurationRecordersRequest = {}
    if configuration_recorder_names is not None:
        input_["configuration_recorder_names"] = configuration_recorder_names
    if service_principal is not None:
        input_["service_principal"] = service_principal
    if arn is not None:
        input_["arn"] = arn

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

describe_configuration_recorders async ¶

describe_configuration_recorders `async` ¶