Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SSM.TerminateSession

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the managed node. A terminated session can't be resumed.

Creating a Request

data TerminateSession Source #

See: newTerminateSession smart constructor.

Constructors

TerminateSession'
Fields sessionId :: Text The ID of the session to terminate.

Instances

Instances details

ToJSON TerminateSession Source #
Instance details Defined in Amazonka.SSM.TerminateSession Methods toJSON :: TerminateSession -> Value # toEncoding :: TerminateSession -> Encoding # toJSONList :: [TerminateSession] -> Value # toEncodingList :: [TerminateSession] -> Encoding #
ToHeaders TerminateSession Source #
Instance details Defined in Amazonka.SSM.TerminateSession Methods toHeaders :: TerminateSession -> [Header] #
ToPath TerminateSession Source #
Instance details Defined in Amazonka.SSM.TerminateSession Methods toPath :: TerminateSession -> ByteString #
ToQuery TerminateSession Source #
Instance details Defined in Amazonka.SSM.TerminateSession Methods toQuery :: TerminateSession -> QueryString #
AWSRequest TerminateSession Source #
Instance details Defined in Amazonka.SSM.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 Source #
Instance details Defined in Amazonka.SSM.TerminateSession Associated Types type Rep TerminateSession :: Type -> Type # Methods from :: TerminateSession -> Rep TerminateSession x # to :: Rep TerminateSession x -> TerminateSession #
Read TerminateSession Source #
Instance details Defined in Amazonka.SSM.TerminateSession Methods readsPrec :: Int -> ReadS TerminateSession # readList :: ReadS [TerminateSession] # readPrec :: ReadPrec TerminateSession # readListPrec :: ReadPrec [TerminateSession] #
Show TerminateSession Source #
Instance details Defined in Amazonka.SSM.TerminateSession Methods showsPrec :: Int -> TerminateSession -> ShowS # show :: TerminateSession -> String # showList :: [TerminateSession] -> ShowS #
NFData TerminateSession Source #
Instance details Defined in Amazonka.SSM.TerminateSession Methods rnf :: TerminateSession -> () #
Eq TerminateSession Source #
Instance details Defined in Amazonka.SSM.TerminateSession Methods (==) :: TerminateSession -> TerminateSession -> Bool # (/=) :: TerminateSession -> TerminateSession -> Bool #
Hashable TerminateSession Source #
Instance details Defined in Amazonka.SSM.TerminateSession Methods hashWithSalt :: Int -> TerminateSession -> Int # hash :: TerminateSession -> Int #
type AWSResponse TerminateSession Source #
Instance details Defined in Amazonka.SSM.TerminateSession type AWSResponse TerminateSession = TerminateSessionResponse
type Rep TerminateSession Source #
Instance details Defined in Amazonka.SSM.TerminateSession type Rep TerminateSession = D1 ('MetaData "TerminateSession" "Amazonka.SSM.TerminateSession" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "TerminateSession'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sessionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newTerminateSession Source #

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 ID of the session to terminate.

Request Lenses

terminateSession_sessionId :: Lens' TerminateSession Text Source #

The ID of the session to terminate.

Destructuring the Response

data TerminateSessionResponse Source #

See: newTerminateSessionResponse smart constructor.

Constructors

TerminateSessionResponse'
Fields sessionId :: Maybe Text The ID of the session that has been terminated. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic TerminateSessionResponse Source #
Instance details Defined in Amazonka.SSM.TerminateSession Associated Types type Rep TerminateSessionResponse :: Type -> Type # Methods from :: TerminateSessionResponse -> Rep TerminateSessionResponse x # to :: Rep TerminateSessionResponse x -> TerminateSessionResponse #
Read TerminateSessionResponse Source #
Instance details Defined in Amazonka.SSM.TerminateSession Methods readsPrec :: Int -> ReadS TerminateSessionResponse # readList :: ReadS [TerminateSessionResponse] # readPrec :: ReadPrec TerminateSessionResponse # readListPrec :: ReadPrec [TerminateSessionResponse] #
Show TerminateSessionResponse Source #
Instance details Defined in Amazonka.SSM.TerminateSession Methods showsPrec :: Int -> TerminateSessionResponse -> ShowS # show :: TerminateSessionResponse -> String # showList :: [TerminateSessionResponse] -> ShowS #
NFData TerminateSessionResponse Source #
Instance details Defined in Amazonka.SSM.TerminateSession Methods rnf :: TerminateSessionResponse -> () #
Eq TerminateSessionResponse Source #
Instance details Defined in Amazonka.SSM.TerminateSession Methods (==) :: TerminateSessionResponse -> TerminateSessionResponse -> Bool # (/=) :: TerminateSessionResponse -> TerminateSessionResponse -> Bool #
type Rep TerminateSessionResponse Source #
Instance details Defined in Amazonka.SSM.TerminateSession type Rep TerminateSessionResponse = D1 ('MetaData "TerminateSessionResponse" "Amazonka.SSM.TerminateSession" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "TerminateSessionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sessionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newTerminateSessionResponse Source #

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:

TerminateSession, terminateSessionResponse_sessionId - The ID of the session that has been terminated.

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

Response Lenses

terminateSessionResponse_sessionId :: Lens' TerminateSessionResponse (Maybe Text) Source #

The ID of the session that has been terminated.

terminateSessionResponse_httpStatus :: Lens' TerminateSessionResponse Int Source #

The response's http status code.