WorkSpaces / Client / stop_workspaces_pool

stop_workspaces_pool#

WorkSpaces.Client.stop_workspaces_pool(**kwargs)#

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.

See also: AWS API Documentation

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