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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Permanently deletes the specified canary.

When you delete a canary, resources used and created by the canary are not automatically deleted. After you delete a canary that you do not intend to use again, you should also delete the following:

The Lambda functions and layers used by this canary. These have the prefix cwsyn-MyCanaryName .
The CloudWatch alarms created for this canary. These alarms have a name of Synthetics-SharpDrop-Alarm-MyCanaryName .
Amazon S3 objects and buckets, such as the canary's artifact location.
IAM roles created for the canary. If they were created in the console, these roles have the name role/service-role/CloudWatchSyntheticsRole-MyCanaryName .
CloudWatch Logs log groups created for the canary. These logs groups have the name /aws/lambda/cwsyn-MyCanaryName .

Before you delete a canary, you might want to use GetCanary to display the information about this canary. Make note of the information returned by this operation so that you can delete these resources after you delete the canary.

Synopsis

data DeleteCanary = DeleteCanary' {
- name :: Text
}
newDeleteCanary :: Text -> DeleteCanary
deleteCanary_name :: Lens' DeleteCanary Text
data DeleteCanaryResponse = DeleteCanaryResponse' {
- httpStatus :: Int
}
newDeleteCanaryResponse :: Int -> DeleteCanaryResponse
deleteCanaryResponse_httpStatus :: Lens' DeleteCanaryResponse Int

Creating a Request

data DeleteCanary Source #

See: newDeleteCanary smart constructor.

Constructors

DeleteCanary'
Fields name :: Text The name of the canary that you want to delete. To find the names of your canaries, use DescribeCanaries.

Instances

Instances details

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

newDeleteCanary Source #

Arguments

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

Create a value of DeleteCanary 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:DeleteCanary', deleteCanary_name - The name of the canary that you want to delete. To find the names of your canaries, use DescribeCanaries.

Request Lenses

deleteCanary_name :: Lens' DeleteCanary Text Source #

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

Destructuring the Response

data DeleteCanaryResponse Source #

See: newDeleteCanaryResponse smart constructor.

Constructors

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

Instances

Instances details

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

newDeleteCanaryResponse Source #

Arguments

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

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

Response Lenses

deleteCanaryResponse_httpStatus :: Lens' DeleteCanaryResponse Int Source #

The response's http status code.