libZSservicesZSamazonka-syntheticsZSamazonka-synthetics
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.Synthetics.StopCanary

Description

Stops the canary to prevent all future runs. If the canary is currently running, Synthetics stops waiting for the current run of the specified canary to complete. 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

Creating a Request

data StopCanary Source #

See: newStopCanary smart constructor.

Constructors

StopCanary' 

Fields

Instances

Instances details
Eq StopCanary Source # 
Instance details

Defined in Amazonka.Synthetics.StopCanary

Read StopCanary Source # 
Instance details

Defined in Amazonka.Synthetics.StopCanary

Show StopCanary Source # 
Instance details

Defined in Amazonka.Synthetics.StopCanary

Generic StopCanary Source # 
Instance details

Defined in Amazonka.Synthetics.StopCanary

Associated Types

type Rep StopCanary :: Type -> Type #

NFData StopCanary Source # 
Instance details

Defined in Amazonka.Synthetics.StopCanary

Methods

rnf :: StopCanary -> () #

Hashable StopCanary Source # 
Instance details

Defined in Amazonka.Synthetics.StopCanary

ToJSON StopCanary Source # 
Instance details

Defined in Amazonka.Synthetics.StopCanary

AWSRequest StopCanary Source # 
Instance details

Defined in Amazonka.Synthetics.StopCanary

Associated Types

type AWSResponse StopCanary #

ToHeaders StopCanary Source # 
Instance details

Defined in Amazonka.Synthetics.StopCanary

Methods

toHeaders :: StopCanary -> [Header] #

ToPath StopCanary Source # 
Instance details

Defined in Amazonka.Synthetics.StopCanary

ToQuery StopCanary Source # 
Instance details

Defined in Amazonka.Synthetics.StopCanary

type Rep StopCanary Source # 
Instance details

Defined in Amazonka.Synthetics.StopCanary

type Rep StopCanary = D1 ('MetaData "StopCanary" "Amazonka.Synthetics.StopCanary" "libZSservicesZSamazonka-syntheticsZSamazonka-synthetics" 'False) (C1 ('MetaCons "StopCanary'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse StopCanary Source # 
Instance details

Defined in Amazonka.Synthetics.StopCanary

newStopCanary Source #

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:

$sel:name:StopCanary', stopCanary_name - The name of the canary that you want to stop. To find the names of your canaries, use DescribeCanaries.

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

Destructuring the Response

data StopCanaryResponse Source #

See: newStopCanaryResponse smart constructor.

Constructors

StopCanaryResponse' 

Fields

Instances

Instances details
Eq StopCanaryResponse Source # 
Instance details

Defined in Amazonka.Synthetics.StopCanary

Read StopCanaryResponse Source # 
Instance details

Defined in Amazonka.Synthetics.StopCanary

Show StopCanaryResponse Source # 
Instance details

Defined in Amazonka.Synthetics.StopCanary

Generic StopCanaryResponse Source # 
Instance details

Defined in Amazonka.Synthetics.StopCanary

Associated Types

type Rep StopCanaryResponse :: Type -> Type #

NFData StopCanaryResponse Source # 
Instance details

Defined in Amazonka.Synthetics.StopCanary

Methods

rnf :: StopCanaryResponse -> () #

type Rep StopCanaryResponse Source # 
Instance details

Defined in Amazonka.Synthetics.StopCanary

type Rep StopCanaryResponse = D1 ('MetaData "StopCanaryResponse" "Amazonka.Synthetics.StopCanary" "libZSservicesZSamazonka-syntheticsZSamazonka-synthetics" 'False) (C1 ('MetaCons "StopCanaryResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStopCanaryResponse Source #

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