stop_configuration_recorder ¶

stop_configuration_recorder(
    configuration_recorder_name: RecorderName,
    *,
    config_overrides: Optional[ConfigServiceClientConfig] = None,
) -> None

Stops the customer managed configuration recorder. The customer managed configuration recorder will stop recording configuration changes for the resource types you have specified.

Parameters:

configuration_recorder_name (RecorderName) –

The name of the customer managed configuration recorder that you want to stop.

Raises:

NoSuchConfigurationRecorderException –

You have specified a configuration recorder that does not exist.
UnmodifiableEntityException –

The requested operation is not valid.

For PutConfigurationRecorder, you will see this exception because you cannot use this operation to create a service-linked configuration recorder. Use the PutServiceLinkedConfigurationRecorder operation to create a service-linked configuration recorder.

For DeleteConfigurationRecorder, you will see this exception because you cannot use this operation to delete a service-linked configuration recorder. Use the DeleteServiceLinkedConfigurationRecorder operation to delete a service-linked configuration recorder.

For StartConfigurationRecorder and StopConfigurationRecorder, you will see this exception because these operations do not affect service-linked configuration recorders. Service-linked configuration recorders are always recording. To stop recording, you must delete the service-linked configuration recorder. Use the DeleteServiceLinkedConfigurationRecorder operation to delete a service-linked configuration recorder.
UnknownServiceError –

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

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

def stop_configuration_recorder(
    self,
    configuration_recorder_name: "capo_config_service.types.recorder_name.RecorderName",
    *,
    config_overrides: Optional[ConfigServiceClientConfig] = None,
) -> None:
    """<p>Stops the customer managed configuration recorder. The customer managed configuration recorder will stop recording configuration changes for the resource types you have specified.</p>

    Args:
        configuration_recorder_name: <p>The name of the customer managed configuration recorder that you want to stop.</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.unmodifiable_entity_exception.UnmodifiableEntityException: <p>The requested operation is not valid.</p> <p>For <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_PutConfigurationRecorder.html">PutConfigurationRecorder</a>, you will see this exception because you cannot use this operation to create a service-linked configuration recorder. Use the <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_PutServiceLinkedConfigurationRecorder.html">PutServiceLinkedConfigurationRecorder</a> operation to create a service-linked configuration recorder.</p> <p>For <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_DeleteConfigurationRecorder.html">DeleteConfigurationRecorder</a>, you will see this exception because you cannot use this operation to delete a service-linked configuration recorder. Use the <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_DeleteServiceLinkedConfigurationRecorder.html">DeleteServiceLinkedConfigurationRecorder</a> operation to delete a service-linked configuration recorder.</p> <p>For <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_StartConfigurationRecorder.html">StartConfigurationRecorder</a> and <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_StopConfigurationRecorder.html">StopConfigurationRecorder</a>, you will see this exception because these operations do not affect service-linked configuration recorders. Service-linked configuration recorders are always recording. To stop recording, you must delete the service-linked configuration recorder. Use the <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_DeleteServiceLinkedConfigurationRecorder.html">DeleteServiceLinkedConfigurationRecorder</a> operation to delete a service-linked configuration recorder.</p>
        capo_config_service.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_config_service.types.stop_configuration_recorder_request.StopConfigurationRecorderRequest]",
    ) -> OperationResponse[None]:
        import capo_config_service._operations.starling_dove_service.stop_configuration_recorder

        output, http_response = (
            capo_config_service._operations.starling_dove_service.stop_configuration_recorder.stop_configuration_recorder(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StopConfigurationRecorder")
    )
    input_: capo_config_service.types.stop_configuration_recorder_request.StopConfigurationRecorderRequest = {
        "configuration_recorder_name": configuration_recorder_name
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output