

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

# API リファレンス
<a name="API_Reference"></a>

このセクションでは、Amazon Personalize API の操作に関するドキュメントを提供します。リージョンごとの Amazon Personalize のエンドポイントのリストについては、*AWS 全般のリファレンス*の「[AWS リージョンとエンドポイント](https://docs.aws.amazon.com/general/latest/gr/personalize.html)」を参照してください。

**Topics**
+ [アクション](API_Operations.md)
+ [データ型](API_Types.md)
+ [共通エラー](CommonErrors.md)
+ [共通パラメータ](CommonParameters.md)

# アクション
<a name="API_Operations"></a>

次のアクションは、Amazon Personalize でサポートされています。
+  [CreateBatchInferenceJob](API_CreateBatchInferenceJob.md) 
+  [CreateBatchSegmentJob](API_CreateBatchSegmentJob.md) 
+  [CreateCampaign](API_CreateCampaign.md) 
+  [CreateDataDeletionJob](API_CreateDataDeletionJob.md) 
+  [CreateDataset](API_CreateDataset.md) 
+  [CreateDatasetExportJob](API_CreateDatasetExportJob.md) 
+  [CreateDatasetGroup](API_CreateDatasetGroup.md) 
+  [CreateDatasetImportJob](API_CreateDatasetImportJob.md) 
+  [CreateEventTracker](API_CreateEventTracker.md) 
+  [CreateFilter](API_CreateFilter.md) 
+  [CreateMetricAttribution](API_CreateMetricAttribution.md) 
+  [CreateRecommender](API_CreateRecommender.md) 
+  [CreateSchema](API_CreateSchema.md) 
+  [CreateSolution](API_CreateSolution.md) 
+  [CreateSolutionVersion](API_CreateSolutionVersion.md) 
+  [DeleteCampaign](API_DeleteCampaign.md) 
+  [DeleteDataset](API_DeleteDataset.md) 
+  [DeleteDatasetGroup](API_DeleteDatasetGroup.md) 
+  [DeleteEventTracker](API_DeleteEventTracker.md) 
+  [DeleteFilter](API_DeleteFilter.md) 
+  [DeleteMetricAttribution](API_DeleteMetricAttribution.md) 
+  [DeleteRecommender](API_DeleteRecommender.md) 
+  [DeleteSchema](API_DeleteSchema.md) 
+  [DeleteSolution](API_DeleteSolution.md) 
+  [DescribeAlgorithm](API_DescribeAlgorithm.md) 
+  [DescribeBatchInferenceJob](API_DescribeBatchInferenceJob.md) 
+  [DescribeBatchSegmentJob](API_DescribeBatchSegmentJob.md) 
+  [DescribeCampaign](API_DescribeCampaign.md) 
+  [DescribeDataDeletionJob](API_DescribeDataDeletionJob.md) 
+  [DescribeDataset](API_DescribeDataset.md) 
+  [DescribeDatasetExportJob](API_DescribeDatasetExportJob.md) 
+  [DescribeDatasetGroup](API_DescribeDatasetGroup.md) 
+  [DescribeDatasetImportJob](API_DescribeDatasetImportJob.md) 
+  [DescribeEventTracker](API_DescribeEventTracker.md) 
+  [DescribeFeatureTransformation](API_DescribeFeatureTransformation.md) 
+  [DescribeFilter](API_DescribeFilter.md) 
+  [DescribeMetricAttribution](API_DescribeMetricAttribution.md) 
+  [DescribeRecipe](API_DescribeRecipe.md) 
+  [DescribeRecommender](API_DescribeRecommender.md) 
+  [DescribeSchema](API_DescribeSchema.md) 
+  [DescribeSolution](API_DescribeSolution.md) 
+  [DescribeSolutionVersion](API_DescribeSolutionVersion.md) 
+  [GetSolutionMetrics](API_GetSolutionMetrics.md) 
+  [ListBatchInferenceJobs](API_ListBatchInferenceJobs.md) 
+  [ListBatchSegmentJobs](API_ListBatchSegmentJobs.md) 
+  [ListCampaigns](API_ListCampaigns.md) 
+  [ListDataDeletionJobs](API_ListDataDeletionJobs.md) 
+  [ListDatasetExportJobs](API_ListDatasetExportJobs.md) 
+  [ListDatasetGroups](API_ListDatasetGroups.md) 
+  [ListDatasetImportJobs](API_ListDatasetImportJobs.md) 
+  [ListDatasets](API_ListDatasets.md) 
+  [ListEventTrackers](API_ListEventTrackers.md) 
+  [ListFilters](API_ListFilters.md) 
+  [ListMetricAttributionMetrics](API_ListMetricAttributionMetrics.md) 
+  [ListMetricAttributions](API_ListMetricAttributions.md) 
+  [ListRecipes](API_ListRecipes.md) 
+  [ListRecommenders](API_ListRecommenders.md) 
+  [ListSchemas](API_ListSchemas.md) 
+  [ListSolutions](API_ListSolutions.md) 
+  [ListSolutionVersions](API_ListSolutionVersions.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [StartRecommender](API_StartRecommender.md) 
+  [StopRecommender](API_StopRecommender.md) 
+  [StopSolutionVersionCreation](API_StopSolutionVersionCreation.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateCampaign](API_UpdateCampaign.md) 
+  [UpdateDataset](API_UpdateDataset.md) 
+  [UpdateMetricAttribution](API_UpdateMetricAttribution.md) 
+  [UpdateRecommender](API_UpdateRecommender.md) 
+  [UpdateSolution](API_UpdateSolution.md) 

次のアクションは、Amazon Personalize Events でサポートされています。
+  [PutActionInteractions](API_UBS_PutActionInteractions.md) 
+  [PutActions](API_UBS_PutActions.md) 
+  [PutEvents](API_UBS_PutEvents.md) 
+  [PutItems](API_UBS_PutItems.md) 
+  [PutUsers](API_UBS_PutUsers.md) 

次のアクションは、Amazon Personalize Runtime でサポートされています。
+  [GetActionRecommendations](API_RS_GetActionRecommendations.md) 
+  [GetPersonalizedRanking](API_RS_GetPersonalizedRanking.md) 
+  [GetRecommendations](API_RS_GetRecommendations.md) 

# Amazon Personalize
<a name="API_Operations_Amazon_Personalize"></a>

次のアクションは、Amazon Personalize でサポートされています。
+  [CreateBatchInferenceJob](API_CreateBatchInferenceJob.md) 
+  [CreateBatchSegmentJob](API_CreateBatchSegmentJob.md) 
+  [CreateCampaign](API_CreateCampaign.md) 
+  [CreateDataDeletionJob](API_CreateDataDeletionJob.md) 
+  [CreateDataset](API_CreateDataset.md) 
+  [CreateDatasetExportJob](API_CreateDatasetExportJob.md) 
+  [CreateDatasetGroup](API_CreateDatasetGroup.md) 
+  [CreateDatasetImportJob](API_CreateDatasetImportJob.md) 
+  [CreateEventTracker](API_CreateEventTracker.md) 
+  [CreateFilter](API_CreateFilter.md) 
+  [CreateMetricAttribution](API_CreateMetricAttribution.md) 
+  [CreateRecommender](API_CreateRecommender.md) 
+  [CreateSchema](API_CreateSchema.md) 
+  [CreateSolution](API_CreateSolution.md) 
+  [CreateSolutionVersion](API_CreateSolutionVersion.md) 
+  [DeleteCampaign](API_DeleteCampaign.md) 
+  [DeleteDataset](API_DeleteDataset.md) 
+  [DeleteDatasetGroup](API_DeleteDatasetGroup.md) 
+  [DeleteEventTracker](API_DeleteEventTracker.md) 
+  [DeleteFilter](API_DeleteFilter.md) 
+  [DeleteMetricAttribution](API_DeleteMetricAttribution.md) 
+  [DeleteRecommender](API_DeleteRecommender.md) 
+  [DeleteSchema](API_DeleteSchema.md) 
+  [DeleteSolution](API_DeleteSolution.md) 
+  [DescribeAlgorithm](API_DescribeAlgorithm.md) 
+  [DescribeBatchInferenceJob](API_DescribeBatchInferenceJob.md) 
+  [DescribeBatchSegmentJob](API_DescribeBatchSegmentJob.md) 
+  [DescribeCampaign](API_DescribeCampaign.md) 
+  [DescribeDataDeletionJob](API_DescribeDataDeletionJob.md) 
+  [DescribeDataset](API_DescribeDataset.md) 
+  [DescribeDatasetExportJob](API_DescribeDatasetExportJob.md) 
+  [DescribeDatasetGroup](API_DescribeDatasetGroup.md) 
+  [DescribeDatasetImportJob](API_DescribeDatasetImportJob.md) 
+  [DescribeEventTracker](API_DescribeEventTracker.md) 
+  [DescribeFeatureTransformation](API_DescribeFeatureTransformation.md) 
+  [DescribeFilter](API_DescribeFilter.md) 
+  [DescribeMetricAttribution](API_DescribeMetricAttribution.md) 
+  [DescribeRecipe](API_DescribeRecipe.md) 
+  [DescribeRecommender](API_DescribeRecommender.md) 
+  [DescribeSchema](API_DescribeSchema.md) 
+  [DescribeSolution](API_DescribeSolution.md) 
+  [DescribeSolutionVersion](API_DescribeSolutionVersion.md) 
+  [GetSolutionMetrics](API_GetSolutionMetrics.md) 
+  [ListBatchInferenceJobs](API_ListBatchInferenceJobs.md) 
+  [ListBatchSegmentJobs](API_ListBatchSegmentJobs.md) 
+  [ListCampaigns](API_ListCampaigns.md) 
+  [ListDataDeletionJobs](API_ListDataDeletionJobs.md) 
+  [ListDatasetExportJobs](API_ListDatasetExportJobs.md) 
+  [ListDatasetGroups](API_ListDatasetGroups.md) 
+  [ListDatasetImportJobs](API_ListDatasetImportJobs.md) 
+  [ListDatasets](API_ListDatasets.md) 
+  [ListEventTrackers](API_ListEventTrackers.md) 
+  [ListFilters](API_ListFilters.md) 
+  [ListMetricAttributionMetrics](API_ListMetricAttributionMetrics.md) 
+  [ListMetricAttributions](API_ListMetricAttributions.md) 
+  [ListRecipes](API_ListRecipes.md) 
+  [ListRecommenders](API_ListRecommenders.md) 
+  [ListSchemas](API_ListSchemas.md) 
+  [ListSolutions](API_ListSolutions.md) 
+  [ListSolutionVersions](API_ListSolutionVersions.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [StartRecommender](API_StartRecommender.md) 
+  [StopRecommender](API_StopRecommender.md) 
+  [StopSolutionVersionCreation](API_StopSolutionVersionCreation.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateCampaign](API_UpdateCampaign.md) 
+  [UpdateDataset](API_UpdateDataset.md) 
+  [UpdateMetricAttribution](API_UpdateMetricAttribution.md) 
+  [UpdateRecommender](API_UpdateRecommender.md) 
+  [UpdateSolution](API_UpdateSolution.md) 

# CreateBatchInferenceJob
<a name="API_CreateBatchInferenceJob"></a>

Amazon S3 に保存されているアイテムまたはユーザーのリストに基づいてバッチレコメンデーションを生成し、レコメンデーションを Amazon S3 バケットにエクスポートします。

バッチレコメンデーションを生成するには、ソリューションバージョンの ARN と、入出力データの Amazon S3 URI を指定します。ユーザーパーソナライズ、人気アイテム、パーソナライズされたランキングソリューションの場合、バッチ推論ジョブによって入力ファイル内のユーザー ID ごとに推奨アイテムのリストが生成されます。関連アイテムソリューションの場合、ジョブによって入力ファイル内のアイテム ID ごとに推奨アイテムのリストが生成されます。

詳細については、「[バッチ推論ジョブの作成](https://docs.aws.amazon.com/personalize/latest/dg/getting-batch-recommendations.html)」を参照してください。

 Similar-Items レシピを使用する場合、Amazon Personalize はバッチレコメンデーションにわかりやすいテーマを追加できます。テーマを生成するには、ジョブのモードを `THEME_GENERATION` に設定し、入力データの項目名を含むフィールド名を指定します。

 テーマの生成の詳細については、「[Batch recommendations with themes from Content Generator](https://docs.aws.amazon.com/personalize/latest/dg/themed-batch-recommendations.html)」を参照してください。

Trending-Now レシピまたは Next-Best-Action レシピではバッチレコメンデーションを取得することはできません。

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

```
{
   "batchInferenceJobConfig": { 
      "itemExplorationConfig": { 
         "string" : "string" 
      },
      "rankingInfluence": { 
         "string" : number 
      }
   },
   "batchInferenceJobMode": "string",
   "filterArn": "string",
   "jobInput": { 
      "s3DataSource": { 
         "kmsKeyArn": "string",
         "path": "string"
      }
   },
   "jobName": "string",
   "jobOutput": { 
      "s3DataDestination": { 
         "kmsKeyArn": "string",
         "path": "string"
      }
   },
   "numResults": number,
   "roleArn": "string",
   "solutionVersionArn": "string",
   "tags": [ 
      { 
         "tagKey": "string",
         "tagValue": "string"
      }
   ],
   "themeGenerationConfig": { 
      "fieldsForThemeGeneration": { 
         "itemName": "string"
      }
   }
}
```

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

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

 ** [batchInferenceJobConfig](#API_CreateBatchInferenceJob_RequestSyntax) **   <a name="personalize-CreateBatchInferenceJob-request-batchInferenceJobConfig"></a>
バッチ推論ジョブの設定の詳細。  
型: [BatchInferenceJobConfig](API_BatchInferenceJobConfig.md) オブジェクト  
必須: いいえ

 ** [batchInferenceJobMode](#API_CreateBatchInferenceJob_RequestSyntax) **   <a name="personalize-CreateBatchInferenceJob-request-batchInferenceJobMode"></a>
バッチ推論ジョブのモード。類似アイテムのグループを説明するテーマを生成するには、ジョブモードを `THEME_GENERATION` に設定します。テーマを生成しない場合は、デフォルトの `BATCH_INFERENCE` を使用します。  
 テーマ付きバッチレコメンデーションを取得すると、追加コストが発生します。詳細については、「[Amazon Personalize の料金](https://aws.amazon.com/personalize/pricing/)」を参照してください。  
型: 文字列  
有効な値：`BATCH_INFERENCE | THEME_GENERATION`  
必須：いいえ

 ** [filterArn](#API_CreateBatchInferenceJob_RequestSyntax) **   <a name="personalize-CreateBatchInferenceJob-request-filterArn"></a>
バッチ推論ジョブに適用するフィルターの ARN。フィルターの使用の詳細については、「[バッチのレコメンデーションのフィルタリング](https://docs.aws.amazon.com/personalize/latest/dg/filter-batch.html)」を参照してください。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** [jobInput](#API_CreateBatchInferenceJob_RequestSyntax) **   <a name="personalize-CreateBatchInferenceJob-request-jobInput"></a>
レコメンデーションのベースとなる入力ファイルの格納場所への Amazon S3 パス。入力資料は JSON 形式である必要があります。  
型: [BatchInferenceJobInput](API_BatchInferenceJobInput.md) オブジェクト  
必須: はい

 ** [jobName](#API_CreateBatchInferenceJob_RequestSyntax) **   <a name="personalize-CreateBatchInferenceJob-request-jobName"></a>
作成するバッチ推論ジョブの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: はい

 ** [jobOutput](#API_CreateBatchInferenceJob_RequestSyntax) **   <a name="personalize-CreateBatchInferenceJob-request-jobOutput"></a>
ジョブの出力が保存される Amazon S3 バケットへのパス。  
型: [BatchInferenceJobOutput](API_BatchInferenceJobOutput.md) オブジェクト  
必須: はい

 ** [numResults](#API_CreateBatchInferenceJob_RequestSyntax) **   <a name="personalize-CreateBatchInferenceJob-request-numResults"></a>
取得するレコメンデーションの数。  
タイプ: 整数  
必須: いいえ

 ** [roleArn](#API_CreateBatchInferenceJob_RequestSyntax) **   <a name="personalize-CreateBatchInferenceJob-request-roleArn"></a>
入力および出力 Amazon S3 バケットに対してそれぞれ読み取りおよび書き込みを実行するための許可を持つ Amazon Identity and Access Management ロールの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`   
必須: はい

 ** [solutionVersionArn](#API_CreateBatchInferenceJob_RequestSyntax) **   <a name="personalize-CreateBatchInferenceJob-request-solutionVersionArn"></a>
バッチ推論レコメンデーションの生成に使用するソリューションバージョンの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

 ** [tags](#API_CreateBatchInferenceJob_RequestSyntax) **   <a name="personalize-CreateBatchInferenceJob-request-tags"></a>
バッチ推論ジョブに適用する[タグ](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)のリスト。  
型: [Tag](API_Tag.md) オブジェクトの配列  
配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。  
必須: いいえ

 ** [themeGenerationConfig](#API_CreateBatchInferenceJob_RequestSyntax) **   <a name="personalize-CreateBatchInferenceJob-request-themeGenerationConfig"></a>
テーマ生成ジョブでは、各アイテムの名前を含むアイテムデータセット内の列の名前を指定します。  
型: [ThemeGenerationConfig](API_ThemeGenerationConfig.md) オブジェクト  
必須: いいえ

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

```
{
   "batchInferenceJobArn": "string"
}
```

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

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

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

 ** [batchInferenceJobArn](#API_CreateBatchInferenceJob_ResponseSyntax) **   <a name="personalize-CreateBatchInferenceJob-response-batchInferenceJobArn"></a>
バッチ推論ジョブの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

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

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

 ** LimitExceededException **   
1 秒あたりのリクエスト数の上限を超えています。  
HTTP ステータスコード: 400

 ** ResourceAlreadyExistsException **   
指定したリソースはすでに存在しています。  
HTTP ステータスコード: 400

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

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

 ** TooManyTagsException **   
このリソースに適用できるタグの最大数を超過しています。  
HTTP ステータスコード: 400

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

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

# CreateBatchSegmentJob
<a name="API_CreateBatchSegmentJob"></a>

バッチセグメントジョブを作成します。この操作は最大 5,000 万レコードを処理でき、入力ファイルは JSON 形式である必要があります。詳細については、「[バッチレコメンデーションとユーザーセグメントの取得](https://docs.aws.amazon.com/personalize/latest/dg/recommendations-batch.html)」を参照してください。

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

```
{
   "filterArn": "string",
   "jobInput": { 
      "s3DataSource": { 
         "kmsKeyArn": "string",
         "path": "string"
      }
   },
   "jobName": "string",
   "jobOutput": { 
      "s3DataDestination": { 
         "kmsKeyArn": "string",
         "path": "string"
      }
   },
   "numResults": number,
   "roleArn": "string",
   "solutionVersionArn": "string",
   "tags": [ 
      { 
         "tagKey": "string",
         "tagValue": "string"
      }
   ]
}
```

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

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

 ** [filterArn](#API_CreateBatchSegmentJob_RequestSyntax) **   <a name="personalize-CreateBatchSegmentJob-request-filterArn"></a>
バッチセグメントジョブに適用するフィルターの ARN。フィルターの使用についての詳細は、「[バッチのレコメンデーションのフィルタリング](https://docs.aws.amazon.com/personalize/latest/dg/filter-batch.html)」を参照してください。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** [jobInput](#API_CreateBatchSegmentJob_RequestSyntax) **   <a name="personalize-CreateBatchSegmentJob-request-jobInput"></a>
バッチセグメントジョブの生成に使用される入力データの Amazon S3 パス。  
型: [BatchSegmentJobInput](API_BatchSegmentJobInput.md) オブジェクト  
必須: はい

 ** [jobName](#API_CreateBatchSegmentJob_RequestSyntax) **   <a name="personalize-CreateBatchSegmentJob-request-jobName"></a>
作成するバッチセグメントジョブの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: はい

 ** [jobOutput](#API_CreateBatchSegmentJob_RequestSyntax) **   <a name="personalize-CreateBatchSegmentJob-request-jobOutput"></a>
ジョブの出力が保存されるバケットの Amazon S3 パス。  
型: [BatchSegmentJobOutput](API_BatchSegmentJobOutput.md) オブジェクト  
必須: はい

 ** [numResults](#API_CreateBatchSegmentJob_RequestSyntax) **   <a name="personalize-CreateBatchSegmentJob-request-numResults"></a>
入力データの各行のバッチセグメントジョブによって生成された予測ユーザーの数。セグメントあたりのユーザーの最大数は 500 万人です。  
タイプ: 整数  
必須: いいえ

 ** [roleArn](#API_CreateBatchSegmentJob_RequestSyntax) **   <a name="personalize-CreateBatchSegmentJob-request-roleArn"></a>
入力および出力 Amazon S3 バケットに対してそれぞれ読み取りおよび書き込みを実行するための許可を持つ Amazon Identity and Access Management ロールの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`   
必須: はい

 ** [solutionVersionArn](#API_CreateBatchSegmentJob_RequestSyntax) **   <a name="personalize-CreateBatchSegmentJob-request-solutionVersionArn"></a>
バッチセグメントジョブでバッチセグメントを生成するために使用するソリューションバージョンの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

 ** [tags](#API_CreateBatchSegmentJob_RequestSyntax) **   <a name="personalize-CreateBatchSegmentJob-request-tags"></a>
バッチセグメントジョブに適用する[タグ](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)のリスト。  
型: [Tag](API_Tag.md) オブジェクトの配列  
配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。  
必須: いいえ

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

```
{
   "batchSegmentJobArn": "string"
}
```

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

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

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

 ** [batchSegmentJobArn](#API_CreateBatchSegmentJob_ResponseSyntax) **   <a name="personalize-CreateBatchSegmentJob-response-batchSegmentJobArn"></a>
バッチセグメントジョブの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

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

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

 ** LimitExceededException **   
1 秒あたりのリクエスト数の上限を超えています。  
HTTP ステータスコード: 400

 ** ResourceAlreadyExistsException **   
指定したリソースはすでに存在しています。  
HTTP ステータスコード: 400

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

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

 ** TooManyTagsException **   
このリソースに適用できるタグの最大数を超過しています。  
HTTP ステータスコード: 400

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

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

# CreateCampaign
<a name="API_CreateCampaign"></a>

**重要**  
 キャンペーンがアクティブになっている間は、キャンペーンコストが発生します。不要なコストを避けるため、完了したらキャンペーンを削除します。キャンペーンのコストの詳細については、「[Amazon Personalize の料金](https://aws.amazon.com/personalize/pricing/)」を参照してください。

ソリューションバージョンをデプロイするキャンペーンを作成します。クライアントが [GetRecommendations](https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) および [GetPersonalizedRanking](https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetPersonalizedRanking.html) API を呼び出すと、キャンペーンがリクエストで指定されます。

 **最小プロビジョンド 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 の料金](https://aws.amazon.com/personalize/pricing/)」を参照してください。

 **ステータス** 

キャンペーンは、次に示す状態のいずれかになります。
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -または- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS

キャンペーンのステータスを取得するには、[DescribeCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html) を呼び出します。

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

**関連 API**
+  [ListCampaigns](https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html) 
+  [DescribeCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html) 
+  [UpdateCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateCampaign.html) 
+  [DeleteCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteCampaign.html) 

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

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

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

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

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

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

 ** [name](#API_CreateCampaign_RequestSyntax) **   <a name="personalize-CreateCampaign-request-name"></a>
新しいキャンペーンの名前。キャンペーン名はアカウント内で一意でなければなりません。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: はい

 ** [solutionVersionArn](#API_CreateCampaign_RequestSyntax) **   <a name="personalize-CreateCampaign-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:.*:.*:.+`   
必須: はい

 ** [tags](#API_CreateCampaign_RequestSyntax) **   <a name="personalize-CreateCampaign-request-tags"></a>
関数に適用する[タグ](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)のリスト  
型: [Tag](API_Tag.md) オブジェクトの配列  
配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。  
必須: いいえ

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

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

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

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

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

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

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

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

 ** LimitExceededException **   
1 秒あたりのリクエスト数の上限を超えています。  
HTTP ステータスコード: 400

 ** ResourceAlreadyExistsException **   
指定したリソースはすでに存在しています。  
HTTP ステータスコード: 400

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

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

 ** TooManyTagsException **   
このリソースに適用できるタグの最大数を超過しています。  
HTTP ステータスコード: 400

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

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

# CreateDataDeletionJob
<a name="API_CreateDataDeletionJob"></a>

Amazon Personalize データセットグループから特定のユーザーへのすべての参照をバッチで削除するバッチジョブを作成します。Amazon S3 バケットの userId の CSV ファイルで削除するユーザーを指定します。ジョブが完了すると、Amazon Personalize はユーザーのデータをトレーニングしなくなり、ユーザーセグメントの生成時にユーザーを考慮しなくなります。データ削除ジョブの作成の詳細については、「[ユーザーの削除](https://docs.aws.amazon.com/personalize/latest/dg/delete-records.html)」を参照してください。
+ 入力ファイルは、ユーザー ID を一覧表示する USER\$1ID 列を持つ CSV ファイルである必要があります。CSV ファイルの準備の詳細については、「[データ削除ファイルの準備と Amazon S3 へのアップロード](https://docs.aws.amazon.com/personalize/latest/dg/prepare-deletion-input-file.html)」を参照してください。
+ userId の入力 CSV ファイルにアクセスするアクセス許可を Amazon Personalize に付与するには、データソースから読み取るアクセス許可を持つ IAM サービスロールを指定する必要があります。このロールには、バケットとコンテンツの `GetObject` と `ListBucket` アクセス許可が必要です。これらのアクセス許可は、データのインポートと同じです。Amazon S3 バケットへのアクセスを許可する方法については、「[Amazon Personalize に Amazon S3 リソースへのアクセスを許可する](https://docs.aws.amazon.com/personalize/latest/dg/granting-personalize-s3-access.html)」を参照してください。

 ジョブを作成した後、データセットとモデルからユーザーへのすべての参照を削除するまでに最大 1 日かかる場合があります。ジョブが完了するまで、Amazon Personalize はトレーニング時に引き続きデータを使用します。また、ユーザーセグメンテーションレシピを使用すると、ユーザーがユーザーセグメントに表示されることがあります。

 **ステータス** 

データ削除ジョブのステータスは、次のいずれかです。
+ PENDING > IN\$1PROGRESS > COMPLETED または FAILED

データ削除ジョブのステータスを取得するには、[DescribeDataDeletionJob](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataDeletionJob.html) API オペレーションを呼び出し、ジョブの Amazon リソースネーム (ARN) を指定します。ステータスが FAILED の場合、レスポンスには、ジョブが失敗した理由を記述する `failureReason` キーが含まれています。

**関連 API**
+  [ListDataDeletionJobs](https://docs.aws.amazon.com/personalize/latest/dg/API_ListDataDeletionJobs.html) 
+  [DescribeDataDeletionJob](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataDeletionJob.html) 

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

```
{
   "datasetGroupArn": "string",
   "dataSource": { 
      "dataLocation": "string"
   },
   "jobName": "string",
   "roleArn": "string",
   "tags": [ 
      { 
         "tagKey": "string",
         "tagValue": "string"
      }
   ]
}
```

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

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

 ** [datasetGroupArn](#API_CreateDataDeletionJob_RequestSyntax) **   <a name="personalize-CreateDataDeletionJob-request-datasetGroupArn"></a>
レコードを削除するレコードのあるデータセットグループの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

 ** [dataSource](#API_CreateDataDeletionJob_RequestSyntax) **   <a name="personalize-CreateDataDeletionJob-request-dataSource"></a>
削除するユーザーの userId のリストを含む Amazon S3 バケット。  
型: [DataSource](API_DataSource.md) オブジェクト  
必須: はい

 ** [jobName](#API_CreateDataDeletionJob_RequestSyntax) **   <a name="personalize-CreateDataDeletionJob-request-jobName"></a>
データ削除ジョブの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: はい

 ** [roleArn](#API_CreateDataDeletionJob_RequestSyntax) **   <a name="personalize-CreateDataDeletionJob-request-roleArn"></a>
Amazon S3 データソースから読み取るための許可を持つ IAM ロールの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`   
必須: はい

 ** [tags](#API_CreateDataDeletionJob_RequestSyntax) **   <a name="personalize-CreateDataDeletionJob-request-tags"></a>
データ削除ジョブに適用する[タグ](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)のリスト。  
型: [Tag](API_Tag.md) オブジェクトの配列  
配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。  
必須: いいえ

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

```
{
   "dataDeletionJobArn": "string"
}
```

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

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

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

 ** [dataDeletionJobArn](#API_CreateDataDeletionJob_ResponseSyntax) **   <a name="personalize-CreateDataDeletionJob-response-dataDeletionJobArn"></a>
データ削除ジョブの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

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

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

 ** LimitExceededException **   
1 秒あたりのリクエスト数の上限を超えています。  
HTTP ステータスコード: 400

 ** ResourceAlreadyExistsException **   
指定したリソースはすでに存在しています。  
HTTP ステータスコード: 400

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

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

 ** TooManyTagsException **   
このリソースに適用できるタグの最大数を超過しています。  
HTTP ステータスコード: 400

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

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

# CreateDataset
<a name="API_CreateDataset"></a>

空のデータセットを作成し、指定したデータセットグループに追加します。[CreateDatasetImportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html) を使用してトレーニングデータをデータセットにインポートします。

データセットには次の 5 つのタイプがあります。
+ アイテムインタラクション
+ 項目
+ [ユーザー]
+ Action インタラクション
+ アクション

各データセットタイプには、必須のフィールドタイプに関連付けられたスキーマがあります。モデルのトレーニング (ソリューションの作成とも呼ばれます) に必要なのは、`Item interactions` データセットのみです。

データセットは、次に示す状態のいずれかになります。
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -または- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS

データセットのステータスを取得するには、[DescribeDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html) を呼び出します。

**関連 API**
+  [CreateDatasetGroup](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html) 
+  [ListDatasets](https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasets.html) 
+  [DescribeDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html) 
+  [DeleteDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteDataset.html) 

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

```
{
   "datasetGroupArn": "string",
   "datasetType": "string",
   "name": "string",
   "schemaArn": "string",
   "tags": [ 
      { 
         "tagKey": "string",
         "tagValue": "string"
      }
   ]
}
```

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

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

 ** [datasetGroupArn](#API_CreateDataset_RequestSyntax) **   <a name="personalize-CreateDataset-request-datasetGroupArn"></a>
データセットを追加するデータセットグループの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

 ** [datasetType](#API_CreateDataset_RequestSyntax) **   <a name="personalize-CreateDataset-request-datasetType"></a>
データセットのタイプ。  
次の値のいずれか (大文字と小文字は区別されません):  
+ インタラクション
+ 項目
+ [ユーザー]
+ アクション
+ Action\$1Interactions
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `^[A-Za-z_]+$`   
必須: はい

 ** [name](#API_CreateDataset_RequestSyntax) **   <a name="personalize-CreateDataset-request-name"></a>
データセットの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: はい

 ** [schemaArn](#API_CreateDataset_RequestSyntax) **   <a name="personalize-CreateDataset-request-schemaArn"></a>
データセットに関連付けるスキーマの ARN。スキーマはデータセットフィールドを定義します。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

 ** [tags](#API_CreateDataset_RequestSyntax) **   <a name="personalize-CreateDataset-request-tags"></a>
データセットに適用する[タグ](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)のリスト  
型: [Tag](API_Tag.md) オブジェクトの配列  
配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。  
必須: いいえ

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

```
{
   "datasetArn": "string"
}
```

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

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

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

 ** [datasetArn](#API_CreateDataset_ResponseSyntax) **   <a name="personalize-CreateDataset-response-datasetArn"></a>
データセットの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

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

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

 ** LimitExceededException **   
1 秒あたりのリクエスト数の上限を超えています。  
HTTP ステータスコード: 400

 ** ResourceAlreadyExistsException **   
指定したリソースはすでに存在しています。  
HTTP ステータスコード: 400

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

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

 ** TooManyTagsException **   
このリソースに適用できるタグの最大数を超過しています。  
HTTP ステータスコード: 400

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

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

# CreateDatasetExportJob
<a name="API_CreateDatasetExportJob"></a>

 データセットから Amazon S3 バケットにデータをエクスポートするジョブを作成します。Amazon Personalize がトレーニングデータをエクスポートできるようにするには、Amazon S3 バケットについての `PutObject` の許可を Amazon Personalize に付与する、サービスにリンクされた IAM ロールを指定する必要があります。詳細については、Amazon Personalize デベロッパーガイドの「[データセットのエクスポート](https://docs.aws.amazon.com/personalize/latest/dg/export-data.html)」を参照してください。

 **ステータス** 

データセットのエクスポートジョブは、次のいずれかの状態になります。
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -または- CREATE FAILED

 エクスポートジョブのステータスを取得するには、[DescribeDatasetExportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetExportJob.html) を呼び出し、データセットのエクスポートジョブの Amazon リソースネーム (ARN) を指定します。ステータスが ACTIVE と表示されると、データセットのエクスポートが完了します。ステータスが CREATE FAILED と表示されている場合、レスポンスには、ジョブが失敗した理由を記述する `failureReason` キーが含まれています。

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

```
{
   "datasetArn": "string",
   "ingestionMode": "string",
   "jobName": "string",
   "jobOutput": { 
      "s3DataDestination": { 
         "kmsKeyArn": "string",
         "path": "string"
      }
   },
   "roleArn": "string",
   "tags": [ 
      { 
         "tagKey": "string",
         "tagValue": "string"
      }
   ]
}
```

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

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

 ** [datasetArn](#API_CreateDatasetExportJob_RequestSyntax) **   <a name="personalize-CreateDatasetExportJob-request-datasetArn"></a>
エクスポートするデータを含むデータセットの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

 ** [ingestionMode](#API_CreateDatasetExportJob_RequestSyntax) **   <a name="personalize-CreateDatasetExportJob-request-ingestionMode"></a>
エクスポートするデータ (データをインポートした方法に基づく)。データセットのインポートジョブを使用してインポートした `BULK` データのみ、(コンソール、PutEvents、PutUsers、および PutItems 操作を使用して) 増分的にインポートした `PUT` データのみ、または両方のタイプの `ALL` をエクスポートすることを選択できます。デフォルト値は `PUT` です。  
型: 文字列  
有効な値：`BULK | PUT | ALL`  
必須：いいえ

 ** [jobName](#API_CreateDatasetExportJob_RequestSyntax) **   <a name="personalize-CreateDatasetExportJob-request-jobName"></a>
データセットのエクスポートジョブの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: はい

 ** [jobOutput](#API_CreateDatasetExportJob_RequestSyntax) **   <a name="personalize-CreateDatasetExportJob-request-jobOutput"></a>
ジョブの出力が保存される Amazon S3 バケットへのパス。  
型: [DatasetExportJobOutput](API_DatasetExportJobOutput.md) オブジェクト  
必須: はい

 ** [roleArn](#API_CreateDatasetExportJob_RequestSyntax) **   <a name="personalize-CreateDatasetExportJob-request-roleArn"></a>
出力 Amazon S3 バケットにデータを追加するための許可を持つ IAM サービスロールの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`   
必須: はい

 ** [tags](#API_CreateDatasetExportJob_RequestSyntax) **   <a name="personalize-CreateDatasetExportJob-request-tags"></a>
データセットのエクスポートジョブに適用する[タグ](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)のリスト。  
型: [Tag](API_Tag.md) オブジェクトの配列  
配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。  
必須: いいえ

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

```
{
   "datasetExportJobArn": "string"
}
```

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

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

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

 ** [datasetExportJobArn](#API_CreateDatasetExportJob_ResponseSyntax) **   <a name="personalize-CreateDatasetExportJob-response-datasetExportJobArn"></a>
データセットのエクスポートジョブの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

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

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

 ** LimitExceededException **   
1 秒あたりのリクエスト数の上限を超えています。  
HTTP ステータスコード: 400

 ** ResourceAlreadyExistsException **   
指定したリソースはすでに存在しています。  
HTTP ステータスコード: 400

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

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

 ** TooManyTagsException **   
このリソースに適用できるタグの最大数を超過しています。  
HTTP ステータスコード: 400

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

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

# CreateDatasetGroup
<a name="API_CreateDatasetGroup"></a>

空のデータセットグループを作成します。データセットグループは、Amazon Personalize のリソースのコンテナです。データセットグループには、データセットのタイプごとに 1 つずつ、最大 3 つのデータセットを含めることができます。
+ アイテムインタラクション
+ 項目
+ [ユーザー]
+ アクション
+ Action インタラクション

 データセットグループは、ドメインを指定してレコメンダーなどの事前設定されたリソースを使用するドメインデータセットグループ、または、キャンペーンでデプロイするカスタムリソースを使用するカスタムデータセットグループ (ソリューションバージョンを使用したソリューションなど) にすることができます。ドメインデータセットグループで始める場合でも、カスタムユースケースのレシピでトレーニングされ、キャンペーンでデプロイされたソリューションやソリューションバージョンなどのカスタムリソースを追加できます。

データセットグループは、次に示す状態のいずれかになります。
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -または- CREATE FAILED
+ DELETE PENDING

データセットグループのステータスを取得するには、[DescribeDatasetGroup](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetGroup.html) を呼び出します。ステータスが CREATE FAILED と表示されている場合、レスポンスには、作成が失敗した理由を記述する `failureReason` キーが含まれています。

**注記**  
データセットをグループに追加する前に、データセットグループの `status` が `ACTIVE` になるまで待つ必要があります。

 AWS Key Management Service (KMS) キーを指定して、グループ内のデータセットを暗号化できます。KMS キーを指定する場合は、キーにアクセスするための許可を持つ AWS Identity and Access Management (IAM) ロールも含める必要があります。

**リクエストでデータセットグループ ARN を必要とする API**
+  [CreateDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html) 
+  [CreateEventTracker](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html) 
+  [CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) 

**関連 API**
+  [ListDatasetGroups](https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasetGroups.html) 
+  [DescribeDatasetGroup](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetGroup.html) 
+  [DeleteDatasetGroup](https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteDatasetGroup.html) 

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

```
{
   "domain": "string",
   "kmsKeyArn": "string",
   "name": "string",
   "roleArn": "string",
   "tags": [ 
      { 
         "tagKey": "string",
         "tagValue": "string"
      }
   ]
}
```

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

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

 ** [domain](#API_CreateDatasetGroup_RequestSyntax) **   <a name="personalize-CreateDatasetGroup-request-domain"></a>
データセットグループのドメイン。ドメインを指定して、ドメインデータセットグループを作成します。指定するドメインによって、データセットのデフォルトスキーマと、レコメンダーが利用できるユースケースが決まります。ドメインを指定しない場合は、キャンペーンでデプロイするソリューションバージョンを使用してカスタムデータセットグループを作成します。  
型: 文字列  
有効な値：`ECOMMERCE | VIDEO_ON_DEMAND`  
必須：いいえ

 ** [kmsKeyArn](#API_CreateDatasetGroup_RequestSyntax) **   <a name="personalize-CreateDatasetGroup-request-kmsKeyArn"></a>
データセットの暗号化に使用される (KMS) キーの Amazon リソースネーム AWS Key Management Service (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 2,048 です。  
パターン: `arn:aws.*:kms:.*:[0-9]{12}:key/.*`   
必須: いいえ

 ** [name](#API_CreateDatasetGroup_RequestSyntax) **   <a name="personalize-CreateDatasetGroup-request-name"></a>
新しいデータセットグループの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: はい

 ** [roleArn](#API_CreateDatasetGroup_RequestSyntax) **   <a name="personalize-CreateDatasetGroup-request-roleArn"></a>
 AWS Identity and Access Management (KMS) キーへのアクセス許可を持つ AWS Key Management Service (IAM) ロールの ARN。IAM ロールの指定は、KMS キーも指定する場合にのみ有効です。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`   
必須: いいえ

 ** [tags](#API_CreateDatasetGroup_RequestSyntax) **   <a name="personalize-CreateDatasetGroup-request-tags"></a>
データセットグループに適用する[タグ](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)のリスト。  
型: [Tag](API_Tag.md) オブジェクトの配列  
配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。  
必須: いいえ

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

```
{
   "datasetGroupArn": "string",
   "domain": "string"
}
```

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

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

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

 ** [datasetGroupArn](#API_CreateDatasetGroup_ResponseSyntax) **   <a name="personalize-CreateDatasetGroup-response-datasetGroupArn"></a>
新しいデータセットグループの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

 ** [domain](#API_CreateDatasetGroup_ResponseSyntax) **   <a name="personalize-CreateDatasetGroup-response-domain"></a>
新しいドメインデータセットグループのドメイン。  
型: 文字列  
有効な値：`ECOMMERCE | VIDEO_ON_DEMAND`

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

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

 ** LimitExceededException **   
1 秒あたりのリクエスト数の上限を超えています。  
HTTP ステータスコード: 400

 ** ResourceAlreadyExistsException **   
指定したリソースはすでに存在しています。  
HTTP ステータスコード: 400

 ** TooManyTagsException **   
このリソースに適用できるタグの最大数を超過しています。  
HTTP ステータスコード: 400

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

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

# CreateDatasetImportJob
<a name="API_CreateDatasetImportJob"></a>

データソース (Amazon S3 バケット) から Amazon Personalize データセットにトレーニングデータをインポートするジョブを作成します。Amazon Personalize がトレーニングデータをインポートできるようにするには、Amazon Personalize がデータのコピーを作成して内部で処理するため、データソースからの読み取り許可を持つ IAM サービスロールを指定する必要があります。Amazon S3 バケットへのアクセスを許可する方法については、「[Amazon Personalize に Amazon S3 リソースへのアクセスを許可する](https://docs.aws.amazon.com/personalize/latest/dg/granting-personalize-s3-access.html)」を参照してください。

レコメンダーをすでに作成しているか、キャンペーンでカスタムソリューションバージョンをデプロイしている場合、新しいバルクレコードがレコメンデーションにどのように影響するかは、使用するドメインのユースケースまたはレシピによって異なります。詳細については、「[新しいデータがリアルタイムのレコメンデーションに与える影響](https://docs.aws.amazon.com/personalize/latest/dg/how-new-data-influences-recommendations.html)」を参照してください。

**重要**  
デフォルトでは、データセットのインポートジョブは、一括でインポートしたデータセット内の既存のデータを置き換えます。既存のデータを置き換えずに新しいレコードを追加するには、CreateDatasetImportJob オペレーションのインポートモードに INCREMENTAL を指定します。

 **ステータス** 

データセットのインポートジョブは、次のいずれかの状態になります。
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -または- CREATE FAILED

インポートジョブのステータスを取得するには、[DescribeDatasetImportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetImportJob.html) を呼び出し、データセットのインポートジョブの Amazon リソースネーム (ARN) を指定します。ステータスが ACTIVE と表示されると、データセットのインポートが完了します。ステータスが CREATE FAILED と表示されている場合、レスポンスには、ジョブが失敗した理由を記述する `failureReason` キーが含まれています。

**注記**  
インポートには時間がかかります。ステータスが ACTIVE になるまで待ってから、データセットを使用してモデルをトレーニングしてください。

**関連 API**
+  [ListDatasetImportJobs](https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasetImportJobs.html) 
+  DescribeDatasetImportJob 

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

```
{
   "datasetArn": "string",
   "dataSource": { 
      "dataLocation": "string"
   },
   "importMode": "string",
   "jobName": "string",
   "publishAttributionMetricsToS3": boolean,
   "roleArn": "string",
   "tags": [ 
      { 
         "tagKey": "string",
         "tagValue": "string"
      }
   ]
}
```

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

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

 ** [datasetArn](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="personalize-CreateDatasetImportJob-request-datasetArn"></a>
インポートされたデータを受け取るデータセットの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

 ** [dataSource](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="personalize-CreateDatasetImportJob-request-dataSource"></a>
インポートするトレーニングデータを含む Amazon S3 バケット。  
型: [DataSource](API_DataSource.md) オブジェクト  
必須: はい

 ** [importMode](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="personalize-CreateDatasetImportJob-request-importMode"></a>
新しいレコードを既存のデータセットに追加する方法を指定します。デフォルトのインポートモードは `FULL` です。以前にデータセットに一括レコードをインポートしたことがない場合は、`FULL` を指定することしかできません。  
+ データセット内の既存のバルクデータをすべて上書きするように `FULL` を指定します。個別にインポートしたデータは置き換えられません。
+ データセット内の既存のデータに新しいレコードを追加するように `INCREMENTAL` を指定します。Amazon Personalize は、同じ ID のレコードをすべて新しいレコードに置き換えます。
型: 文字列  
有効な値：`FULL | INCREMENTAL`  
必須：いいえ

 ** [jobName](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="personalize-CreateDatasetImportJob-request-jobName"></a>
データセットのインポートジョブの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: はい

 ** [publishAttributionMetricsToS3](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="personalize-CreateDatasetImportJob-request-publishAttributionMetricsToS3"></a>
メトリクス属性を作成した場合は、このインポートジョブのメトリクスを Amazon S3 に発行するかどうかを指定します。  
タイプ: ブール値  
必須: いいえ

 ** [roleArn](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="personalize-CreateDatasetImportJob-request-roleArn"></a>
Amazon S3 データソースから読み取るための許可を持つ IAM ロールの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`   
必須: いいえ

 ** [tags](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="personalize-CreateDatasetImportJob-request-tags"></a>
データセットのインポートジョブに適用する[タグ](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)のリスト。  
型: [Tag](API_Tag.md) オブジェクトの配列  
配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。  
必須: いいえ

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

```
{
   "datasetImportJobArn": "string"
}
```

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

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

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

 ** [datasetImportJobArn](#API_CreateDatasetImportJob_ResponseSyntax) **   <a name="personalize-CreateDatasetImportJob-response-datasetImportJobArn"></a>
データセットのインポートジョブの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

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

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

 ** LimitExceededException **   
1 秒あたりのリクエスト数の上限を超えています。  
HTTP ステータスコード: 400

 ** ResourceAlreadyExistsException **   
指定したリソースはすでに存在しています。  
HTTP ステータスコード: 400

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

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

 ** TooManyTagsException **   
このリソースに適用できるタグの最大数を超過しています。  
HTTP ステータスコード: 400

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

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

# CreateEventTracker
<a name="API_CreateEventTracker"></a>

[PutEvents](https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html) API を使用して、指定したデータセットグループにイベントデータを追加するときに使用するイベントトラッカーを作成します。

**注記**  
データセットグループに関連付けることができるイベントトラッカーは 1 つのみです。既存のイベントトラッカーと同じデータセットグループを使用して `CreateEventTracker` を呼び出すと、エラーが発生します。​

イベントトラッカーを作成すると、レスポンスには追跡 ID が含まれます。これは、[PutEvents](https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html) 操作を使用するときにパラメータとして渡します。その後、Amazon Personalize は、イベントトラッカーで指定したデータセットグループのアイテムインタラクションデータセットにイベントデータを追加します。

イベントトラッカーは、次に示す状態のいずれかになります。
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -または- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS

イベントトラッカーのステータスを取得するには、[DescribeEventTracker](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeEventTracker.html) を呼び出します。

**注記**  
追跡 ID を使用する前に、イベントトラッカーが ACTIVE 状態になっている必要があります。

**関連 API**
+  [ListEventTrackers](https://docs.aws.amazon.com/personalize/latest/dg/API_ListEventTrackers.html) 
+  [DescribeEventTracker](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeEventTracker.html) 
+  [DeleteEventTracker](https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteEventTracker.html) 

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

```
{
   "datasetGroupArn": "string",
   "name": "string",
   "tags": [ 
      { 
         "tagKey": "string",
         "tagValue": "string"
      }
   ]
}
```

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

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

 ** [datasetGroupArn](#API_CreateEventTracker_RequestSyntax) **   <a name="personalize-CreateEventTracker-request-datasetGroupArn"></a>
イベントデータを受け取るデータセットグループの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

 ** [name](#API_CreateEventTracker_RequestSyntax) **   <a name="personalize-CreateEventTracker-request-name"></a>
イベントトラッカーの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: はい

 ** [tags](#API_CreateEventTracker_RequestSyntax) **   <a name="personalize-CreateEventTracker-request-tags"></a>
イベントトラッカーに適用する[タグ](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)のリスト。  
型: [Tag](API_Tag.md) オブジェクトの配列  
配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。  
必須: いいえ

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

```
{
   "eventTrackerArn": "string",
   "trackingId": "string"
}
```

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

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

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

 ** [eventTrackerArn](#API_CreateEventTracker_ResponseSyntax) **   <a name="personalize-CreateEventTracker-response-eventTrackerArn"></a>
イベントトラッカーの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

 ** [trackingId](#API_CreateEventTracker_ResponseSyntax) **   <a name="personalize-CreateEventTracker-response-trackingId"></a>
イベントトラッカーの ID。この ID を [PutEvents](https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html) API へのリクエストに含めます。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。

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

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

 ** LimitExceededException **   
1 秒あたりのリクエスト数の上限を超えています。  
HTTP ステータスコード: 400

 ** ResourceAlreadyExistsException **   
指定したリソースはすでに存在しています。  
HTTP ステータスコード: 400

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

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

 ** TooManyTagsException **   
このリソースに適用できるタグの最大数を超過しています。  
HTTP ステータスコード: 400

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

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

# CreateFilter
<a name="API_CreateFilter"></a>

レコメンデーションフィルターを作成します。詳細については、「[レコメンデーションとユーザーセグメントのフィルタリング](https://docs.aws.amazon.com/personalize/latest/dg/filter.html)」を参照してください。

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

```
{
   "datasetGroupArn": "string",
   "filterExpression": "string",
   "name": "string",
   "tags": [ 
      { 
         "tagKey": "string",
         "tagValue": "string"
      }
   ]
}
```

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

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

 ** [datasetGroupArn](#API_CreateFilter_RequestSyntax) **   <a name="personalize-CreateFilter-request-datasetGroupArn"></a>
フィルターが属するデータセットグループの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

 ** [filterExpression](#API_CreateFilter_RequestSyntax) **   <a name="personalize-CreateFilter-request-filterExpression"></a>
フィルター式は、レコメンデーションに含める、またはレコメンデーションから除外するアイテムを定義します。フィルター式は、特定のフォーマットルールに従う必要があります。フィルター式の構造と構文については、「[フィルター式](https://docs.aws.amazon.com/personalize/latest/dg/filter-expressions.html)」を参照してください。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 2500 です。  
必須: はい

 ** [name](#API_CreateFilter_RequestSyntax) **   <a name="personalize-CreateFilter-request-name"></a>
作成するフィルターの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: はい

 ** [tags](#API_CreateFilter_RequestSyntax) **   <a name="personalize-CreateFilter-request-tags"></a>
フィルターに適用する[タグ](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)のリスト  
型: [Tag](API_Tag.md) オブジェクトの配列  
配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。  
必須: いいえ

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

```
{
   "filterArn": "string"
}
```

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

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

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

 ** [filterArn](#API_CreateFilter_ResponseSyntax) **   <a name="personalize-CreateFilter-response-filterArn"></a>
新しいフィルターの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

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

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

 ** LimitExceededException **   
1 秒あたりのリクエスト数の上限を超えています。  
HTTP ステータスコード: 400

 ** ResourceAlreadyExistsException **   
指定したリソースはすでに存在しています。  
HTTP ステータスコード: 400

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

 ** TooManyTagsException **   
このリソースに適用できるタグの最大数を超過しています。  
HTTP ステータスコード: 400

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

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

# CreateMetricAttribution
<a name="API_CreateMetricAttribution"></a>

メトリクス属性を作成します。メトリクス属性は、Amazon Personalize にインポートしたデータに関するレポートを作成します。データをインポートした方法に応じて Amazon CloudWatch または Amazon S3 でレポートを表示できます。詳細については、「[レコメンデーションの影響の測定](https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html)」を参照してください。

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

```
{
   "datasetGroupArn": "string",
   "metrics": [ 
      { 
         "eventType": "string",
         "expression": "string",
         "metricName": "string"
      }
   ],
   "metricsOutputConfig": { 
      "roleArn": "string",
      "s3DataDestination": { 
         "kmsKeyArn": "string",
         "path": "string"
      }
   },
   "name": "string"
}
```

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

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

 ** [datasetGroupArn](#API_CreateMetricAttribution_RequestSyntax) **   <a name="personalize-CreateMetricAttribution-request-datasetGroupArn"></a>
メトリクス属性に対する宛先ドメインデータセットグループの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

 ** [metrics](#API_CreateMetricAttribution_RequestSyntax) **   <a name="personalize-CreateMetricAttribution-request-metrics"></a>
メトリクス属性のメトリクス属性のリスト。各メトリクス属性は、追跡するイベントタイプと関数を指定します。使用できる関数は、`SUM()` または `SAMPLECOUNT()` です。SUM() 関数では、データセットのタイプ (インタラクションまたはアイテム) と合計する列をパラメーターとして指定します。例えば、SUM(Items.PRICE) などです。  
型: [MetricAttribute](API_MetricAttribute.md) オブジェクトの配列  
配列メンバー: 最大数は 10 項目です。  
必須: はい

 ** [metricsOutputConfig](#API_CreateMetricAttribution_RequestSyntax) **   <a name="personalize-CreateMetricAttribution-request-metricsOutputConfig"></a>
メトリクス属性の出力設定の詳細。  
型: [MetricAttributionOutput](API_MetricAttributionOutput.md) オブジェクト  
必須: はい

 ** [name](#API_CreateMetricAttribution_RequestSyntax) **   <a name="personalize-CreateMetricAttribution-request-name"></a>
メトリクス属性の名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: はい

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

```
{
   "metricAttributionArn": "string"
}
```

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

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

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

 ** [metricAttributionArn](#API_CreateMetricAttribution_ResponseSyntax) **   <a name="personalize-CreateMetricAttribution-response-metricAttributionArn"></a>
新しいメトリクス属性の Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

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

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

 ** LimitExceededException **   
1 秒あたりのリクエスト数の上限を超えています。  
HTTP ステータスコード: 400

 ** ResourceAlreadyExistsException **   
指定したリソースはすでに存在しています。  
HTTP ステータスコード: 400

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

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

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

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

# CreateRecommender
<a name="API_CreateRecommender"></a>

指定したレシピ (ドメインデータセットグループのユースケース) を使用してレコメンダーを作成します。ドメインデータセットグループのレコメンダーを作成し、[GetRecommendations](https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) リクエストを実行するときにレコメンダーの Amazon リソースネーム (ARN) を指定します。

 **1 秒あたりの最小レコメンデーションリクエスト数** 

**重要**  
`minRecommendationRequestsPerSecond` を高く設定すると請求額が増加します。最初は `minRecommendationRequestsPerSecond` に 1 を使用することをお勧めします (デフォルト)。Amazon CloudWatch メトリクスを使用して使用状況を追跡し、必要に応じて `minRecommendationRequestsPerSecond` を引き上げることをお勧めします。

レコメンダーを作成する際、レコメンダーの 1 秒あたりの最小レコメンデーションリクエスト数を設定できます。1 秒あたりの最小レコメンデーションリクエスト数 (`minRecommendationRequestsPerSecond`) は、Amazon Personalize によってプロビジョニングされるベースラインレコメンデーションリクエストスループットを指定します。デフォルトの minRecommendationRequestsPerSecond は `1` です。レコメンデーションリクエストは 1 回の `GetRecommendations` 操作です。リクエストスループットは 1 秒あたりのリクエスト数で測定されます。Amazon Personalize は 1 秒あたりのリクエスト数を使用して、1 時間あたりのリクエスト数とレコメンダーの使用量を算出します。

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

 請求額は、1 時間あたりの最小リクエスト数 (minRecommendationRequestSperSecond に基づく) または実際のリクエスト数のどちらか大きい方です。実際に使用されるリクエストのスループットは、5 分間のウィンドウ内の平均リクエスト数/秒として計算されます。低い `minRecommendationRequestsPerSecond` から始めて、Amazon CloudWatch メトリクスを使用して使用状況を追跡し、必要に応じて `minRecommendationRequestsPerSecond` を引き上げることをお勧めします。

 **ステータス** 

レコメンダーは、次に示す状態のいずれかになります。
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -または- CREATE FAILED
+ STOP PENDING > STOP IN\$1PROGRESS > INACTIVE > START PENDING > START IN\$1PROGRESS > ACTIVE
+ DELETE PENDING > DELETE IN\$1PROGRESS

レコメンダーのステータスを取得するには、[DescribeRecommender](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html) を呼び出します。

**注記**  
レコメンダーの `status` が `ACTIVE` になるまで待ってから、レコメンダーにレコメンデーションを尋ねます。

**関連 API**
+  [ListRecommenders](https://docs.aws.amazon.com/personalize/latest/dg/API_ListRecommenders.html) 
+  [DescribeRecommender](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html) 
+  [UpdateRecommender](https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateRecommender.html) 
+  [DeleteRecommender](https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteRecommender.html) 

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

```
{
   "datasetGroupArn": "string",
   "name": "string",
   "recipeArn": "string",
   "recommenderConfig": { 
      "enableMetadataWithRecommendations": boolean,
      "itemExplorationConfig": { 
         "string" : "string" 
      },
      "minRecommendationRequestsPerSecond": number,
      "trainingDataConfig": { 
         "excludedDatasetColumns": { 
            "string" : [ "string" ]
         },
         "includedDatasetColumns": { 
            "string" : [ "string" ]
         }
      }
   },
   "tags": [ 
      { 
         "tagKey": "string",
         "tagValue": "string"
      }
   ]
}
```

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

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

 ** [datasetGroupArn](#API_CreateRecommender_RequestSyntax) **   <a name="personalize-CreateRecommender-request-datasetGroupArn"></a>
レコメンダーの宛先ドメインデータセットグループの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

 ** [name](#API_CreateRecommender_RequestSyntax) **   <a name="personalize-CreateRecommender-request-name"></a>
レコメンダーの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: はい

 ** [recipeArn](#API_CreateRecommender_RequestSyntax) **   <a name="personalize-CreateRecommender-request-recipeArn"></a>
レコメンダーが使用するレシピの Amazon リソースネーム (ARN)。レコメンダーについて、レシピはドメインデータセットグループのユースケースです。レコメンダーを作成する際、ドメインデータセットグループのユースケースのみを使用できます。ユースケースの詳細については、「[レコメンダーのユースケースの選択](https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html)」を参照してください。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

 ** [recommenderConfig](#API_CreateRecommender_RequestSyntax) **   <a name="personalize-CreateRecommender-request-recommenderConfig"></a>
レコメンダーの設定の詳細。  
型: [RecommenderConfig](API_RecommenderConfig.md) オブジェクト  
必須: いいえ

 ** [tags](#API_CreateRecommender_RequestSyntax) **   <a name="personalize-CreateRecommender-request-tags"></a>
レコメンダーに適用する[タグ](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)のリスト。  
型: [Tag](API_Tag.md) オブジェクトの配列  
配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。  
必須: いいえ

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

```
{
   "recommenderArn": "string"
}
```

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

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

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

 ** [recommenderArn](#API_CreateRecommender_ResponseSyntax) **   <a name="personalize-CreateRecommender-response-recommenderArn"></a>
レコメンダーの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

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

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

 ** LimitExceededException **   
1 秒あたりのリクエスト数の上限を超えています。  
HTTP ステータスコード: 400

 ** ResourceAlreadyExistsException **   
指定したリソースはすでに存在しています。  
HTTP ステータスコード: 400

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

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

 ** TooManyTagsException **   
このリソースに適用できるタグの最大数を超過しています。  
HTTP ステータスコード: 400

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

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

# CreateSchema
<a name="API_CreateSchema"></a>

指定されたスキーマ文字列から Amazon Personalize スキーマを作成します。作成するスキーマは Avro JSON 形式である必要があります。

Amazon Personalize は、3 つのスキーマバリアントを認識します。各スキーマはデータセットタイプに関連付けられており、必須フィールドとキーワードのセットを備えています。ドメインデータセットグループ内のデータセットのスキーマを作成する場合は、ドメインデータセットグループのドメインを指定します。[CreateDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html) を呼び出すときにスキーマを指定します。

スキーマの詳細については、「[データセットとスキーマ](https://docs.aws.amazon.com/personalize/latest/dg/how-it-works-dataset-schema.html)」を参照してください。

**関連 API**
+  [ListSchemas](https://docs.aws.amazon.com/personalize/latest/dg/API_ListSchemas.html) 
+  [DescribeSchema](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSchema.html) 
+  [DeleteSchema](https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSchema.html) 

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

```
{
   "domain": "string",
   "name": "string",
   "schema": "string"
}
```

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

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

 ** [domain](#API_CreateSchema_RequestSyntax) **   <a name="personalize-CreateSchema-request-domain"></a>
スキーマのドメイン。ドメインデータセットグループ内のデータセットのスキーマを作成する場合は、ドメインデータセットグループを作成したときに選択したドメインを指定します。  
型: 文字列  
有効な値：`ECOMMERCE | VIDEO_ON_DEMAND`  
必須：いいえ

 ** [name](#API_CreateSchema_RequestSyntax) **   <a name="personalize-CreateSchema-request-name"></a>
スキーマの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: はい

 ** [schema](#API_CreateSchema_RequestSyntax) **   <a name="personalize-CreateSchema-request-schema"></a>
Avro JSON 形式のスキーマ。  
タイプ: 文字列  
長さの制限: 最大長は 20,000 です。  
必須: はい

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

```
{
   "schemaArn": "string"
}
```

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

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

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

 ** [schemaArn](#API_CreateSchema_ResponseSyntax) **   <a name="personalize-CreateSchema-response-schemaArn"></a>
作成したスキーマの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

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

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

 ** LimitExceededException **   
1 秒あたりのリクエスト数の上限を超えています。  
HTTP ステータスコード: 400

 ** ResourceAlreadyExistsException **   
指定したリソースはすでに存在しています。  
HTTP ステータスコード: 400

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

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

# CreateSolution
<a name="API_CreateSolution"></a>

**重要**  
デフォルトでは、すべての新しいソリューションで自動トレーニングが使用されます。自動トレーニングでは、ソリューションがアクティブな間はトレーニングコストが発生します。不要なコストを避けるために、完了したら[ソリューションを更新](https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateSolution.html)して自動トレーニングを無効にすることができます。トレーニングのコストの詳細については、「[Amazon Personalize の料金](https://aws.amazon.com/personalize/pricing/)」を参照してください。

モデルをトレーニングするための設定 (ソリューションバージョンの作成) を作成します。この設定には、モデルトレーニングに使用するレシピと、トレーニングや機能変換パラメータで使用する列などのオプションのトレーニング設定が含まれます。ソリューションの設定の詳細については、「[ソリューションの作成と構成](https://docs.aws.amazon.com/personalize/latest/dg/customizing-solution-config.html)」を参照してください。

 デフォルトでは、新しいソリューションは自動トレーニングを使用して 7 日ごとにソリューションバージョンを作成します。トレーニング頻度は変更できます。自動ソリューションバージョンの作成は、ソリューションが ACTIVE になってから 1 時間以内に開始されます。1 時間以内にソリューションバージョンを手動で作成した場合、ソリューションは最初の自動トレーニングをスキップします。詳細については、「[自動トレーニングの設定](https://docs.aws.amazon.com/personalize/latest/dg/solution-config-auto-training.html)」を参照してください。

 自動トレーニングを無効にするには、`performAutoTraining` を false に設定します。自動トレーニングをオフにする場合は、[CreateSolutionVersion](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolutionVersion.html) オペレーションを呼び出して、ソリューションバージョンを手動で作成する必要があります。

トレーニングが開始されると、[ListSolutionVersions](https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html) API オペレーションを使用してソリューションバージョンの Amazon リソースネーム (ARN) を取得できます。ステータスを取得するには、[DescribeSolutionVersion](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html) を使用します。

トレーニングが完了したら、[GetSolutionMetrics](https://docs.aws.amazon.com/personalize/latest/dg/API_GetSolutionMetrics.html) を呼び出してモデルの精度を評価できます。ソリューションバージョンに問題がなければ、[CreateCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html) を使用してデプロイします。キャンペーンは、[GetRecommendations](https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) API を介してクライアントにレコメンデーションを提供します。

**注記**  
現時点では、Amazon Personalize は、ソリューションのハイパーパラメータ最適化のためん、`hpoObjective` の設定をサポートしていません。

 **ステータス** 

ソリューションは、次に示す状態のいずれかになります。
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -または- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS

ソリューションのステータスを取得するには、[DescribeSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html) を呼び出します。手動トレーニングを使用する場合は、`CreateSolutionVersion` を呼び出す前にステータスが ACTIVE である必要があります。

**関連 API**
+  [UpdateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateSolution.html) 
+  [ListSolutions](https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutions.html) 
+  [CreateSolutionVersion](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolutionVersion.html) 
+  [DescribeSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html) 
+  [DeleteSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSolution.html) 
+  [ListSolutionVersions](https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html) 
+  [DescribeSolutionVersion](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html) 

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

```
{
   "datasetGroupArn": "string",
   "eventType": "string",
   "name": "string",
   "performAutoML": boolean,
   "performAutoTraining": boolean,
   "performHPO": boolean,
   "performIncrementalUpdate": boolean,
   "recipeArn": "string",
   "solutionConfig": { 
      "algorithmHyperParameters": { 
         "string" : "string" 
      },
      "autoMLConfig": { 
         "metricName": "string",
         "recipeList": [ "string" ]
      },
      "autoTrainingConfig": { 
         "schedulingExpression": "string"
      },
      "eventsConfig": { 
         "eventParametersList": [ 
            { 
               "eventType": "string",
               "eventValueThreshold": number,
               "weight": number
            }
         ]
      },
      "eventValueThreshold": "string",
      "featureTransformationParameters": { 
         "string" : "string" 
      },
      "hpoConfig": { 
         "algorithmHyperParameterRanges": { 
            "categoricalHyperParameterRanges": [ 
               { 
                  "name": "string",
                  "values": [ "string" ]
               }
            ],
            "continuousHyperParameterRanges": [ 
               { 
                  "maxValue": number,
                  "minValue": number,
                  "name": "string"
               }
            ],
            "integerHyperParameterRanges": [ 
               { 
                  "maxValue": number,
                  "minValue": number,
                  "name": "string"
               }
            ]
         },
         "hpoObjective": { 
            "metricName": "string",
            "metricRegex": "string",
            "type": "string"
         },
         "hpoResourceConfig": { 
            "maxNumberOfTrainingJobs": "string",
            "maxParallelTrainingJobs": "string"
         }
      },
      "optimizationObjective": { 
         "itemAttribute": "string",
         "objectiveSensitivity": "string"
      },
      "trainingDataConfig": { 
         "excludedDatasetColumns": { 
            "string" : [ "string" ]
         },
         "includedDatasetColumns": { 
            "string" : [ "string" ]
         }
      }
   },
   "tags": [ 
      { 
         "tagKey": "string",
         "tagValue": "string"
      }
   ]
}
```

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

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

 ** [datasetGroupArn](#API_CreateSolution_RequestSyntax) **   <a name="personalize-CreateSolution-request-datasetGroupArn"></a>
トレーニングデータを提供するデータセットグループの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

 ** [eventType](#API_CreateSolution_RequestSyntax) **   <a name="personalize-CreateSolution-request-eventType"></a>
(`EVENT_TYPE` スキーマフィールドを使用して) 複数のイベントタイプがある場合、このパラメータは、モデルのトレーニングに使用されるイベントタイプ (例えば、「クリック」または「いいね」) を指定します。  
`eventType` を指定しない場合、Amazon Personalize は、タイプにかかわらず、同じ重みでトレーニングするためにすべてのインタラクションを使用します。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

 ** [name](#API_CreateSolution_RequestSyntax) **   <a name="personalize-CreateSolution-request-name"></a>
ソリューションの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: はい

 ** [performAutoML](#API_CreateSolution_RequestSyntax) **   <a name="personalize-CreateSolution-request-performAutoML"></a>
自動機械学習の有効化は推奨されません。代わりに、利用可能な Amazon Personalize のレシピにユースケースをマッチさせます。詳細については、の「[Choosing a recipe](https://docs.aws.amazon.com/personalize/latest/dg/working-with-predefined-recipes.html)」を参照してください。
自動機械学習 (AutoML) を実行するかどうか。デフォルトは `false` です。この場合、`recipeArn` を指定する必要があります。  
`true` に設定すると、Amazon Personalize はトレーニングデータを分析し、最適な USER\$1PERSONALIZATION レシピとハイパーパラメータを選択します。この場合、`recipeArn` を省略する必要があります。Amazon Personalize は、ハイパーパラメータにさまざまな値を使用してテストを実行することにより、最適なレシピを決定します。AutoML では、特定のレシピを選択する場合と比較して、トレーニングプロセスに長時間を要します。  
タイプ: ブール値  
必須: いいえ

 ** [performAutoTraining](#API_CreateSolution_RequestSyntax) **   <a name="personalize-CreateSolution-request-performAutoTraining"></a>
ソリューションが自動トレーニングを使用して新しいソリューションバージョン (トレーニング済みモデル) を作成するかどうか。デフォルトは `True` で、ソリューションは 7 日ごとに新しいソリューションバージョンを自動的に作成します。ソリューション設定の一部として `AutoTrainingConfig` で `schedulingExpression` を指定することで、トレーニング頻度を変更できます。自動トレーニングの詳細については、「[自動トレーニングの設定](https://docs.aws.amazon.com/personalize/latest/dg/solution-config-auto-training.html)」を参照してください。  
 自動ソリューションバージョンの作成は、ソリューションが ACTIVE になってから 1 時間以内に開始されます。1 時間以内にソリューションバージョンを手動で作成した場合、ソリューションは最初の自動トレーニングをスキップします。  
 トレーニングが開始されると、[ListSolutionVersions](https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html) API オペレーションを使用してソリューションバージョンの Amazon リソースネーム (ARN) を取得できます。ステータスを取得するには、[DescribeSolutionVersion](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html) を使用します。  
タイプ: ブール値  
必須: いいえ

 ** [performHPO](#API_CreateSolution_RequestSyntax) **   <a name="personalize-CreateSolution-request-performHPO"></a>
指定または選択したレシピでハイパーパラメータ最適化 (HPO) を実行するかどうか。デフォルトは `false` です。  
AutoML を実行する場合、このパラメータは常に `true` となります。`false` に設定しないでください。  
タイプ: ブール値  
必須: いいえ

 ** [performIncrementalUpdate](#API_CreateSolution_RequestSyntax) **   <a name="personalize-CreateSolution-request-performIncrementalUpdate"></a>
モデルで増分トレーニング更新を実行するかどうか。これにより、モデルは完全な再トレーニングを必要とせずに新しいデータからより頻繁に学習できるため、ほぼリアルタイムのパーソナライゼーションが可能になります。このパラメータは、セマンティック類似度レシピを使用するソリューションでのみサポートされます。  
タイプ: ブール値  
必須: いいえ

 ** [recipeArn](#API_CreateSolution_RequestSyntax) **   <a name="personalize-CreateSolution-request-recipeArn"></a>
モデルトレーニングに使用するレシピの Amazon リソースネーム (ARN)。これは、`performAutoML` が false の場合に必要です。Amazon Personalize のさまざまなレシピとその ARN の詳細については、「[Choosing a recipe](https://docs.aws.amazon.com/personalize/latest/dg/working-with-predefined-recipes.html)」を参照してください。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** [solutionConfig](#API_CreateSolution_RequestSyntax) **   <a name="personalize-CreateSolution-request-solutionConfig"></a>
ソリューションの設定プロパティ。`performAutoML` が true に設定されている場合、Amazon Personalize はソリューション設定の `autoMLConfig` セクションのみを評価します。  
現時点では、Amazon Personalize は `hpoObjective` の設定をサポートしていません。
型: [SolutionConfig](API_SolutionConfig.md) オブジェクト  
必須: いいえ

 ** [tags](#API_CreateSolution_RequestSyntax) **   <a name="personalize-CreateSolution-request-tags"></a>
ソリューションに適用する[タグ](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)のリスト。  
型: [Tag](API_Tag.md) オブジェクトの配列  
配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。  
必須: いいえ

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

```
{
   "solutionArn": "string"
}
```

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

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

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

 ** [solutionArn](#API_CreateSolution_ResponseSyntax) **   <a name="personalize-CreateSolution-response-solutionArn"></a>
ソリューションの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

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

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

 ** LimitExceededException **   
1 秒あたりのリクエスト数の上限を超えています。  
HTTP ステータスコード: 400

 ** ResourceAlreadyExistsException **   
指定したリソースはすでに存在しています。  
HTTP ステータスコード: 400

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

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

 ** TooManyTagsException **   
このリソースに適用できるタグの最大数を超過しています。  
HTTP ステータスコード: 400

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

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

# CreateSolutionVersion
<a name="API_CreateSolutionVersion"></a>

カスタムデータセットグループでアクティブなソリューションをトレーニングまたは再トレーニングします。ソリューションは [CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) 操作を使用して作成され、`CreateSolutionVersion` を呼び出す前に ACTIVE 状態となっている必要があります。この操作を呼び出すたびに、ソリューションの新しいバージョンが作成されます。

 **ステータス** 

ソリューションバージョンは、次のいずれかの状態になります。
+ CREATE PENDING
+ CREATE IN\$1PROGRESS
+ アクティブ
+ CREATE FAILED
+ CREATE STOPPING
+ CREATE STOPPED

バージョンのステータスを取得するには、[DescribeSolutionVersion](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html) を呼び出します。ステータスが ACTIVE と表示されるまで待ってから、`CreateCampaign` を呼び出します。

ステータスが CREATE FAILED と表示されている場合、レスポンスには、ジョブが失敗した理由を記述する `failureReason` キーが含まれています。

**関連 API**
+  [ListSolutionVersions](https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html) 
+  [DescribeSolutionVersion](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html) 
+  [ListSolutions](https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutions.html) 
+  [CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) 
+  [DescribeSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html) 
+  [DeleteSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSolution.html) 

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

```
{
   "name": "string",
   "solutionArn": "string",
   "tags": [ 
      { 
         "tagKey": "string",
         "tagValue": "string"
      }
   ],
   "trainingMode": "string"
}
```

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

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

 ** [name](#API_CreateSolutionVersion_RequestSyntax) **   <a name="personalize-CreateSolutionVersion-request-name"></a>
ソリューションバージョンの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: いいえ

 ** [solutionArn](#API_CreateSolutionVersion_RequestSyntax) **   <a name="personalize-CreateSolutionVersion-request-solutionArn"></a>
トレーニング設定情報を含むソリューションの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

 ** [tags](#API_CreateSolutionVersion_RequestSyntax) **   <a name="personalize-CreateSolutionVersion-request-tags"></a>
ソリューションバージョンに適用する[タグ](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)のリスト。  
型: [Tag](API_Tag.md) オブジェクトの配列  
配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。  
必須: いいえ

 ** [trainingMode](#API_CreateSolutionVersion_RequestSyntax) **   <a name="personalize-CreateSolutionVersion-request-trainingMode"></a>
ソリューションバージョンを作成するときに実行するトレーニングの範囲。デフォルトは `FULL` です。これにより、データセットグループ内のデータセットからのトレーニングデータ全体に基づいて、完全に新しいモデルが作成されます。  
[User-Personalization](https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html)を使用する場合は、`UPDATE` のトレーニングモードを指定できます。これによりモデルが更新され、新しい項目をレコメンデーションの対象として検討するようになります。これは完全な再トレーニングではありません。それでも、毎週完全な再トレーニングを完了する必要があります。`UPDATE` を指定した場合、Amazon Personalize はソリューションバージョンの自動更新を停止します。更新を再開するには、トレーニングモードを `FULL` に設定して新しいソリューションを作成し、キャンペーンにデプロイします。自動更新の詳細については、「[自動更新](https://docs.aws.amazon.com/personalize/latest/dg/use-case-recipe-features.html#maintaining-with-automatic-updates)」を参照してください。  
`UPDATE` オプションは、`FULL` オプションを使用して入力ソリューションから作成されたアクティブなソリューションバージョンが既にあり、入力ソリューションが [User-Personalization](https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html) レシピまたは [HRNN-Coldstart](https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html) レシピでトレーニングされている場合にのみ使用できます。  
型: 文字列  
有効な値：`FULL | UPDATE | AUTOTRAIN`  
必須：いいえ

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

```
{
   "solutionVersionArn": "string"
}
```

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

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

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

 ** [solutionVersionArn](#API_CreateSolutionVersion_ResponseSyntax) **   <a name="personalize-CreateSolutionVersion-response-solutionVersionArn"></a>
新しいソリューションバージョンの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

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

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

 ** LimitExceededException **   
1 秒あたりのリクエスト数の上限を超えています。  
HTTP ステータスコード: 400

 ** ResourceAlreadyExistsException **   
指定したリソースはすでに存在しています。  
HTTP ステータスコード: 400

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

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

 ** TooManyTagsException **   
このリソースに適用できるタグの最大数を超過しています。  
HTTP ステータスコード: 400

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

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

# DeleteCampaign
<a name="API_DeleteCampaign"></a>

ソリューションのデプロイを削除して、キャンペーンを削除します。キャンペーンのベースとなっているソリューションは削除されず、必要に応じて再デプロイできます。削除されたキャンペーンは、[GetRecommendations](https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) リクエストで指定できなくなりました。キャンペーンの作成については、「[CreateCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html)」を参照してください。

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

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

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

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

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

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

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

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

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

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

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

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

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

# DeleteDataset
<a name="API_DeleteDataset"></a>

データセットを削除します。関連付けられた `DatasetImportJob` または `SolutionVersion` が CREATE PENDING または IN PROGRESS 状態にある場合、データセットを削除することはできません。データセットの削除の詳細については、「[データセットの削除](https://docs.aws.amazon.com/personalize/latest/dg/delete-dataset.html)」を参照してください。

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

```
{
   "datasetArn": "string"
}
```

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

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

 ** [datasetArn](#API_DeleteDataset_RequestSyntax) **   <a name="personalize-DeleteDataset-request-datasetArn"></a>
削除するデータセットの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

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

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

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

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

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

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

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

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

# DeleteDatasetGroup
<a name="API_DeleteDatasetGroup"></a>

データセットグループを削除します。データセットグループを削除する前に、以下を削除する必要があります。
+ すべての関連付けられたイベントトラッカー。
+ すべての関連付けられたソリューション。
+ データセットグループのすべてのデータセット。

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

```
{
   "datasetGroupArn": "string"
}
```

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

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

 ** [datasetGroupArn](#API_DeleteDatasetGroup_RequestSyntax) **   <a name="personalize-DeleteDatasetGroup-request-datasetGroupArn"></a>
削除するデータセットグループの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

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

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

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

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

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

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

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

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

# DeleteEventTracker
<a name="API_DeleteEventTracker"></a>

イベントトラッカーを削除します。データセットグループからデータセットを削除しません。イベントトラッカーについての詳細は、「[CreateEventTracker](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html)」を参照してください。

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

```
{
   "eventTrackerArn": "string"
}
```

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

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

 ** [eventTrackerArn](#API_DeleteEventTracker_RequestSyntax) **   <a name="personalize-DeleteEventTracker-request-eventTrackerArn"></a>
削除するイベントトラッカーの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

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

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

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

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

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

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

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

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

# DeleteFilter
<a name="API_DeleteFilter"></a>

フィルターを削除します。

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

```
{
   "filterArn": "string"
}
```

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

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

 ** [filterArn](#API_DeleteFilter_RequestSyntax) **   <a name="personalize-DeleteFilter-request-filterArn"></a>
削除するフィルターの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

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

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

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

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

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

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

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

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

# DeleteMetricAttribution
<a name="API_DeleteMetricAttribution"></a>

メトリクス属性を削除します。

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

```
{
   "metricAttributionArn": "string"
}
```

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

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

 ** [metricAttributionArn](#API_DeleteMetricAttribution_RequestSyntax) **   <a name="personalize-DeleteMetricAttribution-request-metricAttributionArn"></a>
メトリクス属性の Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

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

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

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

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

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

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

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

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

# DeleteRecommender
<a name="API_DeleteRecommender"></a>

レコメンダーを非アクティブにして削除します。削除されたレコメンダーは、[GetRecommendations](https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) リクエストで指定できなくなりました。

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

```
{
   "recommenderArn": "string"
}
```

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

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

 ** [recommenderArn](#API_DeleteRecommender_RequestSyntax) **   <a name="personalize-DeleteRecommender-request-recommenderArn"></a>
削除するレコメンダーの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

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

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

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

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

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

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

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

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

# DeleteSchema
<a name="API_DeleteSchema"></a>

スキーマを削除します。スキーマを削除する前に、そのスキーマを参照しているすべてのデータセットを削除する必要があります。スキーマについての詳細は、「[CreateSchema](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html)」を参照してください。

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

```
{
   "schemaArn": "string"
}
```

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

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

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

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

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

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

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

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

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

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

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

# DeleteSolution
<a name="API_DeleteSolution"></a>

ソリューションのすべてのバージョンと `Solution` オブジェクト自体を削除します。ソリューションを削除する前に、そのソリューションに基づくすべてのキャンペーンを削除する必要があります。ソリューションを使用しているキャンペーンを決定するには、[ListCampaigns](https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html) を呼び出して、ソリューションの Amazon リソースネーム (ARN) を提供します。関連付けられた `SolutionVersion` が CREATE PENDING または IN PROGRESS 状態にある場合、ソリューションを削除することはできません。詳細については、「[CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html)」を参照してください。

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

```
{
   "solutionArn": "string"
}
```

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

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

 ** [solutionArn](#API_DeleteSolution_RequestSyntax) **   <a name="personalize-DeleteSolution-request-solutionArn"></a>
削除するソリューションの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

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

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

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

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

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

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

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

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

# DescribeAlgorithm
<a name="API_DescribeAlgorithm"></a>

特定のアルゴリズムを記述します。

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

```
{
   "algorithmArn": "string"
}
```

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

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

 ** [algorithmArn](#API_DescribeAlgorithm_RequestSyntax) **   <a name="personalize-DescribeAlgorithm-request-algorithmArn"></a>
記述するアルゴリズムの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

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

```
{
   "algorithm": { 
      "algorithmArn": "string",
      "algorithmImage": { 
         "dockerURI": "string",
         "name": "string"
      },
      "creationDateTime": number,
      "defaultHyperParameterRanges": { 
         "categoricalHyperParameterRanges": [ 
            { 
               "isTunable": boolean,
               "name": "string",
               "values": [ "string" ]
            }
         ],
         "continuousHyperParameterRanges": [ 
            { 
               "isTunable": boolean,
               "maxValue": number,
               "minValue": number,
               "name": "string"
            }
         ],
         "integerHyperParameterRanges": [ 
            { 
               "isTunable": boolean,
               "maxValue": number,
               "minValue": number,
               "name": "string"
            }
         ]
      },
      "defaultHyperParameters": { 
         "string" : "string" 
      },
      "defaultResourceConfig": { 
         "string" : "string" 
      },
      "lastUpdatedDateTime": number,
      "name": "string",
      "roleArn": "string",
      "trainingInputMode": "string"
   }
}
```

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

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

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

 ** [algorithm](#API_DescribeAlgorithm_ResponseSyntax) **   <a name="personalize-DescribeAlgorithm-response-algorithm"></a>
アルゴリズムのプロパティのリスト。  
型: [Algorithm](API_Algorithm.md) オブジェクト

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

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

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

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

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

# DescribeBatchInferenceJob
<a name="API_DescribeBatchInferenceJob"></a>

名前、Amazon リソースネーム (ARN)、ステータス、入力と出力の設定、およびレコメンデーションの生成に使用されたソリューションバージョンの ARN を含むバッチ推論ジョブのプロパティを取得します。

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

```
{
   "batchInferenceJobArn": "string"
}
```

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

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

 ** [batchInferenceJobArn](#API_DescribeBatchInferenceJob_RequestSyntax) **   <a name="personalize-DescribeBatchInferenceJob-request-batchInferenceJobArn"></a>
記述するバッチ推論ジョブの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

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

```
{
   "batchInferenceJob": { 
      "batchInferenceJobArn": "string",
      "batchInferenceJobConfig": { 
         "itemExplorationConfig": { 
            "string" : "string" 
         },
         "rankingInfluence": { 
            "string" : number 
         }
      },
      "batchInferenceJobMode": "string",
      "creationDateTime": number,
      "failureReason": "string",
      "filterArn": "string",
      "jobInput": { 
         "s3DataSource": { 
            "kmsKeyArn": "string",
            "path": "string"
         }
      },
      "jobName": "string",
      "jobOutput": { 
         "s3DataDestination": { 
            "kmsKeyArn": "string",
            "path": "string"
         }
      },
      "lastUpdatedDateTime": number,
      "numResults": number,
      "roleArn": "string",
      "solutionVersionArn": "string",
      "status": "string",
      "themeGenerationConfig": { 
         "fieldsForThemeGeneration": { 
            "itemName": "string"
         }
      }
   }
}
```

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

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

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

 ** [batchInferenceJob](#API_DescribeBatchInferenceJob_ResponseSyntax) **   <a name="personalize-DescribeBatchInferenceJob-response-batchInferenceJob"></a>
指定されたバッチ推論ジョブに関する情報。  
型: [BatchInferenceJob](API_BatchInferenceJob.md) オブジェクト

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

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

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

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

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

# DescribeBatchSegmentJob
<a name="API_DescribeBatchSegmentJob"></a>

名前、Amazon リソースネーム (ARN)、ステータス、入力と出力の設定、およびセグメントの生成に使用されたソリューションバージョンの ARN を含むバッチセグメントジョブのプロパティを取得します。

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

```
{
   "batchSegmentJobArn": "string"
}
```

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

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

 ** [batchSegmentJobArn](#API_DescribeBatchSegmentJob_RequestSyntax) **   <a name="personalize-DescribeBatchSegmentJob-request-batchSegmentJobArn"></a>
記述するバッチセグメントジョブの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

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

```
{
   "batchSegmentJob": { 
      "batchSegmentJobArn": "string",
      "creationDateTime": number,
      "failureReason": "string",
      "filterArn": "string",
      "jobInput": { 
         "s3DataSource": { 
            "kmsKeyArn": "string",
            "path": "string"
         }
      },
      "jobName": "string",
      "jobOutput": { 
         "s3DataDestination": { 
            "kmsKeyArn": "string",
            "path": "string"
         }
      },
      "lastUpdatedDateTime": number,
      "numResults": number,
      "roleArn": "string",
      "solutionVersionArn": "string",
      "status": "string"
   }
}
```

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

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

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

 ** [batchSegmentJob](#API_DescribeBatchSegmentJob_ResponseSyntax) **   <a name="personalize-DescribeBatchSegmentJob-response-batchSegmentJob"></a>
指定されたバッチセグメントジョブに関する情報。  
型: [BatchSegmentJob](API_BatchSegmentJob.md) オブジェクト

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

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

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

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

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

# DescribeCampaign
<a name="API_DescribeCampaign"></a>

ステータスを含む、特定のキャンペーンを記述します。

キャンペーンは、次に示す状態のいずれかになります。
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -または- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS

`status` が `CREATE FAILED` の場合、レスポンスには理由を記述する `failureReason` キーが含まれます。

キャンペーンの作成の詳細については、「[CreateCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html)」を参照してください。

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

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

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

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

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

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

```
{
   "campaign": { 
      "campaignArn": "string",
      "campaignConfig": { 
         "enableMetadataWithRecommendations": boolean,
         "itemExplorationConfig": { 
            "string" : "string" 
         },
         "rankingInfluence": { 
            "string" : number 
         },
         "syncWithLatestSolutionVersion": boolean
      },
      "creationDateTime": number,
      "failureReason": "string",
      "lastUpdatedDateTime": number,
      "latestCampaignUpdate": { 
         "campaignConfig": { 
            "enableMetadataWithRecommendations": boolean,
            "itemExplorationConfig": { 
               "string" : "string" 
            },
            "rankingInfluence": { 
               "string" : number 
            },
            "syncWithLatestSolutionVersion": boolean
         },
         "creationDateTime": number,
         "failureReason": "string",
         "lastUpdatedDateTime": number,
         "minProvisionedTPS": number,
         "solutionVersionArn": "string",
         "status": "string"
      },
      "minProvisionedTPS": number,
      "name": "string",
      "solutionVersionArn": "string",
      "status": "string"
   }
}
```

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

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

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

 ** [campaign](#API_DescribeCampaign_ResponseSyntax) **   <a name="personalize-DescribeCampaign-response-campaign"></a>
`latestCampaignUpdate` フィールドは、キャンペーンで少なくとも 1 回の `UpdateCampaign` 呼び出しがあった場合にのみ返されます。
キャンペーンのプロパティ。  
`latestCampaignUpdate` フィールドは、キャンペーンで少なくとも 1 回の `UpdateCampaign` 呼び出しがあった場合にのみ返されます。
型: [Campaign](API_Campaign.md) オブジェクト

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

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

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

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

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

# DescribeDataDeletionJob
<a name="API_DescribeDataDeletionJob"></a>

[CreateDataDeletionJob](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataDeletionJob.html) によって作成されたデータ削除ジョブについて、ジョブのステータスを含めて説明します。

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

```
{
   "dataDeletionJobArn": "string"
}
```

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

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

 ** [dataDeletionJobArn](#API_DescribeDataDeletionJob_RequestSyntax) **   <a name="personalize-DescribeDataDeletionJob-request-dataDeletionJobArn"></a>
データ削除ジョブの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

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

```
{
   "dataDeletionJob": { 
      "creationDateTime": number,
      "dataDeletionJobArn": "string",
      "datasetGroupArn": "string",
      "dataSource": { 
         "dataLocation": "string"
      },
      "failureReason": "string",
      "jobName": "string",
      "lastUpdatedDateTime": number,
      "numDeleted": number,
      "roleArn": "string",
      "status": "string"
   }
}
```

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

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

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

 ** [dataDeletionJob](#API_DescribeDataDeletionJob_ResponseSyntax) **   <a name="personalize-DescribeDataDeletionJob-response-dataDeletionJob"></a>
ステータスを含む、データ削除ジョブに関する情報。  
ステータスは、次のいずれかの値です。  
+ 保留中
+ IN\$1PROGRESS
+ COMPLETED
+ FAILED
型: [DataDeletionJob](API_DataDeletionJob.md) オブジェクト

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

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

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

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

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

# DescribeDataset
<a name="API_DescribeDataset"></a>

特定のデータセットの記述を表示します。データセットについての詳細は、「[CreateDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html)」を参照してください。

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

```
{
   "datasetArn": "string"
}
```

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

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

 ** [datasetArn](#API_DescribeDataset_RequestSyntax) **   <a name="personalize-DescribeDataset-request-datasetArn"></a>
記述するデータセットの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

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

```
{
   "dataset": { 
      "creationDateTime": number,
      "datasetArn": "string",
      "datasetGroupArn": "string",
      "datasetType": "string",
      "lastUpdatedDateTime": number,
      "latestDatasetUpdate": { 
         "creationDateTime": number,
         "failureReason": "string",
         "lastUpdatedDateTime": number,
         "schemaArn": "string",
         "status": "string"
      },
      "name": "string",
      "schemaArn": "string",
      "status": "string",
      "trackingId": "string"
   }
}
```

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

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

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

 ** [dataset](#API_DescribeDataset_ResponseSyntax) **   <a name="personalize-DescribeDataset-response-dataset"></a>
データセットのプロパティのリスト。  
型: [Dataset](API_Dataset.md) オブジェクト

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

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

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

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

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

# DescribeDatasetExportJob
<a name="API_DescribeDatasetExportJob"></a>

[CreateDatasetExportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html) によって作成されたデータセットのエクスポートジョブについて、エクスポートジョブのステータスを含めて記述します。

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

```
{
   "datasetExportJobArn": "string"
}
```

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

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

 ** [datasetExportJobArn](#API_DescribeDatasetExportJob_RequestSyntax) **   <a name="personalize-DescribeDatasetExportJob-request-datasetExportJobArn"></a>
記述するデータセットのエクスポートジョブの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

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

```
{
   "datasetExportJob": { 
      "creationDateTime": number,
      "datasetArn": "string",
      "datasetExportJobArn": "string",
      "failureReason": "string",
      "ingestionMode": "string",
      "jobName": "string",
      "jobOutput": { 
         "s3DataDestination": { 
            "kmsKeyArn": "string",
            "path": "string"
         }
      },
      "lastUpdatedDateTime": number,
      "roleArn": "string",
      "status": "string"
   }
}
```

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

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

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

 ** [datasetExportJob](#API_DescribeDatasetExportJob_ResponseSyntax) **   <a name="personalize-DescribeDatasetExportJob-response-datasetExportJob"></a>
ステータスを含む、データセットのエクスポートジョブに関する情報。  
ステータスは、次のいずれかの値です。  
+ CREATE PENDING
+ CREATE IN\$1PROGRESS
+ アクティブ
+ CREATE FAILED
型: [DatasetExportJob](API_DatasetExportJob.md) オブジェクト

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

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

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

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

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

# DescribeDatasetGroup
<a name="API_DescribeDatasetGroup"></a>

特定のデータセットグループを記述します。データセットグループについての詳細は、「[CreateDatasetGroup](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html)」を参照してください。

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

```
{
   "datasetGroupArn": "string"
}
```

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

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

 ** [datasetGroupArn](#API_DescribeDatasetGroup_RequestSyntax) **   <a name="personalize-DescribeDatasetGroup-request-datasetGroupArn"></a>
記述するデータセットグループの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

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

```
{
   "datasetGroup": { 
      "creationDateTime": number,
      "datasetGroupArn": "string",
      "domain": "string",
      "failureReason": "string",
      "kmsKeyArn": "string",
      "lastUpdatedDateTime": number,
      "name": "string",
      "roleArn": "string",
      "status": "string"
   }
}
```

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

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

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

 ** [datasetGroup](#API_DescribeDatasetGroup_ResponseSyntax) **   <a name="personalize-DescribeDatasetGroup-response-datasetGroup"></a>
データセットグループのプロパティのリスト。  
型: [DatasetGroup](API_DatasetGroup.md) オブジェクト

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

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

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

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

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

# DescribeDatasetImportJob
<a name="API_DescribeDatasetImportJob"></a>

[CreateDatasetImportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html) によって作成されたデータセットのインポートジョブについて、インポートジョブのステータスを含めて記述します。

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

```
{
   "datasetImportJobArn": "string"
}
```

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

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

 ** [datasetImportJobArn](#API_DescribeDatasetImportJob_RequestSyntax) **   <a name="personalize-DescribeDatasetImportJob-request-datasetImportJobArn"></a>
記述するデータセットのインポートジョブの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

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

```
{
   "datasetImportJob": { 
      "creationDateTime": number,
      "datasetArn": "string",
      "datasetImportJobArn": "string",
      "dataSource": { 
         "dataLocation": "string"
      },
      "failureReason": "string",
      "importMode": "string",
      "jobName": "string",
      "lastUpdatedDateTime": number,
      "publishAttributionMetricsToS3": boolean,
      "roleArn": "string",
      "status": "string"
   }
}
```

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

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

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

 ** [datasetImportJob](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="personalize-DescribeDatasetImportJob-response-datasetImportJob"></a>
ステータスを含む、データセットのインポートジョブに関する情報。  
ステータスは、次のいずれかの値です。  
+ CREATE PENDING
+ CREATE IN\$1PROGRESS
+ アクティブ
+ CREATE FAILED
型: [DatasetImportJob](API_DatasetImportJob.md) オブジェクト

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

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

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

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

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

# DescribeEventTracker
<a name="API_DescribeEventTracker"></a>

イベントトラッカーの説明を記述します。レスポンスには、イベントトラッカーの `trackingId` と `status` が含まれます。イベントトラッカーについての詳細は、「[CreateEventTracker](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html)」を参照してください。

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

```
{
   "eventTrackerArn": "string"
}
```

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

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

 ** [eventTrackerArn](#API_DescribeEventTracker_RequestSyntax) **   <a name="personalize-DescribeEventTracker-request-eventTrackerArn"></a>
記述するイベントトラッカーの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

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

```
{
   "eventTracker": { 
      "accountId": "string",
      "creationDateTime": number,
      "datasetGroupArn": "string",
      "eventTrackerArn": "string",
      "lastUpdatedDateTime": number,
      "name": "string",
      "status": "string",
      "trackingId": "string"
   }
}
```

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

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

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

 ** [eventTracker](#API_DescribeEventTracker_ResponseSyntax) **   <a name="personalize-DescribeEventTracker-response-eventTracker"></a>
イベントトラッカーを記述するオブジェクトです。  
型: [EventTracker](API_EventTracker.md) オブジェクト

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

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

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

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

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

# DescribeFeatureTransformation
<a name="API_DescribeFeatureTransformation"></a>

特定の特徴変換を記述します。

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

```
{
   "featureTransformationArn": "string"
}
```

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

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

 ** [featureTransformationArn](#API_DescribeFeatureTransformation_RequestSyntax) **   <a name="personalize-DescribeFeatureTransformation-request-featureTransformationArn"></a>
記述する特徴変換の Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

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

```
{
   "featureTransformation": { 
      "creationDateTime": number,
      "defaultParameters": { 
         "string" : "string" 
      },
      "featureTransformationArn": "string",
      "lastUpdatedDateTime": number,
      "name": "string",
      "status": "string"
   }
}
```

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

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

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

 ** [featureTransformation](#API_DescribeFeatureTransformation_ResponseSyntax) **   <a name="personalize-DescribeFeatureTransformation-response-featureTransformation"></a>
FeatureTransformation プロパティのリスト。  
型: [FeatureTransformation](API_FeatureTransformation.md) オブジェクト

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

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

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

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

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

# DescribeFilter
<a name="API_DescribeFilter"></a>

フィルターのプロパティを記述します。

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

```
{
   "filterArn": "string"
}
```

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

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

 ** [filterArn](#API_DescribeFilter_RequestSyntax) **   <a name="personalize-DescribeFilter-request-filterArn"></a>
記述するフィルターの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

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

```
{
   "filter": { 
      "creationDateTime": number,
      "datasetGroupArn": "string",
      "failureReason": "string",
      "filterArn": "string",
      "filterExpression": "string",
      "lastUpdatedDateTime": number,
      "name": "string",
      "status": "string"
   }
}
```

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

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

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

 ** [filter](#API_DescribeFilter_ResponseSyntax) **   <a name="personalize-DescribeFilter-response-filter"></a>
フィルターの詳細。  
型: [Filter](API_Filter.md) オブジェクト

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

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

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

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

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

# DescribeMetricAttribution
<a name="API_DescribeMetricAttribution"></a>

メトリクス属性について説明します。

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

```
{
   "metricAttributionArn": "string"
}
```

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

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

 ** [metricAttributionArn](#API_DescribeMetricAttribution_RequestSyntax) **   <a name="personalize-DescribeMetricAttribution-request-metricAttributionArn"></a>
メトリクス属性の Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

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

```
{
   "metricAttribution": { 
      "creationDateTime": number,
      "datasetGroupArn": "string",
      "failureReason": "string",
      "lastUpdatedDateTime": number,
      "metricAttributionArn": "string",
      "metricsOutputConfig": { 
         "roleArn": "string",
         "s3DataDestination": { 
            "kmsKeyArn": "string",
            "path": "string"
         }
      },
      "name": "string",
      "status": "string"
   }
}
```

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

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

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

 ** [metricAttribution](#API_DescribeMetricAttribution_ResponseSyntax) **   <a name="personalize-DescribeMetricAttribution-response-metricAttribution"></a>
メトリックス属性の詳細。  
型: [MetricAttribution](API_MetricAttribution.md) オブジェクト

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

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

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

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

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

# DescribeRecipe
<a name="API_DescribeRecipe"></a>

レシピを説明を記述します。

レシピには 3 つのアイテムが含まれています。
+ モデルをトレーニングするアルゴリズム。
+ トレーニングを統制するハイパーパラメータ。
+ トレーニング前に入力データを変更するための特徴変換に関する情報。

Amazon Personalize は、事前定義された一連のレシピを提供します。[CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) API を使用してソリューションを作成するときに、レシピを指定します。`CreateSolution` は、指定されたレシピのアルゴリズムとトレーニングデータセットを使用してモデルをトレーニングします。ソリューションをキャンペーンとしてデプロイすると、[GetRecommendations](https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) API を使用してレコメンデーションを提供できます。

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

```
{
   "recipeArn": "string"
}
```

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

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

 ** [recipeArn](#API_DescribeRecipe_RequestSyntax) **   <a name="personalize-DescribeRecipe-request-recipeArn"></a>
記述するレシピの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

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

```
{
   "recipe": { 
      "algorithmArn": "string",
      "creationDateTime": number,
      "description": "string",
      "featureTransformationArn": "string",
      "lastUpdatedDateTime": number,
      "name": "string",
      "recipeArn": "string",
      "recipeType": "string",
      "status": "string"
   }
}
```

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

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

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

 ** [recipe](#API_DescribeRecipe_ResponseSyntax) **   <a name="personalize-DescribeRecipe-response-recipe"></a>
レシピを記述するオブジェクト。  
型: [Recipe](API_Recipe.md) オブジェクト

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

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

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

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

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

# DescribeRecommender
<a name="API_DescribeRecommender"></a>

ステータスを含む、特定のレコメンダーを記述します。

レコメンダーは、次に示す状態のいずれかになります。
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -または- CREATE FAILED
+ STOP PENDING > STOP IN\$1PROGRESS > INACTIVE > START PENDING > START IN\$1PROGRESS > ACTIVE
+ DELETE PENDING > DELETE IN\$1PROGRESS

`status` が `CREATE FAILED` の場合、レスポンスには理由を記述する `failureReason` キーが含まれます。

レコメンダーを作成または削除しているときは、`modelMetrics` キーは null になります。

レコメンダーの詳細については、[CreateRecommender](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateRecommender.html) を参照してください。

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

```
{
   "recommenderArn": "string"
}
```

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

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

 ** [recommenderArn](#API_DescribeRecommender_RequestSyntax) **   <a name="personalize-DescribeRecommender-request-recommenderArn"></a>
記述するレコメンダーの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

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

```
{
   "recommender": { 
      "creationDateTime": number,
      "datasetGroupArn": "string",
      "failureReason": "string",
      "lastUpdatedDateTime": number,
      "latestRecommenderUpdate": { 
         "creationDateTime": number,
         "failureReason": "string",
         "lastUpdatedDateTime": number,
         "recommenderConfig": { 
            "enableMetadataWithRecommendations": boolean,
            "itemExplorationConfig": { 
               "string" : "string" 
            },
            "minRecommendationRequestsPerSecond": number,
            "trainingDataConfig": { 
               "excludedDatasetColumns": { 
                  "string" : [ "string" ]
               },
               "includedDatasetColumns": { 
                  "string" : [ "string" ]
               }
            }
         },
         "status": "string"
      },
      "modelMetrics": { 
         "string" : number 
      },
      "name": "string",
      "recipeArn": "string",
      "recommenderArn": "string",
      "recommenderConfig": { 
         "enableMetadataWithRecommendations": boolean,
         "itemExplorationConfig": { 
            "string" : "string" 
         },
         "minRecommendationRequestsPerSecond": number,
         "trainingDataConfig": { 
            "excludedDatasetColumns": { 
               "string" : [ "string" ]
            },
            "includedDatasetColumns": { 
               "string" : [ "string" ]
            }
         }
      },
      "status": "string"
   }
}
```

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

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

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

 ** [recommender](#API_DescribeRecommender_ResponseSyntax) **   <a name="personalize-DescribeRecommender-response-recommender"></a>
レコメンダーのプロパティ。  
型: [Recommender](API_Recommender.md) オブジェクト

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

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

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

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

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

# DescribeSchema
<a name="API_DescribeSchema"></a>

スキーマの説明を記述します。スキーマについての詳細は、「[CreateSchema](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html)」を参照してください。

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

```
{
   "schemaArn": "string"
}
```

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

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

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

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

```
{
   "schema": { 
      "creationDateTime": number,
      "domain": "string",
      "lastUpdatedDateTime": number,
      "name": "string",
      "schema": "string",
      "schemaArn": "string"
   }
}
```

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

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

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

 ** [schema](#API_DescribeSchema_ResponseSyntax) **   <a name="personalize-DescribeSchema-response-schema"></a>
リクエストされたスキーマ。  
型: [DatasetSchema](API_DatasetSchema.md) オブジェクト

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

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

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

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

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

# DescribeSolution
<a name="API_DescribeSolution"></a>

ソリューションの説明を記述します。詳細については、「[CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html)」を参照してください。

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

```
{
   "solutionArn": "string"
}
```

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

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

 ** [solutionArn](#API_DescribeSolution_RequestSyntax) **   <a name="personalize-DescribeSolution-request-solutionArn"></a>
記述するソリューションの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

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

```
{
   "solution": { 
      "autoMLResult": { 
         "bestRecipeArn": "string"
      },
      "creationDateTime": number,
      "datasetGroupArn": "string",
      "eventType": "string",
      "lastUpdatedDateTime": number,
      "latestSolutionUpdate": { 
         "creationDateTime": number,
         "failureReason": "string",
         "lastUpdatedDateTime": number,
         "performAutoTraining": boolean,
         "performIncrementalUpdate": boolean,
         "solutionUpdateConfig": { 
            "autoTrainingConfig": { 
               "schedulingExpression": "string"
            },
            "eventsConfig": { 
               "eventParametersList": [ 
                  { 
                     "eventType": "string",
                     "eventValueThreshold": number,
                     "weight": number
                  }
               ]
            }
         },
         "status": "string"
      },
      "latestSolutionVersion": { 
         "creationDateTime": number,
         "failureReason": "string",
         "lastUpdatedDateTime": number,
         "solutionVersionArn": "string",
         "status": "string",
         "trainingMode": "string",
         "trainingType": "string"
      },
      "name": "string",
      "performAutoML": boolean,
      "performAutoTraining": boolean,
      "performHPO": boolean,
      "performIncrementalUpdate": boolean,
      "recipeArn": "string",
      "solutionArn": "string",
      "solutionConfig": { 
         "algorithmHyperParameters": { 
            "string" : "string" 
         },
         "autoMLConfig": { 
            "metricName": "string",
            "recipeList": [ "string" ]
         },
         "autoTrainingConfig": { 
            "schedulingExpression": "string"
         },
         "eventsConfig": { 
            "eventParametersList": [ 
               { 
                  "eventType": "string",
                  "eventValueThreshold": number,
                  "weight": number
               }
            ]
         },
         "eventValueThreshold": "string",
         "featureTransformationParameters": { 
            "string" : "string" 
         },
         "hpoConfig": { 
            "algorithmHyperParameterRanges": { 
               "categoricalHyperParameterRanges": [ 
                  { 
                     "name": "string",
                     "values": [ "string" ]
                  }
               ],
               "continuousHyperParameterRanges": [ 
                  { 
                     "maxValue": number,
                     "minValue": number,
                     "name": "string"
                  }
               ],
               "integerHyperParameterRanges": [ 
                  { 
                     "maxValue": number,
                     "minValue": number,
                     "name": "string"
                  }
               ]
            },
            "hpoObjective": { 
               "metricName": "string",
               "metricRegex": "string",
               "type": "string"
            },
            "hpoResourceConfig": { 
               "maxNumberOfTrainingJobs": "string",
               "maxParallelTrainingJobs": "string"
            }
         },
         "optimizationObjective": { 
            "itemAttribute": "string",
            "objectiveSensitivity": "string"
         },
         "trainingDataConfig": { 
            "excludedDatasetColumns": { 
               "string" : [ "string" ]
            },
            "includedDatasetColumns": { 
               "string" : [ "string" ]
            }
         }
      },
      "status": "string"
   }
}
```

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

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

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

 ** [solution](#API_DescribeSolution_ResponseSyntax) **   <a name="personalize-DescribeSolution-response-solution"></a>
ソリューションを記述するオブジェクト。  
型: [Solution](API_Solution.md) オブジェクト

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

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

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

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

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

# DescribeSolutionVersion
<a name="API_DescribeSolutionVersion"></a>

ソリューションの特定のバージョンを記述します。詳細については、「[CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html)」を参照してください。

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

```
{
   "solutionVersionArn": "string"
}
```

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

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

 ** [solutionVersionArn](#API_DescribeSolutionVersion_RequestSyntax) **   <a name="personalize-DescribeSolutionVersion-request-solutionVersionArn"></a>
ソリューションバージョンの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

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

```
{
   "solutionVersion": { 
      "creationDateTime": number,
      "datasetGroupArn": "string",
      "eventType": "string",
      "failureReason": "string",
      "lastUpdatedDateTime": number,
      "name": "string",
      "performAutoML": boolean,
      "performHPO": boolean,
      "performIncrementalUpdate": boolean,
      "recipeArn": "string",
      "solutionArn": "string",
      "solutionConfig": { 
         "algorithmHyperParameters": { 
            "string" : "string" 
         },
         "autoMLConfig": { 
            "metricName": "string",
            "recipeList": [ "string" ]
         },
         "autoTrainingConfig": { 
            "schedulingExpression": "string"
         },
         "eventsConfig": { 
            "eventParametersList": [ 
               { 
                  "eventType": "string",
                  "eventValueThreshold": number,
                  "weight": number
               }
            ]
         },
         "eventValueThreshold": "string",
         "featureTransformationParameters": { 
            "string" : "string" 
         },
         "hpoConfig": { 
            "algorithmHyperParameterRanges": { 
               "categoricalHyperParameterRanges": [ 
                  { 
                     "name": "string",
                     "values": [ "string" ]
                  }
               ],
               "continuousHyperParameterRanges": [ 
                  { 
                     "maxValue": number,
                     "minValue": number,
                     "name": "string"
                  }
               ],
               "integerHyperParameterRanges": [ 
                  { 
                     "maxValue": number,
                     "minValue": number,
                     "name": "string"
                  }
               ]
            },
            "hpoObjective": { 
               "metricName": "string",
               "metricRegex": "string",
               "type": "string"
            },
            "hpoResourceConfig": { 
               "maxNumberOfTrainingJobs": "string",
               "maxParallelTrainingJobs": "string"
            }
         },
         "optimizationObjective": { 
            "itemAttribute": "string",
            "objectiveSensitivity": "string"
         },
         "trainingDataConfig": { 
            "excludedDatasetColumns": { 
               "string" : [ "string" ]
            },
            "includedDatasetColumns": { 
               "string" : [ "string" ]
            }
         }
      },
      "solutionVersionArn": "string",
      "status": "string",
      "trainingHours": number,
      "trainingMode": "string",
      "trainingType": "string",
      "tunedHPOParams": { 
         "algorithmHyperParameters": { 
            "string" : "string" 
         }
      }
   }
}
```

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

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

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

 ** [solutionVersion](#API_DescribeSolutionVersion_ResponseSyntax) **   <a name="personalize-DescribeSolutionVersion-response-solutionVersion"></a>
ソリューションバージョン。  
型: [SolutionVersion](API_SolutionVersion.md) オブジェクト

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

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

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

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

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

# GetSolutionMetrics
<a name="API_GetSolutionMetrics"></a>

指定されたソリューションバージョンのメトリクスを取得します。

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

```
{
   "solutionVersionArn": "string"
}
```

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

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

 ** [solutionVersionArn](#API_GetSolutionMetrics_RequestSyntax) **   <a name="personalize-GetSolutionMetrics-request-solutionVersionArn"></a>
メトリクスを取得するソリューションバージョンの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

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

```
{
   "metrics": { 
      "string" : number 
   },
   "solutionVersionArn": "string"
}
```

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

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

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

 ** [metrics](#API_GetSolutionMetrics_ResponseSyntax) **   <a name="personalize-GetSolutionMetrics-response-metrics"></a>
ソリューションバージョンのメトリクス。詳細については、[[メトリクスを使用してソリューションバージョンを評価する](https://docs.aws.amazon.com/personalize/latest/dg/working-with-training-metrics.html)]を参照してください。  
タイプ: ダブルマップへの文字列。  
マップエントリ: アイテムの最大数は 100 です。  
キーの長さの制限: 最大長は 256 です。

 ** [solutionVersionArn](#API_GetSolutionMetrics_ResponseSyntax) **   <a name="personalize-GetSolutionMetrics-response-solutionVersionArn"></a>
リクエストで指定されたものと同じソリューションバージョン ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

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

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

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

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

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

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

# ListBatchInferenceJobs
<a name="API_ListBatchInferenceJobs"></a>

ソリューションバージョンから実行されたバッチ推論ジョブのリストを取得します。

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

```
{
   "maxResults": number,
   "nextToken": "string",
   "solutionVersionArn": "string"
}
```

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

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

 ** [maxResults](#API_ListBatchInferenceJobs_RequestSyntax) **   <a name="personalize-ListBatchInferenceJobs-request-maxResults"></a>
各ページで返されるバッチ推論ジョブの結果の最大数。デフォルト値は 100 です。  
型: 整数  
有効範囲: 最小値 は 1 です。最大値は 100 です。  
必須: いいえ

 ** [nextToken](#API_ListBatchInferenceJobs_RequestSyntax) **   <a name="personalize-ListBatchInferenceJobs-request-nextToken"></a>
次の結果ページを要求するためのトークン。  
タイプ: 文字列  
長さの制限: 最大長は 1500 です。  
パターン: `\p{ASCII}{0,1500}`   
必須: いいえ

 ** [solutionVersionArn](#API_ListBatchInferenceJobs_RequestSyntax) **   <a name="personalize-ListBatchInferenceJobs-request-solutionVersionArn"></a>
バッチ推論ジョブが作成されたソリューションバージョンの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

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

```
{
   "batchInferenceJobs": [ 
      { 
         "batchInferenceJobArn": "string",
         "batchInferenceJobMode": "string",
         "creationDateTime": number,
         "failureReason": "string",
         "jobName": "string",
         "lastUpdatedDateTime": number,
         "solutionVersionArn": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

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

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

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

 ** [batchInferenceJobs](#API_ListBatchInferenceJobs_ResponseSyntax) **   <a name="personalize-ListBatchInferenceJobs-response-batchInferenceJobs"></a>
返される各ジョブに関する情報を含むリスト。  
型: [BatchInferenceJobSummary](API_BatchInferenceJobSummary.md) オブジェクトの配列  
配列メンバー: 最大数は 100 項目です。

 ** [nextToken](#API_ListBatchInferenceJobs_ResponseSyntax) **   <a name="personalize-ListBatchInferenceJobs-response-nextToken"></a>
次の結果ページの取得に使用するトークン。返される結果がそれ以上存在しない場合、値は `null` になります。  
タイプ: 文字列  
長さの制限: 最大長は 1500 です。  
パターン: `\p{ASCII}{0,1500}` 

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

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

 ** InvalidNextTokenException **   
トークンが無効です。  
HTTP ステータスコード: 400

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

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

# ListBatchSegmentJobs
<a name="API_ListBatchSegmentJobs"></a>

指定したソリューションバージョンから実行されたバッチセグメントジョブのリストを取得します。

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

```
{
   "maxResults": number,
   "nextToken": "string",
   "solutionVersionArn": "string"
}
```

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

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

 ** [maxResults](#API_ListBatchSegmentJobs_RequestSyntax) **   <a name="personalize-ListBatchSegmentJobs-request-maxResults"></a>
各ページで返されるバッチセグメントジョブの結果の最大数。デフォルト値は 100 です。  
型: 整数  
有効範囲: 最小値 は 1 です。最大値は 100 です。  
必須: いいえ

 ** [nextToken](#API_ListBatchSegmentJobs_RequestSyntax) **   <a name="personalize-ListBatchSegmentJobs-request-nextToken"></a>
次の結果ページを要求するためのトークン。  
タイプ: 文字列  
長さの制限: 最大長は 1500 です。  
パターン: `\p{ASCII}{0,1500}`   
必須: いいえ

 ** [solutionVersionArn](#API_ListBatchSegmentJobs_RequestSyntax) **   <a name="personalize-ListBatchSegmentJobs-request-solutionVersionArn"></a>
バッチセグメントジョブがバッチセグメントを生成するために使用したソリューションバージョンの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

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

```
{
   "batchSegmentJobs": [ 
      { 
         "batchSegmentJobArn": "string",
         "creationDateTime": number,
         "failureReason": "string",
         "jobName": "string",
         "lastUpdatedDateTime": number,
         "solutionVersionArn": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

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

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

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

 ** [batchSegmentJobs](#API_ListBatchSegmentJobs_ResponseSyntax) **   <a name="personalize-ListBatchSegmentJobs-response-batchSegmentJobs"></a>
返される各ジョブに関する情報を含むリスト。  
型: [BatchSegmentJobSummary](API_BatchSegmentJobSummary.md) オブジェクトの配列  
配列メンバー: 最大数は 100 項目です。

 ** [nextToken](#API_ListBatchSegmentJobs_ResponseSyntax) **   <a name="personalize-ListBatchSegmentJobs-response-nextToken"></a>
次の結果ページの取得に使用するトークン。返される結果がそれ以上存在しない場合、値は `null` になります。  
タイプ: 文字列  
長さの制限: 最大長は 1500 です。  
パターン: `\p{ASCII}{0,1500}` 

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

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

 ** InvalidNextTokenException **   
トークンが無効です。  
HTTP ステータスコード: 400

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

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

# ListCampaigns
<a name="API_ListCampaigns"></a>

特定のソリューションを使用するキャンペーンのリストを返します。ソリューションが指定されていない場合、アカウントに関連付けられているすべてのキャンペーンが一覧表示されます。レスポンスは、Amazon リソースネーム (ARN) など、各キャンペーンのプロパティを提供します。キャンペーンの作成の詳細については、「[CreateCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html)」を参照してください。

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

```
{
   "maxResults": number,
   "nextToken": "string",
   "solutionArn": "string"
}
```

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

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

 ** [maxResults](#API_ListCampaigns_RequestSyntax) **   <a name="personalize-ListCampaigns-request-maxResults"></a>
返されるキャンペーンの最大数。  
タイプ: 整数  
有効範囲: 最小値 は 1 です。最大値は 100 です。  
必須: いいえ

 ** [nextToken](#API_ListCampaigns_RequestSyntax) **   <a name="personalize-ListCampaigns-request-nextToken"></a>
キャンペーンの次のセットを取得するために、[ListCampaigns](https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html) に対する前の呼び出しから返されたトークン (存在する場合)。  
タイプ: 文字列  
長さの制限: 最大長は 1500 です。  
パターン: `\p{ASCII}{0,1500}`   
必須: いいえ

 ** [solutionArn](#API_ListCampaigns_RequestSyntax) **   <a name="personalize-ListCampaigns-request-solutionArn"></a>
キャンペーンを一覧表示するソリューションの Amazon リソースネーム (ARN)。ソリューションが指定されていない場合、アカウントに関連付けられているすべてのキャンペーンが一覧表示されます。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

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

```
{
   "campaigns": [ 
      { 
         "campaignArn": "string",
         "creationDateTime": number,
         "failureReason": "string",
         "lastUpdatedDateTime": number,
         "name": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

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

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

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

 ** [campaigns](#API_ListCampaigns_ResponseSyntax) **   <a name="personalize-ListCampaigns-response-campaigns"></a>
キャンペーンのリスト。  
型: [CampaignSummary](API_CampaignSummary.md) オブジェクトの配列  
配列メンバー: 最大数は 100 項目です。

 ** [nextToken](#API_ListCampaigns_ResponseSyntax) **   <a name="personalize-ListCampaigns-response-nextToken"></a>
キャンペーンの次のセットを取得するためのトークン (存在する場合)。  
タイプ: 文字列  
長さの制限: 最大長は 1500 です。  
パターン: `\p{ASCII}{0,1500}` 

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

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

 ** InvalidNextTokenException **   
トークンが無効です。  
HTTP ステータスコード: 400

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

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

# ListDataDeletionJobs
<a name="API_ListDataDeletionJobs"></a>

データセットグループのデータ削除ジョブのリストを、作成時刻順に新しいものから順に返します。データセットグループが指定されていない場合、アカウントに関連付けられているすべてのデータ削除ジョブが一覧表示されます。レスポンスは、Amazon リソースネーム (ARN) など、各ジョブのプロパティを提供します。データ削除ジョブの詳細については、「[ユーザーの削除](https://docs.aws.amazon.com/personalize/latest/dg/delete-records.html)」を参照してください。

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

```
{
   "datasetGroupArn": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

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

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

 ** [datasetGroupArn](#API_ListDataDeletionJobs_RequestSyntax) **   <a name="personalize-ListDataDeletionJobs-request-datasetGroupArn"></a>
データ削除ジョブを一覧表示するデータセットグループの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** [maxResults](#API_ListDataDeletionJobs_RequestSyntax) **   <a name="personalize-ListDataDeletionJobs-request-maxResults"></a>
返されるデータセットのデータ削除ジョブの最大数。  
タイプ: 整数  
有効範囲: 最小値 は 1 です。最大値は 100 です。  
必須: いいえ

 ** [nextToken](#API_ListDataDeletionJobs_RequestSyntax) **   <a name="personalize-ListDataDeletionJobs-request-nextToken"></a>
ジョブの次のセットを取得するために、前の `ListDataDeletionJobs` に対する呼び出しから返されたトークン (存在する場合)。  
タイプ: 文字列  
長さの制限: 最大長は 1500 です。  
パターン: `\p{ASCII}{0,1500}`   
必須: いいえ

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

```
{
   "dataDeletionJobs": [ 
      { 
         "creationDateTime": number,
         "dataDeletionJobArn": "string",
         "datasetGroupArn": "string",
         "failureReason": "string",
         "jobName": "string",
         "lastUpdatedDateTime": number,
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

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

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

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

 ** [dataDeletionJobs](#API_ListDataDeletionJobs_ResponseSyntax) **   <a name="personalize-ListDataDeletionJobs-response-dataDeletionJobs"></a>
データ削除ジョブのリスト。  
型: [DataDeletionJobSummary](API_DataDeletionJobSummary.md) オブジェクトの配列  
配列メンバー: 最大数は 100 項目です。

 ** [nextToken](#API_ListDataDeletionJobs_ResponseSyntax) **   <a name="personalize-ListDataDeletionJobs-response-nextToken"></a>
データ削除ジョブの次のセットを取得するためのトークン (存在する場合)。  
タイプ: 文字列  
長さの制限: 最大長は 1500 です。  
パターン: `\p{ASCII}{0,1500}` 

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

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

 ** InvalidNextTokenException **   
トークンが無効です。  
HTTP ステータスコード: 400

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

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

# ListDatasetExportJobs
<a name="API_ListDatasetExportJobs"></a>

特定のデータセットを使用するデータセットのエクスポートジョブのリストを返します。データセットが指定されていない場合、アカウントに関連付けられているすべてのデータセットのエクスポートジョブが一覧表示されます。レスポンスは、Amazon リソースネーム (ARN) など、データセットの各エクスポートジョブのプロパティを提供します。データセットのエクスポートジョブについての詳細は、「[CreateDatasetExportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html)」を参照してください。詳細については、[[CreateDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html)]を参照してください。

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

```
{
   "datasetArn": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

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

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

 ** [datasetArn](#API_ListDatasetExportJobs_RequestSyntax) **   <a name="personalize-ListDatasetExportJobs-request-datasetArn"></a>
データセットのエクスポートジョブを一覧表示するデータセットの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** [maxResults](#API_ListDatasetExportJobs_RequestSyntax) **   <a name="personalize-ListDatasetExportJobs-request-maxResults"></a>
返されるデータセットのエクスポートジョブの最大数。  
タイプ: 整数  
有効範囲: 最小値 は 1 です。最大値は 100 です。  
必須: いいえ

 ** [nextToken](#API_ListDatasetExportJobs_RequestSyntax) **   <a name="personalize-ListDatasetExportJobs-request-nextToken"></a>
データセットのエクスポートジョブの次のセットを取得するために、前の `ListDatasetExportJobs` に対する呼び出しから返されたトークン (存在する場合)。  
タイプ: 文字列  
長さの制限: 最大長は 1500 です。  
パターン: `\p{ASCII}{0,1500}`   
必須: いいえ

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

```
{
   "datasetExportJobs": [ 
      { 
         "creationDateTime": number,
         "datasetExportJobArn": "string",
         "failureReason": "string",
         "jobName": "string",
         "lastUpdatedDateTime": number,
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

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

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

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

 ** [datasetExportJobs](#API_ListDatasetExportJobs_ResponseSyntax) **   <a name="personalize-ListDatasetExportJobs-response-datasetExportJobs"></a>
データセットのエクスポートジョブのリスト。  
型: [DatasetExportJobSummary](API_DatasetExportJobSummary.md) オブジェクトの配列  
配列メンバー: 最大数は 100 項目です。

 ** [nextToken](#API_ListDatasetExportJobs_ResponseSyntax) **   <a name="personalize-ListDatasetExportJobs-response-nextToken"></a>
データセットのエクスポートジョブの次のセットを取得するためのトークン (存在する場合)。  
タイプ: 文字列  
長さの制限: 最大長は 1500 です。  
パターン: `\p{ASCII}{0,1500}` 

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

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

 ** InvalidNextTokenException **   
トークンが無効です。  
HTTP ステータスコード: 400

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

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

# ListDatasetGroups
<a name="API_ListDatasetGroups"></a>

データセットグループのリストを返します。レスポンスは、Amazon リソースネーム (ARN) など、各データセットグループのプロパティを提供します。データセットグループとデータセットの作成については、「[CreateDatasetGroup](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html)」を参照してください。

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

```
{
   "maxResults": number,
   "nextToken": "string"
}
```

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

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

 ** [maxResults](#API_ListDatasetGroups_RequestSyntax) **   <a name="personalize-ListDatasetGroups-request-maxResults"></a>
返されるデータセットグループの最大数。  
タイプ: 整数  
有効範囲: 最小値 は 1 です。最大値は 100 です。  
必須: いいえ

 ** [nextToken](#API_ListDatasetGroups_RequestSyntax) **   <a name="personalize-ListDatasetGroups-request-nextToken"></a>
データセットグループの次のセットを取得するために、前の `ListDatasetGroups` に対する呼び出しから返されたトークン (存在する場合)。  
タイプ: 文字列  
長さの制限: 最大長は 1500 です。  
パターン: `\p{ASCII}{0,1500}`   
必須: いいえ

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

```
{
   "datasetGroups": [ 
      { 
         "creationDateTime": number,
         "datasetGroupArn": "string",
         "domain": "string",
         "failureReason": "string",
         "lastUpdatedDateTime": number,
         "name": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

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

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

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

 ** [datasetGroups](#API_ListDatasetGroups_ResponseSyntax) **   <a name="personalize-ListDatasetGroups-response-datasetGroups"></a>
データセットグループのリスト。  
型: [DatasetGroupSummary](API_DatasetGroupSummary.md) オブジェクトの配列  
配列メンバー: 最大数は 100 項目です。

 ** [nextToken](#API_ListDatasetGroups_ResponseSyntax) **   <a name="personalize-ListDatasetGroups-response-nextToken"></a>
データセットグループの次のセットを取得するためのトークン (存在する場合)。  
タイプ: 文字列  
長さの制限: 最大長は 1500 です。  
パターン: `\p{ASCII}{0,1500}` 

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

 ** InvalidNextTokenException **   
トークンが無効です。  
HTTP ステータスコード: 400

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

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

# ListDatasetImportJobs
<a name="API_ListDatasetImportJobs"></a>

特定のデータセットを使用するデータセットのインポートジョブのリストを返します。データセットが指定されていない場合、アカウントに関連付けられているすべてのデータセットのインポートジョブが一覧表示されます。レスポンスは、Amazon リソースネーム (ARN) など、データセットの各インポートジョブのプロパティを提供します。データセットのインポートジョブについての詳細は、「[CreateDatasetImportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html)」を参照してください。詳細については、「[CreateDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html)」を参照してください。

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

```
{
   "datasetArn": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

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

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

 ** [datasetArn](#API_ListDatasetImportJobs_RequestSyntax) **   <a name="personalize-ListDatasetImportJobs-request-datasetArn"></a>
データセットのインポートジョブを一覧表示するデータセットの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** [maxResults](#API_ListDatasetImportJobs_RequestSyntax) **   <a name="personalize-ListDatasetImportJobs-request-maxResults"></a>
返されるデータセットのインポートジョブの最大数。  
タイプ: 整数  
有効範囲: 最小値 は 1 です。最大値は 100 です。  
必須: いいえ

 ** [nextToken](#API_ListDatasetImportJobs_RequestSyntax) **   <a name="personalize-ListDatasetImportJobs-request-nextToken"></a>
データセットのインポートジョブの次のセットを取得するために、前の `ListDatasetImportJobs` に対する呼び出しから返されたトークン (存在する場合)。  
タイプ: 文字列  
長さの制限: 最大長は 1500 です。  
パターン: `\p{ASCII}{0,1500}`   
必須: いいえ

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

```
{
   "datasetImportJobs": [ 
      { 
         "creationDateTime": number,
         "datasetImportJobArn": "string",
         "failureReason": "string",
         "importMode": "string",
         "jobName": "string",
         "lastUpdatedDateTime": number,
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

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

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

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

 ** [datasetImportJobs](#API_ListDatasetImportJobs_ResponseSyntax) **   <a name="personalize-ListDatasetImportJobs-response-datasetImportJobs"></a>
データセットのインポートジョブのリスト。  
型: [DatasetImportJobSummary](API_DatasetImportJobSummary.md) オブジェクトの配列  
配列メンバー: 最大数は 100 項目です。

 ** [nextToken](#API_ListDatasetImportJobs_ResponseSyntax) **   <a name="personalize-ListDatasetImportJobs-response-nextToken"></a>
データセットのインポートジョブの次のセットを取得するためのトークン (存在する場合)。  
タイプ: 文字列  
長さの制限: 最大長は 1500 です。  
パターン: `\p{ASCII}{0,1500}` 

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

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

 ** InvalidNextTokenException **   
トークンが無効です。  
HTTP ステータスコード: 400

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

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

# ListDatasets
<a name="API_ListDatasets"></a>

特定のデータセットグループに含まれるデータセットのリストを返します。レスポンスは、Amazon リソースネーム (ARN) など、各データセットのプロパティを提供します。詳細については、「[CreateDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html)」を参照してください。

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

```
{
   "datasetGroupArn": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

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

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

 ** [datasetGroupArn](#API_ListDatasets_RequestSyntax) **   <a name="personalize-ListDatasets-request-datasetGroupArn"></a>
一覧表示するデータセットを含むデータセットグループの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** [maxResults](#API_ListDatasets_RequestSyntax) **   <a name="personalize-ListDatasets-request-maxResults"></a>
返されるデータセットの最大数。  
タイプ: 整数  
有効範囲: 最小値 は 1 です。最大値は 100 です。  
必須: いいえ

 ** [nextToken](#API_ListDatasets_RequestSyntax) **   <a name="personalize-ListDatasets-request-nextToken"></a>
データセットのインポートジョブの次のセットを取得するために、前の `ListDatasets` に対する呼び出しから返されたトークン (存在する場合)。  
タイプ: 文字列  
長さの制限: 最大長は 1500 です。  
パターン: `\p{ASCII}{0,1500}`   
必須: いいえ

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

```
{
   "datasets": [ 
      { 
         "creationDateTime": number,
         "datasetArn": "string",
         "datasetType": "string",
         "lastUpdatedDateTime": number,
         "name": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

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

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

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

 ** [datasets](#API_ListDatasets_ResponseSyntax) **   <a name="personalize-ListDatasets-response-datasets"></a>
`Dataset` オブジェクトの配列。各オブジェクトはメタデータ情報を提供します。  
型: [DatasetSummary](API_DatasetSummary.md) オブジェクトの配列  
配列メンバー: 最大数は 100 項目です。

 ** [nextToken](#API_ListDatasets_ResponseSyntax) **   <a name="personalize-ListDatasets-response-nextToken"></a>
データセットの次のセットを取得するためのトークン (存在する場合)。  
タイプ: 文字列  
長さの制限: 最大長は 1500 です。  
パターン: `\p{ASCII}{0,1500}` 

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

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

 ** InvalidNextTokenException **   
トークンが無効です。  
HTTP ステータスコード: 400

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

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

# ListEventTrackers
<a name="API_ListEventTrackers"></a>

アカウントに関連付けられているイベントトラッカーのリストを返します。レスポンスは、Amazon リソースネーム (ARN) や追跡 ID など、各イベントトラッカーのプロパティを提供します。イベントトラッカーについての詳細は、「[CreateEventTracker](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html)」を参照してください。

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

```
{
   "datasetGroupArn": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

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

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

 ** [datasetGroupArn](#API_ListEventTrackers_RequestSyntax) **   <a name="personalize-ListEventTrackers-request-datasetGroupArn"></a>
レスポンスのフィルタリングに使用されるデータセットグループの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** [maxResults](#API_ListEventTrackers_RequestSyntax) **   <a name="personalize-ListEventTrackers-request-maxResults"></a>
返されるイベントトラッカーの最大数。  
タイプ: 整数  
有効範囲: 最小値 は 1 です。最大値は 100 です。  
必須: いいえ

 ** [nextToken](#API_ListEventTrackers_RequestSyntax) **   <a name="personalize-ListEventTrackers-request-nextToken"></a>
イベントトラッカーの次のセットを取得するために、前の `ListEventTrackers` に対する呼び出しから返されたトークン (存在する場合)。  
タイプ: 文字列  
長さの制限: 最大長は 1500 です。  
パターン: `\p{ASCII}{0,1500}`   
必須: いいえ

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

```
{
   "eventTrackers": [ 
      { 
         "creationDateTime": number,
         "eventTrackerArn": "string",
         "lastUpdatedDateTime": number,
         "name": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

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

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

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

 ** [eventTrackers](#API_ListEventTrackers_ResponseSyntax) **   <a name="personalize-ListEventTrackers-response-eventTrackers"></a>
イベントトラッカーのリスト。  
型: [EventTrackerSummary](API_EventTrackerSummary.md) オブジェクトの配列  
配列メンバー: 最大数は 100 項目です。

 ** [nextToken](#API_ListEventTrackers_ResponseSyntax) **   <a name="personalize-ListEventTrackers-response-nextToken"></a>
イベントトラッカーの次のセットを取得するためのトークン (存在する場合)。  
タイプ: 文字列  
長さの制限: 最大長は 1500 です。  
パターン: `\p{ASCII}{0,1500}` 

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

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

 ** InvalidNextTokenException **   
トークンが無効です。  
HTTP ステータスコード: 400

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

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

# ListFilters
<a name="API_ListFilters"></a>

特定のデータセットグループに属するすべてのフィルターを一覧表示します。

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

```
{
   "datasetGroupArn": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

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

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

 ** [datasetGroupArn](#API_ListFilters_RequestSyntax) **   <a name="personalize-ListFilters-request-datasetGroupArn"></a>
フィルターを含むデータセットグループの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** [maxResults](#API_ListFilters_RequestSyntax) **   <a name="personalize-ListFilters-request-maxResults"></a>
返されるフィルターの最大数。  
タイプ: 整数  
有効範囲: 最小値 は 1 です。最大値は 100 です。  
必須: いいえ

 ** [nextToken](#API_ListFilters_RequestSyntax) **   <a name="personalize-ListFilters-request-nextToken"></a>
フィルターの次のセットを取得するために、前の `ListFilters` に対する呼び出しから返されたトークン (存在する場合)。  
タイプ: 文字列  
長さの制限: 最大長は 1500 です。  
パターン: `\p{ASCII}{0,1500}`   
必須: いいえ

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

```
{
   "Filters": [ 
      { 
         "creationDateTime": number,
         "datasetGroupArn": "string",
         "failureReason": "string",
         "filterArn": "string",
         "lastUpdatedDateTime": number,
         "name": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

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

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

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

 ** [Filters](#API_ListFilters_ResponseSyntax) **   <a name="personalize-ListFilters-response-Filters"></a>
返されたフィルターのリスト。  
型: [FilterSummary](API_FilterSummary.md) オブジェクトの配列  
配列メンバー: 最大数は 100 項目です。

 ** [nextToken](#API_ListFilters_ResponseSyntax) **   <a name="personalize-ListFilters-response-nextToken"></a>
フィルターの次のセットを取得するためのトークン (存在する場合)。  
タイプ: 文字列  
長さの制限: 最大長は 1500 です。  
パターン: `\p{ASCII}{0,1500}` 

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

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

 ** InvalidNextTokenException **   
トークンが無効です。  
HTTP ステータスコード: 400

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

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

# ListMetricAttributionMetrics
<a name="API_ListMetricAttributionMetrics"></a>

メトリクス属性のメトリクスを一覧表示します。

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

```
{
   "maxResults": number,
   "metricAttributionArn": "string",
   "nextToken": "string"
}
```

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

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

 ** [maxResults](#API_ListMetricAttributionMetrics_RequestSyntax) **   <a name="personalize-ListMetricAttributionMetrics-request-maxResults"></a>
結果の 1 ページで返されるメトリクスの最大数。  
タイプ: 整数  
有効範囲: 最小値 は 1 です。最大値は 100 です。  
必須: いいえ

 ** [metricAttributionArn](#API_ListMetricAttributionMetrics_RequestSyntax) **   <a name="personalize-ListMetricAttributionMetrics-request-metricAttributionArn"></a>
属性を取得するメトリクス属性の Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** [nextToken](#API_ListMetricAttributionMetrics_RequestSyntax) **   <a name="personalize-ListMetricAttributionMetrics-request-nextToken"></a>
次のページの結果を取得する以前のリクエストによって返される、ページ分割トークンを指定します。  
タイプ: 文字列  
長さの制限: 最大長は 1500 です。  
パターン: `\p{ASCII}{0,1500}`   
必須: いいえ

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

```
{
   "metrics": [ 
      { 
         "eventType": "string",
         "expression": "string",
         "metricName": "string"
      }
   ],
   "nextToken": "string"
}
```

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

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

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

 ** [metrics](#API_ListMetricAttributionMetrics_ResponseSyntax) **   <a name="personalize-ListMetricAttributionMetrics-response-metrics"></a>
指定されたメトリクス属性のメトリクス。  
型: [MetricAttribute](API_MetricAttribute.md) オブジェクトの配列  
配列メンバー: 最大数は 10 項目です。

 ** [nextToken](#API_ListMetricAttributionMetrics_ResponseSyntax) **   <a name="personalize-ListMetricAttributionMetrics-response-nextToken"></a>
次のページの結果を取得する以前の `ListMetricAttributionMetricsResponse` リクエストによって返される、ページ分割トークンを指定します。  
タイプ: 文字列  
長さの制限: 最大長は 1500 です。  
パターン: `\p{ASCII}{0,1500}` 

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

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

 ** InvalidNextTokenException **   
トークンが無効です。  
HTTP ステータスコード: 400

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

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

# ListMetricAttributions
<a name="API_ListMetricAttributions"></a>

メトリクス属性を一覧表示します。

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

```
{
   "datasetGroupArn": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

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

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

 ** [datasetGroupArn](#API_ListMetricAttributions_RequestSyntax) **   <a name="personalize-ListMetricAttributions-request-datasetGroupArn"></a>
メトリクス属性のデータセットグループ Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** [maxResults](#API_ListMetricAttributions_RequestSyntax) **   <a name="personalize-ListMetricAttributions-request-maxResults"></a>
結果の 1 ページで返されるメトリクス属性の最大数です。  
タイプ: 整数  
有効範囲: 最小値 は 1 です。最大値は 100 です。  
必須: いいえ

 ** [nextToken](#API_ListMetricAttributions_RequestSyntax) **   <a name="personalize-ListMetricAttributions-request-nextToken"></a>
次のページの結果を取得する以前のリクエストによって返される、ページ分割トークンを指定します。  
タイプ: 文字列  
長さの制限: 最大長は 1500 です。  
パターン: `\p{ASCII}{0,1500}`   
必須: いいえ

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

```
{
   "metricAttributions": [ 
      { 
         "creationDateTime": number,
         "failureReason": "string",
         "lastUpdatedDateTime": number,
         "metricAttributionArn": "string",
         "name": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

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

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

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

 ** [metricAttributions](#API_ListMetricAttributions_ResponseSyntax) **   <a name="personalize-ListMetricAttributions-response-metricAttributions"></a>
メトリクス属性のリスト。  
型: [MetricAttributionSummary](API_MetricAttributionSummary.md) オブジェクトの配列  
配列メンバー: 最大数は 100 項目です。

 ** [nextToken](#API_ListMetricAttributions_ResponseSyntax) **   <a name="personalize-ListMetricAttributions-response-nextToken"></a>
次のページの結果を取得する以前のリクエストによって返される、ページ分割トークンを指定します。  
タイプ: 文字列  
長さの制限: 最大長は 1500 です。  
パターン: `\p{ASCII}{0,1500}` 

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

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

 ** InvalidNextTokenException **   
トークンが無効です。  
HTTP ステータスコード: 400

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

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

# ListRecipes
<a name="API_ListRecipes"></a>

利用可能なレシピのリストを返します。レスポンスは、レシピの Amazon リソースネーム (ARN) など、各レシピのプロパティを提供します。

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

```
{
   "domain": "string",
   "maxResults": number,
   "nextToken": "string",
   "recipeProvider": "string"
}
```

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

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

 ** [domain](#API_ListRecipes_RequestSyntax) **   <a name="personalize-ListRecipes-request-domain"></a>
 ドメインデータセットグループのドメインごとに返されたレシピをフィルタリングします。このドメインのレシピ (ドメインデータセットグループのユースケース) のみがレスポンスに含まれます。ドメインを指定しない場合、すべてのレシピが返されます。  
型: 文字列  
有効な値：`ECOMMERCE | VIDEO_ON_DEMAND`  
必須：いいえ

 ** [maxResults](#API_ListRecipes_RequestSyntax) **   <a name="personalize-ListRecipes-request-maxResults"></a>
返されるレシピの最大数。  
タイプ: 整数  
有効範囲: 最小値 は 1 です。最大値は 100 です。  
必須: いいえ

 ** [nextToken](#API_ListRecipes_RequestSyntax) **   <a name="personalize-ListRecipes-request-nextToken"></a>
レシピの次のセットを取得するために、前の `ListRecipes` に対する呼び出しから返されたトークン (存在する場合)。  
タイプ: 文字列  
長さの制限: 最大長は 1500 です。  
パターン: `\p{ASCII}{0,1500}`   
必須: いいえ

 ** [recipeProvider](#API_ListRecipes_RequestSyntax) **   <a name="personalize-ListRecipes-request-recipeProvider"></a>
デフォルトは `SERVICE` です。  
型: 文字列  
有効な値：`SERVICE`  
必須：いいえ

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

```
{
   "nextToken": "string",
   "recipes": [ 
      { 
         "creationDateTime": number,
         "domain": "string",
         "lastUpdatedDateTime": number,
         "name": "string",
         "recipeArn": "string",
         "status": "string"
      }
   ]
}
```

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

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

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

 ** [nextToken](#API_ListRecipes_ResponseSyntax) **   <a name="personalize-ListRecipes-response-nextToken"></a>
次のレシピセットを取得するためのトークン。  
タイプ: 文字列  
長さの制限: 最大長は 1500 です。  
パターン: `\p{ASCII}{0,1500}` 

 ** [recipes](#API_ListRecipes_ResponseSyntax) **   <a name="personalize-ListRecipes-response-recipes"></a>
使用可能なレシピのリスト。  
型: [RecipeSummary](API_RecipeSummary.md) オブジェクトの配列  
配列メンバー: 最大数は 100 項目です。

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

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

 ** InvalidNextTokenException **   
トークンが無効です。  
HTTP ステータスコード: 400

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

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

# ListRecommenders
<a name="API_ListRecommenders"></a>

特定のドメインデータセットグループ内のレコメンダーのリストを返します。ドメインデータセットグループが指定されていない場合、アカウントに関連付けられているすべてのレコメンダーが一覧表示されます。レスポンスは、Amazon リソースネーム (ARN) など、各レコメンダーのプロパティを提供します。レコメンダーの詳細については、[CreateRecommender](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateRecommender.html) を参照してください。

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

```
{
   "datasetGroupArn": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

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

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

 ** [datasetGroupArn](#API_ListRecommenders_RequestSyntax) **   <a name="personalize-ListRecommenders-request-datasetGroupArn"></a>
レコメンダーを一覧表示するドメインデータセットグループの Amazon リソースネーム (ARN)。ドメインデータセットグループが指定されていない場合、アカウントに関連付けられているすべてのレコメンダーが一覧表示されます。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** [maxResults](#API_ListRecommenders_RequestSyntax) **   <a name="personalize-ListRecommenders-request-maxResults"></a>
返されるレコメンダーの最大数。  
タイプ: 整数  
有効範囲: 最小値 は 1 です。最大値は 100 です。  
必須: いいえ

 ** [nextToken](#API_ListRecommenders_RequestSyntax) **   <a name="personalize-ListRecommenders-request-nextToken"></a>
レコメンダーの次のセットを取得するために、前の `ListRecommenders` に対する呼び出しから返されたトークン (存在する場合)。  
タイプ: 文字列  
長さの制限: 最大長は 1500 です。  
パターン: `\p{ASCII}{0,1500}`   
必須: いいえ

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

```
{
   "nextToken": "string",
   "recommenders": [ 
      { 
         "creationDateTime": number,
         "datasetGroupArn": "string",
         "lastUpdatedDateTime": number,
         "name": "string",
         "recipeArn": "string",
         "recommenderArn": "string",
         "recommenderConfig": { 
            "enableMetadataWithRecommendations": boolean,
            "itemExplorationConfig": { 
               "string" : "string" 
            },
            "minRecommendationRequestsPerSecond": number,
            "trainingDataConfig": { 
               "excludedDatasetColumns": { 
                  "string" : [ "string" ]
               },
               "includedDatasetColumns": { 
                  "string" : [ "string" ]
               }
            }
         },
         "status": "string"
      }
   ]
}
```

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

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

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

 ** [nextToken](#API_ListRecommenders_ResponseSyntax) **   <a name="personalize-ListRecommenders-response-nextToken"></a>
レコメンダーの次のセットを取得するためのトークン (存在する場合)。  
タイプ: 文字列  
長さの制限: 最大長は 1500 です。  
パターン: `\p{ASCII}{0,1500}` 

 ** [recommenders](#API_ListRecommenders_ResponseSyntax) **   <a name="personalize-ListRecommenders-response-recommenders"></a>
レコメンダーのリスト。  
型: [RecommenderSummary](API_RecommenderSummary.md) オブジェクトの配列  
配列メンバー: 最大数は 100 項目です。

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

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

 ** InvalidNextTokenException **   
トークンが無効です。  
HTTP ステータスコード: 400

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

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

# ListSchemas
<a name="API_ListSchemas"></a>

アカウントに関連付けられているスキーマのリストを返します。レスポンスは、Amazon リソースネーム (ARN) など、各スキーマのプロパティを提供します。スキーマについての詳細は、「[CreateSchema](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html)」を参照してください。

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

```
{
   "maxResults": number,
   "nextToken": "string"
}
```

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

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

 ** [maxResults](#API_ListSchemas_RequestSyntax) **   <a name="personalize-ListSchemas-request-maxResults"></a>
返されるスキーマの最大数。  
タイプ: 整数  
有効範囲: 最小値 は 1 です。最大値は 100 です。  
必須: いいえ

 ** [nextToken](#API_ListSchemas_RequestSyntax) **   <a name="personalize-ListSchemas-request-nextToken"></a>
スキーマの次のセットを取得するために、前の `ListSchemas` に対する呼び出しから返されたトークン (存在する場合)。  
タイプ: 文字列  
長さの制限: 最大長は 1500 です。  
パターン: `\p{ASCII}{0,1500}`   
必須: いいえ

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

```
{
   "nextToken": "string",
   "schemas": [ 
      { 
         "creationDateTime": number,
         "domain": "string",
         "lastUpdatedDateTime": number,
         "name": "string",
         "schemaArn": "string"
      }
   ]
}
```

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

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

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

 ** [nextToken](#API_ListSchemas_ResponseSyntax) **   <a name="personalize-ListSchemas-response-nextToken"></a>
スキーマの次のセットを取得するために使用するトークン (存在する場合)。  
タイプ: 文字列  
長さの制限: 最大長は 1500 です。  
パターン: `\p{ASCII}{0,1500}` 

 ** [schemas](#API_ListSchemas_ResponseSyntax) **   <a name="personalize-ListSchemas-response-schemas"></a>
スキーマのリスト。  
型: [DatasetSchemaSummary](API_DatasetSchemaSummary.md) オブジェクトの配列  
配列メンバー: 最大数は 100 項目です。

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

 ** InvalidNextTokenException **   
トークンが無効です。  
HTTP ステータスコード: 400

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

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

# ListSolutions
<a name="API_ListSolutions"></a>

特定のデータセットグループのソリューションのリストを返します。データセットグループが指定されていない場合、アカウントに関連付けられているすべてのソリューションが一覧表示されます。レスポンスは、Amazon リソースネーム (ARN) など、各ソリューションのプロパティを提供します。詳細については、「[CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html)」を参照してください。

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

```
{
   "datasetGroupArn": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

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

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

 ** [datasetGroupArn](#API_ListSolutions_RequestSyntax) **   <a name="personalize-ListSolutions-request-datasetGroupArn"></a>
データセットグループの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** [maxResults](#API_ListSolutions_RequestSyntax) **   <a name="personalize-ListSolutions-request-maxResults"></a>
返されるソリューションの最大数。  
タイプ: 整数  
有効範囲: 最小値 は 1 です。最大値は 100 です。  
必須: いいえ

 ** [nextToken](#API_ListSolutions_RequestSyntax) **   <a name="personalize-ListSolutions-request-nextToken"></a>
ソリューションの次のセットを取得するために、前の `ListSolutions` に対する呼び出しから返されたトークン (存在する場合)。  
タイプ: 文字列  
長さの制限: 最大長は 1500 です。  
パターン: `\p{ASCII}{0,1500}`   
必須: いいえ

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

```
{
   "nextToken": "string",
   "solutions": [ 
      { 
         "creationDateTime": number,
         "lastUpdatedDateTime": number,
         "name": "string",
         "recipeArn": "string",
         "solutionArn": "string",
         "status": "string"
      }
   ]
}
```

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

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

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

 ** [nextToken](#API_ListSolutions_ResponseSyntax) **   <a name="personalize-ListSolutions-response-nextToken"></a>
ソリューションの次のセットを取得するためのトークン (存在する場合)。  
タイプ: 文字列  
長さの制限: 最大長は 1500 です。  
パターン: `\p{ASCII}{0,1500}` 

 ** [solutions](#API_ListSolutions_ResponseSyntax) **   <a name="personalize-ListSolutions-response-solutions"></a>
現在のソリューションのリスト。  
型: [SolutionSummary](API_SolutionSummary.md) オブジェクトの配列  
配列メンバー: 最大数は 100 項目です。

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

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

 ** InvalidNextTokenException **   
トークンが無効です。  
HTTP ステータスコード: 400

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

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

# ListSolutionVersions
<a name="API_ListSolutionVersions"></a>

特定のソリューションのソリューションバージョンのリストを返します。ソリューションが指定されていない場合、アカウントに関連付けられているすべてのソリューションバージョンが一覧表示されます。レスポンスは、Amazon リソースネーム (ARN) など、各ソリューションバージョンのプロパティを提供します。

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

```
{
   "maxResults": number,
   "nextToken": "string",
   "solutionArn": "string"
}
```

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

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

 ** [maxResults](#API_ListSolutionVersions_RequestSyntax) **   <a name="personalize-ListSolutionVersions-request-maxResults"></a>
返されるソリューションバージョンの最大数。  
タイプ: 整数  
有効範囲: 最小値 は 1 です。最大値は 100 です。  
必須: いいえ

 ** [nextToken](#API_ListSolutionVersions_RequestSyntax) **   <a name="personalize-ListSolutionVersions-request-nextToken"></a>
ソリューションバージョンの次のセットを取得するために、前の `ListSolutionVersions` に対する呼び出しから返されたトークン (存在する場合)。  
タイプ: 文字列  
長さの制限: 最大長は 1500 です。  
パターン: `\p{ASCII}{0,1500}`   
必須: いいえ

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

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

```
{
   "nextToken": "string",
   "solutionVersions": [ 
      { 
         "creationDateTime": number,
         "failureReason": "string",
         "lastUpdatedDateTime": number,
         "solutionVersionArn": "string",
         "status": "string",
         "trainingMode": "string",
         "trainingType": "string"
      }
   ]
}
```

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

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

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

 ** [nextToken](#API_ListSolutionVersions_ResponseSyntax) **   <a name="personalize-ListSolutionVersions-response-nextToken"></a>
ソリューションバージョンの次のセットを取得するためのトークン (存在する場合)。  
タイプ: 文字列  
長さの制限: 最大長は 1500 です。  
パターン: `\p{ASCII}{0,1500}` 

 ** [solutionVersions](#API_ListSolutionVersions_ResponseSyntax) **   <a name="personalize-ListSolutionVersions-response-solutionVersions"></a>
バージョンのプロパティを記述するソリューションバージョンのリスト。  
型: [SolutionVersionSummary](API_SolutionVersionSummary.md) オブジェクトの配列  
配列メンバー: 最大数は 100 項目です。

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

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

 ** InvalidNextTokenException **   
トークンが無効です。  
HTTP ステータスコード: 400

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

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

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

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

リソースに添付されている[タグ](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)のリストを取得します。

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

```
{
   "resourceArn": "string"
}
```

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

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

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

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

```
{
   "tags": [ 
      { 
         "tagKey": "string",
         "tagValue": "string"
      }
   ]
}
```

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

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

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

 ** [tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="personalize-ListTagsForResource-response-tags"></a>
リソースのタグ。  
型: [Tag](API_Tag.md) オブジェクトの配列  
配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。

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

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

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

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

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

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

# StartRecommender
<a name="API_StartRecommender"></a>

非アクティブなレコメンダーを起動します。レコメンダーを起動しても新しいモデルは作成されませんが、レコメンダーへの請求と自動再トレーニングが再開されます。

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

```
{
   "recommenderArn": "string"
}
```

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

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

 ** [recommenderArn](#API_StartRecommender_RequestSyntax) **   <a name="personalize-StartRecommender-request-recommenderArn"></a>
起動するレコメンダーの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

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

```
{
   "recommenderArn": "string"
}
```

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

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

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

 ** [recommenderArn](#API_StartRecommender_ResponseSyntax) **   <a name="personalize-StartRecommender-response-recommenderArn"></a>
起動したレコメンダーの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

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

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

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

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

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

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

# StopRecommender
<a name="API_StopRecommender"></a>

アクティブなレコメンダーを停止します。レコメンダーを停止すると、レコメンダーへの請求と自動再トレーニングが停止します。

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

```
{
   "recommenderArn": "string"
}
```

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

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

 ** [recommenderArn](#API_StopRecommender_RequestSyntax) **   <a name="personalize-StopRecommender-request-recommenderArn"></a>
停止するレコメンダーの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

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

```
{
   "recommenderArn": "string"
}
```

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

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

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

 ** [recommenderArn](#API_StopRecommender_ResponseSyntax) **   <a name="personalize-StopRecommender-response-recommenderArn"></a>
停止したレコメンダーの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

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

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

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

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

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

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

# StopSolutionVersionCreation
<a name="API_StopSolutionVersionCreation"></a>

CREATE\$1PENDING または CREATE IN\$1PROGRESS の状態にあるソリューションバージョンの作成を停止します。

ソリューションバージョンの現在の状態に応じて、ソリューションバージョンの状態は次のように変化します。
+ CREATE\$1PENDING > CREATE\$1STOPPED

  または
+ CREATE\$1IN\$1PROGRESS > CREATE\$1STOPPING > CREATE\$1STOPPED

ソリューションバージョンの作成を停止するまでに完了したすべてのトレーニングについて請求されます。停止したソリューションバージョンの作成を再開することはできません。

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

```
{
   "solutionVersionArn": "string"
}
```

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

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

 ** [solutionVersionArn](#API_StopSolutionVersionCreation_RequestSyntax) **   <a name="personalize-StopSolutionVersionCreation-request-solutionVersionArn"></a>
作成を停止するソリューションバージョンの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

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

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

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

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

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

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

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

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

# TagResource
<a name="API_TagResource"></a>

リソースにタグのリストを追加します。

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

```
{
   "resourceArn": "string",
   "tags": [ 
      { 
         "tagKey": "string",
         "tagValue": "string"
      }
   ]
}
```

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

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

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

 ** [tags](#API_TagResource_RequestSyntax) **   <a name="personalize-TagResource-request-tags"></a>
リソースに適用するタグ。詳細については、「[Amazon Personalize のリソースにタグ付けする](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)」を参照してください。  
型: [Tag](API_Tag.md) オブジェクトの配列  
配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。  
必須: はい

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

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

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

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

 ** LimitExceededException **   
1 秒あたりのリクエスト数の上限を超えています。  
HTTP ステータスコード: 400

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

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

 ** TooManyTagsException **   
このリソースに適用できるタグの最大数を超過しています。  
HTTP ステータスコード: 400

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

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

# UntagResource
<a name="API_UntagResource"></a>

リソースにアタッチされている指定したタグを削除します。詳細については、「[Amazon Personalize リソースからタグを削除する](https://docs.aws.amazon.com/personalize/latest/dg/tags-remove.html)」を参照してください。

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

```
{
   "resourceArn": "string",
   "tagKeys": [ "string" ]
}
```

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

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

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

 ** [tagKeys](#API_UntagResource_RequestSyntax) **   <a name="personalize-UntagResource-request-tagKeys"></a>
削除するタグのキー。  
型: 文字列の配列  
配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。  
長さの制限：最小長 1、最大長は 128 です。  
パターン: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
必須: はい

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

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

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

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

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

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

 ** TooManyTagKeysException **   
リクエストには、リソースに関連付けることができる数よりも多くのタグキーが含まれています (リソースごとに 50 個のタグキー)。  
HTTP ステータスコード: 400

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

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

# 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) 

# UpdateDataset
<a name="API_UpdateDataset"></a>

データセットを更新して、そのスキーマを新しいスキーマまたは既存のスキーマに置き換えます。詳細については、「[データセットのスキーマの置き換え](https://docs.aws.amazon.com/personalize/latest/dg/updating-dataset-schema.html)」を参照してください。

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

```
{
   "datasetArn": "string",
   "schemaArn": "string"
}
```

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

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

 ** [datasetArn](#API_UpdateDataset_RequestSyntax) **   <a name="personalize-UpdateDataset-request-datasetArn"></a>
更新するデータセットの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

 ** [schemaArn](#API_UpdateDataset_RequestSyntax) **   <a name="personalize-UpdateDataset-request-schemaArn"></a>
使用するデータセットのAmazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

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

```
{
   "datasetArn": "string"
}
```

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

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

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

 ** [datasetArn](#API_UpdateDataset_ResponseSyntax) **   <a name="personalize-UpdateDataset-response-datasetArn"></a>
更新したデータセットの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

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

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

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

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

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

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

# UpdateMetricAttribution
<a name="API_UpdateMetricAttribution"></a>

メトリクス属性を更新します。

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

```
{
   "addMetrics": [ 
      { 
         "eventType": "string",
         "expression": "string",
         "metricName": "string"
      }
   ],
   "metricAttributionArn": "string",
   "metricsOutputConfig": { 
      "roleArn": "string",
      "s3DataDestination": { 
         "kmsKeyArn": "string",
         "path": "string"
      }
   },
   "removeMetrics": [ "string" ]
}
```

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

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

 ** [addMetrics](#API_UpdateMetricAttribution_RequestSyntax) **   <a name="personalize-UpdateMetricAttribution-request-addMetrics"></a>
メトリクス属性に新しいメトリック属性を追加します。  
型: [MetricAttribute](API_MetricAttribute.md) オブジェクトの配列  
配列メンバー: 最大数は 10 項目です。  
必須: いいえ

 ** [metricAttributionArn](#API_UpdateMetricAttribution_RequestSyntax) **   <a name="personalize-UpdateMetricAttribution-request-metricAttributionArn"></a>
更新するメトリクス属性の Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** [metricsOutputConfig](#API_UpdateMetricAttribution_RequestSyntax) **   <a name="personalize-UpdateMetricAttribution-request-metricsOutputConfig"></a>
メトリクス属性の出力設定。  
型: [MetricAttributionOutput](API_MetricAttributionOutput.md) オブジェクト  
必須: いいえ

 ** [removeMetrics](#API_UpdateMetricAttribution_RequestSyntax) **   <a name="personalize-UpdateMetricAttribution-request-removeMetrics"></a>
メトリクス属性からメトリクス属性を削除します。  
型: 文字列の配列  
配列メンバー: 最大数は 10 項目です。  
長さの制約: 最大長は 256 です。  
必須: いいえ

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

```
{
   "metricAttributionArn": "string"
}
```

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

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [metricAttributionArn](#API_UpdateMetricAttribution_ResponseSyntax) **   <a name="personalize-UpdateMetricAttribution-response-metricAttributionArn"></a>
更新するメトリクス属性の Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

## エラー
<a name="API_UpdateMetricAttribution_Errors"></a>

 ** InvalidInputException **   
フィールドまたはパラメータに有効な値を指定します。  
HTTP ステータスコード: 400

 ** ResourceAlreadyExistsException **   
指定したリソースはすでに存在しています。  
HTTP ステータスコード: 400

 ** ResourceInUseException **   
指定されたリソースは使用中です。  
HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
指定されたリソースが見つかりませんでした。  
HTTP ステータスコード: 400

## 以下の資料も参照してください。
<a name="API_UpdateMetricAttribution_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/UpdateMetricAttribution) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/UpdateMetricAttribution) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/UpdateMetricAttribution) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/UpdateMetricAttribution) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/UpdateMetricAttribution) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/UpdateMetricAttribution) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/UpdateMetricAttribution) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/UpdateMetricAttribution) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/UpdateMetricAttribution) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/UpdateMetricAttribution) 

# UpdateRecommender
<a name="API_UpdateRecommender"></a>

レコメンダーを更新して、レコメンダーの設定を変更します。レコメンダーを更新してトレーニングに使用した列を変更すると、Amazon Personalize はレコメンダーを裏付けるモデルの完全な再トレーニングを自動的に開始します。更新が完了しても、レコメンダーからレコメンデーションを取得できます。レコメンダーは、更新が完了するまで以前の設定を使用します。この更新のステータスを追跡するには、[DescribeRecommender ](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html) オペレーションで返された `latestRecommenderUpdate` を使用します。

## リクエストの構文
<a name="API_UpdateRecommender_RequestSyntax"></a>

```
{
   "recommenderArn": "string",
   "recommenderConfig": { 
      "enableMetadataWithRecommendations": boolean,
      "itemExplorationConfig": { 
         "string" : "string" 
      },
      "minRecommendationRequestsPerSecond": number,
      "trainingDataConfig": { 
         "excludedDatasetColumns": { 
            "string" : [ "string" ]
         },
         "includedDatasetColumns": { 
            "string" : [ "string" ]
         }
      }
   }
}
```

## リクエストパラメーター
<a name="API_UpdateRecommender_RequestParameters"></a>

リクエストは以下のデータを JSON 形式で受け入れます。

 ** [recommenderArn](#API_UpdateRecommender_RequestSyntax) **   <a name="personalize-UpdateRecommender-request-recommenderArn"></a>
変更するレコメンダーの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

 ** [recommenderConfig](#API_UpdateRecommender_RequestSyntax) **   <a name="personalize-UpdateRecommender-request-recommenderConfig"></a>
レコメンダーの設定の詳細。  
型: [RecommenderConfig](API_RecommenderConfig.md) オブジェクト  
必須: はい

## レスポンスの構文
<a name="API_UpdateRecommender_ResponseSyntax"></a>

```
{
   "recommenderArn": "string"
}
```

## レスポンス要素
<a name="API_UpdateRecommender_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [recommenderArn](#API_UpdateRecommender_ResponseSyntax) **   <a name="personalize-UpdateRecommender-response-recommenderArn"></a>
リクエストで指定されたものと同じレコメンダー Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

## エラー
<a name="API_UpdateRecommender_Errors"></a>

 ** InvalidInputException **   
フィールドまたはパラメータに有効な値を指定します。  
HTTP ステータスコード: 400

 ** ResourceInUseException **   
指定されたリソースは使用中です。  
HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
指定されたリソースが見つかりませんでした。  
HTTP ステータスコード: 400

## 以下の資料も参照してください。
<a name="API_UpdateRecommender_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/UpdateRecommender) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/UpdateRecommender) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/UpdateRecommender) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/UpdateRecommender) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/UpdateRecommender) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/UpdateRecommender) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/UpdateRecommender) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/UpdateRecommender) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/UpdateRecommender) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/UpdateRecommender) 

# UpdateSolution
<a name="API_UpdateSolution"></a>

Amazon Personalize ソリューションを更新して、別の自動トレーニング設定を使用します。ソリューションを更新するときに、ソリューションが自動トレーニングを使用するかどうかを変更したり、トレーニング頻度を変更したりできます。ソリューションの更新の詳細については、「[ソリューションの更新](https://docs.aws.amazon.com/personalize/latest/dg/updating-solution.html)」を参照してください。

ソリューションの更新は、次に示す状態のいずれかになります。

CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -または- CREATE FAILED

ソリューションの更新のステータスを取得するには、[DescribeSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html) API オペレーションを呼び出し、`latestSolutionUpdate` でステータスを確認します。

## リクエストの構文
<a name="API_UpdateSolution_RequestSyntax"></a>

```
{
   "performAutoTraining": boolean,
   "performIncrementalUpdate": boolean,
   "solutionArn": "string",
   "solutionUpdateConfig": { 
      "autoTrainingConfig": { 
         "schedulingExpression": "string"
      },
      "eventsConfig": { 
         "eventParametersList": [ 
            { 
               "eventType": "string",
               "eventValueThreshold": number,
               "weight": number
            }
         ]
      }
   }
}
```

## リクエストパラメーター
<a name="API_UpdateSolution_RequestParameters"></a>

リクエストは以下のデータを JSON 形式で受け入れます。

 ** [performAutoTraining](#API_UpdateSolution_RequestSyntax) **   <a name="personalize-UpdateSolution-request-performAutoTraining"></a>
ソリューションが自動トレーニングを使用して新しいソリューションバージョン (トレーニング済みモデル) を作成するかどうか。ソリューション設定の一部として `AutoTrainingConfig` で `schedulingExpression` を指定することで、トレーニング頻度を変更できます。  
 自動トレーニングを有効にすると、ソリューションの更新が完了してから 1 時間以内に最初の自動トレーニングが開始されます。1 時間以内にソリューションバージョンを手動で作成した場合、ソリューションは最初の自動トレーニングをスキップします。自動トレーニングの詳細については、「[自動トレーニングの設定](https://docs.aws.amazon.com/personalize/latest/dg/solution-config-auto-training.html)」を参照してください。  
 トレーニングが開始されると、[ListSolutionVersions](https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html) API オペレーションを使用してソリューションバージョンの Amazon リソースネーム (ARN) を取得できます。ステータスを取得するには、[DescribeSolutionVersion](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html) を使用します。  
タイプ: ブール値  
必須: いいえ

 ** [performIncrementalUpdate](#API_UpdateSolution_RequestSyntax) **   <a name="personalize-UpdateSolution-request-performIncrementalUpdate"></a>
モデルで増分トレーニング更新を実行するかどうか。これにより、モデルは完全な再トレーニングを必要とせずに新しいデータからより頻繁に学習できるため、ほぼリアルタイムのパーソナライゼーションが可能になります。このパラメータは、セマンティック類似度レシピを使用するソリューションでのみサポートされます。  
タイプ: ブール値  
必須: いいえ

 ** [solutionArn](#API_UpdateSolution_RequestSyntax) **   <a name="personalize-UpdateSolution-request-solutionArn"></a>
更新するソリューションの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

 ** [solutionUpdateConfig](#API_UpdateSolution_RequestSyntax) **   <a name="personalize-UpdateSolution-request-solutionUpdateConfig"></a>
ソリューションの新しい設定の詳細。  
型: [SolutionUpdateConfig](API_SolutionUpdateConfig.md) オブジェクト  
必須: いいえ

## レスポンスの構文
<a name="API_UpdateSolution_ResponseSyntax"></a>

```
{
   "solutionArn": "string"
}
```

## レスポンス要素
<a name="API_UpdateSolution_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [solutionArn](#API_UpdateSolution_ResponseSyntax) **   <a name="personalize-UpdateSolution-response-solutionArn"></a>
リクエストで指定されたものと同じソリューション Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+` 

## エラー
<a name="API_UpdateSolution_Errors"></a>

 ** InvalidInputException **   
フィールドまたはパラメータに有効な値を指定します。  
HTTP ステータスコード: 400

 ** LimitExceededException **   
1 秒あたりのリクエスト数の上限を超えています。  
HTTP ステータスコード: 400

 ** ResourceInUseException **   
指定されたリソースは使用中です。  
HTTP ステータスコード: 400

 ** ResourceInUseException **   
指定されたリソースは使用中です。  
HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
指定されたリソースが見つかりませんでした。  
HTTP ステータスコード: 400

## 以下の資料も参照してください。
<a name="API_UpdateSolution_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/UpdateSolution) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/UpdateSolution) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/UpdateSolution) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/UpdateSolution) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/UpdateSolution) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/UpdateSolution) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/UpdateSolution) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/UpdateSolution) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/UpdateSolution) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/UpdateSolution) 

# Amazon Personalize Events
<a name="API_Operations_Amazon_Personalize_Events"></a>

次のアクションは、Amazon Personalize Events でサポートされています。
+  [PutActionInteractions](API_UBS_PutActionInteractions.md) 
+  [PutActions](API_UBS_PutActions.md) 
+  [PutEvents](API_UBS_PutEvents.md) 
+  [PutItems](API_UBS_PutItems.md) 
+  [PutUsers](API_UBS_PutUsers.md) 

# PutActionInteractions
<a name="API_UBS_PutActionInteractions"></a>

アクションインタラクションのイベントデータを記録します。アクションインタラクションイベントは、ユーザーとアクションの間のインタラクションです。****例えば、ユーザーがメンバーシッププログラムへの登録やアプリのダウンロードなどのアクションを実行する場合です。

 アクションインタラクションの記録の詳細については、「[アクションインタラクションイベントの記録](https://docs.aws.amazon.com/personalize/latest/dg/recording-action-interaction-events.html)」を参照してください。アクションデータセット内のアクションの詳細については、「[Actions dataset](https://docs.aws.amazon.com/personalize/latest/dg/actions-datasets.html)」を参照してください。

## リクエストの構文
<a name="API_UBS_PutActionInteractions_RequestSyntax"></a>

```
POST /action-interactions HTTP/1.1
Content-type: application/json

{
   "actionInteractions": [ 
      { 
         "actionId": "string",
         "eventId": "string",
         "eventType": "string",
         "impression": [ "string" ],
         "properties": "string",
         "recommendationId": "string",
         "sessionId": "string",
         "timestamp": number,
         "userId": "string"
      }
   ],
   "trackingId": "string"
}
```

## URI リクエストパラメータ
<a name="API_UBS_PutActionInteractions_RequestParameters"></a>

リクエストでは URI パラメータを使用しません。

## リクエストボディ
<a name="API_UBS_PutActionInteractions_RequestBody"></a>

リクエストは以下の JSON 形式のデータを受け入れます。

 ** [actionInteractions](#API_UBS_PutActionInteractions_RequestSyntax) **   <a name="personalize-UBS_PutActionInteractions-request-actionInteractions"></a>
セッションからのアクションインタラクションのイベントのリスト。  
型: [ActionInteraction](API_UBS_ActionInteraction.md) オブジェクトの配列  
配列メンバー: 最小数は 1 項目です。最大数は 10 項目です。  
必須: はい

 ** [trackingId](#API_UBS_PutActionInteractions_RequestSyntax) **   <a name="personalize-UBS_PutActionInteractions-request-trackingId"></a>
アクションインタラクションイベントトラッカーの ID。Action インタラクションデータセットを作成すると、Amazon Personalize は自動的にアクションインタラクションイベントトラッカーを作成します。詳細については、「[Action interaction event tracker ID](https://docs.aws.amazon.com/personalize/latest/dg/action-interaction-tracker-id.html)」を参照してください。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 256 です。  
必須: はい

## レスポンスの構文
<a name="API_UBS_PutActionInteractions_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## レスポンス要素
<a name="API_UBS_PutActionInteractions_ResponseElements"></a>

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

## エラー
<a name="API_UBS_PutActionInteractions_Errors"></a>

 ** InvalidInputException **   
フィールドまたはパラメータに有効な値を指定します。  
HTTP ステータスコード: 400

 ** ResourceInUseException **   
指定されたリソースは使用中です。  
HTTP ステータスコード: 409

 ** ResourceNotFoundException **   
指定されたリソースが見つかりませんでした。  
HTTP ステータスコード: 404

## 以下の資料も参照してください。
<a name="API_UBS_PutActionInteractions_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/personalize-events-2018-03-22/PutActionInteractions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-events-2018-03-22/PutActionInteractions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/PutActionInteractions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-events-2018-03-22/PutActionInteractions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/PutActionInteractions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-events-2018-03-22/PutActionInteractions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-events-2018-03-22/PutActionInteractions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-events-2018-03-22/PutActionInteractions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-events-2018-03-22/PutActionInteractions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/PutActionInteractions) 

# PutActions
<a name="API_UBS_PutActions"></a>

1 つ以上のアクションを Actions データセットに追加します。詳細については、「[Importing actions individually](https://docs.aws.amazon.com/personalize/latest/dg/importing-actions.html)」を参照してください。

## リクエストの構文
<a name="API_UBS_PutActions_RequestSyntax"></a>

```
POST /actions HTTP/1.1
Content-type: application/json

{
   "actions": [ 
      { 
         "actionId": "string",
         "properties": "string"
      }
   ],
   "datasetArn": "string"
}
```

## URI リクエストパラメータ
<a name="API_UBS_PutActions_RequestParameters"></a>

リクエストでは URI パラメータを使用しません。

## リクエストボディ
<a name="API_UBS_PutActions_RequestBody"></a>

リクエストは以下の JSON 形式のデータを受け入れます。

 ** [actions](#API_UBS_PutActions_RequestSyntax) **   <a name="personalize-UBS_PutActions-request-actions"></a>
アクションデータのリスト。  
型: [Action](API_UBS_Action.md) オブジェクトの配列  
配列メンバー: 最小数は 1 項目です。最大数は 10 項目です。  
必須: はい

 ** [datasetArn](#API_UBS_PutActions_RequestSyntax) **   <a name="personalize-UBS_PutActions-request-datasetArn"></a>
1 つまたは複数のアクションを追加する Actions データセットの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

## レスポンスの構文
<a name="API_UBS_PutActions_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## レスポンス要素
<a name="API_UBS_PutActions_ResponseElements"></a>

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

## エラー
<a name="API_UBS_PutActions_Errors"></a>

 ** InvalidInputException **   
フィールドまたはパラメータに有効な値を指定します。  
HTTP ステータスコード: 400

 ** ResourceInUseException **   
指定されたリソースは使用中です。  
HTTP ステータスコード: 409

 ** ResourceNotFoundException **   
指定されたリソースが見つかりませんでした。  
HTTP ステータスコード: 404

## 以下の資料も参照してください。
<a name="API_UBS_PutActions_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/personalize-events-2018-03-22/PutActions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-events-2018-03-22/PutActions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/PutActions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-events-2018-03-22/PutActions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/PutActions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-events-2018-03-22/PutActions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-events-2018-03-22/PutActions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-events-2018-03-22/PutActions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-events-2018-03-22/PutActions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/PutActions) 

# PutEvents
<a name="API_UBS_PutEvents"></a>

アイテムインタラクションのイベントデータを記録します。詳細については、「[Recording item interaction events](https://docs.aws.amazon.com/personalize/latest/dg/recording-item-interaction-events.html)」を参照してください。

**注記**  
 AWS Lambda 関数を使用して PutEvents オペレーションを呼び出す場合、関数の実行ロールには、 `Resource`要素`*`のワイルドカードを使用して`personalize:PutEvents`アクションを実行するアクセス許可が必要です。

## リクエストの構文
<a name="API_UBS_PutEvents_RequestSyntax"></a>

```
POST /events HTTP/1.1
Content-type: application/json

{
   "eventList": [ 
      { 
         "eventId": "string",
         "eventType": "string",
         "eventValue": number,
         "impression": [ "string" ],
         "itemId": "string",
         "metricAttribution": { 
            "eventAttributionSource": "string"
         },
         "properties": "string",
         "recommendationId": "string",
         "sentAt": number
      }
   ],
   "sessionId": "string",
   "trackingId": "string",
   "userId": "string"
}
```

## URI リクエストパラメータ
<a name="API_UBS_PutEvents_RequestParameters"></a>

リクエストでは URI パラメータを使用しません。

## リクエストボディ
<a name="API_UBS_PutEvents_RequestBody"></a>

リクエストは以下の JSON 形式のデータを受け入れます。

 ** [eventList](#API_UBS_PutEvents_RequestSyntax) **   <a name="personalize-UBS_PutEvents-request-eventList"></a>
セッションからのイベントデータのリスト。  
型: [Event](API_UBS_Event.md) オブジェクトの配列  
配列メンバー: 最小数は 1 項目です。最大数は 10 項目です。  
必須: はい

 ** [sessionId](#API_UBS_PutEvents_RequestSyntax) **   <a name="personalize-UBS_PutEvents-request-sessionId"></a>
ユーザーの訪問に関連付けられたセッション ID。アプリケーションは、ユーザーが最初にウェブサイトにアクセスしたとき、またはアプリケーションを使用したときに、sessionId を生成します。Amazon Personalize は、sessionId を使用して、ユーザーがログインする前にイベントをユーザーに関連付けます。詳細については、「[Recording item interaction events](https://docs.aws.amazon.com/personalize/latest/dg/recording-item-interaction-events.html)」を参照してください。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 256 です。  
必須: はい

 ** [trackingId](#API_UBS_PutEvents_RequestSyntax) **   <a name="personalize-UBS_PutEvents-request-trackingId"></a>
イベントの追跡 ID。ID は、[CreateEventTracker](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html) API に対する呼び出しによって生成されます。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 256 です。  
必須: はい

 ** [userId](#API_UBS_PutEvents_RequestSyntax) **   <a name="personalize-UBS_PutEvents-request-userId"></a>
イベントに関連付けられているユーザー。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 256 です。  
必須: いいえ

## レスポンスの構文
<a name="API_UBS_PutEvents_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## レスポンス要素
<a name="API_UBS_PutEvents_ResponseElements"></a>

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

## エラー
<a name="API_UBS_PutEvents_Errors"></a>

 ** InvalidInputException **   
フィールドまたはパラメータに有効な値を指定します。  
HTTP ステータスコード: 400

## 以下の資料も参照してください。
<a name="API_UBS_PutEvents_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/personalize-events-2018-03-22/PutEvents) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-events-2018-03-22/PutEvents) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/PutEvents) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-events-2018-03-22/PutEvents) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/PutEvents) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-events-2018-03-22/PutEvents) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-events-2018-03-22/PutEvents) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-events-2018-03-22/PutEvents) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-events-2018-03-22/PutEvents) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/PutEvents) 

# PutItems
<a name="API_UBS_PutItems"></a>

1 つ以上のアイテムを Items データセットに追加します。詳細については、「[Importing items individually](https://docs.aws.amazon.com/personalize/latest/dg/importing-items.html)」を参照してください。

## リクエストの構文
<a name="API_UBS_PutItems_RequestSyntax"></a>

```
POST /items HTTP/1.1
Content-type: application/json

{
   "datasetArn": "string",
   "items": [ 
      { 
         "itemId": "string",
         "properties": "string"
      }
   ]
}
```

## URI リクエストパラメータ
<a name="API_UBS_PutItems_RequestParameters"></a>

リクエストでは URI パラメータを使用しません。

## リクエストボディ
<a name="API_UBS_PutItems_RequestBody"></a>

リクエストは以下の JSON 形式のデータを受け入れます。

 ** [datasetArn](#API_UBS_PutItems_RequestSyntax) **   <a name="personalize-UBS_PutItems-request-datasetArn"></a>
1 つまたは複数のアイテムを追加する Items データセットの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

 ** [items](#API_UBS_PutItems_RequestSyntax) **   <a name="personalize-UBS_PutItems-request-items"></a>
アイテムデータのリスト。  
型: [Item](API_UBS_Item.md) オブジェクトの配列  
配列メンバー: 最小数は 1 項目です。最大数は 10 項目です。  
必須: はい

## レスポンスの構文
<a name="API_UBS_PutItems_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## レスポンス要素
<a name="API_UBS_PutItems_ResponseElements"></a>

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

## エラー
<a name="API_UBS_PutItems_Errors"></a>

 ** InvalidInputException **   
フィールドまたはパラメータに有効な値を指定します。  
HTTP ステータスコード: 400

 ** ResourceInUseException **   
指定されたリソースは使用中です。  
HTTP ステータスコード: 409

 ** ResourceNotFoundException **   
指定されたリソースが見つかりませんでした。  
HTTP ステータスコード: 404

## 以下の資料も参照してください。
<a name="API_UBS_PutItems_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/personalize-events-2018-03-22/PutItems) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-events-2018-03-22/PutItems) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/PutItems) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-events-2018-03-22/PutItems) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/PutItems) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-events-2018-03-22/PutItems) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-events-2018-03-22/PutItems) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-events-2018-03-22/PutItems) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-events-2018-03-22/PutItems) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/PutItems) 

# PutUsers
<a name="API_UBS_PutUsers"></a>

1 名以上のユーザーを Users データセットに追加します。詳細については、「[Importing users individually](https://docs.aws.amazon.com/personalize/latest/dg/importing-users.html)」を参照してください。

## リクエストの構文
<a name="API_UBS_PutUsers_RequestSyntax"></a>

```
POST /users HTTP/1.1
Content-type: application/json

{
   "datasetArn": "string",
   "users": [ 
      { 
         "properties": "string",
         "userId": "string"
      }
   ]
}
```

## URI リクエストパラメータ
<a name="API_UBS_PutUsers_RequestParameters"></a>

リクエストでは URI パラメータを使用しません。

## リクエストボディ
<a name="API_UBS_PutUsers_RequestBody"></a>

リクエストは以下の JSON 形式のデータを受け入れます。

 ** [datasetArn](#API_UBS_PutUsers_RequestSyntax) **   <a name="personalize-UBS_PutUsers-request-datasetArn"></a>
1 名または複数のユーザーを追加する Users データセットの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

 ** [users](#API_UBS_PutUsers_RequestSyntax) **   <a name="personalize-UBS_PutUsers-request-users"></a>
ユーザーデータのリスト。  
型: [User](API_UBS_User.md) オブジェクトの配列  
配列メンバー: 最小数は 1 項目です。最大数は 10 項目です。  
必須: はい

## レスポンスの構文
<a name="API_UBS_PutUsers_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## レスポンス要素
<a name="API_UBS_PutUsers_ResponseElements"></a>

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

## エラー
<a name="API_UBS_PutUsers_Errors"></a>

 ** InvalidInputException **   
フィールドまたはパラメータに有効な値を指定します。  
HTTP ステータスコード: 400

 ** ResourceInUseException **   
指定されたリソースは使用中です。  
HTTP ステータスコード: 409

 ** ResourceNotFoundException **   
指定されたリソースが見つかりませんでした。  
HTTP ステータスコード: 404

## 以下の資料も参照してください。
<a name="API_UBS_PutUsers_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/personalize-events-2018-03-22/PutUsers) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-events-2018-03-22/PutUsers) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/PutUsers) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-events-2018-03-22/PutUsers) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/PutUsers) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-events-2018-03-22/PutUsers) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-events-2018-03-22/PutUsers) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-events-2018-03-22/PutUsers) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-events-2018-03-22/PutUsers) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/PutUsers) 

# Amazon Personalize Runtime
<a name="API_Operations_Amazon_Personalize_Runtime"></a>

次のアクションは、Amazon Personalize Runtime でサポートされています。
+  [GetActionRecommendations](API_RS_GetActionRecommendations.md) 
+  [GetPersonalizedRanking](API_RS_GetPersonalizedRanking.md) 
+  [GetRecommendations](API_RS_GetRecommendations.md) 

# GetActionRecommendations
<a name="API_RS_GetActionRecommendations"></a>

予測スコアで降順にソートされたレコメンデーションアクションのリストを返します。PERSONALIZED\$1ACTIONS レシピでトレーニングされたソリューションバージョンをデプロイするカスタムキャンペーンがある場合は、`GetActionRecommendations` API を使用してください。

PERSONALIZED\$1ACTIONS レシピの詳細については、「[PERSONALIZED\$1ACTIONS recipes](https://docs.aws.amazon.com/personalize/latest/dg/nexts-best-action-recipes.html)」を参照してください。アクションレコメンデーションの取得については、「[Getting action recommendations](https://docs.aws.amazon.com/personalize/latest/dg/get-action-recommendations.html)」を参照してください。

## リクエストの構文
<a name="API_RS_GetActionRecommendations_RequestSyntax"></a>

```
POST /action-recommendations HTTP/1.1
Content-type: application/json

{
   "campaignArn": "string",
   "filterArn": "string",
   "filterValues": { 
      "string" : "string" 
   },
   "numResults": number,
   "userId": "string"
}
```

## URI リクエストパラメータ
<a name="API_RS_GetActionRecommendations_RequestParameters"></a>

リクエストでは URI パラメータを使用しません。

## リクエストボディ
<a name="API_RS_GetActionRecommendations_RequestBody"></a>

リクエストは以下の JSON 形式のデータを受け入れます。

 ** [campaignArn](#API_RS_GetActionRecommendations_RequestSyntax) **   <a name="personalize-RS_GetActionRecommendations-request-campaignArn"></a>
アクションレコメンデーションの取得に使用するキャンペーンの Amazon リソースネーム (ARN)。このキャンペーンでは、PERSONALIZED\$1ACTIONS レシピでトレーニングされたソリューションバージョンをデプロイする必要があります。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** [filterArn](#API_RS_GetActionRecommendations_RequestSyntax) **   <a name="personalize-RS_GetActionRecommendations-request-filterArn"></a>
返されたレコメンデーションに適用するフィルターの ARN。詳細については、「[レコメンデーションのフィルタリング](https://docs.aws.amazon.com/personalize/latest/dg/filter.html)」を参照してください。  
このパラメータを使用するときは、フィルターのリソースが `ACTIVE` であることを確認してください。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** [filterValues](#API_RS_GetActionRecommendations_RequestSyntax) **   <a name="personalize-RS_GetActionRecommendations-request-filterValues"></a>
レコメンデーションをフィルタリングするときに使用する値。フィルター式の各プレースホルダーパラメータについて、(大文字と小文字が一致した状態で) パラメータ名をキーとして指定し、フィルター値を対応する値として指定します。1 つのパラメータの複数の値をコンマで区切ります。  
`INCLUDE` 要素を使用してアクションを含めるフィルター式について、式で定義されているすべてのパラメータの値を指定する必要があります。`EXCLUDE` 要素を使用してアクションを除外する式を含むフィルターについては、`filter-values` を省略できます。この場合、Amazon Personalize は、式のその部分を使用してレコメンデーションをフィルタリングしません。  
詳細については、「[レコメンデーションとユーザーセグメントのフィルタリング](https://docs.aws.amazon.com/personalize/latest/dg/filter.html)」を参照してください。  
タイプ: 文字列間のマッピング  
マップエントリ: アイテムの最大数は 25 です。  
キーの長さの制限: 最大長は 50 です。  
キーパターン: `[A-Za-z0-9_]+`   
値の長さの制限: 最大長は 1000 です。  
必須: いいえ

 ** [numResults](#API_RS_GetActionRecommendations_RequestSyntax) **   <a name="personalize-RS_GetActionRecommendations-request-numResults"></a>
返される結果の数。デフォルトは 5 です。最大は 100 です。  
タイプ: 整数  
値の範囲: 最小値 は 0 です。  
必須: いいえ

 ** [userId](#API_RS_GetActionRecommendations_RequestSyntax) **   <a name="personalize-RS_GetActionRecommendations-request-userId"></a>
アクションレコメンデーションを提供するユーザーのユーザー ID。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## レスポンスの構文
<a name="API_RS_GetActionRecommendations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "actionList": [ 
      { 
         "actionId": "string",
         "score": number
      }
   ],
   "recommendationId": "string"
}
```

## レスポンス要素
<a name="API_RS_GetActionRecommendations_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [actionList](#API_RS_GetActionRecommendations_ResponseSyntax) **   <a name="personalize-RS_GetActionRecommendations-response-actionList"></a>
予測スコアで降順にソートされたアクションレコメンデーションのリスト。リストには最大 100 個のアクションを含めることができます。アクションスコアの詳細については、「[How action recommendation scoring works](https://docs.aws.amazon.com/personalize/latest/dg/how-action-recommendation-scoring-works.html)」を参照してください。  
型: [PredictedAction](API_RS_PredictedAction.md) オブジェクトの配列

 ** [recommendationId](#API_RS_GetActionRecommendations_ResponseSyntax) **   <a name="personalize-RS_GetActionRecommendations-response-recommendationId"></a>
レコメンデーションの ID。  
タイプ: 文字列

## エラー
<a name="API_RS_GetActionRecommendations_Errors"></a>

 ** InvalidInputException **   
フィールドまたはパラメータに有効な値を指定します。  
HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
指定されたリソースは存在しません。  
HTTP ステータスコード: 404

## 以下の資料も参照してください。
<a name="API_RS_GetActionRecommendations_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-runtime-2018-05-22/GetActionRecommendations) 

# GetPersonalizedRanking
<a name="API_RS_GetPersonalizedRanking"></a>

特定のユーザーに推奨されるアイテムのリストを再ランク付けします。リストの最初のアイテムは、ユーザーが関心を持つ可能性が最も高いアイテムとみなされます。

**注記**  
キャンペーンにデプロイするソリューションが PERSONALIZED\$1RANKING タイプのレシピを使用して作成済みであることが必要です。

## リクエストの構文
<a name="API_RS_GetPersonalizedRanking_RequestSyntax"></a>

```
POST /personalize-ranking HTTP/1.1
Content-type: application/json

{
   "campaignArn": "string",
   "context": { 
      "string" : "string" 
   },
   "filterArn": "string",
   "filterValues": { 
      "string" : "string" 
   },
   "inputList": [ "string" ],
   "metadataColumns": { 
      "string" : [ "string" ]
   },
   "userId": "string"
}
```

## URI リクエストパラメータ
<a name="API_RS_GetPersonalizedRanking_RequestParameters"></a>

リクエストでは URI パラメータを使用しません。

## リクエストボディ
<a name="API_RS_GetPersonalizedRanking_RequestBody"></a>

リクエストは以下の JSON 形式のデータを受け入れます。

 ** [campaignArn](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-campaignArn"></a>
パーソナライズされたランキングの生成に使用するキャンペーンの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

 ** [context](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-context"></a>
レコメンデーションを取得するときに使用するコンテキストメタデータ。コンテキストメタデータには、ユーザーの現在の場所やデバイスタイプなど、ユーザーのレコメンデーションを取得するときに関連する可能性のあるインタラクション情報が含まれます。  
タイプ: 文字列から文字列へのマップ  
マップエントリ: アイテムの最大数は 150 です。  
キーの長さの制限: 最大長は 150 です。  
キーパターン: `[A-Za-z\d_]+`   
値の長さの制限: 最大長は 1000 です。  
必須: いいえ

 ** [filterArn](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-filterArn"></a>
特定のユーザーのレコメンデーションからアイテムを含めたり、アイテムを除外したりするために作成したフィルターの Amazon リソースネーム (ARN)。詳細については、「[レコメンデーションのフィルタリング](https://docs.aws.amazon.com/personalize/latest/dg/filter.html)」を参照してください。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** [filterValues](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-filterValues"></a>
レコメンデーションをフィルタリングするときに使用する値。フィルター式の各プレースホルダーパラメータについて、(大文字と小文字が一致した状態で) パラメータ名をキーとして指定し、フィルター値を対応する値として指定します。1 つのパラメータの複数の値をコンマで区切ります。  
`INCLUDE` 要素を使用してアイテムを含めるフィルター式について、式で定義されているすべてのパラメータの値を指定する必要があります。`EXCLUDE` 要素を使用してアイテムを除外する式を含むフィルターについては、`filter-values` を省略できます。この場合、Amazon Personalize は、レコメンデーションをフィルタリングするために式のその部分を使用しません。  
詳細については、「[レコメンデーションのフィルタリング](https://docs.aws.amazon.com/personalize/latest/dg/filter.html)」を参照してください。  
タイプ: 文字列間のマッピング  
マップエントリ: アイテムの最大数は 25 です。  
キーの長さの制限: 最大長は 50 です。  
キーパターン: `[A-Za-z0-9_]+`   
値の長さの制限: 最大長は 1000 です。  
必須: いいえ

 ** [inputList](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-inputList"></a>
ランク付けするアイテムのリスト (`itemId` による)。アイテムがトレーニングデータセットに含まれていなかった場合、そのアイテムは再ランク付けされたリストの最後に追加されます。レコメンデーションにメタデータを含める場合、最大数は 50 です。それ以外の場合、最大数は 500 です。  
型: 文字列の配列  
長さの制約: 最大長は 256 です。  
必須: はい

 ** [metadataColumns](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-metadataColumns"></a>
キャンペーンを作成または更新したときにレコメンデーションのメタデータを有効にした場合は、アイテムデータセットのメタデータ列を指定して、パーソナライズしたランキングに含めるようにします。マップキーは `ITEMS` で、値はアイテムデータセットの列名のリストです。指定できる列の最大数は 10 です。  
 キャンペーンのメタデータを有効にする方法については、「[Enabling metadata in recommendations for a campaign](https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-return-metadata)」を参照してください。  
タイプ: 文字列マップの配列への文字列  
マップエントリ: アイテムの最大数は 1 です。  
キーの長さの制限: 最大長は 256 です。  
配列メンバー: 最大数は 99 アイテムです。  
長さの制限: 最大長は 1,024 です。  
必須: いいえ

 ** [userId](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-userId"></a>
キャンペーンによるパーソナライズされたランキングの提供先とするユーザー。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: はい

## レスポンスの構文
<a name="API_RS_GetPersonalizedRanking_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "personalizedRanking": [ 
      { 
         "itemId": "string",
         "metadata": { 
            "string" : "string" 
         },
         "promotionName": "string",
         "reason": [ "string" ],
         "score": number
      }
   ],
   "recommendationId": "string"
}
```

## レスポンス要素
<a name="API_RS_GetPersonalizedRanking_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [personalizedRanking](#API_RS_GetPersonalizedRanking_ResponseSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-response-personalizedRanking"></a>
アイテムのリスト (ユーザーが関心を持つ可能性が最も高い順)。最大数は 500 です。  
型: [PredictedItem](API_RS_PredictedItem.md) オブジェクトの配列

 ** [recommendationId](#API_RS_GetPersonalizedRanking_ResponseSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-response-recommendationId"></a>
レコメンデーションの ID。  
タイプ: 文字列

## エラー
<a name="API_RS_GetPersonalizedRanking_Errors"></a>

 ** InvalidInputException **   
フィールドまたはパラメータに有効な値を指定します。  
HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
指定されたリソースは存在しません。  
HTTP ステータスコード: 404

## 以下の資料も参照してください。
<a name="API_RS_GetPersonalizedRanking_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-runtime-2018-05-22/GetPersonalizedRanking) 

# GetRecommendations
<a name="API_RS_GetRecommendations"></a>

推奨アイテムのリストを返します。キャンペーンについて、キャンペーンの Amazon リソースネーム (ARN) は必須であり、必要なユーザーとアイテムの入力は、キャンペーンをサポートするソリューションの作成に使用されたレシピタイプによって次のように異なります。
+ USER\$1PERSONALIZATION - `userId` 必須、`itemId` 未使用
+ RELATED\$1ITEMS - `itemId` 必須、`userId` 未使用

**注記**  
タイプ PERSONALIZED\$1RANKING のレシピを使用して作成されたソリューションにサポートされたキャンペーンは、[GetPersonalizedRanking](API_RS_GetPersonalizedRanking.md) API を使用します。

 レコメンダーの場合、レコメンダーの ARN が必要であり、必要なアイテムとユーザー入力は、レコメンダーをサポートするユースケース (ドメインベースのレシピ) によって異なります。ユースケースにおける要件の詳細については、「[レコメンダーのユースケースの選択](https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html)」を参照してください。

## リクエストの構文
<a name="API_RS_GetRecommendations_RequestSyntax"></a>

```
POST /recommendations HTTP/1.1
Content-type: application/json

{
   "campaignArn": "string",
   "context": { 
      "string" : "string" 
   },
   "filterArn": "string",
   "filterValues": { 
      "string" : "string" 
   },
   "itemId": "string",
   "metadataColumns": { 
      "string" : [ "string" ]
   },
   "numResults": number,
   "promotions": [ 
      { 
         "filterArn": "string",
         "filterValues": { 
            "string" : "string" 
         },
         "name": "string",
         "percentPromotedItems": number
      }
   ],
   "recommenderArn": "string",
   "userId": "string"
}
```

## URI リクエストパラメータ
<a name="API_RS_GetRecommendations_RequestParameters"></a>

リクエストでは URI パラメータを使用しません。

## リクエストボディ
<a name="API_RS_GetRecommendations_RequestBody"></a>

リクエストは以下の JSON 形式のデータを受け入れます。

 ** [campaignArn](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-campaignArn"></a>
レコメンデーションの取得に使用するキャンペーンの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** [context](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-context"></a>
レコメンデーションを取得するときに使用するコンテキストメタデータ。コンテキストメタデータには、ユーザーの現在の場所やデバイスタイプなど、ユーザーのレコメンデーションを取得するときに関連する可能性のあるインタラクション情報が含まれます。  
タイプ: 文字列から文字列へのマップ  
マップエントリ: アイテムの最大数は 150 です。  
キーの長さの制限: 最大長は 150 です。  
キーパターン: `[A-Za-z\d_]+`   
値の長さの制限: 最大長は 1000 です。  
必須: いいえ

 ** [filterArn](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-filterArn"></a>
返されたレコメンデーションに適用するフィルターの ARN。詳細については、「[レコメンデーションのフィルタリング](https://docs.aws.amazon.com/personalize/latest/dg/filter.html)」を参照してください。  
このパラメータを使用するときは、フィルターのリソースが `ACTIVE` であることを確認してください。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** [filterValues](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-filterValues"></a>
レコメンデーションをフィルタリングするときに使用する値。フィルター式の各プレースホルダーパラメータについて、(大文字と小文字が一致した状態で) パラメータ名をキーとして指定し、フィルター値を対応する値として指定します。1 つのパラメータの複数の値をコンマで区切ります。  
`INCLUDE` 要素を使用してアイテムを含めるフィルター式について、式で定義されているすべてのパラメータの値を指定する必要があります。`EXCLUDE` 要素を使用してアイテムを除外する式を含むフィルターについては、`filter-values` を省略できます。この場合、Amazon Personalize は、レコメンデーションをフィルタリングするために式のその部分を使用しません。  
詳細については、「[レコメンデーションとユーザーセグメントのフィルタリング](https://docs.aws.amazon.com/personalize/latest/dg/filter.html)」を参照してください。  
タイプ: 文字列間のマッピング  
マップエントリ: アイテムの最大数は 25 です。  
キーの長さの制限: 最大長は 50 です。  
キーパターン: `[A-Za-z0-9_]+`   
値の長さの制限: 最大長は 1000 です。  
必須: いいえ

 ** [itemId](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-itemId"></a>
レコメンデーションを提供するアイテム ID。  
`RELATED_ITEMS` レシピタイプに必要です。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

 ** [metadataColumns](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-metadataColumns"></a>
キャンペーンまたはレコメンダーを作成または更新したときにレコメンデーションのメタデータを有効にした場合は、アイテムデータセットのメタデータ列をアイテムレコメンデーションに含めるように指定します。マップキーは `ITEMS` で、値はアイテムデータセットの列名のリストです。指定できる列の最大数は 10 です。  
 キャンペーンのメタデータを有効にする方法については、「[Enabling metadata in recommendations for a campaign](https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-return-metadata)」を参照してください。レコメンダーのメタデータを有効にする方法については、「[Enabling metadata in recommendations for a recommender](https://docs.aws.amazon.com/personalize/latest/dg/creating-recommenders.html#create-recommender-return-metadata)」を参照してください。  
タイプ: 文字列マップの配列への文字列  
マップエントリ: アイテムの最大数は 1 です。  
キーの長さの制限: 最大長は 256 です。  
配列メンバー: 最大数は 99 アイテムです。  
長さの制限: 最大長は 1,024 です。  
必須: いいえ

 ** [numResults](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-numResults"></a>
返される結果の数。デフォルトは 25 です。レコメンデーションにメタデータを含める場合、最大数は 50 です。それ以外の場合、最大数は 500 です。  
タイプ: 整数  
値の範囲: 最小値 は 0 です。  
必須: いいえ

 ** [promotions](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-promotions"></a>
レコメンデーションリクエストに適用するプロモーション。プロモーションは、設定可能なおすすめアイテムのサブセットに適用される追加のビジネスルールを定義します。  
型: [Promotion](API_RS_Promotion.md) オブジェクトの配列  
配列メンバー: 最大数は 1 項目です。  
必須: いいえ

 ** [recommenderArn](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-recommenderArn"></a>
レコメンデーションを取得するために使用するレコメンダーの Amazon リソースネーム (ARN)。ドメインユースケース向けのレコメンダーを含むドメインデータセットグループを作成した場合は、レコメンダー ARN を提供します。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** [userId](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-userId"></a>
レコメンデーションを提供するユーザー ID。  
`USER_PERSONALIZATION` レシピタイプに必要です。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## レスポンスの構文
<a name="API_RS_GetRecommendations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "itemList": [ 
      { 
         "itemId": "string",
         "metadata": { 
            "string" : "string" 
         },
         "promotionName": "string",
         "reason": [ "string" ],
         "score": number
      }
   ],
   "recommendationId": "string"
}
```

## レスポンス要素
<a name="API_RS_GetRecommendations_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [itemList](#API_RS_GetRecommendations_ResponseSyntax) **   <a name="personalize-RS_GetRecommendations-response-itemList"></a>
予測スコアでソートされたレコメンデーションのリスト (降順)。リストには最大 500 個のアイテムを含めることができます。  
型: [PredictedItem](API_RS_PredictedItem.md) オブジェクトの配列

 ** [recommendationId](#API_RS_GetRecommendations_ResponseSyntax) **   <a name="personalize-RS_GetRecommendations-response-recommendationId"></a>
レコメンデーションの ID。  
タイプ: 文字列

## エラー
<a name="API_RS_GetRecommendations_Errors"></a>

 ** InvalidInputException **   
フィールドまたはパラメータに有効な値を指定します。  
HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
指定されたリソースは存在しません。  
HTTP ステータスコード: 404

## 以下の資料も参照してください。
<a name="API_RS_GetRecommendations_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-runtime-2018-05-22/GetRecommendations) 

# データ型
<a name="API_Types"></a>

次のデータ型は、Amazon Personalize でサポートされています。
+  [Algorithm](API_Algorithm.md) 
+  [AlgorithmImage](API_AlgorithmImage.md) 
+  [AutoMLConfig](API_AutoMLConfig.md) 
+  [AutoMLResult](API_AutoMLResult.md) 
+  [AutoTrainingConfig](API_AutoTrainingConfig.md) 
+  [BatchInferenceJob](API_BatchInferenceJob.md) 
+  [BatchInferenceJobConfig](API_BatchInferenceJobConfig.md) 
+  [BatchInferenceJobInput](API_BatchInferenceJobInput.md) 
+  [BatchInferenceJobOutput](API_BatchInferenceJobOutput.md) 
+  [BatchInferenceJobSummary](API_BatchInferenceJobSummary.md) 
+  [BatchSegmentJob](API_BatchSegmentJob.md) 
+  [BatchSegmentJobInput](API_BatchSegmentJobInput.md) 
+  [BatchSegmentJobOutput](API_BatchSegmentJobOutput.md) 
+  [BatchSegmentJobSummary](API_BatchSegmentJobSummary.md) 
+  [Campaign](API_Campaign.md) 
+  [CampaignConfig](API_CampaignConfig.md) 
+  [CampaignSummary](API_CampaignSummary.md) 
+  [CampaignUpdateSummary](API_CampaignUpdateSummary.md) 
+  [CategoricalHyperParameterRange](API_CategoricalHyperParameterRange.md) 
+  [ContinuousHyperParameterRange](API_ContinuousHyperParameterRange.md) 
+  [DataDeletionJob](API_DataDeletionJob.md) 
+  [DataDeletionJobSummary](API_DataDeletionJobSummary.md) 
+  [Dataset](API_Dataset.md) 
+  [DatasetExportJob](API_DatasetExportJob.md) 
+  [DatasetExportJobOutput](API_DatasetExportJobOutput.md) 
+  [DatasetExportJobSummary](API_DatasetExportJobSummary.md) 
+  [DatasetGroup](API_DatasetGroup.md) 
+  [DatasetGroupSummary](API_DatasetGroupSummary.md) 
+  [DatasetImportJob](API_DatasetImportJob.md) 
+  [DatasetImportJobSummary](API_DatasetImportJobSummary.md) 
+  [DatasetSchema](API_DatasetSchema.md) 
+  [DatasetSchemaSummary](API_DatasetSchemaSummary.md) 
+  [DatasetSummary](API_DatasetSummary.md) 
+  [DatasetUpdateSummary](API_DatasetUpdateSummary.md) 
+  [DataSource](API_DataSource.md) 
+  [DefaultCategoricalHyperParameterRange](API_DefaultCategoricalHyperParameterRange.md) 
+  [DefaultContinuousHyperParameterRange](API_DefaultContinuousHyperParameterRange.md) 
+  [DefaultHyperParameterRanges](API_DefaultHyperParameterRanges.md) 
+  [DefaultIntegerHyperParameterRange](API_DefaultIntegerHyperParameterRange.md) 
+  [EventParameters](API_EventParameters.md) 
+  [EventsConfig](API_EventsConfig.md) 
+  [EventTracker](API_EventTracker.md) 
+  [EventTrackerSummary](API_EventTrackerSummary.md) 
+  [FeatureTransformation](API_FeatureTransformation.md) 
+  [FieldsForThemeGeneration](API_FieldsForThemeGeneration.md) 
+  [Filter](API_Filter.md) 
+  [FilterSummary](API_FilterSummary.md) 
+  [HPOConfig](API_HPOConfig.md) 
+  [HPOObjective](API_HPOObjective.md) 
+  [HPOResourceConfig](API_HPOResourceConfig.md) 
+  [HyperParameterRanges](API_HyperParameterRanges.md) 
+  [IntegerHyperParameterRange](API_IntegerHyperParameterRange.md) 
+  [MetricAttribute](API_MetricAttribute.md) 
+  [MetricAttribution](API_MetricAttribution.md) 
+  [MetricAttributionOutput](API_MetricAttributionOutput.md) 
+  [MetricAttributionSummary](API_MetricAttributionSummary.md) 
+  [OptimizationObjective](API_OptimizationObjective.md) 
+  [Recipe](API_Recipe.md) 
+  [RecipeSummary](API_RecipeSummary.md) 
+  [Recommender](API_Recommender.md) 
+  [RecommenderConfig](API_RecommenderConfig.md) 
+  [RecommenderSummary](API_RecommenderSummary.md) 
+  [RecommenderUpdateSummary](API_RecommenderUpdateSummary.md) 
+  [S3DataConfig](API_S3DataConfig.md) 
+  [Solution](API_Solution.md) 
+  [SolutionConfig](API_SolutionConfig.md) 
+  [SolutionSummary](API_SolutionSummary.md) 
+  [SolutionUpdateConfig](API_SolutionUpdateConfig.md) 
+  [SolutionUpdateSummary](API_SolutionUpdateSummary.md) 
+  [SolutionVersion](API_SolutionVersion.md) 
+  [SolutionVersionSummary](API_SolutionVersionSummary.md) 
+  [Tag](API_Tag.md) 
+  [ThemeGenerationConfig](API_ThemeGenerationConfig.md) 
+  [TrainingDataConfig](API_TrainingDataConfig.md) 
+  [TunedHPOParams](API_TunedHPOParams.md) 

次のデータ型は、Amazon Personalize Events でサポートされています。
+  [Action](API_UBS_Action.md) 
+  [ActionInteraction](API_UBS_ActionInteraction.md) 
+  [Event](API_UBS_Event.md) 
+  [Item](API_UBS_Item.md) 
+  [MetricAttribution](API_UBS_MetricAttribution.md) 
+  [User](API_UBS_User.md) 

次のデータ型は、Amazon Personalize Runtime でサポートされています。
+  [PredictedAction](API_RS_PredictedAction.md) 
+  [PredictedItem](API_RS_PredictedItem.md) 
+  [Promotion](API_RS_Promotion.md) 

# Amazon Personalize
<a name="API_Types_Amazon_Personalize"></a>

次のデータ型は、Amazon Personalize でサポートされています。
+  [Algorithm](API_Algorithm.md) 
+  [AlgorithmImage](API_AlgorithmImage.md) 
+  [AutoMLConfig](API_AutoMLConfig.md) 
+  [AutoMLResult](API_AutoMLResult.md) 
+  [AutoTrainingConfig](API_AutoTrainingConfig.md) 
+  [BatchInferenceJob](API_BatchInferenceJob.md) 
+  [BatchInferenceJobConfig](API_BatchInferenceJobConfig.md) 
+  [BatchInferenceJobInput](API_BatchInferenceJobInput.md) 
+  [BatchInferenceJobOutput](API_BatchInferenceJobOutput.md) 
+  [BatchInferenceJobSummary](API_BatchInferenceJobSummary.md) 
+  [BatchSegmentJob](API_BatchSegmentJob.md) 
+  [BatchSegmentJobInput](API_BatchSegmentJobInput.md) 
+  [BatchSegmentJobOutput](API_BatchSegmentJobOutput.md) 
+  [BatchSegmentJobSummary](API_BatchSegmentJobSummary.md) 
+  [Campaign](API_Campaign.md) 
+  [CampaignConfig](API_CampaignConfig.md) 
+  [CampaignSummary](API_CampaignSummary.md) 
+  [CampaignUpdateSummary](API_CampaignUpdateSummary.md) 
+  [CategoricalHyperParameterRange](API_CategoricalHyperParameterRange.md) 
+  [ContinuousHyperParameterRange](API_ContinuousHyperParameterRange.md) 
+  [DataDeletionJob](API_DataDeletionJob.md) 
+  [DataDeletionJobSummary](API_DataDeletionJobSummary.md) 
+  [Dataset](API_Dataset.md) 
+  [DatasetExportJob](API_DatasetExportJob.md) 
+  [DatasetExportJobOutput](API_DatasetExportJobOutput.md) 
+  [DatasetExportJobSummary](API_DatasetExportJobSummary.md) 
+  [DatasetGroup](API_DatasetGroup.md) 
+  [DatasetGroupSummary](API_DatasetGroupSummary.md) 
+  [DatasetImportJob](API_DatasetImportJob.md) 
+  [DatasetImportJobSummary](API_DatasetImportJobSummary.md) 
+  [DatasetSchema](API_DatasetSchema.md) 
+  [DatasetSchemaSummary](API_DatasetSchemaSummary.md) 
+  [DatasetSummary](API_DatasetSummary.md) 
+  [DatasetUpdateSummary](API_DatasetUpdateSummary.md) 
+  [DataSource](API_DataSource.md) 
+  [DefaultCategoricalHyperParameterRange](API_DefaultCategoricalHyperParameterRange.md) 
+  [DefaultContinuousHyperParameterRange](API_DefaultContinuousHyperParameterRange.md) 
+  [DefaultHyperParameterRanges](API_DefaultHyperParameterRanges.md) 
+  [DefaultIntegerHyperParameterRange](API_DefaultIntegerHyperParameterRange.md) 
+  [EventParameters](API_EventParameters.md) 
+  [EventsConfig](API_EventsConfig.md) 
+  [EventTracker](API_EventTracker.md) 
+  [EventTrackerSummary](API_EventTrackerSummary.md) 
+  [FeatureTransformation](API_FeatureTransformation.md) 
+  [FieldsForThemeGeneration](API_FieldsForThemeGeneration.md) 
+  [Filter](API_Filter.md) 
+  [FilterSummary](API_FilterSummary.md) 
+  [HPOConfig](API_HPOConfig.md) 
+  [HPOObjective](API_HPOObjective.md) 
+  [HPOResourceConfig](API_HPOResourceConfig.md) 
+  [HyperParameterRanges](API_HyperParameterRanges.md) 
+  [IntegerHyperParameterRange](API_IntegerHyperParameterRange.md) 
+  [MetricAttribute](API_MetricAttribute.md) 
+  [MetricAttribution](API_MetricAttribution.md) 
+  [MetricAttributionOutput](API_MetricAttributionOutput.md) 
+  [MetricAttributionSummary](API_MetricAttributionSummary.md) 
+  [OptimizationObjective](API_OptimizationObjective.md) 
+  [Recipe](API_Recipe.md) 
+  [RecipeSummary](API_RecipeSummary.md) 
+  [Recommender](API_Recommender.md) 
+  [RecommenderConfig](API_RecommenderConfig.md) 
+  [RecommenderSummary](API_RecommenderSummary.md) 
+  [RecommenderUpdateSummary](API_RecommenderUpdateSummary.md) 
+  [S3DataConfig](API_S3DataConfig.md) 
+  [Solution](API_Solution.md) 
+  [SolutionConfig](API_SolutionConfig.md) 
+  [SolutionSummary](API_SolutionSummary.md) 
+  [SolutionUpdateConfig](API_SolutionUpdateConfig.md) 
+  [SolutionUpdateSummary](API_SolutionUpdateSummary.md) 
+  [SolutionVersion](API_SolutionVersion.md) 
+  [SolutionVersionSummary](API_SolutionVersionSummary.md) 
+  [Tag](API_Tag.md) 
+  [ThemeGenerationConfig](API_ThemeGenerationConfig.md) 
+  [TrainingDataConfig](API_TrainingDataConfig.md) 
+  [TunedHPOParams](API_TunedHPOParams.md) 

# Algorithm
<a name="API_Algorithm"></a>

カスタムアルゴリズムを記述します。

## 内容
<a name="API_Algorithm_Contents"></a>

 ** algorithmArn **   <a name="personalize-Type-Algorithm-algorithmArn"></a>
アルゴリズムの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** algorithmImage **   <a name="personalize-Type-Algorithm-algorithmImage"></a>
アルゴリズムイメージの Docker コンテナの URI。  
型: [AlgorithmImage](API_AlgorithmImage.md) オブジェクト  
必須: いいえ

 ** creationDateTime **   <a name="personalize-Type-Algorithm-creationDateTime"></a>
アルゴリズムの作成日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** defaultHyperParameterRanges **   <a name="personalize-Type-Algorithm-defaultHyperParameterRanges"></a>
デフォルトのハイパーパラメータ、それらの範囲、およびそれらがチューニング可能かどうかを指定します。チューニング可能なハイパーパラメータは、ハイパーパラメータ最適化 (HPO) 中にその値を決定できます。  
型: [DefaultHyperParameterRanges](API_DefaultHyperParameterRanges.md) オブジェクト  
必須: いいえ

 ** defaultHyperParameters **   <a name="personalize-Type-Algorithm-defaultHyperParameters"></a>
デフォルトのハイパーパラメータを指定します。  
型: 文字列間のマッピング  
マップエントリ: アイテムの最大数は 100 です。  
キーの長さの制限: 最大長は 256 です。  
値の長さの制限: 最大長は 1000 です。  
必須: いいえ

 ** defaultResourceConfig **   <a name="personalize-Type-Algorithm-defaultResourceConfig"></a>
トレーニングジョブと並列トレーニングジョブのデフォルトの最大数を指定します。  
型: 文字列間のマッピング  
マップエントリ: アイテムの最大数は 100 です。  
キーの長さの制限: 最大長は 256 です。  
値の長さの制限: 最大長は 1000 です。  
必須: いいえ

 ** lastUpdatedDateTime **   <a name="personalize-Type-Algorithm-lastUpdatedDateTime"></a>
アルゴリズムの最終更新日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** name **   <a name="personalize-Type-Algorithm-name"></a>
アルゴリズムの名前  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: いいえ

 ** roleArn **   <a name="personalize-Type-Algorithm-roleArn"></a>
ロールの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** trainingInputMode **   <a name="personalize-Type-Algorithm-trainingInputMode"></a>
トレーニング入力モード。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_Algorithm_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Algorithm) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/Algorithm) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/Algorithm) 

# AlgorithmImage
<a name="API_AlgorithmImage"></a>

アルゴリズムイメージを記述します。

## 内容
<a name="API_AlgorithmImage_Contents"></a>

 ** dockerURI **   <a name="personalize-Type-AlgorithmImage-dockerURI"></a>
アルゴリズムイメージの Docker コンテナの URI。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: はい

 ** name **   <a name="personalize-Type-AlgorithmImage-name"></a>
アルゴリズムイメージの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: いいえ

## 以下の資料も参照してください。
<a name="API_AlgorithmImage_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/AlgorithmImage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/AlgorithmImage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/AlgorithmImage) 

# AutoMLConfig
<a name="API_AutoMLConfig"></a>

ソリューションが AutoML を実行すると (`performAutoML` が [CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) で true)、Amazon Personalize は、指定されたリストから、既定のメトリクスを最適化するレシピを決定します。その後、Amazon Personalize はそのレシピをソリューションに使用します。

## 内容
<a name="API_AutoMLConfig_Contents"></a>

 ** metricName **   <a name="personalize-Type-AutoMLConfig-metricName"></a>
最適化するメトリクス。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

 ** recipeList **   <a name="personalize-Type-AutoMLConfig-recipeList"></a>
候補レシピのリスト。  
型: 文字列の配列  
配列メンバー: 最大数は 100 項目です。  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

## 以下の資料も参照してください。
<a name="API_AutoMLConfig_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/AutoMLConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/AutoMLConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/AutoMLConfig) 

# AutoMLResult
<a name="API_AutoMLResult"></a>

ソリューションが AutoML を実行する場合 ([CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html)で `performAutoML` が true)、指定されたメトリクスを最適化するレシピを指定します。

## 内容
<a name="API_AutoMLResult_Contents"></a>

 ** bestRecipeArn **   <a name="personalize-Type-AutoMLResult-bestRecipeArn"></a>
最適なレシピの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

## 以下の資料も参照してください。
<a name="API_AutoMLResult_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/AutoMLResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/AutoMLResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/AutoMLResult) 

# AutoTrainingConfig
<a name="API_AutoTrainingConfig"></a>

`performAutoTraining` が true の場合に使用する自動トレーニング設定。

## 内容
<a name="API_AutoTrainingConfig_Contents"></a>

 ** schedulingExpression **   <a name="personalize-Type-AutoTrainingConfig-schedulingExpression"></a>
新しいソリューションバージョンを自動的にトレーニングする頻度を指定します。rate(*値* *単位*) 形式で rate 式を指定します。値には、1～30 の数値を指定します。単位には、`day` または `days` を指定します。例えば、5 日ごとに新しいソリューションバージョンを自動的に作成するには、`rate(5 days)` を指定します。デフォルトは 7 日ごとです。  
自動トレーニングの詳細については、「[ソリューションの作成と構成](https://docs.aws.amazon.com/personalize/latest/dg/customizing-solution-config.html)」を参照してください。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 16 です。  
パターン: `rate\(\d+ days?\)`   
必須: いいえ

## 以下の資料も参照してください。
<a name="API_AutoTrainingConfig_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/AutoTrainingConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/AutoTrainingConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/AutoTrainingConfig) 

# BatchInferenceJob
<a name="API_BatchInferenceJob"></a>

バッチ推論ジョブに関する情報が含まれます。

## 内容
<a name="API_BatchInferenceJob_Contents"></a>

 ** batchInferenceJobArn **   <a name="personalize-Type-BatchInferenceJob-batchInferenceJobArn"></a>
バッチ推論ジョブの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** batchInferenceJobConfig **   <a name="personalize-Type-BatchInferenceJob-batchInferenceJobConfig"></a>
バッチ推論ジョブの設定の詳細の文字列から文字列へのマップ。  
型: [BatchInferenceJobConfig](API_BatchInferenceJobConfig.md) オブジェクト  
必須: いいえ

 ** batchInferenceJobMode **   <a name="personalize-Type-BatchInferenceJob-batchInferenceJobMode"></a>
ジョブのモード。  
型: 文字列  
有効な値：`BATCH_INFERENCE | THEME_GENERATION`  
必須：いいえ

 ** creationDateTime **   <a name="personalize-Type-BatchInferenceJob-creationDateTime"></a>
バッチ推論ジョブの作成時刻。  
型: タイムスタンプ  
必須: いいえ

 ** failureReason **   <a name="personalize-Type-BatchInferenceJob-failureReason"></a>
バッチ推論ジョブが失敗した場合、失敗の理由。  
タイプ: 文字列  
必須: いいえ

 ** filterArn **   <a name="personalize-Type-BatchInferenceJob-filterArn"></a>
バッチ推論ジョブで使用されるフィルターの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** jobInput **   <a name="personalize-Type-BatchInferenceJob-jobInput"></a>
バッチ推論ジョブの生成に使用される入力データの格納場所への Amazon S3 パス。  
型: [BatchInferenceJobInput](API_BatchInferenceJobInput.md) オブジェクト  
必須: いいえ

 ** jobName **   <a name="personalize-Type-BatchInferenceJob-jobName"></a>
バッチ推論ジョブの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: いいえ

 ** jobOutput **   <a name="personalize-Type-BatchInferenceJob-jobOutput"></a>
バッチ推論ジョブによって生成される出力データを含む Amazon S3 バケット。  
型: [BatchInferenceJobOutput](API_BatchInferenceJobOutput.md) オブジェクト  
必須: いいえ

 ** lastUpdatedDateTime **   <a name="personalize-Type-BatchInferenceJob-lastUpdatedDateTime"></a>
バッチ推論ジョブの最終更新時刻。  
型: タイムスタンプ  
必須: いいえ

 ** numResults **   <a name="personalize-Type-BatchInferenceJob-numResults"></a>
バッチ推論ジョブによって生成されたレコメンデーションの数。この数には、失敗した入力レコードについて生成されたエラーメッセージが含まれます。  
タイプ: 整数  
必須: いいえ

 ** roleArn **   <a name="personalize-Type-BatchInferenceJob-roleArn"></a>
バッチ推論ジョブをリクエストした Amazon Identity and Access Management (IAM) ロールの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`   
必須: いいえ

 ** solutionVersionArn **   <a name="personalize-Type-BatchInferenceJob-solutionVersionArn"></a>
バッチ推論ジョブが作成されたソリューションバージョンの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** status **   <a name="personalize-Type-BatchInferenceJob-status"></a>
バッチ推論ジョブのステータス。ステータスは、次のいずれかの値です。  
+ 保留中
+ IN PROGRESS
+ ACTIVE
+ CREATE FAILED
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

 ** themeGenerationConfig **   <a name="personalize-Type-BatchInferenceJob-themeGenerationConfig"></a>
ジョブのテーマ生成設定。  
型: [ThemeGenerationConfig](API_ThemeGenerationConfig.md) オブジェクト  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_BatchInferenceJob_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchInferenceJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchInferenceJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchInferenceJob) 

# BatchInferenceJobConfig
<a name="API_BatchInferenceJobConfig"></a>

バッチ推論ジョブの設定の詳細。

## 内容
<a name="API_BatchInferenceJobConfig_Contents"></a>

 ** itemExplorationConfig **   <a name="personalize-Type-BatchInferenceJobConfig-itemExplorationConfig"></a>
`explorationWeight` と `explorationItemAgeCutOff` を含む探索設定ハイパーパラメータ (Amazon Personalize がアイテムを推奨するときに使用するアイテム探索の量を設定するために使用するもの) を指定する文字列から文字列へのマップ。[User-Personalization](https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html) を参照してください。  
タイプ: 文字列間のマッピング  
マップエントリ: アイテムの最大数は 100 です。  
キーの長さの制限: 最大長は 256 です。  
値の長さの制限: 最大長は 1000 です。  
必須: いいえ

 ** rankingInfluence **   <a name="personalize-Type-BatchInferenceJobConfig-rankingInfluence"></a>
POPULARITY と FRESHNESS のランキング影響値のマップ。キーごとに、0.0 から 1.0 までの数値を指定し、そのランク付け要素が最終的なレコメンデーションにどの程度影響するかを決定します。1.0 に近い値は係数に重みを付け、0.0 に近い値はその影響を軽減します。指定しない場合、どちらもデフォルトで 0.0 になります。  
タイプ: ダブルマップへの文字列。  
有効なキー: `POPULARITY | FRESHNESS`   
有効範囲: 最小値 は 0 です。最大値は 1 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_BatchInferenceJobConfig_SeeAlso"></a>

言語固有の AWSSDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWSSDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchInferenceJobConfig) 
+  [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchInferenceJobConfig) 
+  [AWSSDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchInferenceJobConfig) 

# BatchInferenceJobInput
<a name="API_BatchInferenceJobInput"></a>

バッチ推論ジョブの入力設定。

## 内容
<a name="API_BatchInferenceJobInput_Contents"></a>

 ** s3DataSource **   <a name="personalize-Type-BatchInferenceJobInput-s3DataSource"></a>
入力データを含む Amazon S3 のロケーションの URI。Amazon S3 バケットは、呼び出す API エンドポイントと同じリージョンにある必要があります。  
型: [S3DataConfig](API_S3DataConfig.md) オブジェクト  
必須: はい

## 以下の資料も参照してください。
<a name="API_BatchInferenceJobInput_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchInferenceJobInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchInferenceJobInput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchInferenceJobInput) 

# BatchInferenceJobOutput
<a name="API_BatchInferenceJobOutput"></a>

バッチ推論ジョブの出力設定パラメータ。

## 内容
<a name="API_BatchInferenceJobOutput_Contents"></a>

 ** s3DataDestination **   <a name="personalize-Type-BatchInferenceJobOutput-s3DataDestination"></a>
バッチ推論ジョブの出力が保存される Amazon S3 バケットに関する情報。  
型: [S3DataConfig](API_S3DataConfig.md) オブジェクト  
必須: はい

## 以下の資料も参照してください。
<a name="API_BatchInferenceJobOutput_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchInferenceJobOutput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchInferenceJobOutput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchInferenceJobOutput) 

# BatchInferenceJobSummary
<a name="API_BatchInferenceJobSummary"></a>

[BatchInferenceJob](https://docs.aws.amazon.com/personalize/latest/dg/API_BatchInferenceJob.html) の短縮版です。ListBatchInferenceJobs 操作は、バッチ推論ジョブの概要のリストを返します。

## 内容
<a name="API_BatchInferenceJobSummary_Contents"></a>

 ** batchInferenceJobArn **   <a name="personalize-Type-BatchInferenceJobSummary-batchInferenceJobArn"></a>
バッチ推論ジョブの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** batchInferenceJobMode **   <a name="personalize-Type-BatchInferenceJobSummary-batchInferenceJobMode"></a>
ジョブのモード。  
型: 文字列  
有効な値：`BATCH_INFERENCE | THEME_GENERATION`  
必須：いいえ

 ** creationDateTime **   <a name="personalize-Type-BatchInferenceJobSummary-creationDateTime"></a>
バッチ推論ジョブの作成時刻。  
型: タイムスタンプ  
必須: いいえ

 ** failureReason **   <a name="personalize-Type-BatchInferenceJobSummary-failureReason"></a>
バッチ推論ジョブが失敗した場合、失敗の理由。  
タイプ: 文字列  
必須: いいえ

 ** jobName **   <a name="personalize-Type-BatchInferenceJobSummary-jobName"></a>
バッチ推論ジョブの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: いいえ

 ** lastUpdatedDateTime **   <a name="personalize-Type-BatchInferenceJobSummary-lastUpdatedDateTime"></a>
バッチ推論ジョブの最終更新時刻。  
型: タイムスタンプ  
必須: いいえ

 ** solutionVersionArn **   <a name="personalize-Type-BatchInferenceJobSummary-solutionVersionArn"></a>
バッチ推論ジョブで使用されるソリューションバージョンの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** status **   <a name="personalize-Type-BatchInferenceJobSummary-status"></a>
バッチ推論ジョブのステータス。ステータスは、次のいずれかの値です。  
+ 保留中
+ IN PROGRESS
+ ACTIVE
+ CREATE FAILED
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_BatchInferenceJobSummary_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchInferenceJobSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchInferenceJobSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchInferenceJobSummary) 

# BatchSegmentJob
<a name="API_BatchSegmentJob"></a>

バッチセグメントジョブに関する情報が含まれます。

## 内容
<a name="API_BatchSegmentJob_Contents"></a>

 ** batchSegmentJobArn **   <a name="personalize-Type-BatchSegmentJob-batchSegmentJobArn"></a>
バッチセグメントジョブの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** creationDateTime **   <a name="personalize-Type-BatchSegmentJob-creationDateTime"></a>
バッチセグメントジョブの作成時刻。  
型: タイムスタンプ  
必須: いいえ

 ** failureReason **   <a name="personalize-Type-BatchSegmentJob-failureReason"></a>
バッチセグメントジョブが失敗した場合、失敗の理由。  
タイプ: 文字列  
必須: いいえ

 ** filterArn **   <a name="personalize-Type-BatchSegmentJob-filterArn"></a>
バッチセグメントジョブで使用されるフィルターの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** jobInput **   <a name="personalize-Type-BatchSegmentJob-jobInput"></a>
バッチセグメントジョブの生成に使用される入力データの格納場所への Amazon S3 パス。  
型: [BatchSegmentJobInput](API_BatchSegmentJobInput.md) オブジェクト  
必須: いいえ

 ** jobName **   <a name="personalize-Type-BatchSegmentJob-jobName"></a>
バッチセグメントジョブの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: いいえ

 ** jobOutput **   <a name="personalize-Type-BatchSegmentJob-jobOutput"></a>
バッチセグメントジョブによって生成される出力データを含む Amazon S3 バケット。  
型: [BatchSegmentJobOutput](API_BatchSegmentJobOutput.md) オブジェクト  
必須: いいえ

 ** lastUpdatedDateTime **   <a name="personalize-Type-BatchSegmentJob-lastUpdatedDateTime"></a>
バッチセグメントジョブの最終更新時刻。  
型: タイムスタンプ  
必須: いいえ

 ** numResults **   <a name="personalize-Type-BatchSegmentJob-numResults"></a>
入力データの各行のバッチセグメントジョブによって生成された予測ユーザーの数。セグメントあたりのユーザーの最大数は 500 万人です。  
タイプ: 整数  
必須: いいえ

 ** roleArn **   <a name="personalize-Type-BatchSegmentJob-roleArn"></a>
バッチセグメントジョブをリクエストした Amazon Identity and Access Management (IAM) ロールの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`   
必須: いいえ

 ** solutionVersionArn **   <a name="personalize-Type-BatchSegmentJob-solutionVersionArn"></a>
バッチセグメントを生成するためにバッチセグメントジョブで使用されるソリューションバージョンの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** status **   <a name="personalize-Type-BatchSegmentJob-status"></a>
バッチセグメントジョブのステータス。ステータスは、次のいずれかの値です。  
+ 保留中
+ IN PROGRESS
+ ACTIVE
+ CREATE FAILED
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_BatchSegmentJob_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchSegmentJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchSegmentJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchSegmentJob) 

# BatchSegmentJobInput
<a name="API_BatchSegmentJobInput"></a>

バッチセグメントジョブの入力設定。

## 内容
<a name="API_BatchSegmentJobInput_Contents"></a>

 ** s3DataSource **   <a name="personalize-Type-BatchSegmentJobInput-s3DataSource"></a>
Amazon S3 の入力または出力バケットの設定の詳細。  
型: [S3DataConfig](API_S3DataConfig.md) オブジェクト  
必須: はい

## 以下の資料も参照してください。
<a name="API_BatchSegmentJobInput_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchSegmentJobInput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchSegmentJobInput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchSegmentJobInput) 

# BatchSegmentJobOutput
<a name="API_BatchSegmentJobOutput"></a>

バッチセグメントジョブの出力設定パラメータ。

## 内容
<a name="API_BatchSegmentJobOutput_Contents"></a>

 ** s3DataDestination **   <a name="personalize-Type-BatchSegmentJobOutput-s3DataDestination"></a>
Amazon S3 の入力または出力バケットの設定の詳細。  
型: [S3DataConfig](API_S3DataConfig.md) オブジェクト  
必須: はい

## 以下の資料も参照してください。
<a name="API_BatchSegmentJobOutput_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchSegmentJobOutput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchSegmentJobOutput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchSegmentJobOutput) 

# BatchSegmentJobSummary
<a name="API_BatchSegmentJobSummary"></a>

BatchSegmentJob データ型の短縮版。[ListBatchSegmentJobs](https://docs.aws.amazon.com/personalize/latest/dg/API_ListBatchSegmentJobs.html) 操作は、バッチセグメントジョブの概要のリストを返します。

## 内容
<a name="API_BatchSegmentJobSummary_Contents"></a>

 ** batchSegmentJobArn **   <a name="personalize-Type-BatchSegmentJobSummary-batchSegmentJobArn"></a>
バッチセグメントジョブの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** creationDateTime **   <a name="personalize-Type-BatchSegmentJobSummary-creationDateTime"></a>
バッチセグメントジョブの作成時刻。  
型: タイムスタンプ  
必須: いいえ

 ** failureReason **   <a name="personalize-Type-BatchSegmentJobSummary-failureReason"></a>
バッチセグメントジョブが失敗した場合、失敗の理由。  
タイプ: 文字列  
必須: いいえ

 ** jobName **   <a name="personalize-Type-BatchSegmentJobSummary-jobName"></a>
バッチセグメントジョブの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: いいえ

 ** lastUpdatedDateTime **   <a name="personalize-Type-BatchSegmentJobSummary-lastUpdatedDateTime"></a>
バッチセグメントジョブの最終更新時刻。  
型: タイムスタンプ  
必須: いいえ

 ** solutionVersionArn **   <a name="personalize-Type-BatchSegmentJobSummary-solutionVersionArn"></a>
バッチセグメントを生成するためにバッチセグメントジョブで使用されるソリューションバージョンの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** status **   <a name="personalize-Type-BatchSegmentJobSummary-status"></a>
バッチセグメントジョブのステータス。ステータスは、次のいずれかの値です。  
+ 保留中
+ IN PROGRESS
+ ACTIVE
+ CREATE FAILED
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_BatchSegmentJobSummary_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchSegmentJobSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchSegmentJobSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchSegmentJobSummary) 

# Campaign
<a name="API_Campaign"></a>

ソリューションバージョンのデプロイを記述するオブジェクト。キャンペーンの作成の詳細については、「[CreateCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html)」を参照してください。

## 内容
<a name="API_Campaign_Contents"></a>

 ** campaignArn **   <a name="personalize-Type-Campaign-campaignArn"></a>
キャンペーンの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** campaignConfig **   <a name="personalize-Type-Campaign-campaignConfig"></a>
キャンペーンの設定の詳細。  
型: [CampaignConfig](API_CampaignConfig.md) オブジェクト  
必須: いいえ

 ** creationDateTime **   <a name="personalize-Type-Campaign-creationDateTime"></a>
キャンペーンの作成日時 (Unix 形式)。  
型: タイムスタンプ  
必須: いいえ

 ** failureReason **   <a name="personalize-Type-Campaign-failureReason"></a>
キャンペーンが失敗した場合、失敗の理由。  
タイプ: 文字列  
必須: いいえ

 ** lastUpdatedDateTime **   <a name="personalize-Type-Campaign-lastUpdatedDateTime"></a>
キャンペーンの最終更新日時 (Unix 形式)。  
型: タイムスタンプ  
必須: いいえ

 ** latestCampaignUpdate **   <a name="personalize-Type-Campaign-latestCampaignUpdate"></a>
キャンペーンの更新のプロパティの概要を提供します。詳細なリストについては、[DescribeCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html) API を呼び出してください。  
`latestCampaignUpdate` フィールドは、キャンペーンで少なくとも 1 回の`UpdateCampaign` 呼び出しがあった場合にのみ返されます。
型: [CampaignUpdateSummary](API_CampaignUpdateSummary.md) オブジェクト  
必須: いいえ

 ** minProvisionedTPS **   <a name="personalize-Type-Campaign-minProvisionedTPS"></a>
1 秒あたりにリクエストされる最小プロビジョンドトランザクション (レコメンデーション) を指定します。`minProvisionedTPS` を高く設定すると請求額が増加します。最初は `minProvisionedTPS` に 1 を使用することをお勧めします (デフォルト)。Amazon CloudWatch メトリクスを使用して使用状況を追跡し、必要に応じて `minProvisionedTPS` を引き上げます。  
タイプ: 整数  
有効な範囲: 最小値 は 1 です。  
必須: いいえ

 ** name **   <a name="personalize-Type-Campaign-name"></a>
キャンペーンの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: いいえ

 ** solutionVersionArn **   <a name="personalize-Type-Campaign-solutionVersionArn"></a>
キャンペーンで使用するソリューションバージョンの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** status **   <a name="personalize-Type-Campaign-status"></a>
キャンペーンのステータス。  
キャンペーンは、次に示す状態のいずれかになります。  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -または- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_Campaign_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Campaign) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/Campaign) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/Campaign) 

# CampaignConfig
<a name="API_CampaignConfig"></a>

キャンペーンの設定の詳細。

## 内容
<a name="API_CampaignConfig_Contents"></a>

 ** enableMetadataWithRecommendations **   <a name="personalize-Type-CampaignConfig-enableMetadataWithRecommendations"></a>
レコメンデーションを含むメタデータがキャンペーンで有効になっているかどうか。有効にすると、レコメンデーションのリクエストでアイテムデータセットの列を指定できます。Amazon Personalize は、レコメンデーションレスポンス内の各アイテムについてこのデータを返します。キャンペーンのメタデータを有効にする方法については、「[Enabling metadata in recommendations for a campaign](https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-return-metadata)」を参照してください。  
 レコメンデーションのメタデータを有効にすると、追加費用が発生します。詳細については、「[Amazon Personalize の料金](https://aws.amazon.com/personalize/pricing/)」を参照してください。  
タイプ: ブール値  
必須: いいえ

 ** itemExplorationConfig **   <a name="personalize-Type-CampaignConfig-itemExplorationConfig"></a>
`explorationWeight` と `explorationItemAgeCutOff` を含む探索設定ハイパーパラメータ (Amazon Personalize がアイテムを推奨するときに使用するアイテム探索の量を設定するために使用するもの) を指定します。ソリューションが [User-Personalization](https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html) レシピを使用している場合にのみ `itemExplorationConfig` データを提供します。  
タイプ: 文字列間のマッピング  
マップエントリ: アイテムの最大数は 100 です。  
キーの長さの制限: 最大長は 256 です。  
値の長さの制限: 最大長は 1000 です。  
必須: いいえ

 ** rankingInfluence **   <a name="personalize-Type-CampaignConfig-rankingInfluence"></a>
POPULARITY と FRESHNESS のランキング影響値のマップ。キーごとに、0.0 から 1.0 までの数値を指定し、そのランク付け要素が最終的なレコメンデーションにどの程度影響するかを決定します。1.0 に近い値は係数に重みを付け、0.0 に近い値はその影響を軽減します。指定しない場合、どちらもデフォルトで 0.0 になります。  
タイプ: ダブルマップへの文字列。  
有効なキー: `POPULARITY | FRESHNESS`   
有効範囲: 最小値 は 0 です。最大値は 1 です。  
必須: いいえ

 ** syncWithLatestSolutionVersion **   <a name="personalize-Type-CampaignConfig-syncWithLatestSolutionVersion"></a>
キャンペーンが自動的に更新されて、ソリューションの最新バージョン (トレーニング済みモデル) を使用するかどうか。`True` を指定する場合は、`SolutionVersionArn` パラメータの*ソリューション*の ARN を指定する必要があります。`SolutionArn/$LATEST` 形式である必要があります。デフォルトは `False` で、キャンペーンを手動で更新して、最新のソリューションバージョンをデプロイする必要があります。  
 キャンペーンの自動更新の詳細については、「[キャンペーンの自動更新を有効にする](https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-automatic-latest-sv-update)」を参照してください。  
タイプ: ブール値  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_CampaignConfig_SeeAlso"></a>

言語固有の AWSSDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWSSDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CampaignConfig) 
+  [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CampaignConfig) 
+  [AWSSDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CampaignConfig) 

# CampaignSummary
<a name="API_CampaignSummary"></a>

キャンペーンのプロパティの概要を提供します。詳細なリストについては、[DescribeCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html) API を呼び出してください。

## 内容
<a name="API_CampaignSummary_Contents"></a>

 ** campaignArn **   <a name="personalize-Type-CampaignSummary-campaignArn"></a>
キャンペーンの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** creationDateTime **   <a name="personalize-Type-CampaignSummary-creationDateTime"></a>
キャンペーンの作成日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** failureReason **   <a name="personalize-Type-CampaignSummary-failureReason"></a>
キャンペーンが失敗した場合、失敗の理由。  
タイプ: 文字列  
必須: いいえ

 ** lastUpdatedDateTime **   <a name="personalize-Type-CampaignSummary-lastUpdatedDateTime"></a>
キャンペーンの最終更新日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** name **   <a name="personalize-Type-CampaignSummary-name"></a>
キャンペーンの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: いいえ

 ** status **   <a name="personalize-Type-CampaignSummary-status"></a>
キャンペーンのステータス。  
キャンペーンは、次に示す状態のいずれかになります。  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -または- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_CampaignSummary_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CampaignSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CampaignSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CampaignSummary) 

# CampaignUpdateSummary
<a name="API_CampaignUpdateSummary"></a>

キャンペーンの更新のプロパティの概要を提供します。詳細なリストについては、[DescribeCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html) API を呼び出してください。

## 内容
<a name="API_CampaignUpdateSummary_Contents"></a>

 ** campaignConfig **   <a name="personalize-Type-CampaignUpdateSummary-campaignConfig"></a>
キャンペーンの設定の詳細。  
型: [CampaignConfig](API_CampaignConfig.md) オブジェクト  
必須: いいえ

 ** creationDateTime **   <a name="personalize-Type-CampaignUpdateSummary-creationDateTime"></a>
キャンペーンの更新の作成日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** failureReason **   <a name="personalize-Type-CampaignUpdateSummary-failureReason"></a>
キャンペーンの更新が失敗した場合、失敗の理由。  
タイプ: 文字列  
必須: いいえ

 ** lastUpdatedDateTime **   <a name="personalize-Type-CampaignUpdateSummary-lastUpdatedDateTime"></a>
キャンペーンの更新の最終更新日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** minProvisionedTPS **   <a name="personalize-Type-CampaignUpdateSummary-minProvisionedTPS"></a>
Amazon Personalize がサポートする、リクエストされた 1 秒あたりの最小プロビジョンドトランザクション (推奨) を指定します。  
タイプ: 整数  
有効な範囲: 最小値 は 1 です。  
必須: いいえ

 ** solutionVersionArn **   <a name="personalize-Type-CampaignUpdateSummary-solutionVersionArn"></a>
デプロイされたソリューションバージョンの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** status **   <a name="personalize-Type-CampaignUpdateSummary-status"></a>
キャンペーン更新のステータス。  
キャンペーンの更新は、次のいずれかの状態になります。  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -または- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_CampaignUpdateSummary_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CampaignUpdateSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CampaignUpdateSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CampaignUpdateSummary) 

# CategoricalHyperParameterRange
<a name="API_CategoricalHyperParameterRange"></a>

カテゴリカルハイパーパラメータの名前と範囲を指定します。

## 内容
<a name="API_CategoricalHyperParameterRange_Contents"></a>

 ** name **   <a name="personalize-Type-CategoricalHyperParameterRange-name"></a>
ハイパーパラメータの名前。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

 ** values **   <a name="personalize-Type-CategoricalHyperParameterRange-values"></a>
ハイパーパラメータのカテゴリのリスト。  
型: 文字列の配列  
配列メンバー: 最大数は 100 項目です。  
長さの制限: 最大長は 1,000 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_CategoricalHyperParameterRange_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CategoricalHyperParameterRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CategoricalHyperParameterRange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CategoricalHyperParameterRange) 

# ContinuousHyperParameterRange
<a name="API_ContinuousHyperParameterRange"></a>

連続ハイパーパラメータの名前と範囲を指定します。

## 内容
<a name="API_ContinuousHyperParameterRange_Contents"></a>

 ** maxValue **   <a name="personalize-Type-ContinuousHyperParameterRange-maxValue"></a>
ハイパーパラメータの最大許容値。  
型: 倍精度浮動小数点数  
値の範囲: 最小値 は -1000000 です。  
必須: いいえ

 ** minValue **   <a name="personalize-Type-ContinuousHyperParameterRange-minValue"></a>
ハイパーパラメータの最小許容値。  
型: 倍精度浮動小数点数  
値の範囲: 最小値 は -1000000 です。  
必須: いいえ

 ** name **   <a name="personalize-Type-ContinuousHyperParameterRange-name"></a>
ハイパーパラメータの名前。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_ContinuousHyperParameterRange_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ContinuousHyperParameterRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ContinuousHyperParameterRange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ContinuousHyperParameterRange) 

# DataDeletionJob
<a name="API_DataDeletionJob"></a>

Amazon Personalize データセットグループから特定のユーザーへのすべての参照をバッチで削除するジョブについて説明します。データ削除ジョブの作成については、「[ユーザーの削除](https://docs.aws.amazon.com/personalize/latest/dg/delete-records.html)」を参照してください。

## 内容
<a name="API_DataDeletionJob_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-DataDeletionJob-creationDateTime"></a>
データ削除ジョブの作成日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** dataDeletionJobArn **   <a name="personalize-Type-DataDeletionJob-dataDeletionJobArn"></a>
データ削除ジョブの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** datasetGroupArn **   <a name="personalize-Type-DataDeletionJob-datasetGroupArn"></a>
ジョブがレコードを削除するデータセットグループの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** dataSource **   <a name="personalize-Type-DataDeletionJob-dataSource"></a>
データセットにアップロードするデータを含むデータソース、または Amazon Personalize から削除するレコードのリストについて説明します。  
型: [DataSource](API_DataSource.md) オブジェクト  
必須: いいえ

 ** failureReason **   <a name="personalize-Type-DataDeletionJob-failureReason"></a>
データ削除ジョブが失敗した場合、その理由を提供します。  
タイプ: 文字列  
必須: いいえ

 ** jobName **   <a name="personalize-Type-DataDeletionJob-jobName"></a>
データ削除ジョブの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: いいえ

 ** lastUpdatedDateTime **   <a name="personalize-Type-DataDeletionJob-lastUpdatedDateTime"></a>
データ削除ジョブが最後に更新された日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** numDeleted **   <a name="personalize-Type-DataDeletionJob-numDeleted"></a>
完了済みジョブによって削除されたレコードの数。  
タイプ: 整数  
必須: いいえ

 ** roleArn **   <a name="personalize-Type-DataDeletionJob-roleArn"></a>
Amazon S3 データソースから読み取るための許可を持つ IAM ロールの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`   
必須: いいえ

 ** status **   <a name="personalize-Type-DataDeletionJob-status"></a>
データ削除ジョブのステータス。  
データ削除ジョブのステータスは、次のいずれかです。  
+ PENDING > IN\$1PROGRESS > COMPLETED または FAILED
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_DataDeletionJob_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DataDeletionJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DataDeletionJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DataDeletionJob) 

# DataDeletionJobSummary
<a name="API_DataDeletionJobSummary"></a>

データ削除ジョブのプロパティの概要を提供します。詳細なリストについては、[DescribeDataDeletionJob](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataDeletionJob.html) API オペレーションを呼び出してください。

## 内容
<a name="API_DataDeletionJobSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-DataDeletionJobSummary-creationDateTime"></a>
データ削除ジョブの作成日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** dataDeletionJobArn **   <a name="personalize-Type-DataDeletionJobSummary-dataDeletionJobArn"></a>
データ削除ジョブの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** datasetGroupArn **   <a name="personalize-Type-DataDeletionJobSummary-datasetGroupArn"></a>
ジョブがレコードを削除したデータセットグループの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** failureReason **   <a name="personalize-Type-DataDeletionJobSummary-failureReason"></a>
データ削除ジョブが失敗した場合、その理由を提供します。  
タイプ: 文字列  
必須: いいえ

 ** jobName **   <a name="personalize-Type-DataDeletionJobSummary-jobName"></a>
データ削除ジョブの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: いいえ

 ** lastUpdatedDateTime **   <a name="personalize-Type-DataDeletionJobSummary-lastUpdatedDateTime"></a>
データ削除ジョブが最後に更新された日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** status **   <a name="personalize-Type-DataDeletionJobSummary-status"></a>
データ削除ジョブのステータス。  
データ削除ジョブのステータスは、次のいずれかです。  
+ PENDING > IN\$1PROGRESS > COMPLETED または FAILED
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_DataDeletionJobSummary_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DataDeletionJobSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DataDeletionJobSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DataDeletionJobSummary) 

# Dataset
<a name="API_Dataset"></a>

データセットのメタデータを提供します。

## 内容
<a name="API_Dataset_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-Dataset-creationDateTime"></a>
データセットの作成日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** datasetArn **   <a name="personalize-Type-Dataset-datasetArn"></a>
メタデータの取得対象とするデータセットの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** datasetGroupArn **   <a name="personalize-Type-Dataset-datasetGroupArn"></a>
データセットグループの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** datasetType **   <a name="personalize-Type-Dataset-datasetType"></a>
次のいずれかの値になります。  
+ インタラクション
+ 項目
+ [ユーザー]
+ アクション
+ Action\$1Interactions
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `^[A-Za-z_]+$`   
必須: いいえ

 ** lastUpdatedDateTime **   <a name="personalize-Type-Dataset-lastUpdatedDateTime"></a>
データセットがいつ更新されたかを示すタイムスタンプ。  
型: タイムスタンプ  
必須: いいえ

 ** latestDatasetUpdate **   <a name="personalize-Type-Dataset-latestDatasetUpdate"></a>
データセットの最新の更新について説明します。  
型: [DatasetUpdateSummary](API_DatasetUpdateSummary.md) オブジェクト  
必須: いいえ

 ** name **   <a name="personalize-Type-Dataset-name"></a>
データセットの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: いいえ

 ** schemaArn **   <a name="personalize-Type-Dataset-schemaArn"></a>
関連付けられたスキーマの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** status **   <a name="personalize-Type-Dataset-status"></a>
データセットのステータス。  
データセットは、次に示す状態のいずれかになります。  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -または- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

 ** trackingId **   <a name="personalize-Type-Dataset-trackingId"></a>
アクションインタラクションデータセットのイベントトラッカーの ID。トラッカーの ID は `PutActionInteractions` API オペレーションで指定します。Amazon Personalize は、これを使用して、データセットグループのアクションインタラクションデータセットに新しいデータを送信します。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_Dataset_SeeAlso"></a>

言語固有の AWSSDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWSSDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Dataset) 
+  [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/Dataset) 
+  [AWSSDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/Dataset) 

# DatasetExportJob
<a name="API_DatasetExportJob"></a>

データセットを Amazon S3 バケットにエクスポートするジョブを記述します。詳細については、「[CreateDatasetExportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html)」を参照してください。

データセットのエクスポートジョブは、次のいずれかの状態になります。
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -または- CREATE FAILED

## 内容
<a name="API_DatasetExportJob_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-DatasetExportJob-creationDateTime"></a>
データセットのエクスポートジョブの作成日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** datasetArn **   <a name="personalize-Type-DatasetExportJob-datasetArn"></a>
エクスポートするデータセットの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** datasetExportJobArn **   <a name="personalize-Type-DatasetExportJob-datasetExportJobArn"></a>
データセットのエクスポートジョブの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** failureReason **   <a name="personalize-Type-DatasetExportJob-failureReason"></a>
データセットのエクスポートジョブが失敗した場合、その理由を提供します。  
タイプ: 文字列  
必須: いいえ

 ** ingestionMode **   <a name="personalize-Type-DatasetExportJob-ingestionMode"></a>
エクスポートするデータ (データをインポートした方法に基づく)。データセットのインポートジョブを使用してインポートした `BULK` データ、(コンソール、PutEvents、PutUsers、および PutItems 操作を使用して) 増分的にインポートした `PUT` データ、または両方のタイプの `ALL` をエクスポートすることを選択できます。デフォルト値は `PUT` です。  
型: 文字列  
有効な値：`BULK | PUT | ALL`  
必須：いいえ

 ** jobName **   <a name="personalize-Type-DatasetExportJob-jobName"></a>
エクスポートジョブの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: いいえ

 ** jobOutput **   <a name="personalize-Type-DatasetExportJob-jobOutput"></a>
ジョブの出力が保存される Amazon S3 バケットへのパス。例:  
 `s3://bucket-name/folder-name/`   
型: [DatasetExportJobOutput](API_DatasetExportJobOutput.md) オブジェクト  
必須: いいえ

 ** lastUpdatedDateTime **   <a name="personalize-Type-DatasetExportJob-lastUpdatedDateTime"></a>
データセットのエクスポートジョブのステータスの最終更新日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** roleArn **   <a name="personalize-Type-DatasetExportJob-roleArn"></a>
出力 Amazon S3 バケットにデータを追加するための許可を持つ IAM サービスロールの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** status **   <a name="personalize-Type-DatasetExportJob-status"></a>
データセットのエクスポートジョブのステータス。  
データセットのエクスポートジョブは、次のいずれかの状態になります。  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -または- CREATE FAILED
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_DatasetExportJob_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetExportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetExportJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetExportJob) 

# DatasetExportJobOutput
<a name="API_DatasetExportJobOutput"></a>

データセットのエクスポートジョブの出力設定パラメータ。

## 内容
<a name="API_DatasetExportJobOutput_Contents"></a>

 ** s3DataDestination **   <a name="personalize-Type-DatasetExportJobOutput-s3DataDestination"></a>
Amazon S3 の入力または出力バケットの設定の詳細。  
型: [S3DataConfig](API_S3DataConfig.md) オブジェクト  
必須: はい

## 以下の資料も参照してください。
<a name="API_DatasetExportJobOutput_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetExportJobOutput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetExportJobOutput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetExportJobOutput) 

# DatasetExportJobSummary
<a name="API_DatasetExportJobSummary"></a>

データセットのエクスポートジョブのプロパティの概要を提供します。詳細なリストについては、[DescribeDatasetExportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetExportJob.html) API を呼び出してください。

## 内容
<a name="API_DatasetExportJobSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-DatasetExportJobSummary-creationDateTime"></a>
データセットのエクスポートジョブの作成日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** datasetExportJobArn **   <a name="personalize-Type-DatasetExportJobSummary-datasetExportJobArn"></a>
データセットのエクスポートジョブの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** failureReason **   <a name="personalize-Type-DatasetExportJobSummary-failureReason"></a>
データセットのエクスポートジョブが失敗した場合、失敗の理由。  
タイプ: 文字列  
必須: いいえ

 ** jobName **   <a name="personalize-Type-DatasetExportJobSummary-jobName"></a>
データセットのエクスポートジョブの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: いいえ

 ** lastUpdatedDateTime **   <a name="personalize-Type-DatasetExportJobSummary-lastUpdatedDateTime"></a>
データセットのエクスポートジョブのステータスの最終更新日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** status **   <a name="personalize-Type-DatasetExportJobSummary-status"></a>
データセットのエクスポートジョブのステータス。  
データセットのエクスポートジョブは、次のいずれかの状態になります。  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -または- CREATE FAILED
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_DatasetExportJobSummary_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetExportJobSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetExportJobSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetExportJobSummary) 

# DatasetGroup
<a name="API_DatasetGroup"></a>

データセットグループは、関連するデータセットのコレクションです (アイテムインタラクション、ユーザー、アイテム、アクション、アクションインタラクション)。[CreateDatasetGroup](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html) を呼び出すことによってデータセットグループを作成します。その後、データセットを作成して、[CreateDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html) を呼び出してデータセットグループに追加します。[CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) を呼び出すことにより、データセットグループを使用してソリューションに作成とトレーニングをします。データセットグループには、各タイプのデータセットを 1 つのみ含めることができます。

AWS Key Management Service (KMS) キーを指定して、グループ内のデータセットを暗号化できます。

## 内容
<a name="API_DatasetGroup_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-DatasetGroup-creationDateTime"></a>
データセットグループの作成日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** datasetGroupArn **   <a name="personalize-Type-DatasetGroup-datasetGroupArn"></a>
データセットグループの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** domain **   <a name="personalize-Type-DatasetGroup-domain"></a>
ドメインデータセットグループのドメイン。  
型: 文字列  
有効な値：`ECOMMERCE | VIDEO_ON_DEMAND`  
必須：いいえ

 ** failureReason **   <a name="personalize-Type-DatasetGroup-failureReason"></a>
データセットグループの作成が失敗した場合、その理由を提供します。  
タイプ: 文字列  
必須: いいえ

 ** kmsKeyArn **   <a name="personalize-Type-DatasetGroup-kmsKeyArn"></a>
データセットの暗号化に使用される AWS Key Management Service (KMS) キーの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 2,048 です。  
パターン: `arn:aws.*:kms:.*:[0-9]{12}:key/.*`   
必須: いいえ

 ** lastUpdatedDateTime **   <a name="personalize-Type-DatasetGroup-lastUpdatedDateTime"></a>
データセットグループの最終更新日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** name **   <a name="personalize-Type-DatasetGroup-name"></a>
データセットグループの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: いいえ

 ** roleArn **   <a name="personalize-Type-DatasetGroup-roleArn"></a>
AWS Key Management Service (KMS) キーにアクセスするための許可を持つ AWS Identity and Access Management (IAM) ロールの ARN。IAM ロールの指定は、KMS キーも指定する場合にのみ有効です。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`   
必須: いいえ

 ** status **   <a name="personalize-Type-DatasetGroup-status"></a>
データセットグループの現在のステータス。  
データセットグループは、次に示す状態のいずれかになります。  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -または- CREATE FAILED
+ DELETE PENDING
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_DatasetGroup_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetGroup) 

# DatasetGroupSummary
<a name="API_DatasetGroupSummary"></a>

データセットグループのプロパティの概要を提供します。詳細なリストについては、[DescribeDatasetGroup](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetGroup.html) API を呼び出してください。

## 内容
<a name="API_DatasetGroupSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-DatasetGroupSummary-creationDateTime"></a>
データセットグループの作成日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** datasetGroupArn **   <a name="personalize-Type-DatasetGroupSummary-datasetGroupArn"></a>
データセットグループの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** domain **   <a name="personalize-Type-DatasetGroupSummary-domain"></a>
ドメインデータセットグループのドメイン。  
型: 文字列  
有効な値：`ECOMMERCE | VIDEO_ON_DEMAND`  
必須：いいえ

 ** failureReason **   <a name="personalize-Type-DatasetGroupSummary-failureReason"></a>
データセットグループの作成が失敗した場合、失敗の理由。  
タイプ: 文字列  
必須: いいえ

 ** lastUpdatedDateTime **   <a name="personalize-Type-DatasetGroupSummary-lastUpdatedDateTime"></a>
データセットグループが最後に更新された日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** name **   <a name="personalize-Type-DatasetGroupSummary-name"></a>
データセットグループの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: いいえ

 ** status **   <a name="personalize-Type-DatasetGroupSummary-status"></a>
データセットグループのステータス。  
データセットグループは、次に示す状態のいずれかになります。  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -または- CREATE FAILED
+ DELETE PENDING
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_DatasetGroupSummary_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetGroupSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetGroupSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetGroupSummary) 

# DatasetImportJob
<a name="API_DatasetImportJob"></a>

トレーニングデータをデータソース (Amazon S3バケット) から Amazon Personalize データセットにインポートするジョブを記述します。詳細については、「[CreateDatasetImportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html)」を参照してください。

データセットのインポートジョブは、次のいずれかの状態になります。
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -または- CREATE FAILED

## 内容
<a name="API_DatasetImportJob_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-DatasetImportJob-creationDateTime"></a>
データセットのインポートジョブの作成日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** datasetArn **   <a name="personalize-Type-DatasetImportJob-datasetArn"></a>
インポートされたデータを受け取るデータセットの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** datasetImportJobArn **   <a name="personalize-Type-DatasetImportJob-datasetImportJobArn"></a>
データセットのインポートジョブの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** dataSource **   <a name="personalize-Type-DatasetImportJob-dataSource"></a>
インポートするトレーニングデータを含む Amazon S3 バケット。  
型: [DataSource](API_DataSource.md) オブジェクト  
必須: いいえ

 ** failureReason **   <a name="personalize-Type-DatasetImportJob-failureReason"></a>
データセットのインポートジョブが失敗した場合、その理由を提供します。  
タイプ: 文字列  
必須: いいえ

 ** importMode **   <a name="personalize-Type-DatasetImportJob-importMode"></a>
データセットのインポートジョブが新しいレコードをインポートするために使用するインポートモード。  
型: 文字列  
有効な値：`FULL | INCREMENTAL`  
必須：いいえ

 ** jobName **   <a name="personalize-Type-DatasetImportJob-jobName"></a>
インポートジョブの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: いいえ

 ** lastUpdatedDateTime **   <a name="personalize-Type-DatasetImportJob-lastUpdatedDateTime"></a>
データセットが最後に更新された日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** publishAttributionMetricsToS3 **   <a name="personalize-Type-DatasetImportJob-publishAttributionMetricsToS3"></a>
ジョブがメトリクス属性のために Amazon S3 にメトリクスを公開するかどうか。  
型: ブール値  
必須: いいえ

 ** roleArn **   <a name="personalize-Type-DatasetImportJob-roleArn"></a>
Amazon S3 データソースから読み取るための許可を持つ IAM ロールの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** status **   <a name="personalize-Type-DatasetImportJob-status"></a>
データセットのインポートジョブのステータス。  
データセットのインポートジョブは、次のいずれかの状態になります。  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -または- CREATE FAILED
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_DatasetImportJob_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetImportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetImportJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetImportJob) 

# DatasetImportJobSummary
<a name="API_DatasetImportJobSummary"></a>

データセットのインポートジョブのプロパティの概要を提供します。詳細なリストについては、[DescribeDatasetImportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetImportJob.html) API を呼び出してください。

## 内容
<a name="API_DatasetImportJobSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-DatasetImportJobSummary-creationDateTime"></a>
データセットのインポートジョブの作成日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** datasetImportJobArn **   <a name="personalize-Type-DatasetImportJobSummary-datasetImportJobArn"></a>
データセットのインポートジョブの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** failureReason **   <a name="personalize-Type-DatasetImportJobSummary-failureReason"></a>
データセットのインポートジョブが失敗した場合、失敗の理由。  
タイプ: 文字列  
必須: いいえ

 ** importMode **   <a name="personalize-Type-DatasetImportJobSummary-importMode"></a>
データセットのインポートジョブがデータセット内のデータを更新するために使用するインポートモード。詳細については、「[既存のバルクデータの更新](https://docs.aws.amazon.com/personalize/latest/dg/updating-existing-bulk-data.html)」を参照してください。  
型: 文字列  
有効な値：`FULL | INCREMENTAL`  
必須：いいえ

 ** jobName **   <a name="personalize-Type-DatasetImportJobSummary-jobName"></a>
データセットのインポートジョブの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: いいえ

 ** lastUpdatedDateTime **   <a name="personalize-Type-DatasetImportJobSummary-lastUpdatedDateTime"></a>
データセットのインポートジョブのステータスの最終更新日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** status **   <a name="personalize-Type-DatasetImportJobSummary-status"></a>
データセットのインポートジョブのステータス。  
データセットのインポートジョブは、次のいずれかの状態になります。  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -または- CREATE FAILED
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_DatasetImportJobSummary_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetImportJobSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetImportJobSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetImportJobSummary) 

# DatasetSchema
<a name="API_DatasetSchema"></a>

データセットのスキーマを記述します。スキーマについての詳細は、「[CreateSchema](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html)」を参照してください。

## 内容
<a name="API_DatasetSchema_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-DatasetSchema-creationDateTime"></a>
スキーマが作成された日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** domain **   <a name="personalize-Type-DatasetSchema-domain"></a>
ドメインデータセットグループ内のデータセット用に作成したスキーマのドメイン。  
型: 文字列  
有効な値：`ECOMMERCE | VIDEO_ON_DEMAND`  
必須：いいえ

 ** lastUpdatedDateTime **   <a name="personalize-Type-DatasetSchema-lastUpdatedDateTime"></a>
スキーマが最後に更新された日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** name **   <a name="personalize-Type-DatasetSchema-name"></a>
スキーマの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: いいえ

 ** schema **   <a name="personalize-Type-DatasetSchema-schema"></a>
スキーマ。  
タイプ: 文字列  
長さの制限: 最大長は 20,000 です。  
必須: いいえ

 ** schemaArn **   <a name="personalize-Type-DatasetSchema-schemaArn"></a>
スキーマの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

## 以下の資料も参照してください。
<a name="API_DatasetSchema_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetSchema) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetSchema) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetSchema) 

# DatasetSchemaSummary
<a name="API_DatasetSchemaSummary"></a>

データセットスキーマのプロパティの概要を提供します。詳細なリストについては、[DescribeSchema](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSchema.html) API を呼び出してください。

## 内容
<a name="API_DatasetSchemaSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-DatasetSchemaSummary-creationDateTime"></a>
スキーマが作成された日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** domain **   <a name="personalize-Type-DatasetSchemaSummary-domain"></a>
ドメインデータセットグループ内のデータセット用に作成したスキーマのドメイン。  
型: 文字列  
有効な値：`ECOMMERCE | VIDEO_ON_DEMAND`  
必須：いいえ

 ** lastUpdatedDateTime **   <a name="personalize-Type-DatasetSchemaSummary-lastUpdatedDateTime"></a>
スキーマが最後に更新された日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** name **   <a name="personalize-Type-DatasetSchemaSummary-name"></a>
スキーマの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: いいえ

 ** schemaArn **   <a name="personalize-Type-DatasetSchemaSummary-schemaArn"></a>
スキーマの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

## 以下の資料も参照してください。
<a name="API_DatasetSchemaSummary_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetSchemaSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetSchemaSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetSchemaSummary) 

# DatasetSummary
<a name="API_DatasetSummary"></a>

データセットのプロパティの概要を提供します。詳細なリストについては、[DescribeDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html) API を呼び出してください。

## 内容
<a name="API_DatasetSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-DatasetSummary-creationDateTime"></a>
データセットの作成日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** datasetArn **   <a name="personalize-Type-DatasetSummary-datasetArn"></a>
データセットの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** datasetType **   <a name="personalize-Type-DatasetSummary-datasetType"></a>
データセットのタイプ。次のいずれかの値になります。  
+ インタラクション
+ 項目
+ [ユーザー]
+ イベントインタラクション
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `^[A-Za-z_]+$`   
必須: いいえ

 ** lastUpdatedDateTime **   <a name="personalize-Type-DatasetSummary-lastUpdatedDateTime"></a>
データセットが最後に更新された日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** name **   <a name="personalize-Type-DatasetSummary-name"></a>
データセットの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: いいえ

 ** status **   <a name="personalize-Type-DatasetSummary-status"></a>
データセットのステータス。  
データセットは、次に示す状態のいずれかになります。  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -または- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_DatasetSummary_SeeAlso"></a>

言語固有の AWSSDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWSSDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetSummary) 
+  [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetSummary) 
+  [AWSSDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetSummary) 

# DatasetUpdateSummary
<a name="API_DatasetUpdateSummary"></a>

データセットの更新について説明します。

## 内容
<a name="API_DatasetUpdateSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-DatasetUpdateSummary-creationDateTime"></a>
データセット更新の作成日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** failureReason **   <a name="personalize-Type-DatasetUpdateSummary-failureReason"></a>
データセットの更新が失敗した場合、その理由を提供します。  
タイプ: 文字列  
必須: いいえ

 ** lastUpdatedDateTime **   <a name="personalize-Type-DatasetUpdateSummary-lastUpdatedDateTime"></a>
データセットの最終更新日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** schemaArn **   <a name="personalize-Type-DatasetUpdateSummary-schemaArn"></a>
データセットの以前のスキーマを置き換えたスキーマの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** status **   <a name="personalize-Type-DatasetUpdateSummary-status"></a>
データセット更新のステータス。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_DatasetUpdateSummary_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetUpdateSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetUpdateSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetUpdateSummary) 

# DataSource
<a name="API_DataSource"></a>

データセットにアップロードするデータを含むデータソース、または Amazon Personalize から削除するレコードのリストについて説明します。

## 内容
<a name="API_DataSource_Contents"></a>

 ** dataLocation **   <a name="personalize-Type-DataSource-dataLocation"></a>
データセットインポートジョブで、データセットにアップロードするデータが保存される Amazon S3 バケットへのパス。データ削除ジョブで、削除するレコードのリストを保存する Amazon S3 バケットへのパス。  
 例:   
 `s3://bucket-name/folder-name/fileName.csv`   
CSV ファイルが Amazon S3 バケット内のフォルダにあり、インポートジョブまたはデータ削除ジョブで複数のファイルを検討する場合、フォルダへのパスを指定できます。データ削除ジョブでは、Amazon Personalize は、フォルダとサブフォルダ内のすべてのファイルを使用します。フォルダ名の後に `/` を付けて次の構文を使用します。  
 `s3://bucket-name/folder-name/`   
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `(s3|http|https)://.+`   
必須: いいえ

## 以下の資料も参照してください。
<a name="API_DataSource_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DataSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DataSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DataSource) 

# DefaultCategoricalHyperParameterRange
<a name="API_DefaultCategoricalHyperParameterRange"></a>

カテゴリ別ハイパーパラメータの名前とデフォルトの範囲、およびハイパーパラメータがチューニング可能かどうかを示します。チューニング可能なハイパーパラメータは、ハイパーパラメータ最適化 (HPO) 中にその値を決定できます。

## 内容
<a name="API_DefaultCategoricalHyperParameterRange_Contents"></a>

 ** isTunable **   <a name="personalize-Type-DefaultCategoricalHyperParameterRange-isTunable"></a>
ハイパーパラメータがチューニング可能かどうか。  
型: ブール値  
必須: いいえ

 ** name **   <a name="personalize-Type-DefaultCategoricalHyperParameterRange-name"></a>
ハイパーパラメータの名前。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

 ** values **   <a name="personalize-Type-DefaultCategoricalHyperParameterRange-values"></a>
ハイパーパラメータのカテゴリのリスト。  
型: 文字列の配列  
配列メンバー: 最大数は 100 項目です。  
長さの制限: 最大長は 1,000 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_DefaultCategoricalHyperParameterRange_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DefaultCategoricalHyperParameterRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DefaultCategoricalHyperParameterRange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DefaultCategoricalHyperParameterRange) 

# DefaultContinuousHyperParameterRange
<a name="API_DefaultContinuousHyperParameterRange"></a>

連続ハイパーパラメータの名前とデフォルトの範囲、およびハイパーパラメータがチューニング可能かどうかを示します。チューニング可能なハイパーパラメータは、ハイパーパラメータ最適化 (HPO) 中にその値を決定できます。

## 内容
<a name="API_DefaultContinuousHyperParameterRange_Contents"></a>

 ** isTunable **   <a name="personalize-Type-DefaultContinuousHyperParameterRange-isTunable"></a>
ハイパーパラメータがチューニング可能かどうか。  
型: ブール値  
必須: いいえ

 ** maxValue **   <a name="personalize-Type-DefaultContinuousHyperParameterRange-maxValue"></a>
ハイパーパラメータの最大許容値。  
型: 倍精度浮動小数点数  
値の範囲: 最小値 は -1000000 です。  
必須: いいえ

 ** minValue **   <a name="personalize-Type-DefaultContinuousHyperParameterRange-minValue"></a>
ハイパーパラメータの最小許容値。  
型: 倍精度浮動小数点数  
値の範囲: 最小値 は -1000000 です。  
必須: いいえ

 ** name **   <a name="personalize-Type-DefaultContinuousHyperParameterRange-name"></a>
ハイパーパラメータの名前。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_DefaultContinuousHyperParameterRange_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DefaultContinuousHyperParameterRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DefaultContinuousHyperParameterRange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DefaultContinuousHyperParameterRange) 

# DefaultHyperParameterRanges
<a name="API_DefaultHyperParameterRanges"></a>

ハイパーパラメータとそのデフォルトの範囲を指定します。ハイパーパラメータのタイプは、カテゴリ別、継続的、または整数値のいずれかです。

## 内容
<a name="API_DefaultHyperParameterRanges_Contents"></a>

 ** categoricalHyperParameterRanges **   <a name="personalize-Type-DefaultHyperParameterRanges-categoricalHyperParameterRanges"></a>
カテゴリハイパーパラメータとそのデフォルトの範囲。  
タイプ: [DefaultCategoricalHyperParameterRange](API_DefaultCategoricalHyperParameterRange.md) オブジェクトの配列  
配列メンバー: 最大数は 100 項目です。  
必須: いいえ

 ** continuousHyperParameterRanges **   <a name="personalize-Type-DefaultHyperParameterRanges-continuousHyperParameterRanges"></a>
連続ハイパーパラメータとそのデフォルトの範囲。  
タイプ: [DefaultContinuousHyperParameterRange](API_DefaultContinuousHyperParameterRange.md) オブジェクトの配列  
配列メンバー: 最大数は 100 項目です。  
必須: いいえ

 ** integerHyperParameterRanges **   <a name="personalize-Type-DefaultHyperParameterRanges-integerHyperParameterRanges"></a>
整数値のハイパーパラメータとそのデフォルトの範囲。  
タイプ: [DefaultIntegerHyperParameterRange](API_DefaultIntegerHyperParameterRange.md) オブジェクトの配列  
配列メンバー: 最大数は 100 項目です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_DefaultHyperParameterRanges_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DefaultHyperParameterRanges) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DefaultHyperParameterRanges) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DefaultHyperParameterRanges) 

# DefaultIntegerHyperParameterRange
<a name="API_DefaultIntegerHyperParameterRange"></a>

整数値のハイパーパラメータの名前とデフォルトの範囲、およびハイパーパラメータがチューニング可能かどうかを示します。チューニング可能なハイパーパラメータは、ハイパーパラメータ最適化 (HPO) 中にその値を決定できます。

## 内容
<a name="API_DefaultIntegerHyperParameterRange_Contents"></a>

 ** isTunable **   <a name="personalize-Type-DefaultIntegerHyperParameterRange-isTunable"></a>
ハイパーパラメータがチューニング可能かどうかを示します。  
型: ブール値  
必須: いいえ

 ** maxValue **   <a name="personalize-Type-DefaultIntegerHyperParameterRange-maxValue"></a>
ハイパーパラメータの最大許容値。  
タイプ: 整数  
有効な範囲: 最大値は 1000000 です。  
必須: いいえ

 ** minValue **   <a name="personalize-Type-DefaultIntegerHyperParameterRange-minValue"></a>
ハイパーパラメータの最小許容値。  
タイプ: 整数  
値の範囲: 最小値 は -1000000 です。  
必須: いいえ

 ** name **   <a name="personalize-Type-DefaultIntegerHyperParameterRange-name"></a>
ハイパーパラメータの名前。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_DefaultIntegerHyperParameterRange_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DefaultIntegerHyperParameterRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DefaultIntegerHyperParameterRange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DefaultIntegerHyperParameterRange) 

# EventParameters
<a name="API_EventParameters"></a>

ソリューションの作成に使用されるイベントのパラメータについて説明します。

## 内容
<a name="API_EventParameters_Contents"></a>

 ** eventType **   <a name="personalize-Type-EventParameters-eventType"></a>
ソリューションの作成で検討対象となるイベントタイプの名前。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

 ** eventValueThreshold **   <a name="personalize-Type-EventParameters-eventValueThreshold"></a>
イベントタイプのしきい値。このしきい値以上の値を持つイベントのみが、ソリューションの作成で検討対象となります。  
型: 倍精度浮動小数点数  
必須: いいえ

 ** weight **   <a name="personalize-Type-EventParameters-weight"></a>
イベントタイプの重み。重みが大きいほど、作成されたソリューションのイベントタイプの重要度が高くなります。  
型: 倍精度浮動小数点数  
有効範囲: 最小値 は 0 です。最大値は 1 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_EventParameters_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/EventParameters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/EventParameters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/EventParameters) 

# EventsConfig
<a name="API_EventsConfig"></a>

ソリューションの作成に使用されるイベントの設定について説明します。

## 内容
<a name="API_EventsConfig_Contents"></a>

 ** eventParametersList **   <a name="personalize-Type-EventsConfig-eventParametersList"></a>
イベントパラメータのリスト。イベントタイプと、そのイベント値のしきい値と重みが含まれます。  
タイプ: [EventParameters](API_EventParameters.md) オブジェクトの配列  
配列メンバー: 最大数は 10 項目です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_EventsConfig_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/EventsConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/EventsConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/EventsConfig) 

# EventTracker
<a name="API_EventTracker"></a>

イベントトラッカーに関する情報を提供します。

## 内容
<a name="API_EventTracker_Contents"></a>

 ** accountId **   <a name="personalize-Type-EventTracker-accountId"></a>
イベントトラッカーを所有する AWS アカウント。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

 ** creationDateTime **   <a name="personalize-Type-EventTracker-creationDateTime"></a>
イベントトラッカーの作成日時 (Unix 形式)。  
型: タイムスタンプ  
必須: いいえ

 ** datasetGroupArn **   <a name="personalize-Type-EventTracker-datasetGroupArn"></a>
イベントデータを受け取るデータセットグループの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** eventTrackerArn **   <a name="personalize-Type-EventTracker-eventTrackerArn"></a>
イベントトラッカーの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** lastUpdatedDateTime **   <a name="personalize-Type-EventTracker-lastUpdatedDateTime"></a>
イベントトラッカーの最終更新日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** name **   <a name="personalize-Type-EventTracker-name"></a>
イベントトラッカーの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: いいえ

 ** status **   <a name="personalize-Type-EventTracker-status"></a>
イベントトラッカーのステータス。  
イベントトラッカーは、次に示す状態のいずれかになります。  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -または- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

 ** trackingId **   <a name="personalize-Type-EventTracker-trackingId"></a>
イベントトラッカーの ID。この ID を [PutEvents](https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html) API へのリクエストに含めます。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_EventTracker_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/EventTracker) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/EventTracker) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/EventTracker) 

# EventTrackerSummary
<a name="API_EventTrackerSummary"></a>

イベントトラッカーのプロパティの概要を提供します。詳細なリストについては、[DescribeEventTracker](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeEventTracker.html) API を呼び出してください。

## 内容
<a name="API_EventTrackerSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-EventTrackerSummary-creationDateTime"></a>
イベントトラッカーの作成日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** eventTrackerArn **   <a name="personalize-Type-EventTrackerSummary-eventTrackerArn"></a>
イベントトラッカーの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** lastUpdatedDateTime **   <a name="personalize-Type-EventTrackerSummary-lastUpdatedDateTime"></a>
イベントトラッカーの最終更新日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** name **   <a name="personalize-Type-EventTrackerSummary-name"></a>
イベントトラッカーの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: いいえ

 ** status **   <a name="personalize-Type-EventTrackerSummary-status"></a>
イベントトラッカーのステータス。  
イベントトラッカーは、次に示す状態のいずれかになります。  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -または- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_EventTrackerSummary_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/EventTrackerSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/EventTrackerSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/EventTrackerSummary) 

# FeatureTransformation
<a name="API_FeatureTransformation"></a>

特徴変換に関する情報を提供します。機能変換は、raw 入力データを変更してモデルトレーニングにより適した形式にするプロセスです。

## 内容
<a name="API_FeatureTransformation_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-FeatureTransformation-creationDateTime"></a>
特徴変換の作成日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** defaultParameters **   <a name="personalize-Type-FeatureTransformation-defaultParameters"></a>
特徴変換のデフォルトパラメータを提供します。  
型: 文字列間のマッピング  
マップエントリ: アイテムの最大数は 100 です。  
キーの長さの制限: 最大長は 256 です。  
値の長さの制限: 最大長は 1000 です。  
必須: いいえ

 ** featureTransformationArn **   <a name="personalize-Type-FeatureTransformation-featureTransformationArn"></a>
FeatureTransformation オブジェクトの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** lastUpdatedDateTime **   <a name="personalize-Type-FeatureTransformation-lastUpdatedDateTime"></a>
特徴変換の最終更新日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** name **   <a name="personalize-Type-FeatureTransformation-name"></a>
特徴変換の名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: いいえ

 ** status **   <a name="personalize-Type-FeatureTransformation-status"></a>
特徴変換のステータス。  
特徴変換は、次のいずれかの状態になります。  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -または- CREATE FAILED
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_FeatureTransformation_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/FeatureTransformation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/FeatureTransformation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/FeatureTransformation) 

# FieldsForThemeGeneration
<a name="API_FieldsForThemeGeneration"></a>

テーマ生成の設定の詳細の文字列から文字列へのマップ。

## 内容
<a name="API_FieldsForThemeGeneration_Contents"></a>

 ** itemName **   <a name="personalize-Type-FieldsForThemeGeneration-itemName"></a>
データセット内の各アイテムの名前を保存するアイテムデータセット列の名前。  
タイプ: 文字列  
長さの制限: 最大長は 1,024 です。  
パターン: `[A-Za-z_][A-Za-z\d_]*`   
必須: はい

## 以下の資料も参照してください。
<a name="API_FieldsForThemeGeneration_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/FieldsForThemeGeneration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/FieldsForThemeGeneration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/FieldsForThemeGeneration) 

# Filter
<a name="API_Filter"></a>

ARN、ステータス、フィルター式など、レコメンデーションフィルターに関する情報が含まれます。

## 内容
<a name="API_Filter_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-Filter-creationDateTime"></a>
フィルターが作成された時刻。  
型: タイムスタンプ  
必須: いいえ

 ** datasetGroupArn **   <a name="personalize-Type-Filter-datasetGroupArn"></a>
フィルターが属するデータセットグループの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** failureReason **   <a name="personalize-Type-Filter-failureReason"></a>
フィルターが失敗した場合、その失敗の理由。  
タイプ: 文字列  
必須: いいえ

 ** filterArn **   <a name="personalize-Type-Filter-filterArn"></a>
フィルターの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** filterExpression **   <a name="personalize-Type-Filter-filterExpression"></a>
レコメンデーションの結果から除外するアイテムのインタラクションのタイプを指定します。フィルター式は、特定のフォーマットルールに従う必要があります。フィルター式の構造と構文については、「[フィルター式](https://docs.aws.amazon.com/personalize/latest/dg/filter-expressions.html)」を参照してください。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 2500 です。  
必須: いいえ

 ** lastUpdatedDateTime **   <a name="personalize-Type-Filter-lastUpdatedDateTime"></a>
フィルターが最後に更新された時刻。  
型: タイムスタンプ  
必須: いいえ

 ** name **   <a name="personalize-Type-Filter-name"></a>
フィルターの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: いいえ

 ** status **   <a name="personalize-Type-Filter-status"></a>
フィルターのステータス。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_Filter_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Filter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/Filter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/Filter) 

# FilterSummary
<a name="API_FilterSummary"></a>

フィルターの属性の簡単な概要。

## 内容
<a name="API_FilterSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-FilterSummary-creationDateTime"></a>
フィルターが作成された時刻。  
型: タイムスタンプ  
必須: いいえ

 ** datasetGroupArn **   <a name="personalize-Type-FilterSummary-datasetGroupArn"></a>
フィルターが属するデータセットグループの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** failureReason **   <a name="personalize-Type-FilterSummary-failureReason"></a>
フィルターが失敗した場合、失敗の理由。  
タイプ: 文字列  
必須: いいえ

 ** filterArn **   <a name="personalize-Type-FilterSummary-filterArn"></a>
フィルターの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** lastUpdatedDateTime **   <a name="personalize-Type-FilterSummary-lastUpdatedDateTime"></a>
フィルターが最後に更新された時刻。  
型: タイムスタンプ  
必須: いいえ

 ** name **   <a name="personalize-Type-FilterSummary-name"></a>
フィルターの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: いいえ

 ** status **   <a name="personalize-Type-FilterSummary-status"></a>
フィルターのステータス。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_FilterSummary_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/FilterSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/FilterSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/FilterSummary) 

# HPOConfig
<a name="API_HPOConfig"></a>

ハイパーパラメータ最適化 (HPO) のプロパティを記述します。

## 内容
<a name="API_HPOConfig_Contents"></a>

 ** algorithmHyperParameterRanges **   <a name="personalize-Type-HPOConfig-algorithmHyperParameterRanges"></a>
ハイパーパラメータとその許容範囲。  
型: [HyperParameterRanges](API_HyperParameterRanges.md) オブジェクト  
必須: いいえ

 ** hpoObjective **   <a name="personalize-Type-HPOConfig-hpoObjective"></a>
HPO 中に最適化するメトリクス。  
現時点では、Amazon Personalize は `hpoObjective` の設定をサポートしていません。
型: [HPOObjective](API_HPOObjective.md) オブジェクト  
必須: いいえ

 ** hpoResourceConfig **   <a name="personalize-Type-HPOConfig-hpoResourceConfig"></a>
HPO のリソース設定を記述します。  
型: [HPOResourceConfig](API_HPOResourceConfig.md) オブジェクト  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_HPOConfig_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/HPOConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/HPOConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/HPOConfig) 

# HPOObjective
<a name="API_HPOObjective"></a>

ハイパーパラメータ最適化 (HPO) 中に最適化するメトリクス。

**注記**  
現時点では、Amazon Personalize は `hpoObjective` の設定をサポートしていません。

## 内容
<a name="API_HPOObjective_Contents"></a>

 ** metricName **   <a name="personalize-Type-HPOObjective-metricName"></a>
メトリクスの名前。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

 ** metricRegex **   <a name="personalize-Type-HPOObjective-metricRegex"></a>
トレーニングジョブのログでメトリクスを見つけるための正規表現。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

 ** type **   <a name="personalize-Type-HPOObjective-type"></a>
メトリクスのタイプ。有効な値は、`Maximize` および `Minimize` です。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_HPOObjective_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/HPOObjective) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/HPOObjective) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/HPOObjective) 

# HPOResourceConfig
<a name="API_HPOResourceConfig"></a>

ハイパーパラメータ最適化 (HPO) のリソース設定を記述します。

## 内容
<a name="API_HPOResourceConfig_Contents"></a>

 ** maxNumberOfTrainingJobs **   <a name="personalize-Type-HPOResourceConfig-maxNumberOfTrainingJobs"></a>
ソリューションバージョンを作成するときのトレーニングジョブの最大数。`maxNumberOfTrainingJobs` の最大値は `40` です。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

 ** maxParallelTrainingJobs **   <a name="personalize-Type-HPOResourceConfig-maxParallelTrainingJobs"></a>
ソリューションバージョンを作成するときの並列トレーニングジョブの最大数。`maxParallelTrainingJobs` の最大値は `10` です。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_HPOResourceConfig_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/HPOResourceConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/HPOResourceConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/HPOResourceConfig) 

# HyperParameterRanges
<a name="API_HyperParameterRanges"></a>

ハイパーパラメータとその範囲を指定します。ハイパーパラメータのタイプは、カテゴリ別、継続的、または整数値のいずれかです。

## 内容
<a name="API_HyperParameterRanges_Contents"></a>

 ** categoricalHyperParameterRanges **   <a name="personalize-Type-HyperParameterRanges-categoricalHyperParameterRanges"></a>
カテゴリハイパーパラメータとその範囲。  
タイプ: [CategoricalHyperParameterRange](API_CategoricalHyperParameterRange.md) オブジェクトの配列  
配列メンバー: 最大数は 100 項目です。  
必須: いいえ

 ** continuousHyperParameterRanges **   <a name="personalize-Type-HyperParameterRanges-continuousHyperParameterRanges"></a>
連続ハイパーパラメータとその範囲。  
タイプ: [ContinuousHyperParameterRange](API_ContinuousHyperParameterRange.md) オブジェクトの配列  
配列メンバー: 最大数は 100 項目です。  
必須: いいえ

 ** integerHyperParameterRanges **   <a name="personalize-Type-HyperParameterRanges-integerHyperParameterRanges"></a>
整数値のハイパーパラメータとその範囲。  
タイプ: [IntegerHyperParameterRange](API_IntegerHyperParameterRange.md) オブジェクトの配列  
配列メンバー: 最大数は 100 項目です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_HyperParameterRanges_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/HyperParameterRanges) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/HyperParameterRanges) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/HyperParameterRanges) 

# IntegerHyperParameterRange
<a name="API_IntegerHyperParameterRange"></a>

整数値のハイパーパラメータの名前と範囲を指定します。

## 内容
<a name="API_IntegerHyperParameterRange_Contents"></a>

 ** maxValue **   <a name="personalize-Type-IntegerHyperParameterRange-maxValue"></a>
ハイパーパラメータの最大許容値。  
タイプ: 整数  
有効な範囲: 最大値は 1000000 です。  
必須: いいえ

 ** minValue **   <a name="personalize-Type-IntegerHyperParameterRange-minValue"></a>
ハイパーパラメータの最小許容値。  
タイプ: 整数  
値の範囲: 最小値 は -1000000 です。  
必須: いいえ

 ** name **   <a name="personalize-Type-IntegerHyperParameterRange-name"></a>
ハイパーパラメータの名前。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_IntegerHyperParameterRange_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/IntegerHyperParameterRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/IntegerHyperParameterRange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/IntegerHyperParameterRange) 

# MetricAttribute
<a name="API_MetricAttribute"></a>

メトリクス属性のレポート対象となるメトリクスに関する情報が含まれます。詳細については、「[レコメンデーションの影響の測定](https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html)」を参照してください。

## 内容
<a name="API_MetricAttribute_Contents"></a>

 ** eventType **   <a name="personalize-Type-MetricAttribute-eventType"></a>
メトリクスのイベントタイプ。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: はい

 ** expression **   <a name="personalize-Type-MetricAttribute-expression"></a>
属性の式。使用できるオプションは、`SUM()` または `SAMPLECOUNT()` です。SUM() 関数では、データセットのタイプ (インタラクションまたはアイテム) と合計する列をパラメーターとして指定します。例えば、SUM(Items.PRICE) などです。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: はい

 ** metricName **   <a name="personalize-Type-MetricAttribute-metricName"></a>
メトリクスの名前。この名前は、Amazon CloudWatch または Amazon S3 のメトリクスを特定するのに役立ちます。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: はい

## 以下の資料も参照してください。
<a name="API_MetricAttribute_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/MetricAttribute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/MetricAttribute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/MetricAttribute) 

# MetricAttribution
<a name="API_MetricAttribution"></a>

メトリクス属性に関する情報が含まれます。メトリクス属性は、Amazon Personalize にインポートしたデータに関するレポートを作成します。データをインポートする方法に応じて Amazon CloudWatch または Amazon S3 でレポートを表示できます。詳細については、「[レコメンデーションの影響の測定](https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html)」を参照してください。

## 内容
<a name="API_MetricAttribution_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-MetricAttribution-creationDateTime"></a>
メトリクス属性の作成日時。  
型: タイムスタンプ  
必須: いいえ

 ** datasetGroupArn **   <a name="personalize-Type-MetricAttribution-datasetGroupArn"></a>
メトリクス属性のデータセットグループの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** failureReason **   <a name="personalize-Type-MetricAttribution-failureReason"></a>
メトリクス属性の失敗理由。  
タイプ: 文字列  
必須: いいえ

 ** lastUpdatedDateTime **   <a name="personalize-Type-MetricAttribution-lastUpdatedDateTime"></a>
メトリクス属性の最終更新日時。  
型: タイムスタンプ  
必須: いいえ

 ** metricAttributionArn **   <a name="personalize-Type-MetricAttribution-metricAttributionArn"></a>
メトリクス属性の Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** metricsOutputConfig **   <a name="personalize-Type-MetricAttribution-metricsOutputConfig"></a>
メトリクス属性の出力設定。  
型: [MetricAttributionOutput](API_MetricAttributionOutput.md) オブジェクト  
必須: いいえ

 ** name **   <a name="personalize-Type-MetricAttribution-name"></a>
メトリクス属性の名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: いいえ

 ** status **   <a name="personalize-Type-MetricAttribution-status"></a>
メトリクス属性のステータス。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_MetricAttribution_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/MetricAttribution) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/MetricAttribution) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/MetricAttribution) 

# MetricAttributionOutput
<a name="API_MetricAttributionOutput"></a>

メトリクス属性の出力設定の詳細。

## 内容
<a name="API_MetricAttributionOutput_Contents"></a>

 ** roleArn **   <a name="personalize-Type-MetricAttributionOutput-roleArn"></a>
出力 Amazon S3 バケットにデータを追加し、Amazon CloudWatch にメトリクスを追加するためのアクセス許可を持つ IAM サービスロールの Amazon リソースネーム (ARN)。詳細については、「[レコメンデーションの影響の測定](https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html)」を参照してください。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`   
必須: はい

 ** s3DataDestination **   <a name="personalize-Type-MetricAttributionOutput-s3DataDestination"></a>
Amazon S3 の入力または出力バケットの設定の詳細。  
型: [S3DataConfig](API_S3DataConfig.md) オブジェクト  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_MetricAttributionOutput_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/MetricAttributionOutput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/MetricAttributionOutput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/MetricAttributionOutput) 

# MetricAttributionSummary
<a name="API_MetricAttributionSummary"></a>

メトリクス属性のプロパティの概要を提供します。詳細なリストについては、[DescribeMetricAttribution](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeMetricAttribution.html) を呼び出してください。

## 内容
<a name="API_MetricAttributionSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-MetricAttributionSummary-creationDateTime"></a>
メトリクス属性の作成日時。  
型: タイムスタンプ  
必須: いいえ

 ** failureReason **   <a name="personalize-Type-MetricAttributionSummary-failureReason"></a>
メトリクス属性の失敗理由。  
タイプ: 文字列  
必須: いいえ

 ** lastUpdatedDateTime **   <a name="personalize-Type-MetricAttributionSummary-lastUpdatedDateTime"></a>
メトリクス属性の最終更新日時。  
型: タイムスタンプ  
必須: いいえ

 ** metricAttributionArn **   <a name="personalize-Type-MetricAttributionSummary-metricAttributionArn"></a>
メトリクス属性の Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** name **   <a name="personalize-Type-MetricAttributionSummary-name"></a>
メトリクス属性の名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: いいえ

 ** status **   <a name="personalize-Type-MetricAttributionSummary-status"></a>
メトリクス属性のステータス。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_MetricAttributionSummary_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/MetricAttributionSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/MetricAttributionSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/MetricAttributionSummary) 

# OptimizationObjective
<a name="API_OptimizationObjective"></a>

ストリーミング時間 (分) の最大化や収益の増加など、ソリューションの追加の目的を記述します。詳細については、「[ソリューションの最適化](https://docs.aws.amazon.com/personalize/latest/dg/optimizing-solution-for-objective.html)」を参照してください。

## 内容
<a name="API_OptimizationObjective_Contents"></a>

 ** itemAttribute **   <a name="personalize-Type-OptimizationObjective-itemAttribute"></a>
最適化の目標に関連する Items データセットの数値メタデータ列。例えば、VIDEO\$1LENGTH (ストリーミング (分) を最大化するため) または PRICE (収益を最大化するため) です。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 150 です。  
必須: いいえ

 ** objectiveSensitivity **   <a name="personalize-Type-OptimizationObjective-objectiveSensitivity"></a>
Amazon Personalize が最適化の目的の重要性と関連性のバランスをどのように取るかを指定します。  
型: 文字列  
有効な値：`LOW | MEDIUM | HIGH | OFF`  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_OptimizationObjective_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/OptimizationObjective) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/OptimizationObjective) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/OptimizationObjective) 

# Recipe
<a name="API_Recipe"></a>

レシピに関する情報を提供します。各レシピは、[CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) 操作を使用するときに Amazon Personalize がモデルトレーニングで使用するアルゴリズムを提供します。

## 内容
<a name="API_Recipe_Contents"></a>

 ** algorithmArn **   <a name="personalize-Type-Recipe-algorithmArn"></a>
Amazon Personalize がモデルをトレーニングするために使用するアルゴリズムの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** creationDateTime **   <a name="personalize-Type-Recipe-creationDateTime"></a>
レシピの作成日時 (Unix 形式)。  
型: タイムスタンプ  
必須: いいえ

 ** description **   <a name="personalize-Type-Recipe-description"></a>
recipe の説明。  
タイプ: 文字列  
必須: いいえ

 ** featureTransformationArn **   <a name="personalize-Type-Recipe-featureTransformationArn"></a>
FeatureTransformation オブジェクトの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** lastUpdatedDateTime **   <a name="personalize-Type-Recipe-lastUpdatedDateTime"></a>
レシピの最終更新日時 (Unix 形式)。  
型: タイムスタンプ  
必須: いいえ

 ** name **   <a name="personalize-Type-Recipe-name"></a>
レシピの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: いいえ

 ** recipeArn **   <a name="personalize-Type-Recipe-recipeArn"></a>
レシピの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** recipeType **   <a name="personalize-Type-Recipe-recipeType"></a>
次のいずれかの値になります。  
+ PERSONALIZED\$1RANKING
+ RELATED\$1ITEMS
+ USER\$1PERSONALIZATION
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

 ** status **   <a name="personalize-Type-Recipe-status"></a>
レシピのステータス。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_Recipe_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Recipe) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/Recipe) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/Recipe) 

# RecipeSummary
<a name="API_RecipeSummary"></a>

レシピのプロパティの概要を提供します。詳細なリストについては、[DescribeRecipe](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecipe.html) API を呼び出してください。

## 内容
<a name="API_RecipeSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-RecipeSummary-creationDateTime"></a>
レシピの作成日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** domain **   <a name="personalize-Type-RecipeSummary-domain"></a>
レシピのドメイン (レシピがドメインデータセットグループのユースケースの場合)。  
型: 文字列  
有効な値：`ECOMMERCE | VIDEO_ON_DEMAND`  
必須：いいえ

 ** lastUpdatedDateTime **   <a name="personalize-Type-RecipeSummary-lastUpdatedDateTime"></a>
レシピが最後に更新された日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** name **   <a name="personalize-Type-RecipeSummary-name"></a>
レシピの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: いいえ

 ** recipeArn **   <a name="personalize-Type-RecipeSummary-recipeArn"></a>
レシピの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** status **   <a name="personalize-Type-RecipeSummary-status"></a>
レシピのステータス。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_RecipeSummary_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/RecipeSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/RecipeSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/RecipeSummary) 

# Recommender
<a name="API_Recommender"></a>

ドメインデータセットグループのレコメンデーションジェネレーターを記述します。特定のドメインユースケース (ドメインレシピ) のドメインデータセットグループにレコメンダーを作成し、[GetRecommendations](https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) リクエストでレコメンダーを指定します。

## 内容
<a name="API_Recommender_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-Recommender-creationDateTime"></a>
レコメンダーの作成日時 (Unix 形式)。  
型: タイムスタンプ  
必須: いいえ

 ** datasetGroupArn **   <a name="personalize-Type-Recommender-datasetGroupArn"></a>
レコメンダーを含むドメインデータセットグループの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** failureReason **   <a name="personalize-Type-Recommender-failureReason"></a>
レコメンダーが失敗した場合、失敗の理由。  
タイプ: 文字列  
必須: いいえ

 ** lastUpdatedDateTime **   <a name="personalize-Type-Recommender-lastUpdatedDateTime"></a>
レコメンダーの最終更新日時 (Unix 形式)。  
型: タイムスタンプ  
必須: いいえ

 ** latestRecommenderUpdate **   <a name="personalize-Type-Recommender-latestRecommenderUpdate"></a>
レコメンダーに対する最新の更新の概要を提供します。  
型: [RecommenderUpdateSummary](API_RecommenderUpdateSummary.md) オブジェクト  
必須: いいえ

 ** modelMetrics **   <a name="personalize-Type-Recommender-modelMetrics"></a>
レコメンダーのパフォーマンスを判断するのに役立つ評価メトリクスを提供します。詳細については、「[レコメンダーの評価](https://docs.aws.amazon.com/personalize/latest/dg/evaluating-recommenders.html)」を参照してください。  
タイプ: ダブルマップへの文字列。  
マップエントリ: アイテムの最大数は 100 です。  
キーの長さの制限: 最大長は 256 です。  
必須: いいえ

 ** name **   <a name="personalize-Type-Recommender-name"></a>
レコメンダーの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: いいえ

 ** recipeArn **   <a name="personalize-Type-Recommender-recipeArn"></a>
レコメンダーが作成されたレシピ (ドメインデータセットグループのユースケース) の Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** recommenderArn **   <a name="personalize-Type-Recommender-recommenderArn"></a>
レコメンダーの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** recommenderConfig **   <a name="personalize-Type-Recommender-recommenderConfig"></a>
レコメンダーの設定の詳細。  
型: [RecommenderConfig](API_RecommenderConfig.md) オブジェクト  
必須: いいえ

 ** status **   <a name="personalize-Type-Recommender-status"></a>
レコメンダーのステータス。  
レコメンダーは、次に示す状態のいずれかになります。  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -または- CREATE FAILED
+ STOP PENDING > STOP IN\$1PROGRESS > INACTIVE > START PENDING > START IN\$1PROGRESS > ACTIVE
+ DELETE PENDING > DELETE IN\$1PROGRESS
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_Recommender_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Recommender) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/Recommender) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/Recommender) 

# RecommenderConfig
<a name="API_RecommenderConfig"></a>

レコメンダーの設定の詳細。

## 内容
<a name="API_RecommenderConfig_Contents"></a>

 ** enableMetadataWithRecommendations **   <a name="personalize-Type-RecommenderConfig-enableMetadataWithRecommendations"></a>
レコメンデーション付きのメタデータがレコメンダーに対して有効になっているかどうか。有効にすると、レコメンデーションのリクエストでアイテムデータセットの列を指定できます。Amazon Personalize は、レコメンデーションレスポンス内の各アイテムについてこのデータを返します。レコメンダーのメタデータを有効にする方法については、「[Enabling metadata in recommendations for a recommender](https://docs.aws.amazon.com/personalize/latest/dg/creating-recommenders.html#create-recommender-return-metadata)」を参照してください。  
 レコメンデーションのメタデータを有効にすると、追加費用が発生します。詳細については、「[Amazon Personalize の料金](https://aws.amazon.com/personalize/pricing/)」を参照してください。  
型: ブール値  
必須: いいえ

 ** itemExplorationConfig **   <a name="personalize-Type-RecommenderConfig-itemExplorationConfig"></a>
`explorationWeight` と `explorationItemAgeCutOff` を含む探索設定ハイパーパラメータ (Amazon Personalize がアイテムを推奨するときに使用するアイテム探索の量を設定するために使用するもの) を指定します。レコメンダーがユーザー向けにパーソナライズされたレコメンデーションを生成する場合にのみ `itemExplorationConfig` データを提供します (人気のあるアイテムや類似アイテムではありません)。  
型: 文字列間のマッピング  
マップエントリ: アイテムの最大数は 100 です。  
キーの長さの制限: 最大長は 256 です。  
値の長さの制限: 最大長は 1000 です。  
必須: いいえ

 ** minRecommendationRequestsPerSecond **   <a name="personalize-Type-RecommenderConfig-minRecommendationRequestsPerSecond"></a>
Amazon Personalize がサポートする、リクエストされた 1 秒あたりの最小プロビジョンドトランザクション (推奨) を指定します。`minRecommendationRequestsPerSecond` の値を高く設定すると請求額が増加します。最初は `minRecommendationRequestsPerSecond` に 1 を使用することをお勧めします (デフォルト)。低い `minRecommendationRequestsPerSecond` から始めて、Amazon CloudWatch メトリクスを使用して使用状況を追跡し、必要に応じて を引き上げることをお勧めします。  
タイプ: 整数  
有効な範囲: 最小値 は 1 です。  
必須: いいえ

 ** trainingDataConfig **   <a name="personalize-Type-RecommenderConfig-trainingDataConfig"></a>
 ドメインレコメンダーを作成するときに使用するトレーニングデータ設定を指定します。  
型: [TrainingDataConfig](API_TrainingDataConfig.md) オブジェクト  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_RecommenderConfig_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/RecommenderConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/RecommenderConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/RecommenderConfig) 

# RecommenderSummary
<a name="API_RecommenderSummary"></a>

レコメンダーのプロパティの概要を提供します。

## 内容
<a name="API_RecommenderSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-RecommenderSummary-creationDateTime"></a>
レコメンダーの作成日時 (Unix 形式)。  
型: タイムスタンプ  
必須: いいえ

 ** datasetGroupArn **   <a name="personalize-Type-RecommenderSummary-datasetGroupArn"></a>
レコメンダーを含むドメインデータセットグループの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** lastUpdatedDateTime **   <a name="personalize-Type-RecommenderSummary-lastUpdatedDateTime"></a>
レコメンダーの最終更新日時 (Unix 形式)。  
型: タイムスタンプ  
必須: いいえ

 ** name **   <a name="personalize-Type-RecommenderSummary-name"></a>
レコメンダーの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: いいえ

 ** recipeArn **   <a name="personalize-Type-RecommenderSummary-recipeArn"></a>
レコメンダーが作成されたレシピ (ドメインデータセットグループのユースケース) の Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** recommenderArn **   <a name="personalize-Type-RecommenderSummary-recommenderArn"></a>
レコメンダーの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** recommenderConfig **   <a name="personalize-Type-RecommenderSummary-recommenderConfig"></a>
レコメンダーの設定の詳細。  
型: [RecommenderConfig](API_RecommenderConfig.md) オブジェクト  
必須: いいえ

 ** status **   <a name="personalize-Type-RecommenderSummary-status"></a>
レコメンダーのステータス。レコメンダーは、次に示す状態のいずれかになります。  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -または- CREATE FAILED
+ STOP PENDING > STOP IN\$1PROGRESS > INACTIVE > START PENDING > START IN\$1PROGRESS > ACTIVE
+ DELETE PENDING > DELETE IN\$1PROGRESS
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_RecommenderSummary_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/RecommenderSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/RecommenderSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/RecommenderSummary) 

# RecommenderUpdateSummary
<a name="API_RecommenderUpdateSummary"></a>

レコメンダーの更新のプロパティの概要を提供します。詳細なリストについては、[DescribeRecommender](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html) API を呼び出してください。

## 内容
<a name="API_RecommenderUpdateSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-RecommenderUpdateSummary-creationDateTime"></a>
レコメンダーの更新の作成日時 (Unix 形式)。  
型: タイムスタンプ  
必須: いいえ

 ** failureReason **   <a name="personalize-Type-RecommenderUpdateSummary-failureReason"></a>
レコメンダーの更新が失敗した場合、失敗の理由。  
タイプ: 文字列  
必須: いいえ

 ** lastUpdatedDateTime **   <a name="personalize-Type-RecommenderUpdateSummary-lastUpdatedDateTime"></a>
レコメンダーの更新の最終更新日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** recommenderConfig **   <a name="personalize-Type-RecommenderUpdateSummary-recommenderConfig"></a>
レコメンダーの更新の設定の詳細。  
型: [RecommenderConfig](API_RecommenderConfig.md) オブジェクト  
必須: いいえ

 ** status **   <a name="personalize-Type-RecommenderUpdateSummary-status"></a>
レコメンダーの更新のステータス。レコメンダーの更新は、次に示す状態のいずれかになります。  
CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -または- CREATE FAILED  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_RecommenderUpdateSummary_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/RecommenderUpdateSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/RecommenderUpdateSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/RecommenderUpdateSummary) 

# S3DataConfig
<a name="API_S3DataConfig"></a>

Amazon S3 の入力または出力バケットの設定の詳細。

## 内容
<a name="API_S3DataConfig_Contents"></a>

 ** path **   <a name="personalize-Type-S3DataConfig-path"></a>
Amazon S3 バケットのファイルパス。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `(s3|http|https)://.+`   
必須: はい

 ** kmsKeyArn **   <a name="personalize-Type-S3DataConfig-kmsKeyArn"></a>
Amazon Personalize が入力ファイルと出力ファイルを暗号化または復号するために使用する AWS Key Management Service (KMS) キーの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 2,048 です。  
パターン: `arn:aws.*:kms:.*:[0-9]{12}:key/.*`   
必須: いいえ

## 以下の資料も参照してください。
<a name="API_S3DataConfig_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/S3DataConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/S3DataConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/S3DataConfig) 

# Solution
<a name="API_Solution"></a>

**重要**  
デフォルトでは、すべての新しいソリューションで自動トレーニングが使用されます。自動トレーニングでは、ソリューションがアクティブな間はトレーニングコストが発生します。不要なコストを避けるために、完了したら[ソリューションを更新](https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateSolution.html)して自動トレーニングを無効にすることができます。トレーニングのコストの詳細については、「[Amazon Personalize の料金](https://aws.amazon.com/personalize/pricing/)」を参照してください。

ソリューションに関する情報を提供するオブジェクト。ソリューションには、Amazon Personalize がレコメンデーションを生成するために使用する、カスタムレシピ、カスタマイズされたパラメータ、およびトレーニング済みモデル (ソリューションバージョン) が含まれます。

ソリューションを作成した後は、その設定を変更することはできません。変更を加える必要がある場合は、Amazon Personalize コンソールを使用して[ソリューションをクローン](https://docs.aws.amazon.com/personalize/latest/dg/cloning-solution.html)するか、新しいソリューションを作成できます。

## 内容
<a name="API_Solution_Contents"></a>

 ** autoMLResult **   <a name="personalize-Type-Solution-autoMLResult"></a>
`performAutoML` が true の場合、見つかった最適なレシピを指定します。  
型: [AutoMLResult](API_AutoMLResult.md) オブジェクト  
必須: いいえ

 ** creationDateTime **   <a name="personalize-Type-Solution-creationDateTime"></a>
ソリューションの作成日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** datasetGroupArn **   <a name="personalize-Type-Solution-datasetGroupArn"></a>
トレーニングデータを提供するデータセットグループの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** eventType **   <a name="personalize-Type-Solution-eventType"></a>
モデルのトレーニングに使用されるイベントタイプ (例えば、「クリック」または「いいね」)。`eventType` が指定されていない場合、Amazon Personalize は、タイプにかかわらず、同じ重みでトレーニングするためにすべてのインタラクションを使用します。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

 ** lastUpdatedDateTime **   <a name="personalize-Type-Solution-lastUpdatedDateTime"></a>
ソリューションの最終更新日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** latestSolutionUpdate **   <a name="personalize-Type-Solution-latestSolutionUpdate"></a>
ソリューションに対する最新の更新の概要を提供します。  
型: [SolutionUpdateSummary](API_SolutionUpdateSummary.md) オブジェクト  
必須: いいえ

 ** latestSolutionVersion **   <a name="personalize-Type-Solution-latestSolutionVersion"></a>
ステータスと ARN を含む、ソリューションの最新バージョンを記述します。  
型: [SolutionVersionSummary](API_SolutionVersionSummary.md) オブジェクト  
必須: いいえ

 ** name **   <a name="personalize-Type-Solution-name"></a>
ソリューションの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: いいえ

 ** performAutoML **   <a name="personalize-Type-Solution-performAutoML"></a>
自動機械学習の有効化は推奨されません。代わりに、利用可能な Amazon Personalize のレシピにユースケースをマッチさせます。詳細については、「[ユースケースの特定](https://docs.aws.amazon.com/personalize/latest/dg/determining-use-case.html)」を参照してください。
true の場合、Amazon Personalize は、ソリューション構成で指定されたリストから最適な USER\$1PERSONALIZATION recipe の検索を実行します (`recipeArn` を指定しないでください)。false (デフォルト) の場合、Amazon Personalize はトレーニングに `recipeArn` を使用します。  
タイプ: ブール値  
必須: いいえ

 ** performAutoTraining **   <a name="personalize-Type-Solution-performAutoTraining"></a>
ソリューションが自動的にソリューションバージョンを作成するかどうかを指定します。デフォルトは `True` で、ソリューションは 7 日ごとに新しいソリューションバージョンを自動的に作成します。  
自動トレーニングの詳細については、「[ソリューションの作成と構成](https://docs.aws.amazon.com/personalize/latest/dg/customizing-solution-config.html)」を参照してください。  
タイプ: ブール値  
必須: いいえ

 ** performHPO **   <a name="personalize-Type-Solution-performHPO"></a>
選択したレシピでハイパーパラメータ最適化 (HPO) を実行するかどうか。デフォルトは `false` です。  
タイプ: ブール値  
必須: いいえ

 ** performIncrementalUpdate **   <a name="personalize-Type-Solution-performIncrementalUpdate"></a>
モデルで増分トレーニング更新が実行されるかどうかを示すブール値。これにより、モデルは完全な再トレーニングを必要とせずに新しいデータからより頻繁に学習できるため、ほぼリアルタイムのパーソナライゼーションが可能になります。このパラメータは、セマンティック類似度レシピを使用するソリューションでのみサポートされます。  
タイプ: ブール値  
必須: いいえ

 ** recipeArn **   <a name="personalize-Type-Solution-recipeArn"></a>
ソリューションの作成に使用されたレシピの ARN。これは、`performAutoML` が false の場合に必要です。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** solutionArn **   <a name="personalize-Type-Solution-solutionArn"></a>
ソリューションの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** solutionConfig **   <a name="personalize-Type-Solution-solutionConfig"></a>
ソリューションの設定プロパティを記述します。  
型: [SolutionConfig](API_SolutionConfig.md) オブジェクト  
必須: いいえ

 ** status **   <a name="personalize-Type-Solution-status"></a>
ソリューションのステータス。  
ソリューションは、次に示す状態のいずれかになります。  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -または- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_Solution_SeeAlso"></a>

言語固有の AWSSDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWSSDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Solution) 
+  [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/Solution) 
+  [AWSSDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/Solution) 

# SolutionConfig
<a name="API_SolutionConfig"></a>

ソリューションの構成プロパティを記述します。

## 内容
<a name="API_SolutionConfig_Contents"></a>

 ** algorithmHyperParameters **   <a name="personalize-Type-SolutionConfig-algorithmHyperParameters"></a>
アルゴリズムのハイパーパラメータとその値を一覧表示します。  
型: 文字列間のマッピング  
マップエントリ: アイテムの最大数は 100 です。  
キーの長さの制限: 最大長は 256 です。  
値の長さの制限: 最大長は 1000 です。  
必須: いいえ

 ** autoMLConfig **   <a name="personalize-Type-SolutionConfig-autoMLConfig"></a>
AutoML の実行時に検索する recipe のリストを含む [AutoMLConfig](https://docs.aws.amazon.com/personalize/latest/dg/API_AutoMLConfig.html) オブジェクト。  
型: [AutoMLConfig](API_AutoMLConfig.md) オブジェクト  
必須: いいえ

 ** autoTrainingConfig **   <a name="personalize-Type-SolutionConfig-autoTrainingConfig"></a>
使用する自動トレーニング設定を指定します。  
型: [AutoTrainingConfig](API_AutoTrainingConfig.md) オブジェクト  
必須: いいえ

 ** eventsConfig **   <a name="personalize-Type-SolutionConfig-eventsConfig"></a>
イベントの設定について説明します。これにはイベントパラメータのリストが含まれます。最大 10 個のイベントパラメータを指定できます。イベントはソリューションの作成に使用されます。  
型: [EventsConfig](API_EventsConfig.md) オブジェクト  
必須: いいえ

 ** eventValueThreshold **   <a name="personalize-Type-SolutionConfig-eventValueThreshold"></a>
モデルのトレーニングには、このしきい値以上の値を持つイベントのみが使用されます。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

 ** featureTransformationParameters **   <a name="personalize-Type-SolutionConfig-featureTransformationParameters"></a>
特徴変換パラメータを一覧表示します。  
型: 文字列間のマッピング  
マップエントリ: アイテムの最大数は 100 です。  
キーの長さの制限: 最大長は 256 です。  
値の長さの制限: 最大長は 1000 です。  
必須: いいえ

 ** hpoConfig **   <a name="personalize-Type-SolutionConfig-hpoConfig"></a>
ハイパーパラメータ最適化 (HPO) のプロパティを記述します。  
型: [HPOConfig](API_HPOConfig.md) オブジェクト  
必須: いいえ

 ** optimizationObjective **   <a name="personalize-Type-SolutionConfig-optimizationObjective"></a>
ストリーミング時間 (分) の最大化や収益の増加など、ソリューションの追加の目的を記述します。詳細については、「[ソリューションの最適化](https://docs.aws.amazon.com/personalize/latest/dg/optimizing-solution-for-objective.html)」を参照してください。  
型: [OptimizationObjective](API_OptimizationObjective.md) オブジェクト  
必須: いいえ

 ** trainingDataConfig **   <a name="personalize-Type-SolutionConfig-trainingDataConfig"></a>
 カスタムソリューションバージョン (トレーニング済みモデル) を作成するときに使用するトレーニングデータ構成を指定します。  
型: [TrainingDataConfig](API_TrainingDataConfig.md) オブジェクト  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_SolutionConfig_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/SolutionConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/SolutionConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/SolutionConfig) 

# SolutionSummary
<a name="API_SolutionSummary"></a>

ソリューションのプロパティの概要を提供します。詳細なリストについては、[DescribeSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html) API を呼び出してください。

## 内容
<a name="API_SolutionSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-SolutionSummary-creationDateTime"></a>
ソリューションの作成日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** lastUpdatedDateTime **   <a name="personalize-Type-SolutionSummary-lastUpdatedDateTime"></a>
ソリューションの最終更新日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** name **   <a name="personalize-Type-SolutionSummary-name"></a>
ソリューションの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: いいえ

 ** recipeArn **   <a name="personalize-Type-SolutionSummary-recipeArn"></a>
ソリューションによって使用されるレシピの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** solutionArn **   <a name="personalize-Type-SolutionSummary-solutionArn"></a>
ソリューションの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** status **   <a name="personalize-Type-SolutionSummary-status"></a>
ソリューションのステータス。  
ソリューションは、次に示す状態のいずれかになります。  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -または- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_SolutionSummary_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/SolutionSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/SolutionSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/SolutionSummary) 

# SolutionUpdateConfig
<a name="API_SolutionUpdateConfig"></a>

ソリューション更新の設定の詳細。

## 内容
<a name="API_SolutionUpdateConfig_Contents"></a>

 ** autoTrainingConfig **   <a name="personalize-Type-SolutionUpdateConfig-autoTrainingConfig"></a>
`performAutoTraining` が true の場合に使用する自動トレーニング設定。  
型: [AutoTrainingConfig](API_AutoTrainingConfig.md) オブジェクト  
必須: いいえ

 ** eventsConfig **   <a name="personalize-Type-SolutionUpdateConfig-eventsConfig"></a>
イベントの設定について説明します。これにはイベントパラメータのリストが含まれます。最大 10 個のイベントパラメータを指定できます。イベントはソリューションの作成に使用されます。  
型: [EventsConfig](API_EventsConfig.md) オブジェクト  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_SolutionUpdateConfig_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/SolutionUpdateConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/SolutionUpdateConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/SolutionUpdateConfig) 

# SolutionUpdateSummary
<a name="API_SolutionUpdateSummary"></a>

ソリューションの更新のプロパティの概要を提供します。詳細なリストについては、[DescribeSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html) API を呼び出してください。

## 内容
<a name="API_SolutionUpdateSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-SolutionUpdateSummary-creationDateTime"></a>
ソリューションの更新の作成日時 (Unix 形式)。  
型: タイムスタンプ  
必須: いいえ

 ** failureReason **   <a name="personalize-Type-SolutionUpdateSummary-failureReason"></a>
ソリューションの更新が失敗した場合、失敗の理由。  
タイプ: 文字列  
必須: いいえ

 ** lastUpdatedDateTime **   <a name="personalize-Type-SolutionUpdateSummary-lastUpdatedDateTime"></a>
ソリューションの更新の最終更新日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** performAutoTraining **   <a name="personalize-Type-SolutionUpdateSummary-performAutoTraining"></a>
ソリューションが自動的にソリューションバージョンを作成するかどうか。  
タイプ: ブール値  
必須: いいえ

 ** performIncrementalUpdate **   <a name="personalize-Type-SolutionUpdateSummary-performIncrementalUpdate"></a>
モデルで増分トレーニング更新が実行されるかどうかを示すブール値。有効にすると、アクティブなキャンペーンを持つソリューションバージョンに対して増分トレーニングが実行され、モデルは完全な再トレーニングを必要とせずに新しいデータからより頻繁に学習できるため、ほぼリアルタイムのパーソナライゼーションが可能になります。このパラメータは、セマンティック類似度レシピを使用するソリューションでのみサポートされます。デフォルトは `true` です。  
特定のスコアや属性 (aws-semantic-similarity レシピによるランキングの影響に使用されるアイテムの人気や鮮度の更新など) は、次の完全なトレーニングが行われるまで更新されない場合があることに注意してください。  
タイプ: ブール値  
必須: いいえ

 ** solutionUpdateConfig **   <a name="personalize-Type-SolutionUpdateSummary-solutionUpdateConfig"></a>
ソリューションの設定の詳細。  
型: [SolutionUpdateConfig](API_SolutionUpdateConfig.md) オブジェクト  
必須: いいえ

 ** status **   <a name="personalize-Type-SolutionUpdateSummary-status"></a>
ソリューションの更新のステータス。ソリューションの更新は、次に示す状態のいずれかになります。  
CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -または- CREATE FAILED  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_SolutionUpdateSummary_SeeAlso"></a>

言語固有の AWSSDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWSSDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/SolutionUpdateSummary) 
+  [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/SolutionUpdateSummary) 
+  [AWSSDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/SolutionUpdateSummary) 

# SolutionVersion
<a name="API_SolutionVersion"></a>

カスタムデータセットグループ内の[ソリューション](https://docs.aws.amazon.com/personalize/latest/dg/API_Solution.html)の特定のバージョンに関する情報を提供するオブジェクト。

## 内容
<a name="API_SolutionVersion_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-SolutionVersion-creationDateTime"></a>
このバージョンのソリューションの作成日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** datasetGroupArn **   <a name="personalize-Type-SolutionVersion-datasetGroupArn"></a>
トレーニングデータを提供するデータセットグループの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** eventType **   <a name="personalize-Type-SolutionVersion-eventType"></a>
モデルのトレーニングに使用されるイベントタイプ (例えば、「クリック」または「いいね」)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

 ** failureReason **   <a name="personalize-Type-SolutionVersion-failureReason"></a>
ソリューションバージョンのトレーニングが失敗した場合、失敗の理由。  
タイプ: 文字列  
必須: いいえ

 ** lastUpdatedDateTime **   <a name="personalize-Type-SolutionVersion-lastUpdatedDateTime"></a>
ソリューションの最終更新日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** name **   <a name="personalize-Type-SolutionVersion-name"></a>
ソリューションバージョンの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: いいえ

 ** performAutoML **   <a name="personalize-Type-SolutionVersion-performAutoML"></a>
true の場合、Amazon Personalize は、ソリューション設定に従って最適なレシピを検索します。false (デフォルト) の場合、Amazon Personalize は `recipeArn` を使用します。  
タイプ: ブール値  
必須: いいえ

 ** performHPO **   <a name="personalize-Type-SolutionVersion-performHPO"></a>
選択したレシピでハイパーパラメータ最適化 (HPO) を実行するかどうか。デフォルトは `false` です。  
タイプ: ブール値  
必須: いいえ

 ** performIncrementalUpdate **   <a name="personalize-Type-SolutionVersion-performIncrementalUpdate"></a>
ソリューションバージョンが増分更新を実行するかどうか。true に設定すると、トレーニングは trainingMode が UPDATE に設定されている場合と同様に、最新のトレーニング以降に変更されたデータのみを処理します。これは、User-Personalization レシピを使用するソリューションバージョンでのみ使用できます。  
タイプ: ブール値  
必須: いいえ

 ** recipeArn **   <a name="personalize-Type-SolutionVersion-recipeArn"></a>
ソリューションで使用されるレシピの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** solutionArn **   <a name="personalize-Type-SolutionVersion-solutionArn"></a>
ソリューションの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** solutionConfig **   <a name="personalize-Type-SolutionVersion-solutionConfig"></a>
ソリューションの設定プロパティを記述します。  
型: [SolutionConfig](API_SolutionConfig.md) オブジェクト  
必須: いいえ

 ** solutionVersionArn **   <a name="personalize-Type-SolutionVersion-solutionVersionArn"></a>
ソリューションバージョンの ARN。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** status **   <a name="personalize-Type-SolutionVersion-status"></a>
ソリューションバージョンのステータス。  
ソリューションバージョンは、次のいずれかの状態になります。  
+ CREATE PENDING
+ CREATE IN\$1PROGRESS
+ アクティブ
+ CREATE FAILED
+ CREATE STOPPING
+ CREATE STOPPED
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

 ** trainingHours **   <a name="personalize-Type-SolutionVersion-trainingHours"></a>
モデルのトレーニングに使用した時間。モデルのトレーニングにかかる時間について請求されます。このフィールドは、Amazon Personalize がモデルのトレーニングに成功した後にのみ表示されます。  
型: 倍精度  
有効な範囲: 最小値 は 0 です。  
必須: いいえ

 ** trainingMode **   <a name="personalize-Type-SolutionVersion-trainingMode"></a>
ソリューションバージョンを作成するときに実行するトレーニングの範囲。`FULL` トレーニングでは、データセットグループ内のすべてのデータを考慮します。`UPDATE` は、最新のトレーニング以降に変更されたデータのみを処理します。User-Personalization レシピで作成されたソリューションバージョンのみが `UPDATE` を使用できます。  
型: 文字列  
有効な値：`FULL | UPDATE | AUTOTRAIN`  
必須：いいえ

 ** trainingType **   <a name="personalize-Type-SolutionVersion-trainingType"></a>
ソリューションバージョンが自動または手動で作成されたかどうか。  
型: 文字列  
有効な値：`AUTOMATIC | MANUAL`  
必須：いいえ

 ** tunedHPOParams **   <a name="personalize-Type-SolutionVersion-tunedHPOParams"></a>
ハイパーパラメータ最適化が実行された場合、最もパフォーマンスの高いモデルのハイパーパラメータ値が含まれます。  
型: [TunedHPOParams](API_TunedHPOParams.md) オブジェクト  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_SolutionVersion_SeeAlso"></a>

言語固有の AWSSDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWSSDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/SolutionVersion) 
+  [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/SolutionVersion) 
+  [AWSSDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/SolutionVersion) 

# SolutionVersionSummary
<a name="API_SolutionVersionSummary"></a>

ソリューションバージョンのプロパティの概要を提供します。詳細なリストについては、[DescribeSolutionVersion](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html) API を呼び出してください。

## 内容
<a name="API_SolutionVersionSummary_Contents"></a>

 ** creationDateTime **   <a name="personalize-Type-SolutionVersionSummary-creationDateTime"></a>
このバージョンのソリューションの作成日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** failureReason **   <a name="personalize-Type-SolutionVersionSummary-failureReason"></a>
ソリューションバージョンが失敗した場合、失敗の理由。  
タイプ: 文字列  
必須: いいえ

 ** lastUpdatedDateTime **   <a name="personalize-Type-SolutionVersionSummary-lastUpdatedDateTime"></a>
ソリューションバージョンの最終更新日時 (Unix 時間)。  
型: タイムスタンプ  
必須: いいえ

 ** solutionVersionArn **   <a name="personalize-Type-SolutionVersionSummary-solutionVersionArn"></a>
ソリューションバージョンの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** status **   <a name="personalize-Type-SolutionVersionSummary-status"></a>
ソリューションバージョンのステータス。  
ソリューションバージョンは、次のいずれかの状態になります。  
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -または- CREATE FAILED
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

 ** trainingMode **   <a name="personalize-Type-SolutionVersionSummary-trainingMode"></a>
ソリューションバージョンを作成するときに実行するトレーニングの範囲。`FULL` トレーニングでは、データセットグループ内のすべてのデータを考慮します。`UPDATE` は、最新のトレーニング以降に変更されたデータのみを処理します。User-Personalization レシピで作成されたソリューションバージョンのみが `UPDATE` を使用できます。  
型: 文字列  
有効な値：`FULL | UPDATE | AUTOTRAIN`  
必須：いいえ

 ** trainingType **   <a name="personalize-Type-SolutionVersionSummary-trainingType"></a>
ソリューションバージョンが自動または手動で作成されたかどうか。  
型: 文字列  
有効な値：`AUTOMATIC | MANUAL`  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_SolutionVersionSummary_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/SolutionVersionSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/SolutionVersionSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/SolutionVersionSummary) 

# Tag
<a name="API_Tag"></a>

リソースに適用し、リソースの分類と整理に役立つオプションのメタデータ。タグはそれぞれ、1 つのキーとオプションの 1 つの値で設定されており、どちらもお客様側が定義します。詳細については、「[Amazon Personalize のリソースにタグ付けする](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)」を参照してください。

## 内容
<a name="API_Tag_Contents"></a>

 ** tagKey **   <a name="personalize-Type-Tag-tagKey"></a>
タグを構成するキーと値のペアの一部。キーは、より具体的なタグ値のカテゴリのように動作する、一般的なラベルです。  
タイプ: 文字列  
長さの制限: 最小長は 1 です。最大長は 128 です。  
パターン: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
必須: はい

 ** tagValue **   <a name="personalize-Type-Tag-tagValue"></a>
タグを構成するキーと値のペアのオプションの一部。値はタグカテゴリ (キー) の記述子として機能します。  
タイプ: 文字列  
長さの制約: 最小長は 0 です。最大長は 256 です。  
パターン: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
必須: はい

## 以下の資料も参照してください。
<a name="API_Tag_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Tag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/Tag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/Tag) 

# ThemeGenerationConfig
<a name="API_ThemeGenerationConfig"></a>

バッチ推論ジョブでテーマを生成するための設定の詳細。

## 内容
<a name="API_ThemeGenerationConfig_Contents"></a>

 ** fieldsForThemeGeneration **   <a name="personalize-Type-ThemeGenerationConfig-fieldsForThemeGeneration"></a>
バッチ推論ジョブの説明テーマを生成するために使用されるフィールド。  
型: [FieldsForThemeGeneration](API_FieldsForThemeGeneration.md) オブジェクト  
必須: はい

## 以下の資料も参照してください。
<a name="API_ThemeGenerationConfig_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ThemeGenerationConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ThemeGenerationConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ThemeGenerationConfig) 

# TrainingDataConfig
<a name="API_TrainingDataConfig"></a>

ドメインレコメンダーまたはカスタムソリューションバージョン (トレーニング済みモデル) を作成するときに使用するトレーニングデータ構成。

## 内容
<a name="API_TrainingDataConfig_Contents"></a>

 ** excludedDatasetColumns **   <a name="personalize-Type-TrainingDataConfig-excludedDatasetColumns"></a>
トレーニングから除外する列を指定します。各キーはデータセットタイプで、各値は列のリストです。列を除外することで、Amazon Personalize がレコメンデーションの生成に使用するデータを制御できます。  
 例えば、レコメンデーションをフィルタリングするためだけに使用したい列があるとします。この列をトレーニングから除外すると、Amazon Personalize はフィルタリング時にのみこの列を考慮します。  
タイプ: 文字列マップの配列への文字列  
マップエントリ: アイテムの最大数は 3 です。  
キーの長さの制限: 最大長は 256 です。  
キーパターン: `^[A-Za-z_]+$`   
配列メンバー: 最大数は 50 品目です。  
長さの制限: 最大長は 1,024 です。  
パターン: `[A-Za-z_][A-Za-z\d_]*`   
必須: いいえ

 ** includedDatasetColumns **   <a name="personalize-Type-TrainingDataConfig-includedDatasetColumns"></a>
トレーニングから含める列を指定します。各キーはデータセットタイプで、各値は列のリストです。Amazon Personalize がレコメンデーションの生成に使用するデータを制御するための列を含めます。  
たとえば、項目データセットに複数の列があっても、トレーニングにタイトルと説明のみを使用したいとします。トレーニングにはこれら 2 つの列のみを含めることができ、Amazon Personalize はトレーニングには含まれている列のみを考慮します。  
タイプ: 文字列マップの配列への文字列  
マップエントリ: アイテムの最大数は 3 です。  
キーの長さの制限: 最大長は 256 です。  
キーパターン: `^[A-Za-z_]+$`   
配列メンバー: 最大数は 50 品目です。  
長さの制限: 最大長は 1,024 です。  
パターン: `[A-Za-z_][A-Za-z\d_]*`   
必須: いいえ

## 以下の資料も参照してください。
<a name="API_TrainingDataConfig_SeeAlso"></a>

言語固有の AWSSDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWSSDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/TrainingDataConfig) 
+  [AWSSDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/TrainingDataConfig) 
+  [AWSSDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/TrainingDataConfig) 

# TunedHPOParams
<a name="API_TunedHPOParams"></a>

ハイパーパラメータ最適化 (HPO) が実行された場合、最もパフォーマンスの高いモデルのハイパーパラメータ値が含まれます。

## 内容
<a name="API_TunedHPOParams_Contents"></a>

 ** algorithmHyperParameters **   <a name="personalize-Type-TunedHPOParams-algorithmHyperParameters"></a>
最高のパフォーマンスを発揮するモデルのハイパーパラメータ値のリスト。  
型: 文字列間のマッピング  
マップエントリ: アイテムの最大数は 100 です。  
キーの長さの制限: 最大長は 256 です。  
値の長さの制限: 最大長は 1000 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_TunedHPOParams_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/TunedHPOParams) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/TunedHPOParams) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/TunedHPOParams) 

# Amazon Personalize Events
<a name="API_Types_Amazon_Personalize_Events"></a>

次のデータ型は、Amazon Personalize Events でサポートされています。
+  [Action](API_UBS_Action.md) 
+  [ActionInteraction](API_UBS_ActionInteraction.md) 
+  [Event](API_UBS_Event.md) 
+  [Item](API_UBS_Item.md) 
+  [MetricAttribution](API_UBS_MetricAttribution.md) 
+  [User](API_UBS_User.md) 

# Action
<a name="API_UBS_Action"></a>

`PutActions` API を使用してアクションデータセットに追加されたアクションメタデータを表します。詳細については、「[Importing actions individually](https://docs.aws.amazon.com/personalize/latest/dg/importing-actions.html)」を参照してください。

## 内容
<a name="API_UBS_Action_Contents"></a>

 ** actionId **   <a name="personalize-Type-UBS_Action-actionId"></a>
アクションに関連付けられた ID。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 256 です。  
必須: はい

 ** properties **   <a name="personalize-Type-UBS_Action-properties"></a>
アクション固有のメタデータの文字列マップ。マップの各要素は、キーバリューペアで設定されています。例えば、`{"value": "100"}`。  
キーは、アクションデータセットのスキーマ内のフィールドと一致するキャメルケース名を使用します。前の例では、`value` はアクションスキーマで定義された「VALUE」フィールドと一致します。カテゴリ文字列データについて、単一のアクションに複数のカテゴリを含めるには、各カテゴリをパイプ区切り文字 (`|`) で区切ります。例えば、`\"Deluxe|Premium\"` です。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 32,000 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_UBS_Action_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/Action) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/Action) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/Action) 

# ActionInteraction
<a name="API_UBS_ActionInteraction"></a>

`PutActionInteractions` API を使用して送信されるアクションインタラクションイベントを表します。

## 内容
<a name="API_UBS_ActionInteraction_Contents"></a>

 ** actionId **   <a name="personalize-Type-UBS_ActionInteraction-actionId"></a>
ユーザーが操作したアクションの ID。これはアクションインタラクションスキーマの `ACTION_ID` フィールドに対応します。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 256 です。  
必須: はい

 ** eventType **   <a name="personalize-Type-UBS_ActionInteraction-eventType"></a>
アクションインタラクションイベントのタイプ。`Viewed`、`Taken`、および `Not Taken` イベントタイプを指定できます。アクションインタラクションのイベントタイプデータについて詳しくは、「[Event type data](https://docs.aws.amazon.com/personalize/latest/dg/action-interaction-event-type-data.html)」を参照してください。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 256 です。  
必須: はい

 ** sessionId **   <a name="personalize-Type-UBS_ActionInteraction-sessionId"></a>
ユーザーの訪問に関連付けられたセッション ID。アプリケーションは、ユーザーが最初にウェブサイトにアクセスしたとき、またはアプリケーションを使用したときに、一意の `sessionId` を生成します。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 256 です。  
必須: はい

 ** timestamp **   <a name="personalize-Type-UBS_ActionInteraction-timestamp"></a>
アクションインタラクションイベントが発生したときのタイムスタンプ。タイムスタンプは Unix エポック時刻形式 (秒単位) である必要があります。  
タイプ: タイムスタンプ  
必須: はい

 ** eventId **   <a name="personalize-Type-UBS_ActionInteraction-eventId"></a>
イベントに関連付けられた ID。イベント ID が指定されていない場合、Amazon Personalize はイベントの一意の ID を生成します。イベント ID はモデルへの入力として使用されません。Amazon Personalize は、イベント ID を使用して一意のイベントを区別します。同じイベント ID を持つ最初のイベント以降の後続のイベントは、モデルトレーニングでは使用されません。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 256 です。  
必須: いいえ

 ** impression **   <a name="personalize-Type-UBS_ActionInteraction-impression"></a>
ユーザーに表示したアクションのシーケンスを表すアクション ID のリスト。例えば、`["actionId1", "actionId2", "actionId3"]`。Amazon Personalize は、アクションインタラクションイベントのインプレッションデータを使用しません。代わりに、アクションごとに複数のイベントを記録し、`Viewed` イベントタイプを使用してください。  
型: 文字列の配列  
配列メンバー: 最小数は 1 項目です。最大数は 25 項目です。  
長さの制約: 最小長は 1 です。最大長は 256 です。  
必須: いいえ

 ** properties **   <a name="personalize-Type-UBS_ActionInteraction-properties"></a>
記録することを選択する可能性のあるイベント固有のデータの文字列マップ。例えば、ユーザーがアクションを実行した場合 (アクション ID 以外)、ユーザーが行ったアクションの数を送信することもできます。  
マップの各アイテムは、キーバリューペアで設定されています。例:  
 `{"numberOfActions": "12"}`   
キーは、アクションインタラクションスキーマのフィールドと一致するキャメルケース名を使用します。上の例では、`numberOfActions` はアクションインタラクションスキーマで定義された「NUMBER\$1OF\$1ACTIONS」フィールドと一致します。  
 以下はプロパティのキーワードとして含めることはできません (大文字と小文字は区別されません)。  
+  userId 
+  sessionId 
+ eventType
+ timestamp
+ recommendationId
+ インプレッション
タイプ: 文字列  
長さの制限: 最小長は 1 です。最大長は 1,024 です。  
必須: いいえ

 ** recommendationId **   <a name="personalize-Type-UBS_ActionInteraction-recommendationId"></a>
ユーザーが操作したアイテムを含むレコメンデーションのリストの ID。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 40 です。  
必須: いいえ

 ** userId **   <a name="personalize-Type-UBS_ActionInteraction-userId"></a>
アクションを操作したユーザーの ID。これはアクションインタラクションスキーマの `USER_ID` フィールドに対応します。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 256 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_UBS_ActionInteraction_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/ActionInteraction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/ActionInteraction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/ActionInteraction) 

# Event
<a name="API_UBS_Event"></a>

`PutEvents` API を使用して送信されるアイテムインタラクションのイベント情報を表します。

## 内容
<a name="API_UBS_Event_Contents"></a>

 ** eventType **   <a name="personalize-Type-UBS_Event-eventType"></a>
イベントのタイプ (クリックやダウンロードなど)。このプロパティは、アイテムインタラクションデータセットスキーマの `EVENT_TYPE` フィールドに対応し、追跡しているイベントのタイプによって異なります。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 256 です。  
必須: はい

 ** sentAt **   <a name="personalize-Type-UBS_Event-sentAt"></a>
イベントが発生したときのクライアント側のタイムスタンプ (Unix 時間)。  
タイプ: タイムスタンプ  
必須: はい

 ** eventId **   <a name="personalize-Type-UBS_Event-eventId"></a>
イベントに関連付けられた ID。イベント ID が指定されていない場合、Amazon Personalize はイベントの一意の ID を生成します。イベント ID はモデルへの入力として使用されません。Amazon Personalize は、イベント ID を使用して一意のイベントを区別します。同じイベント ID を持つ最初のイベント以降の後続のイベントは、モデルトレーニングでは使用されません。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 256 です。  
必須: いいえ

 ** eventValue **   <a name="personalize-Type-UBS_Event-eventValue"></a>
アイテムインタラクションスキーマの `EVENT_VALUE` フィールドに対応するイベント値。  
タイプ: 浮動小数点  
必須: いいえ

 ** impression **   <a name="personalize-Type-UBS_Event-impression"></a>
ユーザーに表示したアイテムのシーケンスを表すアイテム ID のリスト。例えば、`["itemId1", "itemId2", "itemId3"]`。イベントのインプレッションデータを手動で記録する項目のリストを提供します。インプレッションデータの記録についての詳細は、「[インプレッションデータの記録](https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html#putevents-including-impressions-data)」を参照してください。  
型: 文字列の配列  
配列メンバー: 最小数は 1 項目です。最大数は 25 項目です。  
長さの制約: 最小長は 1 です。最大長は 256 です。  
必須: いいえ

 ** itemId **   <a name="personalize-Type-UBS_Event-itemId"></a>
アイテムインタラクションデータセットのスキーマの `ITEM_ID` フィールドに対応するアイテム ID キー。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 256 です。  
必須: いいえ

 ** metricAttribution **   <a name="personalize-Type-UBS_Event-metricAttribution"></a>
イベントに関連するメトリクス属性に関する情報が含まれています。メトリクス属性についての詳細は、「[レコメンデーションの影響の測定](https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html)」を参照してください。  
型: [MetricAttribution](API_UBS_MetricAttribution.md) オブジェクト  
必須: いいえ

 ** properties **   <a name="personalize-Type-UBS_Event-properties"></a>
記録することを選択する可能性のあるイベント固有のデータの文字列マップ。例えば、ユーザーがサイトで映画を評価した場合 (映画 ID (`itemId`) とレーティング (`eventValue`) 以外)、ユーザーが行った映画のレーティングの数を送信することもできます。  
マップの各アイテムは、キーバリューペアで設定されています。例:  
 `{"numberOfRatings": "12"}`   
キーは、アイテムインタラクションデータセットのスキーマのフィールドと一致するキャメルケース名を使用します。上の例では、`numberOfRatings` はアイテムインタラクションデータセットのスキーマで定義された「NUMBER\$1OF\$1RATINGS」フィールドと一致します。  
 以下はプロパティのキーワードとして含めることはできません (大文字と小文字は区別されません)。  
+  userId 
+  sessionId 
+ eventType
+ timestamp
+ recommendationId
+ インプレッション
タイプ: 文字列  
長さの制限: 最小長は 1 です。最大長は 1,024 です。  
必須: いいえ

 ** recommendationId **   <a name="personalize-Type-UBS_Event-recommendationId"></a>
ユーザーが操作したアイテムを含むレコメンデーションのリストの ID。Amazon Personalize がユーザーに表示したレコメンデーションをインプレッションデータとして暗黙のうちに記録するには、`recommendationId` を指定します。または、メトリクス属性を使用してレコメンデーションの影響を測定する場合は `recommendationId` を指定します。  
 インプレッションデータの記録についての詳細は、「[インプレッションデータの記録](https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html#putevents-including-impressions-data)」を参照してください。メトリクス属性の作成について詳しくは、「[レコメンデーションの影響の測定](https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html)」を参照してください。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 40 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_UBS_Event_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/Event) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/Event) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/Event) 

# Item
<a name="API_UBS_Item"></a>

`PutItems` API を使用して Items データセットに追加されたアイテムメタデータを表します。詳細については、「[Importing items individually](https://docs.aws.amazon.com/personalize/latest/dg/importing-items.html)」を参照してください。

## 内容
<a name="API_UBS_Item_Contents"></a>

 ** itemId **   <a name="personalize-Type-UBS_Item-itemId"></a>
アイテムに関連付けられた ID。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 256 です。  
必須: はい

 ** properties **   <a name="personalize-Type-UBS_Item-properties"></a>
アイテム固有のメタデータの文字列マップ。マップの各要素は、キーバリューペアで設定されています。例えば、`{"numberOfRatings": "12"}`。  
キーは、Items データセットのスキーマ内のフィールドと一致するキャメルケース名を使用します。前の例では、`numberOfRatings` は Items スキーマで定義された「NUMBER\$1OF\$1RATINGS」フィールドと一致します。カテゴリ文字列データについて、単一のアイテムに複数のカテゴリを含めるには、各カテゴリをパイプ区切り文字 (`|`) で区切ります。例えば、`\"Horror|Action\"` です。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 32,000 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_UBS_Item_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/Item) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/Item) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/Item) 

# MetricAttribution
<a name="API_UBS_MetricAttribution"></a>

イベントに関連するメトリクス属性に関する情報が含まれます。メトリクス属性についての詳細は、「[レコメンデーションの影響の測定](https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html)」を参照してください。

## 内容
<a name="API_UBS_MetricAttribution_Contents"></a>

 ** eventAttributionSource **   <a name="personalize-Type-UBS_MetricAttribution-eventAttributionSource"></a>
サードパーティーなどのイベントのソース。  
タイプ: 文字列  
長さの制約: 最大長は 1,024 です。  
パターン: `^[\x20-\x7E]*[\x21-\x7E]+[\x20-\x7E]*$`   
必須: はい

## 以下の資料も参照してください。
<a name="API_UBS_MetricAttribution_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/MetricAttribution) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/MetricAttribution) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/MetricAttribution) 

# User
<a name="API_UBS_User"></a>

`PutUsers` API を使用して Users データセットに追加されたユーザーメタデータを表します。詳細については、「[Importing users individually](https://docs.aws.amazon.com/personalize/latest/dg/importing-users.html)」を参照してください。

## 内容
<a name="API_UBS_User_Contents"></a>

 ** userId **   <a name="personalize-Type-UBS_User-userId"></a>
ユーザーに関連付けられた ID。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 256 です。  
必須: はい

 ** properties **   <a name="personalize-Type-UBS_User-properties"></a>
アイテム固有のメタデータの文字列マップ。マップの各要素は、キーバリューペアで設定されています。例えば、`{"numberOfVideosWatched": "45"}`。  
キーは、Users データセットのスキーマ内のフィールドと一致するキャメルケース名を使用します。前の例では、`numberOfVideosWatched` は Users スキーマで定義された「NUMBER\$1OF\$1VIDEOS\$1WATCHED」フィールドに一致します。カテゴリ文字列データについて、単一のユーザーに複数のカテゴリを含めるには、各カテゴリをパイプ区切り文字 (`|`) で区切ります。例えば、`\"Member|Frequent shopper\"` です。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 24,000 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_UBS_User_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/User) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/User) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/User) 

# Amazon Personalize Runtime
<a name="API_Types_Amazon_Personalize_Runtime"></a>

次のデータ型は、Amazon Personalize Runtime でサポートされています。
+  [PredictedAction](API_RS_PredictedAction.md) 
+  [PredictedItem](API_RS_PredictedItem.md) 
+  [Promotion](API_RS_Promotion.md) 

# PredictedAction
<a name="API_RS_PredictedAction"></a>

アクションを識別するオブジェクト。

[GetActionRecommendations](API_RS_GetActionRecommendations.md) API は `PredictedAction` のリストを返します。

## 内容
<a name="API_RS_PredictedAction_Contents"></a>

 ** actionId **   <a name="personalize-Type-RS_PredictedAction-actionId"></a>
レコメンデーションアクションの ID。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

 ** score **   <a name="personalize-Type-RS_PredictedAction-score"></a>
レコメンデーションアクションのスコア。アクションスコアの詳細については、「[How action recommendation scoring works](https://docs.aws.amazon.com/personalize/latest/dg/how-action-recommendation-scoring-works.html)」を参照してください。  
型: 倍精度浮動小数点数  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_RS_PredictedAction_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-runtime-2018-05-22/PredictedAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-runtime-2018-05-22/PredictedAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-runtime-2018-05-22/PredictedAction) 

# PredictedItem
<a name="API_RS_PredictedItem"></a>

アイテムを識別するオブジェクト。

[GetRecommendations](API_RS_GetRecommendations.md) および [GetPersonalizedRanking](API_RS_GetPersonalizedRanking.md) API は、`PredictedItem` のリストを返します。

## 内容
<a name="API_RS_PredictedItem_Contents"></a>

 ** itemId **   <a name="personalize-Type-RS_PredictedItem-itemId"></a>
推奨アイテム ID。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
必須: いいえ

 ** metadata **   <a name="personalize-Type-RS_PredictedItem-metadata"></a>
アイテムデータセットのアイテムに関するメタデータ。  
型: 文字列間のマッピング  
キーの長さの制限: 最大長は 150 です。  
値の長さの制限: 最大長は 20,000 です。  
必須: いいえ

 ** promotionName **   <a name="personalize-Type-RS_PredictedItem-promotionName"></a>
予測アイテムを含むプロモーションの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: いいえ

 ** reason **   <a name="personalize-Type-RS_PredictedItem-reason"></a>
User-Personalization-v2 を使用する場合、アイテムがレコメンデーションに含まれていた原因のリスト。次のような原因が考えられます。  
+ プロモーション対象アイテム - レコメンデーションリクエストに適用したプロモーションの一部としてアイテムが含まれていたことを示します。
+ 探索 - アイテムが探索に含まれていたことを示します。探索では、レコメンデーションに、インタラクションデータまたはユーザーとの関連性が少ないアイテムが含まれます。探索の詳細については、「[探索](https://docs.aws.amazon.com/personalize/latest/dg/use-case-recipe-features.html#about-exploration)」を参照してください。
+  人気のあるアイテム - アイテムがプレースホルダーの人気のあるアイテムとして含まれていたことを示します。フィルターを使用する場合、フィルターが削除するレコメンデーションの数に応じて、Amazon Personalize はレコメンデーションリクエストの `numResults` を満たすプレースホルダーアイテムを追加する場合があります。これらのアイテムは、インタラクションデータに基づいて、フィルター基準を満たす一般的なアイテムです。これらにはユーザーの関連性スコアがありません。
型: 文字列の配列  
長さの制約: 最大長は 256 です。  
必須: いいえ

 ** score **   <a name="personalize-Type-RS_PredictedItem-score"></a>
次にユーザーが該当のアイテムを選択することについての、モデルの確実性の数値表現。スコアリングロジックの詳細については、「[レコメンデーションスコア](getting-recommendations.md#how-scores-work)」を参照してください。  
型: 倍精度浮動小数点数  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_RS_PredictedItem_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-runtime-2018-05-22/PredictedItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-runtime-2018-05-22/PredictedItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-runtime-2018-05-22/PredictedItem) 

# Promotion
<a name="API_RS_Promotion"></a>

プロモーションに関する情報が含まれています。プロモーションは、設定可能な推奨アイテムのサブセットに適用される追加のビジネスルールを定義します。

## 内容
<a name="API_RS_Promotion_Contents"></a>

 ** filterArn **   <a name="personalize-Type-RS_Promotion-filterArn"></a>
プロモーションで使用される Amazon リソースネーム (ARN)。このフィルターはプロモーション対象アイテムの条件を定義します。フィルターを使用する方法については、「プロモーションフィルター」を参照してください。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: いいえ

 ** filterValues **   <a name="personalize-Type-RS_Promotion-filterValues"></a>
アイテムをプロモーションするときに使用する値。フィルター式の各プレースホルダーパラメータについて、(大文字と小文字が一致した状態で) パラメータ名をキーとして指定し、フィルター値を対応する値として指定します。1 つのパラメータの複数の値をコンマで区切ります。  
`INCLUDE` 要素を使用してアイテムを含めるフィルター式について、式で定義されているすべてのパラメータの値を指定する必要があります。`EXCLUDE` 要素を使用してアイテムを除外する式を含むフィルターについては、`filter-values` を省略できます。この場合、Amazon Personalize は、式のその部分を使用してレコメンデーションをフィルタリングしません。  
フィルター作成についての詳細は、「[レコメンデーションとユーザーセグメントのフィルタリング](https://docs.aws.amazon.com/personalize/latest/dg/filter.html)」を参照してください。  
型: 文字列間のマッピング  
マップエントリ: アイテムの最大数は 25 です。  
キーの長さの制限: 最大長は 50 です。  
キーパターン: `[A-Za-z0-9_]+`   
値の長さの制限: 最大長は 1000 です。  
必須: いいえ

 ** name **   <a name="personalize-Type-RS_Promotion-name"></a>
プロモーションの名前。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 63 です。  
パターン: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`   
必須: いいえ

 ** percentPromotedItems **   <a name="personalize-Type-RS_Promotion-percentPromotedItems"></a>
プロモーションを適用する推奨アイテム品の割合。  
タイプ: 整数  
有効範囲: 最小値 は 1 です。最大値は 100 です。  
必須: いいえ

## 以下の資料も参照してください。
<a name="API_RS_Promotion_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-runtime-2018-05-22/Promotion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-runtime-2018-05-22/Promotion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-runtime-2018-05-22/Promotion) 

# 共通エラー
<a name="CommonErrors"></a>

このセクションでは、AWS のすべてのサービスの API アクションに共通のエラーを一覧表示しています。このサービスの API アクションに固有のエラーについては、その API アクションのトピックを参照してください。

 **AccessDeniedException**   
このアクションを実行する十分なアクセス権限がありません。  
HTTP ステータスコード: 400

 **IncompleteSignature**   
リクエストの署名が AWS 基準に適合しません。  
HTTP ステータスコード: 400

 **InternalFailure**   <a name="CommonErrors-InternalFailure"></a>
リクエストの処理が、不明なエラー、例外、または障害により実行できませんでした。  
HTTP ステータスコード: 500

 **InvalidAction**   <a name="CommonErrors-InvalidAction"></a>
リクエストされたアクション、またはオペレーションは無効です。アクションが正しく入力されていることを確認してください。  
HTTP ステータスコード: 400

 **InvalidClientTokenId**   <a name="CommonErrors-InvalidClientTokenId"></a>
指定された X.509 証明書または AWS アクセスキー ID がレコード内に見つかりません。  
HTTP ステータスコード: 403

 **NotAuthorized**   <a name="CommonErrors-NotAuthorized"></a>
このアクションを実行するためのアクセス許可がありません。  
HTTP ステータスコード: 400

 **OptInRequired**   <a name="CommonErrors-OptInRequired"></a>
サービスを利用するためには、AWS アクセスキー ID を取得する必要があります。  
HTTP ステータスコード: 403

 **RequestExpired**   <a name="CommonErrors-RequestExpired"></a>
リクエストの日付スタンプの 15 分以上後またはリクエストの有効期限 (署名付き URL の場合など) の 15 分以上後に、リクエストが到着しました。または、リクエストの日付スタンプが現在より 15 分以上先です。  
HTTP ステータスコード: 400

 **ServiceUnavailable**   <a name="CommonErrors-ServiceUnavailable"></a>
サーバーの一時的な障害により、リクエストは失敗しました。  
HTTP ステータスコード: 503

 **ThrottlingException**   <a name="CommonErrors-ThrottlingException"></a>
リクエストのスロットリングにより、リクエストが拒否されました。  
HTTP ステータスコード: 400

 **ValidationError**   <a name="CommonErrors-ValidationError"></a>
入力が、AWS サービスで指定された制約を満たしていません。  
HTTP ステータスコード: 400

# 共通パラメータ
<a name="CommonParameters"></a>

次のリストには、すべてのアクションが署名バージョン 4 リクエストにクエリ文字列で署名するために使用するパラメータを示します。アクション固有のパラメータは、アクションのトピックに示されています。署名バージョン 4 の詳細については、*IAM ユーザーガイド*[の AWS API リクエストの署名](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html)を参照してください。

 **X-Amz-Algorithm**   <a name="CommonParameters-X-Amz-Algorithm"></a>
リクエストの署名を作成するのに使用したハッシュアルゴリズム。  
条件: HTTP 認可ヘッダーではなくクエリ文字列に認証情報を含める場合は、このパラメータを指定します。  
型: 文字列  
有効な値：`AWS4-HMAC-SHA256`  
必須: 条件による

 **X-Amz-Credential**   <a name="CommonParameters-X-Amz-Credential"></a>
認証情報スコープの値で、アクセスキー、日付、対象とするリージョン、リクエストしているサービス、および終了文字列 ("aws4\$1request") を含む文字列です。値は次の形式で表現されます: [*access\$1key*/*YYYYMMDD*/*リージョン*/*サービス*/aws4\$1request]。  
詳細については、*IAM* [ユーザーガイドの「署名付き AWS API リクエストの作成](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html)」を参照してください。  
条件: HTTP 認可ヘッダーではなくクエリ文字列に認証情報を含める場合は、このパラメータを指定します。  
型: 文字列  
必須: 条件による

 **X-Amz-Date**   <a name="CommonParameters-X-Amz-Date"></a>
署名を作成するときに使用する日付です。形式は ISO 8601 基本形式の YYYYMMDD'T'HHMMSS'Z' でなければなりません。例えば、日付 `20120325T120000Z` は、有効な X-Amz-Date の値です。  
条件: X-Amz-Date はすべてのリクエストに対してオプションです。署名リクエストで使用する日付よりも優先される日付として使用できます。ISO 8601 ベーシック形式で日付ヘッダーが指定されている場合、X-Amz-Date は必要ありません。X-Amz-Date を使用すると、常に Date ヘッダーの値よりも優先されます。詳細については、*IAM ユーザーガイド*[の AWS API リクエスト署名の要素](https://docs.aws.amazon.com/IAM/latest/UserGuide/signing-elements.html)を参照してください。  
タイプ: 文字列  
必須: 条件による

 **X-Amz-Security-Token**   <a name="CommonParameters-X-Amz-Security-Token"></a>
 AWS Security Token Service () の呼び出しによって取得された一時的なセキュリティトークンAWS STS。 AWS STSの一時的なセキュリティ認証情報をサポートするサービスのリストについては、「IAM ユーザーガイド」の「[IAM と連携するAWS のサービス](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html)」を参照してください。  
条件: から一時的なセキュリティ認証情報を使用している場合は AWS STS、セキュリティトークンを含める必要があります。  
タイプ: 文字列  
必須: 条件による

 **X-Amz-Signature**   <a name="CommonParameters-X-Amz-Signature"></a>
署名する文字列と派生署名キーから計算された 16 進符号化署名を指定します。  
条件: HTTP 認可ヘッダーではなくクエリ文字列に認証情報を含める場合は、このパラメータを指定します。  
型: 文字列  
必須: 条件による

 **X-Amz-SignedHeaders**   <a name="CommonParameters-X-Amz-SignedHeaders"></a>
正規リクエストの一部として含まれていたすべての HTTP ヘッダーを指定します。署名付きヘッダーの指定の詳細については、*IAM* [ユーザーガイドの「署名付き AWS API リクエストの作成](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html)」を参照してください。  
条件: HTTP 認可ヘッダーではなくクエリ文字列に認証情報を含める場合は、このパラメータを指定します。  
型: 文字列  
必須: 条件による