

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# 操作
<a name="API_Operations"></a>

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

Amazon Personalize Events 支持以下操作：
+  [PutActionInteractions](API_UBS_PutActionInteractions.md) 
+  [PutActions](API_UBS_PutActions.md) 
+  [PutEvents](API_UBS_PutEvents.md) 
+  [PutItems](API_UBS_PutItems.md) 
+  [PutUsers](API_UBS_PutUsers.md) 

Amazon Personalize Runtime 支持以下操作：
+  [GetActionRecommendations](API_RS_GetActionRecommendations.md) 
+  [GetPersonalizedRanking](API_RS_GetPersonalizedRanking.md) 
+  [GetRecommendations](API_RS_GetRecommendations.md) 

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

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

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

根据存储在 Amazon S3 中的物品或用户的列表生成批量建议，并将建议导出到 Amazon S3 桶。

要生成批量建议，请指定解决方案版本的 ARN 以及输入和输出数据的 Amazon S3 URI。对于用户个性化、热门物品和个性化排名解决方案，批量推理作业会为输入文件中的每个用户 ID 生成建议物品列表。对于相关物品解决方案，该作业会为输入文件中的每个物品 ID 生成建议物品列表。

有关更多信息，请参阅[创建批量推理作业](https://docs.aws.amazon.com/personalize/latest/dg/getting-batch-recommendations.html)。

 如果您使用 Similar-Items 配方，Amazon Personalize 可以向批量建议添加描述性主题。要生成主题，请将作业的模式设置为 `THEME_GENERATION`，并指定在输入数据中包含物品名称的字段的名称。

 有关生成主题的更多信息，请参阅[内容生成器中带有主题的批量建议](https://docs.aws.amazon.com/personalize/latest/dg/themed-batch-recommendations.html)。

你无法通过 Trending-Now 或食谱获得批次推荐。 Next-Best-Action

## 请求语法
<a name="API_CreateBatchInferenceJob_RequestSyntax"></a>

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

## 请求参数
<a name="API_CreateBatchInferenceJob_RequestParameters"></a>

请求接受采用 JSON 格式的以下数据。

 ** [batchInferenceJobConfig](#API_CreateBatchInferenceJob_RequestSyntax) **   <a name="personalize-CreateBatchInferenceJob-request-batchInferenceJobConfig"></a>
批量推理作业的配置详情。  
类型：[BatchInferenceJobConfig](API_BatchInferenceJobConfig.md) 对象  
必需：否

 ** [batchInferenceJobMode](#API_CreateBatchInferenceJob_RequestSyntax) **   <a name="personalize-CreateBatchInferenceJob-request-batchInferenceJobMode"></a>
批量推理作业的模式。要为一组相似的物品生成描述性主题，请将作业模式设置为 `THEME_GENERATION`。如果您不想生成主题，请使用默认 `BATCH_INFERENCE`。  
 当您获得带有主题的批量建议时，将产生额外的成本。有关更多信息，请参阅 [Amazon Personalize 定价](https://aws.amazon.com/personalize/pricing/)。  
类型：字符串  
有效值：`BATCH_INFERENCE | THEME_GENERATION`  
必需：否

 ** [filterArn](#API_CreateBatchInferenceJob_RequestSyntax) **   <a name="personalize-CreateBatchInferenceJob-request-filterArn"></a>
要应用于批量推理作业的筛选器的 ARN。有关使用筛选器的更多信息，请参阅[筛选批量建议](https://docs.aws.amazon.com/personalize/latest/dg/filter-batch.html)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
必需：否

 ** [jobInput](#API_CreateBatchInferenceJob_RequestSyntax) **   <a name="personalize-CreateBatchInferenceJob-request-jobInput"></a>
指向输入文件以作为建议的基础的 Amazon S3 路径。输入材料必须采用 JSON 格式。  
类型：[BatchInferenceJobInput](API_BatchInferenceJobInput.md) 对象  
是否必需：是

 ** [jobName](#API_CreateBatchInferenceJob_RequestSyntax) **   <a name="personalize-CreateBatchInferenceJob-request-jobName"></a>
要创建的批量推理作业的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 63。  
模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*`  
是否必需：是

 ** [jobOutput](#API_CreateBatchInferenceJob_RequestSyntax) **   <a name="personalize-CreateBatchInferenceJob-request-jobOutput"></a>
指向存储作业输出的 Amazon S3 存储桶的路径。  
类型：[BatchInferenceJobOutput](API_BatchInferenceJobOutput.md) 对象  
是否必需：是

 ** [numResults](#API_CreateBatchInferenceJob_RequestSyntax) **   <a name="personalize-CreateBatchInferenceJob-request-numResults"></a>
要检索的建议的数量。  
类型：整数  
必需：否

 ** [roleArn](#API_CreateBatchInferenceJob_RequestSyntax) **   <a name="personalize-CreateBatchInferenceJob-request-roleArn"></a>
分别有权读取和写入您的输入和输出 Amazon S3 存储桶的 Amazon Identity and Access Management 角色的 ARN。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`  
是否必需：是

 ** [solutionVersionArn](#API_CreateBatchInferenceJob_RequestSyntax) **   <a name="personalize-CreateBatchInferenceJob-request-solutionVersionArn"></a>
将用于生成批量推理建议的解决方案版本的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
是否必需：是

 ** [tags](#API_CreateBatchInferenceJob_RequestSyntax) **   <a name="personalize-CreateBatchInferenceJob-request-tags"></a>
要应用于批量推理作业的[标签](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)列表。  
类型：[Tag](API_Tag.md) 对象数组  
数组成员：最少 0 个物品。最多 200 项。  
必需：否

 ** [themeGenerationConfig](#API_CreateBatchInferenceJob_RequestSyntax) **   <a name="personalize-CreateBatchInferenceJob-request-themeGenerationConfig"></a>
对于主题生成作业，请指定物品数据集中包含每个物品名称的列的名称。  
类型：[ThemeGenerationConfig](API_ThemeGenerationConfig.md) 对象  
必需：否

## 响应语法
<a name="API_CreateBatchInferenceJob_ResponseSyntax"></a>

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

## 响应元素
<a name="API_CreateBatchInferenceJob_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [batchInferenceJobArn](#API_CreateBatchInferenceJob_ResponseSyntax) **   <a name="personalize-CreateBatchInferenceJob-response-batchInferenceJobArn"></a>
批量推理作业的 ARN。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`

## 错误
<a name="API_CreateBatchInferenceJob_Errors"></a>

 ** InvalidInputException **   
为字段或参数提供有效值。  
HTTP 状态代码：400

 ** LimitExceededException **   
超出每秒请求次数的限制。  
HTTP 状态代码：400

 ** ResourceAlreadyExistsException **   
指定资源已经存在。  
HTTP 状态代码：400

 ** ResourceInUseException **   
指定的资源正在使用中。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
找不到指定的资源。  
HTTP 状态代码：400

 ** TooManyTagsException **   
您已超出您可以应用到此资源的最大标签数量。  
HTTP 状态代码：400

## 另请参阅
<a name="API_CreateBatchInferenceJob_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateBatchInferenceJob) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateBatchInferenceJob) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateBatchInferenceJob) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateBatchInferenceJob) 
+  [AWS Python 软件开发工具包](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>

创建批量细分作业。该操作最多可以处理 5000 万条记录，并且输入文件必须为 JSON 格式。有关更多信息，请参阅[获取批量建议和用户细分](https://docs.aws.amazon.com/personalize/latest/dg/recommendations-batch.html)。

## 请求语法
<a name="API_CreateBatchSegmentJob_RequestSyntax"></a>

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

## 请求参数
<a name="API_CreateBatchSegmentJob_RequestParameters"></a>

请求接受采用 JSON 格式的以下数据。

 ** [filterArn](#API_CreateBatchSegmentJob_RequestSyntax) **   <a name="personalize-CreateBatchSegmentJob-request-filterArn"></a>
要应用于批量细分作业的筛选器的 ARN。有关使用筛选器的更多信息，请参阅[筛选批量建议](https://docs.aws.amazon.com/personalize/latest/dg/filter-batch.html)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
必需：否

 ** [jobInput](#API_CreateBatchSegmentJob_RequestSyntax) **   <a name="personalize-CreateBatchSegmentJob-request-jobInput"></a>
用于生成批量细分作业的输入数据的 Amazon S3 路径。  
类型：[BatchSegmentJobInput](API_BatchSegmentJobInput.md) 对象  
是否必需：是

 ** [jobName](#API_CreateBatchSegmentJob_RequestSyntax) **   <a name="personalize-CreateBatchSegmentJob-request-jobName"></a>
要创建的批量细分作业的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 63。  
模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*`  
是否必需：是

 ** [jobOutput](#API_CreateBatchSegmentJob_RequestSyntax) **   <a name="personalize-CreateBatchSegmentJob-request-jobOutput"></a>
存储作业输出的存储桶的 Amazon S3 路径。  
类型：[BatchSegmentJobOutput](API_BatchSegmentJobOutput.md) 对象  
是否必需：是

 ** [numResults](#API_CreateBatchSegmentJob_RequestSyntax) **   <a name="personalize-CreateBatchSegmentJob-request-numResults"></a>
批量细分作业为每行输入数据生成的预测用户数。每个细分的最大用户数为 500 万。  
类型：整数  
必需：否

 ** [roleArn](#API_CreateBatchSegmentJob_RequestSyntax) **   <a name="personalize-CreateBatchSegmentJob-request-roleArn"></a>
分别有权读取和写入您的输入和输出 Amazon S3 存储桶的 Amazon Identity and Access Management 角色的 ARN。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`  
是否必需：是

 ** [solutionVersionArn](#API_CreateBatchSegmentJob_RequestSyntax) **   <a name="personalize-CreateBatchSegmentJob-request-solutionVersionArn"></a>
您希望批量细分作业用于生成批量细分的解决方案版本的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
是否必需：是

 ** [tags](#API_CreateBatchSegmentJob_RequestSyntax) **   <a name="personalize-CreateBatchSegmentJob-request-tags"></a>
要应用于批量细分作业的[标签](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)列表。  
类型：[Tag](API_Tag.md) 对象数组  
数组成员：最少 0 个物品。最多 200 项。  
必需：否

## 响应语法
<a name="API_CreateBatchSegmentJob_ResponseSyntax"></a>

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

## 响应元素
<a name="API_CreateBatchSegmentJob_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [batchSegmentJobArn](#API_CreateBatchSegmentJob_ResponseSyntax) **   <a name="personalize-CreateBatchSegmentJob-response-batchSegmentJobArn"></a>
批量细分作业的 ARN。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`

## 错误
<a name="API_CreateBatchSegmentJob_Errors"></a>

 ** InvalidInputException **   
为字段或参数提供有效值。  
HTTP 状态代码：400

 ** LimitExceededException **   
超出每秒请求次数的限制。  
HTTP 状态代码：400

 ** ResourceAlreadyExistsException **   
指定资源已经存在。  
HTTP 状态代码：400

 ** ResourceInUseException **   
指定的资源正在使用中。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
找不到指定的资源。  
HTTP 状态代码：400

 ** TooManyTagsException **   
您已超出您可以应用到此资源的最大标签数量。  
HTTP 状态代码：400

## 另请参阅
<a name="API_CreateBatchSegmentJob_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateBatchSegmentJob) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateBatchSegmentJob) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateBatchSegmentJob) 
+  [AWS Python 软件开发工具包](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 - 或 - CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS

要获取活动状态，请致电[DescribeCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html)。

**注意**  
等到市场活动的 `status` 为 `ACTIVE` 时，再向市场活动询问建议。

**相关 APIs**
+  [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 资源名称（ARN）。要指定解决方案的最新解决方案版本，请以 `SolutionArn/$LATEST` 格式指定*解决方案*的 ARN。如果`True`在中设置为`syncWithLatestSolutionVersion`，则必须使用此格式[CampaignConfig](https://docs.aws.amazon.com/personalize/latest/dg/API_CampaignConfig.html)。  
 如果要部署的模型不是解决方案的最新解决方案版本，请指定解决方案版本的 ARN。  
 有关自动市场活动更新的更多信息，请参阅[启用自动市场活动更新](https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-automatic-latest-sv-update)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
是否必需：是

 ** [tags](#API_CreateCampaign_RequestSyntax) **   <a name="personalize-CreateCampaign-request-tags"></a>
要应用于市场活动的[标签](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)列表。  
类型：[Tag](API_Tag.md) 对象数组  
数组成员：最少 0 个物品。最多 200 项。  
必需：否

## 响应语法
<a name="API_CreateCampaign_ResponseSyntax"></a>

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

## 响应元素
<a name="API_CreateCampaign_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [campaignArn](#API_CreateCampaign_ResponseSyntax) **   <a name="personalize-CreateCampaign-response-campaignArn"></a>
市场活动的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`

## 错误
<a name="API_CreateCampaign_Errors"></a>

 ** InvalidInputException **   
为字段或参数提供有效值。  
HTTP 状态代码：400

 ** LimitExceededException **   
超出每秒请求次数的限制。  
HTTP 状态代码：400

 ** ResourceAlreadyExistsException **   
指定资源已经存在。  
HTTP 状态代码：400

 ** ResourceInUseException **   
指定的资源正在使用中。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
找不到指定的资源。  
HTTP 状态代码：400

 ** TooManyTagsException **   
您已超出您可以应用到此资源的最大标签数量。  
HTTP 状态代码：400

## 另请参阅
<a name="API_CreateCampaign_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateCampaign) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateCampaign) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateCampaign) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateCampaign) 
+  [AWS Python 软件开发工具包](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 存储桶中包含用户 ID 的 CSV 文件中指定要删除的用户。作业完成后，Amazon Personalize 将不再根据用户的数据进行训练，在生成用户细分时也不再考虑这些用户。有关创建数据删除作业的更多信息，请参阅[删除用户](https://docs.aws.amazon.com/personalize/latest/dg/delete-records.html)。
+ 您的输入文件必须是一个 CSV 文件，其中包含一个列出用户的 USER\$1ID 列。 IDs有关准备 CSV 文件的更多信息，请参阅[准备数据删除文件并将其上传到 Amazon S3](https://docs.aws.amazon.com/personalize/latest/dg/prepare-deletion-input-file.html)。
+ 要允许 Amazon Personalize 访问您的包含用户 ID 的输入 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 会继续在训练时使用这些数据。而且，如果您使用 User Segmentation 配方，则用户可能会出现在用户细分中。

 **状态** 

数据删除作业可能具有以下某一状态：
+ PENDING > IN\$1PROGRESS > COMPLETED 或 FAILED

要获取数据删除任务的状态，请调用 [DescribeDataDeletionJob](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataDeletionJob.html)API 操作并指定该任务的 Amazon 资源名称 (ARN)。如果状态为 FAILED，则响应中包含一个描述作业失败原因的 `failureReason` 键。

**相关 APIs**
+  [ListDataDeletionJobs](https://docs.aws.amazon.com/personalize/latest/dg/API_ListDataDeletionJobs.html) 
+  [DescribeDataDeletionJob](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataDeletionJob.html) 

## 请求语法
<a name="API_CreateDataDeletionJob_RequestSyntax"></a>

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

## 请求参数
<a name="API_CreateDataDeletionJob_RequestParameters"></a>

请求接受采用 JSON 格式的以下数据。

 ** [datasetGroupArn](#API_CreateDataDeletionJob_RequestSyntax) **   <a name="personalize-CreateDataDeletionJob-request-datasetGroupArn"></a>
数据集组（包含您希望从中删除记录的数据集）的 Amazon 资源名称（ARN）。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
是否必需：是

 ** [dataSource](#API_CreateDataDeletionJob_RequestSyntax) **   <a name="personalize-CreateDataDeletionJob-request-dataSource"></a>
包含待删除用户的用户 ID 列表的 Amazon S3 存储桶。  
类型：[DataSource](API_DataSource.md) 对象  
是否必需：是

 ** [jobName](#API_CreateDataDeletionJob_RequestSyntax) **   <a name="personalize-CreateDataDeletionJob-request-jobName"></a>
数据删除作业的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 63。  
模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*`  
是否必需：是

 ** [roleArn](#API_CreateDataDeletionJob_RequestSyntax) **   <a name="personalize-CreateDataDeletionJob-request-roleArn"></a>
有权从 Amazon S3 数据来源读取的 IAM 角色的 Amazon 资源名称（ARN）。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`  
是否必需：是

 ** [tags](#API_CreateDataDeletionJob_RequestSyntax) **   <a name="personalize-CreateDataDeletionJob-request-tags"></a>
要应用于数据删除作业的[标签](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)列表。  
类型：[Tag](API_Tag.md) 对象数组  
数组成员：最少 0 个物品。最多 200 项。  
必需：否

## 响应语法
<a name="API_CreateDataDeletionJob_ResponseSyntax"></a>

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

## 响应元素
<a name="API_CreateDataDeletionJob_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [dataDeletionJobArn](#API_CreateDataDeletionJob_ResponseSyntax) **   <a name="personalize-CreateDataDeletionJob-response-dataDeletionJobArn"></a>
数据删除作业的 Amazon 资源名称（ARN）。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`

## 错误
<a name="API_CreateDataDeletionJob_Errors"></a>

 ** InvalidInputException **   
为字段或参数提供有效值。  
HTTP 状态代码：400

 ** LimitExceededException **   
超出每秒请求次数的限制。  
HTTP 状态代码：400

 ** ResourceAlreadyExistsException **   
指定资源已经存在。  
HTTP 状态代码：400

 ** ResourceInUseException **   
指定的资源正在使用中。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
找不到指定的资源。  
HTTP 状态代码：400

 ** TooManyTagsException **   
您已超出您可以应用到此资源的最大标签数量。  
HTTP 状态代码：400

## 另请参阅
<a name="API_CreateDataDeletionJob_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateDataDeletionJob) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateDataDeletionJob) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateDataDeletionJob) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateDataDeletionJob) 
+  [AWS Python 软件开发工具包](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 - 或 - CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS

要获取数据集的状态，请调用[DescribeDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html)。

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

## 请求语法
<a name="API_CreateDataset_RequestSyntax"></a>

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

## 请求参数
<a name="API_CreateDataset_RequestParameters"></a>

请求接受采用 JSON 格式的以下数据。

 ** [datasetGroupArn](#API_CreateDataset_RequestSyntax) **   <a name="personalize-CreateDataset-request-datasetGroupArn"></a>
要添加到数据集的数据集组的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
是否必需：是

 ** [datasetType](#API_CreateDataset_RequestSyntax) **   <a name="personalize-CreateDataset-request-datasetType"></a>
数据集的类型。  
以下一个值（区分大小写）：  
+ 交互
+ 物品
+ 用户
+ 操作
+ Action\$1Interactions
类型：字符串  
长度约束：最大长度为 256。  
模式：`^[A-Za-z_]+$`  
是否必需：是

 ** [name](#API_CreateDataset_RequestSyntax) **   <a name="personalize-CreateDataset-request-name"></a>
数据集的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 63。  
模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*`  
是否必需：是

 ** [schemaArn](#API_CreateDataset_RequestSyntax) **   <a name="personalize-CreateDataset-request-schemaArn"></a>
与数据集关联的架构的 ARN。架构定义数据集字段。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
是否必需：是

 ** [tags](#API_CreateDataset_RequestSyntax) **   <a name="personalize-CreateDataset-request-tags"></a>
要应用于数据集的[标签](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)列表。  
类型：[Tag](API_Tag.md) 对象数组  
数组成员：最少 0 个物品。最多 200 项。  
必需：否

## 响应语法
<a name="API_CreateDataset_ResponseSyntax"></a>

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

## 响应元素
<a name="API_CreateDataset_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [datasetArn](#API_CreateDataset_ResponseSyntax) **   <a name="personalize-CreateDataset-response-datasetArn"></a>
数据集的 ARN。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`

## 错误
<a name="API_CreateDataset_Errors"></a>

 ** InvalidInputException **   
为字段或参数提供有效值。  
HTTP 状态代码：400

 ** LimitExceededException **   
超出每秒请求次数的限制。  
HTTP 状态代码：400

 ** ResourceAlreadyExistsException **   
指定资源已经存在。  
HTTP 状态代码：400

 ** ResourceInUseException **   
指定的资源正在使用中。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
找不到指定的资源。  
HTTP 状态代码：400

 ** TooManyTagsException **   
您已超出您可以应用到此资源的最大标签数量。  
HTTP 状态代码：400

## 另请参阅
<a name="API_CreateDataset_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateDataset) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateDataset) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateDataset) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateDataset) 
+  [AWS Python 软件开发工具包](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 Personalize 提供对 Amazon S3 存储桶的 `PutObject` 权限。有关信息，请参阅《Amazon Personalize 开发人员指南》中的[导出数据集](https://docs.aws.amazon.com/personalize/latest/dg/export-data.html)。

 **状态** 

数据集导出作业可处于以下几种状态之一：
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE - 或 - CREATE FAILED

 要获取导出任务的状态 [DescribeDatasetExportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetExportJob.html)，请调用并指定数据集导出任务的 Amazon 资源名称 (ARN)。当状态显示为 ACTIVE 时，数据集导出完成。如果状态显示为 CREATE FAILED，则响应中包含一个描述作业失败原因的 `failureReason` 键。

## 请求语法
<a name="API_CreateDatasetExportJob_RequestSyntax"></a>

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

## 请求参数
<a name="API_CreateDatasetExportJob_RequestParameters"></a>

请求接受采用 JSON 格式的以下数据。

 ** [datasetArn](#API_CreateDatasetExportJob_RequestSyntax) **   <a name="personalize-CreateDatasetExportJob-request-datasetArn"></a>
包含要导出的数据的数据集的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
是否必需：是

 ** [ingestionMode](#API_CreateDatasetExportJob_RequestSyntax) **   <a name="personalize-CreateDatasetExportJob-request-ingestionMode"></a>
要导出的数据，取决于您导入数据的方式。您可以选择仅导出使用`BULK`数据集导入任务导入的数据或以增量方式导入`PUT`的数据（使用控制台 PutUsers 和 PutItems 操作） PutEvents，或者同时导`ALL`出两种类型的数据。默认值为 `PUT`。  
类型：字符串  
有效值：`BULK | PUT | ALL`  
必需：否

 ** [jobName](#API_CreateDatasetExportJob_RequestSyntax) **   <a name="personalize-CreateDatasetExportJob-request-jobName"></a>
数据集导出作业的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 63。  
模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*`  
是否必需：是

 ** [jobOutput](#API_CreateDatasetExportJob_RequestSyntax) **   <a name="personalize-CreateDatasetExportJob-request-jobOutput"></a>
指向存储作业输出的 Amazon S3 存储桶的路径。  
类型：[DatasetExportJobOutput](API_DatasetExportJobOutput.md) 对象  
是否必需：是

 ** [roleArn](#API_CreateDatasetExportJob_RequestSyntax) **   <a name="personalize-CreateDatasetExportJob-request-roleArn"></a>
有权向输出 Amazon S3 存储桶添加数据的 IAM 服务角色的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`  
是否必需：是

 ** [tags](#API_CreateDatasetExportJob_RequestSyntax) **   <a name="personalize-CreateDatasetExportJob-request-tags"></a>
要应用于数据集导出作业的[标签](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)列表。  
类型：[Tag](API_Tag.md) 对象数组  
数组成员：最少 0 个物品。最多 200 项。  
必需：否

## 响应语法
<a name="API_CreateDatasetExportJob_ResponseSyntax"></a>

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

## 响应元素
<a name="API_CreateDatasetExportJob_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [datasetExportJobArn](#API_CreateDatasetExportJob_ResponseSyntax) **   <a name="personalize-CreateDatasetExportJob-response-datasetExportJobArn"></a>
数据集导出作业的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`

## 错误
<a name="API_CreateDatasetExportJob_Errors"></a>

 ** InvalidInputException **   
为字段或参数提供有效值。  
HTTP 状态代码：400

 ** LimitExceededException **   
超出每秒请求次数的限制。  
HTTP 状态代码：400

 ** ResourceAlreadyExistsException **   
指定资源已经存在。  
HTTP 状态代码：400

 ** ResourceInUseException **   
指定的资源正在使用中。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
找不到指定的资源。  
HTTP 状态代码：400

 ** TooManyTagsException **   
您已超出您可以应用到此资源的最大标签数量。  
HTTP 状态代码：400

## 另请参阅
<a name="API_CreateDatasetExportJob_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateDatasetExportJob) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateDatasetExportJob) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateDatasetExportJob) 
+  [AWS Python 软件开发工具包](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 - 或 - CREATE FAILED
+ DELETE PENDING

要获取数据集组的状态，请调用[DescribeDatasetGroup](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetGroup.html)。如果状态显示为 CREATE FAILED，则响应中包含一个描述创建失败原因的 `failureReason` 键。

**注意**  
必须等到数据集组的 `status` 为 `ACTIVE`，然后才能向该组添加数据集。

您可以指定 AWS Key Management Service (KMS) 密钥来加密组中的数据集。如果您指定 KMS 密钥，则还必须包括有权访问该密钥的 AWS Identity and Access Management (IAM) 角色。

**APIs 请求中需要数据集组 ARN**
+  [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) 

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

## 请求语法
<a name="API_CreateDatasetGroup_RequestSyntax"></a>

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

## 请求参数
<a name="API_CreateDatasetGroup_RequestParameters"></a>

请求接受采用 JSON 格式的以下数据。

 ** [domain](#API_CreateDatasetGroup_RequestSyntax) **   <a name="personalize-CreateDatasetGroup-request-domain"></a>
数据集组的域。要创建域数据集组，请指定域。您指定的域决定了数据集的默认架构和推荐器可用的使用案例。如果您未指定域，则可以创建一个自定义数据集组，其中包含您通过市场活动部署的解决方案版本。  
类型：字符串  
有效值：`ECOMMERCE | VIDEO_ON_DEMAND`  
必需：否

 ** [kmsKeyArn](#API_CreateDatasetGroup_RequestSyntax) **   <a name="personalize-CreateDatasetGroup-request-kmsKeyArn"></a>
用于加密数据集的 (KMS) 密钥的亚马逊资源名称 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>
有权访问 (KMS) 密钥的 AWS Identity and Access Management (IAM) 角色的 AWS Key Management Service 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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateDatasetGroup) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateDatasetGroup) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateDatasetGroup) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateDatasetGroup) 
+  [AWS Python 软件开发工具包](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 操作中为导入模式指定 “增量”。

 **状态** 

数据集导入作业可处于以下几种状态之一：
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE - 或 - CREATE FAILED

要获取导入任务的状态，请致电 [DescribeDatasetImportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetImportJob.html)，提供数据集导入任务的 Amazon 资源名称 (ARN)。当状态显示为 ACTIVE 时，数据集导入完成。如果状态显示为 CREATE FAILED，则响应中包含一个描述作业失败原因的 `failureReason` 键。

**注意**  
导入需要耗费时间。您必须等到状态显示为 ACTIVE，然后才能使用数据集训练模型。

**相关 APIs**
+  [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>
有权读取 Amazon S3 数据来源的 IAM 角色的 ARN。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`  
必需：否

 ** [tags](#API_CreateDatasetImportJob_RequestSyntax) **   <a name="personalize-CreateDatasetImportJob-request-tags"></a>
要应用于数据集导入作业的[标签](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)列表。  
类型：[Tag](API_Tag.md) 对象数组  
数组成员：最少 0 个物品。最多 200 项。  
必需：否

## 响应语法
<a name="API_CreateDatasetImportJob_ResponseSyntax"></a>

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

## 响应元素
<a name="API_CreateDatasetImportJob_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [datasetImportJobArn](#API_CreateDatasetImportJob_ResponseSyntax) **   <a name="personalize-CreateDatasetImportJob-response-datasetImportJobArn"></a>
数据集导入作业的 ARN。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`

## 错误
<a name="API_CreateDatasetImportJob_Errors"></a>

 ** InvalidInputException **   
为字段或参数提供有效值。  
HTTP 状态代码：400

 ** LimitExceededException **   
超出每秒请求次数的限制。  
HTTP 状态代码：400

 ** ResourceAlreadyExistsException **   
指定资源已经存在。  
HTTP 状态代码：400

 ** ResourceInUseException **   
指定的资源正在使用中。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
找不到指定的资源。  
HTTP 状态代码：400

 ** TooManyTagsException **   
您已超出您可以应用到此资源的最大标签数量。  
HTTP 状态代码：400

## 另请参阅
<a name="API_CreateDatasetImportJob_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateDatasetImportJob) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateDatasetImportJob) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateDatasetImportJob) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateDatasetImportJob) 
+  [AWS Python 软件开发工具包](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 - 或 - CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS

要获取事件跟踪器的状态，请致电[DescribeEventTracker](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeEventTracker.html)。

**注意**  
在使用跟踪 ID 之前，事件跟踪器必须处于 ACTIVE 状态。

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

## 请求语法
<a name="API_CreateEventTracker_RequestSyntax"></a>

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

## 请求参数
<a name="API_CreateEventTracker_RequestParameters"></a>

请求接受采用 JSON 格式的以下数据。

 ** [datasetGroupArn](#API_CreateEventTracker_RequestSyntax) **   <a name="personalize-CreateEventTracker-request-datasetGroupArn"></a>
接收事件数据的数据集组的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
是否必需：是

 ** [name](#API_CreateEventTracker_RequestSyntax) **   <a name="personalize-CreateEventTracker-request-name"></a>
事件跟踪器的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 63。  
模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*`  
是否必需：是

 ** [tags](#API_CreateEventTracker_RequestSyntax) **   <a name="personalize-CreateEventTracker-request-tags"></a>
要应用于事件跟踪器的[标签](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)列表。  
类型：[Tag](API_Tag.md) 对象数组  
数组成员：最少 0 个物品。最多 200 项。  
必需：否

## 响应语法
<a name="API_CreateEventTracker_ResponseSyntax"></a>

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

## 响应元素
<a name="API_CreateEventTracker_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [eventTrackerArn](#API_CreateEventTracker_ResponseSyntax) **   <a name="personalize-CreateEventTracker-response-eventTrackerArn"></a>
事件跟踪器的 ARN。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`

 ** [trackingId](#API_CreateEventTracker_ResponseSyntax) **   <a name="personalize-CreateEventTracker-response-trackingId"></a>
事件跟踪器的 ID。在向 [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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateEventTracker) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateEventTracker) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateEventTracker) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateEventTracker) 
+  [AWS Python 软件开发工具包](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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateFilter) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateFilter) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateFilter) 
+  [AWS Python 软件开发工具包](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 资源名称 (ARN)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
是否必需：是

 ** [metrics](#API_CreateMetricAttribution_RequestSyntax) **   <a name="personalize-CreateMetricAttribution-request-metrics"></a>
指标归因的指标属性列表。每个指标属性都指定了要跟踪的事件类型和函数。可用函数为 `SUM()` 或 `SAMPLECOUNT()`。对于 SUM() 函数，提供数据集类型（交互或物品）及要求和的列作为参数。例如 SUM(Items.PRICE)。  
类型：[MetricAttribute](API_MetricAttribute.md) 对象数组  
数组成员：最多 10 项。  
是否必需：是

 ** [metricsOutputConfig](#API_CreateMetricAttribution_RequestSyntax) **   <a name="personalize-CreateMetricAttribution-request-metricsOutputConfig"></a>
指标归因的输出配置详细信息。  
类型：[MetricAttributionOutput](API_MetricAttributionOutput.md) 对象  
是否必需：是

 ** [name](#API_CreateMetricAttribution_RequestSyntax) **   <a name="personalize-CreateMetricAttribution-request-name"></a>
指标归因的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 63。  
模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*`  
必需：是

## 响应语法
<a name="API_CreateMetricAttribution_ResponseSyntax"></a>

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

## 响应元素
<a name="API_CreateMetricAttribution_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [metricAttributionArn](#API_CreateMetricAttribution_ResponseSyntax) **   <a name="personalize-CreateMetricAttribution-response-metricAttributionArn"></a>
新指标归因的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`

## 错误
<a name="API_CreateMetricAttribution_Errors"></a>

 ** InvalidInputException **   
为字段或参数提供有效值。  
HTTP 状态代码：400

 ** LimitExceededException **   
超出每秒请求次数的限制。  
HTTP 状态代码：400

 ** ResourceAlreadyExistsException **   
指定资源已经存在。  
HTTP 状态代码：400

 ** ResourceInUseException **   
指定的资源正在使用中。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
找不到指定的资源。  
HTTP 状态代码：400

## 另请参阅
<a name="API_CreateMetricAttribution_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateMetricAttribution) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateMetricAttribution) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateMetricAttribution) 
+  [AWS Python 软件开发工具包](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>

通过您指定的食谱（域数据集组使用案例）创建推荐器。您可以为域数据集组创建推荐器，并在提出请求时指定推荐人的亚马逊资源名称 (ARN)。[GetRecommendations](https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html)

 **最低每秒建议请求数** 

**重要**  
高 `minRecommendationRequestsPerSecond` 会增加您的账单费用。我们建议从 1 开始设置 `minRecommendationRequestsPerSecond`（默认值）。使用 Amazon CloudWatch 指标跟踪您的使用情况，并在必要`minRecommendationRequestsPerSecond`时增加使用量。

创建推荐器时，您可以配置推荐器的每秒最低建议请求数。每秒最低建议请求数 (`minRecommendationRequestsPerSecond`) 指定了 Amazon Personalize 预调配的基准建议请求吞吐量。默认值 minRecommendationRequestsPerSecond 为`1`。建议请求是单个 `GetRecommendations` 操作。请求吞吐量以每秒请求数来衡量，Amazon Personalize 使用每秒请求数来计算每小时请求数和推荐器使用量的价格。

 如果您的每秒请求数增加到超过 `minRecommendationRequestsPerSecond`，则 Amazon Personalize 会自动纵向扩展和缩减预调配容量，但永远不会低于 `minRecommendationRequestsPerSecond`。增加容量时会有短时间延迟，这可能会导致请求丢失。

 您的账单是每小时最低请求数（基于 minRecommendationRequestsPerSecond）或实际请求数中的较大值。使用的实际请求吞吐量按一小时窗口 requests/second 内的平均值计算。我们建议从默认值开始`minRecommendationRequestsPerSecond`，使用 Amazon CloudWatch 指标跟踪您的使用情况，然后`minRecommendationRequestsPerSecond`根据需要增加使用量。

 **状态** 

推荐器可处于以下一种状态：
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE - 或 - CREATE FAILED
+ STOP PENDING > STOP IN\$1PROGRESS > INACTIVE > START PENDING > START IN\$1PROGRESS > ACTIVE
+ DELETE PENDING > DELETE IN\$1PROGRESS

要获取推荐人状态，请致[DescribeRecommender](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html)电。

**注意**  
等到推荐器的 `status` 为 `ACTIVE` 时，再向推荐器询问建议。

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

## 请求语法
<a name="API_CreateRecommender_RequestSyntax"></a>

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

## 请求参数
<a name="API_CreateRecommender_RequestParameters"></a>

请求接受采用 JSON 格式的以下数据。

 ** [datasetGroupArn](#API_CreateRecommender_RequestSyntax) **   <a name="personalize-CreateRecommender-request-datasetGroupArn"></a>
推荐器目标域数据集组的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
是否必需：是

 ** [name](#API_CreateRecommender_RequestSyntax) **   <a name="personalize-CreateRecommender-request-name"></a>
推荐器的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 63。  
模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*`  
是否必需：是

 ** [recipeArn](#API_CreateRecommender_RequestSyntax) **   <a name="personalize-CreateRecommender-request-recipeArn"></a>
推荐器将使用的食谱的 Amazon 资源名称 (ARN)。对于推荐器，食谱是域数据集组使用案例。只能使用域数据集组使用案例来创建推荐器。有关使用案例的信息，请参阅[选择推荐器使用案例](https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
是否必需：是

 ** [recommenderConfig](#API_CreateRecommender_RequestSyntax) **   <a name="personalize-CreateRecommender-request-recommenderConfig"></a>
推荐器的配置详细信息。  
类型：[RecommenderConfig](API_RecommenderConfig.md) 对象  
必需：否

 ** [tags](#API_CreateRecommender_RequestSyntax) **   <a name="personalize-CreateRecommender-request-tags"></a>
要应用于推荐器的[标签](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)列表。  
类型：[Tag](API_Tag.md) 对象数组  
数组成员：最少 0 个物品。最多 200 项。  
必需：否

## 响应语法
<a name="API_CreateRecommender_ResponseSyntax"></a>

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

## 响应元素
<a name="API_CreateRecommender_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [recommenderArn](#API_CreateRecommender_ResponseSyntax) **   <a name="personalize-CreateRecommender-response-recommenderArn"></a>
推荐器的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`

## 错误
<a name="API_CreateRecommender_Errors"></a>

 ** InvalidInputException **   
为字段或参数提供有效值。  
HTTP 状态代码：400

 ** LimitExceededException **   
超出每秒请求次数的限制。  
HTTP 状态代码：400

 ** ResourceAlreadyExistsException **   
指定资源已经存在。  
HTTP 状态代码：400

 ** ResourceInUseException **   
指定的资源正在使用中。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
找不到指定的资源。  
HTTP 状态代码：400

 ** TooManyTagsException **   
您已超出您可以应用到此资源的最大标签数量。  
HTTP 状态代码：400

## 另请参阅
<a name="API_CreateRecommender_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateRecommender) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateRecommender) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateRecommender) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateRecommender) 
+  [AWS Python 软件开发工具包](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)。

**相关 APIs**
+  [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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateSchema) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateSchema) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateSchema) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateSchema) 
+  [AWS Python 软件开发工具包](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 天创建一个解决方案版本。您可以更改训练频率。解决方案处于活动状态后，自动解决方案版本创建会在一小时内开始。如果您在一小时内手动创建解决方案版本，则解决方案会跳过第一次自动训练。有关更多信息，请参阅[配置自动训练](https://docs.aws.amazon.com/personalize/latest/dg/solution-config-auto-training.html)。

 要关闭自动训练，请将 `performAutoTraining` 设置为 false。如果您关闭自动训练，则必须通过调用[CreateSolutionVersion](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolutionVersion.html)操作来手动创建解决方案版本。

训练开始后，您可以通过 [ListSolutionVersions](https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html)API 操作获取解决方案版本的 Amazon 资源名称 (ARN)。要获取其状态，请使用[DescribeSolutionVersion](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html)。

训练完成后，您可以通过调用来评估模型精度[GetSolutionMetrics](https://docs.aws.amazon.com/personalize/latest/dg/API_GetSolutionMetrics.html)。如果您对解决方案版本感到满意，则使用进行部署[CreateCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html)。该活动通过 [GetRecommendations](https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html)API 向客户提供推荐。

**注意**  
Amazon Personalize 目前不支持配置用于解决方案超参数优化的 `hpoObjective`。

 **状态** 

解决方案可处于以下几种状态之一：
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE - 或 - CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS

要获取解决方案的状态，请致电[DescribeSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html)。如果您使用手动训练，则在调用 `CreateSolutionVersion` 之前，状态必须为 ACTIVE。

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

## 请求语法
<a name="API_CreateSolution_RequestSyntax"></a>

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

## 请求参数
<a name="API_CreateSolution_RequestParameters"></a>

请求接受采用 JSON 格式的以下数据。

 ** [datasetGroupArn](#API_CreateSolution_RequestSyntax) **   <a name="personalize-CreateSolution-request-datasetGroupArn"></a>
提供训练数据的数据集组的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
是否必需：是

 ** [eventType](#API_CreateSolution_RequestSyntax) **   <a name="personalize-CreateSolution-request-eventType"></a>
当您有多个事件类型（使用 `EVENT_TYPE` 架构字段）时，此参数指定使用哪种事件类型（例如，“单击”或“点赞”）来训练模型。  
如果没有提供 `eventType`，则 Amazon Personalize 将使用所有交互进行同等权重的训练，而不考虑类型。  
类型：字符串  
长度约束：最大长度为 256。  
必需：否

 ** [name](#API_CreateSolution_RequestSyntax) **   <a name="personalize-CreateSolution-request-name"></a>
解决方案的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 63。  
模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*`  
是否必需：是

 ** [performAutoML](#API_CreateSolution_RequestSyntax) **   <a name="personalize-CreateSolution-request-performAutoML"></a>
我们建议不要启用自动机器学习。相反，请将您的使用案例与可用的 Amazon Personalize 配方匹配。有关更多信息，请参阅[选择配方](https://docs.aws.amazon.com/personalize/latest/dg/working-with-predefined-recipes.html)。
是否执行自动机器学习 (AutoML)。默认值为 `false`。对于这种情况，您必须指定 `recipeArn`。  
设置为 `true` 时，Amazon Personalize 会分析您的训练数据并选择最佳 USER\$1PERSONALIZATION 食谱和超参数。在这种情况下，必须省略 `recipeArn`。Amazon Personalize 通过使用不同的超参数值来运行测试，以确定最佳食谱。与选择特定食谱相比，AutoML 可以延长训练过程。  
类型：布尔值  
必需：否

 ** [performAutoTraining](#API_CreateSolution_RequestSyntax) **   <a name="personalize-CreateSolution-request-performAutoTraining"></a>
解决方案是否使用自动训练来创建新的解决方案版本（经过训练的模型）。默认设置为 `True`，解决方案每 7 天自动创建新的解决方案版本。在解决方案配置过程中，您可以在 `AutoTrainingConfig` 中指定 `schedulingExpression` 来更改训练频率。有关自动训练的更多信息，请参阅[配置自动训练](https://docs.aws.amazon.com/personalize/latest/dg/solution-config-auto-training.html)。  
 解决方案处于活动状态后，自动解决方案版本创建会在一小时内开始。如果您在一小时内手动创建解决方案版本，则解决方案会跳过第一次自动训练。  
 训练开始后，您可以通过 [ListSolutionVersions](https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html)API 操作获取解决方案版本的 Amazon 资源名称 (ARN)。要获取其状态，请使用[DescribeSolutionVersion](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html)。  
类型：布尔值  
必需：否

 ** [performHPO](#API_CreateSolution_RequestSyntax) **   <a name="personalize-CreateSolution-request-performHPO"></a>
是否对指定或所选食谱执行超参数优化 (HPO)。默认值为 `false`。  
执行 AutoML 时，此参数始终为 `true`，您不应将其设置为 `false`。  
类型：布尔值  
必需：否

 ** [performIncrementalUpdate](#API_CreateSolution_RequestSyntax) **   <a name="personalize-CreateSolution-request-performIncrementalUpdate"></a>
是否对模型执行增量训练更新。启用后，它允许模型更频繁地从新数据中学习，而无需进行全面的再训练，从而实现近乎实时的个性化。只有使用语义相似度配方的解决方案才支持此参数。  
类型：布尔值  
必需：否

 ** [recipeArn](#API_CreateSolution_RequestSyntax) **   <a name="personalize-CreateSolution-request-recipeArn"></a>
用于模型训练的配方的 Amazon 资源名称 (ARN)。当 `performAutoML` 为 false 时，这是必需的。有关不同的 Amazon Personalize 食谱及其信息 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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateSolution) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateSolution) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateSolution) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateSolution) 
+  [AWS Python 软件开发工具包](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 PENDING
+ CREATE IN\$1PROGRESS
+ ACTIVE
+ CREATE FAILED
+ CREATE STOPPING
+ CREATE STOPPED

要获取版本的状态，请致电[DescribeSolutionVersion](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html)。等到状态显示为 ACTIVE 后，再调用 `CreateCampaign`。

如果状态显示为 CREATE FAILED，则响应中包含一个描述作业失败原因的 `failureReason` 键。

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

## 请求语法
<a name="API_CreateSolutionVersion_RequestSyntax"></a>

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

## 请求参数
<a name="API_CreateSolutionVersion_RequestParameters"></a>

请求接受采用 JSON 格式的以下数据。

 ** [name](#API_CreateSolutionVersion_RequestSyntax) **   <a name="personalize-CreateSolutionVersion-request-name"></a>
解决方案版本的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 63。  
模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*`  
必需：否

 ** [solutionArn](#API_CreateSolutionVersion_RequestSyntax) **   <a name="personalize-CreateSolutionVersion-request-solutionArn"></a>
包含训练配置信息的解决方案的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
是否必需：是

 ** [tags](#API_CreateSolutionVersion_RequestSyntax) **   <a name="personalize-CreateSolutionVersion-request-tags"></a>
要应用于解决方案版本的[标签](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)列表。  
类型：[Tag](API_Tag.md) 对象数组  
数组成员：最少 0 个物品。最多 200 项。  
必需：否

 ** [trainingMode](#API_CreateSolutionVersion_RequestSyntax) **   <a name="personalize-CreateSolutionVersion-request-trainingMode"></a>
创建解决方案版本时要执行的训练的范围。默认值为 `FULL`。这将基于数据集组中数据集的全部训练数据，创建一个全新的模型。  
如果您使用 [User-Personalization](https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html)，则可以将训练模式指定为 `UPDATE`。这会更新模型以考虑在建议中加入新物品。这并非全面的再训练。您仍然应该每周完成一次全面的再训练。如果您指定 `UPDATE`，则 Amazon Personalize 将停止解决方案版本的自动更新。要恢复更新，请创建一个将训练模式设置为 `FULL` 的新解决方案，然后将其部署到市场活动中。有关自动更新的更多信息，请参阅[自动更新](https://docs.aws.amazon.com/personalize/latest/dg/use-case-recipe-features.html#maintaining-with-automatic-updates)。  
只有当您已经使用 `FULL` 选项根据输入解决方案创建了有效的解决方案版本，并且输入解决方案已通过 [User-Personalization](https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html) 食谱或旧版 [HRNN-Coldstart](https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html) 食谱进行训练时，才能使用 `UPDATE` 选项。  
类型：字符串  
有效值：`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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateSolutionVersion) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateSolutionVersion) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateSolutionVersion) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateSolutionVersion) 
+  [AWS Python 软件开发工具包](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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DeleteCampaign) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DeleteCampaign) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DeleteCampaign) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteCampaign) 
+  [AWS Python 软件开发工具包](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 资源名称（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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DeleteDataset) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DeleteDataset) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteDataset) 
+  [AWS Python 软件开发工具包](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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DeleteDatasetGroup) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DeleteDatasetGroup) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteDatasetGroup) 
+  [AWS Python 软件开发工具包](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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DeleteEventTracker) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DeleteEventTracker) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteEventTracker) 
+  [AWS Python 软件开发工具包](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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DeleteFilter) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DeleteFilter) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteFilter) 
+  [AWS Python 软件开发工具包](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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DeleteMetricAttribution) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DeleteMetricAttribution) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteMetricAttribution) 
+  [AWS Python 软件开发工具包](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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DeleteRecommender) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DeleteRecommender) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DeleteRecommender) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteRecommender) 
+  [AWS Python 软件开发工具包](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>

删除 schema。在删除架构之前，必须删除引用该架构的所有数据集。有关架构的更多信息，请参阅 [CreateSchema](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html)。

## 请求语法
<a name="API_DeleteSchema_RequestSyntax"></a>

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

## 请求参数
<a name="API_DeleteSchema_RequestParameters"></a>

请求接受采用 JSON 格式的以下数据。

 ** [schemaArn](#API_DeleteSchema_RequestSyntax) **   <a name="personalize-DeleteSchema-request-schemaArn"></a>
要删除的架构的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
是否必需：是

## 响应元素
<a name="API_DeleteSchema_ResponseElements"></a>

如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。

## 错误
<a name="API_DeleteSchema_Errors"></a>

 ** InvalidInputException **   
为字段或参数提供有效值。  
HTTP 状态代码：400

 ** ResourceInUseException **   
指定的资源正在使用中。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
找不到指定的资源。  
HTTP 状态代码：400

## 另请参阅
<a name="API_DeleteSchema_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DeleteSchema) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DeleteSchema) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteSchema) 
+  [AWS Python 软件开发工具包](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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DeleteSolution) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DeleteSolution) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DeleteSolution) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteSolution) 
+  [AWS Python 软件开发工具包](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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeAlgorithm) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeAlgorithm) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeAlgorithm) 
+  [AWS Python 软件开发工具包](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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeBatchInferenceJob) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeBatchInferenceJob) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeBatchInferenceJob) 
+  [AWS Python 软件开发工具包](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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeBatchSegmentJob) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeBatchSegmentJob) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeBatchSegmentJob) 
+  [AWS Python 软件开发工具包](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 - 或 - CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS

当 `status` 为 `CREATE FAILED` 时，响应将包含 `failureReason` 键，该键描述了原因。

有关活动的更多信息，请参阅[CreateCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html)。

## 请求语法
<a name="API_DescribeCampaign_RequestSyntax"></a>

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

## 请求参数
<a name="API_DescribeCampaign_RequestParameters"></a>

请求接受采用 JSON 格式的以下数据。

 ** [campaignArn](#API_DescribeCampaign_RequestSyntax) **   <a name="personalize-DescribeCampaign-request-campaignArn"></a>
市场活动的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
必需：是

## 响应语法
<a name="API_DescribeCampaign_ResponseSyntax"></a>

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

## 响应元素
<a name="API_DescribeCampaign_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [campaign](#API_DescribeCampaign_ResponseSyntax) **   <a name="personalize-DescribeCampaign-response-campaign"></a>
仅当市场活动至少接到一个 `latestCampaignUpdate` 电话时，才会返回 `UpdateCampaign` 字段。
市场活动的属性。  
仅当市场活动至少接到一个 `latestCampaignUpdate` 电话时，才会返回 `UpdateCampaign` 字段。
类型：[Campaign](API_Campaign.md) 对象

## 错误
<a name="API_DescribeCampaign_Errors"></a>

 ** InvalidInputException **   
为字段或参数提供有效值。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
找不到指定的资源。  
HTTP 状态代码：400

## 另请参阅
<a name="API_DescribeCampaign_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeCampaign) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeCampaign) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeCampaign) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeCampaign) 
+  [AWS Python 软件开发工具包](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 资源名称（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>
有关数据删除作业的信息，包括状态。  
状态是以下值之一：  
+ PENDING
+ 进行中
+ COMPLETED
+ FAILED
类型：[DataDeletionJob](API_DataDeletionJob.md) 对象

## 错误
<a name="API_DescribeDataDeletionJob_Errors"></a>

 ** InvalidInputException **   
为字段或参数提供有效值。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
找不到指定的资源。  
HTTP 状态代码：400

## 另请参阅
<a name="API_DescribeDataDeletionJob_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeDataDeletionJob) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeDataDeletionJob) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeDataDeletionJob) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeDataDeletionJob) 
+  [AWS Python 软件开发工具包](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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeDataset) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeDataset) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeDataset) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeDataset) 
+  [AWS Python 软件开发工具包](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 资源名称 (ARN)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
必需：是

## 响应语法
<a name="API_DescribeDatasetExportJob_ResponseSyntax"></a>

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

## 响应元素
<a name="API_DescribeDatasetExportJob_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [datasetExportJob](#API_DescribeDatasetExportJob_ResponseSyntax) **   <a name="personalize-DescribeDatasetExportJob-response-datasetExportJob"></a>
有关数据集导出作业的信息，包括状态。  
状态是以下值之一：  
+ CREATE PENDING
+ CREATE IN\$1PROGRESS
+ ACTIVE
+ CREATE FAILED
类型：[DatasetExportJob](API_DatasetExportJob.md) 对象

## 错误
<a name="API_DescribeDatasetExportJob_Errors"></a>

 ** InvalidInputException **   
为字段或参数提供有效值。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
找不到指定的资源。  
HTTP 状态代码：400

## 另请参阅
<a name="API_DescribeDatasetExportJob_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeDatasetExportJob) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeDatasetExportJob) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeDatasetExportJob) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeDatasetExportJob) 
+  [AWS Python 软件开发工具包](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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeDatasetGroup) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeDatasetGroup) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeDatasetGroup) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeDatasetGroup) 
+  [AWS Python 软件开发工具包](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 资源名称 (ARN)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
必需：是

## 响应语法
<a name="API_DescribeDatasetImportJob_ResponseSyntax"></a>

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

## 响应元素
<a name="API_DescribeDatasetImportJob_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [datasetImportJob](#API_DescribeDatasetImportJob_ResponseSyntax) **   <a name="personalize-DescribeDatasetImportJob-response-datasetImportJob"></a>
有关数据集导入作业的信息，包括状态。  
状态是以下值之一：  
+ CREATE PENDING
+ CREATE IN\$1PROGRESS
+ ACTIVE
+ CREATE FAILED
类型：[DatasetImportJob](API_DatasetImportJob.md) 对象

## 错误
<a name="API_DescribeDatasetImportJob_Errors"></a>

 ** InvalidInputException **   
为字段或参数提供有效值。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
找不到指定的资源。  
HTTP 状态代码：400

## 另请参阅
<a name="API_DescribeDatasetImportJob_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeDatasetImportJob) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeDatasetImportJob) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeDatasetImportJob) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeDatasetImportJob) 
+  [AWS Python 软件开发工具包](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>

描述事件跟踪器。响应包括事件跟踪器的 `trackingId` 和 `status`。有关事件跟踪器的更多信息，请参阅[CreateEventTracker](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html)。

## 请求语法
<a name="API_DescribeEventTracker_RequestSyntax"></a>

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

## 请求参数
<a name="API_DescribeEventTracker_RequestParameters"></a>

请求接受采用 JSON 格式的以下数据。

 ** [eventTrackerArn](#API_DescribeEventTracker_RequestSyntax) **   <a name="personalize-DescribeEventTracker-request-eventTrackerArn"></a>
要描述的事件跟踪器的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
必需：是

## 响应语法
<a name="API_DescribeEventTracker_ResponseSyntax"></a>

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

## 响应元素
<a name="API_DescribeEventTracker_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [eventTracker](#API_DescribeEventTracker_ResponseSyntax) **   <a name="personalize-DescribeEventTracker-response-eventTracker"></a>
描述事件跟踪器的对象。  
类型：[EventTracker](API_EventTracker.md) 对象

## 错误
<a name="API_DescribeEventTracker_Errors"></a>

 ** InvalidInputException **   
为字段或参数提供有效值。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
找不到指定的资源。  
HTTP 状态代码：400

## 另请参阅
<a name="API_DescribeEventTracker_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeEventTracker) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeEventTracker) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeEventTracker) 
+  [AWS Python 软件开发工具包](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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeFeatureTransformation) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeFeatureTransformation) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeFeatureTransformation) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeFeatureTransformation) 
+  [AWS Python 软件开发工具包](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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeFilter) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeFilter) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeFilter) 
+  [AWS Python 软件开发工具包](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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeMetricAttribution) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeMetricAttribution) 
+  [AWS 适用于 Java 的 SDK 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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeMetricAttribution) 
+  [AWS Python 软件开发工具包](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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeRecipe) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeRecipe) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeRecipe) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeRecipe) 
+  [AWS Python 软件开发工具包](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 - 或 - CREATE FAILED
+ STOP PENDING > STOP IN\$1PROGRESS > INACTIVE > START PENDING > START IN\$1PROGRESS > ACTIVE
+ DELETE PENDING > DELETE IN\$1PROGRESS

当 `status` 为 `CREATE FAILED` 时，响应将包含 `failureReason` 键，该键描述了原因。

创建或删除推荐器时，`modelMetrics` 键为空。

有关推荐人的更多信息，请参阅[CreateRecommender](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateRecommender.html)。

## 请求语法
<a name="API_DescribeRecommender_RequestSyntax"></a>

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

## 请求参数
<a name="API_DescribeRecommender_RequestParameters"></a>

请求接受采用 JSON 格式的以下数据。

 ** [recommenderArn](#API_DescribeRecommender_RequestSyntax) **   <a name="personalize-DescribeRecommender-request-recommenderArn"></a>
要描述的推荐器的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
必需：是

## 响应语法
<a name="API_DescribeRecommender_ResponseSyntax"></a>

```
{
   "recommender": { 
      "creationDateTime": number,
      "datasetGroupArn": "string",
      "failureReason": "string",
      "lastUpdatedDateTime": number,
      "latestRecommenderUpdate": { 
         "creationDateTime": number,
         "failureReason": "string",
         "lastUpdatedDateTime": number,
         "recommenderConfig": { 
            "enableMetadataWithRecommendations": boolean,
            "itemExplorationConfig": { 
               "string" : "string" 
            },
            "minRecommendationRequestsPerSecond": number,
            "trainingDataConfig": { 
               "excludedDatasetColumns": { 
                  "string" : [ "string" ]
               },
               "includedDatasetColumns": { 
                  "string" : [ "string" ]
               }
            }
         },
         "status": "string"
      },
      "modelMetrics": { 
         "string" : number 
      },
      "name": "string",
      "recipeArn": "string",
      "recommenderArn": "string",
      "recommenderConfig": { 
         "enableMetadataWithRecommendations": boolean,
         "itemExplorationConfig": { 
            "string" : "string" 
         },
         "minRecommendationRequestsPerSecond": number,
         "trainingDataConfig": { 
            "excludedDatasetColumns": { 
               "string" : [ "string" ]
            },
            "includedDatasetColumns": { 
               "string" : [ "string" ]
            }
         }
      },
      "status": "string"
   }
}
```

## 响应元素
<a name="API_DescribeRecommender_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [recommender](#API_DescribeRecommender_ResponseSyntax) **   <a name="personalize-DescribeRecommender-response-recommender"></a>
推荐器的属性。  
类型：[Recommender](API_Recommender.md) 对象

## 错误
<a name="API_DescribeRecommender_Errors"></a>

 ** InvalidInputException **   
为字段或参数提供有效值。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
找不到指定的资源。  
HTTP 状态代码：400

## 另请参阅
<a name="API_DescribeRecommender_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeRecommender) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeRecommender) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeRecommender) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeRecommender) 
+  [AWS Python 软件开发工具包](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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeSchema) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeSchema) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeSchema) 
+  [AWS Python 软件开发工具包](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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeSolution) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeSolution) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeSolution) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeSolution) 
+  [AWS Python 软件开发工具包](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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeSolutionVersion) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeSolutionVersion) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeSolutionVersion) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeSolutionVersion) 
+  [AWS Python 软件开发工具包](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 资源名称 (ARN)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
必需：是

## 响应语法
<a name="API_GetSolutionMetrics_ResponseSyntax"></a>

```
{
   "metrics": { 
      "string" : number 
   },
   "solutionVersionArn": "string"
}
```

## 响应元素
<a name="API_GetSolutionMetrics_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [metrics](#API_GetSolutionMetrics_ResponseSyntax) **   <a name="personalize-GetSolutionMetrics-response-metrics"></a>
解决方案版本的指标。有关更多信息，请参阅[使用指标评估解决方案版本](https://docs.aws.amazon.com/personalize/latest/dg/working-with-training-metrics.html)。  
类型：字符串到双映射  
映射条目：最多 100 项。  
键长度限制：最大长度为 256。

 ** [solutionVersionArn](#API_GetSolutionMetrics_ResponseSyntax) **   <a name="personalize-GetSolutionMetrics-response-solutionVersionArn"></a>
与请求中指定的解决方案版本 ARN 相同。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`

## 错误
<a name="API_GetSolutionMetrics_Errors"></a>

 ** InvalidInputException **   
为字段或参数提供有效值。  
HTTP 状态代码：400

 ** ResourceInUseException **   
指定的资源正在使用中。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
找不到指定的资源。  
HTTP 状态代码：400

## 另请参阅
<a name="API_GetSolutionMetrics_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/GetSolutionMetrics) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/GetSolutionMetrics) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/GetSolutionMetrics) 
+  [AWS Python 软件开发工具包](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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListBatchInferenceJobs) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListBatchInferenceJobs) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListBatchInferenceJobs) 
+  [AWS Python 软件开发工具包](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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListBatchSegmentJobs) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListBatchSegmentJobs) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListBatchSegmentJobs) 
+  [AWS Python 软件开发工具包](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 资源名称 (ARN)。有关活动的更多信息，请参阅[CreateCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html)。

## 请求语法
<a name="API_ListCampaigns_RequestSyntax"></a>

```
{
   "maxResults": number,
   "nextToken": "string",
   "solutionArn": "string"
}
```

## 请求参数
<a name="API_ListCampaigns_RequestParameters"></a>

请求接受采用 JSON 格式的以下数据。

 ** [maxResults](#API_ListCampaigns_RequestSyntax) **   <a name="personalize-ListCampaigns-request-maxResults"></a>
要返回的市场活动的最大数量。  
类型：整数  
有效范围：最小值为 1。最大值为 100。  
必需：否

 ** [nextToken](#API_ListCampaigns_RequestSyntax) **   <a name="personalize-ListCampaigns-request-nextToken"></a>
从上一次调用返回[ListCampaigns](https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html)的代币，用于获取下一组活动（如果存在）。  
类型：字符串  
长度限制：最大长度为 1500。  
模式：`\p{ASCII}{0,1500}`  
必需：否

 ** [solutionArn](#API_ListCampaigns_RequestSyntax) **   <a name="personalize-ListCampaigns-request-solutionArn"></a>
要列出市场活动的解决方案的 Amazon 资源名称 (ARN)。如果未指定解决方案，则会列出与账户关联的所有市场活动。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
必需：否

## 响应语法
<a name="API_ListCampaigns_ResponseSyntax"></a>

```
{
   "campaigns": [ 
      { 
         "campaignArn": "string",
         "creationDateTime": number,
         "failureReason": "string",
         "lastUpdatedDateTime": number,
         "name": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## 响应元素
<a name="API_ListCampaigns_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [campaigns](#API_ListCampaigns_ResponseSyntax) **   <a name="personalize-ListCampaigns-response-campaigns"></a>
市场活动列表。  
类型：[CampaignSummary](API_CampaignSummary.md) 对象数组  
数组成员：最多 100 项。

 ** [nextToken](#API_ListCampaigns_ResponseSyntax) **   <a name="personalize-ListCampaigns-response-nextToken"></a>
用于获取下一组市场活动（如果存在）的令牌。  
类型：字符串  
长度限制：最大长度为 1500。  
模式：`\p{ASCII}{0,1500}`

## 错误
<a name="API_ListCampaigns_Errors"></a>

 ** InvalidInputException **   
为字段或参数提供有效值。  
HTTP 状态代码：400

 ** InvalidNextTokenException **   
令牌无效。  
HTTP 状态代码：400

## 另请参阅
<a name="API_ListCampaigns_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListCampaigns) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListCampaigns) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListCampaigns) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListCampaigns) 
+  [AWS Python 软件开发工具包](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 资源名称（ARN）。有关数据删除作业的更多信息，请参阅[删除用户](https://docs.aws.amazon.com/personalize/latest/dg/delete-records.html)。

## 请求语法
<a name="API_ListDataDeletionJobs_RequestSyntax"></a>

```
{
   "datasetGroupArn": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

## 请求参数
<a name="API_ListDataDeletionJobs_RequestParameters"></a>

请求接受采用 JSON 格式的以下数据。

 ** [datasetGroupArn](#API_ListDataDeletionJobs_RequestSyntax) **   <a name="personalize-ListDataDeletionJobs-request-datasetGroupArn"></a>
要列出数据删除作业的数据集组的 Amazon 资源名称（ARN）。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
必需：否

 ** [maxResults](#API_ListDataDeletionJobs_RequestSyntax) **   <a name="personalize-ListDataDeletionJobs-request-maxResults"></a>
要返回的数据删除作业的最大数量。  
类型：整数  
有效范围：最小值为 1。最大值为 100。  
必需：否

 ** [nextToken](#API_ListDataDeletionJobs_RequestSyntax) **   <a name="personalize-ListDataDeletionJobs-request-nextToken"></a>
上次调用 `ListDataDeletionJobs` 用于获取下一组作业（如果存在）时返回的令牌。  
类型：字符串  
长度限制：最大长度为 1500。  
模式：`\p{ASCII}{0,1500}`  
必需：否

## 响应语法
<a name="API_ListDataDeletionJobs_ResponseSyntax"></a>

```
{
   "dataDeletionJobs": [ 
      { 
         "creationDateTime": number,
         "dataDeletionJobArn": "string",
         "datasetGroupArn": "string",
         "failureReason": "string",
         "jobName": "string",
         "lastUpdatedDateTime": number,
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## 响应元素
<a name="API_ListDataDeletionJobs_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [dataDeletionJobs](#API_ListDataDeletionJobs_ResponseSyntax) **   <a name="personalize-ListDataDeletionJobs-response-dataDeletionJobs"></a>
数据删除作业列表。  
类型：[DataDeletionJobSummary](API_DataDeletionJobSummary.md) 对象数组  
数组成员：最多 100 项。

 ** [nextToken](#API_ListDataDeletionJobs_ResponseSyntax) **   <a name="personalize-ListDataDeletionJobs-response-nextToken"></a>
用于获取下一组数据删除作业（如果存在）的令牌。  
类型：字符串  
长度限制：最大长度为 1500。  
模式：`\p{ASCII}{0,1500}`

## 错误
<a name="API_ListDataDeletionJobs_Errors"></a>

 ** InvalidInputException **   
为字段或参数提供有效值。  
HTTP 状态代码：400

 ** InvalidNextTokenException **   
令牌无效。  
HTTP 状态代码：400

## 另请参阅
<a name="API_ListDataDeletionJobs_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListDataDeletionJobs) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListDataDeletionJobs) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListDataDeletionJobs) 
+  [AWS Python 软件开发工具包](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 资源名称 (ARN)。有关数据集导出任务的更多信息，请参阅[CreateDatasetExportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html)。有关数据集的更多信息，请参阅[CreateDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html)。

## 请求语法
<a name="API_ListDatasetExportJobs_RequestSyntax"></a>

```
{
   "datasetArn": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

## 请求参数
<a name="API_ListDatasetExportJobs_RequestParameters"></a>

请求接受采用 JSON 格式的以下数据。

 ** [datasetArn](#API_ListDatasetExportJobs_RequestSyntax) **   <a name="personalize-ListDatasetExportJobs-request-datasetArn"></a>
要列出数据集导出作业的数据集的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
必需：否

 ** [maxResults](#API_ListDatasetExportJobs_RequestSyntax) **   <a name="personalize-ListDatasetExportJobs-request-maxResults"></a>
要返回的数据集导出作业的最大数量。  
类型：整数  
有效范围：最小值为 1。最大值为 100。  
必需：否

 ** [nextToken](#API_ListDatasetExportJobs_RequestSyntax) **   <a name="personalize-ListDatasetExportJobs-request-nextToken"></a>
上次调用 `ListDatasetExportJobs` 用于获取下一组数据集导出作业（如果存在）时返回的令牌。  
类型：字符串  
长度限制：最大长度为 1500。  
模式：`\p{ASCII}{0,1500}`  
必需：否

## 响应语法
<a name="API_ListDatasetExportJobs_ResponseSyntax"></a>

```
{
   "datasetExportJobs": [ 
      { 
         "creationDateTime": number,
         "datasetExportJobArn": "string",
         "failureReason": "string",
         "jobName": "string",
         "lastUpdatedDateTime": number,
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## 响应元素
<a name="API_ListDatasetExportJobs_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [datasetExportJobs](#API_ListDatasetExportJobs_ResponseSyntax) **   <a name="personalize-ListDatasetExportJobs-response-datasetExportJobs"></a>
数据集导出作业列表。  
类型：[DatasetExportJobSummary](API_DatasetExportJobSummary.md) 对象数组  
数组成员：最多 100 项。

 ** [nextToken](#API_ListDatasetExportJobs_ResponseSyntax) **   <a name="personalize-ListDatasetExportJobs-response-nextToken"></a>
用于获取下一组数据集导出作业（如果存在）的令牌。  
类型：字符串  
长度限制：最大长度为 1500。  
模式：`\p{ASCII}{0,1500}`

## 错误
<a name="API_ListDatasetExportJobs_Errors"></a>

 ** InvalidInputException **   
为字段或参数提供有效值。  
HTTP 状态代码：400

 ** InvalidNextTokenException **   
令牌无效。  
HTTP 状态代码：400

## 另请参阅
<a name="API_ListDatasetExportJobs_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListDatasetExportJobs) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListDatasetExportJobs) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListDatasetExportJobs) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListDatasetExportJobs) 
+  [AWS Python 软件开发工具包](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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListDatasetGroups) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListDatasetGroups) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListDatasetGroups) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListDatasetGroups) 
+  [AWS Python 软件开发工具包](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 资源名称 (ARN)。有关数据集导入任务的更多信息，请参阅[CreateDatasetImportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html)。有关数据集的更多信息，请参阅[CreateDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html)。

## 请求语法
<a name="API_ListDatasetImportJobs_RequestSyntax"></a>

```
{
   "datasetArn": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

## 请求参数
<a name="API_ListDatasetImportJobs_RequestParameters"></a>

请求接受采用 JSON 格式的以下数据。

 ** [datasetArn](#API_ListDatasetImportJobs_RequestSyntax) **   <a name="personalize-ListDatasetImportJobs-request-datasetArn"></a>
要列出数据集导入作业的数据集的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
必需：否

 ** [maxResults](#API_ListDatasetImportJobs_RequestSyntax) **   <a name="personalize-ListDatasetImportJobs-request-maxResults"></a>
要返回的数据集导入作业的最大数量。  
类型：整数  
有效范围：最小值为 1。最大值为 100。  
必需：否

 ** [nextToken](#API_ListDatasetImportJobs_RequestSyntax) **   <a name="personalize-ListDatasetImportJobs-request-nextToken"></a>
上次调用 `ListDatasetImportJobs` 用于获取下一组数据集导入作业（如果存在）时返回的令牌。  
类型：字符串  
长度限制：最大长度为 1500。  
模式：`\p{ASCII}{0,1500}`  
必需：否

## 响应语法
<a name="API_ListDatasetImportJobs_ResponseSyntax"></a>

```
{
   "datasetImportJobs": [ 
      { 
         "creationDateTime": number,
         "datasetImportJobArn": "string",
         "failureReason": "string",
         "importMode": "string",
         "jobName": "string",
         "lastUpdatedDateTime": number,
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## 响应元素
<a name="API_ListDatasetImportJobs_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [datasetImportJobs](#API_ListDatasetImportJobs_ResponseSyntax) **   <a name="personalize-ListDatasetImportJobs-response-datasetImportJobs"></a>
数据集导入作业的列表。  
类型：[DatasetImportJobSummary](API_DatasetImportJobSummary.md) 对象数组  
数组成员：最多 100 项。

 ** [nextToken](#API_ListDatasetImportJobs_ResponseSyntax) **   <a name="personalize-ListDatasetImportJobs-response-nextToken"></a>
用于获取下一组数据集导入作业（如果存在）的令牌。  
类型：字符串  
长度限制：最大长度为 1500。  
模式：`\p{ASCII}{0,1500}`

## 错误
<a name="API_ListDatasetImportJobs_Errors"></a>

 ** InvalidInputException **   
为字段或参数提供有效值。  
HTTP 状态代码：400

 ** InvalidNextTokenException **   
令牌无效。  
HTTP 状态代码：400

## 另请参阅
<a name="API_ListDatasetImportJobs_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListDatasetImportJobs) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListDatasetImportJobs) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListDatasetImportJobs) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListDatasetImportJobs) 
+  [AWS Python 软件开发工具包](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 资源名称 (ARN)。有关数据集的更多信息，请参阅[CreateDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html)。

## 请求语法
<a name="API_ListDatasets_RequestSyntax"></a>

```
{
   "datasetGroupArn": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

## 请求参数
<a name="API_ListDatasets_RequestParameters"></a>

请求接受采用 JSON 格式的以下数据。

 ** [datasetGroupArn](#API_ListDatasets_RequestSyntax) **   <a name="personalize-ListDatasets-request-datasetGroupArn"></a>
包含要列出的数据集的数据集组的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
必需：否

 ** [maxResults](#API_ListDatasets_RequestSyntax) **   <a name="personalize-ListDatasets-request-maxResults"></a>
要返回的数据集的最大数量。  
类型：整数  
有效范围：最小值为 1。最大值为 100。  
必需：否

 ** [nextToken](#API_ListDatasets_RequestSyntax) **   <a name="personalize-ListDatasets-request-nextToken"></a>
上次调用 `ListDatasets` 用于获取下一组数据集导入作业（如果存在）时返回的令牌。  
类型：字符串  
长度限制：最大长度为 1500。  
模式：`\p{ASCII}{0,1500}`  
必需：否

## 响应语法
<a name="API_ListDatasets_ResponseSyntax"></a>

```
{
   "datasets": [ 
      { 
         "creationDateTime": number,
         "datasetArn": "string",
         "datasetType": "string",
         "lastUpdatedDateTime": number,
         "name": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## 响应元素
<a name="API_ListDatasets_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [datasets](#API_ListDatasets_ResponseSyntax) **   <a name="personalize-ListDatasets-response-datasets"></a>
`Dataset` 数据元数组。每个对象都提供元数据信息。  
类型：[DatasetSummary](API_DatasetSummary.md) 对象数组  
数组成员：最多 100 项。

 ** [nextToken](#API_ListDatasets_ResponseSyntax) **   <a name="personalize-ListDatasets-response-nextToken"></a>
用于获取下一组数据集（如果存在）的令牌。  
类型：字符串  
长度限制：最大长度为 1500。  
模式：`\p{ASCII}{0,1500}`

## 错误
<a name="API_ListDatasets_Errors"></a>

 ** InvalidInputException **   
为字段或参数提供有效值。  
HTTP 状态代码：400

 ** InvalidNextTokenException **   
令牌无效。  
HTTP 状态代码：400

## 另请参阅
<a name="API_ListDatasets_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListDatasets) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListDatasets) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListDatasets) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListDatasets) 
+  [AWS Python 软件开发工具包](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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListEventTrackers) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListEventTrackers) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListEventTrackers) 
+  [AWS Python 软件开发工具包](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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListFilters) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListFilters) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListFilters) 
+  [AWS Python 软件开发工具包](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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListMetricAttributionMetrics) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListMetricAttributionMetrics) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListMetricAttributionMetrics) 
+  [AWS Python 软件开发工具包](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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListMetricAttributions) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListMetricAttributions) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListMetricAttributions) 
+  [AWS Python 软件开发工具包](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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListRecipes) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListRecipes) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListRecipes) 
+  [AWS Python 软件开发工具包](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 资源名称 (ARN)。有关推荐人的更多信息，请参阅[CreateRecommender](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateRecommender.html)。

## 请求语法
<a name="API_ListRecommenders_RequestSyntax"></a>

```
{
   "datasetGroupArn": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

## 请求参数
<a name="API_ListRecommenders_RequestParameters"></a>

请求接受采用 JSON 格式的以下数据。

 ** [datasetGroupArn](#API_ListRecommenders_RequestSyntax) **   <a name="personalize-ListRecommenders-request-datasetGroupArn"></a>
要列出推荐器的域数据集组的 Amazon 资源名称 (ARN)。如果未指定域数据集组，则会列出与账户关联的所有推荐器。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
必需：否

 ** [maxResults](#API_ListRecommenders_RequestSyntax) **   <a name="personalize-ListRecommenders-request-maxResults"></a>
要返回的推荐器的最大数量。  
类型：整数  
有效范围：最小值为 1。最大值为 100。  
必需：否

 ** [nextToken](#API_ListRecommenders_RequestSyntax) **   <a name="personalize-ListRecommenders-request-nextToken"></a>
上次调用 `ListRecommenders` 用于获取下一组推荐器（如果存在）时返回的令牌。  
类型：字符串  
长度限制：最大长度为 1500。  
模式：`\p{ASCII}{0,1500}`  
必需：否

## 响应语法
<a name="API_ListRecommenders_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "recommenders": [ 
      { 
         "creationDateTime": number,
         "datasetGroupArn": "string",
         "lastUpdatedDateTime": number,
         "name": "string",
         "recipeArn": "string",
         "recommenderArn": "string",
         "recommenderConfig": { 
            "enableMetadataWithRecommendations": boolean,
            "itemExplorationConfig": { 
               "string" : "string" 
            },
            "minRecommendationRequestsPerSecond": number,
            "trainingDataConfig": { 
               "excludedDatasetColumns": { 
                  "string" : [ "string" ]
               },
               "includedDatasetColumns": { 
                  "string" : [ "string" ]
               }
            }
         },
         "status": "string"
      }
   ]
}
```

## 响应元素
<a name="API_ListRecommenders_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [nextToken](#API_ListRecommenders_ResponseSyntax) **   <a name="personalize-ListRecommenders-response-nextToken"></a>
用于获取下一组推荐器（如果存在）的令牌。  
类型：字符串  
长度限制：最大长度为 1500。  
模式：`\p{ASCII}{0,1500}`

 ** [recommenders](#API_ListRecommenders_ResponseSyntax) **   <a name="personalize-ListRecommenders-response-recommenders"></a>
推荐器的列表。  
类型：[RecommenderSummary](API_RecommenderSummary.md) 对象数组  
数组成员：最多 100 项。

## 错误
<a name="API_ListRecommenders_Errors"></a>

 ** InvalidInputException **   
为字段或参数提供有效值。  
HTTP 状态代码：400

 ** InvalidNextTokenException **   
令牌无效。  
HTTP 状态代码：400

## 另请参阅
<a name="API_ListRecommenders_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListRecommenders) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListRecommenders) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListRecommenders) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListRecommenders) 
+  [AWS Python 软件开发工具包](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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListSchemas) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListSchemas) 
+  [AWS 适用于 Java 的 SDK 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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListSchemas) 
+  [AWS Python 软件开发工具包](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 资源名称 (ARN)。有关解决方案的更多信息，请参阅[CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html)。

## 请求语法
<a name="API_ListSolutions_RequestSyntax"></a>

```
{
   "datasetGroupArn": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

## 请求参数
<a name="API_ListSolutions_RequestParameters"></a>

请求接受采用 JSON 格式的以下数据。

 ** [datasetGroupArn](#API_ListSolutions_RequestSyntax) **   <a name="personalize-ListSolutions-request-datasetGroupArn"></a>
数据集组的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
必需：否

 ** [maxResults](#API_ListSolutions_RequestSyntax) **   <a name="personalize-ListSolutions-request-maxResults"></a>
要返回的解决方案的最大数量。  
类型：整数  
有效范围：最小值为 1。最大值为 100。  
必需：否

 ** [nextToken](#API_ListSolutions_RequestSyntax) **   <a name="personalize-ListSolutions-request-nextToken"></a>
上次调用 `ListSolutions` 用于获取下一组解决方案（如果存在）时返回的令牌。  
类型：字符串  
长度限制：最大长度为 1500。  
模式：`\p{ASCII}{0,1500}`  
必需：否

## 响应语法
<a name="API_ListSolutions_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "solutions": [ 
      { 
         "creationDateTime": number,
         "lastUpdatedDateTime": number,
         "name": "string",
         "recipeArn": "string",
         "solutionArn": "string",
         "status": "string"
      }
   ]
}
```

## 响应元素
<a name="API_ListSolutions_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [nextToken](#API_ListSolutions_ResponseSyntax) **   <a name="personalize-ListSolutions-response-nextToken"></a>
用于获取下一组解决方案（如果存在）的令牌。  
类型：字符串  
长度限制：最大长度为 1500。  
模式：`\p{ASCII}{0,1500}`

 ** [solutions](#API_ListSolutions_ResponseSyntax) **   <a name="personalize-ListSolutions-response-solutions"></a>
当前解决方案的列表。  
类型：[SolutionSummary](API_SolutionSummary.md) 对象数组  
数组成员：最多 100 项。

## 错误
<a name="API_ListSolutions_Errors"></a>

 ** InvalidInputException **   
为字段或参数提供有效值。  
HTTP 状态代码：400

 ** InvalidNextTokenException **   
令牌无效。  
HTTP 状态代码：400

## 另请参阅
<a name="API_ListSolutions_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListSolutions) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListSolutions) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListSolutions) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListSolutions) 
+  [AWS Python 软件开发工具包](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 资源名称 (ARN)。

## 请求语法
<a name="API_ListSolutionVersions_RequestSyntax"></a>

```
{
   "maxResults": number,
   "nextToken": "string",
   "solutionArn": "string"
}
```

## 请求参数
<a name="API_ListSolutionVersions_RequestParameters"></a>

请求接受采用 JSON 格式的以下数据。

 ** [maxResults](#API_ListSolutionVersions_RequestSyntax) **   <a name="personalize-ListSolutionVersions-request-maxResults"></a>
要返回的解决方案版本的最大数量。  
类型：整数  
有效范围：最小值为 1。最大值为 100。  
必需：否

 ** [nextToken](#API_ListSolutionVersions_RequestSyntax) **   <a name="personalize-ListSolutionVersions-request-nextToken"></a>
上次调用 `ListSolutionVersions` 用于获取下一组解决方案版本（如果存在）时返回的令牌。  
类型：字符串  
长度限制：最大长度为 1500。  
模式：`\p{ASCII}{0,1500}`  
必需：否

 ** [solutionArn](#API_ListSolutionVersions_RequestSyntax) **   <a name="personalize-ListSolutionVersions-request-solutionArn"></a>
解决方案的 Amazon 资源名称（ARN）。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
必需：否

## 响应语法
<a name="API_ListSolutionVersions_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "solutionVersions": [ 
      { 
         "creationDateTime": number,
         "failureReason": "string",
         "lastUpdatedDateTime": number,
         "solutionVersionArn": "string",
         "status": "string",
         "trainingMode": "string",
         "trainingType": "string"
      }
   ]
}
```

## 响应元素
<a name="API_ListSolutionVersions_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [nextToken](#API_ListSolutionVersions_ResponseSyntax) **   <a name="personalize-ListSolutionVersions-response-nextToken"></a>
用于获取下一组解决方案版本（如果存在）的令牌。  
类型：字符串  
长度限制：最大长度为 1500。  
模式：`\p{ASCII}{0,1500}`

 ** [solutionVersions](#API_ListSolutionVersions_ResponseSyntax) **   <a name="personalize-ListSolutionVersions-response-solutionVersions"></a>
描述版本属性的解决方案版本列表。  
类型：[SolutionVersionSummary](API_SolutionVersionSummary.md) 对象数组  
数组成员：最多 100 项。

## 错误
<a name="API_ListSolutionVersions_Errors"></a>

 ** InvalidInputException **   
为字段或参数提供有效值。  
HTTP 状态代码：400

 ** InvalidNextTokenException **   
令牌无效。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
找不到指定的资源。  
HTTP 状态代码：400

## 另请参阅
<a name="API_ListSolutionVersions_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListSolutionVersions) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListSolutionVersions) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListSolutionVersions) 
+  [AWS Python 软件开发工具包](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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListTagsForResource) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListTagsForResource) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListTagsForResource) 
+  [AWS Python 软件开发工具包](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>

启动处于 INACTIVE 状态的推荐器。启动推荐器不会创建任何新模型，但会恢复对推荐器的计费和自动再训练。

## 请求语法
<a name="API_StartRecommender_RequestSyntax"></a>

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

## 请求参数
<a name="API_StartRecommender_RequestParameters"></a>

请求接受采用 JSON 格式的以下数据。

 ** [recommenderArn](#API_StartRecommender_RequestSyntax) **   <a name="personalize-StartRecommender-request-recommenderArn"></a>
要启动的推荐器的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
必需：是

## 响应语法
<a name="API_StartRecommender_ResponseSyntax"></a>

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

## 响应元素
<a name="API_StartRecommender_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [recommenderArn](#API_StartRecommender_ResponseSyntax) **   <a name="personalize-StartRecommender-response-recommenderArn"></a>
您启动的推荐器的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`

## 错误
<a name="API_StartRecommender_Errors"></a>

 ** InvalidInputException **   
为字段或参数提供有效值。  
HTTP 状态代码：400

 ** ResourceInUseException **   
指定的资源正在使用中。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
找不到指定的资源。  
HTTP 状态代码：400

## 另请参阅
<a name="API_StartRecommender_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/StartRecommender) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/StartRecommender) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/StartRecommender) 
+  [AWS Python 软件开发工具包](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 资源名称 (ARN)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
必需：是

## 响应语法
<a name="API_StopRecommender_ResponseSyntax"></a>

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

## 响应元素
<a name="API_StopRecommender_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [recommenderArn](#API_StopRecommender_ResponseSyntax) **   <a name="personalize-StopRecommender-response-recommenderArn"></a>
您停止的推荐器的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`

## 错误
<a name="API_StopRecommender_Errors"></a>

 ** InvalidInputException **   
为字段或参数提供有效值。  
HTTP 状态代码：400

 ** ResourceInUseException **   
指定的资源正在使用中。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
找不到指定的资源。  
HTTP 状态代码：400

## 另请参阅
<a name="API_StopRecommender_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/StopRecommender) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/StopRecommender) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/StopRecommender) 
+  [AWS Python 软件开发工具包](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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/StopSolutionVersionCreation) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/StopSolutionVersionCreation) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/StopSolutionVersionCreation) 
+  [AWS Python 软件开发工具包](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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/TagResource) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/TagResource) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/TagResource) 
+  [AWS Python 软件开发工具包](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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/UntagResource) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/UntagResource) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/UntagResource) 
+  [AWS Python 软件开发工具包](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 资源名称（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 资源名称 (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 资源名称（ARN）。要指定解决方案的最新解决方案版本，请以 `SolutionArn/$LATEST` 格式指定*解决方案*的 ARN。如果`True`在中设置为`syncWithLatestSolutionVersion`，则必须使用此格式[CampaignConfig](https://docs.aws.amazon.com/personalize/latest/dg/API_CampaignConfig.html)。  
 如果要部署的模型不是解决方案的最新解决方案版本，请指定解决方案版本的 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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/UpdateCampaign) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/UpdateCampaign) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/UpdateCampaign) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/UpdateCampaign) 
+  [AWS Python 软件开发工具包](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 资源名称 (ARN)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
是否必需：是

 ** [schemaArn](#API_UpdateDataset_RequestSyntax) **   <a name="personalize-UpdateDataset-request-schemaArn"></a>
您要使用的新架构的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
必需：是

## 响应语法
<a name="API_UpdateDataset_ResponseSyntax"></a>

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

## 响应元素
<a name="API_UpdateDataset_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [datasetArn](#API_UpdateDataset_ResponseSyntax) **   <a name="personalize-UpdateDataset-response-datasetArn"></a>
您更新的数据集的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`

## 错误
<a name="API_UpdateDataset_Errors"></a>

 ** InvalidInputException **   
为字段或参数提供有效值。  
HTTP 状态代码：400

 ** ResourceInUseException **   
指定的资源正在使用中。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
找不到指定的资源。  
HTTP 状态代码：400

## 另请参阅
<a name="API_UpdateDataset_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/UpdateDataset) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/UpdateDataset) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/UpdateDataset) 
+  [AWS Python 软件开发工具包](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 资源名称 (ARN)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
必需：否

 ** [metricsOutputConfig](#API_UpdateMetricAttribution_RequestSyntax) **   <a name="personalize-UpdateMetricAttribution-request-metricsOutputConfig"></a>
指标归因的输出配置。  
类型：[MetricAttributionOutput](API_MetricAttributionOutput.md) 对象  
必需：否

 ** [removeMetrics](#API_UpdateMetricAttribution_RequestSyntax) **   <a name="personalize-UpdateMetricAttribution-request-removeMetrics"></a>
从指标归因中移除指标属性。  
类型：字符串数组  
数组成员：最多 10 项。  
长度约束：最大长度为 256。  
必需：否

## 响应语法
<a name="API_UpdateMetricAttribution_ResponseSyntax"></a>

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

## 响应元素
<a name="API_UpdateMetricAttribution_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [metricAttributionArn](#API_UpdateMetricAttribution_ResponseSyntax) **   <a name="personalize-UpdateMetricAttribution-response-metricAttributionArn"></a>
已更新的指标归因的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`

## 错误
<a name="API_UpdateMetricAttribution_Errors"></a>

 ** InvalidInputException **   
为字段或参数提供有效值。  
HTTP 状态代码：400

 ** ResourceAlreadyExistsException **   
指定资源已经存在。  
HTTP 状态代码：400

 ** ResourceInUseException **   
指定的资源正在使用中。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
找不到指定的资源。  
HTTP 状态代码：400

## 另请参阅
<a name="API_UpdateMetricAttribution_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/UpdateMetricAttribution) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/UpdateMetricAttribution) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/UpdateMetricAttribution) 
+  [AWS Python 软件开发工具包](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 资源名称 (ARN)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
是否必需：是

 ** [recommenderConfig](#API_UpdateRecommender_RequestSyntax) **   <a name="personalize-UpdateRecommender-request-recommenderConfig"></a>
推荐器的配置详细信息。  
类型：[RecommenderConfig](API_RecommenderConfig.md) 对象  
是否必需：是

## 响应语法
<a name="API_UpdateRecommender_ResponseSyntax"></a>

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

## 响应元素
<a name="API_UpdateRecommender_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [recommenderArn](#API_UpdateRecommender_ResponseSyntax) **   <a name="personalize-UpdateRecommender-response-recommenderArn"></a>
与请求中提供的推荐器 Amazon 资源名称 (ARN) 相同。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`

## 错误
<a name="API_UpdateRecommender_Errors"></a>

 ** InvalidInputException **   
为字段或参数提供有效值。  
HTTP 状态代码：400

 ** ResourceInUseException **   
指定的资源正在使用中。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
找不到指定的资源。  
HTTP 状态代码：400

## 另请参阅
<a name="API_UpdateRecommender_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/UpdateRecommender) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/UpdateRecommender) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/UpdateRecommender) 
+  [AWS Python 软件开发工具包](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 - 或 - CREATE FAILED

要获取解决方案更新的状态，请调用 [DescribeSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html)API 操作并在中查找状态`latestSolutionUpdate`。

## 请求语法
<a name="API_UpdateSolution_RequestSyntax"></a>

```
{
   "performAutoTraining": boolean,
   "performIncrementalUpdate": boolean,
   "solutionArn": "string",
   "solutionUpdateConfig": { 
      "autoTrainingConfig": { 
         "schedulingExpression": "string"
      },
      "eventsConfig": { 
         "eventParametersList": [ 
            { 
               "eventType": "string",
               "eventValueThreshold": number,
               "weight": number
            }
         ]
      }
   }
}
```

## 请求参数
<a name="API_UpdateSolution_RequestParameters"></a>

请求接受采用 JSON 格式的以下数据。

 ** [performAutoTraining](#API_UpdateSolution_RequestSyntax) **   <a name="personalize-UpdateSolution-request-performAutoTraining"></a>
解决方案是否使用自动训练来创建新的解决方案版本（经过训练的模型）。在解决方案配置过程中，您可以在 `AutoTrainingConfig` 中指定 `schedulingExpression` 来更改训练频率。  
 如果开启自动训练，则第一次自动训练将在解决方案更新完成后的一小时内开始。如果您在一小时内手动创建解决方案版本，则解决方案会跳过第一次自动训练。有关自动训练的更多信息，请参阅[配置自动训练](https://docs.aws.amazon.com/personalize/latest/dg/solution-config-auto-training.html)。  
 训练开始后，您可以通过 [ListSolutionVersions](https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html)API 操作获取解决方案版本的 Amazon 资源名称 (ARN)。要获取其状态，请使用[DescribeSolutionVersion](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html)。  
类型：布尔值  
必需：否

 ** [performIncrementalUpdate](#API_UpdateSolution_RequestSyntax) **   <a name="personalize-UpdateSolution-request-performIncrementalUpdate"></a>
是否对模型执行增量训练更新。启用后，它允许模型更频繁地从新数据中学习，而无需进行全面的再训练，从而实现近乎实时的个性化。只有使用语义相似度配方的解决方案才支持此参数。  
类型：布尔值  
必需：否

 ** [solutionArn](#API_UpdateSolution_RequestSyntax) **   <a name="personalize-UpdateSolution-request-solutionArn"></a>
要更新的解决方案的 Amazon 资源名称（ARN）。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
是否必需：是

 ** [solutionUpdateConfig](#API_UpdateSolution_RequestSyntax) **   <a name="personalize-UpdateSolution-request-solutionUpdateConfig"></a>
解决方案的新配置详细信息。  
类型：[SolutionUpdateConfig](API_SolutionUpdateConfig.md) 对象  
必需：否

## 响应语法
<a name="API_UpdateSolution_ResponseSyntax"></a>

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

## 响应元素
<a name="API_UpdateSolution_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [solutionArn](#API_UpdateSolution_ResponseSyntax) **   <a name="personalize-UpdateSolution-response-solutionArn"></a>
与请求中提供的解决方案 Amazon 资源名称（ARN）相同。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`

## 错误
<a name="API_UpdateSolution_Errors"></a>

 ** InvalidInputException **   
为字段或参数提供有效值。  
HTTP 状态代码：400

 ** LimitExceededException **   
超出每秒请求次数的限制。  
HTTP 状态代码：400

 ** ResourceInUseException **   
指定的资源正在使用中。  
HTTP 状态代码：400

 ** ResourceInUseException **   
指定的资源正在使用中。  
HTTP 状态代码：400

 ** ResourceNotFoundException **   
找不到指定的资源。  
HTTP 状态代码：400

## 另请参阅
<a name="API_UpdateSolution_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/UpdateSolution) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/UpdateSolution) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/UpdateSolution) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/UpdateSolution) 
+  [AWS Python 软件开发工具包](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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-events-2018-03-22/PutActionInteractions) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-events-2018-03-22/PutActionInteractions) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-events-2018-03-22/PutActionInteractions) 
+  [AWS Python 软件开发工具包](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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-events-2018-03-22/PutActions) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-events-2018-03-22/PutActions) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-events-2018-03-22/PutActions) 
+  [AWS Python 软件开发工具包](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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-events-2018-03-22/PutEvents) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-events-2018-03-22/PutEvents) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/PutEvents) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-events-2018-03-22/PutEvents) 
+  [AWS Python 软件开发工具包](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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-events-2018-03-22/PutItems) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-events-2018-03-22/PutItems) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-events-2018-03-22/PutItems) 
+  [AWS Python 软件开发工具包](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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-events-2018-03-22/PutUsers) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-events-2018-03-22/PutUsers) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-events-2018-03-22/PutUsers) 
+  [AWS Python 软件开发工具包](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 Runtime 支持以下操作：
+  [GetActionRecommendations](API_RS_GetActionRecommendations.md) 
+  [GetPersonalizedRanking](API_RS_GetPersonalizedRanking.md) 
+  [GetRecommendations](API_RS_GetRecommendations.md) 

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

返回按预测分数以降序排列的建议操作列表。如果您的自定义市场活动部署了使用 PERSONALIZED\$1ACTIONS 配方训练的解决方案版本，请使用 `GetActionRecommendations` API。

有关 PERSONALIZED\$1ACTIONS 配方的更多信息，请参阅 [PERSONALIZED\$1ACTIONS 配方](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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS Python 软件开发工具包](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 资源名称 (ARN)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
是否必需：是

 ** [context](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-context"></a>
获取建议时要使用的上下文元数据。上下文元数据包括在获取用户建议时可能相关的任何交互信息，例如用户的当前位置或设备类型。  
类型：字符串到字符串映射  
映射条目：最多 150 项。  
键长度限制：最大长度为 150。  
键模式：`[A-Za-z\d_]+`  
值长度限制：最大长度为 1000。  
必需：否

 ** [filterArn](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-filterArn"></a>
您创建的用于在给定用户建议中包含物品或将物品排除在此类建议之外的筛选器的 Amazon 资源名称 (ARN)。有关更多信息，请参阅[筛选建议](https://docs.aws.amazon.com/personalize/latest/dg/filter.html)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
必需：否

 ** [filterValues](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-filterValues"></a>
筛选建议时要使用的值。对于筛选器表达式中的每个占位符参数，提供参数名称（大小写相符）作为键，提供筛选器值作为对应的值。用英文逗号分隔一个参数的多个值。  
对于使用 `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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS 适用于 Java 的 SDK 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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS Python 软件开发工具包](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 资源名称 (ARN)，所需的用户和物品输入取决于用于创建支持市场活动的解决方案的食谱类型，如下所示：
+ USER\$1PERSONALIZATION - `userId` 必填项，未使用 `itemId`
+ RELATED\$1ITEMS - `itemId` 必填项，未使用 `userId`

**注意**  
由利用 PERSONALIZED\$1RANKING 类型的食谱创建的解决方案支持的市场活动使用 [GetPersonalizedRanking](API_RS_GetPersonalizedRanking.md) API。

 对于推荐器，推荐器的 ARN 是必填项，所需的物品和用户输入取决于支持推荐器的使用案例（基于域的食谱）。有关使用案例要求的信息，请参阅[选择推荐器使用案例](https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html)。

## 请求语法
<a name="API_RS_GetRecommendations_RequestSyntax"></a>

```
POST /recommendations HTTP/1.1
Content-type: application/json

{
   "campaignArn": "string",
   "context": { 
      "string" : "string" 
   },
   "filterArn": "string",
   "filterValues": { 
      "string" : "string" 
   },
   "itemId": "string",
   "metadataColumns": { 
      "string" : [ "string" ]
   },
   "numResults": number,
   "promotions": [ 
      { 
         "filterArn": "string",
         "filterValues": { 
            "string" : "string" 
         },
         "name": "string",
         "percentPromotedItems": number
      }
   ],
   "recommenderArn": "string",
   "userId": "string"
}
```

## URI 请求参数
<a name="API_RS_GetRecommendations_RequestParameters"></a>

该请求不使用任何 URI 参数。

## 请求正文
<a name="API_RS_GetRecommendations_RequestBody"></a>

请求接受采用 JSON 格式的以下数据。

 ** [campaignArn](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-campaignArn"></a>
用于获取建议的市场活动的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
必需：否

 ** [context](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-context"></a>
获取建议时要使用的上下文元数据。上下文元数据包括在获取用户建议时可能相关的任何交互信息，例如用户的当前位置或设备类型。  
类型：字符串到字符串映射  
映射条目：最多 150 项。  
键长度限制：最大长度为 150。  
键模式：`[A-Za-z\d_]+`  
值长度限制：最大长度为 1000。  
必需：否

 ** [filterArn](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-filterArn"></a>
要应用于返回建议的筛选器的 ARN。有关更多信息，请参阅[筛选建议](https://docs.aws.amazon.com/personalize/latest/dg/filter.html)。  
使用此参数时，确保筛选器资源为 `ACTIVE`。  
类型：字符串  
长度约束：最大长度为 256。  
模式：`arn:([a-z\d-]+):personalize:.*:.*:.+`  
必需：否

 ** [filterValues](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-filterValues"></a>
筛选建议时要使用的值。对于筛选器表达式中的每个占位符参数，提供参数名称（大小写相符）作为键，提供筛选器值作为对应的值。用英文逗号分隔一个参数的多个值。  
对于使用 `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 资源名称 (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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS Python 软件开发工具包](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) 