

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# 動作
<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 執行期支援下列動作：
+  [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)

 如果您使用類似項目配方，Amazon Personalize 可以將描述性主題新增至批次建議。若要產生佈景主題，請將任務的模式設定為 ，`THEME_GENERATION`並在輸入資料中指定包含項目名稱的欄位名稱。

 如需產生佈景主題的詳細資訊，請參閱[內容產生器 中的批次建議與佈景主題](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 Identity and Access Management 角色的 ARN，具有分別讀取和寫入輸入和輸出 Amazon S3 儲存貯體的許可。  
類型：字串  
長度限制：長度上限為 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 Resource Name (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 **   
已超過每秒請求數的限制。  
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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateBatchInferenceJob) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateBatchInferenceJob) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateBatchInferenceJob) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateBatchInferenceJob) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateBatchInferenceJob) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateBatchInferenceJob) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateBatchInferenceJob) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateBatchInferenceJob) 
+  [AWS 適用於 Ruby V3 的 SDK](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 Identity and Access Management 角色的 ARN，具有分別讀取和寫入輸入和輸出 Amazon S3 儲存貯體的許可。  
類型：字串  
長度限制：長度上限為 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 Resource Name (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 **   
已超過每秒請求數的限制。  
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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateBatchSegmentJob) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateBatchSegmentJob) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateBatchSegmentJob) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateBatchSegmentJob) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateBatchSegmentJob) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateBatchSegmentJob) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateBatchSegmentJob) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateBatchSegmentJob) 
+  [AWS 適用於 Ruby V3 的 SDK](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) APIs時，會在請求中指定行銷活動。

 **最小佈建 TPS 和自動擴展** 

**重要**  
 較高的 `minProvisionedTPS`會增加您的成本。我們建議從 1 開始 `minProvisionedTPS`（預設值）。使用 Amazon CloudWatch 指標追蹤您的用量，並視需要增加 `minProvisionedTPS`。

 當您建立 Amazon Personalize 行銷活動時，您可以指定行銷活動的每秒最低佈建交易數 (`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 -or- 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 將支援的每秒請求的最低佈建交易 （建議）。較高的 `minProvisionedTPS`會增加您的帳單。我們建議從 1 開始 `minProvisionedTPS`（預設值）。使用 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 Resource Name (ARN)。若要指定解決方案的最新解決方案版本，請以 `SolutionArn/$LATEST` 格式指定*解決方案*的 ARN。如果您在 [CampaignConfig](https://docs.aws.amazon.com/personalize/latest/dg/API_CampaignConfig.html) `True`中`syncWithLatestSolutionVersion`將 設定為 ，則必須使用此格式。  
 若要部署不是解決方案最新版本的模型，請指定解決方案版本的 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 Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`

## 錯誤
<a name="API_CreateCampaign_Errors"></a>

 ** InvalidInputException **   
提供欄位或參數的有效值。  
HTTP 狀態碼：400

 ** LimitExceededException **   
已超過每秒請求數的限制。  
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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateCampaign) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateCampaign) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateCampaign) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateCampaign) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateCampaign) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateCampaign) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateCampaign) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateCampaign) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateCampaign) 

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

