Skip to content

create_workspaces_pool async

create_workspaces_pool(
    pool_name: WorkspacesPoolName,
    description: UpdateDescription,
    bundle_id: BundleId,
    directory_id: DirectoryId,
    capacity: Capacity,
    *,
    config_overrides: Optional[AsyncWorkSpacesClientConfig] = None,
    tags: Optional[TagList] = None,
    application_settings: Optional[ApplicationSettingsRequest] = None,
    timeout_settings: Optional[TimeoutSettings] = None,
    running_mode: Optional[PoolsRunningMode] = None,
) -> CreateWorkspacesPoolResult

End of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools. After December 31, 2027, you will no longer be able to access the Amazon WorkSpaces Pools console or Amazon WorkSpaces Pools resources. For more information, see Amazon WorkSpaces Pools end of support.

Creates a pool of WorkSpaces.

Parameters:

Raises:

Source code in docs_src/capo_workspaces/_services/async_work_spaces.py
async def create_workspaces_pool(
    self,
    pool_name: "capo_workspaces.types.workspaces_pool_name.WorkspacesPoolName",
    description: "capo_workspaces.types.update_description.UpdateDescription",
    bundle_id: "capo_workspaces.types.bundle_id.BundleId",
    directory_id: "capo_workspaces.types.directory_id.DirectoryId",
    capacity: "capo_workspaces.types.capacity.Capacity",
    *,
    config_overrides: Optional[AsyncWorkSpacesClientConfig] = None,
    tags: Optional["capo_workspaces.types.tag_list.TagList"] = None,
    application_settings: Optional[
        "capo_workspaces.types.application_settings_request.ApplicationSettingsRequest"
    ] = None,
    timeout_settings: Optional[
        "capo_workspaces.types.timeout_settings.TimeoutSettings"
    ] = None,
    running_mode: Optional[
        "capo_workspaces.types.pools_running_mode.PoolsRunningMode"
    ] = None,
) -> (
    "capo_workspaces.types.create_workspaces_pool_result.CreateWorkspacesPoolResult"
):
    """<note> <p>End of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools. After December 31, 2027, you will no longer be able to access the Amazon WorkSpaces Pools console or Amazon WorkSpaces Pools resources. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/wsp-pools-end-of-support.html">Amazon WorkSpaces Pools end of support</a>. </p> </note> <p>Creates a pool of WorkSpaces.</p>

    Args:
        pool_name: <p>The name of the pool.</p>
        description: <p>The pool description.</p>
        bundle_id: <p>The identifier of the bundle for the pool.</p>
        directory_id: <p>The identifier of the directory for the pool.</p>
        capacity: <p>The user capacity of the pool.</p>
        tags: <p>The tags for the pool.</p>
        application_settings: <p>Indicates the application settings of the pool.</p>
        timeout_settings: <p>Indicates the timeout settings of the pool.</p>
        running_mode: <p>The running mode for the pool.</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.operation_not_supported_exception.OperationNotSupportedException: <p>This operation is not supported.</p>
        capo_workspaces.errors.resource_already_exists_exception.ResourceAlreadyExistsException: <p>The specified resource already exists.</p>
        capo_workspaces.errors.resource_limit_exceeded_exception.ResourceLimitExceededException: <p>Your resource limits have been exceeded.</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.create_workspaces_pool_request.CreateWorkspacesPoolRequest]",
    ) -> AsyncOperationResponse[
        "capo_workspaces.types.create_workspaces_pool_result.CreateWorkspacesPoolResult"
    ]:
        import capo_workspaces._operations.workspaces_service.create_workspaces_pool

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateWorkspacesPool")
    )
    input_: capo_workspaces.types.create_workspaces_pool_request.CreateWorkspacesPoolRequest = {
        "pool_name": pool_name,
        "description": description,
        "bundle_id": bundle_id,
        "directory_id": directory_id,
        "capacity": capacity,
    }
    if tags is not None:
        input_["tags"] = tags
    if application_settings is not None:
        input_["application_settings"] = application_settings
    if timeout_settings is not None:
        input_["timeout_settings"] = timeout_settings
    if running_mode is not None:
        input_["running_mode"] = running_mode

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