Amazonka.Athena.TerminateSession

Terminates an active session. A TerminateSession 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 TerminateSession is called are forcefully stopped, but may display as FAILED instead of STOPPED.

Creating a Request

data TerminateSession

See: newTerminateSession smart constructor.

Constructors

TerminateSession'

Fields

• sessionId :: Text

  The session ID.

Instances

ToJSON TerminateSession

Defined in Amazonka.Athena.TerminateSession

Methods

toJSON :: TerminateSession -> Value

toEncoding :: TerminateSession -> Encoding

toJSONList :: [TerminateSession] -> Value

toEncodingList :: [TerminateSession] -> Encoding

ToHeaders TerminateSession

Defined in Amazonka.Athena.TerminateSession

Methods

toHeaders :: TerminateSession -> [Header]

ToPath TerminateSession

Defined in Amazonka.Athena.TerminateSession

Methods

toPath :: TerminateSession -> ByteString

ToQuery TerminateSession

Defined in Amazonka.Athena.TerminateSession

Methods

toQuery :: TerminateSession -> QueryString

AWSRequest TerminateSession

Defined in Amazonka.Athena.TerminateSession

Associated Types

type AWSResponse TerminateSession

Methods

request :: (Service -> Service) -> TerminateSession -> Request TerminateSession

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy TerminateSession -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse TerminateSession)))

Generic TerminateSession

Defined in Amazonka.Athena.TerminateSession

Associated Types

type Rep TerminateSession :: Type -> Type

Methods

from :: TerminateSession -> Rep TerminateSession x

to :: Rep TerminateSession x -> TerminateSession

Read TerminateSession

Defined in Amazonka.Athena.TerminateSession

Methods

readsPrec :: Int -> ReadS TerminateSession

readList :: ReadS [TerminateSession]

readPrec :: ReadPrec TerminateSession

readListPrec :: ReadPrec [TerminateSession]

Show TerminateSession

Defined in Amazonka.Athena.TerminateSession

Methods

showsPrec :: Int -> TerminateSession -> ShowS

show :: TerminateSession -> String

showList :: [TerminateSession] -> ShowS

NFData TerminateSession

Defined in Amazonka.Athena.TerminateSession

Methods

rnf :: TerminateSession -> ()

Eq TerminateSession

Defined in Amazonka.Athena.TerminateSession

Methods

(==) :: TerminateSession -> TerminateSession -> Bool

(/=) :: TerminateSession -> TerminateSession -> Bool

Hashable TerminateSession

Defined in Amazonka.Athena.TerminateSession

Methods

hashWithSalt :: Int -> TerminateSession -> Int

hash :: TerminateSession -> Int

type AWSResponse TerminateSession

Defined in Amazonka.Athena.TerminateSession

type AWSResponse TerminateSession = TerminateSessionResponse

type Rep TerminateSession

Defined in Amazonka.Athena.TerminateSession

type Rep TerminateSession = D1 ('MetaData "TerminateSession" "Amazonka.Athena.TerminateSession" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "TerminateSession'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sessionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newTerminateSession

Arguments

:: Text

TerminateSession

-> TerminateSession

Create a value of TerminateSession with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

TerminateSession, terminateSession_sessionId - The session ID.

Request Lenses

terminateSession_sessionId :: Lens' TerminateSession Text

The session ID.

Destructuring the Response

data TerminateSessionResponse

See: newTerminateSessionResponse smart constructor.

Constructors

TerminateSessionResponse'

Fields

• state :: Maybe SessionState

  The state of the session. A description of each state follows.

  CREATING - The session is being started, including acquiring resources.

  CREATED - The session has been started.

  IDLE - The session is able to accept a calculation.

  BUSY - The session is processing another task and is unable to accept a calculation.

  TERMINATING - The session is in the process of shutting down.

  TERMINATED - The session and its resources are no longer running.

  DEGRADED - The session has no healthy coordinators.

  FAILED - Due to a failure, the session and its resources are no longer running.

• httpStatus :: Int

  The response's http status code.

Instances

Generic TerminateSessionResponse

Defined in Amazonka.Athena.TerminateSession

Associated Types

type Rep TerminateSessionResponse :: Type -> Type

Methods

from :: TerminateSessionResponse -> Rep TerminateSessionResponse x

to :: Rep TerminateSessionResponse x -> TerminateSessionResponse

Read TerminateSessionResponse

Defined in Amazonka.Athena.TerminateSession

Methods

readsPrec :: Int -> ReadS TerminateSessionResponse

readList :: ReadS [TerminateSessionResponse]

readPrec :: ReadPrec TerminateSessionResponse

readListPrec :: ReadPrec [TerminateSessionResponse]

Show TerminateSessionResponse

Defined in Amazonka.Athena.TerminateSession

Methods

showsPrec :: Int -> TerminateSessionResponse -> ShowS

show :: TerminateSessionResponse -> String

showList :: [TerminateSessionResponse] -> ShowS

NFData TerminateSessionResponse

Defined in Amazonka.Athena.TerminateSession

Methods

rnf :: TerminateSessionResponse -> ()

Eq TerminateSessionResponse

Defined in Amazonka.Athena.TerminateSession

Methods

(==) :: TerminateSessionResponse -> TerminateSessionResponse -> Bool

(/=) :: TerminateSessionResponse -> TerminateSessionResponse -> Bool

type Rep TerminateSessionResponse

Defined in Amazonka.Athena.TerminateSession

type Rep TerminateSessionResponse = D1 ('MetaData "TerminateSessionResponse" "Amazonka.Athena.TerminateSession" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "TerminateSessionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SessionState)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newTerminateSessionResponse

Arguments

:: Int

$sel:httpStatus:TerminateSessionResponse'

-> TerminateSessionResponse

Create a value of TerminateSessionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

TerminateSessionResponse, terminateSessionResponse_state - The state of the session. A description of each state follows.

CREATING - The session is being started, including acquiring resources.

CREATED - The session has been started.

IDLE - The session is able to accept a calculation.

BUSY - The session is processing another task and is unable to accept a calculation.

TERMINATING - The session is in the process of shutting down.

TERMINATED - The session and its resources are no longer running.

DEGRADED - The session has no healthy coordinators.

FAILED - Due to a failure, the session and its resources are no longer running.

$sel:httpStatus:TerminateSessionResponse', terminateSessionResponse_httpStatus - The response's http status code.

Response Lenses

terminateSessionResponse_state :: Lens' TerminateSessionResponse (Maybe SessionState)

The state of the session. A description of each state follows.

CREATING - The session is being started, including acquiring resources.

CREATED - The session has been started.

IDLE - The session is able to accept a calculation.

BUSY - The session is processing another task and is unable to accept a calculation.

TERMINATING - The session is in the process of shutting down.

TERMINATED - The session and its resources are no longer running.

DEGRADED - The session has no healthy coordinators.

FAILED - Due to a failure, the session and its resources are no longer running.

terminateSessionResponse_httpStatus :: Lens' TerminateSessionResponse Int

The response's http status code.