Skip to content

cancel_bundle_task

Operation

cancel_bundle_task

cancel_bundle_task(request: CancelBundleTaskInput | CancelBundleTaskInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CancelBundleTaskInputDict]) -> CancelBundleTaskOutput

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

Note

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

Parameters:

Name Type Description Default
request CancelBundleTaskInput | CancelBundleTaskInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[CancelBundleTaskInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CancelBundleTaskOutput

An instance of CancelBundleTaskOutput.

cancel_bundle_task async

cancel_bundle_task(request: CancelBundleTaskInput | CancelBundleTaskInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CancelBundleTaskInputDict]) -> CancelBundleTaskOutput

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

Note

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

Parameters:

Name Type Description Default
request CancelBundleTaskInput | CancelBundleTaskInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[CancelBundleTaskInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CancelBundleTaskOutput

An instance of CancelBundleTaskOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

CancelBundleTaskInputDict

Bases: TypedDict

Dictionary form of CancelBundleTaskInput.

Attributes

bundle_id instance-attribute
bundle_id: Required[str]

The ID of the bundle task.

dry_run instance-attribute
dry_run: bool | 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.

CancelBundleTaskInput dataclass

Bases: _SerdeShape

Contains the parameters for CancelBundleTask.

Attributes

bundle_id class-attribute instance-attribute
bundle_id: str | None = ...

The ID of the bundle task.

dry_run class-attribute instance-attribute
dry_run: bool | 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.

Output

CancelBundleTaskOutput dataclass

Bases: _SerdeShape

Contains the output of CancelBundleTask.

Attributes

bundle_task class-attribute instance-attribute
bundle_task: BundleTask | None = ...

Information about the bundle task.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.