建立批次任務，以批次刪除 Amazon Personalize 資料集群組中對特定使用者的所有參考。您可以在 Amazon S3 儲存貯體的 userIds CSV 檔案中指定要刪除的使用者。任務完成後，Amazon Personalize 不會再針對使用者的資料進行訓練，也不會在產生使用者客群時考慮使用者。如需建立資料刪除任務的詳細資訊，請參閱[刪除使用者](https://docs.aws.amazon.com/personalize/latest/dg/delete-records.html)。
+ 您的輸入檔案必須是 CSV 檔案，其中包含列出使用者 IDs的單一 USER\$1ID 資料欄。如需準備 CSV 檔案的詳細資訊，請參閱[準備資料刪除檔案並將其上傳至 Amazon S3](https://docs.aws.amazon.com/personalize/latest/dg/prepare-deletion-input-file.html)。
+ 若要授予 Amazon Personalize 存取 userIds 輸入 CSV 檔案的許可，您必須指定具有從資料來源讀取許可的 IAM 服務角色。此角色需要儲存貯體`GetObject`及其內容的 和`ListBucket`許可。這些許可與匯入資料相同。如需有關授予 Amazon S3 儲存貯體存取權的資訊，請參閱[授予 Amazon Personalize 存取權給 Amazon S3 資源](https://docs.aws.amazon.com/personalize/latest/dg/granting-personalize-s3-access.html)。

 建立任務後，最多可能需要一天的時間，才能從資料集和模型中刪除對使用者的所有參考。在任務完成之前，Amazon Personalize 會在訓練時繼續使用資料。如果您使用使用者區段配方，使用者可能會出現在使用者區段中。

 **狀態** 

資料刪除任務可以有下列其中一種狀態：
+ 待定 > IN\$1PROGRESS > COMPLETED -or- FAILED

若要取得資料刪除任務的狀態，請呼叫 [DescribeDataDeletionJob](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataDeletionJob.html) API 操作，並指定任務的 Amazon Resource Name (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 Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
必要：是

 ** [dataSource](#API_CreateDataDeletionJob_RequestSyntax) **   <a name="personalize-CreateDataDeletionJob-request-dataSource"></a>
包含要刪除之使用者 userIds清單的 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 Resource Name (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 Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`

## 錯誤
<a name="API_CreateDataDeletionJob_Errors"></a>

 ** InvalidInputException **   
提供欄位或參數的有效值。  
HTTP 狀態碼：400

 ** LimitExceededException **   
已超過每秒請求數的限制。  
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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateDataDeletionJob) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateDataDeletionJob) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateDataDeletionJob) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateDataDeletionJob) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateDataDeletionJob) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateDataDeletionJob) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateDataDeletionJob) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateDataDeletionJob) 
+  [AWS 適用於 Ruby V3 的 SDK](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 種類型：
+ 項目互動
+ 項目
+ 使用者
+ 動作互動
+ 動作

每種資料集類型都具有必要欄位類型的相關聯結構描述。若要訓練模型 (也稱為建立解決方案)，僅需要 `Item interactions` 資料集即可。

資料集可為下列任一種狀態：
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- 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 Resource Name (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 **   
已超過每秒請求數的限制。  
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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateDataset) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateDataset) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateDataset) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateDataset) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateDataset) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateDataset) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateDataset) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateDataset) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateDataset) 

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

 建立任務，將資料從資料集匯出至 Amazon S3 儲存貯體。若要允許 Amazon Personalize 匯出訓練資料，您必須指定服務連結 IAM 角色，為 Amazon S3 儲存貯體提供 Amazon Personalize `PutObject`許可。如需詳細資訊，請參閱《Amazon Personalize 開發人員指南》中的[匯出資料集](https://docs.aws.amazon.com/personalize/latest/dg/export-data.html)。

 **狀態** 

資料集匯出任務可以處於下列其中一種狀態：
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED

 若要取得匯出任務的狀態，請呼叫 [DescribeDatasetExportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetExportJob.html)，並指定資料集匯出任務的 Amazon Resource Name (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 Resource Name (ARN)，其中包含要匯出的資料。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
必要：是

 ** [ingestionMode](#API_CreateDatasetExportJob_RequestSyntax) **   <a name="personalize-CreateDatasetExportJob-request-ingestionMode"></a>
根據您匯入資料的方式，要匯出的資料。您可以選擇只匯出使用資料集匯入任務匯入`BULK`的資料，只匯出增量匯入`PUT`的資料 （使用主控台、PutEvents、PutUsers 和 PutItems 操作），或`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>
IAM 服務角色的 Amazon Resource Name (ARN)，其具有將資料新增至輸出 Amazon S3 儲存貯體的許可。  
類型：字串  
長度限制：長度上限為 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 Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`

## 錯誤
<a name="API_CreateDatasetExportJob_Errors"></a>

 ** InvalidInputException **   
提供欄位或參數的有效值。  
HTTP 狀態碼：400

 ** LimitExceededException **   
已超過每秒請求數的限制。  
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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateDatasetExportJob) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateDatasetExportJob) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateDatasetExportJob) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateDatasetExportJob) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateDatasetExportJob) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateDatasetExportJob) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateDatasetExportJob) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateDatasetExportJob) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateDatasetExportJob) 

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

建立空的資料集群組。資料集群組是 Amazon Personalize 資源的容器。資料集群組最多可包含三個資料集，每種資料集各一個：
+ 項目互動
+ 項目
+ 使用者
+ 動作
+ 動作互動

 資料集群組可以是網域資料集群組，您可以在其中指定網域，並使用預先設定的資源，例如推薦者，或是自訂資料集群組，您可以在其中使用自訂資源，例如搭配解決方案版本的解決方案，以行銷活動部署。如果您從網域資料集群組開始，您仍然可以新增自訂資源，例如使用自訂使用案例配方訓練並使用行銷活動部署的解決方案和解決方案版本。

資料集群組可以處於下列其中一種狀態：
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ 刪除擱置中

若要取得資料集群組的狀態，請呼叫 [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 的 APIs**
+  [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>
用來加密資料集之 a(KMS) 金鑰的 Amazon Resource Name AWS Key Management Service (ARN)。  
類型：字串  
長度限制：長度上限為 2048。  
模式：`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。只有在同時指定 KMS 金鑰時，提供 IAM 角色才有效。  
類型：字串  
長度限制：長度上限為 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 Resource Name (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 **   
已超過每秒請求數的限制。  
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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateDatasetGroup) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateDatasetGroup) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateDatasetGroup) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateDatasetGroup) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateDatasetGroup) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateDatasetGroup) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateDatasetGroup) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateDatasetGroup) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateDatasetGroup) 

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

