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.ResumeSession

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Reconnects a session to a managed node after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions.

This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It isn't intended for any other use.

Creating a Request

data ResumeSession Source #

See: newResumeSession smart constructor.

Constructors

ResumeSession'
Fields sessionId :: Text The ID of the disconnected session to resume.

Instances

Instances details

ToJSON ResumeSession Source #
Instance details Defined in Amazonka.SSM.ResumeSession Methods toJSON :: ResumeSession -> Value # toEncoding :: ResumeSession -> Encoding # toJSONList :: [ResumeSession] -> Value # toEncodingList :: [ResumeSession] -> Encoding #
ToHeaders ResumeSession Source #
Instance details Defined in Amazonka.SSM.ResumeSession Methods toHeaders :: ResumeSession -> [Header] #
ToPath ResumeSession Source #
Instance details Defined in Amazonka.SSM.ResumeSession Methods toPath :: ResumeSession -> ByteString #
ToQuery ResumeSession Source #
Instance details Defined in Amazonka.SSM.ResumeSession Methods toQuery :: ResumeSession -> QueryString #
AWSRequest ResumeSession Source #
Instance details Defined in Amazonka.SSM.ResumeSession Associated Types type AWSResponse ResumeSession # Methods request :: (Service -> Service) -> ResumeSession -> Request ResumeSession # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ResumeSession -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ResumeSession))) #
Generic ResumeSession Source #
Instance details Defined in Amazonka.SSM.ResumeSession Associated Types type Rep ResumeSession :: Type -> Type # Methods from :: ResumeSession -> Rep ResumeSession x # to :: Rep ResumeSession x -> ResumeSession #
Read ResumeSession Source #
Instance details Defined in Amazonka.SSM.ResumeSession Methods readsPrec :: Int -> ReadS ResumeSession # readList :: ReadS [ResumeSession] # readPrec :: ReadPrec ResumeSession # readListPrec :: ReadPrec [ResumeSession] #
Show ResumeSession Source #
Instance details Defined in Amazonka.SSM.ResumeSession Methods showsPrec :: Int -> ResumeSession -> ShowS # show :: ResumeSession -> String # showList :: [ResumeSession] -> ShowS #
NFData ResumeSession Source #
Instance details Defined in Amazonka.SSM.ResumeSession Methods rnf :: ResumeSession -> () #
Eq ResumeSession Source #
Instance details Defined in Amazonka.SSM.ResumeSession Methods (==) :: ResumeSession -> ResumeSession -> Bool # (/=) :: ResumeSession -> ResumeSession -> Bool #
Hashable ResumeSession Source #
Instance details Defined in Amazonka.SSM.ResumeSession Methods hashWithSalt :: Int -> ResumeSession -> Int # hash :: ResumeSession -> Int #
type AWSResponse ResumeSession Source #
Instance details Defined in Amazonka.SSM.ResumeSession type AWSResponse ResumeSession = ResumeSessionResponse
type Rep ResumeSession Source #
Instance details Defined in Amazonka.SSM.ResumeSession type Rep ResumeSession = D1 ('MetaData "ResumeSession" "Amazonka.SSM.ResumeSession" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "ResumeSession'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sessionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newResumeSession Source #

Arguments

:: Text	`ResumeSession`
-> ResumeSession

Create a value of ResumeSession 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:

ResumeSession, resumeSession_sessionId - The ID of the disconnected session to resume.

Request Lenses

resumeSession_sessionId :: Lens' ResumeSession Text Source #

The ID of the disconnected session to resume.

Destructuring the Response

data ResumeSessionResponse Source #

See: newResumeSessionResponse smart constructor.

Constructors

ResumeSessionResponse'

Fields

sessionId :: Maybe Text
The ID of the session.
streamUrl :: Maybe Text
A URL back to SSM Agent on the managed node that the Session Manager client uses to send commands and receive output from the managed node. Format: wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output).
region represents the Region identifier for an Amazon Web Services Region supported by Amazon Web Services Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference.
session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE.
tokenValue :: Maybe Text
An encrypted token value containing session and caller information. Used to authenticate the connection to the managed node.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newResumeSessionResponse Source #

Arguments

:: Int	`$sel:httpStatus:ResumeSessionResponse'`
-> ResumeSessionResponse

Create a value of ResumeSessionResponse 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:

ResumeSession, resumeSessionResponse_sessionId - The ID of the session.

$sel:streamUrl:ResumeSessionResponse', resumeSessionResponse_streamUrl - A URL back to SSM Agent on the managed node that the Session Manager client uses to send commands and receive output from the managed node. Format: wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output).

region represents the Region identifier for an Amazon Web Services Region supported by Amazon Web Services Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference.

session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE.

$sel:tokenValue:ResumeSessionResponse', resumeSessionResponse_tokenValue - An encrypted token value containing session and caller information. Used to authenticate the connection to the managed node.

$sel:httpStatus:ResumeSessionResponse', resumeSessionResponse_httpStatus - The response's http status code.

Response Lenses

resumeSessionResponse_sessionId :: Lens' ResumeSessionResponse (Maybe Text) Source #

The ID of the session.

resumeSessionResponse_streamUrl :: Lens' ResumeSessionResponse (Maybe Text) Source #

A URL back to SSM Agent on the managed node that the Session Manager client uses to send commands and receive output from the managed node. Format: wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output).

region represents the Region identifier for an Amazon Web Services Region supported by Amazon Web Services Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference.

session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE.

resumeSessionResponse_tokenValue :: Lens' ResumeSessionResponse (Maybe Text) Source #

An encrypted token value containing session and caller information. Used to authenticate the connection to the managed node.

resumeSessionResponse_httpStatus :: Lens' ResumeSessionResponse Int Source #

The response's http status code.