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.Personalize.DeleteCampaign

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Removes a campaign by deleting the solution deployment. The solution that the campaign is based on is not deleted and can be redeployed when needed. A deleted campaign can no longer be specified in a GetRecommendations request. For information on creating campaigns, see CreateCampaign.

Synopsis

data DeleteCampaign = DeleteCampaign' {
- campaignArn :: Text
}
newDeleteCampaign :: Text -> DeleteCampaign
deleteCampaign_campaignArn :: Lens' DeleteCampaign Text
data DeleteCampaignResponse = DeleteCampaignResponse' {
}
newDeleteCampaignResponse :: DeleteCampaignResponse

Creating a Request

data DeleteCampaign Source #

See: newDeleteCampaign smart constructor.

Constructors

DeleteCampaign'
Fields campaignArn :: Text The Amazon Resource Name (ARN) of the campaign to delete.

Instances

Instances details

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

newDeleteCampaign Source #

Arguments

:: Text	`DeleteCampaign`
-> DeleteCampaign

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

DeleteCampaign, deleteCampaign_campaignArn - The Amazon Resource Name (ARN) of the campaign to delete.

Request Lenses

deleteCampaign_campaignArn :: Lens' DeleteCampaign Text Source #

The Amazon Resource Name (ARN) of the campaign to delete.

Destructuring the Response

data DeleteCampaignResponse Source #

See: newDeleteCampaignResponse smart constructor.

Constructors

DeleteCampaignResponse'

Instances

Instances details

Generic DeleteCampaignResponse Source #
Instance details Defined in Amazonka.Personalize.DeleteCampaign Associated Types type Rep DeleteCampaignResponse :: Type -> Type # Methods from :: DeleteCampaignResponse -> Rep DeleteCampaignResponse x # to :: Rep DeleteCampaignResponse x -> DeleteCampaignResponse #
Read DeleteCampaignResponse Source #
Instance details Defined in Amazonka.Personalize.DeleteCampaign Methods readsPrec :: Int -> ReadS DeleteCampaignResponse # readList :: ReadS [DeleteCampaignResponse] # readPrec :: ReadPrec DeleteCampaignResponse # readListPrec :: ReadPrec [DeleteCampaignResponse] #
Show DeleteCampaignResponse Source #
Instance details Defined in Amazonka.Personalize.DeleteCampaign Methods showsPrec :: Int -> DeleteCampaignResponse -> ShowS # show :: DeleteCampaignResponse -> String # showList :: [DeleteCampaignResponse] -> ShowS #
NFData DeleteCampaignResponse Source #
Instance details Defined in Amazonka.Personalize.DeleteCampaign Methods rnf :: DeleteCampaignResponse -> () #
Eq DeleteCampaignResponse Source #
Instance details Defined in Amazonka.Personalize.DeleteCampaign Methods (==) :: DeleteCampaignResponse -> DeleteCampaignResponse -> Bool # (/=) :: DeleteCampaignResponse -> DeleteCampaignResponse -> Bool #
type Rep DeleteCampaignResponse Source #
Instance details Defined in Amazonka.Personalize.DeleteCampaign type Rep DeleteCampaignResponse = D1 ('MetaData "DeleteCampaignResponse" "Amazonka.Personalize.DeleteCampaign" "amazonka-personalize-2.0-9kdbGNMxU7zEIoXPqEwwTg" 'False) (C1 ('MetaCons "DeleteCampaignResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteCampaignResponse :: DeleteCampaignResponse Source #

Create a value of DeleteCampaignResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.