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

# UpdateCampaign
<a name="API_UpdateCampaign"></a>

 既存のキャンペーンで再トレーニングされたソリューションバージョンをデプロイするためにキャンペーンを更新し、キャンペーンの `minProvisionedTPS` を変更し、またはキャンペーンの構成を変更します。例えば、既存のキャンペーンに対して `enableMetadataWithRecommendations` を true に設定できます。

 最新のソリューションバージョンを使用してキャンペーンを自動的に開始するように更新するには、以下を指定します。
+ `SolutionVersionArn` パラメータには、ソリューションの Amazon リソースネーム (ARN) を `SolutionArn/$LATEST` 形式で指定します。
+  `campaignConfig` で、`syncWithLatestSolutionVersion` を `true` に設定します。

キャンペーンを更新するには、キャンペーンのステータスが ACTIVE または CREATE FAILED である必要があります。[DescribeCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html) オペレーションを使用してキャンペーンのステータスを確認します。

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

コードサンプルなど、キャンペーンの更新について詳しくは、「[キャンペーンの更新](https://docs.aws.amazon.com/personalize/latest/dg/update-campaigns.html)」を参照してください。キャンペーンの作成について詳細は、「キャンペーンの作成」を参照してください。

## リクエストの構文
<a name="API_UpdateCampaign_RequestSyntax"></a>

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

## リクエストパラメーター
<a name="API_UpdateCampaign_RequestParameters"></a>

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

 ** [campaignArn](#API_UpdateCampaign_RequestSyntax) **   <a name="personalize-UpdateCampaign-request-campaignArn"></a>
キャンペーンの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

 ** [campaignConfig](#API_UpdateCampaign_RequestSyntax) **   <a name="personalize-UpdateCampaign-request-campaignConfig"></a>
キャンペーンの設定の詳細。  
型: [CampaignConfig](API_CampaignConfig.md) オブジェクト  
必須: いいえ

 ** [minProvisionedTPS](#API_UpdateCampaign_RequestSyntax) **   <a name="personalize-UpdateCampaign-request-minProvisionedTPS"></a>
Amazon Personalize がサポートする、リクエストされた 1 秒あたりの最小プロビジョンドトランザクション (推奨) を指定します。`minProvisionedTPS` を高く設定すると請求額が増加します。最初は `minProvisionedTPS` に 1 を使用することをお勧めします (デフォルト)。Amazon CloudWatch メトリクスを使用して使用状況を追跡し、必要に応じて `minProvisionedTPS` を引き上げます。  
タイプ: 整数  
有効な範囲: 最小値 は 1 です。  
必須: いいえ

 ** [solutionVersionArn](#API_UpdateCampaign_RequestSyntax) **   <a name="personalize-UpdateCampaign-request-solutionVersionArn"></a>
デプロイする新しいモデルの Amazon リソースネーム (ARN)。ソリューションの最新バージョンを指定するには、*ソリューション*の ARN を `SolutionArn/$LATEST` 形式で指定します。[CampaignConfig](https://docs.aws.amazon.com/personalize/latest/dg/API_CampaignConfig.html) で `syncWithLatestSolutionVersion` を `True` に設定する場合は、この形式を使用する必要があります。  
 ソリューションの最新バージョンではないモデルをデプロイするには、ソリューションバージョンの ARN を指定します。  
 キャンペーンの自動更新の詳細については、「[キャンペーンの自動更新を有効にする](https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-automatic-latest-sv-update)」を参照してください。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

## レスポンスの構文
<a name="API_UpdateCampaign_ResponseSyntax"></a>

```
{
   "campaignArn": "string"
}
```

## レスポンス要素
<a name="API_UpdateCampaign_ResponseElements"></a>

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

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

 ** [campaignArn](#API_UpdateCampaign_ResponseSyntax) **   <a name="personalize-UpdateCampaign-response-campaignArn"></a>
リクエストで指定されたものと同じキャンペーン ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

## エラー
<a name="API_UpdateCampaign_Errors"></a>

 ** InvalidInputException **   
フィールドまたはパラメータに有効な値を指定します。  
HTTP ステータスコード: 400

 ** ResourceInUseException **   
指定されたリソースは使用中です。  
HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
指定されたリソースが見つかりませんでした。  
HTTP ステータスコード: 400

## 以下の資料も参照してください。
<a name="API_UpdateCampaign_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/UpdateCampaign) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/UpdateCampaign) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/UpdateCampaign) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/UpdateCampaign) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/UpdateCampaign) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/UpdateCampaign) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/UpdateCampaign) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/UpdateCampaign) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/UpdateCampaign) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/UpdateCampaign)