Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

StopWorkspaces

Stops the specified WorkSpaces.

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

Request Syntax


{
   "StopWorkspaceRequests": [ 
      { 
         "WorkspaceId": "string"
      }
   ]
}

Request Parameters

The request accepts the following data in JSON format.

StopWorkspaceRequests

The WorkSpaces to stop. You can specify up to 25 WorkSpaces.

Type: Array of StopRequest objects

Array Members: Minimum number of 1 item. Maximum number of 25 items.

Required: Yes

Response Syntax


{
   "FailedRequests": [ 
      { 
         "ErrorCode": "string",
         "ErrorMessage": "string",
         "WorkspaceId": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

FailedRequests

Information about the WorkSpaces that could not be stopped.

Type: Array of FailedWorkspaceChangeRequest objects

Errors

For information about the errors that are common to all actions, see Common Errors.