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

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

Creating a Request

data StartCanary Source #

See: newStartCanary smart constructor.

Constructors

StartCanary' 

Fields

Instances

Instances details
Eq StartCanary Source # 
Instance details

Defined in Amazonka.Synthetics.StartCanary

Read StartCanary Source # 
Instance details

Defined in Amazonka.Synthetics.StartCanary

Show StartCanary Source # 
Instance details

Defined in Amazonka.Synthetics.StartCanary

Generic StartCanary Source # 
Instance details

Defined in Amazonka.Synthetics.StartCanary

Associated Types

type Rep StartCanary :: Type -> Type #

NFData StartCanary Source # 
Instance details

Defined in Amazonka.Synthetics.StartCanary

Methods

rnf :: StartCanary -> () #

Hashable StartCanary Source # 
Instance details

Defined in Amazonka.Synthetics.StartCanary

ToJSON StartCanary Source # 
Instance details

Defined in Amazonka.Synthetics.StartCanary

AWSRequest StartCanary Source # 
Instance details

Defined in Amazonka.Synthetics.StartCanary

Associated Types

type 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

ToQuery StartCanary Source # 
Instance details

Defined in Amazonka.Synthetics.StartCanary

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

newStartCanary Source #

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

Instances

Instances details
Eq StartCanaryResponse Source # 
Instance details

Defined in Amazonka.Synthetics.StartCanary

Read StartCanaryResponse Source # 
Instance details

Defined in Amazonka.Synthetics.StartCanary

Show StartCanaryResponse Source # 
Instance details

Defined in Amazonka.Synthetics.StartCanary

Generic StartCanaryResponse Source # 
Instance details

Defined in Amazonka.Synthetics.StartCanary

Associated Types

type Rep StartCanaryResponse :: Type -> Type #

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 #

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