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

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

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

Overview

Note:

When making an API call, you may pass SessionFilter data as a hash:

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

Describes a filter for Session Manager information.

Instance Attribute Summary collapse

Instance Attribute Details

#keyString

The name of the filter.

Returns:

  • (String)


14369
14370
14371
14372
14373
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14369

class SessionFilter < Struct.new(
  :key,
  :value)
  include Aws::Structure
end

#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

Returns:

  • (String)


14369
14370
14371
14372
14373
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14369

class SessionFilter < Struct.new(
  :key,
  :value)
  include Aws::Structure
end