Describe Sessions

ssm_describe_sessions

R Documentation

Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days

Description

Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.

Usage

ssm_describe_sessions(State, MaxResults, NextToken, Filters)

Arguments

State

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

MaxResults

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.

NextToken

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

Filters

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

Value

A list with the following syntax:

list(
  Sessions = list(
    list(
      SessionId = "string",
      Target = "string",
      Status = "Connected"|"Connecting"|"Disconnected"|"Terminated"|"Terminating"|"Failed",
      StartDate = as.POSIXct(
        "2015-01-01"
      ),
      EndDate = as.POSIXct(
        "2015-01-01"
      ),
      DocumentName = "string",
      Owner = "string",
      Reason = "string",
      Details = "string",
      OutputUrl = list(
        S3OutputUrl = "string",
        CloudWatchOutputUrl = "string"
      ),
      MaxSessionDuration = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_sessions(
  State = "Active"|"History",
  MaxResults = 123,
  NextToken = "string",
  Filters = list(
    list(
      key = "InvokedAfter"|"InvokedBefore"|"Target"|"Owner"|"Status"|"SessionId",
      value = "string"
    )
  )
)