AWaws-samples
Virtual Desktops

Resize virtual desktop instance type

Changed on

Modify the instance type of a DCV desktop session. The session must be in stopped state.

put/api/dcv/virtual_desktops/resize

Request

  • The document declares no server URL.
  • Auth
    socaAuth (a scheme the document does not define) and socaToken (a scheme the document does not define)

Headers

X-EDH-USERstring required
Example:john.doe

SOCA username for authentication

X-EDH-TOKENstring required
Example:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

SOCA authentication token

Request body application/x-www-form-urlencoded

session_uuidstring uuid required

UUID of the virtual desktop session to resize

instance_typestring required

New EC2 instance type for the virtual desktop

Example request

{
  "session_uuid": "12345678-1234-1234-1234-123456789abc",
  "instance_type": "m5.large"
}

Response

Virtual desktop successfully resized

successboolean
messagestring

Example response

{
  "success": true,
  "message": "Your virtual desktop has been updated"
}

Changes

  • v1058396b8f0f1Revision changes
    • info

      the endpoint scheme security socaAuth AND socaToken was added to the API

    • info

      the endpoint scheme security edhAuth AND edhToken was removed from the API

  • v16db97cead8dfRevision changes
    • info

      the endpoint scheme security edhAuth AND edhToken was added to the API

    • info

      the endpoint scheme security socaAuth AND socaToken was removed from the API