Skip to content

cancel_bundle_task

cancel_bundle_task(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    bundle_id: Optional[BundleId] = None,
    dry_run: Optional[Boolean] = None,
) -> CancelBundleTaskResult

Cancels a bundling operation for an instance store-backed Windows instance.

CancelBundleTask is no longer supported because BundleInstance, the operation it cancels, is no longer supported.

Parameters:

  • bundle_id (Optional[BundleId], default: None ) –

    The ID of the bundle 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.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def cancel_bundle_task(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    bundle_id: Optional["capo_ec2.types.bundle_id.BundleId"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.cancel_bundle_task_result.CancelBundleTaskResult":
    """<p>Cancels a bundling operation for an instance store-backed Windows instance.</p> <note> <p>CancelBundleTask is no longer supported because <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_BundleInstance.html">BundleInstance</a>, the operation it cancels, is no longer supported.</p> </note>

    Args:
        bundle_id: <p>The ID of the bundle 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>

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

    def _handler(
        req: "OperationRequest[capo_ec2.types.cancel_bundle_task_request.CancelBundleTaskRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.cancel_bundle_task_result.CancelBundleTaskResult"
    ]:
        import capo_ec2._operations.amazon_ec2.cancel_bundle_task

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

    def _redact_output(
        output: "capo_ec2.types.cancel_bundle_task_result.CancelBundleTaskResult",
    ) -> dict[str, Any]:
        import capo_ec2.types.cancel_bundle_task_result

        return capo_ec2.types.cancel_bundle_task_result.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("CancelBundleTask", redact_output=_redact_output),
    )
    input_: capo_ec2.types.cancel_bundle_task_request.CancelBundleTaskRequest = {}
    if bundle_id is not None:
        input_["bundle_id"] = bundle_id
    if dry_run is not None:
        input_["dry_run"] = dry_run

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