Class: Aws::SSM::Types::StartSessionResponse

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-ssm/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#session_idString

The ID of the session.

Returns:

  • (String)

19541
19542
19543
19544
19545
19546
19547
# File 'lib/aws-sdk-ssm/types.rb', line 19541

class StartSessionResponse < Struct.new(
  :session_id,
  :token_value,
  :stream_url)
  SENSITIVE = []
  include Aws::Structure
end

#stream_urlString

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`.

[1]: docs.aws.amazon.com/general/latest/gr/ssm.html#ssm_region

Returns:

  • (String)

19541
19542
19543
19544
19545
19546
19547
# File 'lib/aws-sdk-ssm/types.rb', line 19541

class StartSessionResponse < Struct.new(
  :session_id,
  :token_value,
  :stream_url)
  SENSITIVE = []
  include Aws::Structure
end

#token_valueString

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.

Returns:

  • (String)

19541
19542
19543
19544
19545
19546
19547
# File 'lib/aws-sdk-ssm/types.rb', line 19541

class StartSessionResponse < Struct.new(
  :session_id,
  :token_value,
  :stream_url)
  SENSITIVE = []
  include Aws::Structure
end