WorkSpaces / Client / stop_workspaces
stop_workspaces#
- WorkSpaces.Client.stop_workspaces(**kwargs)#
Stops the specified WorkSpaces.
You cannot stop a WorkSpace unless it has a running mode of
AutoStop
and a state ofAVAILABLE
,IMPAIRED
,UNHEALTHY
, orERROR
.See also: AWS API Documentation
Request Syntax
response = client.stop_workspaces( StopWorkspaceRequests=[ { 'WorkspaceId': 'string' }, ] )
- Parameters:
StopWorkspaceRequests (list) –
[REQUIRED]
The WorkSpaces to stop. You can specify up to 25 WorkSpaces.
(dict) –
Describes the information used to stop a WorkSpace.
WorkspaceId (string) –
The identifier of the WorkSpace.
- Return type:
dict
- Returns:
Response Syntax
{ 'FailedRequests': [ { 'WorkspaceId': 'string', 'ErrorCode': 'string', 'ErrorMessage': 'string' }, ] }
Response Structure
(dict) –
FailedRequests (list) –
Information about the WorkSpaces that could not be stopped.
(dict) –
Describes a WorkSpace that could not be rebooted. ( RebootWorkspaces), rebuilt ( RebuildWorkspaces), restored ( RestoreWorkspace), terminated ( TerminateWorkspaces), started ( StartWorkspaces), or stopped ( StopWorkspaces).
WorkspaceId (string) –
The identifier of the WorkSpace.
ErrorCode (string) –
The error code that is returned if the WorkSpace cannot be rebooted.
ErrorMessage (string) –
The text of the error message that is returned if the WorkSpace cannot be rebooted.