Skip to content

delete_task

delete_task(
    task_arn: TaskArn, *, config_overrides: Optional[DataSyncClientConfig] = None
) -> DeleteTaskResponse

Deletes a transfer task resource from DataSync.

Parameters:

  • task_arn (TaskArn) –

    Specifies the Amazon Resource Name (ARN) of the task that you want to delete.

Raises:

Source code in docs_src/capo_datasync/_services/data_sync.py
def delete_task(
    self,
    task_arn: "capo_datasync.types.task_arn.TaskArn",
    *,
    config_overrides: Optional[DataSyncClientConfig] = None,
) -> "capo_datasync.types.delete_task_response.DeleteTaskResponse":
    """<p>Deletes a transfer task resource from DataSync.</p>

    Args:
        task_arn: <p>Specifies the Amazon Resource Name (ARN) of the task that you want to delete.</p>

    Raises:
        capo_datasync.errors.internal_exception.InternalException: <p>This exception is thrown when an error occurs in the DataSync service.</p>
        capo_datasync.errors.invalid_request_exception.InvalidRequestException: <p>This exception is thrown when the client submits a malformed request.</p>
        capo_datasync.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_datasync.types.delete_task_request.DeleteTaskRequest]",
    ) -> OperationResponse[
        "capo_datasync.types.delete_task_response.DeleteTaskResponse"
    ]:
        import capo_datasync._operations.fmrs_service.delete_task

        output, http_response = (
            capo_datasync._operations.fmrs_service.delete_task.delete_task(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteTask")
    )
    input_: capo_datasync.types.delete_task_request.DeleteTaskRequest = {
        "task_arn": task_arn
    }

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