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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates a campaign by either deploying a new solution or changing the value of the campaign's minProvisionedTPS parameter.

To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign operation.

You can still get recommendations from a campaign while an update is in progress. The campaign will use the previous solution version and campaign configuration to generate recommendations until the latest campaign update status is Active.

For more information on campaigns, see CreateCampaign.

Creating a Request

data UpdateCampaign Source #

See: newUpdateCampaign smart constructor.

Constructors

UpdateCampaign'
Fields campaignConfig :: Maybe CampaignConfig The configuration details of a campaign. minProvisionedTPS :: Maybe Natural Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support. solutionVersionArn :: Maybe Text The ARN of a new solution version to deploy. campaignArn :: Text The Amazon Resource Name (ARN) of the campaign.

Instances

Instances details

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

newUpdateCampaign Source #

Arguments

:: Text	`UpdateCampaign`
-> UpdateCampaign

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

UpdateCampaign, updateCampaign_campaignConfig - The configuration details of a campaign.

UpdateCampaign, updateCampaign_minProvisionedTPS - Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.

UpdateCampaign, updateCampaign_solutionVersionArn - The ARN of a new solution version to deploy.

UpdateCampaign, updateCampaign_campaignArn - The Amazon Resource Name (ARN) of the campaign.

Request Lenses

updateCampaign_campaignConfig :: Lens' UpdateCampaign (Maybe CampaignConfig) Source #

The configuration details of a campaign.

updateCampaign_minProvisionedTPS :: Lens' UpdateCampaign (Maybe Natural) Source #

Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.

updateCampaign_solutionVersionArn :: Lens' UpdateCampaign (Maybe Text) Source #

The ARN of a new solution version to deploy.

updateCampaign_campaignArn :: Lens' UpdateCampaign Text Source #

The Amazon Resource Name (ARN) of the campaign.

Destructuring the Response

data UpdateCampaignResponse Source #

See: newUpdateCampaignResponse smart constructor.

Constructors

UpdateCampaignResponse'
Fields campaignArn :: Maybe Text The same campaign ARN as given in the request. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateCampaignResponse Source #
Instance details Defined in Amazonka.Personalize.UpdateCampaign Associated Types type Rep UpdateCampaignResponse :: Type -> Type # Methods from :: UpdateCampaignResponse -> Rep UpdateCampaignResponse x # to :: Rep UpdateCampaignResponse x -> UpdateCampaignResponse #
Read UpdateCampaignResponse Source #
Instance details Defined in Amazonka.Personalize.UpdateCampaign Methods readsPrec :: Int -> ReadS UpdateCampaignResponse # readList :: ReadS [UpdateCampaignResponse] # readPrec :: ReadPrec UpdateCampaignResponse # readListPrec :: ReadPrec [UpdateCampaignResponse] #
Show UpdateCampaignResponse Source #
Instance details Defined in Amazonka.Personalize.UpdateCampaign Methods showsPrec :: Int -> UpdateCampaignResponse -> ShowS # show :: UpdateCampaignResponse -> String # showList :: [UpdateCampaignResponse] -> ShowS #
NFData UpdateCampaignResponse Source #
Instance details Defined in Amazonka.Personalize.UpdateCampaign Methods rnf :: UpdateCampaignResponse -> () #
Eq UpdateCampaignResponse Source #
Instance details Defined in Amazonka.Personalize.UpdateCampaign Methods (==) :: UpdateCampaignResponse -> UpdateCampaignResponse -> Bool # (/=) :: UpdateCampaignResponse -> UpdateCampaignResponse -> Bool #
type Rep UpdateCampaignResponse Source #
Instance details Defined in Amazonka.Personalize.UpdateCampaign type Rep UpdateCampaignResponse = D1 ('MetaData "UpdateCampaignResponse" "Amazonka.Personalize.UpdateCampaign" "amazonka-personalize-2.0-9kdbGNMxU7zEIoXPqEwwTg" 'False) (C1 ('MetaCons "UpdateCampaignResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "campaignArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateCampaignResponse Source #

Arguments

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

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

UpdateCampaign, updateCampaignResponse_campaignArn - The same campaign ARN as given in the request.

$sel:httpStatus:UpdateCampaignResponse', updateCampaignResponse_httpStatus - The response's http status code.

Response Lenses

updateCampaignResponse_campaignArn :: Lens' UpdateCampaignResponse (Maybe Text) Source #

The same campaign ARN as given in the request.

updateCampaignResponse_httpStatus :: Lens' UpdateCampaignResponse Int Source #

The response's http status code.