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

Description

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

Synopsis

Creating a Request

data GetConnectionStatus Source #

See: newGetConnectionStatus smart constructor.

Constructors

GetConnectionStatus' 

Fields

Instances

Instances details
Eq GetConnectionStatus Source # 
Instance details

Defined in Amazonka.SSM.GetConnectionStatus

Read GetConnectionStatus Source # 
Instance details

Defined in Amazonka.SSM.GetConnectionStatus

Show GetConnectionStatus Source # 
Instance details

Defined in Amazonka.SSM.GetConnectionStatus

Generic GetConnectionStatus Source # 
Instance details

Defined in Amazonka.SSM.GetConnectionStatus

Associated Types

type Rep GetConnectionStatus :: Type -> Type #

NFData GetConnectionStatus Source # 
Instance details

Defined in Amazonka.SSM.GetConnectionStatus

Methods

rnf :: GetConnectionStatus -> () #

Hashable GetConnectionStatus Source # 
Instance details

Defined in Amazonka.SSM.GetConnectionStatus

ToJSON GetConnectionStatus Source # 
Instance details

Defined in Amazonka.SSM.GetConnectionStatus

AWSRequest GetConnectionStatus Source # 
Instance details

Defined in Amazonka.SSM.GetConnectionStatus

Associated Types

type AWSResponse GetConnectionStatus #

ToHeaders GetConnectionStatus Source # 
Instance details

Defined in Amazonka.SSM.GetConnectionStatus

ToPath GetConnectionStatus Source # 
Instance details

Defined in Amazonka.SSM.GetConnectionStatus

ToQuery GetConnectionStatus Source # 
Instance details

Defined in Amazonka.SSM.GetConnectionStatus

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

newGetConnectionStatus Source #

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

Destructuring the Response

data GetConnectionStatusResponse Source #

See: newGetConnectionStatusResponse smart constructor.

Constructors

GetConnectionStatusResponse' 

Fields

Instances

Instances details
Eq GetConnectionStatusResponse Source # 
Instance details

Defined in Amazonka.SSM.GetConnectionStatus

Read GetConnectionStatusResponse Source # 
Instance details

Defined in Amazonka.SSM.GetConnectionStatus

Show GetConnectionStatusResponse Source # 
Instance details

Defined in Amazonka.SSM.GetConnectionStatus

Generic GetConnectionStatusResponse Source # 
Instance details

Defined in Amazonka.SSM.GetConnectionStatus

Associated Types

type Rep GetConnectionStatusResponse :: Type -> Type #

NFData GetConnectionStatusResponse Source # 
Instance details

Defined in Amazonka.SSM.GetConnectionStatus

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 #

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.