建立將訓練資料從資料來源 (Amazon S3 儲存貯體） 匯入 Amazon Personalize 資料集的任務。若要允許 Amazon Personalize 匯入訓練資料，您必須指定具有從資料來源讀取許可的 IAM 服務角色，因為 Amazon Personalize 會複製您的資料並在內部處理。如需授予 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 -or- CREATE FAILED

若要取得匯入任務的狀態，請呼叫 [DescribeDatasetImportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetImportJob.html)，並提供資料集匯入任務的 Amazon Resource Name (ARN)。當狀態顯示為 ACTIVE 時，即表示資料集匯入完成。如果狀態顯示為 CREATE FAILED，回應會包含`failureReason`金鑰，說明任務失敗的原因。

**注意**  
匯入需要一些時間。您必須等到狀態顯示為 ACTIVE，才能使用資料集訓練模型。

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

## 請求語法
<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>
此為 IAM 角色的 ARN，該角色具有從 Amazon S3 資料來源讀取資料的許可。  
類型：字串  
長度限制：長度上限為 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 **   
已超過每秒請求數的限制。  
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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateDatasetImportJob) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateDatasetImportJob) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateDatasetImportJob) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateDatasetImportJob) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateDatasetImportJob) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateDatasetImportJob) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateDatasetImportJob) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateDatasetImportJob) 
+  [AWS 適用於 Ruby V3 的 SDK](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 將事件資料新增至指定資料集群組時所使用的事件追蹤器。

**注意**  
一個事件追蹤器僅能與一個資料集群組建立關聯。如果使用與現有事件追蹤器相同的資料集群組來呼叫 `CreateEventTracker`，您將會收到錯誤。

當您建立事件追蹤器時，回應會包含追蹤 ID，您可以在使用 [PutEvents](https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html) 操作時以參數形式傳遞。然後，Amazon Personalize 會將事件資料附加到您在事件追蹤器中指定的資料集群組的項目互動資料集。

事件追蹤器可以處於下列其中一種狀態：
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- 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 Resource Name (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。在對 [PutEvents](https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html) API 的請求中包含此 ID。  
類型：字串  
長度限制：長度上限為 256。

## 錯誤
<a name="API_CreateEventTracker_Errors"></a>

 ** InvalidInputException **   
提供欄位或參數的有效值。  
HTTP 狀態碼：400

 ** LimitExceededException **   
已超過每秒請求數的限制。  
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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateEventTracker) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateEventTracker) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateEventTracker) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateEventTracker) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateEventTracker) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateEventTracker) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateEventTracker) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateEventTracker) 
+  [AWS 適用於 Ruby V3 的 SDK](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 **   
已超過每秒請求數的限制。  
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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateFilter) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateFilter) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateFilter) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateFilter) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateFilter) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateFilter) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateFilter) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateFilter) 
+  [AWS 適用於 Ruby V3 的 SDK](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 Resource Name (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 Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`

## 錯誤
<a name="API_CreateMetricAttribution_Errors"></a>

 ** InvalidInputException **   
提供欄位或參數的有效值。  
HTTP 狀態碼：400

 ** LimitExceededException **   
已超過每秒請求數的限制。  
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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateMetricAttribution) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateMetricAttribution) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateMetricAttribution) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateMetricAttribution) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateMetricAttribution) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateMetricAttribution) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateMetricAttribution) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateMetricAttribution) 
+  [AWS 適用於 Ruby V3 的 SDK](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 Resource Name (ARN)。

 **每秒最低建議請求數** 

**重要**  
較高的 `minRecommendationRequestsPerSecond`會增加您的帳單。我們建議從 1 開始 `minRecommendationRequestsPerSecond`（預設值）。使用 Amazon CloudWatch 指標追蹤您的用量，並視需要增加 `minRecommendationRequestsPerSecond`。

建立建議者時，您可以設定建議者每秒的最低建議請求。每秒最低建議請求數 (`minRecommendationRequestsPerSecond`) 指定 Amazon Personalize 佈建的基準建議請求輸送量。預設 minRecommendationRequestsPerSecond 為 `1`。建議請求是單一`GetRecommendations`操作。請求輸送量是以每秒請求數來衡量，Amazon Personalize 會使用每秒請求數來衍生每小時請求數和建議者用量的價格。

 如果您的請求每秒增加超過 `minRecommendationRequestsPerSecond`，Amazon Personalize 會自動擴展和縮減佈建的容量，但絕不會低於 `minRecommendationRequestsPerSecond`。當容量增加時，會發生短暫的延遲，這可能會導致請求遺失。

 您的帳單是每小時最低請求數 （根據 minRecommendationRequestsPerSecond) 或實際請求數中的較大者。使用的實際請求輸送量計算方式為一小時時段內的平均請求/秒。我們建議您從預設的 開始`minRecommendationRequestsPerSecond`，使用 Amazon CloudWatch 指標追蹤您的用量，然後`minRecommendationRequestsPerSecond`視需要增加 。

 **狀態** 

推薦者可以處於下列其中一種狀態：
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ 停止待定 > 停止 IN\$1PROGRESS > 非作用中 > 啟動待定 > 啟動 IN\$1PROGRESS > 作用中
+ 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 Resource Name (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 Resource Name (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 Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`

## 錯誤
<a name="API_CreateRecommender_Errors"></a>

 ** InvalidInputException **   
提供欄位或參數的有效值。  
HTTP 狀態碼：400

 ** LimitExceededException **   
已超過每秒請求數的限制。  
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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateRecommender) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateRecommender) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateRecommender) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateRecommender) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateRecommender) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateRecommender) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateRecommender) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateRecommender) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateRecommender) 

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

從指定結構描述字串中建立 Amazon Personalize 結構描述。您建立的結構描述必須為 Avro JSON 格式。

