本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。 # API 参考本节提供 Amazon Personalize API 操作的文档。有关按区域划分的 Amazon Personalize 端点的列表，请参阅《AWS 一般参考》**中的 [AWS 区域和端点](https://docs.aws.amazon.com/general/latest/gr/personalize.html)。 **Topics** + [操作](API_Operations.md) + [数据类型](API_Types.md) + [常见错误](CommonErrors.md) + [常见参数](CommonParameters.md) # 操作 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 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 根据存储在 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 ## 请求语法 ``` { "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" } } } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [batchInferenceJobConfig](#API_CreateBatchInferenceJob_RequestSyntax) ** 批量推理作业的配置详情。类型：[BatchInferenceJobConfig](API_BatchInferenceJobConfig.md) 对象必需：否 ** [batchInferenceJobMode](#API_CreateBatchInferenceJob_RequestSyntax) ** 批量推理作业的模式。要为一组相似的物品生成描述性主题，请将作业模式设置为 `THEME_GENERATION`。如果您不想生成主题，请使用默认 `BATCH_INFERENCE`。当您获得带有主题的批量建议时，将产生额外的成本。有关更多信息，请参阅 [Amazon Personalize 定价](https://aws.amazon.com/personalize/pricing/)。类型：字符串有效值：`BATCH_INFERENCE | THEME_GENERATION` 必需：否 ** [filterArn](#API_CreateBatchInferenceJob_RequestSyntax) ** 要应用于批量推理作业的筛选器的 ARN。有关使用筛选器的更多信息，请参阅[筛选批量建议](https://docs.aws.amazon.com/personalize/latest/dg/filter-batch.html)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** [jobInput](#API_CreateBatchInferenceJob_RequestSyntax) ** 指向输入文件以作为建议的基础的 Amazon S3 路径。输入材料必须采用 JSON 格式。类型：[BatchInferenceJobInput](API_BatchInferenceJobInput.md) 对象是否必需：是 ** [jobName](#API_CreateBatchInferenceJob_RequestSyntax) ** 要创建的批量推理作业的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 是否必需：是 ** [jobOutput](#API_CreateBatchInferenceJob_RequestSyntax) ** 指向存储作业输出的 Amazon S3 存储桶的路径。类型：[BatchInferenceJobOutput](API_BatchInferenceJobOutput.md) 对象是否必需：是 ** [numResults](#API_CreateBatchInferenceJob_RequestSyntax) ** 要检索的建议的数量。类型：整数必需：否 ** [roleArn](#API_CreateBatchInferenceJob_RequestSyntax) ** 分别有权读取和写入您的输入和输出 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) ** 将用于生成批量推理建议的解决方案版本的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 是否必需：是 ** [tags](#API_CreateBatchInferenceJob_RequestSyntax) ** 要应用于批量推理作业的[标签](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)列表。类型：[Tag](API_Tag.md) 对象数组数组成员：最少 0 个物品。最多 200 项。必需：否 ** [themeGenerationConfig](#API_CreateBatchInferenceJob_RequestSyntax) ** 对于主题生成作业，请指定物品数据集中包含每个物品名称的列的名称。类型：[ThemeGenerationConfig](API_ThemeGenerationConfig.md) 对象必需：否 ## 响应语法 ``` { "batchInferenceJobArn": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [batchInferenceJobArn](#API_CreateBatchInferenceJob_ResponseSyntax) ** 批量推理作业的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** LimitExceededException ** 超出每秒请求次数的限制。 HTTP 状态代码：400 ** ResourceAlreadyExistsException ** 指定资源已经存在。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ** TooManyTagsException ** 您已超出您可以应用到此资源的最大标签数量。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 创建批量细分作业。该操作最多可以处理 5000 万条记录，并且输入文件必须为 JSON 格式。有关更多信息，请参阅[获取批量建议和用户细分](https://docs.aws.amazon.com/personalize/latest/dg/recommendations-batch.html)。 ## 请求语法 ``` { "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" } ] } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [filterArn](#API_CreateBatchSegmentJob_RequestSyntax) ** 要应用于批量细分作业的筛选器的 ARN。有关使用筛选器的更多信息，请参阅[筛选批量建议](https://docs.aws.amazon.com/personalize/latest/dg/filter-batch.html)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** [jobInput](#API_CreateBatchSegmentJob_RequestSyntax) ** 用于生成批量细分作业的输入数据的 Amazon S3 路径。类型：[BatchSegmentJobInput](API_BatchSegmentJobInput.md) 对象是否必需：是 ** [jobName](#API_CreateBatchSegmentJob_RequestSyntax) ** 要创建的批量细分作业的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 是否必需：是 ** [jobOutput](#API_CreateBatchSegmentJob_RequestSyntax) ** 存储作业输出的存储桶的 Amazon S3 路径。类型：[BatchSegmentJobOutput](API_BatchSegmentJobOutput.md) 对象是否必需：是 ** [numResults](#API_CreateBatchSegmentJob_RequestSyntax) ** 批量细分作业为每行输入数据生成的预测用户数。每个细分的最大用户数为 500 万。类型：整数必需：否 ** [roleArn](#API_CreateBatchSegmentJob_RequestSyntax) ** 分别有权读取和写入您的输入和输出 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) ** 您希望批量细分作业用于生成批量细分的解决方案版本的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 是否必需：是 ** [tags](#API_CreateBatchSegmentJob_RequestSyntax) ** 要应用于批量细分作业的[标签](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)列表。类型：[Tag](API_Tag.md) 对象数组数组成员：最少 0 个物品。最多 200 项。必需：否 ## 响应语法 ``` { "batchSegmentJobArn": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [batchSegmentJobArn](#API_CreateBatchSegmentJob_ResponseSyntax) ** 批量细分作业的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** LimitExceededException ** 超出每秒请求次数的限制。 HTTP 状态代码：400 ** ResourceAlreadyExistsException ** 指定资源已经存在。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ** TooManyTagsException ** 您已超出您可以应用到此资源的最大标签数量。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 **重要** 当市场活动处于活动状态时，会产生市场活动费用。为避免产生不必要的费用，请务必在市场活动结束后删除它。有关市场活动成本的信息，请参阅 [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) ## 请求语法 ``` { "campaignConfig": { "enableMetadataWithRecommendations": boolean, "itemExplorationConfig": { "string" : "string" }, "rankingInfluence": { "string" : number }, "syncWithLatestSolutionVersion": boolean }, "minProvisionedTPS": number, "name": "string", "solutionVersionArn": "string", "tags": [ { "tagKey": "string", "tagValue": "string" } ] } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [campaignConfig](#API_CreateCampaign_RequestSyntax) ** 市场活动的配置详情。类型：[CampaignConfig](API_CampaignConfig.md) 对象必需：否 ** [minProvisionedTPS](#API_CreateCampaign_RequestSyntax) ** 指定 Amazon Personalize 将支持的请求的最低预调配每秒事务数（建议）。高 `minProvisionedTPS` 会增加您的账单费用。我们建议从 1 开始设置 `minProvisionedTPS`（默认值）。使用 Amazon CloudWatch 指标跟踪您的使用情况，并在必要`minProvisionedTPS`时增加使用量。类型：整数有效范围：最小值为 1。必需：否 ** [name](#API_CreateCampaign_RequestSyntax) ** 新市场活动的名称。市场活动名称在您的账户内必须是唯一的。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 是否必需：是 ** [solutionVersionArn](#API_CreateCampaign_RequestSyntax) ** 用于与市场活动一起部署的已训练模型的 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) ** 要应用于市场活动的[标签](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)列表。类型：[Tag](API_Tag.md) 对象数组数组成员：最少 0 个物品。最多 200 项。必需：否 ## 响应语法 ``` { "campaignArn": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [campaignArn](#API_CreateCampaign_ResponseSyntax) ** 市场活动的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** LimitExceededException ** 超出每秒请求次数的限制。 HTTP 状态代码：400 ** ResourceAlreadyExistsException ** 指定资源已经存在。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ** TooManyTagsException ** 您已超出您可以应用到此资源的最大标签数量。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 创建一个批量作业，该作业批量删除对 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) ## 请求语法 ``` { "datasetGroupArn": "string", "dataSource": { "dataLocation": "string" }, "jobName": "string", "roleArn": "string", "tags": [ { "tagKey": "string", "tagValue": "string" } ] } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [datasetGroupArn](#API_CreateDataDeletionJob_RequestSyntax) ** 数据集组（包含您希望从中删除记录的数据集）的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 是否必需：是 ** [dataSource](#API_CreateDataDeletionJob_RequestSyntax) ** 包含待删除用户的用户 ID 列表的 Amazon S3 存储桶。类型：[DataSource](API_DataSource.md) 对象是否必需：是 ** [jobName](#API_CreateDataDeletionJob_RequestSyntax) ** 数据删除作业的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 是否必需：是 ** [roleArn](#API_CreateDataDeletionJob_RequestSyntax) ** 有权从 Amazon S3 数据来源读取的 IAM 角色的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` 是否必需：是 ** [tags](#API_CreateDataDeletionJob_RequestSyntax) ** 要应用于数据删除作业的[标签](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)列表。类型：[Tag](API_Tag.md) 对象数组数组成员：最少 0 个物品。最多 200 项。必需：否 ## 响应语法 ``` { "dataDeletionJobArn": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [dataDeletionJobArn](#API_CreateDataDeletionJob_ResponseSyntax) ** 数据删除作业的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** LimitExceededException ** 超出每秒请求次数的限制。 HTTP 状态代码：400 ** ResourceAlreadyExistsException ** 指定资源已经存在。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ** TooManyTagsException ** 您已超出您可以应用到此资源的最大标签数量。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 创建一个空数据集并将其添加到指定的数据集组。用于[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) ## 请求语法 ``` { "datasetGroupArn": "string", "datasetType": "string", "name": "string", "schemaArn": "string", "tags": [ { "tagKey": "string", "tagValue": "string" } ] } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [datasetGroupArn](#API_CreateDataset_RequestSyntax) ** 要添加到数据集的数据集组的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 是否必需：是 ** [datasetType](#API_CreateDataset_RequestSyntax) ** 数据集的类型。以下一个值（区分大小写）： + 交互 + 物品 + 用户 + 操作 + Action\$1Interactions 类型：字符串长度约束：最大长度为 256。模式：`^[A-Za-z_]+$` 是否必需：是 ** [name](#API_CreateDataset_RequestSyntax) ** 数据集的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 是否必需：是 ** [schemaArn](#API_CreateDataset_RequestSyntax) ** 与数据集关联的架构的 ARN。架构定义数据集字段。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 是否必需：是 ** [tags](#API_CreateDataset_RequestSyntax) ** 要应用于数据集的[标签](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)列表。类型：[Tag](API_Tag.md) 对象数组数组成员：最少 0 个物品。最多 200 项。必需：否 ## 响应语法 ``` { "datasetArn": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [datasetArn](#API_CreateDataset_ResponseSyntax) ** 数据集的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** LimitExceededException ** 超出每秒请求次数的限制。 HTTP 状态代码：400 ** ResourceAlreadyExistsException ** 指定资源已经存在。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ** TooManyTagsException ** 您已超出您可以应用到此资源的最大标签数量。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 创建将数据从数据集导出到 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` 键。 ## 请求语法 ``` { "datasetArn": "string", "ingestionMode": "string", "jobName": "string", "jobOutput": { "s3DataDestination": { "kmsKeyArn": "string", "path": "string" } }, "roleArn": "string", "tags": [ { "tagKey": "string", "tagValue": "string" } ] } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [datasetArn](#API_CreateDatasetExportJob_RequestSyntax) ** 包含要导出的数据的数据集的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 是否必需：是 ** [ingestionMode](#API_CreateDatasetExportJob_RequestSyntax) ** 要导出的数据，取决于您导入数据的方式。您可以选择仅导出使用`BULK`数据集导入任务导入的数据或以增量方式导入`PUT`的数据（使用控制台 PutUsers 和 PutItems 操作） PutEvents，或者同时导`ALL`出两种类型的数据。默认值为 `PUT`。类型：字符串有效值：`BULK | PUT | ALL` 必需：否 ** [jobName](#API_CreateDatasetExportJob_RequestSyntax) ** 数据集导出作业的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 是否必需：是 ** [jobOutput](#API_CreateDatasetExportJob_RequestSyntax) ** 指向存储作业输出的 Amazon S3 存储桶的路径。类型：[DatasetExportJobOutput](API_DatasetExportJobOutput.md) 对象是否必需：是 ** [roleArn](#API_CreateDatasetExportJob_RequestSyntax) ** 有权向输出 Amazon S3 存储桶添加数据的 IAM 服务角色的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` 是否必需：是 ** [tags](#API_CreateDatasetExportJob_RequestSyntax) ** 要应用于数据集导出作业的[标签](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)列表。类型：[Tag](API_Tag.md) 对象数组数组成员：最少 0 个物品。最多 200 项。必需：否 ## 响应语法 ``` { "datasetExportJobArn": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [datasetExportJobArn](#API_CreateDatasetExportJob_ResponseSyntax) ** 数据集导出作业的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** LimitExceededException ** 超出每秒请求次数的限制。 HTTP 状态代码：400 ** ResourceAlreadyExistsException ** 指定资源已经存在。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ** TooManyTagsException ** 您已超出您可以应用到此资源的最大标签数量。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 创建空数据集组。数据集组是存放 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) ## 请求语法 ``` { "domain": "string", "kmsKeyArn": "string", "name": "string", "roleArn": "string", "tags": [ { "tagKey": "string", "tagValue": "string" } ] } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [domain](#API_CreateDatasetGroup_RequestSyntax) ** 数据集组的域。要创建域数据集组，请指定域。您指定的域决定了数据集的默认架构和推荐器可用的使用案例。如果您未指定域，则可以创建一个自定义数据集组，其中包含您通过市场活动部署的解决方案版本。类型：字符串有效值：`ECOMMERCE | VIDEO_ON_DEMAND` 必需：否 ** [kmsKeyArn](#API_CreateDatasetGroup_RequestSyntax) ** 用于加密数据集的 (KMS) 密钥的亚马逊资源名称 AWS Key Management Service (ARN)。类型：字符串长度约束：最大长度为 2048。模式：`arn:aws.*:kms:.*:[0-9]{12}:key/.*` 必需：否 ** [name](#API_CreateDatasetGroup_RequestSyntax) ** 新数据集组的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 是否必需：是 ** [roleArn](#API_CreateDatasetGroup_RequestSyntax) ** 有权访问 (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) ** 要应用于数据集组的[标签](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)列表。类型：[Tag](API_Tag.md) 对象数组数组成员：最少 0 个物品。最多 200 项。必需：否 ## 响应语法 ``` { "datasetGroupArn": "string", "domain": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [datasetGroupArn](#API_CreateDatasetGroup_ResponseSyntax) ** 新数据集组的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` ** [domain](#API_CreateDatasetGroup_ResponseSyntax) ** 新域数据集组的域。类型：字符串有效值：`ECOMMERCE | VIDEO_ON_DEMAND` ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** LimitExceededException ** 超出每秒请求次数的限制。 HTTP 状态代码：400 ** ResourceAlreadyExistsException ** 指定资源已经存在。 HTTP 状态代码：400 ** TooManyTagsException ** 您已超出您可以应用到此资源的最大标签数量。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 创建将训练数据从数据源（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) ## 请求语法 ``` { "datasetArn": "string", "dataSource": { "dataLocation": "string" }, "importMode": "string", "jobName": "string", "publishAttributionMetricsToS3": boolean, "roleArn": "string", "tags": [ { "tagKey": "string", "tagValue": "string" } ] } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [datasetArn](#API_CreateDatasetImportJob_RequestSyntax) ** 接收导入数据的数据集的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 是否必需：是 ** [dataSource](#API_CreateDatasetImportJob_RequestSyntax) ** 包含要导入的训练数据的 Amazon S3 桶。类型：[DataSource](API_DataSource.md) 对象是否必需：是 ** [importMode](#API_CreateDatasetImportJob_RequestSyntax) ** 指定如何将新记录添加到现有数据集。默认导入模式为 `FULL`。如果您之前没有将批量记录导入数据集，则只能指定 `FULL`。 + 要覆盖数据集中的所有现有批量数据，请指定 `FULL`。您单独导入的数据不会被替换。 + 要将新记录附加到数据集中的现有数据中，请指定 `INCREMENTAL`。Amazon Personalize 会将所有具有相同 ID 的记录替换为新记录。类型：字符串有效值：`FULL | INCREMENTAL` 必需：否 ** [jobName](#API_CreateDatasetImportJob_RequestSyntax) ** 数据集导入作业的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 是否必需：是 ** [publishAttributionMetricsToS3](#API_CreateDatasetImportJob_RequestSyntax) ** 如果您创建了指标归因，请指定是否将此导入作业的指标发布到 Amazon S3 类型：布尔值必需：否 ** [roleArn](#API_CreateDatasetImportJob_RequestSyntax) ** 有权读取 Amazon S3 数据来源的 IAM 角色的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` 必需：否 ** [tags](#API_CreateDatasetImportJob_RequestSyntax) ** 要应用于数据集导入作业的[标签](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)列表。类型：[Tag](API_Tag.md) 对象数组数组成员：最少 0 个物品。最多 200 项。必需：否 ## 响应语法 ``` { "datasetImportJobArn": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [datasetImportJobArn](#API_CreateDatasetImportJob_ResponseSyntax) ** 数据集导入作业的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** LimitExceededException ** 超出每秒请求次数的限制。 HTTP 状态代码：400 ** ResourceAlreadyExistsException ** 指定资源已经存在。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ** TooManyTagsException ** 您已超出您可以应用到此资源的最大标签数量。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 创建事件跟踪器，供您在使用 [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) ## 请求语法 ``` { "datasetGroupArn": "string", "name": "string", "tags": [ { "tagKey": "string", "tagValue": "string" } ] } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [datasetGroupArn](#API_CreateEventTracker_RequestSyntax) ** 接收事件数据的数据集组的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 是否必需：是 ** [name](#API_CreateEventTracker_RequestSyntax) ** 事件跟踪器的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 是否必需：是 ** [tags](#API_CreateEventTracker_RequestSyntax) ** 要应用于事件跟踪器的[标签](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)列表。类型：[Tag](API_Tag.md) 对象数组数组成员：最少 0 个物品。最多 200 项。必需：否 ## 响应语法 ``` { "eventTrackerArn": "string", "trackingId": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [eventTrackerArn](#API_CreateEventTracker_ResponseSyntax) ** 事件跟踪器的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` ** [trackingId](#API_CreateEventTracker_ResponseSyntax) ** 事件跟踪器的 ID。在向 [PutEvents](https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html)API 发出的请求中包含此 ID。类型：字符串长度约束：最大长度为 256。 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** LimitExceededException ** 超出每秒请求次数的限制。 HTTP 状态代码：400 ** ResourceAlreadyExistsException ** 指定资源已经存在。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ** TooManyTagsException ** 您已超出您可以应用到此资源的最大标签数量。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 创建建议筛选器。有关更多信息，请参阅[筛选建议和用户细分](https://docs.aws.amazon.com/personalize/latest/dg/filter.html)。 ## 请求语法 ``` { "datasetGroupArn": "string", "filterExpression": "string", "name": "string", "tags": [ { "tagKey": "string", "tagValue": "string" } ] } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [datasetGroupArn](#API_CreateFilter_RequestSyntax) ** 筛选器将属于的数据集组的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 是否必需：是 ** [filterExpression](#API_CreateFilter_RequestSyntax) ** 筛选器表达式定义建议中包含或排除哪些物品。筛选器表达式必须遵循特定的格式规则。有关筛选器表达式结构和语法的信息，请参阅[筛选器表达式](https://docs.aws.amazon.com/personalize/latest/dg/filter-expressions.html)。类型：字符串长度限制：最小长度为 1。最大长度为 2500。是否必需：是 ** [name](#API_CreateFilter_RequestSyntax) ** 要创建的筛选器的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 是否必需：是 ** [tags](#API_CreateFilter_RequestSyntax) ** 要应用于筛选器的[标签](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)列表。类型：[Tag](API_Tag.md) 对象数组数组成员：最少 0 个物品。最多 200 项。必需：否 ## 响应语法 ``` { "filterArn": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [filterArn](#API_CreateFilter_ResponseSyntax) ** 新筛选器的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** LimitExceededException ** 超出每秒请求次数的限制。 HTTP 状态代码：400 ** ResourceAlreadyExistsException ** 指定资源已经存在。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ** TooManyTagsException ** 您已超出您可以应用到此资源的最大标签数量。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 创建指标归因。指标归因会针对您导入 Amazon Personalize 的数据创建报告。根据您导入数据的方式，您可以在 Amazon CloudWatch 或 Amazon S3 中查看报告。有关更多信息，请参阅[衡量建议的影响](https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html)。 ## 请求语法 ``` { "datasetGroupArn": "string", "metrics": [ { "eventType": "string", "expression": "string", "metricName": "string" } ], "metricsOutputConfig": { "roleArn": "string", "s3DataDestination": { "kmsKeyArn": "string", "path": "string" } }, "name": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [datasetGroupArn](#API_CreateMetricAttribution_RequestSyntax) ** 指标归因的目标数据集组的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 是否必需：是 ** [metrics](#API_CreateMetricAttribution_RequestSyntax) ** 指标归因的指标属性列表。每个指标属性都指定了要跟踪的事件类型和函数。可用函数为 `SUM()` 或 `SAMPLECOUNT()`。对于 SUM() 函数，提供数据集类型（交互或物品）及要求和的列作为参数。例如 SUM(Items.PRICE)。类型：[MetricAttribute](API_MetricAttribute.md) 对象数组数组成员：最多 10 项。是否必需：是 ** [metricsOutputConfig](#API_CreateMetricAttribution_RequestSyntax) ** 指标归因的输出配置详细信息。类型：[MetricAttributionOutput](API_MetricAttributionOutput.md) 对象是否必需：是 ** [name](#API_CreateMetricAttribution_RequestSyntax) ** 指标归因的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必需：是 ## 响应语法 ``` { "metricAttributionArn": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [metricAttributionArn](#API_CreateMetricAttribution_ResponseSyntax) ** 新指标归因的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** LimitExceededException ** 超出每秒请求次数的限制。 HTTP 状态代码：400 ** ResourceAlreadyExistsException ** 指定资源已经存在。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 通过您指定的食谱（域数据集组使用案例）创建推荐器。您可以为域数据集组创建推荐器，并在提出请求时指定推荐人的亚马逊资源名称 (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) ## 请求语法 ``` { "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" } ] } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [datasetGroupArn](#API_CreateRecommender_RequestSyntax) ** 推荐器目标域数据集组的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 是否必需：是 ** [name](#API_CreateRecommender_RequestSyntax) ** 推荐器的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 是否必需：是 ** [recipeArn](#API_CreateRecommender_RequestSyntax) ** 推荐器将使用的食谱的 Amazon 资源名称 (ARN)。对于推荐器，食谱是域数据集组使用案例。只能使用域数据集组使用案例来创建推荐器。有关使用案例的信息，请参阅[选择推荐器使用案例](https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 是否必需：是 ** [recommenderConfig](#API_CreateRecommender_RequestSyntax) ** 推荐器的配置详细信息。类型：[RecommenderConfig](API_RecommenderConfig.md) 对象必需：否 ** [tags](#API_CreateRecommender_RequestSyntax) ** 要应用于推荐器的[标签](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)列表。类型：[Tag](API_Tag.md) 对象数组数组成员：最少 0 个物品。最多 200 项。必需：否 ## 响应语法 ``` { "recommenderArn": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [recommenderArn](#API_CreateRecommender_ResponseSyntax) ** 推荐器的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** LimitExceededException ** 超出每秒请求次数的限制。 HTTP 状态代码：400 ** ResourceAlreadyExistsException ** 指定资源已经存在。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ** TooManyTagsException ** 您已超出您可以应用到此资源的最大标签数量。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 从指定的架构字符串创建 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) ## 请求语法 ``` { "domain": "string", "name": "string", "schema": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [domain](#API_CreateSchema_RequestSyntax) ** 架构的域。如果要为域数据集组中的数据集创建架构，请指定您在创建域数据集组时选择的域。类型：字符串有效值：`ECOMMERCE | VIDEO_ON_DEMAND` 必需：否 ** [name](#API_CreateSchema_RequestSyntax) ** 架构的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 是否必需：是 ** [schema](#API_CreateSchema_RequestSyntax) ** 采用 Avro JSON 格式的架构。类型：字符串长度限制：最大长度为 20000。是否必需：是 ## 响应语法 ``` { "schemaArn": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [schemaArn](#API_CreateSchema_ResponseSyntax) ** 所创建架构的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** LimitExceededException ** 超出每秒请求次数的限制。 HTTP 状态代码：400 ** ResourceAlreadyExistsException ** 指定资源已经存在。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 **重要** 默认情况下，所有新解决方案都使用自动训练。如果使用自动训练，则在解决方案处于活动状态时，就会产生训练费用。为避免产生不必要的费用，在完成后，可以[更新解决方案](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) ## 请求语法 ``` { "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" } ] } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [datasetGroupArn](#API_CreateSolution_RequestSyntax) ** 提供训练数据的数据集组的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 是否必需：是 ** [eventType](#API_CreateSolution_RequestSyntax) ** 当您有多个事件类型（使用 `EVENT_TYPE` 架构字段）时，此参数指定使用哪种事件类型（例如，“单击”或“点赞”）来训练模型。如果没有提供 `eventType`，则 Amazon Personalize 将使用所有交互进行同等权重的训练，而不考虑类型。类型：字符串长度约束：最大长度为 256。必需：否 ** [name](#API_CreateSolution_RequestSyntax) ** 解决方案的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 是否必需：是 ** [performAutoML](#API_CreateSolution_RequestSyntax) ** 我们建议不要启用自动机器学习。相反，请将您的使用案例与可用的 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) ** 解决方案是否使用自动训练来创建新的解决方案版本（经过训练的模型）。默认设置为 `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) ** 是否对指定或所选食谱执行超参数优化 (HPO)。默认值为 `false`。执行 AutoML 时，此参数始终为 `true`，您不应将其设置为 `false`。类型：布尔值必需：否 ** [performIncrementalUpdate](#API_CreateSolution_RequestSyntax) ** 是否对模型执行增量训练更新。启用后，它允许模型更频繁地从新数据中学习，而无需进行全面的再训练，从而实现近乎实时的个性化。只有使用语义相似度配方的解决方案才支持此参数。类型：布尔值必需：否 ** [recipeArn](#API_CreateSolution_RequestSyntax) ** 用于模型训练的配方的 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) ** 解决方案的配置属性。将 `performAutoML` 设置为 true 时，Amazon Personalize 仅评估解决方案配置的 `autoMLConfig` 部分。 Amazon Personalize 目前不支持配置 `hpoObjective`。类型：[SolutionConfig](API_SolutionConfig.md) 对象必需：否 ** [tags](#API_CreateSolution_RequestSyntax) ** 要应用于解决方案的[标签](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)列表。类型：[Tag](API_Tag.md) 对象数组数组成员：最少 0 个物品。最多 200 项。必需：否 ## 响应语法 ``` { "solutionArn": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [solutionArn](#API_CreateSolution_ResponseSyntax) ** 解决方案的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** LimitExceededException ** 超出每秒请求次数的限制。 HTTP 状态代码：400 ** ResourceAlreadyExistsException ** 指定资源已经存在。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ** TooManyTagsException ** 您已超出您可以应用到此资源的最大标签数量。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 训练或重新训练自定义数据集组中的活动解决方案。解决方案是使用[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) ## 请求语法 ``` { "name": "string", "solutionArn": "string", "tags": [ { "tagKey": "string", "tagValue": "string" } ], "trainingMode": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [name](#API_CreateSolutionVersion_RequestSyntax) ** 解决方案版本的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必需：否 ** [solutionArn](#API_CreateSolutionVersion_RequestSyntax) ** 包含训练配置信息的解决方案的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 是否必需：是 ** [tags](#API_CreateSolutionVersion_RequestSyntax) ** 要应用于解决方案版本的[标签](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)列表。类型：[Tag](API_Tag.md) 对象数组数组成员：最少 0 个物品。最多 200 项。必需：否 ** [trainingMode](#API_CreateSolutionVersion_RequestSyntax) ** 创建解决方案版本时要执行的训练的范围。默认值为 `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` 必需：否 ## 响应语法 ``` { "solutionVersionArn": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [solutionVersionArn](#API_CreateSolutionVersion_ResponseSyntax) ** 新解决方案版本的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** LimitExceededException ** 超出每秒请求次数的限制。 HTTP 状态代码：400 ** ResourceAlreadyExistsException ** 指定资源已经存在。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ** TooManyTagsException ** 您已超出您可以应用到此资源的最大标签数量。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 通过删除解决方案部署来移除市场活动。市场活动所依据的解决方案不会被删除，可以在需要时重新部署。无法再在[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)。 ## 请求语法 ``` { "campaignArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [campaignArn](#API_DeleteCampaign_RequestSyntax) ** 要删除的市场活动的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 是否必需：是 ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 删除数据集。如果关联的 `DatasetImportJob` 或 `SolutionVersion` 处于 CREATE PENDING 或 IN PROGRESS 状态，则您无法删除数据集。有关删除数据集的更多信息，请参阅[删除数据集](https://docs.aws.amazon.com/personalize/latest/dg/delete-dataset.html)。 ## 请求语法 ``` { "datasetArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [datasetArn](#API_DeleteDataset_RequestSyntax) ** 要删除的数据集的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 是否必需：是 ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 删除数据集组。在删除数据集组前，您必须先删除以下内容： + 所有关联的事件跟踪程序。 + 所有关联的解决方案。 + 数据集组中的所有数据集。 ## 请求语法 ``` { "datasetGroupArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [datasetGroupArn](#API_DeleteDatasetGroup_RequestSyntax) ** 要删除的数据集组的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 是否必需：是 ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 删除事件跟踪器。不会将数据集从数据集组中删除。有关事件跟踪器的更多信息，请参阅[CreateEventTracker](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html)。 ## 请求语法 ``` { "eventTrackerArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [eventTrackerArn](#API_DeleteEventTracker_RequestSyntax) ** 要删除的事件跟踪器的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 是否必需：是 ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 删除筛选器。 ## 请求语法 ``` { "filterArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [filterArn](#API_DeleteFilter_RequestSyntax) ** 要删除的筛选器的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 是否必需：是 ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 创建指标归因。 ## 请求语法 ``` { "metricAttributionArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [metricAttributionArn](#API_DeleteMetricAttribution_RequestSyntax) ** 指标归因的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 是否必需：是 ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 停用并移除推荐器。无法再在[GetRecommendations](https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html)请求中指定已删除的推荐人。 ## 请求语法 ``` { "recommenderArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [recommenderArn](#API_DeleteRecommender_RequestSyntax) ** 要删除的推荐器的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 是否必需：是 ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 删除 schema。在删除架构之前，必须删除引用该架构的所有数据集。有关架构的更多信息，请参阅 [CreateSchema](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html)。 ## 请求语法 ``` { "schemaArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [schemaArn](#API_DeleteSchema_RequestSyntax) ** 要删除的架构的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 是否必需：是 ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 删除解决方案的所有版本和 `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)。 ## 请求语法 ``` { "solutionArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [solutionArn](#API_DeleteSolution_RequestSyntax) ** 要删除的解决方案的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 是否必需：是 ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 描述给定的算法。 ## 请求语法 ``` { "algorithmArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [algorithmArn](#API_DescribeAlgorithm_RequestSyntax) ** 要描述的算法的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：是 ## 响应语法 ``` { "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" } } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [algorithm](#API_DescribeAlgorithm_ResponseSyntax) ** 算法属性的列表。类型：[Algorithm](API_Algorithm.md) 对象 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 获取批量推理作业的属性，包括名称、Amazon 资源名称 (ARN)、状态、输入和输出配置，以及用于生成建议的解决方案版本的 ARN。 ## 请求语法 ``` { "batchInferenceJobArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [batchInferenceJobArn](#API_DescribeBatchInferenceJob_RequestSyntax) ** 要描述的批量推理作业的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：是 ## 响应语法 ``` { "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" } } } } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [batchInferenceJob](#API_DescribeBatchInferenceJob_ResponseSyntax) ** 有关指定批量推理作业的信息。类型：[BatchInferenceJob](API_BatchInferenceJob.md) 对象 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 获取批量细分作业的属性，包括名称、Amazon 资源名称 (ARN)、状态、输入和输出配置，以及用于生成建议的解决方案版本的 ARN。 ## 请求语法 ``` { "batchSegmentJobArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [batchSegmentJobArn](#API_DescribeBatchSegmentJob_RequestSyntax) ** 要描述的批量细分作业的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：是 ## 响应语法 ``` { "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" } } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [batchSegmentJob](#API_DescribeBatchSegmentJob_ResponseSyntax) ** 有关指定批量细分作业的信息。类型：[BatchSegmentJob](API_BatchSegmentJob.md) 对象 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 描述给定的市场活动，包括其状态。市场活动可处于以下几种状态之一： + 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)。 ## 请求语法 ``` { "campaignArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [campaignArn](#API_DescribeCampaign_RequestSyntax) ** 市场活动的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：是 ## 响应语法 ``` { "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" } } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [campaign](#API_DescribeCampaign_ResponseSyntax) ** 仅当市场活动至少接到一个 `latestCampaignUpdate` 电话时，才会返回 `UpdateCampaign` 字段。市场活动的属性。仅当市场活动至少接到一个 `latestCampaignUpdate` 电话时，才会返回 `UpdateCampaign` 字段。类型：[Campaign](API_Campaign.md) 对象 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 描述由创建的数据删除任务 [CreateDataDeletionJob](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataDeletionJob.html)，包括任务状态。 ## 请求语法 ``` { "dataDeletionJobArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [dataDeletionJobArn](#API_DescribeDataDeletionJob_RequestSyntax) ** 数据删除作业的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：是 ## 响应语法 ``` { "dataDeletionJob": { "creationDateTime": number, "dataDeletionJobArn": "string", "datasetGroupArn": "string", "dataSource": { "dataLocation": "string" }, "failureReason": "string", "jobName": "string", "lastUpdatedDateTime": number, "numDeleted": number, "roleArn": "string", "status": "string" } } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [dataDeletionJob](#API_DescribeDataDeletionJob_ResponseSyntax) ** 有关数据删除作业的信息，包括状态。状态是以下值之一： + PENDING + 进行中 + COMPLETED + FAILED 类型：[DataDeletionJob](API_DataDeletionJob.md) 对象 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 描述指定的数据集。有关数据集的更多信息，请参阅[CreateDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html)。 ## 请求语法 ``` { "datasetArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [datasetArn](#API_DescribeDataset_RequestSyntax) ** 要描述的数据集的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：是 ## 响应语法 ``` { "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" } } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [dataset](#API_DescribeDataset_ResponseSyntax) ** 数据集的属性列表。类型：[Dataset](API_Dataset.md) 对象 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 描述由创建的数据集导出任务 [CreateDatasetExportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html)，包括导出任务状态。 ## 请求语法 ``` { "datasetExportJobArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [datasetExportJobArn](#API_DescribeDatasetExportJob_RequestSyntax) ** 要描述的数据集导出作业的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：是 ## 响应语法 ``` { "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" } } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [datasetExportJob](#API_DescribeDatasetExportJob_ResponseSyntax) ** 有关数据集导出作业的信息，包括状态。状态是以下值之一： + CREATE PENDING + CREATE IN\$1PROGRESS + ACTIVE + CREATE FAILED 类型：[DatasetExportJob](API_DatasetExportJob.md) 对象 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 描述给定的数据集组。有关数据集组的更多信息，请参阅[CreateDatasetGroup](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html)。 ## 请求语法 ``` { "datasetGroupArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [datasetGroupArn](#API_DescribeDatasetGroup_RequestSyntax) ** 要描述的数据集组的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：是 ## 响应语法 ``` { "datasetGroup": { "creationDateTime": number, "datasetGroupArn": "string", "domain": "string", "failureReason": "string", "kmsKeyArn": "string", "lastUpdatedDateTime": number, "name": "string", "roleArn": "string", "status": "string" } } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [datasetGroup](#API_DescribeDatasetGroup_ResponseSyntax) ** 数据集组的属性列表。类型：[DatasetGroup](API_DatasetGroup.md) 对象 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 描述由创建的数据集导入任务 [CreateDatasetImportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html)，包括导入任务状态。 ## 请求语法 ``` { "datasetImportJobArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [datasetImportJobArn](#API_DescribeDatasetImportJob_RequestSyntax) ** 要描述的数据集导入作业的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：是 ## 响应语法 ``` { "datasetImportJob": { "creationDateTime": number, "datasetArn": "string", "datasetImportJobArn": "string", "dataSource": { "dataLocation": "string" }, "failureReason": "string", "importMode": "string", "jobName": "string", "lastUpdatedDateTime": number, "publishAttributionMetricsToS3": boolean, "roleArn": "string", "status": "string" } } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [datasetImportJob](#API_DescribeDatasetImportJob_ResponseSyntax) ** 有关数据集导入作业的信息，包括状态。状态是以下值之一： + CREATE PENDING + CREATE IN\$1PROGRESS + ACTIVE + CREATE FAILED 类型：[DatasetImportJob](API_DatasetImportJob.md) 对象 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 描述事件跟踪器。响应包括事件跟踪器的 `trackingId` 和 `status`。有关事件跟踪器的更多信息，请参阅[CreateEventTracker](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html)。 ## 请求语法 ``` { "eventTrackerArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [eventTrackerArn](#API_DescribeEventTracker_RequestSyntax) ** 要描述的事件跟踪器的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：是 ## 响应语法 ``` { "eventTracker": { "accountId": "string", "creationDateTime": number, "datasetGroupArn": "string", "eventTrackerArn": "string", "lastUpdatedDateTime": number, "name": "string", "status": "string", "trackingId": "string" } } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [eventTracker](#API_DescribeEventTracker_ResponseSyntax) ** 描述事件跟踪器的对象。类型：[EventTracker](API_EventTracker.md) 对象 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 描述给定的特征转换。 ## 请求语法 ``` { "featureTransformationArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [featureTransformationArn](#API_DescribeFeatureTransformation_RequestSyntax) ** 要描述的特征转换的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：是 ## 响应语法 ``` { "featureTransformation": { "creationDateTime": number, "defaultParameters": { "string" : "string" }, "featureTransformationArn": "string", "lastUpdatedDateTime": number, "name": "string", "status": "string" } } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [featureTransformation](#API_DescribeFeatureTransformation_ResponseSyntax) ** 房产清单。 FeatureTransformation 类型：[FeatureTransformation](API_FeatureTransformation.md) 对象 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 描述筛选器的属性。 ## 请求语法 ``` { "filterArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [filterArn](#API_DescribeFilter_RequestSyntax) ** 要描述的筛选器的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：是 ## 响应语法 ``` { "filter": { "creationDateTime": number, "datasetGroupArn": "string", "failureReason": "string", "filterArn": "string", "filterExpression": "string", "lastUpdatedDateTime": number, "name": "string", "status": "string" } } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [filter](#API_DescribeFilter_ResponseSyntax) ** 筛选器的详细信息。类型：[Filter](API_Filter.md) 对象 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 描述指标归因。 ## 请求语法 ``` { "metricAttributionArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [metricAttributionArn](#API_DescribeMetricAttribution_RequestSyntax) ** 指标归因的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：是 ## 响应语法 ``` { "metricAttribution": { "creationDateTime": number, "datasetGroupArn": "string", "failureReason": "string", "lastUpdatedDateTime": number, "metricAttributionArn": "string", "metricsOutputConfig": { "roleArn": "string", "s3DataDestination": { "kmsKeyArn": "string", "path": "string" } }, "name": "string", "status": "string" } } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [metricAttribution](#API_DescribeMetricAttribution_ResponseSyntax) ** 指标归因的详细信息。类型：[MetricAttribution](API_MetricAttribution.md) 对象 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 描述食谱。一个食谱包含三项： + 训练模型的算法。 + 控制训练的超参数。 + 用于在训练前修改输入数据的特征转换信息。 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 提供推荐。 ## 请求语法 ``` { "recipeArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [recipeArn](#API_DescribeRecipe_RequestSyntax) ** 要描述的食谱的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：是 ## 响应语法 ``` { "recipe": { "algorithmArn": "string", "creationDateTime": number, "description": "string", "featureTransformationArn": "string", "lastUpdatedDateTime": number, "name": "string", "recipeArn": "string", "recipeType": "string", "status": "string" } } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [recipe](#API_DescribeRecipe_ResponseSyntax) ** 描述食谱的对象。类型：[Recipe](API_Recipe.md) 对象 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 描述给定的推荐器，包括其状态。推荐器可处于以下一种状态： + 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)。 ## 请求语法 ``` { "recommenderArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [recommenderArn](#API_DescribeRecommender_RequestSyntax) ** 要描述的推荐器的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：是 ## 响应语法 ``` { "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" } } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [recommender](#API_DescribeRecommender_ResponseSyntax) ** 推荐器的属性。类型：[Recommender](API_Recommender.md) 对象 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 描述架构。有关架构的更多信息，请参阅 [CreateSchema](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html)。 ## 请求语法 ``` { "schemaArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [schemaArn](#API_DescribeSchema_RequestSyntax) ** 要检索的架构的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：是 ## 响应语法 ``` { "schema": { "creationDateTime": number, "domain": "string", "lastUpdatedDateTime": number, "name": "string", "schema": "string", "schemaArn": "string" } } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [schema](#API_DescribeSchema_ResponseSyntax) ** 请求的架构。类型：[DatasetSchema](API_DatasetSchema.md) 对象 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 描述解决方案。有关解决方案的更多信息，请参阅[CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html)。 ## 请求语法 ``` { "solutionArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [solutionArn](#API_DescribeSolution_RequestSyntax) ** 要描述的解决方案的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：是 ## 响应语法 ``` { "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" } } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [solution](#API_DescribeSolution_ResponseSyntax) ** 描述解决方案的对象。类型：[Solution](API_Solution.md) 对象 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 描述解决方案的特定版本。有关解决方案的更多信息，请参阅 [CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) ## 请求语法 ``` { "solutionVersionArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [solutionVersionArn](#API_DescribeSolutionVersion_RequestSyntax) ** 解决方案版本的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：是 ## 响应语法 ``` { "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" } } } } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [solutionVersion](#API_DescribeSolutionVersion_ResponseSyntax) ** 解决方案版本。类型：[SolutionVersion](API_SolutionVersion.md) 对象 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 获取指定解决方案版本的指标。 ## 请求语法 ``` { "solutionVersionArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [solutionVersionArn](#API_GetSolutionMetrics_RequestSyntax) ** 要获取指标的解决方案版本的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：是 ## 响应语法 ``` { "metrics": { "string" : number }, "solutionVersionArn": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [metrics](#API_GetSolutionMetrics_ResponseSyntax) ** 解决方案版本的指标。有关更多信息，请参阅[使用指标评估解决方案版本](https://docs.aws.amazon.com/personalize/latest/dg/working-with-training-metrics.html)。类型：字符串到双映射映射条目：最多 100 项。键长度限制：最大长度为 256。 ** [solutionVersionArn](#API_GetSolutionMetrics_ResponseSyntax) ** 与请求中指定的解决方案版本 ARN 相同。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 获取已在解决方案版本之外执行的批量推理作业的列表。 ## 请求语法 ``` { "maxResults": number, "nextToken": "string", "solutionVersionArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [maxResults](#API_ListBatchInferenceJobs_RequestSyntax) ** 每页返回的批量推理作业结果的最大数量。默认值是 100。类型：整数有效范围：最小值为 1。最大值为 100。必需：否 ** [nextToken](#API_ListBatchInferenceJobs_RequestSyntax) ** 用于请求下一页结果的令牌。类型：字符串长度限制：最大长度为 1500。模式：`\p{ASCII}{0,1500}` 必需：否 ** [solutionVersionArn](#API_ListBatchInferenceJobs_RequestSyntax) ** 创建批量推理作业所依据的解决方案版本的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ## 响应语法 ``` { "batchInferenceJobs": [ { "batchInferenceJobArn": "string", "batchInferenceJobMode": "string", "creationDateTime": number, "failureReason": "string", "jobName": "string", "lastUpdatedDateTime": number, "solutionVersionArn": "string", "status": "string" } ], "nextToken": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [batchInferenceJobs](#API_ListBatchInferenceJobs_ResponseSyntax) ** 包含返回的每项作业信息的列表。类型：[BatchInferenceJobSummary](API_BatchInferenceJobSummary.md) 对象数组数组成员：最多 100 项。 ** [nextToken](#API_ListBatchInferenceJobs_ResponseSyntax) ** 用于检索下一页结果的令牌。当没有更多结果可返回时，值为 `null`。类型：字符串长度限制：最大长度为 1500。模式：`\p{ASCII}{0,1500}` ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** InvalidNextTokenException ** 令牌无效。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 获取已在您指定的解决方案版本之外执行的批量细分作业的列表。 ## 请求语法 ``` { "maxResults": number, "nextToken": "string", "solutionVersionArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [maxResults](#API_ListBatchSegmentJobs_RequestSyntax) ** 每页返回的批量细分作业结果的最大数量。默认值是 100。类型：整数有效范围：最小值为 1。最大值为 100。必需：否 ** [nextToken](#API_ListBatchSegmentJobs_RequestSyntax) ** 用于请求下一页结果的令牌。类型：字符串长度限制：最大长度为 1500。模式：`\p{ASCII}{0,1500}` 必需：否 ** [solutionVersionArn](#API_ListBatchSegmentJobs_RequestSyntax) ** 批量细分作业用于生成批量细分的解决方案版本的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ## 响应语法 ``` { "batchSegmentJobs": [ { "batchSegmentJobArn": "string", "creationDateTime": number, "failureReason": "string", "jobName": "string", "lastUpdatedDateTime": number, "solutionVersionArn": "string", "status": "string" } ], "nextToken": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [batchSegmentJobs](#API_ListBatchSegmentJobs_ResponseSyntax) ** 包含返回的每项作业信息的列表。类型：[BatchSegmentJobSummary](API_BatchSegmentJobSummary.md) 对象数组数组成员：最多 100 项。 ** [nextToken](#API_ListBatchSegmentJobs_ResponseSyntax) ** 用于检索下一页结果的令牌。当没有更多结果可返回时，值为 `null`。类型：字符串长度限制：最大长度为 1500。模式：`\p{ASCII}{0,1500}` ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** InvalidNextTokenException ** 令牌无效。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 返回使用给定解决方案的市场活动列表。如果未指定解决方案，则会列出与账户关联的所有市场活动。响应中将提供每个市场活动的属性，包括 Amazon 资源名称 (ARN)。有关活动的更多信息，请参阅[CreateCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html)。 ## 请求语法 ``` { "maxResults": number, "nextToken": "string", "solutionArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [maxResults](#API_ListCampaigns_RequestSyntax) ** 要返回的市场活动的最大数量。类型：整数有效范围：最小值为 1。最大值为 100。必需：否 ** [nextToken](#API_ListCampaigns_RequestSyntax) ** 从上一次调用返回[ListCampaigns](https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html)的代币，用于获取下一组活动（如果存在）。类型：字符串长度限制：最大长度为 1500。模式：`\p{ASCII}{0,1500}` 必需：否 ** [solutionArn](#API_ListCampaigns_RequestSyntax) ** 要列出市场活动的解决方案的 Amazon 资源名称 (ARN)。如果未指定解决方案，则会列出与账户关联的所有市场活动。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ## 响应语法 ``` { "campaigns": [ { "campaignArn": "string", "creationDateTime": number, "failureReason": "string", "lastUpdatedDateTime": number, "name": "string", "status": "string" } ], "nextToken": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [campaigns](#API_ListCampaigns_ResponseSyntax) ** 市场活动列表。类型：[CampaignSummary](API_CampaignSummary.md) 对象数组数组成员：最多 100 项。 ** [nextToken](#API_ListCampaigns_ResponseSyntax) ** 用于获取下一组市场活动（如果存在）的令牌。类型：字符串长度限制：最大长度为 1500。模式：`\p{ASCII}{0,1500}` ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** InvalidNextTokenException ** 令牌无效。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 返回数据集组的数据删除作业列表，按创建时间排序，最新的作业排在最前面。如果未指定数据集组，则会列出与账户关联的所有数据删除作业。响应中将提供每个作业的属性，包括 Amazon 资源名称（ARN）。有关数据删除作业的更多信息，请参阅[删除用户](https://docs.aws.amazon.com/personalize/latest/dg/delete-records.html)。 ## 请求语法 ``` { "datasetGroupArn": "string", "maxResults": number, "nextToken": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [datasetGroupArn](#API_ListDataDeletionJobs_RequestSyntax) ** 要列出数据删除作业的数据集组的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** [maxResults](#API_ListDataDeletionJobs_RequestSyntax) ** 要返回的数据删除作业的最大数量。类型：整数有效范围：最小值为 1。最大值为 100。必需：否 ** [nextToken](#API_ListDataDeletionJobs_RequestSyntax) ** 上次调用 `ListDataDeletionJobs` 用于获取下一组作业（如果存在）时返回的令牌。类型：字符串长度限制：最大长度为 1500。模式：`\p{ASCII}{0,1500}` 必需：否 ## 响应语法 ``` { "dataDeletionJobs": [ { "creationDateTime": number, "dataDeletionJobArn": "string", "datasetGroupArn": "string", "failureReason": "string", "jobName": "string", "lastUpdatedDateTime": number, "status": "string" } ], "nextToken": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [dataDeletionJobs](#API_ListDataDeletionJobs_ResponseSyntax) ** 数据删除作业列表。类型：[DataDeletionJobSummary](API_DataDeletionJobSummary.md) 对象数组数组成员：最多 100 项。 ** [nextToken](#API_ListDataDeletionJobs_ResponseSyntax) ** 用于获取下一组数据删除作业（如果存在）的令牌。类型：字符串长度限制：最大长度为 1500。模式：`\p{ASCII}{0,1500}` ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** InvalidNextTokenException ** 令牌无效。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 返回使用给定数据集的数据集导出作业列表。如果未指定数据集，则会列出与账户关联的所有数据集导出作业。响应中将提供每个数据集导出作业的属性，包括 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)。 ## 请求语法 ``` { "datasetArn": "string", "maxResults": number, "nextToken": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [datasetArn](#API_ListDatasetExportJobs_RequestSyntax) ** 要列出数据集导出作业的数据集的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** [maxResults](#API_ListDatasetExportJobs_RequestSyntax) ** 要返回的数据集导出作业的最大数量。类型：整数有效范围：最小值为 1。最大值为 100。必需：否 ** [nextToken](#API_ListDatasetExportJobs_RequestSyntax) ** 上次调用 `ListDatasetExportJobs` 用于获取下一组数据集导出作业（如果存在）时返回的令牌。类型：字符串长度限制：最大长度为 1500。模式：`\p{ASCII}{0,1500}` 必需：否 ## 响应语法 ``` { "datasetExportJobs": [ { "creationDateTime": number, "datasetExportJobArn": "string", "failureReason": "string", "jobName": "string", "lastUpdatedDateTime": number, "status": "string" } ], "nextToken": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [datasetExportJobs](#API_ListDatasetExportJobs_ResponseSyntax) ** 数据集导出作业列表。类型：[DatasetExportJobSummary](API_DatasetExportJobSummary.md) 对象数组数组成员：最多 100 项。 ** [nextToken](#API_ListDatasetExportJobs_ResponseSyntax) ** 用于获取下一组数据集导出作业（如果存在）的令牌。类型：字符串长度限制：最大长度为 1500。模式：`\p{ASCII}{0,1500}` ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** InvalidNextTokenException ** 令牌无效。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 返回数据集组的列表。响应中将提供每个数据集组的属性，包括 Amazon 资源名称 (ARN)。有关数据集组的更多信息，请参阅[CreateDatasetGroup](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html)。 ## 请求语法 ``` { "maxResults": number, "nextToken": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [maxResults](#API_ListDatasetGroups_RequestSyntax) ** 要返回的数据集组的最大数量。类型：整数有效范围：最小值为 1。最大值为 100。必需：否 ** [nextToken](#API_ListDatasetGroups_RequestSyntax) ** 上次调用 `ListDatasetGroups` 用于获取下一组数据集组（如果存在）时返回的令牌。类型：字符串长度限制：最大长度为 1500。模式：`\p{ASCII}{0,1500}` 必需：否 ## 响应语法 ``` { "datasetGroups": [ { "creationDateTime": number, "datasetGroupArn": "string", "domain": "string", "failureReason": "string", "lastUpdatedDateTime": number, "name": "string", "status": "string" } ], "nextToken": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [datasetGroups](#API_ListDatasetGroups_ResponseSyntax) ** 数据集组列表。类型：[DatasetGroupSummary](API_DatasetGroupSummary.md) 对象数组数组成员：最多 100 项。 ** [nextToken](#API_ListDatasetGroups_ResponseSyntax) ** 用于获取下一组数据集组（如果存在）的令牌。类型：字符串长度限制：最大长度为 1500。模式：`\p{ASCII}{0,1500}` ## 错误 ** InvalidNextTokenException ** 令牌无效。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 返回使用给定数据集的数据集导入作业的列表。如果未指定数据集，则会列出与账户关联的所有数据集导入作业。响应中将提供每个数据集导入作业的属性，包括 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)。 ## 请求语法 ``` { "datasetArn": "string", "maxResults": number, "nextToken": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [datasetArn](#API_ListDatasetImportJobs_RequestSyntax) ** 要列出数据集导入作业的数据集的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** [maxResults](#API_ListDatasetImportJobs_RequestSyntax) ** 要返回的数据集导入作业的最大数量。类型：整数有效范围：最小值为 1。最大值为 100。必需：否 ** [nextToken](#API_ListDatasetImportJobs_RequestSyntax) ** 上次调用 `ListDatasetImportJobs` 用于获取下一组数据集导入作业（如果存在）时返回的令牌。类型：字符串长度限制：最大长度为 1500。模式：`\p{ASCII}{0,1500}` 必需：否 ## 响应语法 ``` { "datasetImportJobs": [ { "creationDateTime": number, "datasetImportJobArn": "string", "failureReason": "string", "importMode": "string", "jobName": "string", "lastUpdatedDateTime": number, "status": "string" } ], "nextToken": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [datasetImportJobs](#API_ListDatasetImportJobs_ResponseSyntax) ** 数据集导入作业的列表。类型：[DatasetImportJobSummary](API_DatasetImportJobSummary.md) 对象数组数组成员：最多 100 项。 ** [nextToken](#API_ListDatasetImportJobs_ResponseSyntax) ** 用于获取下一组数据集导入作业（如果存在）的令牌。类型：字符串长度限制：最大长度为 1500。模式：`\p{ASCII}{0,1500}` ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** InvalidNextTokenException ** 令牌无效。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 返回给定数据集组中包含的数据集列表。响应中将提供每个数据集的属性，包括 Amazon 资源名称 (ARN)。有关数据集的更多信息，请参阅[CreateDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html)。 ## 请求语法 ``` { "datasetGroupArn": "string", "maxResults": number, "nextToken": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [datasetGroupArn](#API_ListDatasets_RequestSyntax) ** 包含要列出的数据集的数据集组的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** [maxResults](#API_ListDatasets_RequestSyntax) ** 要返回的数据集的最大数量。类型：整数有效范围：最小值为 1。最大值为 100。必需：否 ** [nextToken](#API_ListDatasets_RequestSyntax) ** 上次调用 `ListDatasets` 用于获取下一组数据集导入作业（如果存在）时返回的令牌。类型：字符串长度限制：最大长度为 1500。模式：`\p{ASCII}{0,1500}` 必需：否 ## 响应语法 ``` { "datasets": [ { "creationDateTime": number, "datasetArn": "string", "datasetType": "string", "lastUpdatedDateTime": number, "name": "string", "status": "string" } ], "nextToken": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [datasets](#API_ListDatasets_ResponseSyntax) ** `Dataset` 数据元数组。每个对象都提供元数据信息。类型：[DatasetSummary](API_DatasetSummary.md) 对象数组数组成员：最多 100 项。 ** [nextToken](#API_ListDatasets_ResponseSyntax) ** 用于获取下一组数据集（如果存在）的令牌。类型：字符串长度限制：最大长度为 1500。模式：`\p{ASCII}{0,1500}` ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** InvalidNextTokenException ** 令牌无效。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 返回与账户关联的事件跟踪器的列表。响应中将提供每个事件跟踪器的属性，包括 Amazon 资源名称 (ARN) 和跟踪 ID。有关事件跟踪器的更多信息，请参阅[CreateEventTracker](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html)。 ## 请求语法 ``` { "datasetGroupArn": "string", "maxResults": number, "nextToken": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [datasetGroupArn](#API_ListEventTrackers_RequestSyntax) ** 用于筛选响应的数据集组的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** [maxResults](#API_ListEventTrackers_RequestSyntax) ** 要返回的事件跟踪器的最大数量。类型：整数有效范围：最小值为 1。最大值为 100。必需：否 ** [nextToken](#API_ListEventTrackers_RequestSyntax) ** 上次调用 `ListEventTrackers` 用于获取下一组事件跟踪器（如果存在）时返回的令牌。类型：字符串长度限制：最大长度为 1500。模式：`\p{ASCII}{0,1500}` 必需：否 ## 响应语法 ``` { "eventTrackers": [ { "creationDateTime": number, "eventTrackerArn": "string", "lastUpdatedDateTime": number, "name": "string", "status": "string" } ], "nextToken": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [eventTrackers](#API_ListEventTrackers_ResponseSyntax) ** 事件跟踪器列表。类型：[EventTrackerSummary](API_EventTrackerSummary.md) 对象数组数组成员：最多 100 项。 ** [nextToken](#API_ListEventTrackers_ResponseSyntax) ** 用于获取下一组事件跟踪器（如果存在）的令牌。类型：字符串长度限制：最大长度为 1500。模式：`\p{ASCII}{0,1500}` ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** InvalidNextTokenException ** 令牌无效。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 列出属于给定数据集组的所有筛选器。 ## 请求语法 ``` { "datasetGroupArn": "string", "maxResults": number, "nextToken": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [datasetGroupArn](#API_ListFilters_RequestSyntax) ** 包含筛选器的数据集组的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** [maxResults](#API_ListFilters_RequestSyntax) ** 要返回的筛选器的最大数量。类型：整数有效范围：最小值为 1。最大值为 100。必需：否 ** [nextToken](#API_ListFilters_RequestSyntax) ** 上次调用 `ListFilters` 用于获取下一组筛选器（如果存在）时返回的令牌。类型：字符串长度限制：最大长度为 1500。模式：`\p{ASCII}{0,1500}` 必需：否 ## 响应语法 ``` { "Filters": [ { "creationDateTime": number, "datasetGroupArn": "string", "failureReason": "string", "filterArn": "string", "lastUpdatedDateTime": number, "name": "string", "status": "string" } ], "nextToken": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [Filters](#API_ListFilters_ResponseSyntax) ** 返回的筛选器的列表。类型：[FilterSummary](API_FilterSummary.md) 对象数组数组成员：最多 100 项。 ** [nextToken](#API_ListFilters_ResponseSyntax) ** 用于获取下一组筛选器（如果存在）的令牌。类型：字符串长度限制：最大长度为 1500。模式：`\p{ASCII}{0,1500}` ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** InvalidNextTokenException ** 令牌无效。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 列出指标归因的指标。 ## 请求语法 ``` { "maxResults": number, "metricAttributionArn": "string", "nextToken": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [maxResults](#API_ListMetricAttributionMetrics_RequestSyntax) ** 在一页结果中返回的指标的最大数量。类型：整数有效范围：最小值为 1。最大值为 100。必需：否 ** [metricAttributionArn](#API_ListMetricAttributionMetrics_RequestSyntax) ** 要检索其属性的指标归因的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** [nextToken](#API_ListMetricAttributionMetrics_RequestSyntax) ** 指定上次请求检索下一页结果时的分页令牌。类型：字符串长度限制：最大长度为 1500。模式：`\p{ASCII}{0,1500}` 必需：否 ## 响应语法 ``` { "metrics": [ { "eventType": "string", "expression": "string", "metricName": "string" } ], "nextToken": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [metrics](#API_ListMetricAttributionMetrics_ResponseSyntax) ** 指定指标归因的指标。类型：[MetricAttribute](API_MetricAttribute.md) 对象数组数组成员：最多 10 项。 ** [nextToken](#API_ListMetricAttributionMetrics_ResponseSyntax) ** 指定上次 `ListMetricAttributionMetricsResponse` 请求检索下一页结果时的分页令牌。类型：字符串长度限制：最大长度为 1500。模式：`\p{ASCII}{0,1500}` ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** InvalidNextTokenException ** 令牌无效。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 列出指标归因。 ## 请求语法 ``` { "datasetGroupArn": "string", "maxResults": number, "nextToken": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [datasetGroupArn](#API_ListMetricAttributions_RequestSyntax) ** 指标归因的数据集组 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** [maxResults](#API_ListMetricAttributions_RequestSyntax) ** 在一页结果中返回的指标归因的最大数量。类型：整数有效范围：最小值为 1。最大值为 100。必需：否 ** [nextToken](#API_ListMetricAttributions_RequestSyntax) ** 指定上次请求检索下一页结果时的分页令牌。类型：字符串长度限制：最大长度为 1500。模式：`\p{ASCII}{0,1500}` 必需：否 ## 响应语法 ``` { "metricAttributions": [ { "creationDateTime": number, "failureReason": "string", "lastUpdatedDateTime": number, "metricAttributionArn": "string", "name": "string", "status": "string" } ], "nextToken": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [metricAttributions](#API_ListMetricAttributions_ResponseSyntax) ** 指标归因列表。类型：[MetricAttributionSummary](API_MetricAttributionSummary.md) 对象数组数组成员：最多 100 项。 ** [nextToken](#API_ListMetricAttributions_ResponseSyntax) ** 指定上次请求检索下一页结果时的分页令牌。类型：字符串长度限制：最大长度为 1500。模式：`\p{ASCII}{0,1500}` ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** InvalidNextTokenException ** 令牌无效。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 返回可用食谱列表。响应中将提供每个食谱的属性，包括食谱的 Amazon 资源名称 (ARN)。 ## 请求语法 ``` { "domain": "string", "maxResults": number, "nextToken": "string", "recipeProvider": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [domain](#API_ListRecipes_RequestSyntax) ** 按域数据集组的域筛选返回的食谱。响应中仅包含该域的食谱（域数据集组使用案例）。如果不指定域，则返回所有食谱。类型：字符串有效值：`ECOMMERCE | VIDEO_ON_DEMAND` 必需：否 ** [maxResults](#API_ListRecipes_RequestSyntax) ** 要返回的食谱的最大数量。类型：整数有效范围：最小值为 1。最大值为 100。必需：否 ** [nextToken](#API_ListRecipes_RequestSyntax) ** 上次调用 `ListRecipes` 用于获取下一组食谱（如果存在）时返回的令牌。类型：字符串长度限制：最大长度为 1500。模式：`\p{ASCII}{0,1500}` 必需：否 ** [recipeProvider](#API_ListRecipes_RequestSyntax) ** 默认值为 `SERVICE`。类型：字符串有效值：`SERVICE` 必需：否 ## 响应语法 ``` { "nextToken": "string", "recipes": [ { "creationDateTime": number, "domain": "string", "lastUpdatedDateTime": number, "name": "string", "recipeArn": "string", "status": "string" } ] } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [nextToken](#API_ListRecipes_ResponseSyntax) ** 用于获取下一组食谱的令牌。类型：字符串长度限制：最大长度为 1500。模式：`\p{ASCII}{0,1500}` ** [recipes](#API_ListRecipes_ResponseSyntax) ** 可用食谱的列表。类型：[RecipeSummary](API_RecipeSummary.md) 对象数组数组成员：最多 100 项。 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** InvalidNextTokenException ** 令牌无效。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 返回给定域数据集组中的推荐器列表。如果未指定域数据集组，则会列出与账户关联的所有推荐器。响应中将提供每个推荐器的属性，包括 Amazon 资源名称 (ARN)。有关推荐人的更多信息，请参阅[CreateRecommender](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateRecommender.html)。 ## 请求语法 ``` { "datasetGroupArn": "string", "maxResults": number, "nextToken": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [datasetGroupArn](#API_ListRecommenders_RequestSyntax) ** 要列出推荐器的域数据集组的 Amazon 资源名称 (ARN)。如果未指定域数据集组，则会列出与账户关联的所有推荐器。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** [maxResults](#API_ListRecommenders_RequestSyntax) ** 要返回的推荐器的最大数量。类型：整数有效范围：最小值为 1。最大值为 100。必需：否 ** [nextToken](#API_ListRecommenders_RequestSyntax) ** 上次调用 `ListRecommenders` 用于获取下一组推荐器（如果存在）时返回的令牌。类型：字符串长度限制：最大长度为 1500。模式：`\p{ASCII}{0,1500}` 必需：否 ## 响应语法 ``` { "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" } ] } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [nextToken](#API_ListRecommenders_ResponseSyntax) ** 用于获取下一组推荐器（如果存在）的令牌。类型：字符串长度限制：最大长度为 1500。模式：`\p{ASCII}{0,1500}` ** [recommenders](#API_ListRecommenders_ResponseSyntax) ** 推荐器的列表。类型：[RecommenderSummary](API_RecommenderSummary.md) 对象数组数组成员：最多 100 项。 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** InvalidNextTokenException ** 令牌无效。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 返回与账户关联的架构的列表。响应中将提供每个架构的属性，包括 Amazon 资源名称 (ARN)。有关架构的更多信息，请参阅 [CreateSchema](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html)。 ## 请求语法 ``` { "maxResults": number, "nextToken": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [maxResults](#API_ListSchemas_RequestSyntax) ** 要返回的架构的最大数量。类型：整数有效范围：最小值为 1。最大值为 100。必需：否 ** [nextToken](#API_ListSchemas_RequestSyntax) ** 上次调用 `ListSchemas` 用于获取下一组架构（如果存在）时返回的令牌。类型：字符串长度限制：最大长度为 1500。模式：`\p{ASCII}{0,1500}` 必需：否 ## 响应语法 ``` { "nextToken": "string", "schemas": [ { "creationDateTime": number, "domain": "string", "lastUpdatedDateTime": number, "name": "string", "schemaArn": "string" } ] } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [nextToken](#API_ListSchemas_ResponseSyntax) ** 用于获取下一组架构（如果存在）的令牌。类型：字符串长度限制：最大长度为 1500。模式：`\p{ASCII}{0,1500}` ** [schemas](#API_ListSchemas_ResponseSyntax) ** 架构列表。类型：[DatasetSchemaSummary](API_DatasetSchemaSummary.md) 对象数组数组成员：最多 100 项。 ## 错误 ** InvalidNextTokenException ** 令牌无效。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 返回给定数据集组中的解决方案列表。如果未指定数据集组，则会列出与账户关联的所有解决方案。响应中将提供每个解决方案的属性，包括 Amazon 资源名称 (ARN)。有关解决方案的更多信息，请参阅[CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html)。 ## 请求语法 ``` { "datasetGroupArn": "string", "maxResults": number, "nextToken": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [datasetGroupArn](#API_ListSolutions_RequestSyntax) ** 数据集组的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** [maxResults](#API_ListSolutions_RequestSyntax) ** 要返回的解决方案的最大数量。类型：整数有效范围：最小值为 1。最大值为 100。必需：否 ** [nextToken](#API_ListSolutions_RequestSyntax) ** 上次调用 `ListSolutions` 用于获取下一组解决方案（如果存在）时返回的令牌。类型：字符串长度限制：最大长度为 1500。模式：`\p{ASCII}{0,1500}` 必需：否 ## 响应语法 ``` { "nextToken": "string", "solutions": [ { "creationDateTime": number, "lastUpdatedDateTime": number, "name": "string", "recipeArn": "string", "solutionArn": "string", "status": "string" } ] } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [nextToken](#API_ListSolutions_ResponseSyntax) ** 用于获取下一组解决方案（如果存在）的令牌。类型：字符串长度限制：最大长度为 1500。模式：`\p{ASCII}{0,1500}` ** [solutions](#API_ListSolutions_ResponseSyntax) ** 当前解决方案的列表。类型：[SolutionSummary](API_SolutionSummary.md) 对象数组数组成员：最多 100 项。 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** InvalidNextTokenException ** 令牌无效。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 返回给定解决方案的解决方案版本列表。如果未指定解决方案，则会列出与账户关联的所有解决方案版本。响应中将提供每个解决方案版本的属性，包括 Amazon 资源名称 (ARN)。 ## 请求语法 ``` { "maxResults": number, "nextToken": "string", "solutionArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [maxResults](#API_ListSolutionVersions_RequestSyntax) ** 要返回的解决方案版本的最大数量。类型：整数有效范围：最小值为 1。最大值为 100。必需：否 ** [nextToken](#API_ListSolutionVersions_RequestSyntax) ** 上次调用 `ListSolutionVersions` 用于获取下一组解决方案版本（如果存在）时返回的令牌。类型：字符串长度限制：最大长度为 1500。模式：`\p{ASCII}{0,1500}` 必需：否 ** [solutionArn](#API_ListSolutionVersions_RequestSyntax) ** 解决方案的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ## 响应语法 ``` { "nextToken": "string", "solutionVersions": [ { "creationDateTime": number, "failureReason": "string", "lastUpdatedDateTime": number, "solutionVersionArn": "string", "status": "string", "trainingMode": "string", "trainingType": "string" } ] } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [nextToken](#API_ListSolutionVersions_ResponseSyntax) ** 用于获取下一组解决方案版本（如果存在）的令牌。类型：字符串长度限制：最大长度为 1500。模式：`\p{ASCII}{0,1500}` ** [solutionVersions](#API_ListSolutionVersions_ResponseSyntax) ** 描述版本属性的解决方案版本列表。类型：[SolutionVersionSummary](API_SolutionVersionSummary.md) 对象数组数组成员：最多 100 项。 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** InvalidNextTokenException ** 令牌无效。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 获取附加到资源的[标签](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)列表。 ## 请求语法 ``` { "resourceArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [resourceArn](#API_ListTagsForResource_RequestSyntax) ** 资源的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：是 ## 响应语法 ``` { "tags": [ { "tagKey": "string", "tagValue": "string" } ] } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [tags](#API_ListTagsForResource_ResponseSyntax) ** 资源标签。类型：[Tag](API_Tag.md) 对象数组数组成员：最少 0 个物品。最多 200 项。 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 启动处于 INACTIVE 状态的推荐器。启动推荐器不会创建任何新模型，但会恢复对推荐器的计费和自动再训练。 ## 请求语法 ``` { "recommenderArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [recommenderArn](#API_StartRecommender_RequestSyntax) ** 要启动的推荐器的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：是 ## 响应语法 ``` { "recommenderArn": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [recommenderArn](#API_StartRecommender_ResponseSyntax) ** 您启动的推荐器的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 停止处于 ACTIVE 状态的推荐器。停止推荐器会停止对推荐器的计费和自动再训练。 ## 请求语法 ``` { "recommenderArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [recommenderArn](#API_StopRecommender_RequestSyntax) ** 要停止的推荐器的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：是 ## 响应语法 ``` { "recommenderArn": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [recommenderArn](#API_StopRecommender_ResponseSyntax) ** 您停止的推荐器的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 停止创建处于 CREATE\$1PENDING 或 CREATE IN\$1PROGRESS 状态的解决方案版本。根据解决方案版本的当前状态，解决方案版本状态会发生如下变化： + CREATE\$1PENDING > CREATE\$1STOPPED 或者 + CREATE\$1IN\$1PROGRESS > CREATE\$1STOPPING > CREATE\$1STOPPED 在停止创建解决方案版本之前，您需要为所有已完成的训练付费。解决方案版本一旦停止，就无法继续创建。 ## 请求语法 ``` { "solutionVersionArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [solutionVersionArn](#API_StopSolutionVersionCreation_RequestSyntax) ** 要停止创建的解决方案版本的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 是否必需：是 ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 将标签列表添加到资源。 ## 请求语法 ``` { "resourceArn": "string", "tags": [ { "tagKey": "string", "tagValue": "string" } ] } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [resourceArn](#API_TagResource_RequestSyntax) ** 资源的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 是否必需：是 ** [tags](#API_TagResource_RequestSyntax) ** 要应用于资源的标签。有关更多信息，请参阅[标记 Amazon Personalize 资源](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)。类型：[Tag](API_Tag.md) 对象数组数组成员：最少 0 个物品。最多 200 项。是否必需：是 ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** LimitExceededException ** 超出每秒请求次数的限制。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ** TooManyTagsException ** 您已超出您可以应用到此资源的最大标签数量。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 删除附加到资源的指定标签。有关更多信息，请参阅[从 Amazon Personalize 资源删除标记](https://docs.aws.amazon.com/personalize/latest/dg/tags-remove.html)。 ## 请求语法 ``` { "resourceArn": "string", "tagKeys": [ "string" ] } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [resourceArn](#API_UntagResource_RequestSyntax) ** 资源的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 是否必需：是 ** [tagKeys](#API_UntagResource_RequestSyntax) ** 要删除的标签的键。类型：字符串数组数组成员：最少 0 个物品。最多 200 项。长度限制：最小长度为 1。最大长度为 128。模式：`^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$` 是否必需：是 ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ** TooManyTagKeysException ** 该请求包含的标签键多于可与资源关联的标签键（每个资源 50 个标签键）。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 更新市场活动，以使用现有市场活动部署再训练的解决方案版本，更改市场活动的 `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)。 ## 请求语法 ``` { "campaignArn": "string", "campaignConfig": { "enableMetadataWithRecommendations": boolean, "itemExplorationConfig": { "string" : "string" }, "rankingInfluence": { "string" : number }, "syncWithLatestSolutionVersion": boolean }, "minProvisionedTPS": number, "solutionVersionArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [campaignArn](#API_UpdateCampaign_RequestSyntax) ** 市场活动的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 是否必需：是 ** [campaignConfig](#API_UpdateCampaign_RequestSyntax) ** 市场活动的配置详情。类型：[CampaignConfig](API_CampaignConfig.md) 对象必需：否 ** [minProvisionedTPS](#API_UpdateCampaign_RequestSyntax) ** 指定 Amazon Personalize 将支持的请求的最低预调配每秒事务数（建议）。高 `minProvisionedTPS` 会增加您的账单费用。我们建议从 1 开始设置 `minProvisionedTPS`（默认值）。使用 Amazon CloudWatch 指标跟踪您的使用情况，并在必要`minProvisionedTPS`时增加使用量。类型：整数有效范围：最小值为 1。必需：否 ** [solutionVersionArn](#API_UpdateCampaign_RequestSyntax) ** 要部署的新模型的 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:.*:.*:.+` 必需：否 ## 响应语法 ``` { "campaignArn": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [campaignArn](#API_UpdateCampaign_ResponseSyntax) ** 与请求中提供的市场活动 ARN 相同。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 更新数据集，将其架构替换为新的或现有的架构。有关更多信息，请参阅[替换数据集的架构](https://docs.aws.amazon.com/personalize/latest/dg/updating-dataset-schema.html)。 ## 请求语法 ``` { "datasetArn": "string", "schemaArn": "string" } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [datasetArn](#API_UpdateDataset_RequestSyntax) ** 您要更新的数据集的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 是否必需：是 ** [schemaArn](#API_UpdateDataset_RequestSyntax) ** 您要使用的新架构的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：是 ## 响应语法 ``` { "datasetArn": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [datasetArn](#API_UpdateDataset_ResponseSyntax) ** 您更新的数据集的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 创建指标归因。 ## 请求语法 ``` { "addMetrics": [ { "eventType": "string", "expression": "string", "metricName": "string" } ], "metricAttributionArn": "string", "metricsOutputConfig": { "roleArn": "string", "s3DataDestination": { "kmsKeyArn": "string", "path": "string" } }, "removeMetrics": [ "string" ] } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [addMetrics](#API_UpdateMetricAttribution_RequestSyntax) ** 向指标归因添加新的指标属性。类型：[MetricAttribute](API_MetricAttribute.md) 对象数组数组成员：最多 10 项。必需：否 ** [metricAttributionArn](#API_UpdateMetricAttribution_RequestSyntax) ** 要更新的指标归因的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** [metricsOutputConfig](#API_UpdateMetricAttribution_RequestSyntax) ** 指标归因的输出配置。类型：[MetricAttributionOutput](API_MetricAttributionOutput.md) 对象必需：否 ** [removeMetrics](#API_UpdateMetricAttribution_RequestSyntax) ** 从指标归因中移除指标属性。类型：字符串数组数组成员：最多 10 项。长度约束：最大长度为 256。必需：否 ## 响应语法 ``` { "metricAttributionArn": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [metricAttributionArn](#API_UpdateMetricAttribution_ResponseSyntax) ** 已更新的指标归因的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceAlreadyExistsException ** 指定资源已经存在。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 更新推荐器以修改推荐器配置。如果您更新推荐器以修改训练中使用的列，则 Amazon Personalize 会自动开始对支持推荐器的模型进行全面的重新训练。更新完成后，您仍然可以从推荐器中获得建议。在更新完成之前，推荐器使用之前的配置。要跟踪此更新的状态，请使用 [DescribeRecommender](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html) 操作中返回的 `latestRecommenderUpdate`。 ## 请求语法 ``` { "recommenderArn": "string", "recommenderConfig": { "enableMetadataWithRecommendations": boolean, "itemExplorationConfig": { "string" : "string" }, "minRecommendationRequestsPerSecond": number, "trainingDataConfig": { "excludedDatasetColumns": { "string" : [ "string" ] }, "includedDatasetColumns": { "string" : [ "string" ] } } } } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [recommenderArn](#API_UpdateRecommender_RequestSyntax) ** 要修改的推荐器的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 是否必需：是 ** [recommenderConfig](#API_UpdateRecommender_RequestSyntax) ** 推荐器的配置详细信息。类型：[RecommenderConfig](API_RecommenderConfig.md) 对象是否必需：是 ## 响应语法 ``` { "recommenderArn": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [recommenderArn](#API_UpdateRecommender_ResponseSyntax) ** 与请求中提供的推荐器 Amazon 资源名称 (ARN) 相同。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 更新 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`。 ## 请求语法 ``` { "performAutoTraining": boolean, "performIncrementalUpdate": boolean, "solutionArn": "string", "solutionUpdateConfig": { "autoTrainingConfig": { "schedulingExpression": "string" }, "eventsConfig": { "eventParametersList": [ { "eventType": "string", "eventValueThreshold": number, "weight": number } ] } } } ``` ## 请求参数请求接受采用 JSON 格式的以下数据。 ** [performAutoTraining](#API_UpdateSolution_RequestSyntax) ** 解决方案是否使用自动训练来创建新的解决方案版本（经过训练的模型）。在解决方案配置过程中，您可以在 `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) ** 是否对模型执行增量训练更新。启用后，它允许模型更频繁地从新数据中学习，而无需进行全面的再训练，从而实现近乎实时的个性化。只有使用语义相似度配方的解决方案才支持此参数。类型：布尔值必需：否 ** [solutionArn](#API_UpdateSolution_RequestSyntax) ** 要更新的解决方案的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 是否必需：是 ** [solutionUpdateConfig](#API_UpdateSolution_RequestSyntax) ** 解决方案的新配置详细信息。类型：[SolutionUpdateConfig](API_SolutionUpdateConfig.md) 对象必需：否 ## 响应语法 ``` { "solutionArn": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [solutionArn](#API_UpdateSolution_ResponseSyntax) ** 与请求中提供的解决方案 Amazon 资源名称（ARN）相同。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** LimitExceededException ** 超出每秒请求次数的限制。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：400 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 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 记录操作交互事件数据。*操作交互*事件是用户和*操作*之间的交互。例如，用户执行一项操作，例如注册会员计划或下载您的应用。有关记录操作交互的更多信息，请参阅[记录操作交互事件](https://docs.aws.amazon.com/personalize/latest/dg/recording-action-interaction-events.html)。有关操作数据集中的操作的更多信息，请参阅[操作数据集](https://docs.aws.amazon.com/personalize/latest/dg/actions-datasets.html)。 ## 请求语法 ``` 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 请求参数该请求不使用任何 URI 参数。 ## 请求正文请求接受采用 JSON 格式的以下数据。 ** [actionInteractions](#API_UBS_PutActionInteractions_RequestSyntax) ** 会话中的操作交互事件列表。类型：[ActionInteraction](API_UBS_ActionInteraction.md) 对象数组数组成员：最少 1 个物品。最多 10 个物品。是否必需：是 ** [trackingId](#API_UBS_PutActionInteractions_RequestSyntax) ** 您的操作交互事件跟踪器的 ID。当您创建操作交互数据集时，Amazon Personalize 会为您创建一个操作交互事件跟踪器。有关更多信息，请参阅[操作交互事件跟踪器 ID](https://docs.aws.amazon.com/personalize/latest/dg/action-interaction-tracker-id.html)。类型：字符串长度限制：最小长度为 1。最大长度为 256。是否必需：是 ## 响应语法 ``` HTTP/1.1 200 ``` ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：409 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：404 ## 另请参阅有关以特定语言之一使用此 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 将一个或多个操作添加到操作数据集。有关更多信息，请参阅[单独导入操作](https://docs.aws.amazon.com/personalize/latest/dg/importing-actions.html)。 ## 请求语法 ``` POST /actions HTTP/1.1 Content-type: application/json { "actions": [ { "actionId": "string", "properties": "string" } ], "datasetArn": "string" } ``` ## URI 请求参数该请求不使用任何 URI 参数。 ## 请求正文请求接受采用 JSON 格式的以下数据。 ** [actions](#API_UBS_PutActions_RequestSyntax) ** 操作数据的列表。类型：[Action](API_UBS_Action.md) 对象数组数组成员：最少 1 个物品。最多 10 个物品。是否必需：是 ** [datasetArn](#API_UBS_PutActions_RequestSyntax) ** 要向其中添加一个或多个操作的操作数据集的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：是 ## 响应语法 ``` HTTP/1.1 200 ``` ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：409 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：404 ## 另请参阅有关以特定语言之一使用此 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 记录物品交互事件数据。有关更多信息，请参阅[记录物品交互事件](https://docs.aws.amazon.com/personalize/latest/dg/recording-item-interaction-events.html)。 **注意** 如果您使用 AWS Lambda 函数调用该 PutEvents 操作，则您的函数的执行角色必须具有在`Resource`元素`*`中使用通配符执行`personalize:PutEvents`操作的权限。 ## 请求语法 ``` 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 请求参数该请求不使用任何 URI 参数。 ## 请求正文请求接受采用 JSON 格式的以下数据。 ** [eventList](#API_UBS_PutEvents_RequestSyntax) ** 会话中的事件数据列表。类型：[Event](API_UBS_Event.md) 对象数组数组成员：最少 1 个物品。最多 10 个物品。是否必需：是 ** [sessionId](#API_UBS_PutEvents_RequestSyntax) ** 与用户访问关联的会话 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) ** 事件的跟踪 ID。该 ID 是通过调用 [CreateEventTracker](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html)API 生成的。类型：字符串长度限制：最小长度为 1。最大长度为 256。是否必需：是 ** [userId](#API_UBS_PutEvents_RequestSyntax) ** 与事件关联的用户。类型：字符串长度限制：最小长度为 1。最大长度为 256。必需：否 ## 响应语法 ``` HTTP/1.1 200 ``` ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 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 向物品数据集添加一个或多个物品。有关更多信息，请参阅[单独导入物品](https://docs.aws.amazon.com/personalize/latest/dg/importing-items.html)。 ## 请求语法 ``` POST /items HTTP/1.1 Content-type: application/json { "datasetArn": "string", "items": [ { "itemId": "string", "properties": "string" } ] } ``` ## URI 请求参数该请求不使用任何 URI 参数。 ## 请求正文请求接受采用 JSON 格式的以下数据。 ** [datasetArn](#API_UBS_PutItems_RequestSyntax) ** 您要添加一个或多个物品的物品数据集的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 是否必需：是 ** [items](#API_UBS_PutItems_RequestSyntax) ** 物品数据列表。类型：[Item](API_UBS_Item.md) 对象数组数组成员：最少 1 个物品。最多 10 个物品。是否必需：是 ## 响应语法 ``` HTTP/1.1 200 ``` ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：409 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：404 ## 另请参阅有关以特定语言之一使用此 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 向用户数据集中添加一个或多个用户。有关更多信息，请参阅[单独导入用户](https://docs.aws.amazon.com/personalize/latest/dg/importing-users.html)。 ## 请求语法 ``` POST /users HTTP/1.1 Content-type: application/json { "datasetArn": "string", "users": [ { "properties": "string", "userId": "string" } ] } ``` ## URI 请求参数该请求不使用任何 URI 参数。 ## 请求正文请求接受采用 JSON 格式的以下数据。 ** [datasetArn](#API_UBS_PutUsers_RequestSyntax) ** 您要添加一个或多个用户的用户数据集的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 是否必需：是 ** [users](#API_UBS_PutUsers_RequestSyntax) ** 用户数据列表。类型：[User](API_UBS_User.md) 对象数组数组成员：最少 1 个物品。最多 10 个物品。是否必需：是 ## 响应语法 ``` HTTP/1.1 200 ``` ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceInUseException ** 指定的资源正在使用中。 HTTP 状态代码：409 ** ResourceNotFoundException ** 找不到指定的资源。 HTTP 状态代码：404 ## 另请参阅有关以特定语言之一使用此 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 Amazon Personalize Runtime 支持以下操作： + [GetActionRecommendations](API_RS_GetActionRecommendations.md) + [GetPersonalizedRanking](API_RS_GetPersonalizedRanking.md) + [GetRecommendations](API_RS_GetRecommendations.md) # GetActionRecommendations 返回按预测分数以降序排列的建议操作列表。如果您的自定义市场活动部署了使用 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)。 ## 请求语法 ``` POST /action-recommendations HTTP/1.1 Content-type: application/json { "campaignArn": "string", "filterArn": "string", "filterValues": { "string" : "string" }, "numResults": number, "userId": "string" } ``` ## URI 请求参数该请求不使用任何 URI 参数。 ## 请求正文请求接受采用 JSON 格式的以下数据。 ** [campaignArn](#API_RS_GetActionRecommendations_RequestSyntax) ** 用于获取操作建议的市场活动的 Amazon 资源名称 (ARN)。此市场活动必须部署使用 PERSONALIZED\$1ACTIONS 配方训练的解决方案版本。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** [filterArn](#API_RS_GetActionRecommendations_RequestSyntax) ** 要应用于返回建议的筛选器的 ARN。有关更多信息，请参阅[筛选建议](https://docs.aws.amazon.com/personalize/latest/dg/filter.html)。使用此参数时，确保筛选器资源为 `ACTIVE`。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** [filterValues](#API_RS_GetActionRecommendations_RequestSyntax) ** 筛选建议时要使用的值。对于筛选器表达式中的每个占位符参数，提供参数名称（大小写相符）作为键，提供筛选器值作为对应的值。用英文逗号分隔一个参数的多个值。对于使用 `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) ** 要返回的结果数量。默认值为 5。最大值为 100。类型：整数有效范围：最小值为 0。必需：否 ** [userId](#API_RS_GetActionRecommendations_RequestSyntax) ** 要为其提供操作建议的用户的用户 ID。类型：字符串长度约束：最大长度为 256。必需：否 ## 响应语法 ``` HTTP/1.1 200 Content-type: application/json { "actionList": [ { "actionId": "string", "score": number } ], "recommendationId": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [actionList](#API_RS_GetActionRecommendations_ResponseSyntax) ** 按预测分数降序排序的操作建议列表。列表中最多可以有 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) ** 建议的 ID。类型：字符串 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceNotFoundException ** 指定的资源不存在。 HTTP 状态代码：404 ## 另请参阅有关以特定语言之一使用此 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 对给定用户的推荐物品列表重新排名。将列表中的第一个物品视为用户最可能感兴趣的物品。 **注意** 必须已使用 PERSONALIZED\$1RANKING 类型的配方创建支持市场活动的解决方案。 ## 请求语法 ``` 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 请求参数该请求不使用任何 URI 参数。 ## 请求正文请求接受采用 JSON 格式的以下数据。 ** [campaignArn](#API_RS_GetPersonalizedRanking_RequestSyntax) ** 用于生成个性化排名的市场活动的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 是否必需：是 ** [context](#API_RS_GetPersonalizedRanking_RequestSyntax) ** 获取建议时要使用的上下文元数据。上下文元数据包括在获取用户建议时可能相关的任何交互信息，例如用户的当前位置或设备类型。类型：字符串到字符串映射映射条目：最多 150 项。键长度限制：最大长度为 150。键模式：`[A-Za-z\d_]+` 值长度限制：最大长度为 1000。必需：否 ** [filterArn](#API_RS_GetPersonalizedRanking_RequestSyntax) ** 您创建的用于在给定用户建议中包含物品或将物品排除在此类建议之外的筛选器的 Amazon 资源名称 (ARN)。有关更多信息，请参阅[筛选建议](https://docs.aws.amazon.com/personalize/latest/dg/filter.html)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** [filterValues](#API_RS_GetPersonalizedRanking_RequestSyntax) ** 筛选建议时要使用的值。对于筛选器表达式中的每个占位符参数，提供参数名称（大小写相符）作为键，提供筛选器值作为对应的值。用英文逗号分隔一个参数的多个值。对于使用 `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) ** 要排名的物品（按 `itemId` 排名）列表。如果某个物品未包含在训练数据集中，则会将该物品附加到重新排名的列表末尾。如果您在建议中包含元数据，则最大值为 50。否则，最大值为 500。类型：字符串数组长度约束：最大长度为 256。是否必需：是 ** [metadataColumns](#API_RS_GetPersonalizedRanking_RequestSyntax) ** 如果您在创建或更新市场活动时在建议中启用了元数据，请从您的物品数据集中指定要包含在个性化排名中的元数据列。映射键为 `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) ** 您希望市场活动提供个性化排名的用户。类型：字符串长度约束：最大长度为 256。是否必需：是 ## 响应语法 ``` HTTP/1.1 200 Content-type: application/json { "personalizedRanking": [ { "itemId": "string", "metadata": { "string" : "string" }, "promotionName": "string", "reason": [ "string" ], "score": number } ], "recommendationId": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [personalizedRanking](#API_RS_GetPersonalizedRanking_ResponseSyntax) ** 按用户最可能感兴趣的顺序排列的物品列表。最大值为 500。类型：[PredictedItem](API_RS_PredictedItem.md) 对象数组 ** [recommendationId](#API_RS_GetPersonalizedRanking_ResponseSyntax) ** 建议的 ID。类型：字符串 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceNotFoundException ** 指定的资源不存在。 HTTP 状态代码：404 ## 另请参阅有关以特定语言之一使用此 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 返回推荐物品的列表。对于市场活动，必须提供市场活动的 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)。 ## 请求语法 ``` 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 请求参数该请求不使用任何 URI 参数。 ## 请求正文请求接受采用 JSON 格式的以下数据。 ** [campaignArn](#API_RS_GetRecommendations_RequestSyntax) ** 用于获取建议的市场活动的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** [context](#API_RS_GetRecommendations_RequestSyntax) ** 获取建议时要使用的上下文元数据。上下文元数据包括在获取用户建议时可能相关的任何交互信息，例如用户的当前位置或设备类型。类型：字符串到字符串映射映射条目：最多 150 项。键长度限制：最大长度为 150。键模式：`[A-Za-z\d_]+` 值长度限制：最大长度为 1000。必需：否 ** [filterArn](#API_RS_GetRecommendations_RequestSyntax) ** 要应用于返回建议的筛选器的 ARN。有关更多信息，请参阅[筛选建议](https://docs.aws.amazon.com/personalize/latest/dg/filter.html)。使用此参数时，确保筛选器资源为 `ACTIVE`。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** [filterValues](#API_RS_GetRecommendations_RequestSyntax) ** 筛选建议时要使用的值。对于筛选器表达式中的每个占位符参数，提供参数名称（大小写相符）作为键，提供筛选器值作为对应的值。用英文逗号分隔一个参数的多个值。对于使用 `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) ** 要提供建议的物品 ID。 `RELATED_ITEMS` 食谱类型为必填项。类型：字符串长度约束：最大长度为 256。必需：否 ** [metadataColumns](#API_RS_GetRecommendations_RequestSyntax) ** 如果您在创建或更新市场活动或推荐器时在建议中启用了元数据，请从您的物品数据集中指定要包含在物品建议中的元数据列。映射键为 `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) ** 要返回的结果数量。默认值为 25。如果您在建议中包含元数据，则最大值为 50。否则，最大值为 500。类型：整数有效范围：最小值为 0。必需：否 ** [promotions](#API_RS_GetRecommendations_RequestSyntax) ** 要应用于建议请求的推广。推广定义了其他业务规则，这些规则适用于可配置的建议物品子集。类型：[Promotion](API_RS_Promotion.md) 对象数组数组成员：最多 1 个物品。必需：否 ** [recommenderArn](#API_RS_GetRecommendations_RequestSyntax) ** 用于获取建议的推荐器的 Amazon 资源名称 (ARN)。如果您创建了包含域使用案例推荐器的域数据集组，请提供推荐器 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** [userId](#API_RS_GetRecommendations_RequestSyntax) ** 要提供建议的用户 ID。 `USER_PERSONALIZATION` 食谱类型为必填项。类型：字符串长度约束：最大长度为 256。必需：否 ## 响应语法 ``` HTTP/1.1 200 Content-type: application/json { "itemList": [ { "itemId": "string", "metadata": { "string" : "string" }, "promotionName": "string", "reason": [ "string" ], "score": number } ], "recommendationId": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [itemList](#API_RS_GetRecommendations_ResponseSyntax) ** 按预测分数降序排序的建议列表。列表中最多可以有 500 个物品。类型：[PredictedItem](API_RS_PredictedItem.md) 对象数组 ** [recommendationId](#API_RS_GetRecommendations_ResponseSyntax) ** 建议的 ID。类型：字符串 ## 错误 ** InvalidInputException ** 为字段或参数提供有效值。 HTTP 状态代码：400 ** ResourceNotFoundException ** 指定的资源不存在。 HTTP 状态代码：404 ## 另请参阅有关以特定语言之一使用此 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) # 数据类型 Amazon Personalize 支持以下数据类型： + [Algorithm](API_Algorithm.md) + [AlgorithmImage](API_AlgorithmImage.md) + [AutoMLConfig](API_AutoMLConfig.md) + [AutoMLResult](API_AutoMLResult.md) + [AutoTrainingConfig](API_AutoTrainingConfig.md) + [BatchInferenceJob](API_BatchInferenceJob.md) + [BatchInferenceJobConfig](API_BatchInferenceJobConfig.md) + [BatchInferenceJobInput](API_BatchInferenceJobInput.md) + [BatchInferenceJobOutput](API_BatchInferenceJobOutput.md) + [BatchInferenceJobSummary](API_BatchInferenceJobSummary.md) + [BatchSegmentJob](API_BatchSegmentJob.md) + [BatchSegmentJobInput](API_BatchSegmentJobInput.md) + [BatchSegmentJobOutput](API_BatchSegmentJobOutput.md) + [BatchSegmentJobSummary](API_BatchSegmentJobSummary.md) + [Campaign](API_Campaign.md) + [CampaignConfig](API_CampaignConfig.md) + [CampaignSummary](API_CampaignSummary.md) + [CampaignUpdateSummary](API_CampaignUpdateSummary.md) + [CategoricalHyperParameterRange](API_CategoricalHyperParameterRange.md) + [ContinuousHyperParameterRange](API_ContinuousHyperParameterRange.md) + [DataDeletionJob](API_DataDeletionJob.md) + [DataDeletionJobSummary](API_DataDeletionJobSummary.md) + [Dataset](API_Dataset.md) + [DatasetExportJob](API_DatasetExportJob.md) + [DatasetExportJobOutput](API_DatasetExportJobOutput.md) + [DatasetExportJobSummary](API_DatasetExportJobSummary.md) + [DatasetGroup](API_DatasetGroup.md) + [DatasetGroupSummary](API_DatasetGroupSummary.md) + [DatasetImportJob](API_DatasetImportJob.md) + [DatasetImportJobSummary](API_DatasetImportJobSummary.md) + [DatasetSchema](API_DatasetSchema.md) + [DatasetSchemaSummary](API_DatasetSchemaSummary.md) + [DatasetSummary](API_DatasetSummary.md) + [DatasetUpdateSummary](API_DatasetUpdateSummary.md) + [DataSource](API_DataSource.md) + [DefaultCategoricalHyperParameterRange](API_DefaultCategoricalHyperParameterRange.md) + [DefaultContinuousHyperParameterRange](API_DefaultContinuousHyperParameterRange.md) + [DefaultHyperParameterRanges](API_DefaultHyperParameterRanges.md) + [DefaultIntegerHyperParameterRange](API_DefaultIntegerHyperParameterRange.md) + [EventParameters](API_EventParameters.md) + [EventsConfig](API_EventsConfig.md) + [EventTracker](API_EventTracker.md) + [EventTrackerSummary](API_EventTrackerSummary.md) + [FeatureTransformation](API_FeatureTransformation.md) + [FieldsForThemeGeneration](API_FieldsForThemeGeneration.md) + [Filter](API_Filter.md) + [FilterSummary](API_FilterSummary.md) + [HPOConfig](API_HPOConfig.md) + [HPOObjective](API_HPOObjective.md) + [HPOResourceConfig](API_HPOResourceConfig.md) + [HyperParameterRanges](API_HyperParameterRanges.md) + [IntegerHyperParameterRange](API_IntegerHyperParameterRange.md) + [MetricAttribute](API_MetricAttribute.md) + [MetricAttribution](API_MetricAttribution.md) + [MetricAttributionOutput](API_MetricAttributionOutput.md) + [MetricAttributionSummary](API_MetricAttributionSummary.md) + [OptimizationObjective](API_OptimizationObjective.md) + [Recipe](API_Recipe.md) + [RecipeSummary](API_RecipeSummary.md) + [Recommender](API_Recommender.md) + [RecommenderConfig](API_RecommenderConfig.md) + [RecommenderSummary](API_RecommenderSummary.md) + [RecommenderUpdateSummary](API_RecommenderUpdateSummary.md) + [S3DataConfig](API_S3DataConfig.md) + [Solution](API_Solution.md) + [SolutionConfig](API_SolutionConfig.md) + [SolutionSummary](API_SolutionSummary.md) + [SolutionUpdateConfig](API_SolutionUpdateConfig.md) + [SolutionUpdateSummary](API_SolutionUpdateSummary.md) + [SolutionVersion](API_SolutionVersion.md) + [SolutionVersionSummary](API_SolutionVersionSummary.md) + [Tag](API_Tag.md) + [ThemeGenerationConfig](API_ThemeGenerationConfig.md) + [TrainingDataConfig](API_TrainingDataConfig.md) + [TunedHPOParams](API_TunedHPOParams.md) Amazon Personalize Events 支持以下数据类型： + [Action](API_UBS_Action.md) + [ActionInteraction](API_UBS_ActionInteraction.md) + [Event](API_UBS_Event.md) + [Item](API_UBS_Item.md) + [MetricAttribution](API_UBS_MetricAttribution.md) + [User](API_UBS_User.md) Amazon Personalize Runtime 支持以下数据类型： + [PredictedAction](API_RS_PredictedAction.md) + [PredictedItem](API_RS_PredictedItem.md) + [Promotion](API_RS_Promotion.md) # Amazon Personalize Amazon Personalize 支持以下数据类型： + [Algorithm](API_Algorithm.md) + [AlgorithmImage](API_AlgorithmImage.md) + [AutoMLConfig](API_AutoMLConfig.md) + [AutoMLResult](API_AutoMLResult.md) + [AutoTrainingConfig](API_AutoTrainingConfig.md) + [BatchInferenceJob](API_BatchInferenceJob.md) + [BatchInferenceJobConfig](API_BatchInferenceJobConfig.md) + [BatchInferenceJobInput](API_BatchInferenceJobInput.md) + [BatchInferenceJobOutput](API_BatchInferenceJobOutput.md) + [BatchInferenceJobSummary](API_BatchInferenceJobSummary.md) + [BatchSegmentJob](API_BatchSegmentJob.md) + [BatchSegmentJobInput](API_BatchSegmentJobInput.md) + [BatchSegmentJobOutput](API_BatchSegmentJobOutput.md) + [BatchSegmentJobSummary](API_BatchSegmentJobSummary.md) + [Campaign](API_Campaign.md) + [CampaignConfig](API_CampaignConfig.md) + [CampaignSummary](API_CampaignSummary.md) + [CampaignUpdateSummary](API_CampaignUpdateSummary.md) + [CategoricalHyperParameterRange](API_CategoricalHyperParameterRange.md) + [ContinuousHyperParameterRange](API_ContinuousHyperParameterRange.md) + [DataDeletionJob](API_DataDeletionJob.md) + [DataDeletionJobSummary](API_DataDeletionJobSummary.md) + [Dataset](API_Dataset.md) + [DatasetExportJob](API_DatasetExportJob.md) + [DatasetExportJobOutput](API_DatasetExportJobOutput.md) + [DatasetExportJobSummary](API_DatasetExportJobSummary.md) + [DatasetGroup](API_DatasetGroup.md) + [DatasetGroupSummary](API_DatasetGroupSummary.md) + [DatasetImportJob](API_DatasetImportJob.md) + [DatasetImportJobSummary](API_DatasetImportJobSummary.md) + [DatasetSchema](API_DatasetSchema.md) + [DatasetSchemaSummary](API_DatasetSchemaSummary.md) + [DatasetSummary](API_DatasetSummary.md) + [DatasetUpdateSummary](API_DatasetUpdateSummary.md) + [DataSource](API_DataSource.md) + [DefaultCategoricalHyperParameterRange](API_DefaultCategoricalHyperParameterRange.md) + [DefaultContinuousHyperParameterRange](API_DefaultContinuousHyperParameterRange.md) + [DefaultHyperParameterRanges](API_DefaultHyperParameterRanges.md) + [DefaultIntegerHyperParameterRange](API_DefaultIntegerHyperParameterRange.md) + [EventParameters](API_EventParameters.md) + [EventsConfig](API_EventsConfig.md) + [EventTracker](API_EventTracker.md) + [EventTrackerSummary](API_EventTrackerSummary.md) + [FeatureTransformation](API_FeatureTransformation.md) + [FieldsForThemeGeneration](API_FieldsForThemeGeneration.md) + [Filter](API_Filter.md) + [FilterSummary](API_FilterSummary.md) + [HPOConfig](API_HPOConfig.md) + [HPOObjective](API_HPOObjective.md) + [HPOResourceConfig](API_HPOResourceConfig.md) + [HyperParameterRanges](API_HyperParameterRanges.md) + [IntegerHyperParameterRange](API_IntegerHyperParameterRange.md) + [MetricAttribute](API_MetricAttribute.md) + [MetricAttribution](API_MetricAttribution.md) + [MetricAttributionOutput](API_MetricAttributionOutput.md) + [MetricAttributionSummary](API_MetricAttributionSummary.md) + [OptimizationObjective](API_OptimizationObjective.md) + [Recipe](API_Recipe.md) + [RecipeSummary](API_RecipeSummary.md) + [Recommender](API_Recommender.md) + [RecommenderConfig](API_RecommenderConfig.md) + [RecommenderSummary](API_RecommenderSummary.md) + [RecommenderUpdateSummary](API_RecommenderUpdateSummary.md) + [S3DataConfig](API_S3DataConfig.md) + [Solution](API_Solution.md) + [SolutionConfig](API_SolutionConfig.md) + [SolutionSummary](API_SolutionSummary.md) + [SolutionUpdateConfig](API_SolutionUpdateConfig.md) + [SolutionUpdateSummary](API_SolutionUpdateSummary.md) + [SolutionVersion](API_SolutionVersion.md) + [SolutionVersionSummary](API_SolutionVersionSummary.md) + [Tag](API_Tag.md) + [ThemeGenerationConfig](API_ThemeGenerationConfig.md) + [TrainingDataConfig](API_TrainingDataConfig.md) + [TunedHPOParams](API_TunedHPOParams.md) # Algorithm 描述自定义算法。 ## 目录 ** algorithmArn ** 算法的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** algorithmImage ** 算法映像的 Docker 容器的 URI。类型：[AlgorithmImage](API_AlgorithmImage.md) 对象必需：否 ** creationDateTime ** 算法的创建日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** defaultHyperParameterRanges ** 指定默认超参数、其范围及其是否可调。可以在超参数优化 (HPO) 期间确定可调超参数的值。类型：[DefaultHyperParameterRanges](API_DefaultHyperParameterRanges.md) 对象必需：否 ** defaultHyperParameters ** 指定默认超参数。类型：字符串到字符串映射映射条目：最多 100 项。键长度限制：最大长度为 256。值长度限制：最大长度为 1000。必需：否 ** defaultResourceConfig ** 指定默认最大训练作业数和并行训练作业数。类型：字符串到字符串映射映射条目：最多 100 项。键长度限制：最大长度为 256。值长度限制：最大长度为 1000。必需：否 ** lastUpdatedDateTime ** 上次更新算法的日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** name ** 算法的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必需：否 ** roleArn ** 角色的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** trainingInputMode ** 训练输入模式。类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Algorithm) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/Algorithm) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/Algorithm) # AlgorithmImage 描述算法映像。 ## 目录 ** dockerURI ** 算法映像的 Docker 容器的 URI。类型：字符串长度约束：最大长度为 256。必需：是 ** name ** 算法映像的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/AlgorithmImage) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/AlgorithmImage) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/AlgorithmImage) # AutoMLConfig 当解决方案执行 AutoML（[CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) 中 `performAutoML` 为 ture）时，Amazon Personalize 会从指定列表中确定哪个食谱对给定指标进行优化。然后，Amazon Personalize 将该食谱用于解决方案。 ## 目录 ** metricName ** 要优化的指标。类型：字符串长度约束：最大长度为 256。必需：否 ** recipeList ** 候选食谱列表。类型：字符串数组数组成员：最多 100 项。长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/AutoMLConfig) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/AutoMLConfig) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/AutoMLConfig) # AutoMLResult 当解决方案执行 AutoML（`performAutoML` 在 [CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) 中为 true）时，指定最能优化指定指标的食谱。 ## 目录 ** bestRecipeArn ** 最佳食谱的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/AutoMLResult) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/AutoMLResult) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/AutoMLResult) # AutoTrainingConfig 当 `performAutoTraining` 为 true 时要使用的自动训练配置。 ## 目录 ** schedulingExpression ** 指定自动训练新解决方案版本的频率。以 rate(*value* *unit*) 格式指定 rate 表达式。对于值，指定一个介于 1 和 30 之间的数字。对于单位，指定 `day` 或 `days`。例如，要每 5 天自动创建一个新的解决方案版本，请指定 `rate(5 days)`。默认为每 7 天进行一次训练。有关自动训练的更多信息，请参阅[创建和配置解决方案](https://docs.aws.amazon.com/personalize/latest/dg/customizing-solution-config.html)。类型：字符串长度限制：长度下限为 1。最大长度为 16。模式：`rate$\d+ days?$` 必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/AutoTrainingConfig) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/AutoTrainingConfig) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/AutoTrainingConfig) # BatchInferenceJob 包含批量推理作业的相关信息。 ## 目录 ** batchInferenceJobArn ** 批量推理作业的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** batchInferenceJobConfig ** 批量推理作业的配置详细信息的字符串到字符串映射。类型：[BatchInferenceJobConfig](API_BatchInferenceJobConfig.md) 对象必需：否 ** batchInferenceJobMode ** 作业的模式。类型：字符串有效值：`BATCH_INFERENCE | THEME_GENERATION` 必需：否 ** creationDateTime ** 创建批量推理作业的时间。类型：时间戳必需：否 ** failureReason ** 如果批量推理作业失败，则为其原因。类型：字符串必需：否 ** filterArn ** 批量推理作业中使用的筛选器的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** jobInput ** 指向用于生成批量推理作业的输入数据的 Amazon S3 路径。类型：[BatchInferenceJobInput](API_BatchInferenceJobInput.md) 对象必需：否 ** jobName ** 批量推理作业的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必需：否 ** jobOutput ** 包含批量推理作业生成的输出数据的 Amazon S3 存储桶。类型：[BatchInferenceJobOutput](API_BatchInferenceJobOutput.md) 对象必需：否 ** lastUpdatedDateTime ** 上次更新批量推理作业的时间。类型：时间戳必需：否 ** numResults ** 批量推理作业生成的建议数量。此数字包括为失败的输入记录生成的错误消息数。类型：整数必需：否 ** roleArn ** 请求批量推理作业的 Amazon Identity and Access Management (IAM) 角色的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` 必需：否 ** solutionVersionArn ** 创建批量推理作业所依据的解决方案版本的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** status ** 批量推理作业的状态。状态是以下值之一： + PENDING + IN PROGRESS + ACTIVE + CREATE FAILED 类型：字符串长度约束：最大长度为 256。必需：否 ** themeGenerationConfig ** 作业的主题生成设置。类型：[ThemeGenerationConfig](API_ThemeGenerationConfig.md) 对象必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchInferenceJob) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchInferenceJob) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchInferenceJob) # BatchInferenceJobConfig 批量推理作业的配置详情。 ## 内容 ** itemExplorationConfig ** 指定浏览配置超参数的字符串到字符串映射，包括 `explorationWeight` 和 `explorationItemAgeCutOff`，您希望用它来配置 Amazon Personalize 在推荐物品时使用的物品浏览量。请参见 [User-Personalization](https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html)。类型：字符串到字符串映射映射条目：最多 100 项。键长度限制：最大长度为 256。值长度限制：最大长度为 1000。必需：否 ** rankingInfluence ** 排名地图影响受欢迎程度和新鲜度值。对于每个关键字，指定一个介于 0.0 和 1.0 之间的数值，该数值确定该排名因子对最终推荐的影响程度。值接近 1.0 会使因子得到更大的权重，而接近 0.0 的值会降低其影响。如果未指定，则两者都默认为 0.0。类型：字符串到双映射有效密钥：`POPULARITY | FRESHNESS` 有效范围：最小值为 0。最大值为 1。必需：否 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWSSDKs，请参阅以下内容： + [AWS适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchInferenceJobConfig) + [AWS适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchInferenceJobConfig) + [AWS适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchInferenceJobConfig) # BatchInferenceJobInput 批量推理作业的输入配置。 ## 目录 ** s3DataSource ** 包含输入数据的 Amazon S3 位置的 URI。Amazon S3 存储桶必须与您要调用的 API 端点位于同一区域。类型：[S3DataConfig](API_S3DataConfig.md) 对象必需：是 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchInferenceJobInput) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchInferenceJobInput) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchInferenceJobInput) # BatchInferenceJobOutput 批量推理作业的输出配置参数。 ## 目录 ** s3DataDestination ** 存储批量推理作业输出的 Amazon S3 存储桶的相关信息。类型：[S3DataConfig](API_S3DataConfig.md) 对象必需：是 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchInferenceJobOutput) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchInferenceJobOutput) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchInferenceJobOutput) # BatchInferenceJobSummary [BatchInferenceJob](https://docs.aws.amazon.com/personalize/latest/dg/API_BatchInferenceJob.html) 的截断版本。[ListBatchInferenceJobs](https://docs.aws.amazon.com/personalize/latest/dg/API_ListBatchInferenceJobs.html) 操作返回批量推理作业摘要列表。 ## 目录 ** batchInferenceJobArn ** 批量推理作业的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** batchInferenceJobMode ** 作业的模式。类型：字符串有效值：`BATCH_INFERENCE | THEME_GENERATION` 必需：否 ** creationDateTime ** 创建批量推理作业的时间。类型：时间戳必需：否 ** failureReason ** 如果批量推理作业失败，则为其原因。类型：字符串必需：否 ** jobName ** 批量推理作业的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必需：否 ** lastUpdatedDateTime ** 上次更新批量推理作业的时间。类型：时间戳必需：否 ** solutionVersionArn ** 批量推理作业使用的解决方案版本的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** status ** 批量推理作业的状态。状态是以下值之一： + PENDING + IN PROGRESS + ACTIVE + CREATE FAILED 类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchInferenceJobSummary) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchInferenceJobSummary) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchInferenceJobSummary) # BatchSegmentJob 包含批量细分作业的相关信息。 ## 目录 ** batchSegmentJobArn ** 批量细分作业的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** creationDateTime ** 创建批量细分作业的时间。类型：时间戳必需：否 ** failureReason ** 如果批量细分作业失败，则为其原因。类型：字符串必需：否 ** filterArn ** 批量细分作业中使用的筛选器的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** jobInput ** 指向用于生成批量细分作业的输入数据的 Amazon S3 路径。类型：[BatchSegmentJobInput](API_BatchSegmentJobInput.md) 对象必需：否 ** jobName ** 批量细分作业的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必需：否 ** jobOutput ** 包含批量细分作业生成的输出数据的 Amazon S3 存储桶。类型：[BatchSegmentJobOutput](API_BatchSegmentJobOutput.md) 对象必需：否 ** lastUpdatedDateTime ** 上次更新批量细分作业的时间。类型：时间戳必需：否 ** numResults ** 批量细分作业为每行输入数据生成的预测用户数。每个细分的最大用户数为 500 万。类型：整数必需：否 ** roleArn ** 请求批量细分作业的 Amazon Identity and Access Management (IAM) 角色的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` 必需：否 ** solutionVersionArn ** 批量细分作业用于生成批量细分的解决方案版本的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** status ** 批量细分作业的状态。状态是以下值之一： + PENDING + IN PROGRESS + ACTIVE + CREATE FAILED 类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchSegmentJob) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchSegmentJob) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchSegmentJob) # BatchSegmentJobInput 批量细分作业的输入配置。 ## 目录 ** s3DataSource ** Amazon S3 输入或输出存储桶的配置详细信息。类型：[S3DataConfig](API_S3DataConfig.md) 对象必需：是 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchSegmentJobInput) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchSegmentJobInput) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchSegmentJobInput) # BatchSegmentJobOutput 批量细分作业的输出配置参数。 ## 目录 ** s3DataDestination ** Amazon S3 输入或输出存储桶的配置详细信息。类型：[S3DataConfig](API_S3DataConfig.md) 对象必需：是 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchSegmentJobOutput) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchSegmentJobOutput) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchSegmentJobOutput) # BatchSegmentJobSummary [BatchSegmentJob](https://docs.aws.amazon.com/personalize/latest/dg/API_BatchSegmentJob.html) 数据类型的截断版本。[ListBatchSegmentJobs](https://docs.aws.amazon.com/personalize/latest/dg/API_ListBatchSegmentJobs.html) 操作返回批量细分作业摘要列表。 ## 目录 ** batchSegmentJobArn ** 批量细分作业的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** creationDateTime ** 创建批量细分作业的时间。类型：时间戳必需：否 ** failureReason ** 如果批量细分作业失败，则为其原因。类型：字符串必需：否 ** jobName ** 批量细分作业的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必需：否 ** lastUpdatedDateTime ** 上次更新批量细分作业的时间。类型：时间戳必需：否 ** solutionVersionArn ** 批量细分作业用于生成批量细分的解决方案版本的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** status ** 批量细分作业的状态。状态是以下值之一： + PENDING + IN PROGRESS + ACTIVE + CREATE FAILED 类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchSegmentJobSummary) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchSegmentJobSummary) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchSegmentJobSummary) # Campaign 描述解决方案版本部署的对象。有关市场活动的更多信息，请参阅 [CreateCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html)。 ## 目录 ** campaignArn ** 市场活动的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** campaignConfig ** 市场活动的配置详情。类型：[CampaignConfig](API_CampaignConfig.md) 对象必需：否 ** creationDateTime ** 市场活动创建的日期和时间（采用 Unix 格式）。类型：时间戳必需：否 ** failureReason ** 市场活动失败背后的原因。类型：字符串必需：否 ** lastUpdatedDateTime ** 上次市场活动的更新日期和时间（采用 Unix 格式）。类型：时间戳必需：否 ** latestCampaignUpdate ** 提供市场活动更新的属性摘要。如需完整列表，请调用 [DescribeCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html) API。仅当市场活动至少接到一个 `latestCampaignUpdate` 电话时，才会返回 `UpdateCampaign` 字段。类型：[CampaignUpdateSummary](API_CampaignUpdateSummary.md) 对象必需：否 ** minProvisionedTPS ** 指定请求的最低预调配每秒事务量（建议）。高 `minProvisionedTPS` 会增加您的账单费用。我们建议从 1 开始设置 `minProvisionedTPS`（默认值）。使用 Amazon CloudWatch 指标跟踪您的使用情况，并在必要时增加 `minProvisionedTPS`。类型：整数有效范围：最小值为 1。必需：否 ** name ** 活动的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必需：否 ** solutionVersionArn ** 市场活动使用的解决方案版本的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** status ** 市场活动的状态。市场活动可处于以下几种状态之一： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE - 或 - CREATE FAILED + DELETE PENDING > DELETE IN\$1PROGRESS 类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Campaign) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/Campaign) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/Campaign) # CampaignConfig 市场活动的配置详情。 ## 内容 ** enableMetadataWithRecommendations ** 是否为市场活动启用了带有建议的元数据。如果启用，则可以在建议请求中指定物品数据集中的列。Amazon Personalize 会在建议响应中返回每个物品的这些数据。有关为市场活动启用元数据的信息，请参阅[在市场活动建议中启用元数据](https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-return-metadata)。如果您在建议中启用元数据，则会产生额外费用。有关更多信息，请参阅 [Amazon Personalize 定价](https://aws.amazon.com/personalize/pricing/)。类型：布尔值必需：否 ** itemExplorationConfig ** 指定浏览配置超参数，包括 `explorationWeight` 和 `explorationItemAgeCutOff`，您希望用它来配置 Amazon Personalize 在推荐物品时使用的物品浏览量。仅当您的解决方案使用 [User-Personalization ](https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html)食谱时，才提供 `itemExplorationConfig` 数据。类型：字符串到字符串映射映射条目：最多 100 项。键长度限制：最大长度为 256。值长度限制：最大长度为 1000。必需：否 ** rankingInfluence ** 排名地图影响受欢迎程度和新鲜度值。对于每个关键字，指定一个介于 0.0 和 1.0 之间的数值，该数值确定该排名因子对最终推荐的影响程度。值接近 1.0 会使因子得到更大的权重，而接近 0.0 的值会降低其影响。如果未指定，则两者都默认为 0.0。类型：字符串到双映射有效密钥：`POPULARITY | FRESHNESS` 有效范围：最小值为 0。最大值为 1。必需：否 ** syncWithLatestSolutionVersion ** 市场活动是否自动更新为使用解决方案的最新解决方案版本（经过训练的模型）。如果指定为 `True`，则必须为 `SolutionVersionArn` 参数指定*解决方案*的 ARN。ARN 的格式必须为 `SolutionArn/$LATEST`。默认设置为 `False`，您必须手动更新市场活动才能部署最新的解决方案版本。有关自动市场活动更新的更多信息，请参阅[启用自动市场活动更新](https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-automatic-latest-sv-update)。类型：布尔值必需：否 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWSSDKs，请参阅以下内容： + [AWS适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CampaignConfig) + [AWS适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CampaignConfig) + [AWS适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CampaignConfig) # CampaignSummary 提供活动属性摘要。如需完整列表，请调用 [DescribeCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html) API。 ## 目录 ** campaignArn ** 市场活动的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** creationDateTime ** 活动创建的日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** failureReason ** 市场活动失败背后的原因。类型：字符串必需：否 ** lastUpdatedDateTime ** 上次更新市场活动的日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** name ** 活动的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必需：否 ** status ** 市场活动的状态。市场活动可处于以下几种状态之一： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE - 或 - CREATE FAILED + DELETE PENDING > DELETE IN\$1PROGRESS 类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CampaignSummary) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CampaignSummary) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CampaignSummary) # CampaignUpdateSummary 提供市场活动更新的属性摘要。如需完整列表，请调用 [DescribeCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html) API。 ## 目录 ** campaignConfig ** 市场活动的配置详情。类型：[CampaignConfig](API_CampaignConfig.md) 对象必需：否 ** creationDateTime ** 创建市场活动更新的日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** failureReason ** 市场活动更新失败背后的原因。类型：字符串必需：否 ** lastUpdatedDateTime ** 上次更新市场活动的日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** minProvisionedTPS ** 指定 Amazon Personalize 将支持的请求的最低预调配每秒事务数（建议）。类型：整数有效范围：最小值为 1。必需：否 ** solutionVersionArn ** 部署的解决方案版本的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** status ** 市场活动更新的状态。市场活动更新可处于以下几种状态之一： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE - 或 - CREATE FAILED + DELETE PENDING > DELETE IN\$1PROGRESS 类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CampaignUpdateSummary) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CampaignUpdateSummary) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CampaignUpdateSummary) # CategoricalHyperParameterRange 提供分类超参数的名称和范围。 ## 目录 ** name ** 超参数的名称。类型：字符串长度约束：最大长度为 256。必需：否 ** values ** 超参数的类别列表。类型：字符串数组数组成员：最多 100 项。长度限制：最大长度为 1000。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CategoricalHyperParameterRange) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CategoricalHyperParameterRange) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CategoricalHyperParameterRange) # ContinuousHyperParameterRange 提供连续超参数的名称和范围。 ## 目录 ** maxValue ** 超参数的最大允许值。类型：双精度有效范围：最小值为 -1000000。必需：否 ** minValue ** 超参数的最小允许值。类型：双精度有效范围：最小值为 -1000000。必需：否 ** name ** 超参数的名称。类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ContinuousHyperParameterRange) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ContinuousHyperParameterRange) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ContinuousHyperParameterRange) # DataDeletionJob 描述一项作业，该作业批量删除对 Amazon Personalize 数据集组中特定用户的所有引用。有关创建数据删除作业的信息，请参阅[删除用户](https://docs.aws.amazon.com/personalize/latest/dg/delete-records.html)。 ## 目录 ** creationDateTime ** 数据删除作业的创建日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** dataDeletionJobArn ** 数据删除作业的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** datasetGroupArn ** 作业要从中删除记录的数据集组的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** dataSource ** 描述了包含要上传到数据集的数据来源，或者要从 Amazon Personalize 删除的记录列表。类型：[DataSource](API_DataSource.md) 对象必需：否 ** failureReason ** 如果数据删除作业失败，请提供原因。类型：字符串必需：否 ** jobName ** 数据删除作业的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必需：否 ** lastUpdatedDateTime ** 上次更新数据删除作业的日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** numDeleted ** 已完成作业删除的记录数。类型：整数必需：否 ** roleArn ** 有权从 Amazon S3 数据来源读取的 IAM 角色的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` 必需：否 ** status ** 数据删除作业的状态。数据删除作业可能具有以下某一状态： + PENDING > IN\$1PROGRESS > COMPLETED 或 FAILED 类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DataDeletionJob) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DataDeletionJob) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DataDeletionJob) # DataDeletionJobSummary 提供数据删除作业属性的摘要。如需完整列表，请调用 [DescribeDataDeletionJob](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataDeletionJob.html) API 操作。 ## 目录 ** creationDateTime ** 数据删除作业的创建日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** dataDeletionJobArn ** 数据删除作业的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** datasetGroupArn ** 作业已从中删除记录的数据集组的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** failureReason ** 如果数据删除作业失败，请提供原因。类型：字符串必需：否 ** jobName ** 数据删除作业的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必需：否 ** lastUpdatedDateTime ** 上次更新数据删除作业的日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** status ** 数据删除作业的状态。数据删除作业可能具有以下某一状态： + PENDING > IN\$1PROGRESS > COMPLETED 或 FAILED 类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DataDeletionJobSummary) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DataDeletionJobSummary) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DataDeletionJobSummary) # Dataset 提供数据集的元数据。 ## 内容 ** creationDateTime ** 数据集的创建日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** datasetArn ** 您想要元数据的数据集的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** datasetGroupArn ** 数据集组的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** datasetType ** 下列值之一： + 交互 + 物品 + 用户 + 操作 + Action\$1Interactions 类型：字符串长度约束：最大长度为 256。模式：`^[A-Za-z_]+$` 必需：否 ** lastUpdatedDateTime ** 显示数据集更新时间的时间戳。类型：时间戳必需：否 ** latestDatasetUpdate ** 描述数据集的最新更新。类型：[DatasetUpdateSummary](API_DatasetUpdateSummary.md) 对象必需：否 ** name ** 数据集的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必需：否 ** schemaArn ** 关联架构的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** status ** 数据集的状态。数据集可处于以下几种状态之一： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE - 或 - CREATE FAILED + DELETE PENDING > DELETE IN\$1PROGRESS 类型：字符串长度约束：最大长度为 256。必需：否 ** trackingId ** 操作交互数据集的事件跟踪器的 ID。您可以在 `PutActionInteractions` API 操作中指定跟踪器的 ID。Amazon Personalize 使用它来将新数据定向到数据集组中的操作交互数据集。类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWSSDKs，请参阅以下内容： + [AWS适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Dataset) + [AWS适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/Dataset) + [AWS适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/Dataset) # DatasetExportJob 描述将数据集导出到 Amazon S3 存储桶的作业。有关更多信息，请参阅 [CreateDatasetExportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html)。数据集导出作业可处于以下几种状态之一： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE - 或 - CREATE FAILED ## 目录 ** creationDateTime ** 数据集导出作业的创建日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** datasetArn ** 要导出的数据集的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** datasetExportJobArn ** 数据集导出作业的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** failureReason ** 如果数据集导出作业失败，请提供原因。类型：字符串必需：否 ** ingestionMode ** 要导出的数据，取决于您导入数据的方式。您可以选择导出使用数据集导入作业导入的 `BULK` 数据、增量导入的 `PUT` 数据（使用控制台、PutEvents、PutUsers 和 PutItems 操作），或者同时导出这两种类型的 `ALL`。默认值为 `PUT`。类型：字符串有效值：`BULK | PUT | ALL` 必需：否 ** jobName ** 导出作业的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必需：否 ** jobOutput ** 指向存储作业输出的 Amazon S3 存储桶的路径。例如： `s3://bucket-name/folder-name/` 类型：[DatasetExportJobOutput](API_DatasetExportJobOutput.md) 对象必需：否 ** lastUpdatedDateTime ** 上次更新数据集导出作业状态的日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** roleArn ** 有权向输出 Amazon S3 存储桶添加数据的 IAM 服务角色的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** status ** 数据集导出作业的状态。数据集导出作业可处于以下几种状态之一： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE - 或 - CREATE FAILED 类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetExportJob) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetExportJob) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetExportJob) # DatasetExportJobOutput 数据集导出作业的输出配置参数。 ## 目录 ** s3DataDestination ** Amazon S3 输入或输出存储桶的配置详细信息。类型：[S3DataConfig](API_S3DataConfig.md) 对象必需：是 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetExportJobOutput) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetExportJobOutput) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetExportJobOutput) # DatasetExportJobSummary 提供数据集导出作业的属性摘要。如需完整列表，请调用 [DescribeDatasetExportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetExportJob.html) API。 ## 目录 ** creationDateTime ** 创建数据集导出作业的日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** datasetExportJobArn ** 数据集导出作业的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** failureReason ** 如果数据集导出作业失败，则为其原因。类型：字符串必需：否 ** jobName ** 数据集导出作业的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必需：否 ** lastUpdatedDateTime ** 上次更新数据集导出作业状态的日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** status ** 数据集导出作业的状态。数据集导出作业可处于以下几种状态之一： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE - 或 - CREATE FAILED 类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetExportJobSummary) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetExportJobSummary) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetExportJobSummary) # DatasetGroup 数据集组是相关数据集（物品交互、用户、物品、操作、操作交互）的集合。您可通过调用 [CreateDatasetGroup](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html) 创建数据集组。然后通过调用 [CreateDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html) 创建一个数据集并将其添加到数据集组。数据集组用于通过调用 [CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) 创建和训练解决方案。数据集组只能包含每种数据集类型中的一种。您可以指定 AWS Key Management Service (KMS) 密钥来加密组中的数据集。 ## 目录 ** creationDateTime ** 数据集组的创建日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** datasetGroupArn ** 数据集组的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** domain ** 域数据集组的域。类型：字符串有效值：`ECOMMERCE | VIDEO_ON_DEMAND` 必需：否 ** failureReason ** 如果创建数据集组失败，请提供原因。类型：字符串必需：否 ** kmsKeyArn ** 用于加密数据集的 AWS Key Management Service (KMS) 密钥的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 2048。模式：`arn:aws.*:kms:.*:[0-9]{12}:key/.*` 必需：否 ** lastUpdatedDateTime ** 数据集组的上次更新日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** name ** 数据集组的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必需：否 ** roleArn ** 有权访问 AWS Key Management Service (KMS) 密钥的 AWS Identity and Access Management (IAM) 角色的 ARN。仅当同时指定 KMS 密钥时，提供 IAM 角色才有效。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` 必需：否 ** status ** 数据集组的当前状态。数据集组可处于以下几种状态之一： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE - 或 - CREATE FAILED + DELETE PENDING 类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetGroup) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetGroup) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetGroup) # DatasetGroupSummary 提供数据集组的属性摘要。如需完整列表，请调用 [DescribeDatasetGroup](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetGroup.html) API。 ## 目录 ** creationDateTime ** 创建数据集组的日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** datasetGroupArn ** 数据集组的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** domain ** 域数据集组的域。类型：字符串有效值：`ECOMMERCE | VIDEO_ON_DEMAND` 必需：否 ** failureReason ** 如果创建数据集组失败，则为其原因。类型：字符串必需：否 ** lastUpdatedDateTime ** 上次更新数据集组的日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** name ** 数据集组的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必需：否 ** status ** 数据集组的状态。数据集组可处于以下几种状态之一： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE - 或 - CREATE FAILED + DELETE PENDING 类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetGroupSummary) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetGroupSummary) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetGroupSummary) # DatasetImportJob 描述将训练数据从数据来源（Amazon S3 桶）导入到 Amazon Personalize 数据集的作业。有关更多信息，请参阅 [CreateDatasetImportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html)。数据集导入作业可处于以下几种状态之一： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE - 或 - CREATE FAILED ## 目录 ** creationDateTime ** 数据集导入作业的创建日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** datasetArn ** 接收导入数据的数据集的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** datasetImportJobArn ** 数据集导入作业的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** dataSource ** 包含要导入的训练数据的 Amazon S3 桶。类型：[DataSource](API_DataSource.md) 对象必需：否 ** failureReason ** 如果数据集导入作业失败，请提供原因。类型：字符串必需：否 ** importMode ** 数据集导入作业用于导入新记录的导入模式。类型：字符串有效值：`FULL | INCREMENTAL` 必需：否 ** jobName ** 导入作业的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必需：否 ** lastUpdatedDateTime ** 上次更新数据集的日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** publishAttributionMetricsToS3 ** 作业是否向 Amazon S3 发布指标以进行指标归因。类型：布尔值必需：否 ** roleArn ** 有权读取 Amazon S3 数据来源的 IAM 角色的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** status ** 数据集导入作业的状态。数据集导入作业可处于以下几种状态之一： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE - 或 - CREATE FAILED 类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetImportJob) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetImportJob) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetImportJob) # DatasetImportJobSummary 提供数据集导入作业的属性摘要。如需完整列表，请调用 [DescribeDatasetImportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetImportJob.html) API。 ## 目录 ** creationDateTime ** 创建数据集导入作业的日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** datasetImportJobArn ** 数据集导入作业的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** failureReason ** 如果数据集导入作业失败，则为其原因。类型：字符串必需：否 ** importMode ** 数据集导入作业用于更新数据集中的数据的导入模式。有关更多信息，请参阅[更新现有批量数据](https://docs.aws.amazon.com/personalize/latest/dg/updating-existing-bulk-data.html)。类型：字符串有效值：`FULL | INCREMENTAL` 必需：否 ** jobName ** 数据集导入作业的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必需：否 ** lastUpdatedDateTime ** 上次更新数据集导入作业状态的日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** status ** 数据集导入作业的状态。数据集导入作业可处于以下几种状态之一： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE - 或 - CREATE FAILED 类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetImportJobSummary) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetImportJobSummary) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetImportJobSummary) # DatasetSchema 描述数据集的架构。有关架构的更多信息，请参阅 [CreateSchema](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html)。 ## 目录 ** creationDateTime ** 架构的创建日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** domain ** 为域数据集组中的数据集创建的架构的域。类型：字符串有效值：`ECOMMERCE | VIDEO_ON_DEMAND` 必需：否 ** lastUpdatedDateTime ** 上次更新架构的日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** name ** 架构的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必需：否 ** schema ** 架构。类型：字符串长度限制：最大长度为 20000。必需：否 ** schemaArn ** 架构的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetSchema) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetSchema) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetSchema) # DatasetSchemaSummary 提供数据集架构的属性摘要。如需完整列表，请调用 [DescribeSchema](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSchema.html) API。 ## 目录 ** creationDateTime ** 架构的创建日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** domain ** 为域数据集组中的数据集创建的架构的域。类型：字符串有效值：`ECOMMERCE | VIDEO_ON_DEMAND` 必需：否 ** lastUpdatedDateTime ** 上次更新架构的日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** name ** 架构的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必需：否 ** schemaArn ** 架构的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetSchemaSummary) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetSchemaSummary) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetSchemaSummary) # DatasetSummary 提供数据集属性摘要。如需完整列表，请调用 [DescribeDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html)API。 ## 内容 ** creationDateTime ** 数据集的创建日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** datasetArn ** 数据集的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** datasetType ** 数据集类型。下列值之一： + 交互 + 物品 + Users + 事件-交互类型：字符串长度约束：最大长度为 256。模式：`^[A-Za-z_]+$` 必需：否 ** lastUpdatedDateTime ** 上次更新数据集的日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** name ** 数据集的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必需：否 ** status ** 数据集的状态。数据集可处于以下几种状态之一： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE - 或 - CREATE FAILED + DELETE PENDING > DELETE IN\$1PROGRESS 类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWSSDKs，请参阅以下内容： + [AWS适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetSummary) + [AWS适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetSummary) + [AWS适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetSummary) # DatasetUpdateSummary 描述数据集的更新。 ## 目录 ** creationDateTime ** 数据集更新的创建日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** failureReason ** 如果更新数据集失败，请提供原因。类型：字符串必需：否 ** lastUpdatedDateTime ** 数据集的上次更新日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** schemaArn ** 取代了数据集先前架构的架构的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** status ** 数据集更新的状态。类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetUpdateSummary) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetUpdateSummary) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetUpdateSummary) # DataSource 描述了包含要上传到数据集的数据来源，或者要从 Amazon Personalize 删除的记录列表。 ## 目录 ** dataLocation ** 对于数据集导入作业，这是存储了要上传到数据集的数据的 Amazon S3 存储桶路径。对于数据删除作业，这是存储了待删除记录列表的 Amazon S3 存储桶路径。例如： `s3://bucket-name/folder-name/fileName.csv` 如果您的 CSV 文件位于 Amazon S3 存储桶的某个文件夹中，并且您希望导入作业或数据删除作业考虑多个文件，则可以指定该文件夹的路径。对于数据删除作业，Amazon Personalize 会使用该文件夹及任何子文件夹中的所有文件。使用以下语法，在文件夹名称后面加上 `/`： `s3://bucket-name/folder-name/` 类型：字符串长度约束：最大长度为 256。模式：`(s3|http|https)://.+` 必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DataSource) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DataSource) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DataSource) # DefaultCategoricalHyperParameterRange 提供分类超参数的名称和默认范围，以及超参数是否可调。可以在超参数优化 (HPO) 期间确定可调超参数的值。 ## 目录 ** isTunable ** 超参数是否可调。类型：布尔值必需：否 ** name ** 超参数的名称。类型：字符串长度约束：最大长度为 256。必需：否 ** values ** 超参数的类别列表。类型：字符串数组数组成员：最多 100 项。长度限制：最大长度为 1000。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DefaultCategoricalHyperParameterRange) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DefaultCategoricalHyperParameterRange) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DefaultCategoricalHyperParameterRange) # DefaultContinuousHyperParameterRange 提供连续超参数的名称和默认范围，以及超参数是否可调。可以在超参数优化 (HPO) 期间确定可调超参数的值。 ## 目录 ** isTunable ** 超参数是否可调。类型：布尔值必需：否 ** maxValue ** 超参数的最大允许值。类型：双精度有效范围：最小值为 -1000000。必需：否 ** minValue ** 超参数的最小允许值。类型：双精度有效范围：最小值为 -1000000。必需：否 ** name ** 超参数的名称。类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DefaultContinuousHyperParameterRange) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DefaultContinuousHyperParameterRange) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DefaultContinuousHyperParameterRange) # DefaultHyperParameterRanges 指定超参数及其默认范围。超参数可以是分类值、连续值或整数值。 ## 目录 ** categoricalHyperParameterRanges ** 类别超参数及其默认范围。类型：[DefaultCategoricalHyperParameterRange](API_DefaultCategoricalHyperParameterRange.md) 对象数组数组成员：最多 100 项。必需：否 ** continuousHyperParameterRanges ** 连续超参数及其默认范围。类型：[DefaultContinuousHyperParameterRange](API_DefaultContinuousHyperParameterRange.md) 对象数组数组成员：最多 100 项。必需：否 ** integerHyperParameterRanges ** 整数值超参数及其默认范围。类型：[DefaultIntegerHyperParameterRange](API_DefaultIntegerHyperParameterRange.md) 对象数组数组成员：最多 100 项。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DefaultHyperParameterRanges) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DefaultHyperParameterRanges) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DefaultHyperParameterRanges) # DefaultIntegerHyperParameterRange 提供整数值超参数的名称和默认范围，以及超参数是否可调。可以在超参数优化 (HPO) 期间确定可调超参数的值。 ## 目录 ** isTunable ** 表示超参数是否可调。类型：布尔值必需：否 ** maxValue ** 超参数的最大允许值。类型：整数有效范围：最大值为 1000000。必需：否 ** minValue ** 超参数的最小允许值。类型：整数有效范围：最小值为 -1000000。必需：否 ** name ** 超参数的名称。类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DefaultIntegerHyperParameterRange) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DefaultIntegerHyperParameterRange) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DefaultIntegerHyperParameterRange) # EventParameters 描述用于创建解决方案的事件参数。 ## 目录 ** eventType ** 创建解决方案时要考虑的事件类型的名称。类型：字符串长度约束：最大长度为 256。必需：否 ** eventValueThreshold ** 事件类型的阈值。只有值大于或等于此阈值的事件才会被考虑用于创建解决方案。类型：双精度必需：否 ** weight ** 事件类型的权重。权重越高意味着事件类型对创建的解决方案越重要。类型：双精度有效范围：最小值为 0。最大值为 1。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/EventParameters) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/EventParameters) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/EventParameters) # EventsConfig 描述用于创建解决方案的事件配置。 ## 目录 ** eventParametersList ** 事件参数列表，其中包含事件类型及其事件值阈值和权重。类型：[EventParameters](API_EventParameters.md) 对象数组数组成员：最多 10 项。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/EventsConfig) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/EventsConfig) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/EventsConfig) # EventTracker 提供有关事件跟踪器的信息。 ## 目录 ** accountId ** 拥有事件跟踪器的 AWS 账户。类型：字符串长度约束：最大长度为 256。必需：否 ** creationDateTime ** 创建事件跟踪器的日期和时间（采用 Unix 格式）。类型：时间戳必需：否 ** datasetGroupArn ** 接收事件数据的数据集组的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** eventTrackerArn ** 事件跟踪器的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** lastUpdatedDateTime ** 上次更新事件跟踪器的日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** name ** 事件跟踪器的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必需：否 ** status ** 事件跟踪器的状态。事件跟踪器可以处于以下某种状态： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE - 或 - CREATE FAILED + DELETE PENDING > DELETE IN\$1PROGRESS 类型：字符串长度约束：最大长度为 256。必需：否 ** trackingId ** 事件跟踪器的 ID。在向 [PutEvents](https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html) API 发出的请求中包含此 ID。类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/EventTracker) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/EventTracker) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/EventTracker) # EventTrackerSummary 提供事件跟踪器属性摘要。如需完整列表，请调用 [DescribeEventTracker](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeEventTracker.html) API。 ## 目录 ** creationDateTime ** 创建事件跟踪器的日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** eventTrackerArn ** 事件跟踪器的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** lastUpdatedDateTime ** 上次更新事件跟踪器的日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** name ** 事件跟踪器的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必需：否 ** status ** 事件跟踪器的状态。事件跟踪器可以处于以下某种状态： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE - 或 - CREATE FAILED + DELETE PENDING > DELETE IN\$1PROGRESS 类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/EventTrackerSummary) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/EventTrackerSummary) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/EventTrackerSummary) # FeatureTransformation 提供特征转换信息。特征转换是将原始输入数据修改为更适合模型训练的格式的过程。 ## 目录 ** creationDateTime ** 特征转换的创建日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** defaultParameters ** 提供特征转换的默认参数。类型：字符串到字符串映射映射条目：最多 100 项。键长度限制：最大长度为 256。值长度限制：最大长度为 1000。必需：否 ** featureTransformationArn ** FeatureTransformation 对象的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** lastUpdatedDateTime ** 特征转换的上次更新日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** name ** 特征转换的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必需：否 ** status ** 特征转换的状态。特征转换可以处于以下某种状态： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE - 或 - CREATE FAILED 类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/FeatureTransformation) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/FeatureTransformation) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/FeatureTransformation) # FieldsForThemeGeneration 主题生成的配置详细信息的字符串到字符串映射。 ## 目录 ** itemName ** 用于在数据集中存储每个物品的名称的物品数据集列的名称。类型：字符串长度限制：最大长度为 150。模式：`[A-Za-z_][A-Za-z\d_]*` 必需：是 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/FieldsForThemeGeneration) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/FieldsForThemeGeneration) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/FieldsForThemeGeneration) # Filter 包含有关建议筛选器的信息，包括其 ARN、状态和筛选器表达式。 ## 目录 ** creationDateTime ** 创建筛选器的时间。类型：时间戳必需：否 ** datasetGroupArn ** 筛选器所属数据集组的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** failureReason ** 如果筛选失败，请说明原因。类型：字符串必需：否 ** filterArn ** 筛选器的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** filterExpression ** 指定要从建议结果中筛选出来的物品交互类型。筛选器表达式必须遵循特定的格式规则。有关筛选器表达式结构和语法的信息，请参阅[筛选器表达式](https://docs.aws.amazon.com/personalize/latest/dg/filter-expressions.html)。类型：字符串长度限制：长度下限为 1。最大长度为 2500。必需：否 ** lastUpdatedDateTime ** 上次更新筛选器的时间。类型：时间戳必需：否 ** name ** 筛选器的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必需：否 ** status ** 筛选器的状态。类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Filter) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/Filter) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/Filter) # FilterSummary 筛选器属性的简短摘要。 ## 目录 ** creationDateTime ** 创建筛选器的时间。类型：时间戳必需：否 ** datasetGroupArn ** 筛选器所属数据集组的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** failureReason ** 如果筛选失败，请说明原因。类型：字符串必需：否 ** filterArn ** 筛选器的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** lastUpdatedDateTime ** 上次更新筛选器的时间。类型：时间戳必需：否 ** name ** 筛选器的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必需：否 ** status ** 筛选器的状态。类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/FilterSummary) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/FilterSummary) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/FilterSummary) # HPOConfig 描述超参数优化（HPO）的属性。 ## 目录 ** algorithmHyperParameterRanges ** 超参数及其允许范围。类型：[HyperParameterRanges](API_HyperParameterRanges.md) 对象必需：否 ** hpoObjective ** HPO 期间要优化的指标。 Amazon Personalize 目前不支持配置 `hpoObjective`。类型：[HPOObjective](API_HPOObjective.md) 对象必需：否 ** hpoResourceConfig ** 描述 HPO 的资源配置。类型：[HPOResourceConfig](API_HPOResourceConfig.md) 对象必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/HPOConfig) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/HPOConfig) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/HPOConfig) # HPOObjective 超参数优化（HPO）期间要优化的指标。 **注意** Amazon Personalize 目前不支持配置 `hpoObjective`。 ## 目录 ** metricName ** 指标的名称。类型：字符串长度约束：最大长度为 256。必需：否 ** metricRegex ** 用于在训练任务日志中查找指标的正则表达式。类型：字符串长度约束：最大长度为 256。必需：否 ** type ** 指标的类型。有效值为 `Maximize` 和 `Minimize`。类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/HPOObjective) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/HPOObjective) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/HPOObjective) # HPOResourceConfig 描述超参数优化（HPO）的资源配置。 ## 目录 ** maxNumberOfTrainingJobs ** 创建解决方案版本时的最大训练任务数。`maxNumberOfTrainingJobs` 的最大值为 `40`。类型：字符串长度约束：最大长度为 256。必需：否 ** maxParallelTrainingJobs ** 创建解决方案版本时的最大并行训练任务数。`maxParallelTrainingJobs` 的最大值为 `10`。类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/HPOResourceConfig) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/HPOResourceConfig) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/HPOResourceConfig) # HyperParameterRanges 指定超参数及其范围。超参数可以是分类值、连续值或整数值。 ## 目录 ** categoricalHyperParameterRanges ** 分类超参数及其范围。类型：[CategoricalHyperParameterRange](API_CategoricalHyperParameterRange.md) 对象数组数组成员：最多 100 项。必需：否 ** continuousHyperParameterRanges ** 连续超参数及其范围。类型：[ContinuousHyperParameterRange](API_ContinuousHyperParameterRange.md) 对象数组数组成员：最多 100 项。必需：否 ** integerHyperParameterRanges ** 整数值超参数及其范围。类型：[IntegerHyperParameterRange](API_IntegerHyperParameterRange.md) 对象数组数组成员：最多 100 项。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/HyperParameterRanges) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/HyperParameterRanges) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/HyperParameterRanges) # IntegerHyperParameterRange 提供整数值超参数的名称和范围。 ## 目录 ** maxValue ** 超参数的最大允许值。类型：整数有效范围：最大值为 1000000。必需：否 ** minValue ** 超参数的最小允许值。类型：整数有效范围：最小值为 -1000000。必需：否 ** name ** 超参数的名称。类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/IntegerHyperParameterRange) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/IntegerHyperParameterRange) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/IntegerHyperParameterRange) # MetricAttribute 包含有关指标归因报告的指标的信息。有关更多信息，请参阅[衡量建议的影响](https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html)。 ## 目录 ** eventType ** 指标事件类型。类型：字符串长度约束：最大长度为 256。必需：是 ** expression ** 属性的表达式。可用函数为 `SUM()` 或 `SAMPLECOUNT()`。对于 SUM() 函数，提供数据集类型（交互或物品）及要求和的列作为参数。例如 SUM(Items.PRICE)。类型：字符串长度约束：最大长度为 256。必需：是 ** metricName ** 指标名称。该名称可帮助您识别 Amazon CloudWatch 或 Amazon S3 中的指标。类型：字符串长度约束：最大长度为 256。必需：是 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/MetricAttribute) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/MetricAttribute) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/MetricAttribute) # MetricAttribution 包含有关指标归因的信息。指标归因会针对您导入 Amazon Personalize 的数据创建报告。根据您导入数据的方式，您可以在 Amazon CloudWatch 或 Amazon S3 中查看报告。有关更多信息，请参阅[衡量建议的影响](https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html)。 ## 目录 ** creationDateTime ** 指标归因的创建日期和时间。类型：时间戳必需：否 ** datasetGroupArn ** 指标归因的数据集组 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** failureReason ** 指标归因的失败原因。类型：字符串必需：否 ** lastUpdatedDateTime ** 指标归因的上次更新日期和时间。类型：时间戳必需：否 ** metricAttributionArn ** 指标归因的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** metricsOutputConfig ** 指标归因的输出配置。类型：[MetricAttributionOutput](API_MetricAttributionOutput.md) 对象必需：否 ** name ** 指标归因的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必需：否 ** status ** 指标归因的状态。类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/MetricAttribution) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/MetricAttribution) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/MetricAttribution) # MetricAttributionOutput 指标归因的输出配置详细信息。 ## 目录 ** roleArn ** 有权向输出 Amazon S3 存储桶添加数据并向 Amazon CloudWatch 添加指标的 IAM 服务角色的 Amazon 资源名称 (ARN)。有关更多信息，请参阅[衡量建议的影响](https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` 必需：是 ** s3DataDestination ** Amazon S3 输入或输出存储桶的配置详细信息。类型：[S3DataConfig](API_S3DataConfig.md) 对象必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/MetricAttributionOutput) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/MetricAttributionOutput) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/MetricAttributionOutput) # MetricAttributionSummary 提供指标归因属性的摘要。如需完整列表，请调用 [DescribeMetricAttribution](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeMetricAttribution.html)。 ## 目录 ** creationDateTime ** 指标归因的创建日期和时间。类型：时间戳必需：否 ** failureReason ** 指标归因的失败原因。类型：字符串必需：否 ** lastUpdatedDateTime ** 指标归因的上次更新日期和时间。类型：时间戳必需：否 ** metricAttributionArn ** 指标归因的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** name ** 指标归因的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必需：否 ** status ** 指标归因的状态。类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/MetricAttributionSummary) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/MetricAttributionSummary) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/MetricAttributionSummary) # OptimizationObjective 描述解决方案的其他目标，例如最大限度地提高流时长或增加收入。有关更多信息，请参阅[优化解决方案](https://docs.aws.amazon.com/personalize/latest/dg/optimizing-solution-for-objective.html)。 ## 目录 ** itemAttribute ** 物品数据集中与优化目标相关的数值元数据列。例如，VIDEO\$1LENGTH（可最大限度地提高流时长）或 PRICE（可最大限度地提高收入）。类型：字符串长度限制：长度下限为 1。最大长度为 150。必需：否 ** objectiveSensitivity ** 指定 Amazon Personalize 如何平衡优化目标的重要性与相关性。类型：字符串有效值：`LOW | MEDIUM | HIGH | OFF` 必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/OptimizationObjective) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/OptimizationObjective) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/OptimizationObjective) # Recipe 提供有关食谱的信息。每个食谱都提供了一种算法，供 Amazon Personalize 在您使用 [CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) 操作时在模型训练期间使用。 ## 目录 ** algorithmArn ** Amazon Personalize 用来训练模型的算法的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** creationDateTime ** 创建食谱的日期和时间（采用 Unix 格式）。类型：时间戳必需：否 ** description ** 对食谱的描述。类型：字符串必需：否 ** featureTransformationArn ** FeatureTransformation 对象的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** lastUpdatedDateTime ** 上次更新食谱的日期和时间（采用 Unix 格式）。类型：时间戳必需：否 ** name ** 食谱的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必需：否 ** recipeArn ** 食谱的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** recipeType ** 下列值之一： + PERSONALIZED\$1RANKING + RELATED\$1ITEMS + USER\$1PERSONALIZATION 类型：字符串长度约束：最大长度为 256。必需：否 ** status ** 食谱的状态。类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Recipe) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/Recipe) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/Recipe) # RecipeSummary 提供食谱属性摘要。如需完整列表，请调用 [DescribeRecipe](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecipe.html) API。 ## 目录 ** creationDateTime ** 创建食谱的日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** domain ** 食谱的域（如果食谱是域数据集组使用案例）。类型：字符串有效值：`ECOMMERCE | VIDEO_ON_DEMAND` 必需：否 ** lastUpdatedDateTime ** 上次更新食谱的日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** name ** 食谱的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必需：否 ** recipeArn ** 食谱的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** status ** 食谱的状态。类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/RecipeSummary) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/RecipeSummary) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/RecipeSummary) # Recommender 描述域数据集组的建议生成器。您可以在域数据集组中为特定域使用案例（域食谱）创建推荐器，然后在 [GetRecommendations](https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) 请求中指定推荐器。 ## 目录 ** creationDateTime ** 推荐器的创建日期和时间（采用 Unix 格式）。类型：时间戳必需：否 ** datasetGroupArn ** 包含推荐器的域数据集组的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** failureReason ** 如果推荐器失败，请说明原因。类型：字符串必需：否 ** lastUpdatedDateTime ** 上次更新推荐器的日期和时间（采用 Unix 格式）。类型：时间戳必需：否 ** latestRecommenderUpdate ** 提供推荐器最新更新的摘要。类型：[RecommenderUpdateSummary](API_RecommenderUpdateSummary.md) 对象必需：否 ** modelMetrics ** 提供评估指标，以帮助您确定推荐器的性能。有关更多信息，请参阅[评估推荐器](https://docs.aws.amazon.com/personalize/latest/dg/evaluating-recommenders.html)。类型：字符串到双映射映射条目：最多 100 项。键长度限制：最大长度为 256。必需：否 ** name ** 推荐器的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必需：否 ** recipeArn ** 创建推荐器的食谱（域数据集组使用案例）的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** recommenderArn ** 推荐器的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** recommenderConfig ** 推荐器的配置详细信息。类型：[RecommenderConfig](API_RecommenderConfig.md) 对象必需：否 ** status ** 推荐器的状态。推荐器可处于以下一种状态： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE - 或 - CREATE FAILED + STOP PENDING > STOP IN\$1PROGRESS > INACTIVE > START PENDING > START IN\$1PROGRESS > ACTIVE + DELETE PENDING > DELETE IN\$1PROGRESS 类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Recommender) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/Recommender) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/Recommender) # RecommenderConfig 推荐器的配置详细信息。 ## 目录 ** enableMetadataWithRecommendations ** 是否为推荐器启用了带有建议的元数据。如果启用，则可以在建议请求中指定物品数据集中的列。Amazon Personalize 会在建议响应中返回每个物品的这些数据。有关为推荐器启用元数据的信息，请参阅[在推荐器建议中启用元数据](https://docs.aws.amazon.com/personalize/latest/dg/creating-recommenders.html#create-recommender-return-metadata)。如果您在建议中启用元数据，则会产生额外费用。有关更多信息，请参阅 [Amazon Personalize 定价](https://aws.amazon.com/personalize/pricing/)。类型：布尔值必需：否 ** itemExplorationConfig ** 指定浏览配置超参数，包括 `explorationWeight` 和 `explorationItemAgeCutOff`，您希望用它来配置 Amazon Personalize 在推荐物品时使用的物品浏览量。只有当您的推荐器为用户生成个性化建议（而非热门物品或类似物品）时，才提供 `itemExplorationConfig` 数据。类型：字符串到字符串映射映射条目：最多 100 项。键长度限制：最大长度为 256。值长度限制：最大长度为 1000。必需：否 ** minRecommendationRequestsPerSecond ** 指定 Amazon Personalize 将支持的请求的最低预调配建议每秒请求数。高 `minRecommendationRequestsPerSecond` 会增加您的账单费用。我们建议从 1 开始设置 `minRecommendationRequestsPerSecond`（默认值）。使用 Amazon CloudWatch 指标跟踪您的使用情况，并在必要时增加 `minRecommendationRequestsPerSecond`。类型：整数有效范围：最小值为 1。必需：否 ** trainingDataConfig ** 指定创建域推荐器时要使用的训练数据配置。类型：[TrainingDataConfig](API_TrainingDataConfig.md) 对象必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/RecommenderConfig) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/RecommenderConfig) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/RecommenderConfig) # RecommenderSummary 提供推荐器属性摘要。 ## 目录 ** creationDateTime ** 推荐器的创建日期和时间（采用 Unix 格式）。类型：时间戳必需：否 ** datasetGroupArn ** 包含推荐器的域数据集组的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** lastUpdatedDateTime ** 上次更新推荐器的日期和时间（采用 Unix 格式）。类型：时间戳必需：否 ** name ** 推荐器的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必需：否 ** recipeArn ** 创建推荐器的食谱（域数据集组使用案例）的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** recommenderArn ** 推荐器的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** recommenderConfig ** 推荐器的配置详细信息。类型：[RecommenderConfig](API_RecommenderConfig.md) 对象必需：否 ** status ** 推荐器的状态。推荐器可处于以下一种状态： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE - 或 - CREATE FAILED + STOP PENDING > STOP IN\$1PROGRESS > INACTIVE > START PENDING > START IN\$1PROGRESS > ACTIVE + DELETE PENDING > DELETE IN\$1PROGRESS 类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/RecommenderSummary) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/RecommenderSummary) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/RecommenderSummary) # RecommenderUpdateSummary 提供推荐器更新的属性摘要。如需完整列表，请调用 [DescribeRecommender](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html) API。 ## 目录 ** creationDateTime ** 推荐器更新的创建日期和时间（采用 Unix 格式）。类型：时间戳必需：否 ** failureReason ** 如果推荐器更新失败，请说明原因。类型：字符串必需：否 ** lastUpdatedDateTime ** 上次更新推荐器更新的日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** recommenderConfig ** 推荐器更新的配置详细信息。类型：[RecommenderConfig](API_RecommenderConfig.md) 对象必需：否 ** status ** 推荐器更新的状态。推荐器更新可处于以下一种状态： CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE - 或 - CREATE FAILED 类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/RecommenderUpdateSummary) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/RecommenderUpdateSummary) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/RecommenderUpdateSummary) # S3DataConfig Amazon S3 输入或输出存储桶的配置详细信息。 ## 目录 ** path ** Amazon S3 存储桶的文件路径。类型：字符串长度约束：最大长度为 256。模式：`(s3|http|https)://.+` 必需：是 ** kmsKeyArn ** Amazon Personalize 用来加密或解密输入和输出文件的 AWS Key Management Service (KMS) 密钥的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 2048。模式：`arn:aws.*:kms:.*:[0-9]{12}:key/.*` 必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/S3DataConfig) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/S3DataConfig) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/S3DataConfig) # Solution **重要** 默认情况下，所有新解决方案都使用自动训练。如果使用自动训练，则在解决方案处于活动状态时，就会产生训练费用。为避免产生不必要的费用，在完成后，可以[更新解决方案](https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateSolution.html)以关闭自动训练。有关训练费用的信息，请参阅 [Amazon Personalize 定价](https://aws.amazon.com/personalize/pricing/)。提供有关解决方案的信息的对象。解决方案包括 Amazon Personalize 用来生成推荐的自定义配方、自定义参数和经过训练的模型（解决方案版本）。创建解决方案后，就不能更改其配置。如果您需要进行更改，则可以使用 Amazon Personalize 控制台[克隆解决方案](https://docs.aws.amazon.com/personalize/latest/dg/cloning-solution.html)或创建一个新的解决方案。 ## 内容 ** autoMLResult ** 如果 `performAutoML` 为 true，请指定找到的最佳食谱。类型：[AutoMLResult](API_AutoMLResult.md) 对象必需：否 ** creationDateTime ** 解决方案的创建日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** datasetGroupArn ** 提供训练数据的数据集组的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** eventType ** 用于训练模型的事件类型（例如，“单击”或“点赞”）。如果没有提供 `eventType`，Amazon Personalize 将使用所有交互进行同等权重的训练，而不考虑类型。类型：字符串长度约束：最大长度为 256。必需：否 ** lastUpdatedDateTime ** 上次更新解决方案的日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** latestSolutionUpdate ** 提供解决方案最新更新的摘要。类型：[SolutionUpdateSummary](API_SolutionUpdateSummary.md) 对象必需：否 ** latestSolutionVersion ** 描述解决方案的最新版本，包括状态和 ARN。类型：[SolutionVersionSummary](API_SolutionVersionSummary.md) 对象必需：否 ** name ** 解决方案的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必需：否 ** performAutoML ** 我们建议不要启用自动机器学习。相反，请将您的使用案例与可用的 Amazon Personalize 配方匹配。有关更多信息，请参阅 [Determining your use case](https://docs.aws.amazon.com/personalize/latest/dg/determining-use-case.html)（确定您的使用案例）。如果为 true，Amazon Personalize 会从解决方案配置中指定的列表中搜索最佳 USER\$1PERSONALIZATION 食谱（不得指定 `recipeArn`）。如果为 false（默认值），Amazon Personalize 将使用 `recipeArn` 进行训练。类型：布尔值必需：否 ** performAutoTraining ** 指定解决方案是否自动创建解决方案版本。默认设置为 `True`，解决方案每 7 天自动创建新的解决方案版本。有关自动训练的更多信息，请参阅[创建和配置解决方案](https://docs.aws.amazon.com/personalize/latest/dg/customizing-solution-config.html)。类型：布尔值必需：否 ** performHPO ** 是否对所选食谱执行超参数优化（HPO）。默认值为 `false`。类型：布尔值必需：否 ** performIncrementalUpdate ** 一个布尔值，用于指示是否对模型执行增量训练更新。启用后，它允许模型更频繁地从新数据中学习，而无需进行全面的再训练，从而实现近乎实时的个性化。只有使用语义相似度配方的解决方案才支持此参数类型：布尔值必需：否 ** recipeArn ** 用于创建解决方案的食谱的 ARN。当 `performAutoML` 为 false 时，这是必需的。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** solutionArn ** 解决方案的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** solutionConfig ** 描述解决方案的配置属性。类型：[SolutionConfig](API_SolutionConfig.md) 对象必需：否 ** status ** 解决方案的状态。解决方案可处于以下几种状态之一： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE - 或 - CREATE FAILED + DELETE PENDING > DELETE IN\$1PROGRESS 类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWSSDKs，请参阅以下内容： + [AWS适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Solution) + [AWS适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/Solution) + [AWS适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/Solution) # SolutionConfig 描述解决方案的配置属性。 ## 目录 ** algorithmHyperParameters ** 列出算法超参数及其值。类型：字符串到字符串映射映射条目：最多 100 项。键长度限制：最大长度为 256。值长度限制：最大长度为 1000。必需：否 ** autoMLConfig ** 包含当执行 AutoML 时要搜索的食谱列表的 [AutoMLConfig](https://docs.aws.amazon.com/personalize/latest/dg/API_AutoMLConfig.html) 对象。类型：[AutoMLConfig](API_AutoMLConfig.md) 对象必需：否 ** autoTrainingConfig ** 指定要使用的自动训练配置。类型：[AutoTrainingConfig](API_AutoTrainingConfig.md) 对象必需：否 ** eventsConfig ** 描述事件的配置，其中包含事件参数列表。您可以指定最多 10 个事件参数。事件用于创建解决方案。类型：[EventsConfig](API_EventsConfig.md) 对象必需：否 ** eventValueThreshold ** 仅具有大于或等于阈值的值的事件用于训练模型。类型：字符串长度约束：最大长度为 256。必需：否 ** featureTransformationParameters ** 列出特征转换参数。类型：字符串到字符串映射映射条目：最多 100 项。键长度限制：最大长度为 256。值长度限制：最大长度为 1000。必需：否 ** hpoConfig ** 描述超参数优化（HPO）的属性。类型：[HPOConfig](API_HPOConfig.md) 对象必需：否 ** optimizationObjective ** 描述解决方案的其他目标，例如最大限度地提高流时长或增加收入。有关更多信息，请参阅[优化解决方案](https://docs.aws.amazon.com/personalize/latest/dg/optimizing-solution-for-objective.html)。类型：[OptimizationObjective](API_OptimizationObjective.md) 对象必需：否 ** trainingDataConfig ** 指定创建自定义解决方案版本（经过训练的模型）时要使用的训练数据配置。类型：[TrainingDataConfig](API_TrainingDataConfig.md) 对象必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/SolutionConfig) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/SolutionConfig) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/SolutionConfig) # SolutionSummary 提供解决方案属性摘要。如需完整列表，请调用 [DescribeSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html) API。 ## 目录 ** creationDateTime ** 创建解决方案的日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** lastUpdatedDateTime ** 上次更新解决方案的日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** name ** 解决方案的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必需：否 ** recipeArn ** 解决方案使用的食谱的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** solutionArn ** 解决方案的 Amazon 资源名称（ARN）。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** status ** 解决方案的状态。解决方案可处于以下几种状态之一： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE - 或 - CREATE FAILED + DELETE PENDING > DELETE IN\$1PROGRESS 类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/SolutionSummary) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/SolutionSummary) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/SolutionSummary) # SolutionUpdateConfig 解决方案更新的配置详细信息。 ## 目录 ** autoTrainingConfig ** 当 `performAutoTraining` 为 true 时要使用的自动训练配置。类型：[AutoTrainingConfig](API_AutoTrainingConfig.md) 对象必需：否 ** eventsConfig ** 描述事件的配置，其中包含事件参数列表。您可以指定最多 10 个事件参数。事件用于创建解决方案。类型：[EventsConfig](API_EventsConfig.md) 对象必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/SolutionUpdateConfig) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/SolutionUpdateConfig) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/SolutionUpdateConfig) # SolutionUpdateSummary 提供解决方案更新属性的摘要。如需完整列表，请调用 [DescribeSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html)API。 ## 内容 ** creationDateTime ** 解决方案更新的创建日期和时间（采用 Unix 格式）。类型：时间戳必需：否 ** failureReason ** 如果解决方案更新失败，则为其原因。类型：字符串必需：否 ** lastUpdatedDateTime ** 上次更新解决方案更新的日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** performAutoTraining ** 解决方案是否自动创建解决方案版本。类型：布尔值必需：否 ** performIncrementalUpdate ** 一个布尔值，用于指示是否对模型执行增量训练更新。启用后，将对具有活跃营销活动的解决方案版本进行增量训练，并允许模型更频繁地从新数据中学习，而无需进行全面的再训练，从而实现近乎实时的个性化。只有使用语义相似度配方的解决方案才支持此参数。默认值为 `true`。请注意，某些分数和属性（例如更新物品受欢迎程度和用于通过 aws-semantic-similarity配方影响排名的新鲜度）可能要等到下一次完整训练才会更新。类型：布尔值必需：否 ** solutionUpdateConfig ** 解决方案的配置详细信息。类型：[SolutionUpdateConfig](API_SolutionUpdateConfig.md) 对象必需：否 ** status ** 解决方案更新的状态。解决方案更新可处于以下几种状态之一： CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE - 或 - CREATE FAILED 类型：字符串长度约束：最大长度为 256。必需：否 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWSSDKs，请参阅以下内容： + [AWS适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/SolutionUpdateSummary) + [AWS适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/SolutionUpdateSummary) + [AWS适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/SolutionUpdateSummary) # SolutionVersion 一个对象，用于提供有关自定义数据集组中特定版[解决方案](https://docs.aws.amazon.com/personalize/latest/dg/API_Solution.html)的信息。 ## 内容 ** creationDateTime ** 创建此版解决方案的日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** datasetGroupArn ** 提供训练数据的数据集组的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** eventType ** 用于训练模型的事件类型（例如，“单击”或“点赞”）。类型：字符串长度约束：最大长度为 256。必需：否 ** failureReason ** 如果训练解决方案版本失败，则为其原因。类型：字符串必需：否 ** lastUpdatedDateTime ** 上次更新解决方案的日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** name ** 解决方案版本的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必需：否 ** performAutoML ** 如果为 true，Amazon Personalize 会根据解决方案配置搜索最佳食谱。如果为 false（默认值），Amazon Personalize 将使用 `recipeArn`。类型：布尔值必需：否 ** performHPO ** 是否对所选食谱执行超参数优化（HPO）。默认值为 `false`。类型：布尔值必需：否 ** performIncrementalUpdate ** 解决方案版本是否应执行增量更新。设置为 true 时，训练将仅处理自上次训练以来发生更改的数据，类似于 TrainingMode 设置为 UPDATE 的情况。这只能用于使用用户个性化配方的解决方案版本。类型：布尔值必需：否 ** recipeArn ** 解决方案中使用的食谱的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** solutionArn ** 解决方案的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** solutionConfig ** 描述解决方案的配置属性。类型：[SolutionConfig](API_SolutionConfig.md) 对象必需：否 ** solutionVersionArn ** 解决方案版本的 ARN。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** status ** 解决方案版本的状态。解决方案版本可以处于下列状态之一： + CREATE PENDING + CREATE IN\$1PROGRESS + ACTIVE + CREATE FAILED + CREATE STOPPING + CREATE STOPPED 类型：字符串长度约束：最大长度为 256。必需：否 ** trainingHours ** 用于训练模型的时间。您需要为训练模型所花费的时间付费。只有在 Amazon Personalize 成功训练模型之后，才会显示此字段。类型：双精度有效范围：最小值为 0。必需：否 ** trainingMode ** 创建解决方案版本时要执行的训练的范围。`FULL` 训练会考虑数据集组中的所有数据。`UPDATE` 仅处理自上次训练以来发生变化的数据。只有通过 User-Personalization 配方创建的解决方案版本才能使用 `UPDATE`。类型：字符串有效值：`FULL | UPDATE | AUTOTRAIN` 必需：否 ** trainingType ** 解决方案版本是自动创建还是手动创建。类型：字符串有效值：`AUTOMATIC | MANUAL` 必需：否 ** tunedHPOParams ** 如果执行了超参数优化，则包含性能最佳模型的超参数值。类型：[TunedHPOParams](API_TunedHPOParams.md) 对象必需：否 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWSSDKs，请参阅以下内容： + [AWS适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/SolutionVersion) + [AWS适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/SolutionVersion) + [AWS适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/SolutionVersion) # SolutionVersionSummary 提供解决方案版本的属性摘要。如需完整列表，请调用 [DescribeSolutionVersion](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html) API。 ## 目录 ** creationDateTime ** 创建此版解决方案的日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** failureReason ** 如果解决方案版本失败，则为其原因。类型：字符串必需：否 ** lastUpdatedDateTime ** 上次更新解决方案版本的日期和时间（采用 Unix 时间）。类型：时间戳必需：否 ** solutionVersionArn ** 解决方案版本的 Amazon 资源名称 (ARN)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** status ** 解决方案版本的状态。解决方案版本可以处于下列状态之一： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE - 或 - CREATE FAILED 类型：字符串长度约束：最大长度为 256。必需：否 ** trainingMode ** 创建解决方案版本时要执行的训练的范围。`FULL` 训练会考虑数据集组中的所有数据。`UPDATE` 仅处理自上次训练以来发生变化的数据。只有通过 User-Personalization 配方创建的解决方案版本才能使用 `UPDATE`。类型：字符串有效值：`FULL | UPDATE | AUTOTRAIN` 必需：否 ** trainingType ** 解决方案版本是自动创建还是手动创建。类型：字符串有效值：`AUTOMATIC | MANUAL` 必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/SolutionVersionSummary) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/SolutionVersionSummary) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/SolutionVersionSummary) # Tag 您应用于资源以帮助您对其进行分类和组织的可选元数据。每个标签都包含定义的一个键和一个可选值。有关更多信息，请参阅[标记 Amazon Personalize 资源](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)。 ## 目录 ** tagKey ** 构成标签的键-值对的一个部分。键是一种常见的标签，行为类似于更具体的标签值的类别。类型：字符串长度限制：长度下限为 1。最大长度为 128。模式：`^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$` 必需：是 ** tagValue ** 构成标签的键-值对的可选部分。值充当标签类别（键）中的描述符。类型：字符串长度约束：最小长度为 0。最大长度为 256。模式：`^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$` 必需：是 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Tag) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/Tag) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/Tag) # ThemeGenerationConfig 使用批量推理作业生成主题的配置详细信息。 ## 目录 ** fieldsForThemeGeneration ** 用于为批量推理作业生成描述性主题的字段。类型：[FieldsForThemeGeneration](API_FieldsForThemeGeneration.md) 对象必需：是 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ThemeGenerationConfig) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ThemeGenerationConfig) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ThemeGenerationConfig) # TrainingDataConfig 创建域推荐器或自定义解决方案版本（经过训练的模型）时要使用的训练数据配置。 ## 内容 ** excludedDatasetColumns ** 指定要从训练中排除的列。每个键都是一个数据集类型，每个值都是一个列列表。排除列以控制 Amazon Personalize 使用哪些数据生成建议。例如，可能有一列，您只想将其用来筛选建议。您可以将此列排除在训练之外，Amazon Personalize 只有在筛选时才会考虑该列。类型：字符串到字符串数组映射映射条目：最多 3 项。密钥长度限制：最大长度为 256。键模式：`^[A-Za-z_]+$` 数组成员：最多 50 项。长度限制：最大长度为 150。模式：`[A-Za-z_][A-Za-z\d_]*` 必需：否 ** includedDatasetColumns ** 指定训练中要包含的列。每个键都是一个数据集类型，每个值都是一个列列表。包括用于控制 Amazon Personalize 使用哪些数据生成推荐的列。例如，您的项目数据集中可能有多列，但只想使用标题和描述进行训练。您只能将这两列包含在培训中，Amazon Personalize 将仅考虑培训中包含的列。类型：字符串到字符串数组映射映射条目：最多 3 项。密钥长度限制：最大长度为 256。键模式：`^[A-Za-z_]+$` 数组成员：最多 50 项。长度限制：最大长度为 150。模式：`[A-Za-z_][A-Za-z\d_]*` 必需：否 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWSSDKs，请参阅以下内容： + [AWS适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/TrainingDataConfig) + [AWS适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/TrainingDataConfig) + [AWS适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/TrainingDataConfig) # TunedHPOParams 如果执行了超参数优化 (HPO)，则包含性能最佳模型的超参数值。 ## 目录 ** algorithmHyperParameters ** 性能最佳模型的超参数值列表。类型：字符串到字符串映射映射条目：最多 100 项。键长度限制：最大长度为 256。值长度限制：最大长度为 1000。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/TunedHPOParams) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/TunedHPOParams) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/TunedHPOParams) # Amazon Personalize Events Amazon Personalize Events 支持以下数据类型： + [Action](API_UBS_Action.md) + [ActionInteraction](API_UBS_ActionInteraction.md) + [Event](API_UBS_Event.md) + [Item](API_UBS_Item.md) + [MetricAttribution](API_UBS_MetricAttribution.md) + [User](API_UBS_User.md) # Action 表示使用 `PutActions` API 添加到操作数据集的操作元数据。有关更多信息，请参阅[单独导入操作](https://docs.aws.amazon.com/personalize/latest/dg/importing-actions.html)。 ## 目录 ** actionId ** 与操作关联的 ID。类型：字符串长度限制：最小长度为 1。最大长度为 256。必需：是 ** properties ** 操作特定的元数据的字符串映射。映射中的每个元素都由一个键值对组成。例如 `{"value": "100"}`。键使用与操作数据集架构中的字段匹配的采用驼峰式大小写的名称。在前面的示例中，`value` 与在操作架构中定义的“VALUE”字段相匹配。对于分类字符串数据，要包含单个操作的多个类别，请使用竖线分隔符 (`|`) 分隔每个类别。例如 `\"Deluxe|Premium\"`。类型：字符串长度限制：最小长度为 1。最大长度为 32000。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/Action) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/Action) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/Action) # ActionInteraction 表示使用 `PutActionInteractions` API 发送的操作交互事件。 ## 目录 ** actionId ** 用户与其交互的操作的 ID。这与操作交互架构的 `ACTION_ID` 字段相对应。类型：字符串长度限制：最小长度为 1。最大长度为 256。必需：是 ** eventType ** 操作交互事件的类型。您可以指定 `Viewed`、`Taken` 和 `Not Taken` 事件类型。有关操作交互事件类型数据的更多信息，请参阅[事件类型数据](https://docs.aws.amazon.com/personalize/latest/dg/action-interaction-event-type-data.html)。类型：字符串长度限制：最小长度为 1。最大长度为 256。必需：是 ** sessionId ** 与用户的访问关联的 ID。当用户首次访问您的网站或使用您的应用程序时，您的应用程序会生成唯一 `sessionId`。类型：字符串长度限制：最小长度为 1。最大长度为 256。必需：是 ** timestamp ** 操作交互事件发生时的时间戳。时间戳必须采用 Unix 纪元时间格式，以秒为单位。类型：时间戳必需：是 ** eventId ** 与事件关联的 ID。如果未提供事件 ID，则 Amazon Personalize 会为事件生成一个唯一的 ID。事件 ID 不用作模型的输入。Amazon Personalize 使用事件 ID 来区分唯一事件。模型训练中不使用第一个事件之后具有相同事件 ID 的任何后续事件。类型：字符串长度限制：最小长度为 1。最大长度为 256。必需：否 ** impression ** 操作 ID 列表，表示您已向用户展示的操作的顺序。例如 `["actionId1", "actionId2", "actionId3"]`。Amazon Personalize 不使用来自操作交互事件的展示数据。而是为每个操作记录多个事件并使用 `Viewed` 事件类型。类型：字符串数组数组成员：最少 1 个物品。最多 25 项。长度限制：最小长度为 1。最大长度为 256。必需：否 ** properties ** 您可以选择记录的事件特定数据的字符串映射。例如，如果用户采取了除操作 ID 以外的操作，您可能还会发送该用户采取的操作数量。映射中的每个物品都由一个键值对组成。例如， `{"numberOfActions": "12"}` 键使用与操作交互架构中的字段匹配的采用驼峰式大小写的名称。在上面的示例中，`numberOfActions` 将匹配在操作交互架构中定义的“NUMBER\$1OF\$1ACTIONS”字段。以下内容不能作为属性的关键字包括在内（不区分大小写）。 + userId + sessionId + eventType + timestamp + recommendationId + impression 类型：字符串长度限制：长度下限为 1。最大长度为 1024。必需：否 ** recommendationId ** 包含用户与之交互的操作的建议列表的 ID。类型：字符串长度限制：长度下限为 1。最大长度为 40。必需：否 ** userId ** 与操作交互的用户的 ID。这与操作交互架构的 `USER_ID` 字段相对应。类型：字符串长度限制：最小长度为 1。最大长度为 256。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/ActionInteraction) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/ActionInteraction) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/ActionInteraction) # Event 表示使用 `PutEvents` API 发送的物品交互事件信息。 ## 目录 ** eventType ** 事件的类型，例如单击或下载。此属性对应于物品交互数据集架构的 `EVENT_TYPE` 字段，并取决于您要跟踪的事件类型。类型：字符串长度限制：最小长度为 1。最大长度为 256。必需：是 ** sentAt ** 事件发生时客户端的时间戳（采用 Unix 时间）。类型：时间戳必需：是 ** eventId ** 与事件关联的 ID。如果未提供事件 ID，则 Amazon Personalize 会为事件生成一个唯一的 ID。事件 ID 不用作模型的输入。Amazon Personalize 使用事件 ID 来区分唯一事件。模型训练中不使用第一个事件之后具有相同事件 ID 的任何后续事件。类型：字符串长度限制：最小长度为 1。最大长度为 256。必需：否 ** eventValue ** 与物品交互架构的 `EVENT_VALUE` 字段对应的事件值。类型：浮点值必需：否 ** impression ** 物品 ID 列表，代表您向用户展示的物品顺序。例如 `["itemId1", "itemId2", "itemId3"]`。提供物品列表以手动记录事件的展示数据。有关记录展示数据的更多信息，请参阅[记录展示数据](https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html#putevents-including-impressions-data)。类型：字符串数组数组成员：最少 1 个物品。最多 25 项。长度限制：最小长度为 1。最大长度为 256。必需：否 ** itemId ** 与物品交互数据集的架构中的 `ITEM_ID` 字段对应的物品 ID 键。类型：字符串长度限制：最小长度为 1。最大长度为 256。必需：否 ** metricAttribution ** 包含与事件关联的指标归因的相关信息。有关指标归因的更多信息，请参阅[衡量建议的影响](https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html)。类型：[MetricAttribution](API_UBS_MetricAttribution.md) 对象必需：否 ** properties ** 您可以选择记录的事件特定数据的字符串映射。例如，如果用户在您的网站上对电影进行评分，则除了电影 ID (`itemId`) 和评分 (`eventValue`) 外，您还可以发送该用户对电影做出的评分数量。映射中的每个物品都由一个键值对组成。例如， `{"numberOfRatings": "12"}` 键使用与物品交互数据集架构中的字段匹配的采用驼峰式大小写的名称。在上面的示例中，`numberOfRatings` 将匹配在物品交互数据集的架构中定义的“NUMBER\$1OF\$1RATINGS”字段。以下内容不能作为属性的关键字包括在内（不区分大小写）。 + userId + sessionId + eventType + timestamp + recommendationId + impression 类型：字符串长度限制：长度下限为 1。最大长度为 1024。必需：否 ** recommendationId ** 包含用户与之交互的物品的建议列表的 ID。提供 `recommendationId`，让 Amazon Personalize 隐式记录您向用户展示的建议作为展示数据。或者，在您使用指标归因来衡量建议的影响时，提供 `recommendationId`。有关记录展示数据的更多信息，请参阅[记录展示数据](https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html#putevents-including-impressions-data)。有关创建指标归因的更多信息，请参阅[衡量建议的影响](https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html)。类型：字符串长度限制：长度下限为 1。最大长度为 40。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/Event) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/Event) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/Event) # Item 表示使用 `PutItems` API 添加到物品数据集的物品元数据。有关更多信息，请参阅[单独导入物品](https://docs.aws.amazon.com/personalize/latest/dg/importing-items.html)。 ## 目录 ** itemId ** 与物品关联的 ID。类型：字符串长度限制：最小长度为 1。最大长度为 256。必需：是 ** properties ** 特定于物品的元数据的字符串映射。映射中的每个元素都由一个键值对组成。例如 `{"numberOfRatings": "12"}`。键使用与物品数据集架构中的字段匹配的采用驼峰式大小写的名称。在前面的示例中，`numberOfRatings` 将匹配物品架构中定义的“NUMBER\$1OF\$1RATINGS”字段。对于分类字符串数据，要包含单个物品的多个类别，请使用竖线分隔符 (`|`) 分隔每个类别。例如 `\"Horror|Action\"`。类型：字符串长度限制：最小长度为 1。最大长度为 32000。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/Item) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/Item) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/Item) # MetricAttribution 包含与事件关联的指标归因的相关信息。有关指标归因的更多信息，请参阅[衡量建议的影响](https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html)。 ## 目录 ** eventAttributionSource ** 事件的源，例如第三方。类型：字符串长度限制：最大长度为 1024。模式：`^[\x20-\x7E]*[\x21-\x7E]+[\x20-\x7E]*$` 必需：是 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/MetricAttribution) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/MetricAttribution) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/MetricAttribution) # User 表示使用 `PutUsers` API 添加到用户数据集的用户元数据。有关更多信息，请参阅[单独导入用户](https://docs.aws.amazon.com/personalize/latest/dg/importing-users.html)。 ## 目录 ** userId ** 与用户关联的 ID。类型：字符串长度限制：最小长度为 1。最大长度为 256。必需：是 ** properties ** 用户特定元数据的字符串映射。映射中的每个元素都由一个键值对组成。例如 `{"numberOfVideosWatched": "45"}`。键使用与用户数据集架构中的字段匹配的采用驼峰式大小写的名称。在前面的示例中，`numberOfVideosWatched` 将匹配用户架构中定义的“NUMBER\$1OF\$1VIDEOS\$1WATCHED”字段。对于分类字符串数据，要包含单个用户的多个类别，请使用竖线分隔符 (`|`) 分隔每个类别。例如 `\"Member|Frequent shopper\"`。类型：字符串长度限制：长度下限为 1。最大长度为 24000。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/User) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/User) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/User) # Amazon Personalize Runtime Amazon Personalize Runtime 支持以下数据类型： + [PredictedAction](API_RS_PredictedAction.md) + [PredictedItem](API_RS_PredictedItem.md) + [Promotion](API_RS_Promotion.md) # PredictedAction 标识操作的对象。 [GetActionRecommendations](API_RS_GetActionRecommendations.md) API 返回 `PredictedAction` 的列表。 ## 目录 ** actionId ** 建议操作的 ID。类型：字符串长度约束：最大长度为 256。必需：否 ** score ** 建议操作的分数。有关操作分数的信息，请参阅[操作建议评分的工作原理](https://docs.aws.amazon.com/personalize/latest/dg/how-action-recommendation-scoring-works.html)。类型：双精度必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-runtime-2018-05-22/PredictedAction) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-runtime-2018-05-22/PredictedAction) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-runtime-2018-05-22/PredictedAction) # PredictedItem 标识物品的对象。 [GetRecommendations](API_RS_GetRecommendations.md) 和 [GetPersonalizedRanking](API_RS_GetPersonalizedRanking.md) API 会返回 `PredictedItem` 的列表。 ## 目录 ** itemId ** 推荐的物品 ID。类型：字符串长度约束：最大长度为 256。必需：否 ** metadata ** 有关物品数据集中的物品的元数据。类型：字符串到字符串映射键长度限制：最大长度为 150。值长度限制：最大长度为 20000。必需：否 ** promotionName ** 包含预测物品的推广名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必需：否 ** reason ** 如果您使用 User-Personalization-v2，则会有一份理由清单，说明为什么在推荐中包括该物品。可能的原因包括： + 推广物品 - 表示您在推荐请求中应用的推广活动中包括该物品。 + 浏览 - 表示该物品包括在浏览中。使用浏览时，推荐包括的物品具有更少的交互数据或用户相关性。有关浏览的更多信息，请参阅[浏览](https://docs.aws.amazon.com/personalize/latest/dg/use-case-recipe-features.html#about-exploration)。 + 热门物品 - 表示该物品作为占位符热门物品包括在内。如果您使用筛选条件，那么根据筛选条件删除的推荐数量，Amazon Personalize 可能会添加占位符物品以满足推荐请求的 `numResults`。这些物品是基于交互数据的热门物品，符合您的筛选条件。它们没有针对用户的相关性评分。类型：字符串数组长度约束：最大长度为 256。必需：否 ** score ** 模型对物品将成为下一个用户选择的确定性的数字表示。有关评分逻辑的更多信息，请参阅[建议分数](getting-recommendations.md#how-scores-work)。类型：双精度必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-runtime-2018-05-22/PredictedItem) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-runtime-2018-05-22/PredictedItem) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-runtime-2018-05-22/PredictedItem) # Promotion 包含有关推广的信息。推广定义了其他业务规则，这些规则适用于可配置的建议物品子集。 ## 目录 ** filterArn ** 推广使用的筛选器的 Amazon 资源名称 (ARN)。此筛选器定义了推广物品的标准。有关更多信息，请参阅[推广筛选器](https://docs.aws.amazon.com/personalize/latest/dg/promoting-items.html#promotion-filters)。类型：字符串长度约束：最大长度为 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必需：否 ** filterValues ** 推广物品时要使用的值。对于推广的筛选器表达式中的每个占位符参数，提供参数名称（大小写相符）作为键，提供筛选器值作为对应的值。用英文逗号分隔一个参数的多个值。对于使用 `INCLUDE` 元素来包含物品的筛选器表达式，您必须为表达式中定义的所有参数提供值。对于带有使用 `EXCLUDE` 元素排除物品的表达式的筛选器，您可以省略 `filter-values`。在本例中，Amazon Personalize 未使用表达式的这一部分来筛选建议。有关创建筛选器的更多信息，请参阅[筛选建议和用户细分](https://docs.aws.amazon.com/personalize/latest/dg/filter.html)。类型：字符串到字符串映射映射条目：最多 25 项。键长度限制：最大长度为 50。键模式：`[A-Za-z0-9_]+` 值长度限制：最大长度为 1000。必需：否 ** name ** 推广的名称。类型：字符串长度限制：最小长度为 1。最大长度为 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必需：否 ** percentPromotedItems ** 要应用推广的推荐物品所占的百分比。类型：整数有效范围：最小值为 1。最大值为 100。必需：否 ## 另请参阅有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-runtime-2018-05-22/Promotion) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-runtime-2018-05-22/Promotion) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-runtime-2018-05-22/Promotion) # 常见错误本部分列出了所有 AWS 服务的常见 API 操作错误。对于特定于此服务的 API 操作的错误，请参阅该 API 操作的主题。 **AccessDeniedException** 您没有足够的访问权限，无法执行该操作。 HTTP 状态代码：400 **IncompleteSignature** 请求签名不符合 AWS 标准。 HTTP 状态代码：400 **InternalFailure** 由于未知错误、异常或故障，请求处理失败。 HTTP 状态代码：500 **InvalidAction** 所请求的操作无效。确认正确键入了操作。 HTTP 状态代码：400 **InvalidClientTokenId** 在我们的记录中没有所提供的 X.509 证书或 AWS 访问密钥 ID。 HTTP 状态代码：403 **NotAuthorized** 您无权执行此操作。 HTTP 状态代码：400 **OptInRequired** AWS 访问密钥 ID 需要订阅服务。 HTTP 状态代码：403 **RequestExpired** 请求到达服务的时间超过请求上的日期戳 15 分钟或超过请求到期日期 15 分钟（例如，对于预签名 URL），或者请求上的日期戳比当前时间晚了 15 分钟以上。 HTTP 状态代码：400 **ServiceUnavailable** 由于服务器发生临时故障而导致请求失败。 HTTP 状态代码：503 **ThrottlingException** 由于请求限制而导致请求被拒绝。 HTTP 状态代码：400 **ValidationError** 输入未能满足 AWS 服务指定的约束。 HTTP 状态代码：400 # 常见参数以下列表包含所有操作用于使用查询字符串对 Signature Version 4 请求进行签名的参数。任何特定于操作的参数都列在该操作的主题中。有关签名版本 4 的更多信息，请参阅 I *AM 用户指南*中的[签署 AWS API 请求](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html)。 **X-Amz-Algorithm** 您用于创建请求签名的哈希算法。条件：当您在查询字符串中而不是 HTTP 授权标头中包括身份验证信息时，请指定此参数。类型：字符串有效值：`AWS4-HMAC-SHA256` 必需：条件 **X-Amz-Credential** 凭证范围值，该值是一个字符串，其中包含您的访问密钥、日期、您要定位的区域、您请求的服务以及终止字符串（“aws4\$1request”）。值采用以下格式表示：*access\$1key*/*YYYYMMDD*/*region*/*service*/aws4\$1request。有关更多信息，请参阅 I *AM 用户指南*中的[创建已签名的 AWS API 请求](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html)。条件：当您在查询字符串中而不是 HTTP 授权标头中包括身份验证信息时，请指定此参数。类型：字符串必需：条件 **X-Amz-Date** 用于创建签名的日期。格式必须为 ISO 8601 基本格式 (YYYYMMDD'T'HHMMSS'Z')。例如，以下日期时间是有效 X-Amz-Date值：`20120325T120000Z`。条件： X-Amz-Date 对所有请求而言是可选的；它可以用于覆盖对请求签名所使用的日期。如果日期标题以 ISO 8601 基本格式指定，则 X-Amz-Date不是必填项。使用 X-Amz-Date时，它总是会覆盖 Date 标题的值。有关更多信息，请参阅 I *AM 用户指南*中的 [AWS API 请求签名元素](https://docs.aws.amazon.com/IAM/latest/UserGuide/signing-elements.html)。类型：字符串必需：条件 **X-Amz-Security-Token** 通过调用 AWS Security Token Service (AWS STS) 获得的临时安全令牌。有关支持来自 AWS STS的临时安全凭证的服务列表，请参阅《IAM 用户指南》**中的[使用 IAM 的AWS 服务](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html)。条件：如果您使用的是中的临时安全证书 AWS STS，则必须包含安全令牌。类型：字符串必需：条件 **X-Amz-Signature** 指定从要签名的字符串和派生的签名密钥计算的十六进制编码签名。条件：当您在查询字符串中而不是 HTTP 授权标头中包括身份验证信息时，请指定此参数。类型：字符串必需：条件 **X-Amz-SignedHeaders** 指定作为规范请求的一部分包含的所有 HTTP 标头。有关指定签名标头的更多信息，请参阅 I *AM 用户指南*中的[创建已签名的 AWS API 请求](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html)。条件：当您在查询字符串中而不是 HTTP 授权标头中包括身份验证信息时，请指定此参数。类型：字符串必需：条件