Skip to content

List Sessions

emrserverless_list_sessions R Documentation

Lists sessions for the specified application

Description

Lists sessions for the specified application. You can filter sessions by state and creation time.

Usage

emrserverless_list_sessions(applicationId, nextToken, maxResults,
  states, createdAtAfter, createdAtBefore)

Arguments

applicationId

[required] The ID of the application to list sessions for.

nextToken

The token for the next set of session results.

maxResults

The maximum number of sessions to return in each page of results.

states

An optional filter for session states. Note that if this filter contains multiple states, the resulting list will be grouped by the state.

createdAtAfter

The lower bound of the option to filter by creation date and time.

createdAtBefore

The upper bound of the option to filter by creation date and time.

Value

A list with the following syntax:

list(
  sessions = list(
    list(
      applicationId = "string",
      sessionId = "string",
      arn = "string",
      name = "string",
      state = "SUBMITTED"|"STARTING"|"STARTED"|"IDLE"|"BUSY"|"FAILED"|"TERMINATING"|"TERMINATED",
      stateDetails = "string",
      releaseLabel = "string",
      executionRoleArn = "string",
      createdBy = "string",
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      updatedAt = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_sessions(
  applicationId = "string",
  nextToken = "string",
  maxResults = 123,
  states = list(
    "SUBMITTED"|"STARTING"|"STARTED"|"IDLE"|"BUSY"|"FAILED"|"TERMINATING"|"TERMINATED"
  ),
  createdAtAfter = as.POSIXct(
    "2015-01-01"
  ),
  createdAtBefore = as.POSIXct(
    "2015-01-01"
  )
)