| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
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
- data TerminateSession = TerminateSession' {}
- newTerminateSession :: Text -> TerminateSession
- terminateSession_sessionId :: Lens' TerminateSession Text
- data TerminateSessionResponse = TerminateSessionResponse' {
- sessionId :: Maybe Text
- httpStatus :: Int
- newTerminateSessionResponse :: Int -> TerminateSessionResponse
- terminateSessionResponse_sessionId :: Lens' TerminateSessionResponse (Maybe Text)
- terminateSessionResponse_httpStatus :: Lens' TerminateSessionResponse Int
Creating a Request
data TerminateSession Source #
See: newTerminateSession smart constructor.
Constructors
| TerminateSession' | |
Instances
Arguments
| :: Text | |
| -> 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:
$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
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.
terminateSessionResponse_httpStatus :: Lens' TerminateSessionResponse Int Source #
The response's http status code.