WorkSpaces / Client / stop_workspaces_pool

stop_workspaces_pool¶

WorkSpaces.Client.stop_workspaces_pool(**kwargs)¶

Note

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.

Stops the specified pool.

You cannot stop a WorkSpace pool unless it has a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.

Request Syntax

response = client.stop_workspaces_pool(
    PoolId='string'
)

Parameters:

PoolId (string) –

[REQUIRED]

The identifier of the pool.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

Exceptions

WorkSpaces.Client.exceptions.InvalidParameterValuesException
WorkSpaces.Client.exceptions.InvalidResourceStateException
WorkSpaces.Client.exceptions.ResourceNotFoundException
WorkSpaces.Client.exceptions.OperationInProgressException
WorkSpaces.Client.exceptions.AccessDeniedException