Terminate Session

athena_terminate_session

R Documentation

Terminates an active session

Description

Terminates an active session. A terminate_session call on a session that is already inactive (for example, in a FAILED, TERMINATED or TERMINATING state) succeeds but has no effect. Calculations running in the session when terminate_session is called are forcefully stopped, but may display as FAILED instead of STOPPED.

Usage

athena_terminate_session(SessionId)

Arguments

SessionId

[required] The session ID.

Value

A list with the following syntax:

list(
  State = "CREATING"|"CREATED"|"IDLE"|"BUSY"|"TERMINATING"|"TERMINATED"|"DEGRADED"|"FAILED"
)

Request syntax

svc$terminate_session(
  SessionId = "string"
)