Skip to content

create_workspace_instance async

create_workspace_instance(
    managed_instance: ManagedInstanceRequest,
    *,
    config_overrides: Optional[AsyncWorkspacesInstancesClientConfig] = None,
    client_token: Optional[ClientToken] = None,
    tags: Optional[TagList] = None,
    billing_configuration: Optional[BillingConfiguration] = None,
) -> CreateWorkspaceInstanceResponse

Launches a new WorkSpace Instance with specified configuration parameters, enabling programmatic workspace deployment.

Parameters:

  • client_token (Optional[ClientToken], default: None ) –

    Unique token to ensure idempotent instance creation, preventing duplicate workspace launches.

  • tags (Optional[TagList], default: None ) –

    Optional metadata tags for categorizing and managing WorkSpaces Instances.

  • managed_instance (ManagedInstanceRequest) –

    Comprehensive configuration settings for the WorkSpaces Instance, including network, compute, and storage parameters.

  • billing_configuration (Optional[BillingConfiguration], default: None ) –

    Optional billing configuration for the WorkSpace Instance. Allows customers to specify their preferred billing mode when creating a new instance. Defaults to hourly billing if not specified.

Raises:

Source code in docs_src/capo_workspaces_instances/_services/async_workspaces_instances.py
async def create_workspace_instance(
    self,
    managed_instance: "capo_workspaces_instances.types.managed_instance_request.ManagedInstanceRequest",
    *,
    config_overrides: Optional[AsyncWorkspacesInstancesClientConfig] = None,
    client_token: Optional[
        "capo_workspaces_instances.types.client_token.ClientToken"
    ] = None,
    tags: Optional["capo_workspaces_instances.types.tag_list.TagList"] = None,
    billing_configuration: Optional[
        "capo_workspaces_instances.types.billing_configuration.BillingConfiguration"
    ] = None,
) -> "capo_workspaces_instances.types.create_workspace_instance_response.CreateWorkspaceInstanceResponse":
    """<p>Launches a new WorkSpace Instance with specified configuration parameters, enabling programmatic workspace deployment.</p>

    Args:
        client_token: <p>Unique token to ensure idempotent instance creation, preventing duplicate workspace launches.</p>
        tags: <p>Optional metadata tags for categorizing and managing WorkSpaces Instances.</p>
        managed_instance: <p>Comprehensive configuration settings for the WorkSpaces Instance, including network, compute, and storage parameters.</p>
        billing_configuration: <p>Optional billing configuration for the WorkSpace Instance. Allows customers to specify their preferred billing mode when creating a new instance. Defaults to hourly billing if not specified.</p>

    Raises:
        capo_workspaces_instances.errors.access_denied_exception.AccessDeniedException: <p>Indicates insufficient permissions to perform the requested action.</p>
        capo_workspaces_instances.errors.conflict_exception.ConflictException: <p>Signals a conflict with the current state of the resource.</p>
        capo_workspaces_instances.errors.internal_server_exception.InternalServerException: <p>Indicates an unexpected server-side error occurred.</p>
        capo_workspaces_instances.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>Indicates that a service quota has been exceeded.</p>
        capo_workspaces_instances.errors.throttling_exception.ThrottlingException: <p>Indicates the request rate has exceeded limits.</p>
        capo_workspaces_instances.errors.validation_exception.ValidationException: <p>Indicates invalid input parameters in the request.</p>
        capo_workspaces_instances.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_workspaces_instances.types.create_workspace_instance_request.CreateWorkspaceInstanceRequest]",
    ) -> AsyncOperationResponse[
        "capo_workspaces_instances.types.create_workspace_instance_response.CreateWorkspaceInstanceResponse"
    ]:
        import capo_workspaces_instances._operations.eucmi_frontend_api_service.create_workspace_instance

        (
            output,
            http_response,
        ) = await capo_workspaces_instances._operations.eucmi_frontend_api_service.create_workspace_instance.async_create_workspace_instance(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_workspaces_instances.types.create_workspace_instance_request.CreateWorkspaceInstanceRequest",
    ) -> dict[str, Any]:
        import capo_workspaces_instances.types.create_workspace_instance_request

        return capo_workspaces_instances.types.create_workspace_instance_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("CreateWorkspaceInstance", redact_input=_redact_input),
    )
    input_: capo_workspaces_instances.types.create_workspace_instance_request.CreateWorkspaceInstanceRequest = {
        "managed_instance": managed_instance
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if tags is not None:
        input_["tags"] = tags
    if billing_configuration is not None:
        input_["billing_configuration"] = billing_configuration

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