Skip to content

delete_replicator

delete_replicator(
    replicator_arn: __string,
    *,
    config_overrides: Optional[KafkaClientConfig] = None,
    current_version: Optional[__string] = None,
) -> DeleteReplicatorResponse

Deletes a replicator.

Parameters:

  • current_version (Optional[__string], default: None ) –

    The current version of the replicator.

  • replicator_arn (__string) –

    The Amazon Resource Name (ARN) of the replicator to be deleted.

Raises:

Source code in docs_src/capo_kafka/_services/kafka.py
def delete_replicator(
    self,
    replicator_arn: "capo_kafka.types.__string.__string",
    *,
    config_overrides: Optional[KafkaClientConfig] = None,
    current_version: Optional["capo_kafka.types.__string.__string"] = None,
) -> "capo_kafka.types.delete_replicator_response.DeleteReplicatorResponse":
    """<p>Deletes a replicator.</p>

    Args:
        current_version: <p>The current version of the replicator.</p>
        replicator_arn: <p>The Amazon Resource Name (ARN) of the replicator to be deleted.</p>

    Raises:
        capo_kafka.errors.bad_request_exception.BadRequestException: <p>Returns information about an error.</p>
        capo_kafka.errors.forbidden_exception.ForbiddenException: <p>Returns information about an error.</p>
        capo_kafka.errors.internal_server_error_exception.InternalServerErrorException: <p>Returns information about an error.</p>
        capo_kafka.errors.not_found_exception.NotFoundException: <p>Returns information about an error.</p>
        capo_kafka.errors.service_unavailable_exception.ServiceUnavailableException: <p>Returns information about an error.</p>
        capo_kafka.errors.too_many_requests_exception.TooManyRequestsException: <p>Returns information about an error.</p>
        capo_kafka.errors.unauthorized_exception.UnauthorizedException: <p>Returns information about an error.</p>
        capo_kafka.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_kafka.types.delete_replicator_request.DeleteReplicatorRequest]",
    ) -> OperationResponse[
        "capo_kafka.types.delete_replicator_response.DeleteReplicatorResponse"
    ]:
        import capo_kafka._operations.kafka.delete_replicator

        output, http_response = (
            capo_kafka._operations.kafka.delete_replicator.delete_replicator(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteReplicator")
    )
    input_: capo_kafka.types.delete_replicator_request.DeleteReplicatorRequest = {
        "replicator_arn": replicator_arn
    }
    if current_version is not None:
        input_["current_version"] = current_version

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