AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::SSM::Types::Session

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

Overview

Information about a Session Manager connection to a managed node.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#detailsString

Reserved for future use.

Returns:

  • (String)


18458
18459
18460
18461
18462
18463
18464
18465
18466
18467
18468
18469
18470
18471
18472
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 18458

class Session < Struct.new(
  :session_id,
  :target,
  :status,
  :start_date,
  :end_date,
  :document_name,
  :owner,
  :reason,
  :details,
  :output_url,
  :max_session_duration)
  SENSITIVE = []
  include Aws::Structure
end

#document_nameString

The name of the Session Manager SSM document used to define the parameters and plugin settings for the session. For example, SSM-SessionManagerRunShell.

Returns:

  • (String)


18458
18459
18460
18461
18462
18463
18464
18465
18466
18467
18468
18469
18470
18471
18472
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 18458

class Session < Struct.new(
  :session_id,
  :target,
  :status,
  :start_date,
  :end_date,
  :document_name,
  :owner,
  :reason,
  :details,
  :output_url,
  :max_session_duration)
  SENSITIVE = []
  include Aws::Structure
end

#end_dateTime

The date and time, in ISO-8601 Extended format, when the session was terminated.

Returns:

  • (Time)


18458
18459
18460
18461
18462
18463
18464
18465
18466
18467
18468
18469
18470
18471
18472
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 18458

class Session < Struct.new(
  :session_id,
  :target,
  :status,
  :start_date,
  :end_date,
  :document_name,
  :owner,
  :reason,
  :details,
  :output_url,
  :max_session_duration)
  SENSITIVE = []
  include Aws::Structure
end

#max_session_durationString

The maximum duration of a session before it terminates.

Returns:

  • (String)


18458
18459
18460
18461
18462
18463
18464
18465
18466
18467
18468
18469
18470
18471
18472
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 18458

class Session < Struct.new(
  :session_id,
  :target,
  :status,
  :start_date,
  :end_date,
  :document_name,
  :owner,
  :reason,
  :details,
  :output_url,
  :max_session_duration)
  SENSITIVE = []
  include Aws::Structure
end

#output_urlTypes::SessionManagerOutputUrl

Reserved for future use.



18458
18459
18460
18461
18462
18463
18464
18465
18466
18467
18468
18469
18470
18471
18472
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 18458

class Session < Struct.new(
  :session_id,
  :target,
  :status,
  :start_date,
  :end_date,
  :document_name,
  :owner,
  :reason,
  :details,
  :output_url,
  :max_session_duration)
  SENSITIVE = []
  include Aws::Structure
end

#ownerString

The ID of the Amazon Web Services user account that started the session.

Returns:

  • (String)


18458
18459
18460
18461
18462
18463
18464
18465
18466
18467
18468
18469
18470
18471
18472
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 18458

class Session < Struct.new(
  :session_id,
  :target,
  :status,
  :start_date,
  :end_date,
  :document_name,
  :owner,
  :reason,
  :details,
  :output_url,
  :max_session_duration)
  SENSITIVE = []
  include Aws::Structure
end

#reasonString

The reason for connecting to the instance.

Returns:

  • (String)


18458
18459
18460
18461
18462
18463
18464
18465
18466
18467
18468
18469
18470
18471
18472
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 18458

class Session < Struct.new(
  :session_id,
  :target,
  :status,
  :start_date,
  :end_date,
  :document_name,
  :owner,
  :reason,
  :details,
  :output_url,
  :max_session_duration)
  SENSITIVE = []
  include Aws::Structure
end

#session_idString

The ID of the session.

Returns:

  • (String)


18458
18459
18460
18461
18462
18463
18464
18465
18466
18467
18468
18469
18470
18471
18472
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 18458

class Session < Struct.new(
  :session_id,
  :target,
  :status,
  :start_date,
  :end_date,
  :document_name,
  :owner,
  :reason,
  :details,
  :output_url,
  :max_session_duration)
  SENSITIVE = []
  include Aws::Structure
end

#start_dateTime

The date and time, in ISO-8601 Extended format, when the session began.

Returns:

  • (Time)


18458
18459
18460
18461
18462
18463
18464
18465
18466
18467
18468
18469
18470
18471
18472
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 18458

class Session < Struct.new(
  :session_id,
  :target,
  :status,
  :start_date,
  :end_date,
  :document_name,
  :owner,
  :reason,
  :details,
  :output_url,
  :max_session_duration)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The status of the session. For example, "Connected" or "Terminated".

Returns:

  • (String)


18458
18459
18460
18461
18462
18463
18464
18465
18466
18467
18468
18469
18470
18471
18472
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 18458

class Session < Struct.new(
  :session_id,
  :target,
  :status,
  :start_date,
  :end_date,
  :document_name,
  :owner,
  :reason,
  :details,
  :output_url,
  :max_session_duration)
  SENSITIVE = []
  include Aws::Structure
end

#targetString

The managed node that the Session Manager session connected to.

Returns:

  • (String)


18458
18459
18460
18461
18462
18463
18464
18465
18466
18467
18468
18469
18470
18471
18472
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 18458

class Session < Struct.new(
  :session_id,
  :target,
  :status,
  :start_date,
  :end_date,
  :document_name,
  :owner,
  :reason,
  :details,
  :output_url,
  :max_session_duration)
  SENSITIVE = []
  include Aws::Structure
end