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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the Session Manager connection status for an instance to determine whether it is running and ready to receive Session Manager connections.

Creating a Request

data GetConnectionStatus Source #

See: newGetConnectionStatus smart constructor.

Constructors

GetConnectionStatus'
Fields target :: Text The instance ID.

Instances

Instances details

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

newGetConnectionStatus Source #

Arguments

:: Text	`$sel:target:GetConnectionStatus'`
-> GetConnectionStatus

Create a value of GetConnectionStatus 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:target:GetConnectionStatus', getConnectionStatus_target - The instance ID.

Request Lenses

getConnectionStatus_target :: Lens' GetConnectionStatus Text Source #

The instance ID.

Destructuring the Response

data GetConnectionStatusResponse Source #

See: newGetConnectionStatusResponse smart constructor.

Constructors

GetConnectionStatusResponse'
Fields status :: Maybe ConnectionStatus The status of the connection to the instance. For example, 'Connected' or 'Not Connected'. target :: Maybe Text The ID of the instance to check connection status. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newGetConnectionStatusResponse Source #

Arguments

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

Create a value of GetConnectionStatusResponse 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:status:GetConnectionStatusResponse', getConnectionStatusResponse_status - The status of the connection to the instance. For example, 'Connected' or 'Not Connected'.

$sel:target:GetConnectionStatus', getConnectionStatusResponse_target - The ID of the instance to check connection status.

$sel:httpStatus:GetConnectionStatusResponse', getConnectionStatusResponse_httpStatus - The response's http status code.

Response Lenses

getConnectionStatusResponse_status :: Lens' GetConnectionStatusResponse (Maybe ConnectionStatus) Source #

The status of the connection to the instance. For example, 'Connected' or 'Not Connected'.

getConnectionStatusResponse_target :: Lens' GetConnectionStatusResponse (Maybe Text) Source #

The ID of the instance to check connection status.

getConnectionStatusResponse_httpStatus :: Lens' GetConnectionStatusResponse Int Source #

The response's http status code.