libZSservicesZSamazonka-ssmZSamazonka-ssm
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SSM.TerminateSession

Description

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

Synopsis

Creating a Request

data TerminateSession Source #

See: newTerminateSession smart constructor.

Constructors

TerminateSession' 

Fields

Instances

Instances details
Eq TerminateSession Source # 
Instance details

Defined in Amazonka.SSM.TerminateSession

Read TerminateSession Source # 
Instance details

Defined in Amazonka.SSM.TerminateSession

Show TerminateSession Source # 
Instance details

Defined in Amazonka.SSM.TerminateSession

Generic TerminateSession Source # 
Instance details

Defined in Amazonka.SSM.TerminateSession

Associated Types

type Rep TerminateSession :: Type -> Type #

NFData TerminateSession Source # 
Instance details

Defined in Amazonka.SSM.TerminateSession

Methods

rnf :: TerminateSession -> () #

Hashable TerminateSession Source # 
Instance details

Defined in Amazonka.SSM.TerminateSession

ToJSON TerminateSession Source # 
Instance details

Defined in Amazonka.SSM.TerminateSession

AWSRequest TerminateSession Source # 
Instance details

Defined in Amazonka.SSM.TerminateSession

Associated Types

type AWSResponse TerminateSession #

ToHeaders TerminateSession Source # 
Instance details

Defined in Amazonka.SSM.TerminateSession

ToPath TerminateSession Source # 
Instance details

Defined in Amazonka.SSM.TerminateSession

ToQuery TerminateSession Source # 
Instance details

Defined in Amazonka.SSM.TerminateSession

type Rep TerminateSession Source # 
Instance details

Defined in Amazonka.SSM.TerminateSession

type Rep TerminateSession = D1 ('MetaData "TerminateSession" "Amazonka.SSM.TerminateSession" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "TerminateSession'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sessionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse TerminateSession Source # 
Instance details

Defined in Amazonka.SSM.TerminateSession

newTerminateSession Source #

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:

$sel:sessionId: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

Instances

Instances details
Eq TerminateSessionResponse Source # 
Instance details

Defined in Amazonka.SSM.TerminateSession

Read TerminateSessionResponse Source # 
Instance details

Defined in Amazonka.SSM.TerminateSession

Show TerminateSessionResponse Source # 
Instance details

Defined in Amazonka.SSM.TerminateSession

Generic TerminateSessionResponse Source # 
Instance details

Defined in Amazonka.SSM.TerminateSession

Associated Types

type Rep TerminateSessionResponse :: Type -> Type #

NFData TerminateSessionResponse Source # 
Instance details

Defined in Amazonka.SSM.TerminateSession

type Rep TerminateSessionResponse Source # 
Instance details

Defined in Amazonka.SSM.TerminateSession

type Rep TerminateSessionResponse = D1 ('MetaData "TerminateSessionResponse" "Amazonka.SSM.TerminateSession" "libZSservicesZSamazonka-ssmZSamazonka-ssm" '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 #

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:

$sel:sessionId: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.