Module Values_1.StartSessionResponseSource

Initiates a connection to a target (for example, a managed node) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs. Amazon Web Services CLI usage: start-session is an interactive command that requires the Session Manager plugin to be installed on the client machine making the call. For information, see Install the Session Manager plugin for the Amazon Web Services CLI in the Amazon Web Services Systems Manager User Guide. Amazon Web Services Tools for PowerShell usage: Start-SSMSession isn't currently supported by Amazon Web Services Tools for PowerShell on Windows local machines.

Sourcetype nonrec t = {
  1. sessionId : SessionId.t option;
    (*

    The ID of the session.

    *)
  2. tokenValue : TokenValue.t option;
    (*

    An encrypted token value containing session and caller information. This token is used to authenticate the connection to the managed node, and is valid only long enough to ensure the connection is successful. Never share your session's token.

    *)
  3. streamUrl : StreamUrl.t option;
    (*

    A URL back to SSM Agent on the managed node that the Session Manager client uses to send commands and receive output from the node. Format: wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output) region represents the Region identifier for an Amazon Web Services Region supported by Amazon Web Services Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference. session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE.

    *)
}
Sourcetype nonrec error = [
  1. | `InternalServerError of Values_0.InternalServerError.t
  2. | `InvalidDocument of Values_0.InvalidDocument.t
  3. | `TargetNotConnected of TargetNotConnected.t
  4. | `Unknown_operation_error of string * string option
]
Sourceval make : ?sessionId:??? -> ?tokenValue:??? -> ?streamUrl:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `InternalServerError of Values_0.InternalServerError.t | `InvalidDocument of Values_0.InvalidDocument.t | `TargetNotConnected of TargetNotConnected.t | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `InternalServerError of Values_0.InternalServerError.t | `InvalidDocument of Values_0.InvalidDocument.t | `TargetNotConnected of TargetNotConnected.t | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `String of SessionId.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t