Skip to content

delete_relay

delete_relay(
    relay_id: RelayId, *, config_overrides: Optional[MailManagerClientConfig] = None
) -> DeleteRelayResponse

Deletes an existing relay resource.

Parameters:

  • relay_id (RelayId) –

    The unique relay identifier.

Raises:

Source code in docs_src/capo_mailmanager/_services/mail_manager.py
def delete_relay(
    self,
    relay_id: "capo_mailmanager.types.relay_id.RelayId",
    *,
    config_overrides: Optional[MailManagerClientConfig] = None,
) -> "capo_mailmanager.types.delete_relay_response.DeleteRelayResponse":
    """<p>Deletes an existing relay resource.</p>

    Args:
        relay_id: <p>The unique relay identifier.</p>

    Raises:
        capo_mailmanager.errors.conflict_exception.ConflictException: <p>The request configuration has conflicts. For details, see the accompanying error message.</p>
        capo_mailmanager.errors.resource_not_found_exception.ResourceNotFoundException: <p>Occurs when a requested resource is not found.</p>
        capo_mailmanager.errors.validation_exception.ValidationException: <p>The request validation has failed. For details, see the accompanying error message.</p>
        capo_mailmanager.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_mailmanager.types.delete_relay_request.DeleteRelayRequest]",
    ) -> OperationResponse[
        "capo_mailmanager.types.delete_relay_response.DeleteRelayResponse"
    ]:
        import capo_mailmanager._operations.mail_manager_svc.delete_relay

        output, http_response = (
            capo_mailmanager._operations.mail_manager_svc.delete_relay.delete_relay(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteRelay")
    )
    input_: capo_mailmanager.types.delete_relay_request.DeleteRelayRequest = {
        "relay_id": relay_id
    }

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