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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Information about a Session Manager connection to an instance.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#details ⇒ String

Reserved for future use.

Returns:

  • (String) —

    Reserved for future use.

#document_name ⇒ String

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) —

    The name of the Session Manager SSM document used to define the parameters and plugin settings for the session.

#end_date ⇒ Time

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

Returns:

  • (Time) —

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

#output_url ⇒ Types::SessionManagerOutputUrl

Reserved for future use.

Returns:

#owner ⇒ String

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

Returns:

  • (String) —

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

#session_id ⇒ String

The ID of the session.

Returns:

  • (String) —

    The ID of the session.

#start_date ⇒ Time

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

Returns:

  • (Time) —

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

#status ⇒ String

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

Possible values:

  • Connected
  • Connecting
  • Disconnected
  • Terminated
  • Terminating
  • Failed

Returns:

  • (String) —

    The status of the session.

#target ⇒ String

The instance that the Session Manager session connected to.

Returns:

  • (String) —

    The instance that the Session Manager session connected to.