Amazon Personalize 會辨識三個結構描述變體。每個結構描述都與資料集類型相關聯，且具有一組必填欄位和關鍵字。若要為網域資料集群組中的資料集建立結構描述，請提供網域資料集群組的網域。在呼叫 [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 格式的結構描述。  
類型：字串  
長度限制：長度上限為 20000。  
必要：是

## 回應語法
<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 Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`

## 錯誤
<a name="API_CreateSchema_Errors"></a>

 ** InvalidInputException **   
提供欄位或參數的有效值。  
HTTP 狀態碼：400

 ** LimitExceededException **   
已超過每秒請求數的限制。  
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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateSchema) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateSchema) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateSchema) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateSchema) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateSchema) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateSchema) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateSchema) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateSchema) 
+  [AWS 適用於 Ruby V3 的 SDK](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 後的一小時內開始。如果您在一小時內手動建立解決方案版本，解決方案會略過第一個自動訓練。如需詳細資訊，請參閱[設定自動訓練](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 Resource Name (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 -or- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS

若要取得解決方案的狀態，請呼叫 [DescribeSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html)。如果您使用手動訓練，則在您呼叫 之前，狀態必須為 ACTIVE`CreateSolutionVersion`。

**相關 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 Resource Name (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 配方比對。如需詳細資訊，請參閱[選擇配方](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 天會自動建立新的解決方案版本。您可以在 `schedulingExpression`中指定 `AutoTrainingConfig`作為解決方案組態的一部分，以變更訓練頻率。如需自動訓練的詳細資訊，請參閱[設定自動訓練](https://docs.aws.amazon.com/personalize/latest/dg/solution-config-auto-training.html)。  
 自動建立解決方案版本會在解決方案為 ACTIVE 後的一小時內開始。如果您在一小時內手動建立解決方案版本，解決方案會略過第一個自動訓練。  
 訓練開始後，您可以使用 [ListSolutionVersions](https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html) API 操作取得解決方案版本的 Amazon Resource Name (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 Resource Name (ARN)。當 `performAutoML`為 false 時，此為必要項目。如需不同 Amazon Personalize 配方及其 ARNs 的資訊，請參閱[選擇配方](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 **   
已超過每秒請求數的限制。  
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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateSolution) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateSolution) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateSolution) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateSolution) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateSolution) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateSolution) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateSolution) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateSolution) 
+  [AWS 適用於 Ruby V3 的 SDK](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) 操作建立，而且在呼叫 之前必須處於 ACTIVE 狀態`CreateSolutionVersion`。每次呼叫此操作時，都會建立新的 解決方案版本。

 **狀態** 

解決方案版本可以處於下列其中一種狀態：
+ 建立擱置中
+ CREATE IN\$1PROGRESS
+ ACTIVE
+ 建立失敗
+ 建立停止
+ 建立已停止

若要取得版本的狀態，請呼叫 [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 Resource Name (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`。這會根據資料集群組中資料集的完整訓練資料來建立全新的模型。  
如果您使用[使用者個人化](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`選項從輸入解決方案建立作用中的解決方案版本，且輸入解決方案已使用[使用者個人化](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`選項。  
類型：字串  
有效值:`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 **   
已超過每秒請求數的限制。  
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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateSolutionVersion) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateSolutionVersion) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateSolutionVersion) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateSolutionVersion) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateSolutionVersion) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateSolutionVersion) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateSolutionVersion) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateSolutionVersion) 
+  [AWS 適用於 Ruby V3 的 SDK](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 Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DeleteCampaign) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DeleteCampaign) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DeleteCampaign) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DeleteCampaign) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DeleteCampaign) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DeleteCampaign) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteCampaign) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DeleteCampaign) 
+  [AWS 適用於 Ruby V3 的 SDK](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 Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DeleteDataset) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DeleteDataset) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DeleteDataset) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DeleteDataset) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DeleteDataset) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DeleteDataset) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteDataset) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DeleteDataset) 
+  [AWS 適用於 Ruby V3 的 SDK](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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DeleteDatasetGroup) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DeleteDatasetGroup) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DeleteDatasetGroup) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DeleteDatasetGroup) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DeleteDatasetGroup) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DeleteDatasetGroup) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteDatasetGroup) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DeleteDatasetGroup) 
+  [AWS 適用於 Ruby V3 的 SDK](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 Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DeleteEventTracker) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DeleteEventTracker) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DeleteEventTracker) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DeleteEventTracker) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DeleteEventTracker) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DeleteEventTracker) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteEventTracker) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DeleteEventTracker) 
+  [AWS 適用於 Ruby V3 的 SDK](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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DeleteFilter) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DeleteFilter) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DeleteFilter) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DeleteFilter) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DeleteFilter) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DeleteFilter) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteFilter) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DeleteFilter) 
+  [AWS 適用於 Ruby V3 的 SDK](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 Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DeleteMetricAttribution) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DeleteMetricAttribution) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DeleteMetricAttribution) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DeleteMetricAttribution) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DeleteMetricAttribution) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DeleteMetricAttribution) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteMetricAttribution) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DeleteMetricAttribution) 
+  [AWS 適用於 Ruby V3 的 SDK](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 Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DeleteRecommender) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DeleteRecommender) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DeleteRecommender) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DeleteRecommender) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DeleteRecommender) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DeleteRecommender) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteRecommender) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DeleteRecommender) 
+  [AWS 適用於 Ruby V3 的 SDK](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 Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DeleteSchema) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DeleteSchema) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DeleteSchema) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DeleteSchema) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DeleteSchema) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DeleteSchema) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteSchema) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DeleteSchema) 
+  [AWS 適用於 Ruby V3 的 SDK](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 Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DeleteSolution) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DeleteSolution) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DeleteSolution) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DeleteSolution) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DeleteSolution) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DeleteSolution) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteSolution) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DeleteSolution) 
+  [AWS 適用於 Ruby V3 的 SDK](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 Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeAlgorithm) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeAlgorithm) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeAlgorithm) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeAlgorithm) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeAlgorithm) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeAlgorithm) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeAlgorithm) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeAlgorithm) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeAlgorithm) 

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

取得批次推論任務的屬性，包括名稱、Amazon Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeBatchInferenceJob) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeBatchInferenceJob) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeBatchInferenceJob) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeBatchInferenceJob) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeBatchInferenceJob) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeBatchInferenceJob) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeBatchInferenceJob) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeBatchInferenceJob) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeBatchInferenceJob) 

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

取得批次區段任務的屬性，包括名稱、Amazon Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeBatchSegmentJob) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeBatchSegmentJob) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeBatchSegmentJob) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeBatchSegmentJob) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeBatchSegmentJob) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeBatchSegmentJob) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeBatchSegmentJob) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeBatchSegmentJob) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeBatchSegmentJob) 

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

描述指定的行銷活動，包括其狀態。

行銷活動可以處於下列其中一種狀態：
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- 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 Resource Name (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>
只有當行銷活動至少有一個`UpdateCampaign`呼叫時，才會傳回 `latestCampaignUpdate` 欄位。
行銷活動的屬性。  
只有當行銷活動至少有一個`UpdateCampaign`呼叫時，才會傳回 `latestCampaignUpdate` 欄位。
類型：[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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeCampaign) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeCampaign) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeCampaign) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeCampaign) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeCampaign) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeCampaign) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeCampaign) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeCampaign) 
+  [AWS 適用於 Ruby V3 的 SDK](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 Resource Name (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 (已完成)
+ 失敗
類型：[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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeDataDeletionJob) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeDataDeletionJob) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeDataDeletionJob) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeDataDeletionJob) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeDataDeletionJob) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeDataDeletionJob) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeDataDeletionJob) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeDataDeletionJob) 
+  [AWS 適用於 Ruby V3 的 SDK](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 Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeDataset) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeDataset) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeDataset) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeDataset) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeDataset) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeDataset) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeDataset) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeDataset) 
+  [AWS 適用於 Ruby V3 的 SDK](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 Resource Name (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 IN\$1PROGRESS
+ ACTIVE
+ 建立失敗
類型：[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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeDatasetExportJob) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeDatasetExportJob) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeDatasetExportJob) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeDatasetExportJob) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeDatasetExportJob) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeDatasetExportJob) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeDatasetExportJob) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeDatasetExportJob) 
+  [AWS 適用於 Ruby V3 的 SDK](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 Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeDatasetGroup) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeDatasetGroup) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeDatasetGroup) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeDatasetGroup) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeDatasetGroup) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeDatasetGroup) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeDatasetGroup) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeDatasetGroup) 
+  [AWS 適用於 Ruby V3 的 SDK](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 Resource Name (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 IN\$1PROGRESS
+ ACTIVE
+ 建立失敗
類型：[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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeDatasetImportJob) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeDatasetImportJob) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeDatasetImportJob) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeDatasetImportJob) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeDatasetImportJob) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeDatasetImportJob) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeDatasetImportJob) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeDatasetImportJob) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeDatasetImportJob) 

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

描述事件追蹤器。回應包含事件追蹤器`status`的 `trackingId`和 。如需事件追蹤器的詳細資訊，請參閱 [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 Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeEventTracker) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeEventTracker) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeEventTracker) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeEventTracker) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeEventTracker) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeEventTracker) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeEventTracker) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeEventTracker) 
+  [AWS 適用於 Ruby V3 的 SDK](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 Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeFeatureTransformation) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeFeatureTransformation) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeFeatureTransformation) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeFeatureTransformation) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeFeatureTransformation) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeFeatureTransformation) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeFeatureTransformation) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeFeatureTransformation) 
+  [AWS 適用於 Ruby V3 的 SDK](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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeFilter) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeFilter) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeFilter) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeFilter) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeFilter) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeFilter) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeFilter) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeFilter) 
+  [AWS 適用於 Ruby V3 的 SDK](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 Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeMetricAttribution) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeMetricAttribution) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeMetricAttribution) 
+  [AWS 適用於 Java V2 的開發套件](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeMetricAttribution) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeMetricAttribution) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeMetricAttribution) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeMetricAttribution) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeMetricAttribution) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeMetricAttribution) 

# DescribeRecipe
<a name="API_DescribeRecipe"></a>

描述配方。

配方包含三個項目：
+ 訓練模型的演算法。
+ 管理訓練的超參數。
+ 在訓練之前修改輸入資料的功能轉換資訊。

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 Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeRecipe) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeRecipe) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeRecipe) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeRecipe) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeRecipe) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeRecipe) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeRecipe) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeRecipe) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeRecipe) 

# DescribeRecommender
<a name="API_DescribeRecommender"></a>

描述指定的推薦者，包括其狀態。

推薦者可以處於下列其中一種狀態：
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ 停止待定 > 停止 IN\$1PROGRESS > 非作用中 > 啟動待定 > 啟動 IN\$1PROGRESS > 作用中
+ 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 Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeRecommender) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeRecommender) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeRecommender) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeRecommender) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeRecommender) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeRecommender) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeRecommender) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeRecommender) 
+  [AWS 適用於 Ruby V3 的 SDK](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 Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeSchema) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeSchema) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeSchema) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeSchema) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeSchema) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeSchema) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeSchema) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeSchema) 
+  [AWS 適用於 Ruby V3 的 SDK](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 Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeSolution) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeSolution) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeSolution) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeSolution) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeSolution) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeSolution) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeSolution) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeSolution) 
+  [AWS 適用於 Ruby V3 的 SDK](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 Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeSolutionVersion) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeSolutionVersion) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeSolutionVersion) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeSolutionVersion) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeSolutionVersion) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeSolutionVersion) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeSolutionVersion) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeSolutionVersion) 
+  [AWS 適用於 Ruby V3 的 SDK](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 Resource Name (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)。  
類型：String 到 double 映射  
映射項目：最多 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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/GetSolutionMetrics) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/GetSolutionMetrics) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/GetSolutionMetrics) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/GetSolutionMetrics) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/GetSolutionMetrics) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/GetSolutionMetrics) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/GetSolutionMetrics) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/GetSolutionMetrics) 
+  [AWS 適用於 Ruby V3 的 SDK](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 Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListBatchInferenceJobs) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListBatchInferenceJobs) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListBatchInferenceJobs) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListBatchInferenceJobs) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListBatchInferenceJobs) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListBatchInferenceJobs) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListBatchInferenceJobs) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListBatchInferenceJobs) 
+  [AWS 適用於 Ruby V3 的 SDK](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 Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListBatchSegmentJobs) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListBatchSegmentJobs) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListBatchSegmentJobs) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListBatchSegmentJobs) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListBatchSegmentJobs) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListBatchSegmentJobs) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListBatchSegmentJobs) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListBatchSegmentJobs) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListBatchSegmentJobs) 

# ListCampaigns
<a name="API_ListCampaigns"></a>

傳回使用指定解決方案的行銷活動清單。未指定解決方案時，會列出與該帳戶相關聯的所有行銷活動。回應提供每個行銷活動的屬性，包括 Amazon Resource Name (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 Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListCampaigns) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListCampaigns) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListCampaigns) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListCampaigns) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListCampaigns) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListCampaigns) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListCampaigns) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListCampaigns) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListCampaigns) 

# ListDataDeletionJobs
<a name="API_ListDataDeletionJobs"></a>

傳回依建立時間排序之資料集群組的資料刪除任務清單，以最新的先到者為準。未指定資料集群組時，會列出與帳戶相關聯的所有資料刪除任務。回應提供每個任務的屬性，包括 Amazon Resource Name (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 Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListDataDeletionJobs) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListDataDeletionJobs) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListDataDeletionJobs) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListDataDeletionJobs) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListDataDeletionJobs) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListDataDeletionJobs) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListDataDeletionJobs) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListDataDeletionJobs) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListDataDeletionJobs) 

# ListDatasetExportJobs
<a name="API_ListDatasetExportJobs"></a>

傳回使用指定資料集的資料集匯出任務清單。未指定資料集時，會列出與帳戶相關聯的所有資料集匯出任務。回應提供每個資料集匯出任務的屬性，包括 Amazon Resource Name (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 Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListDatasetExportJobs) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListDatasetExportJobs) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListDatasetExportJobs) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListDatasetExportJobs) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListDatasetExportJobs) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListDatasetExportJobs) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListDatasetExportJobs) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListDatasetExportJobs) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListDatasetExportJobs) 

# ListDatasetGroups
<a name="API_ListDatasetGroups"></a>

傳回資料集群組的清單。回應提供每個資料集群組的屬性，包括 Amazon Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListDatasetGroups) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListDatasetGroups) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListDatasetGroups) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListDatasetGroups) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListDatasetGroups) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListDatasetGroups) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListDatasetGroups) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListDatasetGroups) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListDatasetGroups) 

# ListDatasetImportJobs
<a name="API_ListDatasetImportJobs"></a>

傳回使用指定資料集的資料集匯入任務清單。未指定資料集時，會列出與帳戶相關聯的所有資料集匯入任務。回應提供每個資料集匯入任務的屬性，包括 Amazon Resource Name (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 Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListDatasetImportJobs) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListDatasetImportJobs) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListDatasetImportJobs) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListDatasetImportJobs) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListDatasetImportJobs) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListDatasetImportJobs) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListDatasetImportJobs) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListDatasetImportJobs) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListDatasetImportJobs) 

# ListDatasets
<a name="API_ListDatasets"></a>

傳回指定資料集群組中包含的資料集清單。回應提供每個資料集的屬性，包括 Amazon Resource Name (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 Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListDatasets) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListDatasets) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListDatasets) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListDatasets) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListDatasets) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListDatasets) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListDatasets) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListDatasets) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListDatasets) 

# ListEventTrackers
<a name="API_ListEventTrackers"></a>

傳回與帳戶相關聯的事件追蹤器清單。回應提供每個事件追蹤器的屬性，包括 Amazon Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListEventTrackers) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListEventTrackers) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListEventTrackers) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListEventTrackers) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListEventTrackers) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListEventTrackers) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListEventTrackers) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListEventTrackers) 
+  [AWS 適用於 Ruby V3 的 SDK](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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListFilters) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListFilters) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListFilters) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListFilters) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListFilters) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListFilters) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListFilters) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListFilters) 
+  [AWS 適用於 Ruby V3 的 SDK](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。最大值為 100。  
必要：否

 ** [metricAttributionArn](#API_ListMetricAttributionMetrics_RequestSyntax) **   <a name="personalize-ListMetricAttributionMetrics-request-metricAttributionArn"></a>
要擷取屬性之指標屬性的 Amazon Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListMetricAttributionMetrics) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListMetricAttributionMetrics) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListMetricAttributionMetrics) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListMetricAttributionMetrics) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListMetricAttributionMetrics) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListMetricAttributionMetrics) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListMetricAttributionMetrics) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListMetricAttributionMetrics) 
+  [AWS 適用於 Ruby V3 的 SDK](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 Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
必要：否

 ** [maxResults](#API_ListMetricAttributions_RequestSyntax) **   <a name="personalize-ListMetricAttributions-request-maxResults"></a>
在結果的一頁中傳回的指標屬性數目上限。  
類型：整數  
有效範圍：最小值為 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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListMetricAttributions) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListMetricAttributions) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListMetricAttributions) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListMetricAttributions) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListMetricAttributions) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListMetricAttributions) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListMetricAttributions) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListMetricAttributions) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListMetricAttributions) 

# ListRecipes
<a name="API_ListRecipes"></a>

傳回可用配方的清單。回應提供每個配方的屬性，包括配方的 Amazon Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListRecipes) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListRecipes) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListRecipes) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListRecipes) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListRecipes) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListRecipes) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListRecipes) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListRecipes) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListRecipes) 

# ListRecommenders
<a name="API_ListRecommenders"></a>

傳回指定網域資料集群組中的推薦者清單。未指定網域資料集群組時，會列出與該帳戶相關聯的所有建議者。回應提供每個建議者的屬性，包括 Amazon Resource Name (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 Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListRecommenders) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListRecommenders) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListRecommenders) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListRecommenders) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListRecommenders) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListRecommenders) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListRecommenders) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListRecommenders) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListRecommenders) 

# ListSchemas
<a name="API_ListSchemas"></a>

傳回與帳戶相關聯的結構描述清單。回應提供每個結構描述的屬性，包括 Amazon Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListSchemas) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListSchemas) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListSchemas) 
+  [AWS 適用於 Java V2 的開發套件](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListSchemas) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListSchemas) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListSchemas) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListSchemas) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListSchemas) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListSchemas) 

# ListSolutions
<a name="API_ListSolutions"></a>

傳回指定資料集群組中的解決方案清單。未指定資料集群組時，會列出與該帳戶相關聯的所有解決方案。回應提供每個解決方案的屬性，包括 Amazon Resource Name (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 Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListSolutions) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListSolutions) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListSolutions) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListSolutions) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListSolutions) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListSolutions) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListSolutions) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListSolutions) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListSolutions) 

# ListSolutionVersions
<a name="API_ListSolutionVersions"></a>

傳回指定解決方案的解決方案版本清單。未指定解決方案時，會列出與帳戶相關聯的所有解決方案版本。回應提供每個解決方案版本的屬性，包括 Amazon Resource Name (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 Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListSolutionVersions) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListSolutionVersions) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListSolutionVersions) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListSolutionVersions) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListSolutionVersions) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListSolutionVersions) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListSolutionVersions) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListSolutionVersions) 
+  [AWS 適用於 Ruby V3 的 SDK](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 Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListTagsForResource) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListTagsForResource) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListTagsForResource) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListTagsForResource) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListTagsForResource) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListTagsForResource) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListTagsForResource) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListTagsForResource) 
+  [AWS 適用於 Ruby V3 的 SDK](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 Resource Name (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 Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/StartRecommender) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/StartRecommender) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/StartRecommender) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/StartRecommender) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/StartRecommender) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/StartRecommender) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/StartRecommender) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/StartRecommender) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/StartRecommender) 

# StopRecommender
<a name="API_StopRecommender"></a>

停止 ACTIVE 的推薦者。停止建議者會停止對建議者的計費和自動重新訓練。

## 請求語法
<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 Resource Name (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 Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/StopRecommender) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/StopRecommender) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/StopRecommender) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/StopRecommender) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/StopRecommender) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/StopRecommender) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/StopRecommender) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/StopRecommender) 
+  [AWS 適用於 Ruby V3 的 SDK](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 Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/StopSolutionVersionCreation) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/StopSolutionVersionCreation) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/StopSolutionVersionCreation) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/StopSolutionVersionCreation) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/StopSolutionVersionCreation) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/StopSolutionVersionCreation) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/StopSolutionVersionCreation) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/StopSolutionVersionCreation) 
+  [AWS 適用於 Ruby V3 的 SDK](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 Resource Name (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 **   
已超過每秒請求數的限制。  
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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/TagResource) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/TagResource) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/TagResource) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/TagResource) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/TagResource) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/TagResource) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/TagResource) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/TagResource) 
+  [AWS 適用於 Ruby V3 的 SDK](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 Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/UntagResource) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/UntagResource) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/UntagResource) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/UntagResource) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/UntagResource) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/UntagResource) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/UntagResource) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/UntagResource) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/UntagResource) 

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

 更新行銷活動以使用現有行銷活動部署重新訓練的解決方案版本、變更行銷活動的 `minProvisionedTPS`，或修改行銷活動的組態。例如，您可以將現有行銷活動的 `enableMetadataWithRecommendations` 設為 true。

 若要更新行銷活動以使用最新的解決方案版本自動啟動，請指定下列項目：
+ 針對 `SolutionVersionArn` 參數，以 `SolutionArn/$LATEST` 格式指定解決方案的 Amazon Resource Name (ARN)。
+  在 中`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)。如需行銷活動的詳細資訊，請參閱[建立行銷活動](https://docs.aws.amazon.com/personalize/latest/dg/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 Resource Name (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 將支援的每秒請求的最低佈建交易 （建議）。較高的 `minProvisionedTPS`會增加您的帳單。我們建議從 1 開始 `minProvisionedTPS`（預設值）。使用 Amazon CloudWatch 指標追蹤您的用量，並視需要增加 `minProvisionedTPS`。  
類型：整數  
有效範圍：最小值為 1。  
必要：否

 ** [solutionVersionArn](#API_UpdateCampaign_RequestSyntax) **   <a name="personalize-UpdateCampaign-request-solutionVersionArn"></a>
要部署之新模型的 Amazon Resource Name (ARN)。若要指定解決方案的最新解決方案版本，請以 `SolutionArn/$LATEST` 格式指定*解決方案*的 ARN。如果您在 [CampaignConfig](https://docs.aws.amazon.com/personalize/latest/dg/API_CampaignConfig.html) `True`中`syncWithLatestSolutionVersion`將 設定為 ，則必須使用此格式。  
 若要部署不是解決方案最新版本的模型，請指定解決方案版本的 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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/UpdateCampaign) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/UpdateCampaign) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/UpdateCampaign) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/UpdateCampaign) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/UpdateCampaign) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/UpdateCampaign) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/UpdateCampaign) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/UpdateCampaign) 
