CreateCampaign - Amazon Personalize
リクエストの構文リクエストパラメータレスポンスの構文レスポンス要素エラー以下の資料も参照してください。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

CreateCampaign

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

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

重要

minProvisionedTPS高くなると請求額が増えます。minProvisionedTPS(デフォルト) は 1 から始めることをお勧めします。Amazon CloudWatch のメトリックスを使用して使用状況を追跡し、minProvisionedTPS必要に応じて使用量を増やします。

トランザクションは単一の GetRecommendations または GetPersonalizedRanking コールです。1 秒あたりのトランザクション数 (TPS) は、Amazon Personalize のスループットと請求単位です。プロビジョンド最小 TPS (minProvisionedTPS) は、Amazon Personalize によってプロビジョニングされたベースラインスループット、つまり最小請求料金を指定します。

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

実際に使用される TPS は、5 分間のウィンドウ内の平均リクエスト数/秒として計算されます。最小プロビジョンド TPS または実際の TPS のいずれか多い金額を支払います。低いminProvisionedTPS、Amazon CloudWatch メトリクスを使用して使用状況を追跡し、必要に応じて、必要に応じてminProvisionedTPS、引き上げることをお勧めします。

ステータス

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

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

  • DELETE PENDING > DELETE IN_PROGRESS

キャンペーンのステータスを取得するには、DescribeCampaign を呼び出します。

注記

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

関連 API

リクエストの構文

{
   "campaignConfig": { 
      "itemExplorationConfig": { 
         "string" : "string" 
      }
   },
   "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 です。

パターン: ^[a-zA-Z0-9][a-zA-Z0-9\-_]*

必須: はい

solutionVersionArn

デプロイするソリューションバージョンの Amazon リソースネーム (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 のいずれかでこの API を使用する方法の詳細については、以下を参照してください。