rebuild_workspaces `async` ¶

rebuild_workspaces(
    rebuild_workspace_requests: RebuildWorkspaceRequests,
    *,
    config_overrides: Optional[AsyncWorkSpacesClientConfig] = None,
) -> RebuildWorkspacesResult

Rebuilds the specified WorkSpace.

You cannot rebuild a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, STOPPED, or REBOOTING.

Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Rebuild a WorkSpace.

This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.

Parameters:

rebuild_workspace_requests (RebuildWorkspaceRequests) –

The WorkSpace to rebuild. You can specify a single WorkSpace.

Raises:

OperationNotSupportedException –

This operation is not supported.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_workspaces/_services/async_work_spaces.py

async def rebuild_workspaces(
    self,
    rebuild_workspace_requests: "capo_workspaces.types.rebuild_workspace_requests.RebuildWorkspaceRequests",
    *,
    config_overrides: Optional[AsyncWorkSpacesClientConfig] = None,
) -> "capo_workspaces.types.rebuild_workspaces_result.RebuildWorkspacesResult":
    """<p>Rebuilds the specified WorkSpace.</p> <p>You cannot rebuild a WorkSpace unless its state is <code>AVAILABLE</code>, <code>ERROR</code>, <code>UNHEALTHY</code>, <code>STOPPED</code>, or <code>REBOOTING</code>.</p> <p>Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/reset-workspace.html">Rebuild a WorkSpace</a>.</p> <p>This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.</p>

    Args:
        rebuild_workspace_requests: <p>The WorkSpace to rebuild. You can specify a single WorkSpace.</p>

    Raises:
        capo_workspaces.errors.operation_not_supported_exception.OperationNotSupportedException: <p>This operation is not supported.</p>
        capo_workspaces.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_workspaces.types.rebuild_workspaces_request.RebuildWorkspacesRequest]",
    ) -> AsyncOperationResponse[
        "capo_workspaces.types.rebuild_workspaces_result.RebuildWorkspacesResult"
    ]:
        import capo_workspaces._operations.workspaces_service.rebuild_workspaces

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("RebuildWorkspaces")
    )
    input_: capo_workspaces.types.rebuild_workspaces_request.RebuildWorkspacesRequest = {
        "rebuild_workspace_requests": rebuild_workspace_requests
    }

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

rebuild_workspaces async ¶

rebuild_workspaces `async` ¶