You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#session_idString

The ID of the session.

Returns:

  • (String)


14607
14608
14609
14610
14611
14612
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14607

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

#stream_urlString

A URL back to SSM Agent on the instance that the Session Manager client uses to send commands and receive output from the instance. Format: wss://ssm-messages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output)

region represents the Region identifier for an AWS Region supported by AWS 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 the AWS Systems Manager table of regions and endpoints in the AWS General Reference.

session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE.

Returns:

  • (String)


14607
14608
14609
14610
14611
14612
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14607

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

#token_valueString

An encrypted token value containing session and caller information. Used to authenticate the connection to the instance.

Returns:

  • (String)


14607
14608
14609
14610
14611
14612
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14607

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