UPDATECAMPAIGN()`¶

About UpdateCampaign¶

Updates a campaign to deploy a retrained solution version with an existing campaign, change your campaign's minProvisionedTPS, or modify your campaign's configuration. For example, you can set enableMetadataWithRecommendations to true for an existing campaign.

To update a campaign to start automatically using the latest solution version, specify the following:

For the SolutionVersionArn parameter, specify the Amazon Resource Name (ARN) of your solution in SolutionArn/$LATEST format.
In the campaignConfig, set syncWithLatestSolutionVersion to true.

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 about updating a campaign, including code samples, see Updating a campaign. For more information about campaigns, see Creating a campaign.

Method Signature¶

METHODS /AWS1/IF_PZZ~UPDATECAMPAIGN
  IMPORTING
    !IV_CAMPAIGNARN TYPE /AWS1/PZZARN OPTIONAL
    !IV_SOLUTIONVERSIONARN TYPE /AWS1/PZZARN OPTIONAL
    !IV_MINPROVISIONEDTPS TYPE /AWS1/PZZTRANSACTIONSPERSECOND OPTIONAL
    !IO_CAMPAIGNCONFIG TYPE REF TO /AWS1/CL_PZZCAMPAIGNCONFIG OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_pzzupdatecampaignrsp
  RAISING
    /AWS1/CX_PZZINVALIDINPUTEX
    /AWS1/CX_PZZRESOURCEINUSEEX
    /AWS1/CX_PZZRESOURCENOTFOUNDEX
    /AWS1/CX_PZZCLIENTEXC
    /AWS1/CX_PZZSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_campaignarn` `TYPE /AWS1/PZZARN` `/AWS1/PZZARN`¶

The Amazon Resource Name (ARN) of the campaign.

Optional arguments:¶

`iv_solutionversionarn` `TYPE /AWS1/PZZARN` `/AWS1/PZZARN`¶

The Amazon Resource Name (ARN) of a new model to deploy. To specify the latest solution version of your solution, specify the ARN of your solution in SolutionArn/$LATEST format. You must use this format if you set syncWithLatestSolutionVersion to True in the CampaignConfig.

To deploy a model that isn't the latest solution version of your solution, specify the ARN of the solution version.

For more information about automatic campaign updates, see Enabling automatic campaign updates.

`iv_minprovisionedtps` `TYPE /AWS1/PZZTRANSACTIONSPERSECOND` `/AWS1/PZZTRANSACTIONSPERSECOND`¶

Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support. A high minProvisionedTPS will increase your bill. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.

`io_campaignconfig` `TYPE REF TO /AWS1/CL_PZZCAMPAIGNCONFIG` `/AWS1/CL_PZZCAMPAIGNCONFIG`¶

The configuration details of a campaign.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_pzzupdatecampaignrsp` `/AWS1/CL_PZZUPDATECAMPAIGNRSP`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->updatecampaign(
  io_campaignconfig = new /aws1/cl_pzzcampaignconfig(
    it_itemexplorationconfig = VALUE /aws1/cl_pzzhyperparameters_w=>tt_hyperparameters(
      (
        VALUE /aws1/cl_pzzhyperparameters_w=>ts_hyperparameters_maprow(
          key = |string|
          value = new /aws1/cl_pzzhyperparameters_w( |string| )
        )
      )
    )
    it_rankinginfluence = VALUE /aws1/cl_pzzrankinginfluence_w=>tt_rankinginfluence(
      (
        VALUE /aws1/cl_pzzrankinginfluence_w=>ts_rankinginfluence_maprow(
          value = new /aws1/cl_pzzrankinginfluence_w( |0.1| )
          key = |string|
        )
      )
    )
    iv_enbmetwithrecommendations = ABAP_TRUE
    iv_syncwithlatestsolutionvrs = ABAP_TRUE
  )
  iv_campaignarn = |string|
  iv_minprovisionedtps = 123
  iv_solutionversionarn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_arn = lo_result->get_campaignarn( ).
ENDIF.

/AWS1/IF_PZZ=>UPDATECAMPAIGN()¶