UpdateCampaign - Amazon Personalize
リクエストの構文リクエストパラメータレスポンスの構文レスポンス要素エラーその他の参照資料

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

UpdateCampaign

キャンペーンを更新して、既存のキャンペーンで再トレーニング済みのソリューションバージョンをデプロイしたり、キャンペーンを変更したりminProvisionedTPS、キャンペーンの設定を変更したりします。たとえば、enableMetadataWithRecommendations既存のキャンペーンを true に設定できます。

キャンペーンを更新して自動的に最新のソリューションバージョンを使用し始めるには、以下を指定します。

  • SolutionVersionArnパラメータには、ソリューションの Amazon リソースネーム (ARN) SolutionArn/$LATEST をフォーマットで指定します。

  • でcampaignConfig、syncWithLatestSolutionVersionをに設定します。true

キャンペーンを更新するには、キャンペーンのステータスが ACTIVE または CREATE FAILED である必要があります。DescribeCampaignオペレーションを使用してキャンペーンのステータスを確認します。

注記

更新の進行中でも、キャンペーンからレコメンデーションを取得できます。最新のキャンペーン更新ステータスが Active になるまで、キャンペーンは以前のソリューションバージョンとキャンペーン設定を使用してレコメンデーションを生成します。

コードサンプルなど、キャンペーンの更新について詳しくは、「キャンペーンの更新」を参照してください。キャンペーンの作成について詳細は、「キャンペーンの作成」を参照してください。

リクエストの構文

{
   "campaignArn": "string",
   "campaignConfig": { 
      "enableMetadataWithRecommendations": boolean,
      "itemExplorationConfig": { 
         "string" : "string" 
      },
      "syncWithLatestSolutionVersion": boolean
   },
   "minProvisionedTPS": number,
   "solutionVersionArn": "string"
}

リクエストパラメータ

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

campaignArn

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

型: 文字列

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

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

必須：はい

campaignConfig

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

タイプ：CampaignConfig オブジェクト

必須: いいえ

minProvisionedTPS

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

タイプ：整数

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

必須: いいえ

solutionVersionArn

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

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

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

型: 文字列

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

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

必須: いいえ

レスポンスの構文

{
   "campaignArn": "string"
}

レスポンス要素

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

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

campaignArn

リクエストで指定されたものと同じキャンペーン ARN。

型: 文字列

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

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

エラー

InvalidInputException

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

HTTP ステータスコード：400

ResourceInUseException

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

HTTP ステータスコード：400

ResourceNotFoundException

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

HTTP ステータスコード：400

その他の参照資料

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