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.PrivateNetworks.Ping

Contents

Creating a Request
Destructuring the Response
Response Lenses

Description

Checks the health of the service.

Synopsis

data Ping = Ping' {
}
newPing :: Ping
data PingResponse = PingResponse' {
- status :: Maybe Text
- httpStatus :: Int
}
newPingResponse :: Int -> PingResponse
pingResponse_status :: Lens' PingResponse (Maybe Text)
pingResponse_httpStatus :: Lens' PingResponse Int

Creating a Request

data Ping Source #

See: newPing smart constructor.

Constructors

Ping'

Instances

Instances details

ToHeaders Ping Source #
Instance details Defined in Amazonka.PrivateNetworks.Ping Methods toHeaders :: Ping -> [Header] #
ToPath Ping Source #
Instance details Defined in Amazonka.PrivateNetworks.Ping Methods toPath :: Ping -> ByteString #
ToQuery Ping Source #
Instance details Defined in Amazonka.PrivateNetworks.Ping Methods toQuery :: Ping -> QueryString #
AWSRequest Ping Source #
Instance details Defined in Amazonka.PrivateNetworks.Ping Associated Types type AWSResponse Ping # Methods request :: (Service -> Service) -> Ping -> Request Ping # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy Ping -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse Ping))) #
Generic Ping Source #
Instance details Defined in Amazonka.PrivateNetworks.Ping Associated Types type Rep Ping :: Type -> Type # Methods from :: Ping -> Rep Ping x # to :: Rep Ping x -> Ping #
Read Ping Source #
Instance details Defined in Amazonka.PrivateNetworks.Ping Methods readsPrec :: Int -> ReadS Ping # readList :: ReadS [Ping] # readPrec :: ReadPrec Ping # readListPrec :: ReadPrec [Ping] #
Show Ping Source #
Instance details Defined in Amazonka.PrivateNetworks.Ping Methods showsPrec :: Int -> Ping -> ShowS # show :: Ping -> String # showList :: [Ping] -> ShowS #
NFData Ping Source #
Instance details Defined in Amazonka.PrivateNetworks.Ping Methods rnf :: Ping -> () #
Eq Ping Source #
Instance details Defined in Amazonka.PrivateNetworks.Ping Methods (==) :: Ping -> Ping -> Bool # (/=) :: Ping -> Ping -> Bool #
Hashable Ping Source #
Instance details Defined in Amazonka.PrivateNetworks.Ping Methods hashWithSalt :: Int -> Ping -> Int # hash :: Ping -> Int #
type AWSResponse Ping Source #
Instance details Defined in Amazonka.PrivateNetworks.Ping type AWSResponse Ping = PingResponse
type Rep Ping Source #
Instance details Defined in Amazonka.PrivateNetworks.Ping type Rep Ping = D1 ('MetaData "Ping" "Amazonka.PrivateNetworks.Ping" "amazonka-privatenetworks-2.0-6kTUHQMy1b1JCa08Y5Egzo" 'False) (C1 ('MetaCons "Ping'" 'PrefixI 'False) (U1 :: Type -> Type))

newPing :: Ping Source #

Create a value of Ping with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

Destructuring the Response

data PingResponse Source #

See: newPingResponse smart constructor.

Constructors

PingResponse'
Fields status :: Maybe Text Information about the health of the service. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newPingResponse Source #

Arguments

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

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

PingResponse, pingResponse_status - Information about the health of the service.

$sel:httpStatus:PingResponse', pingResponse_httpStatus - The response's http status code.

Response Lenses

pingResponse_status :: Lens' PingResponse (Maybe Text) Source #

Information about the health of the service.

pingResponse_httpStatus :: Lens' PingResponse Int Source #

The response's http status code.