Skip to content

delete_workspace_bundle async

delete_workspace_bundle(
    *,
    config_overrides: Optional[AsyncWorkSpacesClientConfig] = None,
    bundle_id: Optional[BundleId] = None,
) -> DeleteWorkspaceBundleResult

Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see Delete a Custom WorkSpaces Bundle or Image.

Parameters:

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

    The identifier of the bundle.

Raises:

Source code in docs_src/capo_workspaces/_services/async_work_spaces.py
async def delete_workspace_bundle(
    self,
    *,
    config_overrides: Optional[AsyncWorkSpacesClientConfig] = None,
    bundle_id: Optional["capo_workspaces.types.bundle_id.BundleId"] = None,
) -> "capo_workspaces.types.delete_workspace_bundle_result.DeleteWorkspaceBundleResult":
    """<p>Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/delete_bundle.html"> Delete a Custom WorkSpaces Bundle or Image</a>.</p>

    Args:
        bundle_id: <p>The identifier of the bundle.</p>

    Raises:
        capo_workspaces.errors.access_denied_exception.AccessDeniedException: <p>The user is not authorized to access a resource.</p>
        capo_workspaces.errors.invalid_parameter_values_exception.InvalidParameterValuesException: <p>One or more parameter values are not valid.</p>
        capo_workspaces.errors.resource_associated_exception.ResourceAssociatedException: <p>The resource is associated with a directory.</p>
        capo_workspaces.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource could not be found.</p>
        capo_workspaces.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_workspaces.types.delete_workspace_bundle_request.DeleteWorkspaceBundleRequest]",
    ) -> AsyncOperationResponse[
        "capo_workspaces.types.delete_workspace_bundle_result.DeleteWorkspaceBundleResult"
    ]:
        import capo_workspaces._operations.workspaces_service.delete_workspace_bundle

        (
            output,
            http_response,
        ) = await capo_workspaces._operations.workspaces_service.delete_workspace_bundle.async_delete_workspace_bundle(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteWorkspaceBundle")
    )
    input_: capo_workspaces.types.delete_workspace_bundle_request.DeleteWorkspaceBundleRequest = {}
    if bundle_id is not None:
        input_["bundle_id"] = bundle_id

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output