CreateCampaign

重要

キャンペーンがアクティブである間は、キャンペーン費用が発生します。不要な費用が発生しないように、終了したら必ずキャンペーンを削除してください。キャンペーン費用については、「Amazon Personalize 料金表」を参照してください。

ソリューションバージョンをデプロイするキャンペーンを作成します。クライアントがと GetPersonalizedRankingAPI GetRecommendationsを呼び出すと、リクエストにキャンペーンが指定されます。

最小プロビジョンド TPS およびオートスケーリング

重要

minProvisionedTPS の値を高く設定するとコストが増加します。最初は minProvisionedTPS に 1 を使用することをお勧めします (デフォルト)。Amazon CloudWatch メトリックスを使用して使用状況を追跡し、minProvisionedTPS必要に応じて増やします。

Amazon Personalize のキャンペーンを作成する場合、キャンペーンの 1 秒あたりのプロビジョニングされる最小トランザクション数 (minProvisionedTPS) を指定できます。これは Amazon Personalize によってプロビジョニングされたキャンペーンのベースライントランザクションスループットです。キャンペーンがアクティブである間の最低請求額を設定します。トランザクションは単一の GetRecommendations または GetPersonalizedRanking リクエストです。デフォルト minProvisionedTPS は 1 です。

TPS が minProvisionedTPS を超えて増加した場合、Amazon Personalize はプロビジョンド容量を自動スケーリングしますが、minProvisionedTPS を下回ることはありません。容量が引き上げられている間に短時間の遅延が生じます。これにより、トランザクションの損失が生じる可能性があります。トラフィックが減少すると、容量は minProvisionedTPS に戻ります。

プロビジョニングされた最小 TPS、またはリクエストが minProvisionedTPS を超える場合は実際の TPS に対して課金されます。実際の TPS は、行ったレコメンデーションリクエストの総数です。低い値から始めminProvisionedTPS、Amazon CloudWatch のメトリクスを使用して使用状況を追跡し、minProvisionedTPS必要に応じて値を増やすことをお勧めします。

キャンペーンのコストの詳細については、「Amazon Personalize の料金」を参照してください。

[ステータス]

キャンペーンは、次に示す状態のいずれかになります。

• CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -または- CREATE FAILED

• DELETE PENDING > DELETE IN_PROGRESS

キャンペーンのステータスを確認するには、お電話くださいDescribeCampaign。

注記

キャンペーンの status が ACTIVE になるまで待ってから、キャンペーンにレコメンデーションを尋ねます。

関連 API

• ListCampaigns

• DescribeCampaign

• UpdateCampaign

• DeleteCampaign

リクエストの構文

{
   "campaignConfig": { 
      "enableMetadataWithRecommendations": boolean,
      "itemExplorationConfig": { 
         "string" : "string" 
      },
      "syncWithLatestSolutionVersion": boolean
   },
   "minProvisionedTPS": number,
   "name": "string",
   "solutionVersionArn": "string",
   "tags": [ 
      { 
         "tagKey": "string",
         "tagValue": "string"
      }
   ]
}

リクエストパラメータ

リクエストは以下の JSON 形式のデータを受け入れます。

campaignConfig

キャンペーンの設定の詳細。

タイプ：CampaignConfig オブジェクト

必須: いいえ

minProvisionedTPS

Amazon Personalize がサポートする、リクエストされた 1 秒あたりの最小プロビジョンドトランザクション (推奨) を指定します。minProvisionedTPS を高く設定すると請求額が増加します。最初は minProvisionedTPS に 1 を使用することをお勧めします (デフォルト)。Amazon CloudWatch メトリックスを使用して使用状況を追跡し、minProvisionedTPS必要に応じて増やします。

タイプ：整数

有効な範囲: 最小値 は 1 です。

必須: いいえ

name

新しいキャンペーンの名前。キャンペーン名はアカウント内で一意でなければなりません。

型: 文字列

長さの制限：最小長は 1 です。最大長は 63 です。

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]*

必須：はい

solutionVersionArn

キャンペーンでデプロイするトレーニング済みモデルの Amazon リソースネーム (ARN)。ソリューションの最新のソリューションバージョンを指定するには、ソリューションの ARN SolutionArn/$LATEST をフォーマットで指定します。syncWithLatestSolutionVersionで設定した場合は、この形式を使用する必要があります。True CampaignConfig

ソリューションの最新のソリューションバージョンではないモデルをデプロイするには、ソリューションバージョンの ARN を指定します。

キャンペーンの自動更新について詳しくは、「キャンペーンの自動更新の有効化」を参照してください。

型: 文字列

長さの制限：最大長は 256 です。

パターン：arn:([a-z\d-]+):personalize:.*:.*:.+

必須：はい

tags

関数に適用するタグのリスト

タイプ：Tag オブジェクトの配列

配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。

必須: いいえ

レスポンスの構文

{
   "campaignArn": "string"
}

レスポンス要素

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

campaignArn

キャンペーンの Amazon リソースネーム (ARN)。

型: 文字列

長さの制限：最大長は 256 です。

パターン：arn:([a-z\d-]+):personalize:.*:.*:.+

エラー

InvalidInputException

フィールドまたはパラメータに有効な値を指定します。

HTTP ステータスコード：400

LimitExceededException

1 秒あたりのリクエスト数の上限を超えています。

HTTP ステータスコード：400

ResourceAlreadyExistsException

指定したリソースはすでに存在しています。

HTTP ステータスコード：400

ResourceInUseException

指定されたリソースは使用中です。

HTTP ステータスコード：400

ResourceNotFoundException

指定されたリソースが見つかりませんでした。

HTTP ステータスコード：400

TooManyTagsException

このリソースに適用できるタグの最大数を超過しています。

HTTP ステータスコード：400

その他の参照資料

言語固有の AWS SDK の 1 つでこの API を使用する方法について詳しくは、以下を参照してください。

• AWS コマンドラインインターフェイス

• AWS SDK for .NET

• AWS SDK for C++

• AWS Go バージョン 2 用 SDK

• AWS Java V2 用 SDK

• AWS V3 用 JavaScript SDK

• AWS PHP V3 用SDK

• AWS Python 用 SDK

• AWS ルビー V3 用 SDK