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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Use this operation to run a canary that has already been created. The frequency of the canary runs is determined by the value of the canary's Schedule. To see a canary's schedule, use GetCanary.

Synopsis

data StartCanary = StartCanary' {
- name :: Text
}
newStartCanary :: Text -> StartCanary
startCanary_name :: Lens' StartCanary Text
data StartCanaryResponse = StartCanaryResponse' {
- httpStatus :: Int
}
newStartCanaryResponse :: Int -> StartCanaryResponse
startCanaryResponse_httpStatus :: Lens' StartCanaryResponse Int

Creating a Request

data StartCanary Source #

See: newStartCanary smart constructor.

Constructors

StartCanary'
Fields name :: Text The name of the canary that you want to run. To find canary names, use DescribeCanaries.

Instances

Instances details

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

newStartCanary Source #

Arguments

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

Create a value of StartCanary 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:StartCanary', startCanary_name - The name of the canary that you want to run. To find canary names, use DescribeCanaries.

Request Lenses

startCanary_name :: Lens' StartCanary Text Source #

The name of the canary that you want to run. To find canary names, use DescribeCanaries.

Destructuring the Response

data StartCanaryResponse Source #

See: newStartCanaryResponse smart constructor.

Constructors

StartCanaryResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

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

newStartCanaryResponse Source #

Arguments

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

Create a value of StartCanaryResponse 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:httpStatus:StartCanaryResponse', startCanaryResponse_httpStatus - The response's http status code.

Response Lenses

startCanaryResponse_httpStatus :: Lens' StartCanaryResponse Int Source #

The response's http status code.