本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。 # 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 執行期支援下列動作： + [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) 如果您使用類似項目配方，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 Identity and Access Management 角色的 ARN，具有分別讀取和寫入輸入和輸出 Amazon S3 儲存貯體的許可。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` 必要：是 ** [solutionVersionArn](#API_CreateBatchInferenceJob_RequestSyntax) ** 解決方案版本的 Amazon Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateBatchInferenceJob) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateBatchInferenceJob) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateBatchInferenceJob) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateBatchInferenceJob) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateBatchInferenceJob) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateBatchInferenceJob) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateBatchInferenceJob) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateBatchInferenceJob) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateBatchInferenceJob) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateBatchInferenceJob) # CreateBatchSegmentJob 建立批次區段任務。操作最多可處理 5，000 萬筆記錄，且輸入檔案必須為 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 Identity and Access Management 角色的 ARN，具有分別讀取和寫入輸入和輸出 Amazon S3 儲存貯體的許可。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` 必要：是 ** [solutionVersionArn](#API_CreateBatchSegmentJob_RequestSyntax) ** 您希望批次區段任務用來產生批次區段的解決方案版本的 Amazon Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateBatchSegmentJob) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateBatchSegmentJob) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateBatchSegmentJob) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateBatchSegmentJob) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateBatchSegmentJob) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateBatchSegmentJob) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateBatchSegmentJob) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateBatchSegmentJob) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateBatchSegmentJob) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateBatchSegmentJob) # CreateCampaign **重要** 您在活動期間會產生行銷活動成本。為了避免不必要的成本，請務必在完成時刪除行銷活動。如需行銷活動成本的資訊，請參閱 [Amazon Personalize 定價](https://aws.amazon.com/personalize/pricing/)。建立部署解決方案版本的行銷活動。當用戶端呼叫 [GetRecommendations](https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) 和 [GetPersonalizedRanking](https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetPersonalizedRanking.html) APIs時，會在請求中指定行銷活動。 **最小佈建 TPS 和自動擴展** **重要** 較高的 `minProvisionedTPS`會增加您的成本。我們建議從 1 開始 `minProvisionedTPS`（預設值）。使用 Amazon CloudWatch 指標追蹤您的用量，並視需要增加 `minProvisionedTPS`。當您建立 Amazon Personalize 行銷活動時，您可以指定行銷活動的每秒最低佈建交易數 (`minProvisionedTPS`)。這是 Amazon Personalize 佈建之行銷活動的基準交易輸送量。它會設定行銷活動在作用中時的最低帳單費用。交易是單一 `GetRecommendations`或 `GetPersonalizedRanking`請求。預設值`minProvisionedTPS`為 1。如果您的 TPS 增加超過 `minProvisionedTPS`，Amazon Personalize 會自動擴展和縮減佈建的容量，但絕不會低於 `minProvisionedTPS`。當容量增加時，會發生短暫的延遲，這可能會導致交易遺失。當您的流量減少時，容量會返回 `minProvisionedTPS`。您需要支付最低佈建 TPS 的費用，或者，如果您的請求超過 `minProvisionedTPS`，則為實際 TPS。實際 TPS 是您提出的建議請求總數。我們建議您從較低的開始`minProvisionedTPS`，使用 Amazon CloudWatch 指標追蹤您的用量，然後`minProvisionedTPS`視需要增加。如需行銷活動成本的詳細資訊，請參閱 [Amazon Personalize 定價](https://aws.amazon.com/personalize/pricing/)。 **狀態** 行銷活動可以處於下列其中一種狀態： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED + DELETE PENDING > DELETE IN\$1PROGRESS 若要取得行銷活動狀態，請呼叫 [DescribeCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html)。 **注意** 請等到行銷活動`status`的變成，`ACTIVE`再向行銷活動要求建議。 **相關 API** + [ListCampaigns](https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html) + [DescribeCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html) + [UpdateCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateCampaign.html) + [DeleteCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteCampaign.html) ## 請求語法 ``` { "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 Resource Name (ARN)。若要指定解決方案的最新解決方案版本，請以 `SolutionArn/$LATEST` 格式指定*解決方案*的 ARN。如果您在 [CampaignConfig](https://docs.aws.amazon.com/personalize/latest/dg/API_CampaignConfig.html) `True`中`syncWithLatestSolutionVersion`將設定為，則必須使用此格式。若要部署不是解決方案最新版本的模型，請指定解決方案版本的 ARN。如需自動行銷活動更新的詳細資訊，請參閱[啟用自動行銷活動更新](https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-automatic-latest-sv-update)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：是 ** [tags](#API_CreateCampaign_RequestSyntax) ** 要套用至行銷活動的[標籤](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 Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateCampaign) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateCampaign) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateCampaign) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateCampaign) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateCampaign) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateCampaign) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateCampaign) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateCampaign) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateCampaign) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateCampaign) # CreateDataDeletionJob 建立批次任務，以批次刪除 Amazon Personalize 資料集群組中對特定使用者的所有參考。您可以在 Amazon S3 儲存貯體的 userIds CSV 檔案中指定要刪除的使用者。任務完成後，Amazon Personalize 不會再針對使用者的資料進行訓練，也不會在產生使用者客群時考慮使用者。如需建立資料刪除任務的詳細資訊，請參閱[刪除使用者](https://docs.aws.amazon.com/personalize/latest/dg/delete-records.html)。 + 您的輸入檔案必須是 CSV 檔案，其中包含列出使用者 IDs的單一 USER\$1ID 資料欄。如需準備 CSV 檔案的詳細資訊，請參閱[準備資料刪除檔案並將其上傳至 Amazon S3](https://docs.aws.amazon.com/personalize/latest/dg/prepare-deletion-input-file.html)。 + 若要授予 Amazon Personalize 存取 userIds 輸入 CSV 檔案的許可，您必須指定具有從資料來源讀取許可的 IAM 服務角色。此角色需要儲存貯體`GetObject`及其內容的和`ListBucket`許可。這些許可與匯入資料相同。如需有關授予 Amazon S3 儲存貯體存取權的資訊，請參閱[授予 Amazon Personalize 存取權給 Amazon S3 資源](https://docs.aws.amazon.com/personalize/latest/dg/granting-personalize-s3-access.html)。建立任務後，最多可能需要一天的時間，才能從資料集和模型中刪除對使用者的所有參考。在任務完成之前，Amazon Personalize 會在訓練時繼續使用資料。如果您使用使用者區段配方，使用者可能會出現在使用者區段中。 **狀態** 資料刪除任務可以有下列其中一種狀態： + 待定 > IN\$1PROGRESS > COMPLETED -or- FAILED 若要取得資料刪除任務的狀態，請呼叫 [DescribeDataDeletionJob](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataDeletionJob.html) API 操作，並指定任務的 Amazon Resource Name (ARN)。如果狀態為 FAILED，回應會包含`failureReason`金鑰，說明任務失敗的原因。 **相關 API** + [ListDataDeletionJobs](https://docs.aws.amazon.com/personalize/latest/dg/API_ListDataDeletionJobs.html) + [DescribeDataDeletionJob](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataDeletionJob.html) ## 請求語法 ``` { "datasetGroupArn": "string", "dataSource": { "dataLocation": "string" }, "jobName": "string", "roleArn": "string", "tags": [ { "tagKey": "string", "tagValue": "string" } ] } ``` ## 請求參數請求接受採用 JSON 格式的下列資料。 ** [datasetGroupArn](#API_CreateDataDeletionJob_RequestSyntax) ** 具有您要從中刪除記錄之資料集的資料集群組的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：是 ** [dataSource](#API_CreateDataDeletionJob_RequestSyntax) ** 包含要刪除之使用者 userIds清單的 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 Resource Name (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 Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateDataDeletionJob) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateDataDeletionJob) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateDataDeletionJob) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateDataDeletionJob) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateDataDeletionJob) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateDataDeletionJob) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateDataDeletionJob) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateDataDeletionJob) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateDataDeletionJob) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateDataDeletionJob) # CreateDataset 建立空白資料集，並將其新增至指定的資料集群組。使用 [CreateDatasetImportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html) 來將訓練資料匯入資料集。資料集有 5 種類型： + 項目互動 + 項目 + 使用者 + 動作互動 + 動作每種資料集類型都具有必要欄位類型的相關聯結構描述。若要訓練模型 (也稱為建立解決方案)，僅需要 `Item interactions` 資料集即可。資料集可為下列任一種狀態： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED + DELETE PENDING > DELETE IN\$1PROGRESS 若要取得資料集的狀態，請呼叫 [DescribeDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html)。 **相關 API** + [CreateDatasetGroup](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html) + [ListDatasets](https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasets.html) + [DescribeDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html) + [DeleteDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteDataset.html) ## 請求語法 ``` { "datasetGroupArn": "string", "datasetType": "string", "name": "string", "schemaArn": "string", "tags": [ { "tagKey": "string", "tagValue": "string" } ] } ``` ## 請求參數請求接受採用 JSON 格式的下列資料。 ** [datasetGroupArn](#API_CreateDataset_RequestSyntax) ** 要新增資料集之資料集群組的 Amazon Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateDataset) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateDataset) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateDataset) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateDataset) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateDataset) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateDataset) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateDataset) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateDataset) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateDataset) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateDataset) # CreateDatasetExportJob 建立任務，將資料從資料集匯出至 Amazon S3 儲存貯體。若要允許 Amazon Personalize 匯出訓練資料，您必須指定服務連結 IAM 角色，為 Amazon S3 儲存貯體提供 Amazon Personalize `PutObject`許可。如需詳細資訊，請參閱《Amazon Personalize 開發人員指南》中的[匯出資料集](https://docs.aws.amazon.com/personalize/latest/dg/export-data.html)。 **狀態** 資料集匯出任務可以處於下列其中一種狀態： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED 若要取得匯出任務的狀態，請呼叫 [DescribeDatasetExportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetExportJob.html)，並指定資料集匯出任務的 Amazon Resource Name (ARN)。當狀態顯示為 ACTIVE 時，資料集匯出即完成。如果狀態顯示為 CREATE FAILED，回應會包含`failureReason`金鑰，說明任務失敗的原因。 ## 請求語法 ``` { "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 Resource Name (ARN)，其中包含要匯出的資料。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：是 ** [ingestionMode](#API_CreateDatasetExportJob_RequestSyntax) ** 根據您匯入資料的方式，要匯出的資料。您可以選擇只匯出使用資料集匯入任務匯入`BULK`的資料，只匯出增量匯入`PUT`的資料（使用主控台、PutEvents、PutUsers 和 PutItems 操作），或`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) ** IAM 服務角色的 Amazon Resource Name (ARN)，其具有將資料新增至輸出 Amazon S3 儲存貯體的許可。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` 必要：是 ** [tags](#API_CreateDatasetExportJob_RequestSyntax) ** 要套用至資料集匯出任務的[標籤](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 Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateDatasetExportJob) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateDatasetExportJob) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateDatasetExportJob) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateDatasetExportJob) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateDatasetExportJob) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateDatasetExportJob) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateDatasetExportJob) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateDatasetExportJob) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateDatasetExportJob) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateDatasetExportJob) # CreateDatasetGroup 建立空的資料集群組。資料集群組是 Amazon Personalize 資源的容器。資料集群組最多可包含三個資料集，每種資料集各一個： + 項目互動 + 項目 + 使用者 + 動作 + 動作互動資料集群組可以是網域資料集群組，您可以在其中指定網域，並使用預先設定的資源，例如推薦者，或是自訂資料集群組，您可以在其中使用自訂資源，例如搭配解決方案版本的解決方案，以行銷活動部署。如果您從網域資料集群組開始，您仍然可以新增自訂資源，例如使用自訂使用案例配方訓練並使用行銷活動部署的解決方案和解決方案版本。資料集群組可以處於下列其中一種狀態： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED + 刪除擱置中若要取得資料集群組的狀態，請呼叫 [DescribeDatasetGroup](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetGroup.html)。如果狀態顯示為 CREATE FAILED，回應會包含`failureReason`金鑰，說明建立失敗的原因。 **注意** 您必須等到資料集群組`status`的為，`ACTIVE`再將資料集新增至群組。您可以指定 AWS Key Management Service (KMS) 金鑰來加密群組中的資料集。如果您指定 KMS 金鑰，您還 AWS Identity and Access Management 必須包含具有存取金鑰許可的 (IAM) 角色。 **請求中需要資料集群組 ARN 的 APIs** + [CreateDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html) + [CreateEventTracker](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html) + [CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) **相關 API** + [ListDatasetGroups](https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasetGroups.html) + [DescribeDatasetGroup](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetGroup.html) + [DeleteDatasetGroup](https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteDatasetGroup.html) ## 請求語法 ``` { "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) ** 用來加密資料集之 a(KMS) 金鑰的 Amazon Resource Name 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) ** 具有存取 AWS Identity and Access Management (KMS) 金鑰許可的 AWS Key Management Service (IAM) 角色 ARN。只有在同時指定 KMS 金鑰時，提供 IAM 角色才有效。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` 必要：否 ** [tags](#API_CreateDatasetGroup_RequestSyntax) ** 要套用至資料集群組的[標籤](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 Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateDatasetGroup) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateDatasetGroup) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateDatasetGroup) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateDatasetGroup) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateDatasetGroup) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateDatasetGroup) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateDatasetGroup) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateDatasetGroup) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateDatasetGroup) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateDatasetGroup) # CreateDatasetImportJob 建立將訓練資料從資料來源 (Amazon S3 儲存貯體）匯入 Amazon Personalize 資料集的任務。若要允許 Amazon Personalize 匯入訓練資料，您必須指定具有從資料來源讀取許可的 IAM 服務角色，因為 Amazon Personalize 會複製您的資料並在內部處理。如需授予 Amazon S3 儲存貯體存取權的資訊，請參閱[授予 Amazon Personalize 存取權給 Amazon S3 資源](https://docs.aws.amazon.com/personalize/latest/dg/granting-personalize-s3-access.html)。如果您已使用行銷活動建立推薦者或部署自訂解決方案版本，新的大量記錄如何影響建議取決於您使用的網域使用案例或配方。如需詳細資訊，請參閱[新資料如何影響即時建議](https://docs.aws.amazon.com/personalize/latest/dg/how-new-data-influences-recommendations.html)。 **重要** 根據預設，資料集匯入任務會取代您大量匯入的資料集中的任何現有資料。若要在不取代現有資料的情況下新增記錄，請在 CreateDatasetImportJob 操作中為匯入模式指定 INCREMENTAL。 **狀態** 資料集匯入任務可處於下列任意一種狀態： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED 若要取得匯入任務的狀態，請呼叫 [DescribeDatasetImportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetImportJob.html)，並提供資料集匯入任務的 Amazon Resource Name (ARN)。當狀態顯示為 ACTIVE 時，即表示資料集匯入完成。如果狀態顯示為 CREATE FAILED，回應會包含`failureReason`金鑰，說明任務失敗的原因。 **注意** 匯入需要一些時間。您必須等到狀態顯示為 ACTIVE，才能使用資料集訓練模型。 **相關 API** + [ListDatasetImportJobs](https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasetImportJobs.html) + [DescribeDatasetImportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetImportJob.html) ## 請求語法 ``` { "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) ** 此為 IAM 角色的 ARN，該角色具有從 Amazon S3 資料來源讀取資料的許可。類型：字串長度限制：長度上限為 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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateDatasetImportJob) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateDatasetImportJob) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateDatasetImportJob) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateDatasetImportJob) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateDatasetImportJob) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateDatasetImportJob) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateDatasetImportJob) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateDatasetImportJob) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateDatasetImportJob) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateDatasetImportJob) # CreateEventTracker 建立使用 [PutEvents](https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html) API 將事件資料新增至指定資料集群組時所使用的事件追蹤器。 **注意** 一個事件追蹤器僅能與一個資料集群組建立關聯。如果使用與現有事件追蹤器相同的資料集群組來呼叫 `CreateEventTracker`，您將會收到錯誤。當您建立事件追蹤器時，回應會包含追蹤 ID，您可以在使用 [PutEvents](https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html) 操作時以參數形式傳遞。然後，Amazon Personalize 會將事件資料附加到您在事件追蹤器中指定的資料集群組的項目互動資料集。事件追蹤器可以處於下列其中一種狀態： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED + DELETE PENDING > DELETE IN\$1PROGRESS 若要取得事件追蹤器的狀態，請呼叫 [DescribeEventTracker](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeEventTracker.html)。 **注意** 使用追蹤 ID 之前，事件追蹤器必須處於 ACTIVE 狀態。 **相關 API** + [ListEventTrackers](https://docs.aws.amazon.com/personalize/latest/dg/API_ListEventTrackers.html) + [DescribeEventTracker](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeEventTracker.html) + [DeleteEventTracker](https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteEventTracker.html) ## 請求語法 ``` { "datasetGroupArn": "string", "name": "string", "tags": [ { "tagKey": "string", "tagValue": "string" } ] } ``` ## 請求參數請求接受採用 JSON 格式的下列資料。 ** [datasetGroupArn](#API_CreateEventTracker_RequestSyntax) ** 接收事件資料的資料集群組的 Amazon Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateEventTracker) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateEventTracker) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateEventTracker) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateEventTracker) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateEventTracker) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateEventTracker) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateEventTracker) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateEventTracker) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateEventTracker) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateEventTracker) # CreateFilter 建立建議篩選條件。如需詳細資訊，請參閱[篩選建議和使用者客群](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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateFilter) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateFilter) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateFilter) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateFilter) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateFilter) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateFilter) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateFilter) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateFilter) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateFilter) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateFilter) # CreateMetricAttribution 建立指標屬性。指標屬性會針對您匯入 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 Resource Name (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 Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` ## 錯誤 ** InvalidInputException ** 提供欄位或參數的有效值。 HTTP 狀態碼：400 ** LimitExceededException ** 已超過每秒請求數的限制。 HTTP 狀態碼：400 ** ResourceAlreadyExistsException ** 指定的資源已存在。 HTTP 狀態碼：400 ** ResourceInUseException ** 指定的資源正在使用中。 HTTP 狀態碼：400 ** ResourceNotFoundException ** 找不到指定的資源。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateMetricAttribution) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateMetricAttribution) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateMetricAttribution) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateMetricAttribution) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateMetricAttribution) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateMetricAttribution) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateMetricAttribution) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateMetricAttribution) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateMetricAttribution) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateMetricAttribution) # CreateRecommender 使用您指定的配方（網域資料集群組使用案例）建立推薦者。您可以為網域資料集群組建立推薦者，並在提出 [GetRecommendations](https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) 請求時指定推薦者的 Amazon Resource Name (ARN)。 **每秒最低建議請求數** **重要** 較高的 `minRecommendationRequestsPerSecond`會增加您的帳單。我們建議從 1 開始 `minRecommendationRequestsPerSecond`（預設值）。使用 Amazon CloudWatch 指標追蹤您的用量，並視需要增加 `minRecommendationRequestsPerSecond`。建立建議者時，您可以設定建議者每秒的最低建議請求。每秒最低建議請求數 (`minRecommendationRequestsPerSecond`) 指定 Amazon Personalize 佈建的基準建議請求輸送量。預設 minRecommendationRequestsPerSecond 為 `1`。建議請求是單一`GetRecommendations`操作。請求輸送量是以每秒請求數來衡量，Amazon Personalize 會使用每秒請求數來衍生每小時請求數和建議者用量的價格。如果您的請求每秒增加超過 `minRecommendationRequestsPerSecond`，Amazon Personalize 會自動擴展和縮減佈建的容量，但絕不會低於 `minRecommendationRequestsPerSecond`。當容量增加時，會發生短暫的延遲，這可能會導致請求遺失。您的帳單是每小時最低請求數（根據 minRecommendationRequestsPerSecond) 或實際請求數中的較大者。使用的實際請求輸送量計算方式為一小時時段內的平均請求/秒。我們建議您從預設的開始`minRecommendationRequestsPerSecond`，使用 Amazon CloudWatch 指標追蹤您的用量，然後`minRecommendationRequestsPerSecond`視需要增加。 **狀態** 推薦者可以處於下列其中一種狀態： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED + 停止待定 > 停止 IN\$1PROGRESS > 非作用中 > 啟動待定 > 啟動 IN\$1PROGRESS > 作用中 + DELETE PENDING > DELETE IN\$1PROGRESS 若要取得推薦者狀態，請呼叫 [DescribeRecommender](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html)。 **注意** 請等到`status`建議者的變成，`ACTIVE`再向建議者要求建議。 **相關 API** + [ListRecommenders](https://docs.aws.amazon.com/personalize/latest/dg/API_ListRecommenders.html) + [DescribeRecommender](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html) + [UpdateRecommender](https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateRecommender.html) + [DeleteRecommender](https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteRecommender.html) ## 請求語法 ``` { "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 Resource Name (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 Resource Name (ARN)。對於推薦者，配方是網域資料集群組使用案例。只有網域資料集群組使用案例可用於建立建議程式。如需使用案例的相關資訊，請參閱[選擇推薦者使用案例](https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：是 ** [recommenderConfig](#API_CreateRecommender_RequestSyntax) ** 建議者的組態詳細資訊。類型：[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 Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateRecommender) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateRecommender) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateRecommender) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateRecommender) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateRecommender) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateRecommender) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateRecommender) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateRecommender) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateRecommender) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateRecommender) # CreateSchema 從指定結構描述字串中建立 Amazon Personalize 結構描述。您建立的結構描述必須為 Avro JSON 格式。 Amazon Personalize 會辨識三個結構描述變體。每個結構描述都與資料集類型相關聯，且具有一組必填欄位和關鍵字。若要為網域資料集群組中的資料集建立結構描述，請提供網域資料集群組的網域。在呼叫 [CreateDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html) 時指定結構描述。如需有關結構描述的詳細資訊，請參閱[資料集和結構描述](https://docs.aws.amazon.com/personalize/latest/dg/how-it-works-dataset-schema.html)。 **相關 API** + [ListSchemas](https://docs.aws.amazon.com/personalize/latest/dg/API_ListSchemas.html) + [DescribeSchema](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSchema.html) + [DeleteSchema](https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSchema.html) ## 請求語法 ``` { "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 Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` ## 錯誤 ** InvalidInputException ** 提供欄位或參數的有效值。 HTTP 狀態碼：400 ** LimitExceededException ** 已超過每秒請求數的限制。 HTTP 狀態碼：400 ** ResourceAlreadyExistsException ** 指定的資源已存在。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateSchema) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateSchema) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateSchema) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateSchema) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateSchema) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateSchema) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateSchema) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateSchema) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateSchema) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateSchema) # CreateSolution **重要** 根據預設，所有新解決方案都會使用自動訓練。透過自動訓練，您會在解決方案處於作用中狀態時產生訓練成本。為了避免不必要的成本，您可以在完成後[更新解決方案](https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateSolution.html)以關閉自動訓練。如需訓練成本的資訊，請參閱 [Amazon Personalize 定價](https://aws.amazon.com/personalize/pricing/)。建立用於訓練模型的組態（建立解決方案版本）。此組態包含用於模型訓練的配方和選用的訓練組態，例如用於訓練和功能轉換參數的欄。如需設定解決方案的詳細資訊，請參閱[建立和設定解決方案](https://docs.aws.amazon.com/personalize/latest/dg/customizing-solution-config.html)。根據預設，新的解決方案會每 7 天使用自動訓練來建立解決方案版本。您可以變更訓練頻率。自動建立解決方案版本會在解決方案為 ACTIVE 後的一小時內開始。如果您在一小時內手動建立解決方案版本，解決方案會略過第一個自動訓練。如需詳細資訊，請參閱[設定自動訓練](https://docs.aws.amazon.com/personalize/latest/dg/solution-config-auto-training.html)。若要關閉自動訓練，請將 `performAutoTraining`設定為 false。如果您關閉自動訓練，則必須呼叫 [CreateSolutionVersion](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolutionVersion.html) 操作來手動建立解決方案版本。訓練開始後，您可以使用 [ListSolutionVersions](https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html) API 操作取得解決方案版本的 Amazon Resource Name (ARN)。若要取得其狀態，請使用 [DescribeSolutionVersion](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html)。訓練完成後，您可以透過呼叫 [GetSolutionMetrics](https://docs.aws.amazon.com/personalize/latest/dg/API_GetSolutionMetrics.html) 來評估模型準確性。當您對解決方案版本感到滿意時，您可以使用 [CreateCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html) 部署它。行銷活動會透過 [GetRecommendations](https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) API 向用戶端提供建議。 **注意** Amazon Personalize 目前不支援`hpoObjective`為解決方案超參數最佳化設定。 **狀態** 解決方案可以處於下列其中一種狀態： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED + DELETE PENDING > DELETE IN\$1PROGRESS 若要取得解決方案的狀態，請呼叫 [DescribeSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html)。如果您使用手動訓練，則在您呼叫之前，狀態必須為 ACTIVE`CreateSolutionVersion`。 **相關 API** + [UpdateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateSolution.html) + [ListSolutions](https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutions.html) + [CreateSolutionVersion](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolutionVersion.html) + [DescribeSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html) + [DeleteSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSolution.html) + [ListSolutionVersions](https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html) + [DescribeSolutionVersion](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html) ## 請求語法 ``` { "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 Resource Name (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 天會自動建立新的解決方案版本。您可以在 `schedulingExpression`中指定 `AutoTrainingConfig`作為解決方案組態的一部分，以變更訓練頻率。如需自動訓練的詳細資訊，請參閱[設定自動訓練](https://docs.aws.amazon.com/personalize/latest/dg/solution-config-auto-training.html)。自動建立解決方案版本會在解決方案為 ACTIVE 後的一小時內開始。如果您在一小時內手動建立解決方案版本，解決方案會略過第一個自動訓練。訓練開始後，您可以使用 [ListSolutionVersions](https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html) API 操作取得解決方案版本的 Amazon Resource Name (ARN)。若要取得其狀態，請使用 [DescribeSolutionVersion](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html)。類型：布林值必要：否 ** [performHPO](#API_CreateSolution_RequestSyntax) ** 是否要在指定或選取的配方上執行超參數最佳化 (HPO)。預設值為 `false`。執行 AutoML 時，此參數一律為 `true`，且您不應將其設定為 `false`。類型：布林值必要：否 ** [performIncrementalUpdate](#API_CreateSolution_RequestSyntax) ** 是否對模型執行增量訓練更新。啟用時，這可讓模型更頻繁地從新資料中學習，而無需完整重新訓練，從而實現近乎即時的個人化。只有使用語意相似性配方的解決方案才支援此參數。類型：布林值必要：否 ** [recipeArn](#API_CreateSolution_RequestSyntax) ** 用於模型訓練之配方的 Amazon Resource Name (ARN)。當 `performAutoML`為 false 時，此為必要項目。如需不同 Amazon Personalize 配方及其 ARNs 的資訊，請參閱[選擇配方](https://docs.aws.amazon.com/personalize/latest/dg/working-with-predefined-recipes.html)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** [solutionConfig](#API_CreateSolution_RequestSyntax) ** 解決方案的組態屬性。當 `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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateSolution) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateSolution) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateSolution) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateSolution) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateSolution) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateSolution) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateSolution) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateSolution) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateSolution) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateSolution) # CreateSolutionVersion 訓練或重新訓練自訂資料集群組中的作用中解決方案。解決方案是使用 [CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) 操作建立，而且在呼叫之前必須處於 ACTIVE 狀態`CreateSolutionVersion`。每次呼叫此操作時，都會建立新的解決方案版本。 **狀態** 解決方案版本可以處於下列其中一種狀態： + 建立擱置中 + CREATE IN\$1PROGRESS + ACTIVE + 建立失敗 + 建立停止 + 建立已停止若要取得版本的狀態，請呼叫 [DescribeSolutionVersion](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html)。等到狀態顯示為 ACTIVE，再呼叫 `CreateCampaign`。如果狀態顯示為 CREATE FAILED，回應會包含`failureReason`金鑰，說明任務失敗的原因。 **相關 API** + [ListSolutionVersions](https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html) + [DescribeSolutionVersion](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html) + [ListSolutions](https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutions.html) + [CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) + [DescribeSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html) + [DeleteSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSolution.html) ## 請求語法 ``` { "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 Resource Name (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`。這會根據資料集群組中資料集的完整訓練資料來建立全新的模型。如果您使用[使用者個人化](https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html)，您可以指定的訓練模式`UPDATE`。這會更新模型，以考慮建議的新項目。它不是完整的重新訓練。您仍應每週完成完整重新訓練。如果您指定 `UPDATE`，Amazon Personalize 將停止解決方案版本的自動更新。若要繼續更新，請建立訓練模式設定為的新解決方案，`FULL`並將其部署在行銷活動中。如需自動更新的詳細資訊，請參閱[自動更新](https://docs.aws.amazon.com/personalize/latest/dg/use-case-recipe-features.html#maintaining-with-automatic-updates)。只有在您已使用 `UPDATE`選項從輸入解決方案建立作用中的解決方案版本，且輸入解決方案已使用[使用者個人化](https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html)配方或舊版 [HRNN-Coldstart ](https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html)配方進行訓練時，才能使用 `FULL`選項。類型：字串有效值:`FULL | UPDATE | AUTOTRAIN` 必要：否 ## 回應語法 ``` { "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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/CreateSolutionVersion) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/CreateSolutionVersion) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateSolutionVersion) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/CreateSolutionVersion) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CreateSolutionVersion) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateSolutionVersion) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/CreateSolutionVersion) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateSolutionVersion) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateSolutionVersion) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateSolutionVersion) # DeleteCampaign 刪除解決方案部署以移除行銷活動。行銷活動以為基礎的解決方案不會刪除，並且可以在需要時重新部署。無法在 [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 Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：是 ## 回應元素如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。 ## 錯誤 ** InvalidInputException ** 提供欄位或參數的有效值。 HTTP 狀態碼：400 ** ResourceInUseException ** 指定的資源正在使用中。 HTTP 狀態碼：400 ** ResourceNotFoundException ** 找不到指定的資源。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DeleteCampaign) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DeleteCampaign) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DeleteCampaign) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DeleteCampaign) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DeleteCampaign) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DeleteCampaign) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DeleteCampaign) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteCampaign) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DeleteCampaign) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DeleteCampaign) # DeleteDataset 刪除資料集。如果關聯的 `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 Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：是 ## 回應元素如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。 ## 錯誤 ** InvalidInputException ** 提供欄位或參數的有效值。 HTTP 狀態碼：400 ** ResourceInUseException ** 指定的資源正在使用中。 HTTP 狀態碼：400 ** ResourceNotFoundException ** 找不到指定的資源。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DeleteDataset) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DeleteDataset) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DeleteDataset) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DeleteDataset) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DeleteDataset) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DeleteDataset) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DeleteDataset) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteDataset) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DeleteDataset) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DeleteDataset) # DeleteDatasetGroup 刪除資料集群組。刪除資料集群組之前，您必須先刪除下列項目： + 所有相關的事件追蹤器。 + 所有相關的解決方案。 + 資料集群組中的所有資料集。 ## 請求語法 ``` { "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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DeleteDatasetGroup) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DeleteDatasetGroup) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DeleteDatasetGroup) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DeleteDatasetGroup) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DeleteDatasetGroup) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DeleteDatasetGroup) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DeleteDatasetGroup) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteDatasetGroup) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DeleteDatasetGroup) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DeleteDatasetGroup) # DeleteEventTracker 刪除事件追蹤器。不會從資料集群組中刪除資料集。如需事件追蹤器的詳細資訊，請參閱 [CreateEventTracker](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html)。 ## 請求語法 ``` { "eventTrackerArn": "string" } ``` ## 請求參數請求接受採用 JSON 格式的下列資料。 ** [eventTrackerArn](#API_DeleteEventTracker_RequestSyntax) ** 要刪除之事件追蹤器的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：是 ## 回應元素如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。 ## 錯誤 ** InvalidInputException ** 提供欄位或參數的有效值。 HTTP 狀態碼：400 ** ResourceInUseException ** 指定的資源正在使用中。 HTTP 狀態碼：400 ** ResourceNotFoundException ** 找不到指定的資源。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DeleteEventTracker) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DeleteEventTracker) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DeleteEventTracker) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DeleteEventTracker) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DeleteEventTracker) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DeleteEventTracker) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DeleteEventTracker) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteEventTracker) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DeleteEventTracker) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DeleteEventTracker) # DeleteFilter 刪除篩選條件。 ## 請求語法 ``` { "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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DeleteFilter) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DeleteFilter) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DeleteFilter) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DeleteFilter) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DeleteFilter) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DeleteFilter) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DeleteFilter) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteFilter) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DeleteFilter) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DeleteFilter) # DeleteMetricAttribution 刪除指標屬性。 ## 請求語法 ``` { "metricAttributionArn": "string" } ``` ## 請求參數請求接受採用 JSON 格式的下列資料。 ** [metricAttributionArn](#API_DeleteMetricAttribution_RequestSyntax) ** 指標屬性的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：是 ## 回應元素如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。 ## 錯誤 ** InvalidInputException ** 提供欄位或參數的有效值。 HTTP 狀態碼：400 ** ResourceInUseException ** 指定的資源正在使用中。 HTTP 狀態碼：400 ** ResourceNotFoundException ** 找不到指定的資源。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DeleteMetricAttribution) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DeleteMetricAttribution) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DeleteMetricAttribution) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DeleteMetricAttribution) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DeleteMetricAttribution) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DeleteMetricAttribution) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DeleteMetricAttribution) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteMetricAttribution) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DeleteMetricAttribution) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DeleteMetricAttribution) # DeleteRecommender 停用和移除推薦者。無法在 [GetRecommendations](https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) 請求中指定已刪除的推薦者。 ## 請求語法 ``` { "recommenderArn": "string" } ``` ## 請求參數請求接受採用 JSON 格式的下列資料。 ** [recommenderArn](#API_DeleteRecommender_RequestSyntax) ** 要刪除之建議程式的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：是 ## 回應元素如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。 ## 錯誤 ** InvalidInputException ** 提供欄位或參數的有效值。 HTTP 狀態碼：400 ** ResourceInUseException ** 指定的資源正在使用中。 HTTP 狀態碼：400 ** ResourceNotFoundException ** 找不到指定的資源。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DeleteRecommender) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DeleteRecommender) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DeleteRecommender) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DeleteRecommender) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DeleteRecommender) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DeleteRecommender) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DeleteRecommender) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteRecommender) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DeleteRecommender) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DeleteRecommender) # DeleteSchema 刪除結構描述。刪除結構描述之前，您必須刪除參考結構描述的所有資料集。如需結構描述的詳細資訊，請參閱 [CreateSchema](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html)。 ## 請求語法 ``` { "schemaArn": "string" } ``` ## 請求參數請求接受採用 JSON 格式的下列資料。 ** [schemaArn](#API_DeleteSchema_RequestSyntax) ** 要刪除之結構描述的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：是 ## 回應元素如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。 ## 錯誤 ** InvalidInputException ** 提供欄位或參數的有效值。 HTTP 狀態碼：400 ** ResourceInUseException ** 指定的資源正在使用中。 HTTP 狀態碼：400 ** ResourceNotFoundException ** 找不到指定的資源。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DeleteSchema) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DeleteSchema) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DeleteSchema) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DeleteSchema) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DeleteSchema) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DeleteSchema) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DeleteSchema) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteSchema) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DeleteSchema) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DeleteSchema) # DeleteSolution 刪除解決方案的所有版本和`Solution`物件本身。刪除解決方案之前，您必須根據解決方案刪除所有行銷活動。若要判斷哪些行銷活動正在使用解決方案，請呼叫 [ListCampaigns](https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html) 並提供解決方案的 Amazon Resource Name (ARN)。如果關聯的 `SolutionVersion` 處於 CREATE PENDING 或 IN PROGRESS 狀態，則無法刪除解決方案。如需解決方案的詳細資訊，請參閱 [CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html)。 ## 請求語法 ``` { "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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DeleteSolution) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DeleteSolution) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DeleteSolution) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DeleteSolution) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DeleteSolution) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DeleteSolution) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DeleteSolution) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteSolution) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DeleteSolution) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DeleteSolution) # DescribeAlgorithm 描述指定的演算法。 ## 請求語法 ``` { "algorithmArn": "string" } ``` ## 請求參數請求接受採用 JSON 格式的下列資料。 ** [algorithmArn](#API_DescribeAlgorithm_RequestSyntax) ** 要描述之演算法的 Amazon Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeAlgorithm) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeAlgorithm) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeAlgorithm) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeAlgorithm) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeAlgorithm) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeAlgorithm) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeAlgorithm) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeAlgorithm) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeAlgorithm) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeAlgorithm) # DescribeBatchInferenceJob 取得批次推論任務的屬性，包括名稱、Amazon Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeBatchInferenceJob) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeBatchInferenceJob) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeBatchInferenceJob) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeBatchInferenceJob) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeBatchInferenceJob) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeBatchInferenceJob) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeBatchInferenceJob) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeBatchInferenceJob) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeBatchInferenceJob) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeBatchInferenceJob) # DescribeBatchSegmentJob 取得批次區段任務的屬性，包括名稱、Amazon Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeBatchSegmentJob) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeBatchSegmentJob) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeBatchSegmentJob) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeBatchSegmentJob) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeBatchSegmentJob) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeBatchSegmentJob) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeBatchSegmentJob) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeBatchSegmentJob) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeBatchSegmentJob) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeBatchSegmentJob) # DescribeCampaign 描述指定的行銷活動，包括其狀態。行銷活動可以處於下列其中一種狀態： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED + DELETE PENDING > DELETE IN\$1PROGRESS 當 `status`為時`CREATE FAILED`，回應會包含 `failureReason`金鑰，說明原因。如需行銷活動的詳細資訊，請參閱 [CreateCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html)。 ## 請求語法 ``` { "campaignArn": "string" } ``` ## 請求參數請求接受採用 JSON 格式的下列資料。 ** [campaignArn](#API_DescribeCampaign_RequestSyntax) ** 行銷活動的 Amazon Resource Name (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) ** 只有當行銷活動至少有一個`UpdateCampaign`呼叫時，才會傳回 `latestCampaignUpdate` 欄位。行銷活動的屬性。只有當行銷活動至少有一個`UpdateCampaign`呼叫時，才會傳回 `latestCampaignUpdate` 欄位。類型：[Campaign](API_Campaign.md) 物件 ## 錯誤 ** InvalidInputException ** 提供欄位或參數的有效值。 HTTP 狀態碼：400 ** ResourceNotFoundException ** 找不到指定的資源。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeCampaign) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeCampaign) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeCampaign) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeCampaign) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeCampaign) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeCampaign) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeCampaign) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeCampaign) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeCampaign) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeCampaign) # DescribeDataDeletionJob 描述 [CreateDataDeletionJob](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataDeletionJob.html) 建立的資料刪除任務，包括任務狀態。 ## 請求語法 ``` { "dataDeletionJobArn": "string" } ``` ## 請求參數請求接受採用 JSON 格式的下列資料。 ** [dataDeletionJobArn](#API_DescribeDataDeletionJob_RequestSyntax) ** 資料刪除任務的 Amazon Resource Name (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) ** 資料刪除任務的相關資訊，包括狀態。狀態是下列其中一個值： + 待定 + IN\$1PROGRESS + COMPLETED (已完成) + 失敗類型：[DataDeletionJob](API_DataDeletionJob.md) 物件 ## 錯誤 ** InvalidInputException ** 提供欄位或參數的有效值。 HTTP 狀態碼：400 ** ResourceNotFoundException ** 找不到指定的資源。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeDataDeletionJob) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeDataDeletionJob) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeDataDeletionJob) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeDataDeletionJob) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeDataDeletionJob) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeDataDeletionJob) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeDataDeletionJob) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeDataDeletionJob) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeDataDeletionJob) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeDataDeletionJob) # DescribeDataset 描述指定的資料集。如需資料集的詳細資訊，請參閱 [CreateDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html)。 ## 請求語法 ``` { "datasetArn": "string" } ``` ## 請求參數請求接受採用 JSON 格式的下列資料。 ** [datasetArn](#API_DescribeDataset_RequestSyntax) ** 要描述之資料集的 Amazon Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeDataset) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeDataset) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeDataset) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeDataset) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeDataset) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeDataset) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeDataset) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeDataset) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeDataset) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeDataset) # DescribeDatasetExportJob 描述 [CreateDatasetExportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html) 建立的資料集匯出任務，包括匯出任務狀態。 ## 請求語法 ``` { "datasetExportJobArn": "string" } ``` ## 請求參數請求接受採用 JSON 格式的下列資料。 ** [datasetExportJobArn](#API_DescribeDatasetExportJob_RequestSyntax) ** 要描述的資料集匯出任務的 Amazon Resource Name (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 IN\$1PROGRESS + ACTIVE + 建立失敗類型：[DatasetExportJob](API_DatasetExportJob.md) 物件 ## 錯誤 ** InvalidInputException ** 提供欄位或參數的有效值。 HTTP 狀態碼：400 ** ResourceNotFoundException ** 找不到指定的資源。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeDatasetExportJob) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeDatasetExportJob) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeDatasetExportJob) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeDatasetExportJob) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeDatasetExportJob) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeDatasetExportJob) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeDatasetExportJob) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeDatasetExportJob) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeDatasetExportJob) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeDatasetExportJob) # DescribeDatasetGroup 描述指定的資料集群組。如需資料集群組的詳細資訊，請參閱 [CreateDatasetGroup](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html)。 ## 請求語法 ``` { "datasetGroupArn": "string" } ``` ## 請求參數請求接受採用 JSON 格式的下列資料。 ** [datasetGroupArn](#API_DescribeDatasetGroup_RequestSyntax) ** 要描述之資料集群組的 Amazon Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeDatasetGroup) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeDatasetGroup) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeDatasetGroup) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeDatasetGroup) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeDatasetGroup) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeDatasetGroup) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeDatasetGroup) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeDatasetGroup) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeDatasetGroup) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeDatasetGroup) # DescribeDatasetImportJob 描述 [CreateDatasetImportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html) 建立的資料集匯入任務，包括匯入任務狀態。 ## 請求語法 ``` { "datasetImportJobArn": "string" } ``` ## 請求參數請求接受採用 JSON 格式的下列資料。 ** [datasetImportJobArn](#API_DescribeDatasetImportJob_RequestSyntax) ** 要描述的資料集匯入任務的 Amazon Resource Name (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 IN\$1PROGRESS + ACTIVE + 建立失敗類型：[DatasetImportJob](API_DatasetImportJob.md) 物件 ## 錯誤 ** InvalidInputException ** 提供欄位或參數的有效值。 HTTP 狀態碼：400 ** ResourceNotFoundException ** 找不到指定的資源。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeDatasetImportJob) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeDatasetImportJob) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeDatasetImportJob) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeDatasetImportJob) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeDatasetImportJob) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeDatasetImportJob) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeDatasetImportJob) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeDatasetImportJob) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeDatasetImportJob) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeDatasetImportJob) # DescribeEventTracker 描述事件追蹤器。回應包含事件追蹤器`status`的 `trackingId`和。如需事件追蹤器的詳細資訊，請參閱 [CreateEventTracker](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html)。 ## 請求語法 ``` { "eventTrackerArn": "string" } ``` ## 請求參數請求接受採用 JSON 格式的下列資料。 ** [eventTrackerArn](#API_DescribeEventTracker_RequestSyntax) ** 要描述的事件追蹤器的 Amazon Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeEventTracker) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeEventTracker) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeEventTracker) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeEventTracker) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeEventTracker) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeEventTracker) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeEventTracker) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeEventTracker) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeEventTracker) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeEventTracker) # DescribeFeatureTransformation 描述指定的功能轉換。 ## 請求語法 ``` { "featureTransformationArn": "string" } ``` ## 請求參數請求接受採用 JSON 格式的下列資料。 ** [featureTransformationArn](#API_DescribeFeatureTransformation_RequestSyntax) ** 要描述的功能轉換的 Amazon Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeFeatureTransformation) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeFeatureTransformation) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeFeatureTransformation) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeFeatureTransformation) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeFeatureTransformation) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeFeatureTransformation) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeFeatureTransformation) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeFeatureTransformation) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeFeatureTransformation) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeFeatureTransformation) # DescribeFilter 描述篩選條件的屬性。 ## 請求語法 ``` { "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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeFilter) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeFilter) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeFilter) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeFilter) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeFilter) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeFilter) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeFilter) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeFilter) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeFilter) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeFilter) # DescribeMetricAttribution 描述指標屬性。 ## 請求語法 ``` { "metricAttributionArn": "string" } ``` ## 請求參數請求接受採用 JSON 格式的下列資料。 ** [metricAttributionArn](#API_DescribeMetricAttribution_RequestSyntax) ** 指標屬性的 Amazon Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeMetricAttribution) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeMetricAttribution) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeMetricAttribution) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeMetricAttribution) + [AWS 適用於 Java V2 的開發套件](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeMetricAttribution) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeMetricAttribution) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeMetricAttribution) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeMetricAttribution) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeMetricAttribution) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeMetricAttribution) # DescribeRecipe 描述配方。配方包含三個項目： + 訓練模型的演算法。 + 管理訓練的超參數。 + 在訓練之前修改輸入資料的功能轉換資訊。 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 Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeRecipe) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeRecipe) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeRecipe) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeRecipe) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeRecipe) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeRecipe) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeRecipe) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeRecipe) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeRecipe) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeRecipe) # DescribeRecommender 描述指定的推薦者，包括其狀態。推薦者可以處於下列其中一種狀態： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED + 停止待定 > 停止 IN\$1PROGRESS > 非作用中 > 啟動待定 > 啟動 IN\$1PROGRESS > 作用中 + DELETE PENDING > DELETE IN\$1PROGRESS 當 `status`為時`CREATE FAILED`，回應會包含 `failureReason`金鑰，說明原因。建立或刪除建議程式時，`modelMetrics`金鑰為 null。如需推薦者的詳細資訊，請參閱 [CreateRecommender](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateRecommender.html)。 ## 請求語法 ``` { "recommenderArn": "string" } ``` ## 請求參數請求接受採用 JSON 格式的下列資料。 ** [recommenderArn](#API_DescribeRecommender_RequestSyntax) ** 要描述之建議者的 Amazon Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeRecommender) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeRecommender) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeRecommender) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeRecommender) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeRecommender) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeRecommender) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeRecommender) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeRecommender) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeRecommender) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeRecommender) # DescribeSchema 描述結構描述。如需結構描述的詳細資訊，請參閱 [CreateSchema](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html)。 ## 請求語法 ``` { "schemaArn": "string" } ``` ## 請求參數請求接受採用 JSON 格式的下列資料。 ** [schemaArn](#API_DescribeSchema_RequestSyntax) ** 要擷取之結構描述的 Amazon Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeSchema) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeSchema) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeSchema) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeSchema) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeSchema) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeSchema) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeSchema) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeSchema) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeSchema) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeSchema) # DescribeSolution 描述解決方案。如需解決方案的詳細資訊，請參閱 [CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html)。 ## 請求語法 ``` { "solutionArn": "string" } ``` ## 請求參數請求接受採用 JSON 格式的下列資料。 ** [solutionArn](#API_DescribeSolution_RequestSyntax) ** 要描述的解決方案的 Amazon Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeSolution) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeSolution) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeSolution) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeSolution) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeSolution) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeSolution) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeSolution) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeSolution) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeSolution) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeSolution) # DescribeSolutionVersion 描述解決方案的特定版本。如需解決方案的詳細資訊，請參閱 [CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) ## 請求語法 ``` { "solutionVersionArn": "string" } ``` ## 請求參數請求接受採用 JSON 格式的下列資料。 ** [solutionVersionArn](#API_DescribeSolutionVersion_RequestSyntax) ** 解決方案版本的 Amazon Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeSolutionVersion) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeSolutionVersion) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeSolutionVersion) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeSolutionVersion) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeSolutionVersion) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeSolutionVersion) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeSolutionVersion) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeSolutionVersion) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeSolutionVersion) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeSolutionVersion) # GetSolutionMetrics 取得指定解決方案版本的指標。 ## 請求語法 ``` { "solutionVersionArn": "string" } ``` ## 請求參數請求接受採用 JSON 格式的下列資料。 ** [solutionVersionArn](#API_GetSolutionMetrics_RequestSyntax) ** 要取得指標之解決方案版本的 Amazon Resource Name (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)。類型：String 到 double 映射映射項目：最多 100 個項目。金鑰長度限制：長度上限為 256。 ** [solutionVersionArn](#API_GetSolutionMetrics_ResponseSyntax) ** 與請求中指定的相同解決方案版本 ARN。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` ## 錯誤 ** InvalidInputException ** 提供欄位或參數的有效值。 HTTP 狀態碼：400 ** ResourceInUseException ** 指定的資源正在使用中。 HTTP 狀態碼：400 ** ResourceNotFoundException ** 找不到指定的資源。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/GetSolutionMetrics) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/GetSolutionMetrics) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/GetSolutionMetrics) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/GetSolutionMetrics) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/GetSolutionMetrics) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/GetSolutionMetrics) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/GetSolutionMetrics) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/GetSolutionMetrics) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/GetSolutionMetrics) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/GetSolutionMetrics) # ListBatchInferenceJobs 取得已從解決方案版本執行的批次推論任務清單。 ## 請求語法 ``` { "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 Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListBatchInferenceJobs) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListBatchInferenceJobs) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListBatchInferenceJobs) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListBatchInferenceJobs) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListBatchInferenceJobs) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListBatchInferenceJobs) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListBatchInferenceJobs) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListBatchInferenceJobs) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListBatchInferenceJobs) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListBatchInferenceJobs) # ListBatchSegmentJobs 取得已從您指定的解決方案版本執行的批次區段任務清單。 ## 請求語法 ``` { "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 Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListBatchSegmentJobs) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListBatchSegmentJobs) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListBatchSegmentJobs) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListBatchSegmentJobs) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListBatchSegmentJobs) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListBatchSegmentJobs) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListBatchSegmentJobs) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListBatchSegmentJobs) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListBatchSegmentJobs) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListBatchSegmentJobs) # ListCampaigns 傳回使用指定解決方案的行銷活動清單。未指定解決方案時，會列出與該帳戶相關聯的所有行銷活動。回應提供每個行銷活動的屬性，包括 Amazon Resource Name (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 Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListCampaigns) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListCampaigns) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListCampaigns) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListCampaigns) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListCampaigns) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListCampaigns) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListCampaigns) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListCampaigns) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListCampaigns) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListCampaigns) # ListDataDeletionJobs 傳回依建立時間排序之資料集群組的資料刪除任務清單，以最新的先到者為準。未指定資料集群組時，會列出與帳戶相關聯的所有資料刪除任務。回應提供每個任務的屬性，包括 Amazon Resource Name (ARN)。如需資料刪除任務的詳細資訊，請參閱[刪除使用者](https://docs.aws.amazon.com/personalize/latest/dg/delete-records.html)。 ## 請求語法 ``` { "datasetGroupArn": "string", "maxResults": number, "nextToken": "string" } ``` ## 請求參數請求接受採用 JSON 格式的下列資料。 ** [datasetGroupArn](#API_ListDataDeletionJobs_RequestSyntax) ** 要列出資料刪除任務之資料集群組的 Amazon Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListDataDeletionJobs) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListDataDeletionJobs) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListDataDeletionJobs) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListDataDeletionJobs) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListDataDeletionJobs) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListDataDeletionJobs) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListDataDeletionJobs) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListDataDeletionJobs) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListDataDeletionJobs) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListDataDeletionJobs) # ListDatasetExportJobs 傳回使用指定資料集的資料集匯出任務清單。未指定資料集時，會列出與帳戶相關聯的所有資料集匯出任務。回應提供每個資料集匯出任務的屬性，包括 Amazon Resource Name (ARN)。如需資料集匯出任務的詳細資訊，請參閱 [CreateDatasetExportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html)。如需資料集的詳細資訊，請參閱 [CreateDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html)。 ## 請求語法 ``` { "datasetArn": "string", "maxResults": number, "nextToken": "string" } ``` ## 請求參數請求接受採用 JSON 格式的下列資料。 ** [datasetArn](#API_ListDatasetExportJobs_RequestSyntax) ** 要列出資料集匯出任務之資料集的 Amazon Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListDatasetExportJobs) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListDatasetExportJobs) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListDatasetExportJobs) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListDatasetExportJobs) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListDatasetExportJobs) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListDatasetExportJobs) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListDatasetExportJobs) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListDatasetExportJobs) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListDatasetExportJobs) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListDatasetExportJobs) # ListDatasetGroups 傳回資料集群組的清單。回應提供每個資料集群組的屬性，包括 Amazon Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListDatasetGroups) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListDatasetGroups) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListDatasetGroups) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListDatasetGroups) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListDatasetGroups) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListDatasetGroups) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListDatasetGroups) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListDatasetGroups) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListDatasetGroups) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListDatasetGroups) # ListDatasetImportJobs 傳回使用指定資料集的資料集匯入任務清單。未指定資料集時，會列出與帳戶相關聯的所有資料集匯入任務。回應提供每個資料集匯入任務的屬性，包括 Amazon Resource Name (ARN)。如需資料集匯入任務的詳細資訊，請參閱 [CreateDatasetImportJob](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html)。如需資料集的詳細資訊，請參閱 [CreateDataset](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html)。 ## 請求語法 ``` { "datasetArn": "string", "maxResults": number, "nextToken": "string" } ``` ## 請求參數請求接受採用 JSON 格式的下列資料。 ** [datasetArn](#API_ListDatasetImportJobs_RequestSyntax) ** 要列出資料集匯入任務之資料集的 Amazon Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListDatasetImportJobs) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListDatasetImportJobs) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListDatasetImportJobs) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListDatasetImportJobs) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListDatasetImportJobs) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListDatasetImportJobs) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListDatasetImportJobs) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListDatasetImportJobs) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListDatasetImportJobs) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListDatasetImportJobs) # ListDatasets 傳回指定資料集群組中包含的資料集清單。回應提供每個資料集的屬性，包括 Amazon Resource Name (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 Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListDatasets) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListDatasets) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListDatasets) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListDatasets) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListDatasets) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListDatasets) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListDatasets) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListDatasets) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListDatasets) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListDatasets) # ListEventTrackers 傳回與帳戶相關聯的事件追蹤器清單。回應提供每個事件追蹤器的屬性，包括 Amazon Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListEventTrackers) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListEventTrackers) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListEventTrackers) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListEventTrackers) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListEventTrackers) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListEventTrackers) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListEventTrackers) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListEventTrackers) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListEventTrackers) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListEventTrackers) # ListFilters 列出屬於指定資料集群組的所有篩選條件。 ## 請求語法 ``` { "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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListFilters) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListFilters) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListFilters) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListFilters) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListFilters) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListFilters) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListFilters) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListFilters) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListFilters) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListFilters) # ListMetricAttributionMetrics 列出指標屬性的指標。 ## 請求語法 ``` { "maxResults": number, "metricAttributionArn": "string", "nextToken": "string" } ``` ## 請求參數請求接受採用 JSON 格式的下列資料。 ** [maxResults](#API_ListMetricAttributionMetrics_RequestSyntax) ** 在結果的一頁中傳回的指標數量上限。類型：整數有效範圍：最小值為 1。最大值為 100。必要：否 ** [metricAttributionArn](#API_ListMetricAttributionMetrics_RequestSyntax) ** 要擷取屬性之指標屬性的 Amazon Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListMetricAttributionMetrics) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListMetricAttributionMetrics) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListMetricAttributionMetrics) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListMetricAttributionMetrics) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListMetricAttributionMetrics) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListMetricAttributionMetrics) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListMetricAttributionMetrics) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListMetricAttributionMetrics) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListMetricAttributionMetrics) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListMetricAttributionMetrics) # ListMetricAttributions 列出指標屬性。 ## 請求語法 ``` { "datasetGroupArn": "string", "maxResults": number, "nextToken": "string" } ``` ## 請求參數請求接受採用 JSON 格式的下列資料。 ** [datasetGroupArn](#API_ListMetricAttributions_RequestSyntax) ** 指標屬性的資料集群組 Amazon Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListMetricAttributions) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListMetricAttributions) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListMetricAttributions) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListMetricAttributions) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListMetricAttributions) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListMetricAttributions) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListMetricAttributions) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListMetricAttributions) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListMetricAttributions) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListMetricAttributions) # ListRecipes 傳回可用配方的清單。回應提供每個配方的屬性，包括配方的 Amazon Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListRecipes) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListRecipes) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListRecipes) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListRecipes) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListRecipes) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListRecipes) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListRecipes) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListRecipes) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListRecipes) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListRecipes) # ListRecommenders 傳回指定網域資料集群組中的推薦者清單。未指定網域資料集群組時，會列出與該帳戶相關聯的所有建議者。回應提供每個建議者的屬性，包括 Amazon Resource Name (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 Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListRecommenders) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListRecommenders) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListRecommenders) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListRecommenders) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListRecommenders) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListRecommenders) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListRecommenders) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListRecommenders) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListRecommenders) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListRecommenders) # ListSchemas 傳回與帳戶相關聯的結構描述清單。回應提供每個結構描述的屬性，包括 Amazon Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListSchemas) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListSchemas) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListSchemas) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListSchemas) + [AWS 適用於 Java V2 的開發套件](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListSchemas) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListSchemas) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListSchemas) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListSchemas) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListSchemas) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListSchemas) # ListSolutions 傳回指定資料集群組中的解決方案清單。未指定資料集群組時，會列出與該帳戶相關聯的所有解決方案。回應提供每個解決方案的屬性，包括 Amazon Resource Name (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 Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListSolutions) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListSolutions) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListSolutions) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListSolutions) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListSolutions) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListSolutions) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListSolutions) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListSolutions) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListSolutions) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListSolutions) # ListSolutionVersions 傳回指定解決方案的解決方案版本清單。未指定解決方案時，會列出與帳戶相關聯的所有解決方案版本。回應提供每個解決方案版本的屬性，包括 Amazon Resource Name (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 Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListSolutionVersions) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListSolutionVersions) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListSolutionVersions) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListSolutionVersions) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListSolutionVersions) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListSolutionVersions) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListSolutionVersions) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListSolutionVersions) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListSolutionVersions) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListSolutionVersions) # ListTagsForResource 取得連接至資源的[標籤](https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html)清單。 ## 請求語法 ``` { "resourceArn": "string" } ``` ## 請求參數請求接受採用 JSON 格式的下列資料。 ** [resourceArn](#API_ListTagsForResource_RequestSyntax) ** 資源的 Amazon Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/ListTagsForResource) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/ListTagsForResource) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListTagsForResource) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/ListTagsForResource) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ListTagsForResource) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListTagsForResource) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/ListTagsForResource) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListTagsForResource) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListTagsForResource) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListTagsForResource) # StartRecommender 啟動非作用中的推薦者。啟動推薦者不會建立任何新模型，但會繼續為推薦者計費和自動重新訓練。 ## 請求語法 ``` { "recommenderArn": "string" } ``` ## 請求參數請求接受採用 JSON 格式的下列資料。 ** [recommenderArn](#API_StartRecommender_RequestSyntax) ** 要啟動之建議程式的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：是 ## 回應語法 ``` { "recommenderArn": "string" } ``` ## 回應元素如果動作成功，則服務傳回 HTTP 200 回應。服務會傳回下列 JSON 格式的資料。 ** [recommenderArn](#API_StartRecommender_ResponseSyntax) ** 您啟動之建議程式的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` ## 錯誤 ** InvalidInputException ** 提供欄位或參數的有效值。 HTTP 狀態碼：400 ** ResourceInUseException ** 指定的資源正在使用中。 HTTP 狀態碼：400 ** ResourceNotFoundException ** 找不到指定的資源。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/StartRecommender) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/StartRecommender) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/StartRecommender) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/StartRecommender) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/StartRecommender) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/StartRecommender) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/StartRecommender) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/StartRecommender) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/StartRecommender) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/StartRecommender) # StopRecommender 停止 ACTIVE 的推薦者。停止建議者會停止對建議者的計費和自動重新訓練。 ## 請求語法 ``` { "recommenderArn": "string" } ``` ## 請求參數請求接受採用 JSON 格式的下列資料。 ** [recommenderArn](#API_StopRecommender_RequestSyntax) ** 要停止之建議程式的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：是 ## 回應語法 ``` { "recommenderArn": "string" } ``` ## 回應元素如果動作成功，則服務傳回 HTTP 200 回應。服務會傳回下列 JSON 格式的資料。 ** [recommenderArn](#API_StopRecommender_ResponseSyntax) ** 您停止之推薦者的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` ## 錯誤 ** InvalidInputException ** 提供欄位或參數的有效值。 HTTP 狀態碼：400 ** ResourceInUseException ** 指定的資源正在使用中。 HTTP 狀態碼：400 ** ResourceNotFoundException ** 找不到指定的資源。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/StopRecommender) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/StopRecommender) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/StopRecommender) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/StopRecommender) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/StopRecommender) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/StopRecommender) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/StopRecommender) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/StopRecommender) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/StopRecommender) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/StopRecommender) # StopSolutionVersionCreation 停止建立處於 CREATE\$1PENDING 或 CREATE IN\$1PROGRESS 狀態的解決方案版本。根據解決方案版本的目前狀態，解決方案版本狀態會變更，如下所示： + CREATE\$1PENDING > CREATE\$1STOPPED 或 + CREATE\$1IN\$1PROGRESS > CREATE\$1STOPPING > CREATE\$1STOPPED 在您停止建立解決方案版本之前，所有完成的訓練都會向您收費。解決方案版本一旦停止，您就無法繼續建立。 ## 請求語法 ``` { "solutionVersionArn": "string" } ``` ## 請求參數請求接受採用 JSON 格式的下列資料。 ** [solutionVersionArn](#API_StopSolutionVersionCreation_RequestSyntax) ** 您要停止建立之解決方案版本的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：是 ## 回應元素如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。 ## 錯誤 ** InvalidInputException ** 提供欄位或參數的有效值。 HTTP 狀態碼：400 ** ResourceInUseException ** 指定的資源正在使用中。 HTTP 狀態碼：400 ** ResourceNotFoundException ** 找不到指定的資源。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/StopSolutionVersionCreation) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/StopSolutionVersionCreation) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/StopSolutionVersionCreation) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/StopSolutionVersionCreation) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/StopSolutionVersionCreation) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/StopSolutionVersionCreation) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/StopSolutionVersionCreation) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/StopSolutionVersionCreation) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/StopSolutionVersionCreation) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/StopSolutionVersionCreation) # TagResource 將標籤清單新增至資源。 ## 請求語法 ``` { "resourceArn": "string", "tags": [ { "tagKey": "string", "tagValue": "string" } ] } ``` ## 請求參數請求接受採用 JSON 格式的下列資料。 ** [resourceArn](#API_TagResource_RequestSyntax) ** 資源的 Amazon Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/TagResource) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/TagResource) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/TagResource) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/TagResource) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/TagResource) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/TagResource) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/TagResource) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/TagResource) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/TagResource) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/TagResource) # UntagResource 移除連接至資源的指定標籤。如需詳細資訊，請參閱[從 Amazon Personalize 資源移除標籤](https://docs.aws.amazon.com/personalize/latest/dg/tags-remove.html)。 ## 請求語法 ``` { "resourceArn": "string", "tagKeys": [ "string" ] } ``` ## 請求參數請求接受採用 JSON 格式的下列資料。 ** [resourceArn](#API_UntagResource_RequestSyntax) ** 資源的 Amazon Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/UntagResource) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/UntagResource) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/UntagResource) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/UntagResource) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/UntagResource) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/UntagResource) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/UntagResource) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/UntagResource) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/UntagResource) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/UntagResource) # UpdateCampaign 更新行銷活動以使用現有行銷活動部署重新訓練的解決方案版本、變更行銷活動的 `minProvisionedTPS`，或修改行銷活動的組態。例如，您可以將現有行銷活動的 `enableMetadataWithRecommendations` 設為 true。若要更新行銷活動以使用最新的解決方案版本自動啟動，請指定下列項目： + 針對 `SolutionVersionArn` 參數，以 `SolutionArn/$LATEST` 格式指定解決方案的 Amazon Resource Name (ARN)。 + 在中`campaignConfig`，將 `syncWithLatestSolutionVersion` 設定為 `true`。若要更新行銷活動，行銷活動狀態必須為 ACTIVE 或 CREATE FAILED。使用 [DescribeCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html) 操作檢查行銷活動狀態。 **注意** 當更新正在進行時，您仍然可以從行銷活動取得建議。行銷活動將使用先前的解決方案版本和行銷活動組態來產生建議，直到最新的行銷活動更新狀態為為止`Active`。如需更新行銷活動的詳細資訊，包括程式碼範例，請參閱[更新行銷活動](https://docs.aws.amazon.com/personalize/latest/dg/update-campaigns.html)。如需行銷活動的詳細資訊，請參閱[建立行銷活動](https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html)。 ## 請求語法 ``` { "campaignArn": "string", "campaignConfig": { "enableMetadataWithRecommendations": boolean, "itemExplorationConfig": { "string" : "string" }, "rankingInfluence": { "string" : number }, "syncWithLatestSolutionVersion": boolean }, "minProvisionedTPS": number, "solutionVersionArn": "string" } ``` ## 請求參數請求接受採用 JSON 格式的下列資料。 ** [campaignArn](#API_UpdateCampaign_RequestSyntax) ** 行銷活動的 Amazon Resource Name (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 Resource Name (ARN)。若要指定解決方案的最新解決方案版本，請以 `SolutionArn/$LATEST` 格式指定*解決方案*的 ARN。如果您在 [CampaignConfig](https://docs.aws.amazon.com/personalize/latest/dg/API_CampaignConfig.html) `True`中`syncWithLatestSolutionVersion`將設定為，則必須使用此格式。若要部署不是解決方案最新版本的模型，請指定解決方案版本的 ARN。如需自動行銷活動更新的詳細資訊，請參閱[啟用自動行銷活動更新](https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-automatic-latest-sv-update)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ## 回應語法 ``` { "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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/UpdateCampaign) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/UpdateCampaign) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/UpdateCampaign) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/UpdateCampaign) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/UpdateCampaign) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/UpdateCampaign) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/UpdateCampaign) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/UpdateCampaign) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/UpdateCampaign) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/UpdateCampaign) # UpdateDataset 更新資料集，將其結構描述取代為新的或現有的結構描述。如需詳細資訊，請參閱[取代資料集的結構描述](https://docs.aws.amazon.com/personalize/latest/dg/updating-dataset-schema.html)。 ## 請求語法 ``` { "datasetArn": "string", "schemaArn": "string" } ``` ## 請求參數請求接受採用 JSON 格式的下列資料。 ** [datasetArn](#API_UpdateDataset_RequestSyntax) ** 您要更新之資料集的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：是 ** [schemaArn](#API_UpdateDataset_RequestSyntax) ** 您想要使用的新結構描述的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：是 ## 回應語法 ``` { "datasetArn": "string" } ``` ## 回應元素如果動作成功，則服務傳回 HTTP 200 回應。服務會傳回下列 JSON 格式的資料。 ** [datasetArn](#API_UpdateDataset_ResponseSyntax) ** 您更新之資料集的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` ## 錯誤 ** InvalidInputException ** 提供欄位或參數的有效值。 HTTP 狀態碼：400 ** ResourceInUseException ** 指定的資源正在使用中。 HTTP 狀態碼：400 ** ResourceNotFoundException ** 找不到指定的資源。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/UpdateDataset) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/UpdateDataset) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/UpdateDataset) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/UpdateDataset) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/UpdateDataset) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/UpdateDataset) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/UpdateDataset) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/UpdateDataset) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/UpdateDataset) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/UpdateDataset) # UpdateMetricAttribution 更新指標屬性。 ## 請求語法 ``` { "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 Resource Name (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 Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` ## 錯誤 ** InvalidInputException ** 提供欄位或參數的有效值。 HTTP 狀態碼：400 ** ResourceAlreadyExistsException ** 指定的資源已存在。 HTTP 狀態碼：400 ** ResourceInUseException ** 指定的資源正在使用中。 HTTP 狀態碼：400 ** ResourceNotFoundException ** 找不到指定的資源。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/UpdateMetricAttribution) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/UpdateMetricAttribution) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/UpdateMetricAttribution) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/UpdateMetricAttribution) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/UpdateMetricAttribution) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/UpdateMetricAttribution) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/UpdateMetricAttribution) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/UpdateMetricAttribution) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/UpdateMetricAttribution) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/UpdateMetricAttribution) # UpdateRecommender 更新建議程式以修改建議程式組態。如果您更新建議程式以修改訓練中使用的資料欄，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 Resource Name (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 Resource Name (ARN) 相同。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` ## 錯誤 ** InvalidInputException ** 提供欄位或參數的有效值。 HTTP 狀態碼：400 ** ResourceInUseException ** 指定的資源正在使用中。 HTTP 狀態碼：400 ** ResourceNotFoundException ** 找不到指定的資源。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/UpdateRecommender) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/UpdateRecommender) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/UpdateRecommender) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/UpdateRecommender) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/UpdateRecommender) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/UpdateRecommender) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/UpdateRecommender) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/UpdateRecommender) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/UpdateRecommender) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/UpdateRecommender) # UpdateSolution 更新 Amazon Personalize 解決方案，以使用不同的自動訓練組態。當您更新解決方案時，可以變更解決方案是否使用自動訓練，也可以變更訓練頻率。如需更新解決方案的詳細資訊，請參閱[更新解決方案](https://docs.aws.amazon.com/personalize/latest/dg/updating-solution.html)。解決方案更新可以處於下列其中一種狀態： CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED 若要取得解決方案更新的狀態，請呼叫 [DescribeSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html) API 操作，並在中尋找狀態`latestSolutionUpdate`。 ## 請求語法 ``` { "performAutoTraining": boolean, "performIncrementalUpdate": boolean, "solutionArn": "string", "solutionUpdateConfig": { "autoTrainingConfig": { "schedulingExpression": "string" }, "eventsConfig": { "eventParametersList": [ { "eventType": "string", "eventValueThreshold": number, "weight": number } ] } } } ``` ## 請求參數請求接受採用 JSON 格式的下列資料。 ** [performAutoTraining](#API_UpdateSolution_RequestSyntax) ** 解決方案是否使用自動訓練來建立新的解決方案版本（訓練過的模型）。您可以在 `schedulingExpression`中指定 `AutoTrainingConfig`作為解決方案組態的一部分，以變更訓練頻率。如果您開啟自動訓練，第一個自動訓練會在解決方案更新完成後一小時內開始。如果您在一小時內手動建立解決方案版本，解決方案會略過第一個自動訓練。如需自動訓練的詳細資訊，請參閱[設定自動訓練](https://docs.aws.amazon.com/personalize/latest/dg/solution-config-auto-training.html)。訓練開始後，您可以使用 [ListSolutionVersions](https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html) API 操作取得解決方案版本的 Amazon Resource Name (ARN)。若要取得其狀態，請使用 [DescribeSolutionVersion](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html)。類型：布林值必要：否 ** [performIncrementalUpdate](#API_UpdateSolution_RequestSyntax) ** 是否對模型執行增量訓練更新。啟用時，這可讓模型更頻繁地從新資料中學習，而無需完整重新訓練，從而實現近乎即時的個人化。只有使用語意相似性配方的解決方案才支援此參數。類型：布林值必要：否 ** [solutionArn](#API_UpdateSolution_RequestSyntax) ** 要更新之解決方案的 Amazon Resource Name (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 Resource Name (ARN) 相同。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` ## 錯誤 ** InvalidInputException ** 提供欄位或參數的有效值。 HTTP 狀態碼：400 ** LimitExceededException ** 已超過每秒請求數的限制。 HTTP 狀態碼：400 ** ResourceInUseException ** 指定的資源正在使用中。 HTTP 狀態碼：400 ** ResourceInUseException ** 指定的資源正在使用中。 HTTP 狀態碼：400 ** ResourceNotFoundException ** 找不到指定的資源。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/UpdateSolution) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/UpdateSolution) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/UpdateSolution) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/UpdateSolution) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/UpdateSolution) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/UpdateSolution) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/UpdateSolution) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/UpdateSolution) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/UpdateSolution) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/UpdateSolution) # Amazon Personalize Events 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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-events-2018-03-22/PutActionInteractions) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-events-2018-03-22/PutActionInteractions) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/PutActionInteractions) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-events-2018-03-22/PutActionInteractions) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/PutActionInteractions) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-events-2018-03-22/PutActionInteractions) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-events-2018-03-22/PutActionInteractions) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-events-2018-03-22/PutActionInteractions) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-events-2018-03-22/PutActionInteractions) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/PutActionInteractions) # PutActions 將一或多個動作新增至動作資料集。如需詳細資訊，請參閱[個別匯入動作](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 Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：是 ## 回應語法 ``` HTTP/1.1 200 ``` ## 回應元素如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。 ## 錯誤 ** InvalidInputException ** 提供欄位或參數的有效值。 HTTP 狀態碼：400 ** ResourceInUseException ** 指定的資源正在使用中。 HTTP 狀態碼：409 ** ResourceNotFoundException ** 找不到指定的資源。 HTTP 狀態碼：404 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-events-2018-03-22/PutActions) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-events-2018-03-22/PutActions) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/PutActions) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-events-2018-03-22/PutActions) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/PutActions) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-events-2018-03-22/PutActions) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-events-2018-03-22/PutActions) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-events-2018-03-22/PutActions) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-events-2018-03-22/PutActions) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/PutActions) # PutEvents 記錄項目互動事件資料。如需詳細資訊，請參閱[錄製項目互動事件](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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-events-2018-03-22/PutEvents) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-events-2018-03-22/PutEvents) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/PutEvents) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-events-2018-03-22/PutEvents) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/PutEvents) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-events-2018-03-22/PutEvents) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-events-2018-03-22/PutEvents) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-events-2018-03-22/PutEvents) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-events-2018-03-22/PutEvents) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/PutEvents) # PutItems 將一或多個項目新增至項目資料集。如需詳細資訊，請參閱[個別匯入項目](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 Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-events-2018-03-22/PutItems) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-events-2018-03-22/PutItems) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/PutItems) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-events-2018-03-22/PutItems) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/PutItems) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-events-2018-03-22/PutItems) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-events-2018-03-22/PutItems) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-events-2018-03-22/PutItems) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-events-2018-03-22/PutItems) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/PutItems) # PutUsers 將一或多個使用者新增至使用者資料集。如需詳細資訊，請參閱[個別匯入使用者](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 Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-events-2018-03-22/PutUsers) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-events-2018-03-22/PutUsers) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/PutUsers) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-events-2018-03-22/PutUsers) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/PutUsers) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-events-2018-03-22/PutUsers) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-events-2018-03-22/PutUsers) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-events-2018-03-22/PutUsers) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-events-2018-03-22/PutUsers) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/PutUsers) # Amazon Personalize Runtime Amazon Personalize 執行期支援下列動作： + [GetActionRecommendations](API_RS_GetActionRecommendations.md) + [GetPersonalizedRanking](API_RS_GetPersonalizedRanking.md) + [GetRecommendations](API_RS_GetRecommendations.md) # GetActionRecommendations 傳回依預測分數以遞減順序排序的建議動作清單。如果您有部署以個人化\$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 Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-runtime-2018-05-22/GetActionRecommendations) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-runtime-2018-05-22/GetActionRecommendations) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-runtime-2018-05-22/GetActionRecommendations) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-runtime-2018-05-22/GetActionRecommendations) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-runtime-2018-05-22/GetActionRecommendations) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-runtime-2018-05-22/GetActionRecommendations) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-runtime-2018-05-22/GetActionRecommendations) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-runtime-2018-05-22/GetActionRecommendations) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-runtime-2018-05-22/GetActionRecommendations) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-runtime-2018-05-22/GetActionRecommendations) # GetPersonalizedRanking 重新排序給定使用者的建議項目清單。清單中的第一個項目視為使用者最可能感興趣的項目。 **注意** 您必須已使用類型為 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 Resource Name (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 Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-runtime-2018-05-22/GetPersonalizedRanking) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-runtime-2018-05-22/GetPersonalizedRanking) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-runtime-2018-05-22/GetPersonalizedRanking) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-runtime-2018-05-22/GetPersonalizedRanking) + [AWS 適用於 Java V2 的開發套件](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-runtime-2018-05-22/GetPersonalizedRanking) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-runtime-2018-05-22/GetPersonalizedRanking) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-runtime-2018-05-22/GetPersonalizedRanking) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-runtime-2018-05-22/GetPersonalizedRanking) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-runtime-2018-05-22/GetPersonalizedRanking) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-runtime-2018-05-22/GetPersonalizedRanking) # GetRecommendations 傳回建議項目的清單。對於行銷活動，行銷活動的 Amazon Resource Name (ARN) 是必要的，所需的使用者和項目輸入取決於用來建立支援行銷活動之解決方案的配方類型，如下所示： + USER\$1PERSONALIZATION - `userId`必要，`itemId`不使用 + RELATED\$1ITEMS - `itemId`必要，`userId`不使用 **注意** 由使用類型為 PersonalIZED\$1RANKING 的配方建立的解決方案所支援的行銷活動會使用 [GetPersonalizedRanking](API_RS_GetPersonalizedRanking.md) API。對於推薦者，推薦者的 ARN 是必要的，所需的項目和使用者輸入取決於支援推薦者的使用案例（以網域為基礎的配方）。如需使用案例需求的資訊，請參閱[選擇推薦者使用案例](https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html)。 ## 請求語法 ``` 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 Resource Name (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 Resource Name (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 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/personalize-runtime-2018-05-22/GetRecommendations) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-runtime-2018-05-22/GetRecommendations) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-runtime-2018-05-22/GetRecommendations) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-runtime-2018-05-22/GetRecommendations) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-runtime-2018-05-22/GetRecommendations) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-runtime-2018-05-22/GetRecommendations) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-runtime-2018-05-22/GetRecommendations) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-runtime-2018-05-22/GetRecommendations) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/personalize-runtime-2018-05-22/GetRecommendations) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-runtime-2018-05-22/GetRecommendations) # 資料類型 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 執行期支援下列資料類型： + [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 Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** algorithmImage ** 演算法映像的 Docker 容器 URI。類型：[AlgorithmImage](API_AlgorithmImage.md) 物件必要：否 ** creationDateTime ** 演算法建立的日期和時間（以 Unix 時間為單位）。類型：Timestamp 必要：否 ** defaultHyperParameterRanges ** 指定預設超參數、其範圍，以及它們是否可調校。可調整的超參數可以在超參數最佳化 (HPO) 期間決定其值。類型：[DefaultHyperParameterRanges](API_DefaultHyperParameterRanges.md) 物件必要：否 ** defaultHyperParameters ** 指定預設超參數。類型：字串到字串映射映射項目：最多 100 個項目。金鑰長度限制：長度上限為 256。值長度限制：長度上限為 1000。必要：否 ** defaultResourceConfig ** 指定訓練任務和平行訓練任務的預設最大數量。類型：字串到字串映射映射項目：最多 100 個項目。金鑰長度限制：長度上限為 256。值長度限制：長度上限為 1000。必要：否 ** lastUpdatedDateTime ** 演算法上次更新的日期和時間（以 Unix 時間為單位）。類型：Timestamp 必要：否 ** name ** 演算法的名稱。類型：字串長度限制：長度下限為 1。長度上限為 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必要：否 ** roleArn ** 角色的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** trainingInputMode ** 訓練輸入模式。類型：字串長度限制：長度上限為 256。必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Algorithm) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/Algorithm) + [AWS 適用於 Ruby V3 的 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 SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/AlgorithmImage) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/AlgorithmImage) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/AlgorithmImage) # AutoMLConfig 解決方案執行 AutoML (`performAutoML` 在 [CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) 中為 true) 時，Amazon Personalize 會從指定清單中決定哪個配方最佳化指定的指標。Amazon Personalize 接著會針對解決方案使用該配方。 ## 目錄 ** metricName ** 要最佳化的指標。類型：字串長度限制：長度上限為 256。必要：否 ** recipeList ** 候選配方清單。類型：字串陣列陣列成員：最多 100 個項目。長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/AutoMLConfig) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/AutoMLConfig) + [AWS 適用於 Ruby V3 的 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 Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/AutoMLResult) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/AutoMLResult) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/AutoMLResult) # AutoTrainingConfig 當 `performAutoTraining` 為 true 時要使用的自動訓練組態。 ## 目錄 ** schedulingExpression ** 指定自動訓練新解決方案版本的頻率。以 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 SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/AutoTrainingConfig) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/AutoTrainingConfig) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/AutoTrainingConfig) # BatchInferenceJob 包含批次推論任務的相關資訊。 ## 目錄 ** batchInferenceJobArn ** 批次推論任務的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** batchInferenceJobConfig ** 批次推論任務組態詳細資訊的字串對字串映射。類型：[BatchInferenceJobConfig](API_BatchInferenceJobConfig.md) 物件必要：否 ** batchInferenceJobMode ** 任務的模式。類型：字串有效值:`BATCH_INFERENCE | THEME_GENERATION` 必要：否 ** creationDateTime ** 建立批次推論任務的時間。類型：Timestamp 必要：否 ** 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 ** 批次推論任務上次更新的時間。類型：Timestamp 必要：否 ** 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 Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** status ** 批次推論任務的狀態。狀態是下列其中一個值： + 待定 + 進行中 + ACTIVE + 建立失敗類型：字串長度限制：長度上限為 256。必要：否 ** themeGenerationConfig ** 任務的主題產生設定。類型：[ThemeGenerationConfig](API_ThemeGenerationConfig.md) 物件必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchInferenceJob) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchInferenceJob) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchInferenceJob) # BatchInferenceJobConfig 批次推論任務的組態詳細資訊。 ## 目錄 ** itemExplorationConfig ** 字串對字串映射，指定探勘組態超參數，包括 `explorationWeight`和 `explorationItemAgeCutOff`，您想要用來設定 Amazon Personalize 在建議項目時使用的項目探勘量。請參閱[使用者個人化](https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html)。類型：字串到字串映射映射項目：最多 100 個項目。金鑰長度限制：長度上限為 256。值長度限制：長度上限為 1000。必要：否 ** rankingInfluence ** POPULARITY 和 FRESHNESS 的排名影響值映射。針對每個索引鍵，指定介於 0.0 和 1.0 之間的數值，以決定排名因素對最終建議的影響程度。接近 1.0 的值提供更多的權重給係數，而接近 0.0 的值則降低其影響。如果未指定，則兩者都預設為 0.0。類型：String 到 double 映射有效金鑰：`POPULARITY | FRESHNESS` 有效範圍：最小值為 0。最大值為 1。必要：否 ## 另請參閱如需在其中一種語言特定 AWSSDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchInferenceJobConfig) + [AWS適用於 Java V2 的 SDK](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 SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchInferenceJobInput) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchInferenceJobInput) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchInferenceJobInput) # BatchInferenceJobOutput 批次推論任務的輸出組態參數。 ## 目錄 ** s3DataDestination ** 儲存批次推論任務輸出的 Amazon S3 儲存貯體資訊。類型：[S3DataConfig](API_S3DataConfig.md) 物件必要：是 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchInferenceJobOutput) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchInferenceJobOutput) + [AWS 適用於 Ruby V3 的 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 Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** batchInferenceJobMode ** 任務的模式。類型：字串有效值:`BATCH_INFERENCE | THEME_GENERATION` 必要：否 ** creationDateTime ** 建立批次推論任務的時間。類型：Timestamp 必要：否 ** failureReason ** 如果批次推論任務失敗，則為失敗原因。類型：字串必要：否 ** jobName ** 批次推論任務的名稱。類型：字串長度限制：長度下限為 1。長度上限為 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必要：否 ** lastUpdatedDateTime ** 批次推論任務上次更新的時間。類型：Timestamp 必要：否 ** solutionVersionArn ** 批次推論任務所使用的解決方案版本的 ARN。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** status ** 批次推論任務的狀態。狀態是下列其中一個值： + 待定 + 進行中 + ACTIVE + 建立失敗類型：字串長度限制：長度上限為 256。必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchInferenceJobSummary) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchInferenceJobSummary) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchInferenceJobSummary) # BatchSegmentJob 包含批次區段任務的相關資訊。 ## 目錄 ** batchSegmentJobArn ** 批次區段任務的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** creationDateTime ** 建立批次區段任務的時間。類型：Timestamp 必要：否 ** 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 ** 批次區段任務上次更新的時間。類型：Timestamp 必要：否 ** 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 Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** status ** 批次區段任務的狀態。狀態是下列其中一個值： + 待定 + 進行中 + ACTIVE + 建立失敗類型：字串長度限制：長度上限為 256。必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchSegmentJob) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchSegmentJob) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchSegmentJob) # BatchSegmentJobInput 批次區段任務的輸入組態。 ## 目錄 ** s3DataSource ** Amazon S3 輸入或輸出儲存貯體的組態詳細資訊。類型：[S3DataConfig](API_S3DataConfig.md) 物件必要：是 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchSegmentJobInput) + [AWS 適用於 Java V2 的開發套件](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchSegmentJobInput) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchSegmentJobInput) # BatchSegmentJobOutput 批次區段任務的輸出組態參數。 ## 目錄 ** s3DataDestination ** Amazon S3 輸入或輸出儲存貯體的組態詳細資訊。類型：[S3DataConfig](API_S3DataConfig.md) 物件必要：是 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchSegmentJobOutput) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchSegmentJobOutput) + [AWS 適用於 Ruby V3 的 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 Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** creationDateTime ** 建立批次區段任務的時間。類型：Timestamp 必要：否 ** failureReason ** 如果批次區段任務失敗，則為失敗原因。類型：字串必要：否 ** jobName ** 批次區段任務的名稱。類型：字串長度限制：長度下限為 1。長度上限為 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必要：否 ** lastUpdatedDateTime ** 批次區段任務上次更新的時間。類型：Timestamp 必要：否 ** solutionVersionArn ** 批次區段任務用來產生批次區段之解決方案版本的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** status ** 批次區段任務的狀態。狀態是下列其中一個值： + 待定 + 進行中 + ACTIVE + 建立失敗類型：字串長度限制：長度上限為 256。必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchSegmentJobSummary) + [AWS 適用於 Java V2 的開發套件](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/BatchSegmentJobSummary) + [AWS 適用於 Ruby V3 的 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 Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** campaignConfig ** 行銷活動的組態詳細資訊。類型：[CampaignConfig](API_CampaignConfig.md) 物件必要：否 ** creationDateTime ** 行銷活動建立的日期和時間 (Unix 格式）。類型：Timestamp 必要：否 ** failureReason ** 如果行銷活動失敗，則為失敗背後的原因。類型：字串必要：否 ** lastUpdatedDateTime ** 行銷活動上次更新的日期和時間 (Unix 格式）。類型：Timestamp 必要：否 ** latestCampaignUpdate ** 提供行銷活動更新的屬性摘要。如需完整清單，請呼叫 [DescribeCampaign](https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html) API。只有當行銷活動至少有一個`UpdateCampaign`呼叫時，才會傳回 `latestCampaignUpdate` 欄位。類型：[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 Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** status ** 行銷活動的狀態。行銷活動可以處於下列其中一種狀態： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED + DELETE PENDING > DELETE IN\$1PROGRESS 類型：字串長度限制：長度上限為 256。必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Campaign) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/Campaign) + [AWS 適用於 Ruby V3 的 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 在建議項目時使用的項目探勘量。只有當您的解決方案使用[使用者個人化](https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html)配方時，才提供`itemExplorationConfig`資料。類型：字串到字串映射映射項目：最多 100 個項目。金鑰長度限制：長度上限為 256。值長度限制：長度上限為 1000。必要：否 ** rankingInfluence ** POPULARITY 和 FRESHNESS 的排名影響值映射。針對每個索引鍵，指定介於 0.0 和 1.0 之間的數值，以決定排名因素對最終建議的影響程度。接近 1.0 的值提供更多的權重給係數，而接近 0.0 的值則降低其影響。如果未指定，則兩者都預設為 0.0。類型：String 到 double 映射有效金鑰：`POPULARITY | FRESHNESS` 有效範圍：最小值為 0。最大值為 1。必要：否 ** syncWithLatestSolutionVersion ** 行銷活動是否自動更新以使用解決方案的最新解決方案版本（訓練模型）。如果您指定 `True`，則必須為 `SolutionVersionArn` 參數指定*解決方案*的 ARN。它必須是 `SolutionArn/$LATEST` 格式。預設值為 `False`，您必須手動更新行銷活動以部署最新的解決方案版本。如需自動行銷活動更新的詳細資訊，請參閱[啟用自動行銷活動更新](https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-automatic-latest-sv-update)。類型：布林值必要：否 ## 另請參閱如需在其中一種語言特定 AWSSDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CampaignConfig) + [AWS適用於 Java V2 的 SDK](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 Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** creationDateTime ** 行銷活動建立的日期和時間（以 Unix 時間為單位）。類型：Timestamp 必要：否 ** failureReason ** 如果行銷活動失敗，則為失敗背後的原因。類型：字串必要：否 ** lastUpdatedDateTime ** 行銷活動上次更新的日期和時間（以 Unix 時間為單位）。類型：Timestamp 必要：否 ** name ** 行銷活動的名稱。類型：字串長度限制：長度下限為 1。長度上限為 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必要：否 ** status ** 行銷活動的狀態。行銷活動可以處於下列其中一種狀態： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED + DELETE PENDING > DELETE IN\$1PROGRESS 類型：字串長度限制：長度上限為 256。必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CampaignSummary) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CampaignSummary) + [AWS 適用於 Ruby V3 的 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 時間為單位）。類型：Timestamp 必要：否 ** failureReason ** 如果行銷活動更新失敗，則為失敗背後的原因。類型：字串必要：否 ** lastUpdatedDateTime ** 行銷活動更新上次更新的日期和時間（以 Unix 時間為單位）。類型：Timestamp 必要：否 ** minProvisionedTPS ** 指定 Amazon Personalize 將支援的每秒請求的最低佈建交易（建議）。類型：整數有效範圍：最小值為 1。必要：否 ** solutionVersionArn ** 部署解決方案版本的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** status ** 行銷活動更新的狀態。行銷活動更新可以處於下列其中一種狀態： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED + DELETE PENDING > DELETE IN\$1PROGRESS 類型：字串長度限制：長度上限為 256。必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CampaignUpdateSummary) + [AWS 適用於 Java V2 的開發套件](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CampaignUpdateSummary) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CampaignUpdateSummary) # CategoricalHyperParameterRange 提供分類超參數的名稱和範圍。 ## 目錄 ** name ** 超參數的名稱。類型：字串長度限制：長度上限為 256。必要：否 ** values ** 超參數分類的清單。類型：字串陣列陣列成員：最多 100 個項目。長度限制：長度上限為 1000。必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CategoricalHyperParameterRange) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/CategoricalHyperParameterRange) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CategoricalHyperParameterRange) # ContinuousHyperParameterRange 提供連續超參數的名稱和範圍。 ## 目錄 ** maxValue ** 超參數的最大允許值。類型：Double 有效範圍：最小值為 -1000000。必要：否 ** minValue ** 超參數的最小允許值。類型：Double 有效範圍：最小值為 -1000000。必要：否 ** name ** 超參數的名稱。類型：字串長度限制：長度上限為 256。必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ContinuousHyperParameterRange) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ContinuousHyperParameterRange) + [AWS 適用於 Ruby V3 的 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 時間為單位）。類型：Timestamp 必要：否 ** dataDeletionJobArn ** 資料刪除任務的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** datasetGroupArn ** 任務從中刪除記錄之資料集群組的 Amazon Resource Name (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 時間為單位）。類型：Timestamp 必要：否 ** numDeleted ** COMPLETED 任務刪除的記錄數目。類型：整數必要：否 ** roleArn ** 具有從 Amazon S3 資料來源讀取許可之 IAM 角色的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` 必要：否 ** status ** 資料刪除任務的狀態。資料刪除任務可以有下列其中一種狀態： + 待定 > IN\$1PROGRESS > COMPLETED -or- FAILED 類型：字串長度限制：長度上限為 256。必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DataDeletionJob) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DataDeletionJob) + [AWS 適用於 Ruby V3 的 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 時間為單位）。類型：Timestamp 必要：否 ** dataDeletionJobArn ** 資料刪除任務的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** datasetGroupArn ** 任務從中刪除記錄之資料集群組的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** failureReason ** 如果資料刪除任務失敗，會提供原因。類型：字串必要：否 ** jobName ** 資料刪除任務的名稱。類型：字串長度限制：長度下限為 1。長度上限為 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必要：否 ** lastUpdatedDateTime ** 上次更新資料刪除任務的日期和時間（以 Unix 時間為單位）。類型：Timestamp 必要：否 ** status ** 資料刪除任務的狀態。資料刪除任務可以具有下列其中一種狀態： + 待定 > IN\$1PROGRESS > COMPLETED -or- FAILED 類型：字串長度限制：長度上限為 256。必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DataDeletionJobSummary) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DataDeletionJobSummary) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DataDeletionJobSummary) # Dataset 提供資料集的中繼資料。 ## 目錄 ** creationDateTime ** 資料集的建立日期和時間（以 Unix 時間為單位）。類型：Timestamp 必要：否 ** datasetArn ** 您要用於中繼資料之資料集的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** datasetGroupArn ** 資料集群組的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** datasetType ** 下列其中一值： + 互動 + 項目 + 使用者 + 動作 + Action\$1Interactions 類型：字串長度限制：長度上限為 256。模式：`^[A-Za-z_]+$` 必要：否 ** lastUpdatedDateTime ** 顯示資料集更新時間的時間戳記。類型：Timestamp 必要：否 ** 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 -or- CREATE FAILED + DELETE PENDING > DELETE IN\$1PROGRESS 類型：字串長度限制：長度上限為 256。必要：否 ** trackingId ** 動作互動資料集的事件追蹤器 ID。您可以在 `PutActionInteractions` API 操作中指定追蹤器的 ID。Amazon Personalize 會使用它，將新資料導向至資料集群組中的動作互動資料集。類型：字串長度限制：長度上限為 256。必要：否 ## 另請參閱如需在其中一種語言特定 AWSSDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Dataset) + [AWS適用於 Java V2 的 SDK](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 -or- CREATE FAILED ## 目錄 ** creationDateTime ** 資料集匯出任務的建立日期和時間（以 Unix 時間為單位）。類型：Timestamp 必要：否 ** datasetArn ** 要匯出之資料集的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** datasetExportJobArn ** 資料集匯出任務的 Amazon Resource Name (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 時間為單位）。類型：Timestamp 必要：否 ** roleArn ** IAM 服務角色的 Amazon Resource Name (ARN)，其具有將資料新增至輸出 Amazon S3 儲存貯體的許可。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** status ** 資料集匯出任務的狀態。資料集匯出任務可以處於下列其中一種狀態： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED 類型：字串長度限制：長度上限為 256。必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetExportJob) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetExportJob) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetExportJob) # DatasetExportJobOutput 資料集匯出任務的輸出組態參數。 ## 目錄 ** s3DataDestination ** Amazon S3 輸入或輸出儲存貯體的組態詳細資訊。類型：[S3DataConfig](API_S3DataConfig.md) 物件必要：是 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetExportJobOutput) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetExportJobOutput) + [AWS 適用於 Ruby V3 的 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 時間為單位）。類型：Timestamp 必要：否 ** datasetExportJobArn ** 資料集匯出任務的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** failureReason ** 如果資料集匯出任務失敗，則為失敗背後的原因。類型：字串必要：否 ** jobName ** 資料集匯出任務的名稱。類型：字串長度限制：長度下限為 1。長度上限為 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必要：否 ** lastUpdatedDateTime ** 資料集匯出任務狀態上次更新的日期和時間（以 Unix 時間為單位）。類型：Timestamp 必要：否 ** status ** 資料集匯出任務的狀態。資料集匯出任務可以處於下列其中一種狀態： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED 類型：字串長度限制：長度上限為 256。必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetExportJobSummary) + [AWS 適用於 Java V2 的開發套件](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetExportJobSummary) + [AWS 適用於 Ruby V3 的 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 時間為單位）。類型：Timestamp 必要：否 ** datasetGroupArn ** 資料集群組的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** domain ** 網域資料集群組的網域。類型：字串有效值:`ECOMMERCE | VIDEO_ON_DEMAND` 必要：否 ** failureReason ** 如果建立資料集群組失敗，會提供原因。類型：字串必要：否 ** kmsKeyArn ** 用來加密資料集之 (KMS) 金鑰的 Amazon Resource Name AWS Key Management Service (ARN)。類型：字串長度限制：長度上限為 2048。模式：`arn:aws.*:kms:.*:[0-9]{12}:key/.*` 必要：否 ** lastUpdatedDateTime ** 資料集群組的上次更新日期和時間（以 Unix 時間為單位）。類型：Timestamp 必要：否 ** name ** 資料集群組的名稱。類型：字串長度限制：長度下限為 1。長度上限為 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必要：否 ** roleArn ** 具有存取 AWS Identity and Access Management (KMS) 金鑰許可之 AWS Key Management Service (IAM) 角色的 ARN。只有在同時指定 KMS 金鑰時，提供 IAM 角色才有效。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+` 必要：否 ** status ** 資料集群組的目前狀態。資料集群組可以處於下列其中一種狀態： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED + 刪除擱置中類型：字串長度限制：長度上限為 256。必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetGroup) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetGroup) + [AWS 適用於 Ruby V3 的 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 時間為單位）。類型：Timestamp 必要：否 ** datasetGroupArn ** 資料集群組的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** domain ** 網域資料集群組的網域。類型：字串有效值:`ECOMMERCE | VIDEO_ON_DEMAND` 必要：否 ** failureReason ** 如果建立資料集群組失敗，則失敗背後的原因。類型：字串必要：否 ** lastUpdatedDateTime ** 資料集群組上次更新的日期和時間（以 Unix 時間為單位）。類型：Timestamp 必要：否 ** name ** 資料集群組的名稱。類型：字串長度限制：長度下限為 1。長度上限為 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必要：否 ** status ** 資料集群組的狀態。資料集群組可以處於下列其中一種狀態： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED + 刪除擱置中類型：字串長度限制：長度上限為 256。必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetGroupSummary) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetGroupSummary) + [AWS 適用於 Ruby V3 的 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 -or- CREATE FAILED ## 目錄 ** creationDateTime ** 資料集匯入任務的建立日期和時間（以 Unix 時間為單位）。類型：Timestamp 必要：否 ** datasetArn ** 接收匯入資料之資料集的 Amazon Resource Name (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 時間為單位）。類型：Timestamp 必要：否 ** publishAttributionMetricsToS3 ** 任務是否針對指標屬性將指標發佈至 Amazon S3。類型：布林值必要：否 ** roleArn ** 此為 IAM 角色的 ARN，該角色具有從 Amazon S3 資料來源讀取資料的許可。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** status ** 資料集匯入任務的狀態。資料集匯入任務可處於下列任意一種狀態： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED 類型：字串長度限制：長度上限為 256。必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetImportJob) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetImportJob) + [AWS 適用於 Ruby V3 的 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 時間為單位）。類型：Timestamp 必要：否 ** datasetImportJobArn ** 資料集匯入任務的 Amazon Resource Name (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 時間為單位）。類型：Timestamp 必要：否 ** status ** 資料集匯入任務的狀態。資料集匯入任務可處於下列任意一種狀態： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED 類型：字串長度限制：長度上限為 256。必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetImportJobSummary) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetImportJobSummary) + [AWS 適用於 Ruby V3 的 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 時間為單位）。類型：Timestamp 必要：否 ** domain ** 您為網域資料集群組中的資料集所建立的結構描述網域。類型：字串有效值:`ECOMMERCE | VIDEO_ON_DEMAND` 必要：否 ** lastUpdatedDateTime ** 上次更新結構描述的日期和時間（以 Unix 時間為單位）。類型：Timestamp 必要：否 ** name ** 結構描述的名稱。類型：字串長度限制：長度下限為 1。長度上限為 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必要：否 ** schema ** 結構描述。類型：字串長度限制：長度上限為 20000。必要：否 ** schemaArn ** 結構描述的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetSchema) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetSchema) + [AWS 適用於 Ruby V3 的 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 時間為單位）。類型：Timestamp 必要：否 ** domain ** 您為網域資料集群組中的資料集所建立的結構描述網域。類型：字串有效值:`ECOMMERCE | VIDEO_ON_DEMAND` 必要：否 ** lastUpdatedDateTime ** 上次更新結構描述的日期和時間（以 Unix 時間為單位）。類型：Timestamp 必要：否 ** name ** 結構描述的名稱。類型：字串長度限制：長度下限為 1。長度上限為 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必要：否 ** schemaArn ** 結構描述的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetSchemaSummary) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetSchemaSummary) + [AWS 適用於 Ruby V3 的 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 時間為單位）。類型：Timestamp 必要：否 ** datasetArn ** 資料集的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** datasetType ** 資料集類型。下列其中一值： + 互動 + 項目 + 使用者 + 事件互動類型：字串長度限制：長度上限為 256。模式：`^[A-Za-z_]+$` 必要：否 ** lastUpdatedDateTime ** 上次更新資料集的日期和時間（以 Unix 時間為單位）。類型：Timestamp 必要：否 ** name ** 資料集的名稱。類型：字串長度限制：長度下限為 1。長度上限為 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必要：否 ** status ** 資料集的狀態。資料集可為下列任一種狀態： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED + DELETE PENDING > DELETE IN\$1PROGRESS 類型：字串長度限制：長度上限為 256。必要：否 ## 另請參閱如需在其中一種語言特定 AWSSDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetSummary) + [AWS適用於 Java V2 的 SDK](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 時間為單位）。類型：Timestamp 必要：否 ** failureReason ** 如果更新資料集失敗，會提供原因。類型：字串必要：否 ** lastUpdatedDateTime ** 資料集的上次更新日期和時間（以 Unix 時間為單位）。類型：Timestamp 必要：否 ** schemaArn ** 取代資料集先前結構描述之結構描述的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** status ** 資料集更新的狀態。類型：字串長度限制：長度上限為 256。必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetUpdateSummary) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DatasetUpdateSummary) + [AWS 適用於 Ruby V3 的 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 SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DataSource) + [AWS 適用於 Java V2 的開發套件](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DataSource) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DataSource) # DefaultCategoricalHyperParameterRange 提供分類超參數的名稱和預設範圍，以及超參數是否可調校。可調整的超參數可以在超參數最佳化 (HPO) 期間決定其值。 ## 目錄 ** isTunable ** 超參數是否可調校。類型：布林值必要：否 ** name ** 超參數的名稱。類型：字串長度限制：長度上限為 256。必要：否 ** values ** 超參數分類的清單。類型：字串陣列陣列成員：最多 100 個項目。長度限制：長度上限為 1000。必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DefaultCategoricalHyperParameterRange) + [AWS 適用於 Java V2 的開發套件](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DefaultCategoricalHyperParameterRange) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DefaultCategoricalHyperParameterRange) # DefaultContinuousHyperParameterRange 提供連續超參數的名稱和預設範圍，以及超參數是否可調校。可調整的超參數可以在超參數最佳化 (HPO) 期間決定其值。 ## 目錄 ** isTunable ** 超參數是否可調校。類型：布林值必要：否 ** maxValue ** 超參數的最大允許值。類型：Double 有效範圍：最小值為 -1000000。必要：否 ** minValue ** 超參數的最小允許值。類型：Double 有效範圍：最小值為 -1000000。必要：否 ** name ** 超參數的名稱。類型：字串長度限制：長度上限為 256。必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DefaultContinuousHyperParameterRange) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DefaultContinuousHyperParameterRange) + [AWS 適用於 Ruby V3 的 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 SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DefaultHyperParameterRanges) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DefaultHyperParameterRanges) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DefaultHyperParameterRanges) # DefaultIntegerHyperParameterRange 提供整數值超參數的名稱和預設範圍，以及超參數是否可調校。可調整的超參數可以在超參數最佳化 (HPO) 期間決定其值。 ## 目錄 ** isTunable ** 指出超參數是否可調校。類型：布林值必要：否 ** maxValue ** 超參數的最大允許值。類型：整數有效範圍：最大值為 1000000。必要：否 ** minValue ** 超參數的最小允許值。類型：整數有效範圍：最小值為 -1000000。必要：否 ** name ** 超參數的名稱。類型：字串長度限制：長度上限為 256。必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DefaultIntegerHyperParameterRange) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DefaultIntegerHyperParameterRange) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DefaultIntegerHyperParameterRange) # EventParameters 描述用於建立解決方案的事件參數。 ## 目錄 ** eventType ** 要考慮建立解決方案的事件類型名稱。類型：字串長度限制：長度上限為 256。必要：否 ** eventValueThreshold ** 事件類型的閾值。只有值大於或等於此閾值的事件才會考慮建立解決方案。類型：Double 必要：否 ** weight ** 事件類型的權重。權重越高，表示所建立解決方案的事件類型就越重要。類型：Double 有效範圍：最小值為 0。最大值為 1。必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/EventParameters) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/EventParameters) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/EventParameters) # EventsConfig 描述用於建立解決方案的事件組態。 ## 目錄 ** eventParametersList ** 事件參數清單，其中包含事件類型及其事件值閾值和權重。類型：[EventParameters](API_EventParameters.md) 物件陣列陣列成員：最多 10 個項目。必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/EventsConfig) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/EventsConfig) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/EventsConfig) # EventTracker 提供事件追蹤器的相關資訊。 ## 目錄 ** accountId ** 擁有事件追蹤器 AWS 的帳戶。類型：字串長度限制：長度上限為 256。必要：否 ** creationDateTime ** 建立事件追蹤器的日期和時間 (Unix 格式）。類型：Timestamp 必要：否 ** datasetGroupArn ** 接收事件資料的資料集群組的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** eventTrackerArn ** 事件追蹤器的 ARN。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** lastUpdatedDateTime ** 事件追蹤器上次更新的日期和時間（以 Unix 時間為單位）。類型：Timestamp 必要：否 ** name ** 事件追蹤器的名稱。類型：字串長度限制：長度下限為 1。長度上限為 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必要：否 ** status ** 事件追蹤器的狀態。事件追蹤器可以處於下列其中一種狀態： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- 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 SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/EventTracker) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/EventTracker) + [AWS 適用於 Ruby V3 的 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 時間為單位）。類型：Timestamp 必要：否 ** eventTrackerArn ** 事件追蹤器的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** lastUpdatedDateTime ** 事件追蹤器上次更新的日期和時間（以 Unix 時間為單位）。類型：Timestamp 必要：否 ** name ** 事件追蹤器的名稱。類型：字串長度限制：長度下限為 1。長度上限為 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必要：否 ** status ** 事件追蹤器的狀態。事件追蹤器可以處於下列其中一種狀態： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED + DELETE PENDING > DELETE IN\$1PROGRESS 類型：字串長度限制：長度上限為 256。必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/EventTrackerSummary) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/EventTrackerSummary) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/EventTrackerSummary) # FeatureTransformation 提供功能轉換資訊。特徵轉換是將原始輸入資料修改為更適合於模型培訓之形式的過程。 ## 目錄 ** creationDateTime ** 功能轉換的建立日期和時間（以 Unix 時間為單位）。類型：Timestamp 必要：否 ** defaultParameters ** 提供功能轉換的預設參數。類型：字串到字串映射映射項目：最多 100 個項目。金鑰長度限制：長度上限為 256。值長度限制：長度上限為 1000。必要：否 ** featureTransformationArn ** FeatureTransformation 物件的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** lastUpdatedDateTime ** 特徵轉換的上次更新日期和時間（以 Unix 時間為單位）。類型：Timestamp 必要：否 ** name ** 功能轉換的名稱。類型：字串長度限制：長度下限為 1。長度上限為 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必要：否 ** status ** 功能轉換的狀態。功能轉換可以處於下列其中一種狀態： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED 類型：字串長度限制：長度上限為 256。必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/FeatureTransformation) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/FeatureTransformation) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/FeatureTransformation) # FieldsForThemeGeneration 主題產生之組態詳細資訊的字串對字串映射。 ## 目錄 ** itemName ** 項目資料集資料欄的名稱，用於在資料集中存放每個項目的名稱。類型：字串長度限制：長度上限為 150。模式：`[A-Za-z_][A-Za-z\d_]*` 必要：是 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/FieldsForThemeGeneration) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/FieldsForThemeGeneration) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/FieldsForThemeGeneration) # Filter 包含建議篩選條件的相關資訊，包括其 ARN、狀態和篩選條件表達式。 ## 目錄 ** creationDateTime ** 建立篩選條件的時間。類型：Timestamp 必要：否 ** 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 ** 上次更新篩選條件的時間。類型：Timestamp 必要：否 ** name ** 篩選條件的名稱。類型：字串長度限制：長度下限為 1。長度上限為 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必要：否 ** status ** 篩選條件的狀態。類型：字串長度限制：長度上限為 256。必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Filter) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/Filter) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/Filter) # FilterSummary 篩選條件屬性的簡短摘要。 ## 目錄 ** creationDateTime ** 建立篩選條件的時間。類型：Timestamp 必要：否 ** datasetGroupArn ** 篩選條件所屬之資料集群組的 ARN。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** failureReason ** 如果篩選條件失敗，則表示失敗的原因。類型：字串必要：否 ** filterArn ** 篩選條件的 ARN。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** lastUpdatedDateTime ** 上次更新篩選條件的時間。類型：Timestamp 必要：否 ** name ** 篩選條件的名稱。類型：字串長度限制：長度下限為 1。長度上限為 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必要：否 ** status ** 篩選條件的狀態。類型：字串長度限制：長度上限為 256。必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/FilterSummary) + [AWS 適用於 Java V2 的開發套件](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/FilterSummary) + [AWS 適用於 Ruby V3 的 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 SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/HPOConfig) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/HPOConfig) + [AWS 適用於 Ruby V3 的 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 SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/HPOObjective) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/HPOObjective) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/HPOObjective) # HPOResourceConfig 描述超參數最佳化 (HPO) 的資源組態。 ## 目錄 ** maxNumberOfTrainingJobs ** 建立解決方案版本時的訓練任務數量上限。`maxNumberOfTrainingJobs` 的最大值為 `40`。類型：字串長度限制：長度上限為 256。必要：否 ** maxParallelTrainingJobs ** 建立解決方案版本時的平行訓練任務數量上限。`maxParallelTrainingJobs` 的最大值為 `10`。類型：字串長度限制：長度上限為 256。必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/HPOResourceConfig) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/HPOResourceConfig) + [AWS 適用於 Ruby V3 的 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 SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/HyperParameterRanges) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/HyperParameterRanges) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/HyperParameterRanges) # IntegerHyperParameterRange 提供整數值超參數的名稱和範圍。 ## 目錄 ** maxValue ** 超參數的最大允許值。類型：整數有效範圍：最大值為 1000000。必要：否 ** minValue ** 超參數的最小允許值。類型：整數有效範圍：最小值為 -1000000。必要：否 ** name ** 超參數的名稱。類型：字串長度限制：長度上限為 256。必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/IntegerHyperParameterRange) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/IntegerHyperParameterRange) + [AWS 適用於 Ruby V3 的 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 SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/MetricAttribute) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/MetricAttribute) + [AWS 適用於 Ruby V3 的 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 ** 指標屬性的建立日期時間。類型：Timestamp 必要：否 ** datasetGroupArn ** 指標屬性的資料集群組 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** failureReason ** 指標屬性的失敗原因。類型：字串必要：否 ** lastUpdatedDateTime ** 指標屬性的上次更新日期時間。類型：Timestamp 必要：否 ** metricAttributionArn ** 指標屬性的 Amazon Resource Name (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 SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/MetricAttribution) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/MetricAttribution) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/MetricAttribution) # MetricAttributionOutput 指標屬性的輸出組態詳細資訊。 ## 目錄 ** roleArn ** IAM 服務角色的 Amazon Resource Name (ARN)，其具有將資料新增至輸出 Amazon S3 儲存貯體並將指標新增至 Amazon CloudWatch 的許可。如需詳細資訊，請參閱[測量建議的影響](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 SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/MetricAttributionOutput) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/MetricAttributionOutput) + [AWS 適用於 Ruby V3 的 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 ** 指標屬性的建立日期時間。類型：Timestamp 必要：否 ** failureReason ** 指標屬性的失敗原因。類型：字串必要：否 ** lastUpdatedDateTime ** 指標屬性的上次更新日期時間。類型：Timestamp 必要：否 ** metricAttributionArn ** 指標屬性的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** name ** 指標屬性的名稱。類型：字串長度限制：長度下限為 1。長度上限為 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必要：否 ** status ** 指標屬性的狀態。類型：字串長度限制：長度上限為 256。必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/MetricAttributionSummary) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/MetricAttributionSummary) + [AWS 適用於 Ruby V3 的 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 SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/OptimizationObjective) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/OptimizationObjective) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/OptimizationObjective) # Recipe 提供配方的相關資訊。當您使用 [CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) 操作時，每個配方都會提供 Amazon Personalize 用於模型訓練的演算法。 ## 目錄 ** algorithmArn ** Amazon Personalize 用來訓練模型之演算法的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** creationDateTime ** 建立配方的日期和時間 (Unix 格式）。類型：Timestamp 必要：否 ** description ** 配方的描述。類型：字串必要：否 ** featureTransformationArn ** FeatureTransformation 物件的 ARN。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** lastUpdatedDateTime ** 配方上次更新的日期和時間 (Unix 格式）。類型：Timestamp 必要：否 ** name ** 配方的名稱。類型：字串長度限制：長度下限為 1。長度上限為 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必要：否 ** recipeArn ** 配方的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** recipeType ** 下列其中一值： + PERSONALIZED\$1RANKING + RELATED\$1ITEMS + USER\$1PERSONALIZATION 類型：字串長度限制：長度上限為 256。必要：否 ** status ** 配方的狀態。類型：字串長度限制：長度上限為 256。必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Recipe) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/Recipe) + [AWS 適用於 Ruby V3 的 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 時間為單位）。類型：Timestamp 必要：否 ** domain ** 配方的網域（如果配方是網域資料集群組使用案例）。類型：字串有效值:`ECOMMERCE | VIDEO_ON_DEMAND` 必要：否 ** lastUpdatedDateTime ** 配方上次更新的日期和時間（以 Unix 時間為單位）。類型：Timestamp 必要：否 ** name ** 配方的名稱。類型：字串長度限制：長度下限為 1。長度上限為 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必要：否 ** recipeArn ** 配方的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** status ** 配方的狀態。類型：字串長度限制：長度上限為 256。必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/RecipeSummary) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/RecipeSummary) + [AWS 適用於 Ruby V3 的 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 格式）。類型：Timestamp 必要：否 ** datasetGroupArn ** 包含建議程式之網域資料集群組的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** failureReason ** 如果建議者失敗，則為失敗背後的原因。類型：字串必要：否 ** lastUpdatedDateTime ** 建議者上次更新的日期和時間 (Unix 格式）。類型：Timestamp 必要：否 ** latestRecommenderUpdate ** 提供建議者最新更新的摘要。類型：[RecommenderUpdateSummary](API_RecommenderUpdateSummary.md) 物件必要：否 ** modelMetrics ** 提供評估指標，協助您判斷建議者的效能。如需詳細資訊，請參閱[評估推薦者](https://docs.aws.amazon.com/personalize/latest/dg/evaluating-recommenders.html)。類型：String 到 double 映射映射項目：最多 100 個項目。金鑰長度限制：長度上限為 256。必要：否 ** name ** 建議者的名稱。類型：字串長度限制：長度下限為 1。長度上限為 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必要：否 ** recipeArn ** 建立建議者的配方（網域資料集群組使用案例）的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** recommenderArn ** 建議者的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** recommenderConfig ** 建議者的組態詳細資訊。類型：[RecommenderConfig](API_RecommenderConfig.md) 物件必要：否 ** status ** 建議者的狀態。建議者可以處於下列其中一種狀態： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED + 停止待定 > 停止 IN\$1PROGRESS > 非作用中 > 啟動待定 > 啟動 IN\$1PROGRESS > 作用中 + DELETE PENDING > DELETE IN\$1PROGRESS 類型：字串長度限制：長度上限為 256。必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Recommender) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/Recommender) + [AWS 適用於 Ruby V3 的 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 SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/RecommenderConfig) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/RecommenderConfig) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/RecommenderConfig) # RecommenderSummary 提供建議者的屬性摘要。 ## 目錄 ** creationDateTime ** 建立建議程式的日期和時間 (Unix 格式）。類型：Timestamp 必要：否 ** datasetGroupArn ** 包含建議程式之網域資料集群組的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** lastUpdatedDateTime ** 建議者上次更新的日期和時間 (Unix 格式）。類型：Timestamp 必要：否 ** name ** 建議者的名稱。類型：字串長度限制：長度下限為 1。長度上限為 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必要：否 ** recipeArn ** 建立推薦者的配方（網域資料集群組使用案例）的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** recommenderArn ** 推薦者的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** recommenderConfig ** 建議者的組態詳細資訊。類型：[RecommenderConfig](API_RecommenderConfig.md) 物件必要：否 ** status ** 建議者的狀態。推薦者可以處於下列其中一種狀態： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED + 停止待定 > 停止 IN\$1PROGRESS > 非作用中 > 啟動待定 > 啟動 IN\$1PROGRESS > 作用中 + DELETE PENDING > DELETE IN\$1PROGRESS 類型：字串長度限制：長度上限為 256。必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/RecommenderSummary) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/RecommenderSummary) + [AWS 適用於 Ruby V3 的 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 格式顯示）。類型：Timestamp 必要：否 ** failureReason ** 如果建議者更新失敗，則為失敗背後的原因。類型：字串必要：否 ** lastUpdatedDateTime ** 上次更新建議程式的日期和時間（以 Unix 時間為單位）。類型：Timestamp 必要：否 ** recommenderConfig ** 建議程式更新的組態詳細資訊。類型：[RecommenderConfig](API_RecommenderConfig.md) 物件必要：否 ** status ** 建議程式更新的狀態。建議程式更新可以處於下列其中一種狀態： CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED 類型：字串長度限制：長度上限為 256。必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/RecommenderUpdateSummary) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/RecommenderUpdateSummary) + [AWS 適用於 Ruby V3 的 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 Resource Name (ARN)。類型：字串長度限制：長度上限為 2048。模式：`arn:aws.*:kms:.*:[0-9]{12}:key/.*` 必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/S3DataConfig) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/S3DataConfig) + [AWS 適用於 Ruby V3 的 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 時間為單位）。類型：Timestamp 必要：否 ** datasetGroupArn ** 提供訓練資料之資料集群組的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** eventType ** 用來訓練模型的事件類型 (例如「按一下」或「喜歡」)。若未提供任何 `eventType`，無論類型為何，Amazon Personalize 都會使用所有互動進行相等權重的訓練。類型：字串長度限制：長度上限為 256。必要：否 ** lastUpdatedDateTime ** 上次更新解決方案的日期和時間（以 Unix 時間為單位）。類型：Timestamp 必要：否 ** 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 配方比對。如需詳細資訊，請參閱[判斷您的使用案例](https://docs.aws.amazon.com/personalize/latest/dg/determining-use-case.html)。若為 true，Amazon Personalize 會從解決方案組態的指定清單中搜尋最佳 USER\$1PERSONALIZE 配方 (不得指定 `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 -or- CREATE FAILED + DELETE PENDING > DELETE IN\$1PROGRESS 類型：字串長度限制：長度上限為 256。必要：否 ## 另請參閱如需在其中一種語言特定 AWSSDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Solution) + [AWS適用於 Java V2 的 SDK](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 ** [AutoMLConfig](https://docs.aws.amazon.com/personalize/latest/dg/API_AutoMLConfig.html) 物件包含執行 AutoML 時要搜尋的配方清單。類型：[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 SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/SolutionConfig) + [AWS 適用於 Java V2 的開發套件](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/SolutionConfig) + [AWS 適用於 Ruby V3 的 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 時間為單位）。類型：Timestamp 必要：否 ** lastUpdatedDateTime ** 上次更新解決方案的日期和時間（以 Unix 時間為單位）。類型：Timestamp 必要：否 ** name ** 解決方案的名稱。類型：字串長度限制：長度下限為 1。長度上限為 63。模式：`^[a-zA-Z0-9][a-zA-Z0-9\-_]*` 必要：否 ** recipeArn ** 解決方案所用配方的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** solutionArn ** 解決方案的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** status ** 解決方案的狀態。解決方案可以處於下列其中一種狀態： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED + DELETE PENDING > DELETE IN\$1PROGRESS 類型：字串長度限制：長度上限為 256。必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/SolutionSummary) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/SolutionSummary) + [AWS 適用於 Ruby V3 的 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 SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/SolutionUpdateConfig) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/SolutionUpdateConfig) + [AWS 適用於 Ruby V3 的 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 格式）。類型：Timestamp 必要：否 ** failureReason ** 如果解決方案更新失敗，則為失敗背後的原因。類型：字串必要：否 ** lastUpdatedDateTime ** 上次更新解決方案的日期和時間（以 Unix 時間為單位）。類型：Timestamp 必要：否 ** performAutoTraining ** 解決方案是否自動建立解決方案版本。類型：布林值必要：否 ** performIncrementalUpdate ** 布林值，指出是否在模型上執行增量訓練更新。啟用時，針對具有作用中行銷活動的解決方案版本執行增量訓練，並允許模型更頻繁地從新資料中學習，而不需要完整重新訓練，這可實現近乎即時的個人化。只有使用語意相似性配方的解決方案才支援此參數。預設值為 `true`。請注意，在下一次完整訓練發生之前，某些分數和屬性（例如用於對 aws-semantic-similarity 配方的排名影響的項目熱門度和新鮮度更新）可能不會更新。類型：布林值必要：否 ** solutionUpdateConfig ** 解決方案的組態詳細資訊。類型：[SolutionUpdateConfig](API_SolutionUpdateConfig.md) 物件必要：否 ** status ** 解決方案更新的狀態。解決方案更新可以處於下列其中一種狀態： CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED 類型：字串長度限制：長度上限為 256。必要：否 ## 另請參閱如需在其中一種語言特定 AWSSDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/SolutionUpdateSummary) + [AWS適用於 Java V2 的 SDK](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 時間為單位）。類型：Timestamp 必要：否 ** datasetGroupArn ** 提供訓練資料的資料集群組的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** eventType ** 用來訓練模型的事件類型 (例如「按一下」或「喜歡」)。類型：字串長度限制：長度上限為 256。必要：否 ** failureReason ** 如果訓練解決方案版本失敗，則表示失敗的原因。類型：字串必要：否 ** lastUpdatedDateTime ** 上次更新解決方案的日期和時間（以 Unix 時間為單位）。類型：Timestamp 必要：否 ** 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 IN\$1PROGRESS + ACTIVE + 建立失敗 + 建立停止 + 建立已停止類型：字串長度限制：長度上限為 256。必要：否 ** trainingHours ** 用於訓練模型的時間。您需要支付訓練模型所需的時間費用。只有在 Amazon Personalize 成功訓練模型之後，才會顯示此欄位。類型：Double 有效範圍：最小值為 0。必要：否 ** trainingMode ** 建立解決方案版本時要執行的訓練範圍。`FULL` 訓練會考慮資料集群組中的所有資料。只會`UPDATE`處理自上次訓練以來變更的資料。只有使用使用者個人化配方建立的解決方案版本才能使用 `UPDATE`。類型：字串有效值:`FULL | UPDATE | AUTOTRAIN` 必要：否 ** trainingType ** 解決方案版本是自動還是手動建立的。類型：字串有效值:`AUTOMATIC | MANUAL` 必要：否 ** tunedHPOParams ** 如果已執行超參數最佳化，會包含最佳效能模型的超參數值。類型：[TunedHPOParams](API_TunedHPOParams.md) 物件必要：否 ## 另請參閱如需在其中一種語言特定 AWSSDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/SolutionVersion) + [AWS適用於 Java V2 的 SDK](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 時間為單位）。類型：Timestamp 必要：否 ** failureReason ** 如果解決方案版本失敗，則為失敗背後的原因。類型：字串必要：否 ** lastUpdatedDateTime ** 解決方案版本上次更新的日期和時間（以 Unix 時間為單位）。類型：Timestamp 必要：否 ** solutionVersionArn ** 解決方案版本的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 256。模式：`arn:([a-z\d-]+):personalize:.*:.*:.+` 必要：否 ** status ** 解決方案版本的狀態。解決方案版本可以處於下列其中一種狀態： + CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED 類型：字串長度限制：長度上限為 256。必要：否 ** trainingMode ** 建立解決方案版本時要執行的訓練範圍。`FULL` 訓練會考慮資料集群組中的所有資料。只會`UPDATE`處理自上次訓練以來變更的資料。只有使用使用者個人化配方建立的解決方案版本才能使用 `UPDATE`。類型：字串有效值:`FULL | UPDATE | AUTOTRAIN` 必要：否 ** trainingType ** 解決方案版本是自動還是手動建立的。類型：字串有效值:`AUTOMATIC | MANUAL` 必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/SolutionVersionSummary) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/SolutionVersionSummary) + [AWS 適用於 Ruby V3 的 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 SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Tag) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/Tag) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/Tag) # ThemeGenerationConfig 使用批次推論任務產生佈景主題的組態詳細資訊。 ## 目錄 ** fieldsForThemeGeneration ** 用於為批次推論任務產生描述性主題的欄位。類型：[FieldsForThemeGeneration](API_FieldsForThemeGeneration.md) 物件必要：是 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ThemeGenerationConfig) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/ThemeGenerationConfig) + [AWS 適用於 Ruby V3 的 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_]*` 必要：否 ## 另請參閱如需在其中一種語言特定 AWSSDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/TrainingDataConfig) + [AWS適用於 Java V2 的 SDK](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 SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/TunedHPOParams) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/TunedHPOParams) + [AWS 適用於 Ruby V3 的 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 SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/Action) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/Action) + [AWS 適用於 Ruby V3 的 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 epoch 時間格式，以秒為單位。類型：Timestamp 必要：是 ** eventId ** 與事件相關聯的 ID。如果未提供事件 ID，Amazon Personalize 會為事件產生唯一的 ID。事件 ID 不會用作模型的輸入。Amazon Personalize 使用事件 ID 來區分唯一事件。具有相同事件 ID 的第一個之後的任何後續事件都不會用於模型訓練。類型：字串長度限制：長度下限為 1。長度上限為 256。必要：否 ** impression ** 動作 IDs 清單，代表您已向使用者顯示的動作序列。例如 `["actionId1", "actionId2", "actionId3"]`。Amazon Personalize 不會使用來自動作互動事件的曝光資料。相反地，請記錄每個動作的多個事件，並使用 `Viewed`事件類型。類型：字串陣列陣列成員：項目數下限為 1。最多 25 個項目。長度限制：長度下限為 1。長度上限為 256。必要：否 ** properties ** 您可以選擇記錄的事件特定資料的字串映射。例如，如果使用者採取動作 ID 以外的動作，您也可以傳送使用者採取的動作數目。映射中的每個項目都由索引鍵/值對組成。例如 `{"numberOfActions": "12"}` 金鑰使用符合動作互動結構描述中欄位的駱駝案例名稱。在上述範例中， `numberOfActions`會符合動作互動結構描述中定義的 'NUMBER\$1OF\$1ACTIONS' 欄位。下列項目不能包含為屬性的關鍵字（不區分大小寫）。 + userId + sessionId + eventType + timestamp + recommendationId + 印模類型：字串長度限制：長度下限為 1。長度上限為 1024。必要：否 ** recommendationId ** 包含使用者互動之動作的建議清單 ID。類型：字串長度限制：長度下限為 1。長度上限為 40。必要：否 ** userId ** 與動作互動的使用者 ID。這對應至動作互動結構描述`USER_ID`的欄位。類型：字串長度限制：長度下限為 1。長度上限為 256。必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/ActionInteraction) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/ActionInteraction) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/ActionInteraction) # Event 代表使用 `PutEvents` API 傳送的項目互動事件資訊。 ## 目錄 ** eventType ** 事件的類型，例如點選或下載。此屬性對應至項目互動資料集結構描述`EVENT_TYPE`的欄位，並取決於您正在追蹤的事件類型。類型：字串長度限制：長度下限為 1。長度上限為 256。必要：是 ** sentAt ** 事件發生時用戶端的時間戳記（以 Unix 時間為單位）。類型：Timestamp 必要：是 ** eventId ** 與事件相關聯的 ID。如果未提供事件 ID，Amazon Personalize 會為事件產生唯一的 ID。事件 ID 不會用作模型的輸入。Amazon Personalize 使用事件 ID 來區分唯一事件。第一個之後具有相同事件 ID 的任何後續事件都不會用於模型訓練。類型：字串長度限制：長度下限為 1。長度上限為 256。必要：否 ** eventValue ** 對應至項目互動結構描述 `EVENT_VALUE` 欄位的事件值。類型：浮點數必要：否 ** impression ** 項目 IDs 清單，代表您已向使用者顯示的項目序列。例如 `["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 + 印模類型：字串長度限制：長度下限為 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 SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/Event) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/Event) + [AWS 適用於 Ruby V3 的 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 SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/Item) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/Item) + [AWS 適用於 Ruby V3 的 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 SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/MetricAttribution) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/MetricAttribution) + [AWS 適用於 Ruby V3 的 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 SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/User) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-events-2018-03-22/User) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/User) # Amazon Personalize Runtime Amazon Personalize 執行期支援下列資料類型： + [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)。類型：Double 必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-runtime-2018-05-22/PredictedAction) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-runtime-2018-05-22/PredictedAction) + [AWS 適用於 Ruby V3 的 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) APIs 會傳回的清單`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)。類型：Double 必要：否 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-runtime-2018-05-22/PredictedItem) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-runtime-2018-05-22/PredictedItem) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-runtime-2018-05-22/PredictedItem) # Promotion 包含提升的相關資訊。提升定義適用於建議項目可設定子集的其他業務規則。 ## 目錄 ** filterArn ** 提升所使用的篩選條件 Amazon Resource Name (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 SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-runtime-2018-05-22/Promotion) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-runtime-2018-05-22/Promotion) + [AWS 適用於 Ruby V3 的 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 第 4 版請求的參數以及查詢字串。任何專屬於特定動作的參數則列於該動作的主題中。如需 Signature 第 4 版的詳細資訊，請參閱《*IAM 使用者指南*》中的[簽署 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。如需詳細資訊，請參閱《*IAM 使用者指南*》中的[建立已簽署的 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 時，其一律會覆寫日期標頭的值。如需詳細資訊，請參閱《*IAM 使用者指南*》中的 [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 標頭。如需指定已簽章標頭的詳細資訊，請參閱《*IAM 使用者指南*》中的[建立已簽章的 AWS API 請求](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html)。條件：當您在查詢字串中而非 HTTP 授權標頭中納入驗證資訊時，應指定此參數。類型：字串必要：有條件