Lists the sessions on a cluster¶

Description¶

Lists the sessions on a cluster. You can filter the results by session state. Newer sessions are returned first.

Usage¶

emr_list_sessions(ClusterId, SessionStates, NextToken, MaxResults)

Arguments¶

ClusterId

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

An optional filter that limits the results to sessions in the specified states.
NextToken

The pagination token returned by a previous list_sessions call. Use it to retrieve the next page of results.
MaxResults

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

Value¶

A list with the following syntax:

list(
  Sessions = list(
    list(
      Id = "string",
      ClusterId = "string",
      Name = "string",
      Arn = "string",
      State = "SUBMITTED"|"STARTING"|"STARTED"|"IDLE"|"BUSY"|"TERMINATING"|"TERMINATED"|"FAILED",
      StateChangeReason = "string",
      ReleaseLabel = "string",
      ExecutionRoleArn = "string",
      AccountId = "string",
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      UpdatedAt = as.POSIXct(
        "2015-01-01"
      ),
      StartedAt = as.POSIXct(
        "2015-01-01"
      ),
      EndedAt = as.POSIXct(
        "2015-01-01"
      ),
      IdleSince = as.POSIXct(
        "2015-01-01"
      ),
      EngineConfigurations = list(
        list(
          Classification = "string",
          Configurations = list(),
          Properties = list(
            "string"
          )
        )
      ),
      MonitoringConfiguration = list(
        CloudWatchLoggingConfiguration = list(
          Enabled = TRUE|FALSE,
          LogGroup = "string",
          LogStreamNamePrefix = "string",
          EncryptionKeyArn = "string",
          LogTypes = list(
            list(
              "string"
            )
          )
        ),
        ManagedLoggingConfiguration = list(
          Enabled = TRUE|FALSE,
          EncryptionKeyArn = "string"
        ),
        S3LoggingConfiguration = list(
          Enabled = TRUE|FALSE,
          LogUri = "string",
          EncryptionKeyArn = "string",
          LogTypes = list(
            list(
              "string"
            )
          )
        )
      ),
      SessionIdleTimeoutInMinutes = 123,
      ServerUrl = "string",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_sessions(
  ClusterId = "string",
  SessionStates = list(
    "SUBMITTED"|"STARTING"|"STARTED"|"IDLE"|"BUSY"|"TERMINATING"|"TERMINATED"|"FAILED"
  ),
  NextToken = "string",
  MaxResults = 123
)