Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateGUISessionAccessDetails

Creates two URLs that are used to access a virtual computer’s graphical user interface (GUI) session. The primary URL initiates a web-based Amazon DCV session to the virtual computer's application. The secondary URL initiates a web-based Amazon DCV session to the virtual computer's operating session.

Use StartGUISession to open the session.

Request Syntax


{
   "resourceName": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

resourceName

The resource name.

Type: String

Pattern: \w[\w\-]*\w

Required: Yes

Response Syntax


{
   "failureReason": "string",
   "percentageComplete": number,
   "resourceName": "string",
   "sessions": [ 
      { 
         "isPrimary": boolean,
         "name": "string",
         "url": "string"
      }
   ],
   "status": "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.

failureReason

The reason the operation failed.

Type: String

percentageComplete

The percentage of completion for the operation.

Type: Integer

resourceName

The resource name.

Type: String

Pattern: \w[\w\-]*\w

sessions

Returns information about the specified Amazon DCV GUI session.

Type: Array of Session objects

status

The status of the operation.

Type: String

Errors

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

AccessDeniedException

Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

HTTP Status Code: 400

InvalidInputException

Lightsail throws this exception when user input does not conform to the validation rules of an input field.

Note

Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

HTTP Status Code: 400

NotFoundException

Lightsail throws this exception when it cannot find a resource.

HTTP Status Code: 400

RegionSetupInProgressException

Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.

docs: Regions and Availability Zones for Lightsail
tip: Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.

HTTP Status Code: 400

ServiceException

A general service exception.

HTTP Status Code: 500

UnauthenticatedException

Lightsail throws this exception when the user has not been authenticated.

HTTP Status Code: 400