+  [AWS 適用於 Ruby V3 的 SDK](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 Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
必要：是

 ** [schemaArn](#API_UpdateDataset_RequestSyntax) **   <a name="personalize-UpdateDataset-request-schemaArn"></a>
您想要使用的新結構描述的 Amazon Resource Name (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 Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/UpdateDataset) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/UpdateDataset) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/UpdateDataset) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/UpdateDataset) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/UpdateDataset) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/UpdateDataset) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/UpdateDataset) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/UpdateDataset) 
+  [AWS 適用於 Ruby V3 的 SDK](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 Resource Name (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 Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/UpdateMetricAttribution) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/UpdateMetricAttribution) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/UpdateMetricAttribution) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/UpdateMetricAttribution) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/UpdateMetricAttribution) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/UpdateMetricAttribution) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/UpdateMetricAttribution) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/UpdateMetricAttribution) 
+  [AWS 適用於 Ruby V3 的 SDK](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 Resource Name (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 Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/UpdateRecommender) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/UpdateRecommender) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/UpdateRecommender) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/UpdateRecommender) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/UpdateRecommender) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/UpdateRecommender) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/UpdateRecommender) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/UpdateRecommender) 
+  [AWS 適用於 Ruby V3 的 SDK](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 -or- 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>
解決方案是否使用自動訓練來建立新的解決方案版本 （訓練過的模型）。您可以在 `schedulingExpression`中指定 `AutoTrainingConfig`作為解決方案組態的一部分，以變更訓練頻率。  
 如果您開啟自動訓練，第一個自動訓練會在解決方案更新完成後一小時內開始。如果您在一小時內手動建立解決方案版本，解決方案會略過第一個自動訓練。如需自動訓練的詳細資訊，請參閱[設定自動訓練](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 Resource Name (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 Resource Name (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 Resource Name (ARN) 相同。  
類型：字串  
長度限制：長度上限為 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`

## 錯誤
<a name="API_UpdateSolution_Errors"></a>

 ** InvalidInputException **   
提供欄位或參數的有效值。  
HTTP 狀態碼：400

 ** LimitExceededException **   
已超過每秒請求數的限制。  
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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/UpdateSolution) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/UpdateSolution) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/UpdateSolution) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/UpdateSolution) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/UpdateSolution) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/UpdateSolution) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/UpdateSolution) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/UpdateSolution) 
+  [AWS 適用於 Ruby V3 的 SDK](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)。如需動作資料集中動作的詳細資訊，請參閱[動作資料集](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。當您建立動作互動資料集時，Amazon Personalize 會為您建立動作互動事件追蹤器。如需詳細資訊，請參閱[動作互動事件追蹤器 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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-events-2018-03-22/PutActionInteractions) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/PutActionInteractions) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-events-2018-03-22/PutActionInteractions) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/PutActionInteractions) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-events-2018-03-22/PutActionInteractions) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-events-2018-03-22/PutActionInteractions) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-events-2018-03-22/PutActionInteractions) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-events-2018-03-22/PutActionInteractions) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/PutActionInteractions) 

# PutActions
<a name="API_UBS_PutActions"></a>

將一或多個動作新增至動作資料集。如需詳細資訊，請參閱[個別匯入動作](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>
要新增動作或動作之動作資料集的 Amazon Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-events-2018-03-22/PutActions) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/PutActions) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-events-2018-03-22/PutActions) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/PutActions) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-events-2018-03-22/PutActions) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-events-2018-03-22/PutActions) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-events-2018-03-22/PutActions) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-events-2018-03-22/PutActions) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/PutActions) 

# PutEvents
<a name="API_UBS_PutEvents"></a>

記錄項目互動事件資料。如需詳細資訊，請參閱[錄製項目互動事件](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 在事件登入之前，將事件與使用者建立關聯。如需詳細資訊，請參閱[錄製項目互動事件](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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-events-2018-03-22/PutEvents) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/PutEvents) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-events-2018-03-22/PutEvents) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/PutEvents) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-events-2018-03-22/PutEvents) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-events-2018-03-22/PutEvents) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-events-2018-03-22/PutEvents) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-events-2018-03-22/PutEvents) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/PutEvents) 

# PutItems
<a name="API_UBS_PutItems"></a>

將一或多個項目新增至項目資料集。如需詳細資訊，請參閱[個別匯入項目](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>
您要新增項目的項目資料集的 Amazon Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-events-2018-03-22/PutItems) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/PutItems) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-events-2018-03-22/PutItems) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/PutItems) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-events-2018-03-22/PutItems) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-events-2018-03-22/PutItems) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-events-2018-03-22/PutItems) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-events-2018-03-22/PutItems) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/PutItems) 

# PutUsers
<a name="API_UBS_PutUsers"></a>

將一或多個使用者新增至使用者資料集。如需詳細資訊，請參閱[個別匯入使用者](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>
您要新增使用者的使用者資料集的 Amazon Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-events-2018-03-22/PutUsers) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/PutUsers) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-events-2018-03-22/PutUsers) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/PutUsers) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-events-2018-03-22/PutUsers) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-events-2018-03-22/PutUsers) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-events-2018-03-22/PutUsers) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-events-2018-03-22/PutUsers) 
+  [AWS 適用於 Ruby V3 的 SDK](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 執行期支援下列動作：
+  [GetActionRecommendations](API_RS_GetActionRecommendations.md) 
+  [GetPersonalizedRanking](API_RS_GetPersonalizedRanking.md) 
+  [GetRecommendations](API_RS_GetRecommendations.md) 

# GetActionRecommendations
<a name="API_RS_GetActionRecommendations"></a>

傳回依預測分數以遞減順序排序的建議動作清單。如果您有部署以個人化\$1ACTIONS 配方訓練之解決方案版本的自訂行銷活動，請使用 `GetActionRecommendations` API。

如需 PersonalIZED\$1ACTIONS 配方的詳細資訊，請參閱 [PersonalIZED\$1ACTIONS 配方](https://docs.aws.amazon.com/personalize/latest/dg/nexts-best-action-recipes.html)。如需取得動作建議的詳細資訊，請參閱[取得動作建議](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 Resource Name (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>
篩選建議時要使用的值。針對篩選條件表達式中的每個預留位置參數，提供參數名稱 （在相符的情況下） 做為索引鍵，並提供篩選條件值 （做為對應值）。以逗號分隔一個參數的多個值。  
對於使用 `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 個動作。如需動作分數的資訊，請參閱[動作建議評分的運作方式](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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS 適用於 Ruby V3 的 SDK](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 Resource Name (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 Resource Name (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>
篩選建議時要使用的值。針對篩選條件表達式中的每個預留位置參數，提供參數名稱 （在相符的情況下） 做為索引鍵，並提供篩選條件值 （做為對應值）。以逗號分隔一個參數的多個值。  
對於使用 `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。  
 如需啟用行銷活動中繼資料的詳細資訊，請參閱[在行銷活動的建議中啟用中繼資料](https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-return-metadata)。  
類型：字串到字串陣列映射  
映射項目：最多 1 個項目。  
金鑰長度限制：長度上限為 256。  
陣列成員：最多 99 個項目。  
長度限制：長度上限為 150。  
必要：否

 ** [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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS 適用於 Java V2 的開發套件](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-runtime-2018-05-22/GetPersonalizedRanking) 

# GetRecommendations
<a name="API_RS_GetRecommendations"></a>

傳回建議項目的清單。對於行銷活動，行銷活動的 Amazon Resource Name (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 Resource Name (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>
篩選建議時要使用的值。針對篩選條件表達式中的每個預留位置參數，提供參數名稱 （在相符的情況下） 做為索引鍵，並提供篩選條件值 （做為對應值）。以逗號分隔一個參數的多個值。  
對於使用 `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。  
 如需啟用行銷活動中繼資料的詳細資訊，請參閱[在行銷活動的建議中啟用中繼資料](https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-return-metadata)。如需為建議者啟用中繼資料的詳細資訊，請參閱[在建議者的建議中啟用中繼資料](https://docs.aws.amazon.com/personalize/latest/dg/creating-recommenders.html#create-recommender-return-metadata)。  
類型：字串到字串陣列映射  
映射項目：最多 1 個項目。  
金鑰長度限制：長度上限為 256。  
陣列成員：最多 99 個項目。  
長度限制：長度上限為 150。  
必要：否

 ** [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 Resource Name (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 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-runtime-2018-05-22/GetRecommendations) 