CREATECAMPAIGN()`¶

About CreateCampaign¶

You incur campaign costs while it is active. To avoid unnecessary costs, make sure to delete the campaign when you are finished. For information about campaign costs, see Amazon Personalize pricing.

Creates a campaign that deploys a solution version. When a client calls the GetRecommendations and GetPersonalizedRanking APIs, a campaign is specified in the request.

Minimum Provisioned TPS and Auto-Scaling

A high minProvisionedTPS will increase your cost. We recommend starting with 1 for minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the minProvisionedTPS as necessary.

When you create an Amazon Personalize campaign, you can specify the minimum provisioned transactions per second (minProvisionedTPS) for the campaign. This is the baseline transaction throughput for the campaign provisioned by Amazon Personalize. It sets the minimum billing charge for the campaign while it is active. A transaction is a single GetRecommendations or GetPersonalizedRanking request. The default minProvisionedTPS is 1.

If your TPS increases beyond the minProvisionedTPS, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minProvisionedTPS. There's a short time delay while the capacity is increased that might cause loss of transactions. When your traffic reduces, capacity returns to the minProvisionedTPS.

You are charged for the the minimum provisioned TPS or, if your requests exceed the minProvisionedTPS, the actual TPS. The actual TPS is the total number of recommendation requests you make. We recommend starting with a low minProvisionedTPS, track your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS as necessary.

For more information about campaign costs, see Amazon Personalize pricing.

Status

A campaign can be in one of the following states:

CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS

To get the campaign status, call DescribeCampaign.

Wait until the status of the campaign is ACTIVE before asking the campaign for recommendations.

Related APIs

Method Signature¶

METHODS /AWS1/IF_PZZ~CREATECAMPAIGN
  IMPORTING
    !IV_NAME TYPE /AWS1/PZZNAME OPTIONAL
    !IV_SOLUTIONVERSIONARN TYPE /AWS1/PZZARN OPTIONAL
    !IV_MINPROVISIONEDTPS TYPE /AWS1/PZZTRANSACTIONSPERSECOND OPTIONAL
    !IO_CAMPAIGNCONFIG TYPE REF TO /AWS1/CL_PZZCAMPAIGNCONFIG OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_PZZTAG=>TT_TAGS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_pzzcreatecampaignrsp
  RAISING
    /AWS1/CX_PZZINVALIDINPUTEX
    /AWS1/CX_PZZLIMITEXCEEDEDEX
    /AWS1/CX_PZZRESRCALRDYEXISTSEX
    /AWS1/CX_PZZRESOURCEINUSEEX
    /AWS1/CX_PZZRESOURCENOTFOUNDEX
    /AWS1/CX_PZZTOOMANYTAGSEX
    /AWS1/CX_PZZCLIENTEXC
    /AWS1/CX_PZZSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_name` `TYPE /AWS1/PZZNAME` `/AWS1/PZZNAME`¶

A name for the new campaign. The campaign name must be unique within your account.

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

The Amazon Resource Name (ARN) of the trained model to deploy with the campaign. 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.

Optional arguments:¶

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

`it_tags` `TYPE /AWS1/CL_PZZTAG=>TT_TAGS` `TT_TAGS`¶

A list of tags to apply to the campaign.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_pzzcreatecampaignrsp` `/AWS1/CL_PZZCREATECAMPAIGNRSP`¶

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->createcampaign(
  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(
          key = |string|
          value = new /aws1/cl_pzzrankinginfluence_w( |0.1| )
        )
      )
    )
    iv_enbmetwithrecommendations = ABAP_TRUE
    iv_syncwithlatestsolutionvrs = ABAP_TRUE
  )
  it_tags = VALUE /aws1/cl_pzztag=>tt_tags(
    (
      new /aws1/cl_pzztag(
        iv_tagkey = |string|
        iv_tagvalue = |string|
      )
    )
  )
  iv_minprovisionedtps = 123
  iv_name = |string|
  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=>CREATECAMPAIGN()¶