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.Synthetics.GetCanary

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves complete information about one canary. You must specify the name of the canary that you want. To get a list of canaries and their names, use DescribeCanaries.

Synopsis

data GetCanary = GetCanary' {
- name :: Text
}
newGetCanary :: Text -> GetCanary
getCanary_name :: Lens' GetCanary Text
data GetCanaryResponse = GetCanaryResponse' {
- canary :: Maybe Canary
- httpStatus :: Int
}
newGetCanaryResponse :: Int -> GetCanaryResponse
getCanaryResponse_canary :: Lens' GetCanaryResponse (Maybe Canary)
getCanaryResponse_httpStatus :: Lens' GetCanaryResponse Int

Creating a Request

data GetCanary Source #

See: newGetCanary smart constructor.

Constructors

GetCanary'
Fields name :: Text The name of the canary that you want details for.

Instances

Instances details

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

newGetCanary Source #

Arguments

:: Text	`$sel:name:GetCanary'`
-> GetCanary

Create a value of GetCanary 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:name:GetCanary', getCanary_name - The name of the canary that you want details for.

Request Lenses

getCanary_name :: Lens' GetCanary Text Source #

The name of the canary that you want details for.

Destructuring the Response

data GetCanaryResponse Source #

See: newGetCanaryResponse smart constructor.

Constructors

GetCanaryResponse'
Fields canary :: Maybe Canary A strucure that contains the full information about the canary. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq GetCanaryResponse Source #
Instance details Defined in Amazonka.Synthetics.GetCanary Methods (==) :: GetCanaryResponse -> GetCanaryResponse -> Bool # (/=) :: GetCanaryResponse -> GetCanaryResponse -> Bool #
Read GetCanaryResponse Source #
Instance details Defined in Amazonka.Synthetics.GetCanary Methods readsPrec :: Int -> ReadS GetCanaryResponse # readList :: ReadS [GetCanaryResponse] # readPrec :: ReadPrec GetCanaryResponse # readListPrec :: ReadPrec [GetCanaryResponse] #
Show GetCanaryResponse Source #
Instance details Defined in Amazonka.Synthetics.GetCanary Methods showsPrec :: Int -> GetCanaryResponse -> ShowS # show :: GetCanaryResponse -> String # showList :: [GetCanaryResponse] -> ShowS #
Generic GetCanaryResponse Source #
Instance details Defined in Amazonka.Synthetics.GetCanary Associated Types type Rep GetCanaryResponse :: Type -> Type # Methods from :: GetCanaryResponse -> Rep GetCanaryResponse x # to :: Rep GetCanaryResponse x -> GetCanaryResponse #
NFData GetCanaryResponse Source #
Instance details Defined in Amazonka.Synthetics.GetCanary Methods rnf :: GetCanaryResponse -> () #
type Rep GetCanaryResponse Source #
Instance details Defined in Amazonka.Synthetics.GetCanary type Rep GetCanaryResponse = D1 ('MetaData "GetCanaryResponse" "Amazonka.Synthetics.GetCanary" "libZSservicesZSamazonka-syntheticsZSamazonka-synthetics" 'False) (C1 ('MetaCons "GetCanaryResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "canary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Canary)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetCanaryResponse Source #

Arguments

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

Create a value of GetCanaryResponse 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:canary:GetCanaryResponse', getCanaryResponse_canary - A strucure that contains the full information about the canary.

$sel:httpStatus:GetCanaryResponse', getCanaryResponse_httpStatus - The response's http status code.

Response Lenses

getCanaryResponse_canary :: Lens' GetCanaryResponse (Maybe Canary) Source #

A strucure that contains the full information about the canary.

getCanaryResponse_httpStatus :: Lens' GetCanaryResponse Int Source #

The response's http status code.