Lightsail / Client / create_gui_session_access_details



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

Use StartGUISession to open the session.

See also: AWS API Documentation

Request Syntax

response = client.create_gui_session_access_details(

resourceName (string) –


The resource name.

Return type:



Response Syntax

    'resourceName': 'string',
    'status': 'startExpired'|'notStarted'|'started'|'starting'|'stopped'|'stopping'|'settingUpInstance'|'failedInstanceCreation'|'failedStartingGUISession'|'failedStoppingGUISession',
    'percentageComplete': 123,
    'failureReason': 'string',
    'sessions': [
            'name': 'string',
            'url': 'string',
            'isPrimary': True|False

Response Structure

  • (dict) –

    • resourceName (string) –

      The resource name.

    • status (string) –

      The status of the operation.

    • percentageComplete (integer) –

      The percentage of completion for the operation.

    • failureReason (string) –

      The reason the operation failed.

    • sessions (list) –

      Returns information about the specified NICE DCV GUI session.

      • (dict) –

        Describes a web-based, remote graphical user interface (GUI), NICE DCV session. The session is used to access a virtual computer’s operating system or application.

        • name (string) –

          The session name.

        • url (string) –

          The session URL.

        • isPrimary (boolean) –

          When true, this Boolean value indicates the primary session for the specified resource.


  • Lightsail.Client.exceptions.AccessDeniedException

  • Lightsail.Client.exceptions.InvalidInputException

  • Lightsail.Client.exceptions.NotFoundException

  • Lightsail.Client.exceptions.ServiceException

  • Lightsail.Client.exceptions.UnauthenticatedException