id
stringlengths 14
16
| text
stringlengths 1
2.43k
| source
stringlengths 99
229
|
|---|---|---|
02dc2be24771-0 | Timestamp data, such as `TIMESTAMP` \(for Interactions datasets\) or `CREATION_TIMESTAMP` \(for Items datasets\) data, must be in Unix epoch time format in seconds\. For example, the Epoch timestamp in seconds for date July 31, 2020 is 1596238243\. To convert dates to Unix epoch timestamps use a [Epoch Converter \- Unix Timestamp Converter](https://www.epochconverter.com)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/data-prep-formatting.md |
e0da0b5f2fb2-0 | Amazon Personalize uses `CREATION_TIMESTAMP` data \(in Unix epoch time format, in seconds\) to calculate the age of an item and adjust recommendations accordingly\.
If your schema has a `CREATION_TIMESTAMP` field, but `CREATION_TIMESTAMP` data is missing for one or more items, Amazon Personalize infers this information from interaction data, if any, and uses the timestamp of the item’s oldest interaction data as the item's creation date\. If an item has no interaction data, its creation date is set as the timestamp of the latest interaction in the training set and is considered a new item\.
For more information see [Datasets and Schemas](how-it-works-dataset-schema.md)\. For an example of an Items schema, see [Items Schema Example](how-it-works-dataset-schema.md#schema-examples-items)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/data-prep-formatting.md |
751151b6abf9-0 | Impressions are lists of items that were visible to a user when they interacted with \(for example, clicked or watched\) a particular item\. Amazon Personalize can model two types of impressions:
+ *Implicit impressions* are the recommendations, retrieved from Amazon Personalize, that you show the user\. You can integrate them into your recommendation workflow by including the `RecommendationId` \(returned by the [GetRecommendations](API_RS_GetRecommendations.md) and [GetPersonalizedRanking](API_RS_GetPersonalizedRanking.md) operations\) as input for future [PutEvents](API_UBS_PutEvents.md) requests and Amazon Personalize will derive the implicit impressions based on your recommendation data\.
+ *Explicit impressions* are impressions that you manually record and send to Amazon Personalize\. Use explicit impressions to manipulate results from Amazon Personalize\. For example, use explicit impressions to filter out unavailable items and change the order of recommendations based on user interactions\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/data-prep-formatting.md |
b99aa6f17d2c-0 | To include explicit impressions in your training data, upload them in an interactions dataset \(see [Datasets and Schemas](how-it-works-dataset-schema.md)\) or list them in the [PutEvents](API_UBS_PutEvents.md) command's `impression` input parameter\. The impressions are added to the recommendation that you specify in the `recommendationId` parameter:
```
{
"eventList": [
{
"eventId": "event1",
"eventType": "Rating",
"sentAt": 1553631760,
"itemId": "item id"
"recommendationId": "id"
"impression": ["itemId1", "itemId2", "itemId3"]
}
],
"sessionId": "session1",
"trackingId": "tracking_id",
"userId": "1"
}
```
**Important**
If you provide conflicting implicit and explicit impression data in your `PutEvents` requests, Amazon Personalize uses the explicit impressions by default\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/data-prep-formatting.md |
b99aa6f17d2c-1 | **Important**
If you provide conflicting implicit and explicit impression data in your `PutEvents` requests, Amazon Personalize uses the explicit impressions by default\.
Impressions data is recorded in Interactions datasets, with each impression separated by a `|` character, or sent in a [PutEvents](API_UBS_PutEvents.md) request \(the `|` character is not required when using the SDK\)\. For more information about datasets in Amazon Personalize, see [Datasets and Schemas](how-it-works-dataset-schema.md)\.
The following is a short excerpt from an Interactions dataset that includes explicit impressions in the `IMPRESSION` column\.
| EVENT\_TYPE | IMPRESSION | ITEM\_ID | TIMESTAMP | USER\_ID |
| --- | --- | --- | --- | --- |
| click | 73\|70\|17\|95\|96 | 73 | 1586731606 | USER\_1 |
| click | 35\|82\|78\|57\|20\|63\|1\|90\|76\|75\|49\|71\|26\|24\|25\|6 | 35 | 1586735164 | USER\_2 |
| \.\.\. | \.\.\. | \.\.\. | \.\.\. | \.\.\. | | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/data-prep-formatting.md |
b99aa6f17d2c-2 | | \.\.\. | \.\.\. | \.\.\. | \.\.\. | \.\.\. |
The application showed user `USER_1` items `73`, `70`, `17`, `95`, and `96` and the user ultimately chose item `73`\. When you create a new solution version based on this data, items `70`, `17`, `95`, and `96` will be less frequently recommended to user `USER_1`\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/data-prep-formatting.md |
619efbffd8eb-0 | To include multiple categories for a single item when you use categorical string data, separate the values using the vertical bar, '\|', character\. For example, to match the Items schema from the previous section using two categories, a data row would resemble the following:
```
ITEM_ID,GENRE
item_123,horror|comedy
```
After you format your data, upload it to an Amazon S3 bucket so you can import it into Amazon Personalize\. For more information, see [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/data-prep-formatting.md |
8c588bdc3765-0 | The following data types are supported by Amazon Personalize Runtime:
+ [PredictedItem](API_RS_PredictedItem.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_Types_Amazon_Personalize_Runtime.md |
2304979bfaa2-0 | Creates a campaign by deploying a solution version\. When a client calls the [GetRecommendations](https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) and [GetPersonalizedRanking](https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetPersonalizedRanking.html) APIs, a campaign is specified in the request\.
**Minimum Provisioned TPS and Auto\-Scaling**
A transaction is a single `GetRecommendations` or `GetPersonalizedRanking` call\. Transactions per second \(TPS\) is the throughput and unit of billing for Amazon Personalize\. The minimum provisioned TPS \(`minProvisionedTPS`\) specifies the baseline throughput provisioned by Amazon Personalize, and thus, the minimum billing charge\.
If your TPS increases beyond `minProvisionedTPS`, Amazon Personalize auto\-scales the provisioned capacity up and down, but never below `minProvisionedTPS`\. There's a short time delay while the capacity is increased that might cause loss of transactions\.
The actual TPS used is calculated as the average requests/second within a 5\-minute window\. You pay for maximum of either the minimum provisioned TPS or the actual TPS\. We recommend starting with a low `minProvisionedTPS`, track your usage using Amazon CloudWatch metrics, and then increase the `minProvisionedTPS` as necessary\.
**Status** | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CreateCampaign.md |
2304979bfaa2-1 | **Status**
A campaign can be in one of the following states:
+ CREATE PENDING > CREATE IN\_PROGRESS > ACTIVE \-or\- CREATE FAILED
+ DELETE PENDING > DELETE IN\_PROGRESS
To get the campaign status, call [DescribeCampaign](API_DescribeCampaign.md)\.
**Note**
Wait until the `status` of the campaign is `ACTIVE` before asking the campaign for recommendations\.
**Related APIs**
+ [ListCampaigns](API_ListCampaigns.md)
+ [DescribeCampaign](API_DescribeCampaign.md)
+ [UpdateCampaign](API_UpdateCampaign.md)
+ [DeleteCampaign](API_DeleteCampaign.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CreateCampaign.md |
63e16d27434a-0 | ```
{
"campaignConfig": {
"itemExplorationConfig": {
"string" : "string"
}
},
"minProvisionedTPS": number,
"name": "string",
"solutionVersionArn": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CreateCampaign.md |
c072c70a2153-0 | The request accepts the following data in JSON format\.
** [campaignConfig](#API_CreateCampaign_RequestSyntax) ** <a name="personalize-CreateCampaign-request-campaignConfig"></a>
The configuration details of a campaign\.
Type: [CampaignConfig](API_CampaignConfig.md) object
Required: No
** [minProvisionedTPS](#API_CreateCampaign_RequestSyntax) ** <a name="personalize-CreateCampaign-request-minProvisionedTPS"></a>
Specifies the requested minimum provisioned transactions \(recommendations\) per second that Amazon Personalize will support\.
Type: Integer
Valid Range: Minimum value of 1\.
Required: Yes
** [name](#API_CreateCampaign_RequestSyntax) ** <a name="personalize-CreateCampaign-request-name"></a>
A name for the new campaign\. The campaign name must be unique within your account\.
Type: String
Length Constraints: Minimum length of 1\. Maximum length of 63\.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: Yes | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CreateCampaign.md |
c072c70a2153-1 | Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: Yes
** [solutionVersionArn](#API_CreateCampaign_RequestSyntax) ** <a name="personalize-CreateCampaign-request-solutionVersionArn"></a>
The Amazon Resource Name \(ARN\) of the solution version to deploy\.
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_CreateCampaign.md |
c81d88ae65ff-0 | ```
{
"campaignArn": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CreateCampaign.md |
cf5d31190599-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\.
** [campaignArn](#API_CreateCampaign_ResponseSyntax) ** <a name="personalize-CreateCampaign-response-campaignArn"></a>
The Amazon Resource Name \(ARN\) of the campaign\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CreateCampaign.md |
a77a7b8a11b2-0 | **InvalidInputException**
Provide a valid value for the field or parameter\.
HTTP Status Code: 400
**LimitExceededException**
The limit on the number of requests per second has been exceeded\.
HTTP Status Code: 400
**ResourceAlreadyExistsException**
The specified resource already exists\.
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_CreateCampaign.md |
1344f521b026-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/CreateCampaign)
+ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/personalize-2018-05-22/CreateCampaign)
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateCampaign)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/CreateCampaign)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/CreateCampaign)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/personalize-2018-05-22/CreateCampaign)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateCampaign) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CreateCampaign.md |
1344f521b026-1 | + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateCampaign)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateCampaign) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CreateCampaign.md |
7cd4d0e4746d-0 | Amazon Personalize provides recipes, based on common use cases, for training models\. A *recipe* is a machine learning algorithm or algorithm variant that you use with settings, or hyperparameters, and a dataset group to train an Amazon Personalize model\. With recipes, you can create a personalization system without prior machine learning experience\.
The predefined recipes use the following during training:
+ Predefined attributes of your data
+ Predefined feature transformations
+ Predefined algorithms
+ Initial parameter settings for the algorithms
To optimize your model, you can override many of these parameters when you create a solution\. For more information, see [Hyperparameters and HPO](customizing-solution-config-hpo.md)\.
Choose a specific recipe based on what you want to accomplish and how familiar you are with the recipes\. Each recipe is designed for a specific use case\. When creating a solution, choose the recipe that best fits your needs\. See [Amazon Personalize Recipe Categories](#recipe-categories) for a list of Amazon Personalize recipes by category\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/working-with-predefined-recipes.md |
06ef67f96d02-0 | Amazon Personalize provides three types of recipes\. Besides behavioral differences, each type has different requirements for getting recommendations, as shown in the following table\.
| Recipe type | API | Requirements | Recipes |
| --- | --- | --- | --- |
| USER\_PERSONALIZATION | [GetRecommendations](API_RS_GetRecommendations.md) | `userId`: Required `itemId`: Optional `inputList`: NA | [User\-Personalization](native-recipe-new-item-USER_PERSONALIZATION.md) [HRNN](native-recipe-hrnn.md) [HRNN\-Metadata](native-recipe-hrnn-metadata.md) [HRNN\-Coldstart](native-recipe-hrnn-coldstart.md) [Popularity\-Count](native-recipe-popularity.md) |
| PERSONALIZED\_RANKING | [GetPersonalizedRanking](API_RS_GetPersonalizedRanking.md) | `userId`: Required `itemId`: NA `inputList`: list of itemId's | [Personalized\-Ranking](native-recipe-search.md) |
| RELATED\_ITEMS | [GetRecommendations](API_RS_GetRecommendations.md) | `userId`: Not used `itemId`: Required `inputList`: NA | [SIMS](native-recipe-sims.md) | | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/working-with-predefined-recipes.md |
87629b7743a8-0 | To see a list of available recipes:
+ In the Amazon Personalize console, choose a dataset group\. From the navigation pane, choose **Solutions and recipes**, and choose the **Recipes** tab\.
+ With the AWS SDK for Python \(Boto3\), call the [ListRecipes](API_ListRecipes.md) API\.
+ With the AWS CLI, use the following command\.
```
aws personalize list-recipes
```
To get information about a recipe using the SDK for Python \(Boto3\), call the [DescribeRecipe](API_DescribeRecipe.md) API\. To get information about a recipe using the AWS CLI, use the following command\.
```
aws personalize describe-recipe --recipe-arn recipe_arn
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/working-with-predefined-recipes.md |
32388aae32ac-0 | Amazon Personalize can automatically choose the most appropriate hierarchical recurrent neural network \(HRNN\) recipe based on its analysis of the input data\. This option is called AutoML\. To perform AutoML, set the `performAutoML` parameter to `true` when you call the [CreateSolution](API_CreateSolution.md) API\.
You can also specify the list of recipes that Amazon Personalize examines to determine the optimal recipe, based on a metric you specify\. In this case, you call the `CreateSolution` operation, specify `true` for the `performAutoML` parameter, omit the `recipeArn` parameter, and include the `solutionConfig` parameter, specifying the `metricName` and `recipeList` as part of the `autoMLConfig` object\.
How a recipe is chosen is shown in the following table\. Either `performAutoML`or `recipeArn` must be specified but not both\. AutoML is only performed using the HRNN recipes\.
| performAutoML | recipeArn | solutionConfig | Result |
| --- | --- | --- | --- |
| true | omit | omitted | Amazon Personalize chooses the recipe |
| true | omit | autoMLConfig: metricName and recipeList specified | Amazon Personalize chooses a recipe from the list that optimizes the metric |
| omit | specified | omitted | You specify the recipe |
| omit | specified | specified | You specify the recipe and override the default training properties |
**Note** | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/working-with-predefined-recipes.md |
32388aae32ac-1 | | omit | specified | specified | You specify the recipe and override the default training properties |
**Note**
When `performAutoML` is `true`, all parameters of the `solutionConfig` object are ignored except for `autoMLConfig`\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/working-with-predefined-recipes.md |
7fa5a4a28bb0-0 | An object that provides information about a specific version of a [Solution](API_Solution.md)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_SolutionVersion.md |
1bfdaf44bfc3-0 | **creationDateTime** <a name="personalize-Type-SolutionVersion-creationDateTime"></a>
The date and time \(in Unix time\) that this version of the solution was created\.
Type: Timestamp
Required: No
**datasetGroupArn** <a name="personalize-Type-SolutionVersion-datasetGroupArn"></a>
The Amazon Resource Name \(ARN\) of the dataset group providing the training data\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
**eventType** <a name="personalize-Type-SolutionVersion-eventType"></a>
The event type \(for example, 'click' or 'like'\) that is used for training the model\.
Type: String
Length Constraints: Maximum length of 256\.
Required: No
**failureReason** <a name="personalize-Type-SolutionVersion-failureReason"></a>
If training a solution version fails, the reason for the failure\.
Type: String
Required: No
**lastUpdatedDateTime** <a name="personalize-Type-SolutionVersion-lastUpdatedDateTime"></a> | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_SolutionVersion.md |
1bfdaf44bfc3-1 | **lastUpdatedDateTime** <a name="personalize-Type-SolutionVersion-lastUpdatedDateTime"></a>
The date and time \(in Unix time\) that the solution was last updated\.
Type: Timestamp
Required: No
**performAutoML** <a name="personalize-Type-SolutionVersion-performAutoML"></a>
When true, Amazon Personalize searches for the most optimal recipe according to the solution configuration\. When false \(the default\), Amazon Personalize uses `recipeArn`\.
Type: Boolean
Required: No
**performHPO** <a name="personalize-Type-SolutionVersion-performHPO"></a>
Whether to perform hyperparameter optimization \(HPO\) on the chosen recipe\. The default is `false`\.
Type: Boolean
Required: No
**recipeArn** <a name="personalize-Type-SolutionVersion-recipeArn"></a>
The ARN of the recipe used in the solution\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
**solutionArn** <a name="personalize-Type-SolutionVersion-solutionArn"></a> | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_SolutionVersion.md |
1bfdaf44bfc3-2 | Required: No
**solutionArn** <a name="personalize-Type-SolutionVersion-solutionArn"></a>
The ARN of the solution\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
**solutionConfig** <a name="personalize-Type-SolutionVersion-solutionConfig"></a>
Describes the configuration properties for the solution\.
Type: [SolutionConfig](API_SolutionConfig.md) object
Required: No
**solutionVersionArn** <a name="personalize-Type-SolutionVersion-solutionVersionArn"></a>
The ARN of the solution version\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
**status** <a name="personalize-Type-SolutionVersion-status"></a>
The status of the solution version\.
A solution version can be in one of the following states:
+ CREATE PENDING
+ CREATE IN\_PROGRESS
+ ACTIVE
+ CREATE FAILED
Type: String | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_SolutionVersion.md |
1bfdaf44bfc3-3 | + CREATE PENDING
+ CREATE IN\_PROGRESS
+ ACTIVE
+ CREATE FAILED
Type: String
Length Constraints: Maximum length of 256\.
Required: No
**trainingHours** <a name="personalize-Type-SolutionVersion-trainingHours"></a>
The time used to train the model\. You are billed for the time it takes to train a model\. This field is visible only after Amazon Personalize successfully trains a model\.
Type: Double
Valid Range: Minimum value of 0\.
Required: No
**trainingMode** <a name="personalize-Type-SolutionVersion-trainingMode"></a>
The scope of training used to create the solution version\. The `FULL` option trains the solution version based on the entirety of the input solution's training data, while the `UPDATE` option processes only the training data that has changed since the creation of the last solution version\. Choose `UPDATE` when you want to start recommending items added to the dataset without retraining the model\.
The `UPDATE` option can only be used after you've created a solution version with the `FULL` option and the training solution uses the [HRNN\-Coldstart Recipe](native-recipe-hrnn-coldstart.md)\.
Type: String
Valid Values:` FULL | UPDATE`
Required: No
**tunedHPOParams** <a name="personalize-Type-SolutionVersion-tunedHPOParams"></a> | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_SolutionVersion.md |
1bfdaf44bfc3-4 | **tunedHPOParams** <a name="personalize-Type-SolutionVersion-tunedHPOParams"></a>
If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model\.
Type: [TunedHPOParams](API_TunedHPOParams.md) object
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_SolutionVersion.md |
6ea784fba84e-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/SolutionVersion)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/SolutionVersion)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/SolutionVersion)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/SolutionVersion) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_SolutionVersion.md |
f6454c0cbdcf-0 | After you have created a campaign, you can use it in your applications to get recommendations\. The following topics explain how and when to use each recommendation type\.
**Topics**
+ [How Recommendation Scoring Works](#how-scores-work)
+ [Getting Real\-Time Recommendations](getting-real-time-recommendations.md)
+ [Getting Batch Recommendations](recommendations-batch.md)
+ [Filtering Recommendations](filter.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/getting-recommendations.md |
3d6c78e03bbf-0 | To make recommendations, Amazon Personalize generates scores for the items in your Items dataset based on a user's interaction data and metadata\. These scores represent the relative certainty that Amazon Personalize has in which item the user will select next\. Higher scores represent greater certainty\.
The formulas that calculate scores depend on the recommendation use case and the recipe that was used to train the model\. You can view item scores in the Amazon Personalize console or by using the [Amazon Personalize Runtime](https://docs.aws.amazon.com/personalize/latest/dg/API_Operations_Amazon_Personalize_Runtime.html) APIs\. For more information on how scores are calculated and what they mean, see [Getting Real\-Time Recommendations](getting-real-time-recommendations.md) and [Getting Batch Recommendations](recommendations-batch.md)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/getting-recommendations.md |
09f03f723d92-0 | Re\-ranks a list of recommended items for the given user\. The first item in the list is deemed the most likely item to be of interest to the user\.
**Note**
The solution backing the campaign must have been created using a recipe of type PERSONALIZED\_RANKING\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_RS_GetPersonalizedRanking.md |
eacc0db7d9c1-0 | ```
POST /personalize-ranking HTTP/1.1
Content-type: application/json
{
"campaignArn": "string",
"context": {
"string" : "string"
},
"filterArn": "string",
"inputList": [ "string" ],
"userId": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_RS_GetPersonalizedRanking.md |
ffc11f9640a3-0 | The request does not use any URI parameters\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_RS_GetPersonalizedRanking.md |
7043a314e053-0 | The request accepts the following data in JSON format\.
** [campaignArn](#API_RS_GetPersonalizedRanking_RequestSyntax) ** <a name="personalize-RS_GetPersonalizedRanking-request-campaignArn"></a>
The Amazon Resource Name \(ARN\) of the campaign to use for generating the personalized ranking\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
** [context](#API_RS_GetPersonalizedRanking_RequestSyntax) ** <a name="personalize-RS_GetPersonalizedRanking-request-context"></a>
The contextual metadata to use when getting recommendations\. Contextual metadata includes any interaction information that might be relevant when getting a user's recommendations, such as the user's current location or device type\.
Type: String to string map
Map Entries: Maximum number of 150 items\.
Key Length Constraints: Maximum length of 150\.
Key Pattern: `[A-Za-z\d_]+`
Value Length Constraints: Maximum length of 1000\.
Required: No
** [filterArn](#API_RS_GetPersonalizedRanking_RequestSyntax) ** <a name="personalize-RS_GetPersonalizedRanking-request-filterArn"></a> | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_RS_GetPersonalizedRanking.md |
7043a314e053-1 | The Amazon Resource Name \(ARN\) of a filter you created to include or exclude items from recommendations for a given user\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** [inputList](#API_RS_GetPersonalizedRanking_RequestSyntax) ** <a name="personalize-RS_GetPersonalizedRanking-request-inputList"></a>
A list of items \(by `itemId`\) to rank\. If an item was not included in the training dataset, the item is appended to the end of the reranked list\. The maximum is 500\.
Type: Array of strings
Length Constraints: Maximum length of 256\.
Required: Yes
** [userId](#API_RS_GetPersonalizedRanking_RequestSyntax) ** <a name="personalize-RS_GetPersonalizedRanking-request-userId"></a>
The user for which you want the campaign to provide a personalized ranking\.
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_RS_GetPersonalizedRanking.md |
4e7831e44fda-0 | ```
HTTP/1.1 200
Content-type: application/json
{
"personalizedRanking": [
{
"itemId": "string",
"score": number
}
],
"recommendationId": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_RS_GetPersonalizedRanking.md |
26fda867ea6e-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\.
** [personalizedRanking](#API_RS_GetPersonalizedRanking_ResponseSyntax) ** <a name="personalize-RS_GetPersonalizedRanking-response-personalizedRanking"></a>
A list of items in order of most likely interest to the user\. The maximum is 500\.
Type: Array of [PredictedItem](API_RS_PredictedItem.md) objects
** [recommendationId](#API_RS_GetPersonalizedRanking_ResponseSyntax) ** <a name="personalize-RS_GetPersonalizedRanking-response-recommendationId"></a>
The ID of the recommendation\.
Type: String | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_RS_GetPersonalizedRanking.md |
0569f4c6487e-0 | **InvalidInputException**
Provide a valid value for the field or parameter\.
HTTP Status Code: 400
**ResourceNotFoundException**
The specified resource does not exist\.
HTTP Status Code: 404 | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_RS_GetPersonalizedRanking.md |
5b7a1001ad19-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-runtime-2018-05-22/GetPersonalizedRanking)
+ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/personalize-runtime-2018-05-22/GetPersonalizedRanking)
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-runtime-2018-05-22/GetPersonalizedRanking)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-runtime-2018-05-22/GetPersonalizedRanking)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-runtime-2018-05-22/GetPersonalizedRanking)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/personalize-runtime-2018-05-22/GetPersonalizedRanking) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_RS_GetPersonalizedRanking.md |
5b7a1001ad19-1 | + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-runtime-2018-05-22/GetPersonalizedRanking)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-runtime-2018-05-22/GetPersonalizedRanking)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-runtime-2018-05-22/GetPersonalizedRanking) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_RS_GetPersonalizedRanking.md |
04878d18a023-0 | Deletes the event tracker\. Does not delete the event\-interactions dataset from the associated dataset group\. For more information on event trackers, see [CreateEventTracker](API_CreateEventTracker.md)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DeleteEventTracker.md |
407a8b97a811-0 | ```
{
"eventTrackerArn": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DeleteEventTracker.md |
d877af012e63-0 | The request accepts the following data in JSON format\.
** [eventTrackerArn](#API_DeleteEventTracker_RequestSyntax) ** <a name="personalize-DeleteEventTracker-request-eventTrackerArn"></a>
The Amazon Resource Name \(ARN\) of the event tracker 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_DeleteEventTracker.md |
9783a4dcd1cf-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_DeleteEventTracker.md |
6f2c1f0feaf4-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_DeleteEventTracker.md |
f1c3e22d78a3-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/DeleteEventTracker)
+ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/personalize-2018-05-22/DeleteEventTracker)
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DeleteEventTracker)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/DeleteEventTracker)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/DeleteEventTracker)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/personalize-2018-05-22/DeleteEventTracker) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DeleteEventTracker.md |
f1c3e22d78a3-1 | + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteEventTracker)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DeleteEventTracker)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DeleteEventTracker) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DeleteEventTracker.md |
7061ace83227-0 | As a managed service, Amazon Personalize is protected by the AWS global network security procedures that are described in the [Amazon Web Services: Overview of Security Processes](https://d0.awsstatic.com/whitepapers/Security/AWS_Security_Whitepaper.pdf) whitepaper\.
You use AWS published API calls to access Amazon Personalizethrough the network\. Clients must support Transport Layer Security \(TLS\) 1\.0 or later\. We recommend TLS 1\.2 or later\. Clients must also support cipher suites with perfect forward secrecy \(PFS\) such as Ephemeral Diffie\-Hellman \(DHE\) or Elliptic Curve Ephemeral Diffie\-Hellman \(ECDHE\)\. Most modern systems such as Java 7 and later support these modes\.
Additionally, requests must be signed by using an access key ID and a secret access key that is associated with an IAM principal\. Or you can use the [AWS Security Token Service](https://docs.aws.amazon.com/STS/latest/APIReference/Welcome.html) \(AWS STS\) to generate temporary security credentials to sign requests\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/infrastructure-security.md |
1fbdba08d926-0 | Returns a list of dataset import jobs that use the given dataset\. When a dataset is not specified, all the dataset import jobs associated with the account are listed\. The response provides the properties for each dataset import job, including the Amazon Resource Name \(ARN\)\. For more information on dataset import jobs, see [CreateDatasetImportJob](API_CreateDatasetImportJob.md)\. 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_ListDatasetImportJobs.md |
bba4710b66fc-0 | ```
{
"datasetArn": "string",
"maxResults": number,
"nextToken": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListDatasetImportJobs.md |
3c43ce987665-0 | The request accepts the following data in JSON format\.
** [datasetArn](#API_ListDatasetImportJobs_RequestSyntax) ** <a name="personalize-ListDatasetImportJobs-request-datasetArn"></a>
The Amazon Resource Name \(ARN\) of the dataset to list the dataset import jobs for\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** [maxResults](#API_ListDatasetImportJobs_RequestSyntax) ** <a name="personalize-ListDatasetImportJobs-request-maxResults"></a>
The maximum number of dataset import jobs to return\.
Type: Integer
Valid Range: Minimum value of 1\. Maximum value of 100\.
Required: No
** [nextToken](#API_ListDatasetImportJobs_RequestSyntax) ** <a name="personalize-ListDatasetImportJobs-request-nextToken"></a>
A token returned from the previous call to `ListDatasetImportJobs` for getting the next set of dataset import jobs \(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_ListDatasetImportJobs.md |
3c43ce987665-1 | 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_ListDatasetImportJobs.md |
5f2073f6b49f-0 | ```
{
"datasetImportJobs": [
{
"creationDateTime": number,
"datasetImportJobArn": "string",
"failureReason": "string",
"jobName": "string",
"lastUpdatedDateTime": number,
"status": "string"
}
],
"nextToken": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListDatasetImportJobs.md |
72167983a7de-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\.
** [datasetImportJobs](#API_ListDatasetImportJobs_ResponseSyntax) ** <a name="personalize-ListDatasetImportJobs-response-datasetImportJobs"></a>
The list of dataset import jobs\.
Type: Array of [DatasetImportJobSummary](API_DatasetImportJobSummary.md) objects
Array Members: Maximum number of 100 items\.
** [nextToken](#API_ListDatasetImportJobs_ResponseSyntax) ** <a name="personalize-ListDatasetImportJobs-response-nextToken"></a>
A token for getting the next set of dataset import jobs \(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_ListDatasetImportJobs.md |
2eb53972f28f-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_ListDatasetImportJobs.md |
317a686143db-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/ListDatasetImportJobs)
+ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/personalize-2018-05-22/ListDatasetImportJobs)
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListDatasetImportJobs)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/ListDatasetImportJobs)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/ListDatasetImportJobs)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/personalize-2018-05-22/ListDatasetImportJobs) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListDatasetImportJobs.md |
317a686143db-1 | + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListDatasetImportJobs)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListDatasetImportJobs)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListDatasetImportJobs) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListDatasetImportJobs.md |
64ab50053ac7-0 | The configuration details of a campaign\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CampaignConfig.md |
ac633c6f7c13-0 | **itemExplorationConfig** <a name="personalize-Type-CampaignConfig-itemExplorationConfig"></a>
A string to string map specifying the exploration configuration hyperparameters, including `explorationWeight` and `explorationItemAgeCutOff`, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items\. See [User\-Personalization Recipe](native-recipe-new-item-USER_PERSONALIZATION.md)\.
Type: String to string map
Map Entries: Maximum number of 100 items\.
Key Length Constraints: Maximum length of 256\.
Value Length Constraints: Maximum length of 1000\.
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CampaignConfig.md |
3435d858f9ca-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/CampaignConfig)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/CampaignConfig)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/CampaignConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CampaignConfig) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CampaignConfig.md |
3b58cec10275-0 | A truncated version of the [BatchInferenceJob](API_BatchInferenceJob.md) datatype\. The [ListBatchInferenceJobs](API_ListBatchInferenceJobs.md) operation returns a list of batch inference job summaries\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_BatchInferenceJobSummary.md |
b78265314f20-0 | **batchInferenceJobArn** <a name="personalize-Type-BatchInferenceJobSummary-batchInferenceJobArn"></a>
The Amazon Resource Name \(ARN\) of the batch inference job\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
**creationDateTime** <a name="personalize-Type-BatchInferenceJobSummary-creationDateTime"></a>
The time at which the batch inference job was created\.
Type: Timestamp
Required: No
**failureReason** <a name="personalize-Type-BatchInferenceJobSummary-failureReason"></a>
If the batch inference job failed, the reason for the failure\.
Type: String
Required: No
**jobName** <a name="personalize-Type-BatchInferenceJobSummary-jobName"></a>
The name of the batch inference job\.
Type: String
Length Constraints: Minimum length of 1\. Maximum length of 63\.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_BatchInferenceJobSummary.md |
b78265314f20-1 | Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
**lastUpdatedDateTime** <a name="personalize-Type-BatchInferenceJobSummary-lastUpdatedDateTime"></a>
The time at which the batch inference job was last updated\.
Type: Timestamp
Required: No
**solutionVersionArn** <a name="personalize-Type-BatchInferenceJobSummary-solutionVersionArn"></a>
The ARN of the solution version used by the batch inference job\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
**status** <a name="personalize-Type-BatchInferenceJobSummary-status"></a>
The status of the batch inference job\. The status is one of the following values:
+ PENDING
+ IN PROGRESS
+ ACTIVE
+ 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_BatchInferenceJobSummary.md |
3f58573d7dfc-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/BatchInferenceJobSummary)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/BatchInferenceJobSummary)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/BatchInferenceJobSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchInferenceJobSummary) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_BatchInferenceJobSummary.md |
9b9223f6c404-0 | Provides the name and default range of a integer\-valued hyperparameter and whether the hyperparameter is tunable\. A tunable hyperparameter can have its value determined during hyperparameter optimization \(HPO\)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DefaultIntegerHyperParameterRange.md |
4a9c17d697af-0 | **isTunable** <a name="personalize-Type-DefaultIntegerHyperParameterRange-isTunable"></a>
Indicates whether the hyperparameter is tunable\.
Type: Boolean
Required: No
**maxValue** <a name="personalize-Type-DefaultIntegerHyperParameterRange-maxValue"></a>
The maximum allowable value for the hyperparameter\.
Type: Integer
Valid Range: Maximum value of 1000000\.
Required: No
**minValue** <a name="personalize-Type-DefaultIntegerHyperParameterRange-minValue"></a>
The minimum allowable value for the hyperparameter\.
Type: Integer
Valid Range: Minimum value of \-1000000\.
Required: No
**name** <a name="personalize-Type-DefaultIntegerHyperParameterRange-name"></a>
The name of the hyperparameter\.
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_DefaultIntegerHyperParameterRange.md |
4661da41373f-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/DefaultIntegerHyperParameterRange)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/DefaultIntegerHyperParameterRange)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/DefaultIntegerHyperParameterRange)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DefaultIntegerHyperParameterRange) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DefaultIntegerHyperParameterRange.md |
5a83ef9ce7a4-0 | Creates an event tracker that you use when sending event data to the specified dataset group using the [PutEvents](https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html) API\.
When Amazon Personalize creates an event tracker, it also creates an *event\-interactions* dataset in the dataset group associated with the event tracker\. The event\-interactions dataset stores the event data from the `PutEvents` call\. The contents of this dataset are not available to the user\.
**Note**
Only one event tracker can be associated with a dataset group\. You will get an error if you call `CreateEventTracker` using the same dataset group as an existing event tracker\.
When you send event data you include your tracking ID\. The tracking ID identifies the customer and authorizes the customer to send the data\.
The event tracker can be in one of the following states:
+ CREATE PENDING > CREATE IN\_PROGRESS > ACTIVE \-or\- CREATE FAILED
+ DELETE PENDING > DELETE IN\_PROGRESS
To get the status of the event tracker, call [DescribeEventTracker](API_DescribeEventTracker.md)\.
**Note**
The event tracker must be in the ACTIVE state before using the tracking ID\.
**Related APIs**
+ [ListEventTrackers](API_ListEventTrackers.md)
+ [DescribeEventTracker](API_DescribeEventTracker.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CreateEventTracker.md |
5a83ef9ce7a4-1 | + [DescribeEventTracker](API_DescribeEventTracker.md)
+ [DeleteEventTracker](API_DeleteEventTracker.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CreateEventTracker.md |
8eaa3d0bb111-0 | ```
{
"datasetGroupArn": "string",
"name": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CreateEventTracker.md |
cfcb9971901c-0 | The request accepts the following data in JSON format\.
** [datasetGroupArn](#API_CreateEventTracker_RequestSyntax) ** <a name="personalize-CreateEventTracker-request-datasetGroupArn"></a>
The Amazon Resource Name \(ARN\) of the dataset group that receives the event data\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
** [name](#API_CreateEventTracker_RequestSyntax) ** <a name="personalize-CreateEventTracker-request-name"></a>
The name for the event tracker\.
Type: String
Length Constraints: Minimum length of 1\. Maximum length of 63\.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: Yes | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CreateEventTracker.md |
aa57019dcd12-0 | ```
{
"eventTrackerArn": "string",
"trackingId": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CreateEventTracker.md |
1e86e44eacf6-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\.
** [eventTrackerArn](#API_CreateEventTracker_ResponseSyntax) ** <a name="personalize-CreateEventTracker-response-eventTrackerArn"></a>
The ARN of the event tracker\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
** [trackingId](#API_CreateEventTracker_ResponseSyntax) ** <a name="personalize-CreateEventTracker-response-trackingId"></a>
The ID of the event tracker\. Include this ID in requests to the [PutEvents](https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html) API\.
Type: String
Length Constraints: Maximum length of 256\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CreateEventTracker.md |
54d11b2053aa-0 | **InvalidInputException**
Provide a valid value for the field or parameter\.
HTTP Status Code: 400
**LimitExceededException**
The limit on the number of requests per second has been exceeded\.
HTTP Status Code: 400
**ResourceAlreadyExistsException**
The specified resource already exists\.
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_CreateEventTracker.md |
224cfe2c9ffc-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/CreateEventTracker)
+ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/personalize-2018-05-22/CreateEventTracker)
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateEventTracker)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/CreateEventTracker)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/CreateEventTracker)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/personalize-2018-05-22/CreateEventTracker) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CreateEventTracker.md |
224cfe2c9ffc-1 | + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateEventTracker)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateEventTracker)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateEventTracker) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CreateEventTracker.md |
29a16c48c03b-0 | The HRNN\-Metadata recipe predicts the items that a user will interact with\. It is similar to the [HRNN](native-recipe-hrnn.md) recipe, with additional features derived from contextual, user, and item metadata \(from Interactions, Users, and Items datasets, respectively\)\. HRNN\-Metadata provides accuracy benefits over non\-metadata models when high quality metadata is available\. Using this recipe might require longer training times\.
The HRNN\-Metadata recipe has the following properties:
+ **Name** – `aws-hrnn-metadata`
+ **Recipe Amazon Resource Name \(ARN\)** – `arn:aws:personalize:::recipe/aws-hrnn-metadata`
+ **Algorithm ARN** – `arn:aws:personalize:::algorithm/aws-hrnn-metadata`
+ **Feature transformation ARN** – `arn:aws:personalize:::feature-transformation/featurize_metadata`
+ **Recipe type** – `USER_PERSONALIZATION` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/native-recipe-hrnn-metadata.md |
29a16c48c03b-1 | + **Recipe type** – `USER_PERSONALIZATION`
The following table describes the hyperparameters for the HRNN\-Metadata recipe\. A *hyperparameter* is an algorithm parameter that you can adjust to improve model performance\. Algorithm hyperparameters control how the model performs\. Featurization hyperparameters control how to filter the data to use in training\. The process of choosing the best value for a hyperparameter is called hyperparameter optimization \(HPO\)\. For more information, see [Hyperparameters and HPO](customizing-solution-config-hpo.md)\.
The table also provides the following information for each hyperparameter:
+ **Range**: \[lower bound, upper bound\]
+ **Value type**: Integer, Continuous \(float\), Categorical \(Boolean, list, string\)
+ **HPO tunable**: Can the parameter participate in hyperparameter optimization \(HPO\)?
| Name | Description |
| --- | --- |
| Algorithm Hyperparameters | | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/native-recipe-hrnn-metadata.md |
29a16c48c03b-2 | | Name | Description |
| --- | --- |
| Algorithm Hyperparameters |
| hidden\_dimension | The number of hidden variables used in the model\. *Hidden variables* recreate users' purchase history and item statistics to generate ranking scores\. Specify a greater number of hidden dimensions when your Interactions dataset includes more complicated patterns\. Using more hidden dimensions requires a larger dataset and more time to process\. To decide on the optimal value, use HPO\. To use HPO, set `performHPO` to `true` when you call [CreateSolution](API_CreateSolution.md) and [CreateSolutionVersion](API_CreateSolutionVersion.md) operations\. Default value: 43 Range: \[32, 256\] Value type: Integer HPO tunable: Yes |
| bptt | Determines whether to use the back\-propagation through time technique\. *Back\-propagation through time* is a technique that updates weights in recurrent neural network\-based algorithms\. Use `bptt` for long\-term credits to connect delayed rewards to early events\. For example, a delayed reward can be a purchase made after several clicks\. An early event can be an initial click\. Even within the same event types, such as a click, it’s a good idea to consider long\-term effects and maximize the total rewards\. To consider long\-term effects, use larger `bptt` values\. Using a larger `bptt` value requires larger datasets and more time to process\. Default value: 32 Range: \[2, 32\] Value type: Integer HPO tunable: Yes | | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/native-recipe-hrnn-metadata.md |
29a16c48c03b-3 | | recency\_mask | Determines whether the model should consider the latest popularity trends in the Interactions dataset\. Latest popularity trends might include sudden changes in the underlying patterns of interaction events\. To train a model that places more weight on recent events, set `recency_mask` to `true`\. To train a model that equally weighs all past interactions, set `recency_mask` to `false`\. To get good recommendations using an equal weight, you might need a larger training dataset\. Default value: `True` Range: `True` or `False` Value type: Boolean HPO tunable: Yes |
| Featurization Hyperparameters |
| min\_user\_history\_length\_percentile | The minimum percentile of user history lengths to include in model training\. *History length* is the total amount of data about a user\. Use `min_user_history_length_percentile` to exclude a percentage of users with short history lengths\. Users with a short history often show patterns based on item popularity instead of the user's personal needs or wants\. Removing them can train models with more focus on underlying patterns in your data\. Choose an appropriate value after you review user history lengths, using a histogram or similar tool\. We recommend setting a value that retains the majority of users, but removes the edge cases\. For example, setting `min__user_history_length_percentile to 0.05` and `max_user_history_length_percentile to 0.95` includes all users except those with history lengths at the bottom or top 5%\. Default value: 0\.0 Range: \[0\.0, 1\.0\] Value type: Float HPO tunable: No | | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/native-recipe-hrnn-metadata.md |
29a16c48c03b-4 | | max\_user\_history\_length\_percentile | The maximum percentile of user history lengths to include in model training\. *History length* is the total amount of data about a user\. Use `max_user_history_length_percentile` to exclude a percentage of users with long history lengths because data for these users tend to contain noise\. For example, a robot might have a long list of automated interactions\. Removing these users limits noise in training\. Choose an appropriate value after you review user history lengths using a histogram or similar tool\. We recommend setting a value that retains the majority of users but removes the edge cases\. For example, setting `min__user_history_length_percentile to 0.05` and `max_user_history_length_percentile to 0.95` includes all users except those with history lengths at the bottom or top 5%\. Default value: 0\.99 Range: \[0\.0, 1\.0\] Value type: Float HPO tunable: No | | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/native-recipe-hrnn-metadata.md |
a2337a09d141-0 | The following actions are supported by Amazon Personalize Events:
+ [PutEvents](API_UBS_PutEvents.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_Operations_Amazon_Personalize_Events.md |
0abc6f9aec07-0 | Gets the properties of a batch inference job including name, Amazon Resource Name \(ARN\), status, input and output configurations, and the ARN of the solution version used to generate the recommendations\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeBatchInferenceJob.md |
7f04df4f403d-0 | ```
{
"batchInferenceJobArn": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeBatchInferenceJob.md |
e64170a8cf2b-0 | The request accepts the following data in JSON format\.
** [batchInferenceJobArn](#API_DescribeBatchInferenceJob_RequestSyntax) ** <a name="personalize-DescribeBatchInferenceJob-request-batchInferenceJobArn"></a>
The ARN of the batch inference job to describe\.
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_DescribeBatchInferenceJob.md |
e67ec3b9a564-0 | ```
{
"batchInferenceJob": {
"batchInferenceJobArn": "string",
"batchInferenceJobConfig": {
"itemExplorationConfig": {
"string" : "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"
}
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeBatchInferenceJob.md |
7fe2c3d19cd8-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\.
** [batchInferenceJob](#API_DescribeBatchInferenceJob_ResponseSyntax) ** <a name="personalize-DescribeBatchInferenceJob-response-batchInferenceJob"></a>
Information on the specified batch inference job\.
Type: [BatchInferenceJob](API_BatchInferenceJob.md) object | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeBatchInferenceJob.md |
6da1c497e95b-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_DescribeBatchInferenceJob.md |
580f6b3e8aff-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/DescribeBatchInferenceJob)
+ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/personalize-2018-05-22/DescribeBatchInferenceJob)
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeBatchInferenceJob)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/DescribeBatchInferenceJob)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/DescribeBatchInferenceJob)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/personalize-2018-05-22/DescribeBatchInferenceJob) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeBatchInferenceJob.md |
580f6b3e8aff-1 | + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeBatchInferenceJob)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeBatchInferenceJob)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeBatchInferenceJob) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeBatchInferenceJob.md |
03c6ad6d6197-0 | A short summary of a filter's attributes\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_FilterSummary.md |
d9e3c2ef8755-0 | **creationDateTime** <a name="personalize-Type-FilterSummary-creationDateTime"></a>
The time at which the filter was created\.
Type: Timestamp
Required: No
**datasetGroupArn** <a name="personalize-Type-FilterSummary-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-FilterSummary-failureReason"></a>
If the filter failed, the reason for the failure\.
Type: String
Required: No
**filterArn** <a name="personalize-Type-FilterSummary-filterArn"></a>
The ARN of the filter\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
**lastUpdatedDateTime** <a name="personalize-Type-FilterSummary-lastUpdatedDateTime"></a> | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_FilterSummary.md |
d9e3c2ef8755-1 | **lastUpdatedDateTime** <a name="personalize-Type-FilterSummary-lastUpdatedDateTime"></a>
The time at which the filter was last updated\.
Type: Timestamp
Required: No
**name** <a name="personalize-Type-FilterSummary-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-FilterSummary-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_FilterSummary.md |
95352d7719b2-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/FilterSummary)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/FilterSummary)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/FilterSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/FilterSummary) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_FilterSummary.md |
bcdc54cc12b5-0 | Describes the data source that contains the data to upload to a dataset\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DataSource.md |
523c184ed8cb-0 | **dataLocation** <a name="personalize-Type-DataSource-dataLocation"></a>
The path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored\. For example:
`s3://bucket-name/training-data.csv`
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_DataSource.md |
4ad706a7bc8b-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/DataSource)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/DataSource)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/DataSource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DataSource) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DataSource.md |
84c98921c206-0 | Describes an event tracker\. The response includes the `trackingId` and `status` of the event tracker\. For more information on event trackers, see [CreateEventTracker](API_CreateEventTracker.md)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeEventTracker.md |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.