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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Stops the canary to prevent all future runs. If the canary is currently running,the run that is in progress completes on its own, publishes metrics, and uploads artifacts, but it is not recorded in Synthetics as a completed run.

You can use StartCanary to start it running again with the canary’s current schedule at any point in the future.

Synopsis

data StopCanary = StopCanary' {
- name :: Text
}
newStopCanary :: Text -> StopCanary
stopCanary_name :: Lens' StopCanary Text
data StopCanaryResponse = StopCanaryResponse' {
- httpStatus :: Int
}
newStopCanaryResponse :: Int -> StopCanaryResponse
stopCanaryResponse_httpStatus :: Lens' StopCanaryResponse Int

Creating a Request

data StopCanary Source #

See: newStopCanary smart constructor.

Constructors

StopCanary'
Fields name :: Text The name of the canary that you want to stop. To find the names of your canaries, use ListCanaries.

Instances

Instances details

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

newStopCanary Source #

Arguments

:: Text	`StopCanary`
-> StopCanary

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

StopCanary, stopCanary_name - The name of the canary that you want to stop. To find the names of your canaries, use ListCanaries.

Request Lenses

stopCanary_name :: Lens' StopCanary Text Source #

The name of the canary that you want to stop. To find the names of your canaries, use ListCanaries.

Destructuring the Response

data StopCanaryResponse Source #

See: newStopCanaryResponse smart constructor.

Constructors

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

Instances

Instances details

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

newStopCanaryResponse Source #

Arguments

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

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

Response Lenses

stopCanaryResponse_httpStatus :: Lens' StopCanaryResponse Int Source #

The response's http status code.