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

Class: Aws::SSM::Types::DescribeSessionsRequest

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 DescribeSessionsRequest data as a hash:

{
  state: "Active", # required, accepts Active, History
  max_results: 1,
  next_token: "NextToken",
  filters: [
    {
      key: "InvokedAfter", # required, accepts InvokedAfter, InvokedBefore, Target, Owner, Status
      value: "SessionFilterValue", # required
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#filtersArray<Types::SessionFilter>

One or more filters to limit the type of sessions returned by the request.

Returns:



5214
5215
5216
5217
5218
5219
5220
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5214

class DescribeSessionsRequest < Struct.new(
  :state,
  :max_results,
  :next_token,
  :filters)
  include Aws::Structure
end

#max_resultsInteger

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Returns:

  • (Integer)


5214
5215
5216
5217
5218
5219
5220
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5214

class DescribeSessionsRequest < Struct.new(
  :state,
  :max_results,
  :next_token,
  :filters)
  include Aws::Structure
end

#next_tokenString

The token for the next set of items to return. (You received this token from a previous call.)

Returns:

  • (String)


5214
5215
5216
5217
5218
5219
5220
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5214

class DescribeSessionsRequest < Struct.new(
  :state,
  :max_results,
  :next_token,
  :filters)
  include Aws::Structure
end

#stateString

The session status to retrieve a list of sessions for. For example, "Active".

Returns:

  • (String)


5214
5215
5216
5217
5218
5219
5220
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5214

class DescribeSessionsRequest < Struct.new(
  :state,
  :max_results,
  :next_token,
  :filters)
  include Aws::Structure
end