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

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 an instance.

Instance Attribute Summary collapse

Instance Attribute Details

#detailsString

Reserved for future use.

Returns:

  • (String)


12420
12421
12422
12423
12424
12425
12426
12427
12428
12429
12430
12431
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12420

class Session < Struct.new(
  :session_id,
  :target,
  :status,
  :start_date,
  :end_date,
  :document_name,
  :owner,
  :details,
  :output_url)
  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)


12420
12421
12422
12423
12424
12425
12426
12427
12428
12429
12430
12431
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12420

class Session < Struct.new(
  :session_id,
  :target,
  :status,
  :start_date,
  :end_date,
  :document_name,
  :owner,
  :details,
  :output_url)
  include Aws::Structure
end

#end_dateTime

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

Returns:

  • (Time)


12420
12421
12422
12423
12424
12425
12426
12427
12428
12429
12430
12431
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12420

class Session < Struct.new(
  :session_id,
  :target,
  :status,
  :start_date,
  :end_date,
  :document_name,
  :owner,
  :details,
  :output_url)
  include Aws::Structure
end

#output_urlTypes::SessionManagerOutputUrl

Reserved for future use.



12420
12421
12422
12423
12424
12425
12426
12427
12428
12429
12430
12431
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12420

class Session < Struct.new(
  :session_id,
  :target,
  :status,
  :start_date,
  :end_date,
  :document_name,
  :owner,
  :details,
  :output_url)
  include Aws::Structure
end

#ownerString

The ID of the AWS user account that started the session.

Returns:

  • (String)


12420
12421
12422
12423
12424
12425
12426
12427
12428
12429
12430
12431
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12420

class Session < Struct.new(
  :session_id,
  :target,
  :status,
  :start_date,
  :end_date,
  :document_name,
  :owner,
  :details,
  :output_url)
  include Aws::Structure
end

#session_idString

The ID of the session.

Returns:

  • (String)


12420
12421
12422
12423
12424
12425
12426
12427
12428
12429
12430
12431
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12420

class Session < Struct.new(
  :session_id,
  :target,
  :status,
  :start_date,
  :end_date,
  :document_name,
  :owner,
  :details,
  :output_url)
  include Aws::Structure
end

#start_dateTime

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

Returns:

  • (Time)


12420
12421
12422
12423
12424
12425
12426
12427
12428
12429
12430
12431
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12420

class Session < Struct.new(
  :session_id,
  :target,
  :status,
  :start_date,
  :end_date,
  :document_name,
  :owner,
  :details,
  :output_url)
  include Aws::Structure
end

#statusString

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

Returns:

  • (String)


12420
12421
12422
12423
12424
12425
12426
12427
12428
12429
12430
12431
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12420

class Session < Struct.new(
  :session_id,
  :target,
  :status,
  :start_date,
  :end_date,
  :document_name,
  :owner,
  :details,
  :output_url)
  include Aws::Structure
end

#targetString

The instance that the Session Manager session connected to.

Returns:

  • (String)


12420
12421
12422
12423
12424
12425
12426
12427
12428
12429
12430
12431
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12420

class Session < Struct.new(
  :session_id,
  :target,
  :status,
  :start_date,
  :end_date,
  :document_name,
  :owner,
  :details,
  :output_url)
  include Aws::Structure
end