CreateCampaign - Amazon Personalize

CreateCampaign

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

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

重要

minProvisionedTPS の値を高く設定するとコストが増加します。最初はデフォルトのロールを使用することをお勧めします。低い minProvisionedTPS から始めて、Amazon CloudWatch メトリクスを使用して使用状況を追跡し、必要に応じて を引き上げることをお勧めします。

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 を呼び出します。

注記

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

リクエストの構文

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

リクエストパラメータ

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

campaignConfig

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

型: CampaignConfig オブジェクト

必須: いいえ

minProvisionedTPS

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

型: 整数

有効な範囲: 最小値 は 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 を使用する方法の詳細については、以下を参照してください。