Skip to content

cancel_import_task

cancel_import_task(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    cancel_reason: Optional[String] = None,
    dry_run: Optional[Boolean] = None,
    import_task_id: Optional[ImportTaskId] = None,
) -> CancelImportTaskResult

Cancels an in-process import virtual machine or import snapshot task.

Parameters:

  • cancel_reason (Optional[String], default: None ) –

    The reason for canceling the task.

  • dry_run (Optional[Boolean], default: None ) –

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

  • import_task_id (Optional[ImportTaskId], default: None ) –

    The ID of the import image or import snapshot task to be canceled.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def cancel_import_task(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    cancel_reason: Optional["capo_ec2.types.string.String"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    import_task_id: Optional["capo_ec2.types.import_task_id.ImportTaskId"] = None,
) -> "capo_ec2.types.cancel_import_task_result.CancelImportTaskResult":
    """<p>Cancels an in-process import virtual machine or import snapshot task.</p>

    Args:
        cancel_reason: <p>The reason for canceling the task.</p>
        dry_run: <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
        import_task_id: <p>The ID of the import image or import snapshot task to be canceled.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.cancel_import_task_request.CancelImportTaskRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.cancel_import_task_result.CancelImportTaskResult"
    ]:
        import capo_ec2._operations.amazon_ec2.cancel_import_task

        output, http_response = (
            capo_ec2._operations.amazon_ec2.cancel_import_task.cancel_import_task(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CancelImportTask")
    )
    input_: capo_ec2.types.cancel_import_task_request.CancelImportTaskRequest = {}
    if cancel_reason is not None:
        input_["cancel_reason"] = cancel_reason
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if import_task_id is not None:
        input_["import_task_id"] = import_task_id

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