start_gui_session ¶

def start_gui_session(
    self,
    resource_name: "capo_lightsail.types.resource_name.ResourceName",
    *,
    config_overrides: Optional[LightsailClientConfig] = None,
) -> "capo_lightsail.types.start_gui_session_result.StartGUISessionResult":
    """<p>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. </p>

    Args:
        resource_name: <p>The resource name.</p>

    Raises:
        capo_lightsail.errors.access_denied_exception.AccessDeniedException: <p>Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.</p>
        capo_lightsail.errors.invalid_input_exception.InvalidInputException: <p>Lightsail throws this exception when user input does not conform to the validation rules of an input field.</p> <note> <p>Domain and distribution APIs are only available in the N. Virginia (<code>us-east-1</code>) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to <code>us-east-1</code> to create, view, or edit these resources.</p> </note>
        capo_lightsail.errors.not_found_exception.NotFoundException: <p>Lightsail throws this exception when it cannot find a resource.</p>
        capo_lightsail.errors.region_setup_in_progress_exception.RegionSetupInProgressException: <p>Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.</p>
        capo_lightsail.errors.service_exception.ServiceException: <p>A general service exception.</p>
        capo_lightsail.errors.unauthenticated_exception.UnauthenticatedException: <p>Lightsail throws this exception when the user has not been authenticated.</p>
        capo_lightsail.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_lightsail.types.start_gui_session_request.StartGUISessionRequest]",
    ) -> OperationResponse[
        "capo_lightsail.types.start_gui_session_result.StartGUISessionResult"
    ]:
        import capo_lightsail._operations.lightsail_20161128.start_gui_session

        output, http_response = (
            capo_lightsail._operations.lightsail_20161128.start_gui_session.start_gui_session(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartGUISession")
    )
    input_: capo_lightsail.types.start_gui_session_request.StartGUISessionRequest = {
        "resource_name": resource_name
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output