id
stringlengths 14
16
| text
stringlengths 1
2.43k
| source
stringlengths 99
229
|
|---|---|---|
ef6d1309117d-0 | ```
{
"solution": {
"autoMLResult": {
"bestRecipeArn": "string"
},
"creationDateTime": number,
"datasetGroupArn": "string",
"eventType": "string",
"lastUpdatedDateTime": number,
"latestSolutionVersion": {
"creationDateTime": number,
"failureReason": "string",
"lastUpdatedDateTime": number,
"solutionVersionArn": "string",
"status": "string"
},
"name": "string",
"performAutoML": boolean,
"performHPO": boolean,
"recipeArn": "string",
"solutionArn": "string",
"solutionConfig": {
"algorithmHyperParameters": {
"string" : "string"
},
"autoMLConfig": {
"metricName": "string",
"recipeList": [ "string" ]
},
"eventValueThreshold": "string",
"featureTransformationParameters": {
"string" : "string"
}, | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeSolution.md |
ef6d1309117d-1 | "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"
}
}
},
"status": "string"
}
} | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeSolution.md |
ef6d1309117d-2 | }
}
},
"status": "string"
}
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeSolution.md |
7b6ff9e2568d-0 | If the action is successful, the service sends back an HTTP 200 response\.
The following data is returned in JSON format by the service\.
** [solution](#API_DescribeSolution_ResponseSyntax) ** <a name="personalize-DescribeSolution-response-solution"></a>
An object that describes the solution\.
Type: [Solution](API_Solution.md) object | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeSolution.md |
05d03f18f013-0 | **InvalidInputException**
Provide a valid value for the field or parameter\.
HTTP Status Code: 400
**ResourceNotFoundException**
Could not find the specified resource\.
HTTP Status Code: 400 | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeSolution.md |
c44fdc7f656c-0 | For more information about using this API in one of the language\-specific AWS SDKs, see the following:
+ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/personalize-2018-05-22/DescribeSolution)
+ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/personalize-2018-05-22/DescribeSolution)
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeSolution)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/DescribeSolution)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/DescribeSolution)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/personalize-2018-05-22/DescribeSolution)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeSolution) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeSolution.md |
c44fdc7f656c-1 | + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeSolution)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeSolution) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeSolution.md |
ea780a065ec7-0 | The following actions are supported by Amazon Personalize:
+ [CreateBatchInferenceJob](API_CreateBatchInferenceJob.md)
+ [CreateCampaign](API_CreateCampaign.md)
+ [CreateDataset](API_CreateDataset.md)
+ [CreateDatasetGroup](API_CreateDatasetGroup.md)
+ [CreateDatasetImportJob](API_CreateDatasetImportJob.md)
+ [CreateEventTracker](API_CreateEventTracker.md)
+ [CreateFilter](API_CreateFilter.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)
+ [DeleteSchema](API_DeleteSchema.md)
+ [DeleteSolution](API_DeleteSolution.md)
+ [DescribeAlgorithm](API_DescribeAlgorithm.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_Operations.md |
ea780a065ec7-1 | + [DescribeAlgorithm](API_DescribeAlgorithm.md)
+ [DescribeBatchInferenceJob](API_DescribeBatchInferenceJob.md)
+ [DescribeCampaign](API_DescribeCampaign.md)
+ [DescribeDataset](API_DescribeDataset.md)
+ [DescribeDatasetGroup](API_DescribeDatasetGroup.md)
+ [DescribeDatasetImportJob](API_DescribeDatasetImportJob.md)
+ [DescribeEventTracker](API_DescribeEventTracker.md)
+ [DescribeFeatureTransformation](API_DescribeFeatureTransformation.md)
+ [DescribeFilter](API_DescribeFilter.md)
+ [DescribeRecipe](API_DescribeRecipe.md)
+ [DescribeSchema](API_DescribeSchema.md)
+ [DescribeSolution](API_DescribeSolution.md)
+ [DescribeSolutionVersion](API_DescribeSolutionVersion.md)
+ [GetSolutionMetrics](API_GetSolutionMetrics.md)
+ [ListBatchInferenceJobs](API_ListBatchInferenceJobs.md)
+ [ListCampaigns](API_ListCampaigns.md)
+ [ListDatasetGroups](API_ListDatasetGroups.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_Operations.md |
ea780a065ec7-2 | + [ListDatasetGroups](API_ListDatasetGroups.md)
+ [ListDatasetImportJobs](API_ListDatasetImportJobs.md)
+ [ListDatasets](API_ListDatasets.md)
+ [ListEventTrackers](API_ListEventTrackers.md)
+ [ListFilters](API_ListFilters.md)
+ [ListRecipes](API_ListRecipes.md)
+ [ListSchemas](API_ListSchemas.md)
+ [ListSolutions](API_ListSolutions.md)
+ [ListSolutionVersions](API_ListSolutionVersions.md)
+ [UpdateCampaign](API_UpdateCampaign.md)
The following actions are supported by Amazon Personalize Events:
+ [PutEvents](API_UBS_PutEvents.md)
The following actions are supported by Amazon Personalize Runtime:
+ [GetPersonalizedRanking](API_RS_GetPersonalizedRanking.md)
+ [GetRecommendations](API_RS_GetRecommendations.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_Operations.md |
852771837c89-0 | Returns a list of dataset groups\. The response provides the properties for each dataset group, including the Amazon Resource Name \(ARN\)\. For more information on dataset groups, see [CreateDatasetGroup](API_CreateDatasetGroup.md)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListDatasetGroups.md |
f14632fafe31-0 | ```
{
"maxResults": number,
"nextToken": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListDatasetGroups.md |
627c1461be8a-0 | The request accepts the following data in JSON format\.
** [maxResults](#API_ListDatasetGroups_RequestSyntax) ** <a name="personalize-ListDatasetGroups-request-maxResults"></a>
The maximum number of dataset groups to return\.
Type: Integer
Valid Range: Minimum value of 1\. Maximum value of 100\.
Required: No
** [nextToken](#API_ListDatasetGroups_RequestSyntax) ** <a name="personalize-ListDatasetGroups-request-nextToken"></a>
A token returned from the previous call to `ListDatasetGroups` for getting the next set of dataset groups \(if they exist\)\.
Type: String
Length Constraints: Maximum length of 1300\.
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListDatasetGroups.md |
84c907ac1a6a-0 | ```
{
"datasetGroups": [
{
"creationDateTime": number,
"datasetGroupArn": "string",
"failureReason": "string",
"lastUpdatedDateTime": number,
"name": "string",
"status": "string"
}
],
"nextToken": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListDatasetGroups.md |
4db1560f6b14-0 | If the action is successful, the service sends back an HTTP 200 response\.
The following data is returned in JSON format by the service\.
** [datasetGroups](#API_ListDatasetGroups_ResponseSyntax) ** <a name="personalize-ListDatasetGroups-response-datasetGroups"></a>
The list of your dataset groups\.
Type: Array of [DatasetGroupSummary](API_DatasetGroupSummary.md) objects
Array Members: Maximum number of 100 items\.
** [nextToken](#API_ListDatasetGroups_ResponseSyntax) ** <a name="personalize-ListDatasetGroups-response-nextToken"></a>
A token for getting the next set of dataset groups \(if they exist\)\.
Type: String
Length Constraints: Maximum length of 1300\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListDatasetGroups.md |
9925ec464c57-0 | **InvalidNextTokenException**
The token is not valid\.
HTTP Status Code: 400 | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListDatasetGroups.md |
bfadccdc620a-0 | For more information about using this API in one of the language\-specific AWS SDKs, see the following:
+ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/personalize-2018-05-22/ListDatasetGroups)
+ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/personalize-2018-05-22/ListDatasetGroups)
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListDatasetGroups)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/ListDatasetGroups)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/ListDatasetGroups)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/personalize-2018-05-22/ListDatasetGroups) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListDatasetGroups.md |
bfadccdc620a-1 | + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListDatasetGroups)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListDatasetGroups)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListDatasetGroups) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListDatasetGroups.md |
1ad4adf5c646-0 | Deletes a filter\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DeleteFilter.md |
11b79068abbe-0 | ```
{
"filterArn": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DeleteFilter.md |
632a7b2d0bc1-0 | The request accepts the following data in JSON format\.
** [filterArn](#API_DeleteFilter_RequestSyntax) ** <a name="personalize-DeleteFilter-request-filterArn"></a>
The ARN of the filter to delete\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DeleteFilter.md |
4b00a7bb090f-0 | If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DeleteFilter.md |
f8ee7e06ab4c-0 | **InvalidInputException**
Provide a valid value for the field or parameter\.
HTTP Status Code: 400
**ResourceInUseException**
The specified resource is in use\.
HTTP Status Code: 400
**ResourceNotFoundException**
Could not find the specified resource\.
HTTP Status Code: 400 | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DeleteFilter.md |
597f7910763d-0 | For more information about using this API in one of the language\-specific AWS SDKs, see the following:
+ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/personalize-2018-05-22/DeleteFilter)
+ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/personalize-2018-05-22/DeleteFilter)
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DeleteFilter)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/DeleteFilter)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/DeleteFilter)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/personalize-2018-05-22/DeleteFilter)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteFilter) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DeleteFilter.md |
597f7910763d-1 | + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DeleteFilter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DeleteFilter) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DeleteFilter.md |
2184eeb3f66d-0 | The configuration details of an Amazon S3 input or output bucket\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_S3DataConfig.md |
eecf301872b9-0 | **kmsKeyArn** <a name="personalize-Type-S3DataConfig-kmsKeyArn"></a>
The Amazon Resource Name \(ARN\) of the Amazon Key Management Service \(KMS\) key that Amazon Personalize uses to encrypt or decrypt the input and output files of a batch inference job\.
Type: String
Required: No
**path** <a name="personalize-Type-S3DataConfig-path"></a>
The file path of the Amazon S3 bucket\.
Type: String
Length Constraints: Maximum length of 256\.
Required: Yes | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_S3DataConfig.md |
b0bbe2b4be76-0 | For more information about using this API in one of the language\-specific AWS SDKs, see the following:
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/S3DataConfig)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/S3DataConfig)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/S3DataConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/S3DataConfig) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_S3DataConfig.md |
bf1c37f9e8b5-0 | -----
*****Copyright © 2020 Amazon Web Services, Inc. and/or its affiliates. All rights reserved.*****
-----
Amazon's trademarks and trade dress may not be used in
connection with any product or service that is not Amazon's,
in any manner that is likely to cause confusion among customers,
or in any manner that disparages or discredits Amazon. All other
trademarks not owned by Amazon are the property of their respective
owners, who may or may not be affiliated with, connected to, or
sponsored by Amazon.
----- | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/index.md |
0ff70d11bb92-0 | + [What Is Amazon Personalize?](what-is-personalize.md)
+ [How It Works](how-it-works.md)
+ [Setting Up Amazon Personalize](setup.md)
+ [Setting Up Permissions](aws-personalize-set-up-permissions.md)
+ [Setting Up the AWS CLI](aws-personalize-set-up-aws-cli.md)
+ [Setting Up the AWS SDKs](aws-personalize-set-up-sdks.md)
+ [Getting Started](getting-started.md)
+ [Getting Started Prerequisites](gs-prerequisites.md)
+ [Getting Started (Console)](getting-started-console.md)
+ [Getting Started (AWS CLI)](getting-started-cli.md)
+ [Getting Started (AWS SDK for Python)](getting-started-python.md)
+ [Clean Up Resources](gs-cleanup.md)
+ [Preparing and Importing Data](data-prep.md)
+ [Datasets and Schemas](how-it-works-dataset-schema.md)
+ [Filtering Records from a User-Interactions Training Dataset](event-values-types.md)
+ [Formatting Your Input Data](data-prep-formatting.md)
+ [Uploading to an S3 Bucket](data-prep-upload-s3.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/index.md |
0ff70d11bb92-1 | + [Uploading to an S3 Bucket](data-prep-upload-s3.md)
+ [Importing Your Data](data-prep-importing.md)
+ [Recording Events](recording-events.md)
+ [Creating a Solution](training-deploying-solutions.md)
+ [Choosing a Recipe](working-with-predefined-recipes.md)
+ [USER_PERSONALIZATION Recipes](user-personalization-recipes.md)
+ [User-Personalization Recipe](native-recipe-new-item-USER_PERSONALIZATION.md)
+ [HRNN Recipe](native-recipe-hrnn.md)
+ [HRNN-Metadata Recipe](native-recipe-hrnn-metadata.md)
+ [HRNN-Coldstart Recipe](native-recipe-hrnn-coldstart.md)
+ [Popularity-Count Recipe](native-recipe-popularity.md)
+ [PERSONALIZED_RANKING Recipes](personalized-ranking-recipes.md)
+ [Personalized-Ranking Recipe](native-recipe-search.md)
+ [RELATED_ITEMS Recipes](related-items-recipes.md)
+ [SIMS Recipe](native-recipe-sims.md)
+ [Overriding Default Recipe Parameters](customizing-solution-config.md)
+ [Hyperparameters and HPO](customizing-solution-config-hpo.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/index.md |
0ff70d11bb92-2 | + [Hyperparameters and HPO](customizing-solution-config-hpo.md)
+ [Evaluating a Solution Version](working-with-training-metrics.md)
+ [Creating a Campaign](campaigns.md)
+ [Getting Recommendations](getting-recommendations.md)
+ [Getting Real-Time Recommendations](getting-real-time-recommendations.md)
+ [Getting Batch Recommendations](recommendations-batch.md)
+ [Filtering Recommendations](filter.md)
+ [Filter Expressions](filter-expressions.md)
+ [Filtering Real-time Recommendations](filter-real-time.md)
+ [Filtering Batch Recommendations](filter-batch.md)
+ [Security in Amazon Personalize](security.md)
+ [Data Protection in Amazon Personalize](data-protection.md)
+ [Identity and Access Management for Amazon Personalize](security-iam.md)
+ [How Amazon Personalize Works with IAM](security_iam_service-with-iam.md)
+ [Amazon Personalize Identity-Based Policy Examples](security_iam_id-based-policy-examples.md)
+ [Troubleshooting Amazon Personalize Identity and Access](security_iam_troubleshoot.md)
+ [Logging and Monitoring in Amazon Personalize](logging-monitoring.md)
+ [Monitoring Amazon Personalize](personalize-monitoring.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/index.md |
0ff70d11bb92-3 | + [Logging and Monitoring in Amazon Personalize](logging-monitoring.md)
+ [Monitoring Amazon Personalize](personalize-monitoring.md)
+ [CloudWatch Metrics for Amazon Personalize](cloudwatch-metrics.md)
+ [Logging Amazon Personalize API Calls with AWS CloudTrail](logging-using-cloudtrail.md)
+ [Compliance Validation for Amazon Personalize](SERVICENAME-compliance.md)
+ [Resilience in Amazon Personalize](disaster-recovery-resiliency.md)
+ [Infrastructure Security in Amazon Personalize](infrastructure-security.md)
+ [Quotas in Amazon Personalize](limits.md)
+ [API Reference](API_Reference.md)
+ [Actions](API_Operations.md)
+ [Amazon Personalize](API_Operations_Amazon_Personalize.md)
+ [CreateBatchInferenceJob](API_CreateBatchInferenceJob.md)
+ [CreateCampaign](API_CreateCampaign.md)
+ [CreateDataset](API_CreateDataset.md)
+ [CreateDatasetGroup](API_CreateDatasetGroup.md)
+ [CreateDatasetImportJob](API_CreateDatasetImportJob.md)
+ [CreateEventTracker](API_CreateEventTracker.md)
+ [CreateFilter](API_CreateFilter.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/index.md |
0ff70d11bb92-4 | + [CreateEventTracker](API_CreateEventTracker.md)
+ [CreateFilter](API_CreateFilter.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)
+ [DeleteSchema](API_DeleteSchema.md)
+ [DeleteSolution](API_DeleteSolution.md)
+ [DescribeAlgorithm](API_DescribeAlgorithm.md)
+ [DescribeBatchInferenceJob](API_DescribeBatchInferenceJob.md)
+ [DescribeCampaign](API_DescribeCampaign.md)
+ [DescribeDataset](API_DescribeDataset.md)
+ [DescribeDatasetGroup](API_DescribeDatasetGroup.md)
+ [DescribeDatasetImportJob](API_DescribeDatasetImportJob.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/index.md |
0ff70d11bb92-5 | + [DescribeDatasetImportJob](API_DescribeDatasetImportJob.md)
+ [DescribeEventTracker](API_DescribeEventTracker.md)
+ [DescribeFeatureTransformation](API_DescribeFeatureTransformation.md)
+ [DescribeFilter](API_DescribeFilter.md)
+ [DescribeRecipe](API_DescribeRecipe.md)
+ [DescribeSchema](API_DescribeSchema.md)
+ [DescribeSolution](API_DescribeSolution.md)
+ [DescribeSolutionVersion](API_DescribeSolutionVersion.md)
+ [GetSolutionMetrics](API_GetSolutionMetrics.md)
+ [ListBatchInferenceJobs](API_ListBatchInferenceJobs.md)
+ [ListCampaigns](API_ListCampaigns.md)
+ [ListDatasetGroups](API_ListDatasetGroups.md)
+ [ListDatasetImportJobs](API_ListDatasetImportJobs.md)
+ [ListDatasets](API_ListDatasets.md)
+ [ListEventTrackers](API_ListEventTrackers.md)
+ [ListFilters](API_ListFilters.md)
+ [ListRecipes](API_ListRecipes.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/index.md |
0ff70d11bb92-6 | + [ListFilters](API_ListFilters.md)
+ [ListRecipes](API_ListRecipes.md)
+ [ListSchemas](API_ListSchemas.md)
+ [ListSolutions](API_ListSolutions.md)
+ [ListSolutionVersions](API_ListSolutionVersions.md)
+ [UpdateCampaign](API_UpdateCampaign.md)
+ [Amazon Personalize Events](API_Operations_Amazon_Personalize_Events.md)
+ [PutEvents](API_UBS_PutEvents.md)
+ [Amazon Personalize Runtime](API_Operations_Amazon_Personalize_Runtime.md)
+ [GetPersonalizedRanking](API_RS_GetPersonalizedRanking.md)
+ [GetRecommendations](API_RS_GetRecommendations.md)
+ [Data Types](API_Types.md)
+ [Amazon Personalize](API_Types_Amazon_Personalize.md)
+ [Algorithm](API_Algorithm.md)
+ [AlgorithmImage](API_AlgorithmImage.md)
+ [AutoMLConfig](API_AutoMLConfig.md)
+ [AutoMLResult](API_AutoMLResult.md)
+ [BatchInferenceJob](API_BatchInferenceJob.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/index.md |
0ff70d11bb92-7 | + [BatchInferenceJob](API_BatchInferenceJob.md)
+ [BatchInferenceJobConfig](API_BatchInferenceJobConfig.md)
+ [BatchInferenceJobInput](API_BatchInferenceJobInput.md)
+ [BatchInferenceJobOutput](API_BatchInferenceJobOutput.md)
+ [BatchInferenceJobSummary](API_BatchInferenceJobSummary.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)
+ [Dataset](API_Dataset.md)
+ [DatasetGroup](API_DatasetGroup.md)
+ [DatasetGroupSummary](API_DatasetGroupSummary.md)
+ [DatasetImportJob](API_DatasetImportJob.md)
+ [DatasetImportJobSummary](API_DatasetImportJobSummary.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/index.md |
0ff70d11bb92-8 | + [DatasetImportJobSummary](API_DatasetImportJobSummary.md)
+ [DatasetSchema](API_DatasetSchema.md)
+ [DatasetSchemaSummary](API_DatasetSchemaSummary.md)
+ [DatasetSummary](API_DatasetSummary.md)
+ [DataSource](API_DataSource.md)
+ [DefaultCategoricalHyperParameterRange](API_DefaultCategoricalHyperParameterRange.md)
+ [DefaultContinuousHyperParameterRange](API_DefaultContinuousHyperParameterRange.md)
+ [DefaultHyperParameterRanges](API_DefaultHyperParameterRanges.md)
+ [DefaultIntegerHyperParameterRange](API_DefaultIntegerHyperParameterRange.md)
+ [EventTracker](API_EventTracker.md)
+ [EventTrackerSummary](API_EventTrackerSummary.md)
+ [FeatureTransformation](API_FeatureTransformation.md)
+ [Filter](API_Filter.md)
+ [FilterSummary](API_FilterSummary.md)
+ [HPOConfig](API_HPOConfig.md)
+ [HPOObjective](API_HPOObjective.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/index.md |
0ff70d11bb92-9 | + [HPOObjective](API_HPOObjective.md)
+ [HPOResourceConfig](API_HPOResourceConfig.md)
+ [HyperParameterRanges](API_HyperParameterRanges.md)
+ [IntegerHyperParameterRange](API_IntegerHyperParameterRange.md)
+ [Recipe](API_Recipe.md)
+ [RecipeSummary](API_RecipeSummary.md)
+ [S3DataConfig](API_S3DataConfig.md)
+ [Solution](API_Solution.md)
+ [SolutionConfig](API_SolutionConfig.md)
+ [SolutionSummary](API_SolutionSummary.md)
+ [SolutionVersion](API_SolutionVersion.md)
+ [SolutionVersionSummary](API_SolutionVersionSummary.md)
+ [TunedHPOParams](API_TunedHPOParams.md)
+ [Amazon Personalize Events](API_Types_Amazon_Personalize_Events.md)
+ [Event](API_UBS_Event.md)
+ [Amazon Personalize Runtime](API_Types_Amazon_Personalize_Runtime.md)
+ [PredictedItem](API_RS_PredictedItem.md)
+ [Common Errors](CommonErrors.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/index.md |
0ff70d11bb92-10 | + [PredictedItem](API_RS_PredictedItem.md)
+ [Common Errors](CommonErrors.md)
+ [Common Parameters](CommonParameters.md)
+ [Document History for Amazon Personalize](document-history.md)
+ [AWS glossary](glossary.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/index.md |
1e27b16774de-0 | Contains information on a recommendation filter, including its ARN, status, and filter expression\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_Filter.md |
3d5135523c23-0 | **creationDateTime** <a name="personalize-Type-Filter-creationDateTime"></a>
The time at which the filter was created\.
Type: Timestamp
Required: No
**datasetGroupArn** <a name="personalize-Type-Filter-datasetGroupArn"></a>
The ARN of the dataset group to which the filter belongs\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
**failureReason** <a name="personalize-Type-Filter-failureReason"></a>
If the filter failed, the reason for its failure\.
Type: String
Required: No
**filterArn** <a name="personalize-Type-Filter-filterArn"></a>
The ARN of the filter\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
**filterExpression** <a name="personalize-Type-Filter-filterExpression"></a> | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_Filter.md |
3d5135523c23-1 | Required: No
**filterExpression** <a name="personalize-Type-Filter-filterExpression"></a>
Specifies the type of item interactions to filter out of recommendation results\. The filter expression must follow the following format:
`EXCLUDE itemId WHERE INTERACTIONS.event_type in ("EVENT_TYPE")`
Where "EVENT\_TYPE" is the type of event to filter out\. For more information, see [Using Filters with Amazon Personalize](https://docs.aws.amazon.com/personalize/latest/dg/filters.html)\.
Type: String
Length Constraints: Minimum length of 1\. Maximum length of 2500\.
Required: No
**lastUpdatedDateTime** <a name="personalize-Type-Filter-lastUpdatedDateTime"></a>
The time at which the filter was last updated\.
Type: Timestamp
Required: No
**name** <a name="personalize-Type-Filter-name"></a>
The name of the filter\.
Type: String
Length Constraints: Minimum length of 1\. Maximum length of 63\.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
**status** <a name="personalize-Type-Filter-status"></a>
The status of the filter\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_Filter.md |
3d5135523c23-2 | **status** <a name="personalize-Type-Filter-status"></a>
The status of the filter\.
Type: String
Length Constraints: Maximum length of 256\.
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_Filter.md |
18bbcbf05c34-0 | For more information about using this API in one of the language\-specific AWS SDKs, see the following:
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Filter)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/Filter)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/Filter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/Filter) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_Filter.md |
9211a7ce1e39-0 | Returns a list of campaigns that use the given solution\. When a solution is not specified, all the campaigns associated with the account are listed\. The response provides the properties for each campaign, including the Amazon Resource Name \(ARN\)\. For more information on campaigns, see [CreateCampaign](API_CreateCampaign.md)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListCampaigns.md |
abe51ba232ac-0 | ```
{
"maxResults": number,
"nextToken": "string",
"solutionArn": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListCampaigns.md |
775e8f430292-0 | The request accepts the following data in JSON format\.
** [maxResults](#API_ListCampaigns_RequestSyntax) ** <a name="personalize-ListCampaigns-request-maxResults"></a>
The maximum number of campaigns to return\.
Type: Integer
Valid Range: Minimum value of 1\. Maximum value of 100\.
Required: No
** [nextToken](#API_ListCampaigns_RequestSyntax) ** <a name="personalize-ListCampaigns-request-nextToken"></a>
A token returned from the previous call to `ListCampaigns` for getting the next set of campaigns \(if they exist\)\.
Type: String
Length Constraints: Maximum length of 1300\.
Required: No
** [solutionArn](#API_ListCampaigns_RequestSyntax) ** <a name="personalize-ListCampaigns-request-solutionArn"></a>
The Amazon Resource Name \(ARN\) of the solution to list the campaigns for\. When a solution is not specified, all the campaigns associated with the account are listed\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListCampaigns.md |
0dd8fe511e26-0 | ```
{
"campaigns": [
{
"campaignArn": "string",
"creationDateTime": number,
"failureReason": "string",
"lastUpdatedDateTime": number,
"name": "string",
"status": "string"
}
],
"nextToken": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListCampaigns.md |
768415c70a85-0 | If the action is successful, the service sends back an HTTP 200 response\.
The following data is returned in JSON format by the service\.
** [campaigns](#API_ListCampaigns_ResponseSyntax) ** <a name="personalize-ListCampaigns-response-campaigns"></a>
A list of the campaigns\.
Type: Array of [CampaignSummary](API_CampaignSummary.md) objects
Array Members: Maximum number of 100 items\.
** [nextToken](#API_ListCampaigns_ResponseSyntax) ** <a name="personalize-ListCampaigns-response-nextToken"></a>
A token for getting the next set of campaigns \(if they exist\)\.
Type: String
Length Constraints: Maximum length of 1300\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListCampaigns.md |
12ae66e8d5f6-0 | **InvalidInputException**
Provide a valid value for the field or parameter\.
HTTP Status Code: 400
**InvalidNextTokenException**
The token is not valid\.
HTTP Status Code: 400 | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListCampaigns.md |
fc1182d59776-0 | For more information about using this API in one of the language\-specific AWS SDKs, see the following:
+ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/personalize-2018-05-22/ListCampaigns)
+ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/personalize-2018-05-22/ListCampaigns)
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListCampaigns)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/ListCampaigns)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/ListCampaigns)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/personalize-2018-05-22/ListCampaigns) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListCampaigns.md |
fc1182d59776-1 | + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListCampaigns)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListCampaigns)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListCampaigns) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListCampaigns.md |
4a6190dd8049-0 | When the solution performs AutoML \(`performAutoML` is true in [CreateSolution](API_CreateSolution.md)\), Amazon Personalize determines which recipe, from the specified list, optimizes the given metric\. Amazon Personalize then uses that recipe for the solution\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_AutoMLConfig.md |
a8fdeb74da40-0 | **metricName** <a name="personalize-Type-AutoMLConfig-metricName"></a>
The metric to optimize\.
Type: String
Length Constraints: Maximum length of 256\.
Required: No
**recipeList** <a name="personalize-Type-AutoMLConfig-recipeList"></a>
The list of candidate recipes\.
Type: Array of strings
Array Members: Maximum number of 100 items\.
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_AutoMLConfig.md |
11be3cb36f0a-0 | For more information about using this API in one of the language\-specific AWS SDKs, see the following:
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/AutoMLConfig)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/AutoMLConfig)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/AutoMLConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/AutoMLConfig) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_AutoMLConfig.md |
533395639d0c-0 | Deletes a dataset group\. Before you delete a dataset group, you must delete the following:
+ All associated event trackers\.
+ All associated solutions\.
+ All datasets in the dataset group\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DeleteDatasetGroup.md |
5aaf954cb776-0 | ```
{
"datasetGroupArn": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DeleteDatasetGroup.md |
9a6ff9c6a4e4-0 | The request accepts the following data in JSON format\.
** [datasetGroupArn](#API_DeleteDatasetGroup_RequestSyntax) ** <a name="personalize-DeleteDatasetGroup-request-datasetGroupArn"></a>
The ARN of the dataset group to delete\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DeleteDatasetGroup.md |
68dcc2d474dd-0 | If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DeleteDatasetGroup.md |
b57d3aaadb02-0 | **InvalidInputException**
Provide a valid value for the field or parameter\.
HTTP Status Code: 400
**ResourceInUseException**
The specified resource is in use\.
HTTP Status Code: 400
**ResourceNotFoundException**
Could not find the specified resource\.
HTTP Status Code: 400 | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DeleteDatasetGroup.md |
db48a939ebf3-0 | For more information about using this API in one of the language\-specific AWS SDKs, see the following:
+ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/personalize-2018-05-22/DeleteDatasetGroup)
+ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/personalize-2018-05-22/DeleteDatasetGroup)
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DeleteDatasetGroup)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/DeleteDatasetGroup)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/DeleteDatasetGroup)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/personalize-2018-05-22/DeleteDatasetGroup)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteDatasetGroup) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DeleteDatasetGroup.md |
db48a939ebf3-1 | + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DeleteDatasetGroup)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DeleteDatasetGroup) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DeleteDatasetGroup.md |
5fe9743231e1-0 | Third\-party auditors assess the security and compliance of Amazon Personalizeas part of multiple AWS compliance programs\. These include SOC, PCI, HIPAA, and others\.
For a list of AWS services in scope of specific compliance programs, see [AWS Services in Scope by Compliance Program](http://aws.amazon.com/compliance/services-in-scope/)\. For general information, see [AWS Compliance Programs](http://aws.amazon.com/compliance/programs/)\.
You can download third\-party audit reports using AWS Artifact\. For more information, see [Downloading Reports in AWS Artifact](https://docs.aws.amazon.com/artifact/latest/ug/downloading-documents.html)\.
Your compliance responsibility when using Amazon Personalize is determined by the sensitivity of your data, your company's compliance objectives, and applicable laws and regulations\. AWS provides the following resources to help with compliance:
+ [Security and Compliance Quick Start Guides](http://aws.amazon.com/quickstart/?awsf.quickstart-homepage-filter=categories%23security-identity-compliance) – These deployment guides discuss architectural considerations and provide steps for deploying security\- and compliance\-focused baseline environments on AWS\.
+ [Architecting for HIPAA Security and Compliance Whitepaper ](https://d0.awsstatic.com/whitepapers/compliance/AWS_HIPAA_Compliance_Whitepaper.pdf) – This whitepaper describes how companies can use AWS to create HIPAA\-compliant applications\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/SERVICENAME-compliance.md |
5fe9743231e1-1 | + [AWS Compliance Resources](http://aws.amazon.com/compliance/resources/) – This collection of workbooks and guides might apply to your industry and location\.
+ [Evaluating Resources with Rules](https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html) in the *AWS Config Developer Guide* – The AWS Config service assesses how well your resource configurations comply with internal practices, industry guidelines, and regulations\.
+ [AWS Security Hub](https://docs.aws.amazon.com/securityhub/latest/userguide/what-is-securityhub.html) – This AWS service provides a comprehensive view of your security state within AWS that helps you check your compliance with security industry standards and best practices\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/SERVICENAME-compliance.md |
2bf4a92a2627-0 | The PERSONALIZED\_RANKING recipe, Personalized\-Ranking, provides recommendations in ranked order based on predicted interest level\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/personalized-ranking-recipes.md |
eafd4040bd64-0 | The Personalized\-Ranking recipe is a hierarchical recurrent neural network \(HRNN\) recipe that also can filter and re\-rank results\. Personalized\-Ranking provides a list of the best recommendations\. Use the Personalized\-Ranking recipe when you’re personalizing the results for your users, such as personalized re\-ranking of search results or curated lists\.
To train a model, the Personalized\-Ranking recipe uses the Interactions dataset from a dataset group\. A dataset group is a set of related datasets, which can include the Users, Items, and Interactions datasets\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/personalized-ranking-recipes.md |
1bff09c5c22c-0 | Provides the name and range of a categorical hyperparameter\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CategoricalHyperParameterRange.md |
ddbb16fb1f84-0 | **name** <a name="personalize-Type-CategoricalHyperParameterRange-name"></a>
The name of the hyperparameter\.
Type: String
Length Constraints: Maximum length of 256\.
Required: No
**values** <a name="personalize-Type-CategoricalHyperParameterRange-values"></a>
A list of the categories for the hyperparameter\.
Type: Array of strings
Array Members: Maximum number of 100 items\.
Length Constraints: Maximum length of 1000\.
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CategoricalHyperParameterRange.md |
14e96215f792-0 | For more information about using this API in one of the language\-specific AWS SDKs, see the following:
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CategoricalHyperParameterRange)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/CategoricalHyperParameterRange)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/CategoricalHyperParameterRange)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CategoricalHyperParameterRange) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CategoricalHyperParameterRange.md |
5e3b1690586d-0 | Provides a summary of the properties of a dataset import job\. For a complete listing, call the [DescribeDatasetImportJob](API_DescribeDatasetImportJob.md) API\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DatasetImportJobSummary.md |
8b301a0060ce-0 | **creationDateTime** <a name="personalize-Type-DatasetImportJobSummary-creationDateTime"></a>
The date and time \(in Unix time\) that the dataset import job was created\.
Type: Timestamp
Required: No
**datasetImportJobArn** <a name="personalize-Type-DatasetImportJobSummary-datasetImportJobArn"></a>
The Amazon Resource Name \(ARN\) of the dataset import job\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
**failureReason** <a name="personalize-Type-DatasetImportJobSummary-failureReason"></a>
If a dataset import job fails, the reason behind the failure\.
Type: String
Required: No
**jobName** <a name="personalize-Type-DatasetImportJobSummary-jobName"></a>
The name of the dataset import job\.
Type: String
Length Constraints: Minimum length of 1\. Maximum length of 63\.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DatasetImportJobSummary.md |
8b301a0060ce-1 | Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
**lastUpdatedDateTime** <a name="personalize-Type-DatasetImportJobSummary-lastUpdatedDateTime"></a>
The date and time \(in Unix time\) that the dataset was last updated\.
Type: Timestamp
Required: No
**status** <a name="personalize-Type-DatasetImportJobSummary-status"></a>
The status of the dataset import job\.
A dataset import job can be in one of the following states:
+ CREATE PENDING > CREATE IN\_PROGRESS > ACTIVE \-or\- CREATE FAILED
Type: String
Length Constraints: Maximum length of 256\.
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DatasetImportJobSummary.md |
c0b5f6a9210e-0 | For more information about using this API in one of the language\-specific AWS SDKs, see the following:
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DatasetImportJobSummary)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/DatasetImportJobSummary)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/DatasetImportJobSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetImportJobSummary) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DatasetImportJobSummary.md |
79c9e5ab5e37-0 | Deletes a dataset\. You can't delete a dataset if an associated `DatasetImportJob` or `SolutionVersion` is in the CREATE PENDING or IN PROGRESS state\. For more information on datasets, see [CreateDataset](API_CreateDataset.md)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DeleteDataset.md |
80855f5993c1-0 | ```
{
"datasetArn": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DeleteDataset.md |
ea905170dd6d-0 | The request accepts the following data in JSON format\.
** [datasetArn](#API_DeleteDataset_RequestSyntax) ** <a name="personalize-DeleteDataset-request-datasetArn"></a>
The Amazon Resource Name \(ARN\) of the dataset to delete\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DeleteDataset.md |
a8ceed78a71d-0 | If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DeleteDataset.md |
e398d33af9de-0 | **InvalidInputException**
Provide a valid value for the field or parameter\.
HTTP Status Code: 400
**ResourceInUseException**
The specified resource is in use\.
HTTP Status Code: 400
**ResourceNotFoundException**
Could not find the specified resource\.
HTTP Status Code: 400 | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DeleteDataset.md |
695c2b6fab74-0 | For more information about using this API in one of the language\-specific AWS SDKs, see the following:
+ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/personalize-2018-05-22/DeleteDataset)
+ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/personalize-2018-05-22/DeleteDataset)
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DeleteDataset)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/DeleteDataset)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/DeleteDataset)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/personalize-2018-05-22/DeleteDataset)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteDataset) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DeleteDataset.md |
695c2b6fab74-1 | + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DeleteDataset)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DeleteDataset) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DeleteDataset.md |
d5033c908695-0 | Download and install the AWS SDKs that you want to use\. This guide provides examples for Python, and JavaScript using the AWS Amplify library\. For information about other AWS SDKs, see [Tools for Amazon Web Services](https://aws.amazon.com/tools/)\.
+ [AWS SDK for Python \(Boto3\)](http://boto3.amazonaws.com/v1/documentation/api/latest/index.html)
To confirm that your Python environment is configured correctly for use with Amazon Personalize, see [Getting Started \(AWS SDK for Python\)](getting-started-python.md)\.
+ [AWS Amplify](https://aws-amplify.github.io/docs/js/start) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/aws-personalize-set-up-sdks.md |
4cce13be627d-0 | An object that identifies an item\.
The [GetRecommendations](API_RS_GetRecommendations.md) and [GetPersonalizedRanking](API_RS_GetPersonalizedRanking.md) APIs return a list of `PredictedItem`s\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_RS_PredictedItem.md |
b3a911df1dc8-0 | **itemId** <a name="personalize-Type-RS_PredictedItem-itemId"></a>
The recommended item ID\.
Type: String
Length Constraints: Maximum length of 256\.
Required: No
**score** <a name="personalize-Type-RS_PredictedItem-score"></a>
A numeric representation of the model's certainty that the item will be the next user selection\. For more information on scoring logic, see [How Recommendation Scoring Works](getting-recommendations.md#how-scores-work)\.
Type: Double
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_RS_PredictedItem.md |
2d2af9350119-0 | For more information about using this API in one of the language\-specific AWS SDKs, see the following:
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-runtime-2018-05-22/PredictedItem)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-runtime-2018-05-22/PredictedItem)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-runtime-2018-05-22/PredictedItem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-runtime-2018-05-22/PredictedItem) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_RS_PredictedItem.md |
9e93f9e6004b-0 | Amazon Personalize generates a number of metrics when it creates a solution version\. These metrics allow you to evaluate the performance of the solution version before you create a campaign and provide recommendations\. Metrics allow you to view the effects of modifying a solution's hyperparameters\. You can also compare the metrics between solutions that use the same training data but created with different recipes\.
To get performance metrics, Amazon Personalize splits the input interactions data by randomly selecting 90% of users and their related interactions as training data and the other 10% as testing data\. The solution version is then created using the training data\. Afterwards, the solution version is given the oldest 90% of each user's testing data as input, and the recommendations it generates are compared against the real interactions given by the most recent 10% of testing data\.
For user\-personalization, it's recommended to run multiple recipes on your data to determine the optimal solution\. As a baseline, run the [Popularity\-Count](native-recipe-popularity.md) recipe, which recommends the top K most popular items\.
**Important**
In order for Amazon Personalize to generate solution version metrics, you must have at least 10 datapoints in your input dataset group\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/working-with-training-metrics.md |
c3ca2a7fd4dd-0 | You retrieve the metrics for a specific solution version by calling the [GetSolutionMetrics](API_GetSolutionMetrics.md) operation\.
**Retrieve metrics using the AWS Python SDK**
1. Create a solution version\. For more information, see [Creating a Solution](training-deploying-solutions.md)\.
1. Use the following code to retrieve metrics\.
```
import boto3
personalize = boto3.client('personalize')
response = personalize.get_solution_metrics(
solutionVersionArn = 'solution version arn')
print(response['metrics'])
```
The following is an example of the output from a solution version created using the [HRNN](native-recipe-hrnn.md) recipe with the default solution configuration\.
```
{
"solutionVersionArn": "arn:aws:personalize:us-west-2:acct-id:solution/MovieSolution/<version-id>",
"metrics": {
"coverage": 0.27,
"mean_reciprocal_rank_at_25": 0.0379,
"normalized_discounted_cumulative_gain_at_5": 0.0405,
"normalized_discounted_cumulative_gain_at_10": 0.0513, | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/working-with-training-metrics.md |
c3ca2a7fd4dd-1 | "normalized_discounted_cumulative_gain_at_10": 0.0513,
"normalized_discounted_cumulative_gain_at_25": 0.0828,
"precision_at_5": 0.0136,
"precision_at_10": 0.0102,
"precision_at_25": 0.0091
}
}
```
The above metrics are described below using the following terms:
+ *Relevant recommendation* refers to a recommendation that matches a value in the testing data for the particular user\.
+ *Rank* refers to the position of a recommended item in the list of recommendations\. Position 1 \(the top of the list\) is presumed to be the most relevant to the user\.
+ *Query* refers to the internal equivalent of a [GetRecommendations](API_RS_GetRecommendations.md) call\.
For each metric, higher numbers are better\.
**coverage**
The proportion of unique recommended items from all queries out of the total number of unique items in the training data \(includes both the Items and Interactions datasets\)\.
**mean\_reciprocal\_rank\_at\_25**
The mean of the reciprocal ranks of the first relevant recommendation out of the top 25 recommendations over all queries\.
This metric is appropriate if you're interested in the single highest ranked recommendation\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/working-with-training-metrics.md |
c3ca2a7fd4dd-2 | This metric is appropriate if you're interested in the single highest ranked recommendation\.
**normalized\_discounted\_cumulative\_gain\_at\_K**
Discounted gain assumes that recommendations lower on a list of recommendations are less relevant than higher recommendations\. Therefore, each recommendation is discounted \(given a lower weight\) by a factor dependent on its position\. To produce the cumulative discounted gain \(DCG\) at K, each relevant discounted recommendation in the top K recommendations is summed together\. The normalized discounted cumulative gain \(NDCG\) is the DCG divided by the ideal DCG such that NDCG is between 0 \- 1\. \(The ideal DCG is where the top K recommendations are sorted by relevance\.\)
Amazon Personalize uses a weighting factor of `1/log(1 + position)`, where the top of the list is position `1`\.
This metric rewards relevant items that appear near the top of the list, because the top of a list usually draws more attention\.
**precision\_at\_K**
The number of relevant recommendations out of the top K recommendations divided by K\.
This metric rewards precise recommendation of the relevant items\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/working-with-training-metrics.md |
f02258c924f7-0 | The following is a simple example where, to generate metrics, a solution version produces a list of recommendations for a specific user\. The second and fifth recommendations match records in the testing data for this user\. These are the relevant recommendations\. If `K` is set at `5`, the following metrics are generated for the user\.
**reciprocal\_rank**
Calculation: 1/2
Result: 0\.5000
**normalized\_discounted\_cumulative\_gain\_at\_5**
Calculation: \(1/log\(1 \+ 2\) \+ 1/log\(1 \+ 5\)\) / \(1/log\(1 \+ 1\) \+ 1/log\(1 \+ 2\)\)
Result: 0\.6241
**precision\_at\_5**
Calculation: 2/5
Result: 0\.4000
Now that you have evaluated your solution version, create a campaign by deploying the optimum solution version\. For more information, see [Creating a Campaign](campaigns.md)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/working-with-training-metrics.md |
e54f21e02375-0 | For a sample Jupyter notebook that shows you how to retrieve metrics based on hold\-out data, see [Personalize with temporal evaluation on hold\-out set](https://github.com/aws-samples/amazon-personalize-samples/blob/master/next_steps/core_use_cases/user_personalization/personalize_hrnn_metadata_example.ipynb)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/working-with-training-metrics.md |
5b2e80a1d90c-0 | Provides a summary of the properties of a solution\. For a complete listing, call the [DescribeSolution](API_DescribeSolution.md) API\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_SolutionSummary.md |
e4924ababb03-0 | **creationDateTime** <a name="personalize-Type-SolutionSummary-creationDateTime"></a>
The date and time \(in Unix time\) that the solution was created\.
Type: Timestamp
Required: No
**lastUpdatedDateTime** <a name="personalize-Type-SolutionSummary-lastUpdatedDateTime"></a>
The date and time \(in Unix time\) that the solution was last updated\.
Type: Timestamp
Required: No
**name** <a name="personalize-Type-SolutionSummary-name"></a>
The name of the solution\.
Type: String
Length Constraints: Minimum length of 1\. Maximum length of 63\.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
**solutionArn** <a name="personalize-Type-SolutionSummary-solutionArn"></a>
The Amazon Resource Name \(ARN\) of the solution\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_SolutionSummary.md |
e4924ababb03-1 | Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
**status** <a name="personalize-Type-SolutionSummary-status"></a>
The status of the solution\.
A solution can be in one of the following states:
+ CREATE PENDING > CREATE IN\_PROGRESS > ACTIVE \-or\- CREATE FAILED
+ DELETE PENDING > DELETE IN\_PROGRESS
Type: String
Length Constraints: Maximum length of 256\.
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_SolutionSummary.md |
6c5d8ac60785-0 | For more information about using this API in one of the language\-specific AWS SDKs, see the following:
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/SolutionSummary)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/SolutionSummary)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/SolutionSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/SolutionSummary) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_SolutionSummary.md |
69a52f859386-0 | After you create a CSV file with your data, upload the file to your Amazon Simple Storage Service \( Amazon S3\) bucket\. This is the location that Amazon Personalize imports your data from\.
Amazon Personalize needs permission to access the S3 bucket\. Attach the following policy to your bucket\. For more information, see [How Do I Add an S3 Bucket Policy?](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/add-bucket-policy.html)\.
```
{
"Version": "2012-10-17",
"Id": "PersonalizeS3BucketAccessPolicy",
"Statement": [
{
"Sid": "PersonalizeS3BucketAccessPolicy",
"Effect": "Allow",
"Principal": {
"Service": "personalize.amazonaws.com"
},
"Action": [
"s3:GetObject",
"s3:ListBucket"
],
"Resource": [
"arn:aws:s3:::bucket-name",
"arn:aws:s3:::bucket-name/*"
]
}
]
}
```
**Note** | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/data-prep-upload-s3.md |
69a52f859386-1 | ]
}
]
}
```
**Note**
Because Amazon Personalize does not communicate with AWS VPCs, Amazon Personalize will be unable to interact with Amazon S3 buckets that only allow VPC access\.
After you upload your data to an S3 bucket, import your data into Amazon Personalize\. For more information, see [Importing Your Data](data-prep-importing.md)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/data-prep-upload-s3.md |
85b389c59ae3-0 | Describes the schema for a dataset\. For more information on schemas, see [CreateSchema](API_CreateSchema.md)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DatasetSchema.md |
402787f8fc3f-0 | **creationDateTime** <a name="personalize-Type-DatasetSchema-creationDateTime"></a>
The date and time \(in Unix time\) that the schema was created\.
Type: Timestamp
Required: No
**lastUpdatedDateTime** <a name="personalize-Type-DatasetSchema-lastUpdatedDateTime"></a>
The date and time \(in Unix time\) that the schema was last updated\.
Type: Timestamp
Required: No
**name** <a name="personalize-Type-DatasetSchema-name"></a>
The name of the schema\.
Type: String
Length Constraints: Minimum length of 1\. Maximum length of 63\.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
**schema** <a name="personalize-Type-DatasetSchema-schema"></a>
The schema\.
Type: String
Length Constraints: Maximum length of 10000\.
Required: No
**schemaArn** <a name="personalize-Type-DatasetSchema-schemaArn"></a>
The Amazon Resource Name \(ARN\) of the schema\.
Type: String | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DatasetSchema.md |
402787f8fc3f-1 | The Amazon Resource Name \(ARN\) of the schema\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DatasetSchema.md |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.