AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Initiates a graphical user interface (GUI) session that’s used to access a virtual computer’s operating system and application. The session will be active for 1 hour. Use this action to resume the session after it expires.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to StartGUISessionAsync.

Namespace: Amazon.Lightsail
Assembly: AWSSDK.Lightsail.dll
Version: 3.x.y.z

Syntax

C#
public virtual StartGUISessionResponse StartGUISession(
         StartGUISessionRequest request
)

Parameters

request
Type: Amazon.Lightsail.Model.StartGUISessionRequest

Container for the necessary parameters to execute the StartGUISession service method.

Return Value


The response from the StartGUISession service method, as returned by Lightsail.

Exceptions

ExceptionCondition
AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field. Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException Lightsail throws this exception when it cannot find a resource.
ServiceException A general service exception.
UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

See Also