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

Class: Aws::SSM::Types::SessionFilter

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

Overview

Note:

When passing SessionFilter as input to an Aws::Client method, you can use a vanilla Hash:

{
  key: "InvokedAfter", # required, accepts InvokedAfter, InvokedBefore, Target, Owner, Status, SessionId
  value: "SessionFilterValue", # required
}

Describes a filter for Session Manager information.

Instance Attribute Summary collapse

Instance Attribute Details

#keyString

The name of the filter.

Possible values:

  • InvokedAfter
  • InvokedBefore
  • Target
  • Owner
  • Status
  • SessionId

Returns:

  • (String)

    The name of the filter.

#valueString

The filter value. Valid values for each filter key are as follows:

  • InvokedAfter: Specify a timestamp to limit your results. For example, specify 2018-08-29T00:00:00Z to see sessions that started August 29, 2018, and later.

  • InvokedBefore: Specify a timestamp to limit your results. For example, specify 2018-08-29T00:00:00Z to see sessions that started before August 29, 2018.

  • Target: Specify an instance to which session connections have been made.

  • Owner: Specify an AWS user account to see a list of sessions started by that user.

  • Status: Specify a valid session status to see a list of all sessions with that status. Status values you can specify include:

    • Connected

    • Connecting

    • Disconnected

    • Terminated

    • Terminating

    • Failed

  • SessionId: Specify a session ID to return details about the session.

Returns:

  • (String)

    The filter value.