Amazonka.Synthetics.StartCanary

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.

Creating a Request

data StartCanary

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

ToJSON StartCanary

Defined in Amazonka.Synthetics.StartCanary

Methods

toJSON :: StartCanary -> Value

toEncoding :: StartCanary -> Encoding

toJSONList :: [StartCanary] -> Value

toEncodingList :: [StartCanary] -> Encoding

ToHeaders StartCanary

Defined in Amazonka.Synthetics.StartCanary

Methods

toHeaders :: StartCanary -> [Header]

ToPath StartCanary

Defined in Amazonka.Synthetics.StartCanary

Methods

toPath :: StartCanary -> ByteString

ToQuery StartCanary

Defined in Amazonka.Synthetics.StartCanary

Methods

toQuery :: StartCanary -> QueryString

AWSRequest StartCanary

Defined in Amazonka.Synthetics.StartCanary

Associated Types

type AWSResponse StartCanary

Methods

request :: (Service -> Service) -> StartCanary -> Request StartCanary

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartCanary -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartCanary)))

Generic StartCanary

Defined in Amazonka.Synthetics.StartCanary

Associated Types

type Rep StartCanary :: Type -> Type

Methods

from :: StartCanary -> Rep StartCanary x

to :: Rep StartCanary x -> StartCanary

Read StartCanary

Defined in Amazonka.Synthetics.StartCanary

Methods

readsPrec :: Int -> ReadS StartCanary

readList :: ReadS [StartCanary]

readPrec :: ReadPrec StartCanary

readListPrec :: ReadPrec [StartCanary]

Show StartCanary

Defined in Amazonka.Synthetics.StartCanary

Methods

showsPrec :: Int -> StartCanary -> ShowS

show :: StartCanary -> String

showList :: [StartCanary] -> ShowS

NFData StartCanary

Defined in Amazonka.Synthetics.StartCanary

Methods

rnf :: StartCanary -> ()

Eq StartCanary

Defined in Amazonka.Synthetics.StartCanary

Methods

(==) :: StartCanary -> StartCanary -> Bool

(/=) :: StartCanary -> StartCanary -> Bool

Hashable StartCanary

Defined in Amazonka.Synthetics.StartCanary

Methods

hashWithSalt :: Int -> StartCanary -> Int

hash :: StartCanary -> Int

type AWSResponse StartCanary

Defined in Amazonka.Synthetics.StartCanary

type AWSResponse StartCanary = StartCanaryResponse

type Rep StartCanary

Defined in Amazonka.Synthetics.StartCanary

type Rep StartCanary = D1 ('MetaData "StartCanary" "Amazonka.Synthetics.StartCanary" "amazonka-synthetics-2.0-3I8gICXDswl2F1HDbijRHZ" 'False) (C1 ('MetaCons "StartCanary'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newStartCanary

Arguments

:: Text

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:

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

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

Destructuring the Response

data StartCanaryResponse

See: newStartCanaryResponse smart constructor.

Constructors

StartCanaryResponse'

Fields

• httpStatus :: Int

  The response's http status code.

Instances

Generic StartCanaryResponse

Defined in Amazonka.Synthetics.StartCanary

Associated Types

type Rep StartCanaryResponse :: Type -> Type

Methods

from :: StartCanaryResponse -> Rep StartCanaryResponse x

to :: Rep StartCanaryResponse x -> StartCanaryResponse

Read StartCanaryResponse

Defined in Amazonka.Synthetics.StartCanary

Methods

readsPrec :: Int -> ReadS StartCanaryResponse

readList :: ReadS [StartCanaryResponse]

readPrec :: ReadPrec StartCanaryResponse

readListPrec :: ReadPrec [StartCanaryResponse]

Show StartCanaryResponse

Defined in Amazonka.Synthetics.StartCanary

Methods

showsPrec :: Int -> StartCanaryResponse -> ShowS

show :: StartCanaryResponse -> String

showList :: [StartCanaryResponse] -> ShowS

NFData StartCanaryResponse

Defined in Amazonka.Synthetics.StartCanary

Methods

rnf :: StartCanaryResponse -> ()

Eq StartCanaryResponse

Defined in Amazonka.Synthetics.StartCanary

Methods

(==) :: StartCanaryResponse -> StartCanaryResponse -> Bool

(/=) :: StartCanaryResponse -> StartCanaryResponse -> Bool

type Rep StartCanaryResponse

Defined in Amazonka.Synthetics.StartCanary

type Rep StartCanaryResponse = D1 ('MetaData "StartCanaryResponse" "Amazonka.Synthetics.StartCanary" "amazonka-synthetics-2.0-3I8gICXDswl2F1HDbijRHZ" 'False) (C1 ('MetaCons "StartCanaryResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartCanaryResponse

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

The response's http status code.