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

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

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

Overview

Note:

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

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#filters ⇒ Array<Types::SessionFilter>

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

Returns:

  • (Array<Types::SessionFilter>) —

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

#max_results ⇒ Integer

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

    The maximum number of items to return for this call.

#next_token ⇒ String

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

Returns:

  • (String) —

    The token for the next set of items to return.

#state ⇒ String

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

Possible values:

  • Active
  • History

Returns:

  • (String) —

    The session status to retrieve a list of sessions for.