id
stringlengths 14
16
| text
stringlengths 1
2.43k
| source
stringlengths 99
229
|
|---|---|---|
3e8a203b06bb-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/DatasetSchema)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/DatasetSchema)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/DatasetSchema)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetSchema) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DatasetSchema.md |
c5d77e72816a-0 | Creates the configuration for training a model\. A trained model is known as a solution\. After the configuration is created, you train the model \(create a solution\) by calling the [CreateSolutionVersion](API_CreateSolutionVersion.md) operation\. Every time you call `CreateSolutionVersion`, a new version of the solution is created\.
After creating a solution version, you check its accuracy by calling [GetSolutionMetrics](API_GetSolutionMetrics.md)\. When you are satisfied with the version, you deploy it using [CreateCampaign](API_CreateCampaign.md)\. The campaign provides recommendations to a client through the [GetRecommendations](https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) API\.
To train a model, Amazon Personalize requires training data and a recipe\. The training data comes from the dataset group that you provide in the request\. A recipe specifies the training algorithm and a feature transformation\. You can specify one of the predefined recipes provided by Amazon Personalize\. Alternatively, you can specify `performAutoML` and Amazon Personalize will analyze your data and select the optimum USER\_PERSONALIZATION recipe for you\.
**Status**
A solution can be in one of the following states:
+ CREATE PENDING > CREATE IN\_PROGRESS > ACTIVE \-or\- CREATE FAILED
+ DELETE PENDING > DELETE IN\_PROGRESS | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CreateSolution.md |
c5d77e72816a-1 | + CREATE PENDING > CREATE IN\_PROGRESS > ACTIVE \-or\- CREATE FAILED
+ DELETE PENDING > DELETE IN\_PROGRESS
To get the status of the solution, call [DescribeSolution](API_DescribeSolution.md)\. Wait until the status shows as ACTIVE before calling `CreateSolutionVersion`\.
**Related APIs**
+ [ListSolutions](API_ListSolutions.md)
+ [CreateSolutionVersion](API_CreateSolutionVersion.md)
+ [DescribeSolution](API_DescribeSolution.md)
+ [DeleteSolution](API_DeleteSolution.md)
+ [ListSolutionVersions](API_ListSolutionVersions.md)
+ [DescribeSolutionVersion](API_DescribeSolutionVersion.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CreateSolution.md |
53c3464a318a-0 | ```
{
"datasetGroupArn": "string",
"eventType": "string",
"name": "string",
"performAutoML": boolean,
"performHPO": boolean,
"recipeArn": "string",
"solutionConfig": {
"algorithmHyperParameters": {
"string" : "string"
},
"autoMLConfig": {
"metricName": "string",
"recipeList": [ "string" ]
},
"eventValueThreshold": "string",
"featureTransformationParameters": {
"string" : "string"
},
"hpoConfig": {
"algorithmHyperParameterRanges": {
"categoricalHyperParameterRanges": [
{
"name": "string",
"values": [ "string" ]
}
],
"continuousHyperParameterRanges": [
{
"maxValue": number,
"minValue": number,
"name": "string"
}
],
"integerHyperParameterRanges": [ | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CreateSolution.md |
53c3464a318a-1 | "name": "string"
}
],
"integerHyperParameterRanges": [
{
"maxValue": number,
"minValue": number,
"name": "string"
}
]
},
"hpoObjective": {
"metricName": "string",
"metricRegex": "string",
"type": "string"
},
"hpoResourceConfig": {
"maxNumberOfTrainingJobs": "string",
"maxParallelTrainingJobs": "string"
}
}
}
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CreateSolution.md |
9b16501d0d27-0 | The request accepts the following data in JSON format\.
** [datasetGroupArn](#API_CreateSolution_RequestSyntax) ** <a name="personalize-CreateSolution-request-datasetGroupArn"></a>
The Amazon Resource Name \(ARN\) of the dataset group that provides the training data\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
** [eventType](#API_CreateSolution_RequestSyntax) ** <a name="personalize-CreateSolution-request-eventType"></a>
When your have multiple event types \(using an `EVENT_TYPE` schema field\), this parameter specifies which event type \(for example, 'click' or 'like'\) is used for training the model\.
If you do not provide an `eventType`, Amazon Personalize will use all interactions for training with equal weight regardless of type\.
Type: String
Length Constraints: Maximum length of 256\.
Required: No
** [name](#API_CreateSolution_RequestSyntax) ** <a name="personalize-CreateSolution-request-name"></a>
The name for the solution\.
Type: String
Length Constraints: Minimum length of 1\. Maximum length of 63\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CreateSolution.md |
9b16501d0d27-1 | The name for the solution\.
Type: String
Length Constraints: Minimum length of 1\. Maximum length of 63\.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: Yes
** [performAutoML](#API_CreateSolution_RequestSyntax) ** <a name="personalize-CreateSolution-request-performAutoML"></a>
Whether to perform automated machine learning \(AutoML\)\. The default is `false`\. For this case, you must specify `recipeArn`\.
When set to `true`, Amazon Personalize analyzes your training data and selects the optimal USER\_PERSONALIZATION recipe and hyperparameters\. In this case, you must omit `recipeArn`\. Amazon Personalize determines the optimal recipe by running tests with different values for the hyperparameters\. AutoML lengthens the training process as compared to selecting a specific recipe\.
Type: Boolean
Required: No
** [performHPO](#API_CreateSolution_RequestSyntax) ** <a name="personalize-CreateSolution-request-performHPO"></a>
Whether to perform hyperparameter optimization \(HPO\) on the specified or selected recipe\. The default is `false`\.
When performing AutoML, this parameter is always `true` and you should not set it to `false`\.
Type: Boolean
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CreateSolution.md |
9b16501d0d27-2 | Type: Boolean
Required: No
** [recipeArn](#API_CreateSolution_RequestSyntax) ** <a name="personalize-CreateSolution-request-recipeArn"></a>
The ARN of the recipe to use for model training\. Only specified when `performAutoML` is false\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** [solutionConfig](#API_CreateSolution_RequestSyntax) ** <a name="personalize-CreateSolution-request-solutionConfig"></a>
The configuration to use with the solution\. When `performAutoML` is set to true, Amazon Personalize only evaluates the `autoMLConfig` section of the solution configuration\.
Type: [SolutionConfig](API_SolutionConfig.md) object
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CreateSolution.md |
983d9381e5bf-0 | ```
{
"solutionArn": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CreateSolution.md |
fdba5295eb76-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\.
** [solutionArn](#API_CreateSolution_ResponseSyntax) ** <a name="personalize-CreateSolution-response-solutionArn"></a>
The ARN of the solution\.
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_CreateSolution.md |
7f0c068f672c-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_CreateSolution.md |
80af7ca099bf-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/CreateSolution)
+ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/personalize-2018-05-22/CreateSolution)
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateSolution)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/CreateSolution)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/CreateSolution)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/personalize-2018-05-22/CreateSolution)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateSolution) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CreateSolution.md |
80af7ca099bf-1 | + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateSolution)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateSolution) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CreateSolution.md |
6fb929c5457b-0 | The following steps are prerequisites for the getting started exercises\.
1. Create an AWS account and an AWS Identity and Access Management user, as specified in [Sign Up for AWS](setup.md#aws-personalize-set-up-aws-account)\.
1. Ensure the IAM user that you are using has the [Creating a New IAM Policy](aws-personalize-set-up-permissions.md#set-up-required-permissions)\.
1. Create an AWS Identity and Access Management \(IAM\) service role, as specified in [Creating an IAM Role for Amazon Personalize](aws-personalize-set-up-permissions.md#set-up-create-role-with-permissions)\. Use the role ARN when you upload the movie training data\.
1. Prepare your training data and upload the data to your Amazon S3 bucket, as specified in [Creating the Training Data](#gs-upload-to-bucket)\. Use the name of the Amazon S3 bucket when you upload the movie training data\.
1. Give your Amazon Personalize service role permission to access your Amazon S3 resources, as specified in [Giving Amazon Personalize Access to Amazon S3 Resources](#granting-personalize-s3-access)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/gs-prerequisites.md |
88c79494e62e-0 | To create training data, download, modify, and save the movie ratings data to an Amazon Simple Storage Service \(Amazon S3\) bucket\. Then give Amazon Personalize permission to read from the bucket\.
1. Download the movie ratings zip file, [ml\-latest\-small\.zip](http://files.grouplens.org/datasets/movielens/ml-latest-small.zip) from [MovieLens](https://grouplens.org/datasets/movielens) \(under *recommended for education and development*\)\. Unzip the file\. The user\-interactions data is in the file named `ratings.csv`\.
1. Open the `ratings.csv` file\.
1. Delete the *rating* column\.
1. Replace the header row with the following:
**USER\_ID,ITEM\_ID,TIMESTAMP**
These headers must be exactly as shown for Amazon Personalize to recognize the data\.
Save the `ratings.csv` file\.
1. Upload `ratings.csv` to your Amazon S3 bucket\. For more information, see [Uploading Files and Folders by Using Drag and Drop](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/upload-objects.html) in the Amazon Simple Storage Service Console User Guide\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/gs-prerequisites.md |
88c79494e62e-1 | 1. Give Amazon Personalize permission to read the data in the bucket\. For more information, see [Giving Amazon Personalize Access to Amazon S3 Resources](#granting-personalize-s3-access)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/gs-prerequisites.md |
7a9f0ef03712-0 | To give Amazon Personalize access to your Amazon S3 bucket, do the following:
1. Attach a policy to the Amazon Personalize service role \(see [Creating an IAM Role for Amazon Personalize](aws-personalize-set-up-permissions.md#set-up-create-role-with-permissions)\) that allows access to your Amazon S3 bucket\. For more information, see [Attaching an Amazon S3 Policy to the Amazon Personalize Service Role](#attaching-s3-policy-to-role)\.
1. Attach a bucket policy to the Amazon S3 bucket containing your data files so Amazon Personalize can access them\. For more information, see [Uploading to an S3 Bucket](data-prep-upload-s3.md)\.
**Note**
Because Amazon Personalize doesn’t communicate with AWS VPCs, Amazon Personalize can't interact with Amazon S3 buckets that allow only VPC access\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/gs-prerequisites.md |
08d732cc1031-0 | To attach an Amazon S3 policy to your Amazon Personalize role do the following:
1. Sign in to the IAM console \([https://console\.aws\.amazon\.com/iam](https://console.aws.amazon.com/iam)\)\.
1. In the navigation pane, choose **Policies**, and choose **Create policy**\.
1. Choose the JSON tab, and update the policy as follows\. Replace `bucket-name` with the name of your bucket\.
```
{
"Version": "2012-10-17",
"Id": "PersonalizeS3BucketAccessPolicy",
"Statement": [
{
"Sid": "PersonalizeS3BucketAccessPolicy",
"Effect": "Allow",
"Action": [
"s3:GetObject",
"s3:ListBucket"
],
"Resource": [
"arn:aws:s3:::bucket-name",
"arn:aws:s3:::bucket-name/*"
]
}
]
}
```
1. Choose **Review policy**\.
1. For **Name**, enter `PersonalizeS3BucketAccessPolicy`\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/gs-prerequisites.md |
08d732cc1031-1 | 1. For **Name**, enter `PersonalizeS3BucketAccessPolicy`\.
1. \(Optional\) For **Description**, enter a short sentence describing this policy, for example, **Allow Amazon Personalize to access its S3 bucket\.**
1. Choose **Create policy**\.
1. In the navigation pane, choose **Roles**, and choose \.
1. For **Permissions**, choose **PersonalizeS3BucketAccessPolicy**\.
1. To display the policy in the list, type part of the policy name in the **Filter policies** filter box\.
1. Choose the check box next to **PersonalizeS3BucketAccessPolicy**\.
1. Choose **Attach policy**\.
Before your role is ready for use with Amazon Personalize you must also attach a bucket policy to the Amazon S3 bucket containing your data\. 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/gs-prerequisites.md |
aaa9ec3fc0b6-0 | Describes the given campaign, including its 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
When the `status` is `CREATE FAILED`, the response includes the `failureReason` key, which describes why\.
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_DescribeCampaign.md |
7bf705da42d8-0 | ```
{
"campaignArn": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeCampaign.md |
41d97a30ea27-0 | The request accepts the following data in JSON format\.
** [campaignArn](#API_DescribeCampaign_RequestSyntax) ** <a name="personalize-DescribeCampaign-request-campaignArn"></a>
The Amazon Resource Name \(ARN\) of the campaign\.
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_DescribeCampaign.md |
1dac49cb1dc6-0 | ```
{
"campaign": {
"campaignArn": "string",
"campaignConfig": {
"itemExplorationConfig": {
"string" : "string"
}
},
"creationDateTime": number,
"failureReason": "string",
"lastUpdatedDateTime": number,
"latestCampaignUpdate": {
"campaignConfig": {
"itemExplorationConfig": {
"string" : "string"
}
},
"creationDateTime": number,
"failureReason": "string",
"lastUpdatedDateTime": number,
"minProvisionedTPS": number,
"solutionVersionArn": "string",
"status": "string"
},
"minProvisionedTPS": number,
"name": "string",
"solutionVersionArn": "string",
"status": "string"
}
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeCampaign.md |
a67daba916e0-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\.
** [campaign](#API_DescribeCampaign_ResponseSyntax) ** <a name="personalize-DescribeCampaign-response-campaign"></a>
The properties of the campaign\.
Type: [Campaign](API_Campaign.md) object | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeCampaign.md |
e008c69d1afc-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_DescribeCampaign.md |
5bc77348792e-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/DescribeCampaign)
+ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/personalize-2018-05-22/DescribeCampaign)
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeCampaign)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/DescribeCampaign)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/DescribeCampaign)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/personalize-2018-05-22/DescribeCampaign)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeCampaign) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeCampaign.md |
5bc77348792e-1 | + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeCampaign)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeCampaign) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeCampaign.md |
952a778ff9f6-0 | To use Amazon Personalize, you have to set up permissions that allow IAM users to access the Amazon Personalize console and API operations\. You also have to set up permissions that allow Amazon Personalize to perform tasks on your behalf and to access resources that you own\.
We recommend creating an AWS Identity and Access Management \(IAM\) user with access restricted to Amazon Personalize operations\. You can add other permissions as needed\. For more information, see [Amazon Personalize Identity\-Based Policies](security_iam_service-with-iam.md#security_iam_service-with-iam-id-based-policies)\.
**Note**
We recommend [creating a new IAM policy](#set-up-required-permissions) that grants only the permissions necessary to use Amazon Personalize\.
**To set up permissions**
1. Attach a policy to your Amazon Personalize IAM user or group that allows full access to Amazon Personalize\.
+ Create a new IAM policy and attach it to your IAM user or group \(see [Creating a New IAM Policy](#set-up-required-permissions)\)\.
**or**
+ Attach the `AmazonPersonalizeFullAccess` AWS managed policy to your IAM user or group \(see [AWS Managed Policies](security_iam_id-based-policy-examples.md#using-managed-policies)\)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/aws-personalize-set-up-permissions.md |
952a778ff9f6-1 | 1. Attach the `AmazonS3FullAccess` AWS managed policy to your user or group to grant permissions to access Amazon S3 and create an Amazon S3 bucket\. For more information on granting permission to your Amazon S3 resources see [Using Bucket Policies and User Policies](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html) in the *Amazon S3 Developer Guide*\.
1. Optionally attach the `CloudWatchFullAccess` AWS managed policy to your IAM user or group to grant permissions to monitor Amazon Personalize with CloudWatch\. See [AWS Managed Policies](security_iam_id-based-policy-examples.md#using-managed-policies)\.
1. Create an IAM role for Amazon Personalize and attach the policy from step 1 to the new role\. See [Creating an IAM Role for Amazon Personalize](#set-up-create-role-with-permissions)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/aws-personalize-set-up-permissions.md |
827d5c41bb2e-0 | Create an IAM policy that provides users and Amazon Personalize full access to your Amazon Personalize resources\. Then attach the policy to your IAM user or group\.
**To create and attach an IAM policy**
1. Sign in to the IAM console \([https://console\.aws\.amazon\.com/iam](https://console.aws.amazon.com/iam)\)\.
1. In the navigation pane, choose **Policies**\.
1. Choose **Create policy**\.
1. Choose the **JSON** tab\.
1. Paste following JSON policy document in the text field\.
```
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"personalize:*"
],
"Resource": "*"
},
{
"Effect": "Allow",
"Action": [
"iam:PassRole"
],
"Resource": "*",
"Condition": {
"StringEquals": {
"iam:PassedToService": "personalize.amazonaws.com"
}
}
}
] | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/aws-personalize-set-up-permissions.md |
827d5c41bb2e-1 | }
}
}
]
}
```
1. When you have finished, choose **Review policy**\.
1. On the **Review policy** page, for **Name**, enter a name for the policy\. Optionally, enter a description for **Description**\.
1. In **Summary**, review the policy to see the permissions it grants, then choose **Create policy**\.
1. Attach the new policy to your IAM user or group\.
For information on attaching a policy to a user, see [Changing Permissions for an IAM User](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_change-permissions.html) in the *IAM User Guide*\. For information on attaching a policy to a group, see [Attaching a Policy to an IAM Group](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups_manage_attach-policy.html) in the *IAM User Guide*\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/aws-personalize-set-up-permissions.md |
2afe6c6b30f0-0 | In the following procedure, you create an IAM role that allows Amazon Personalize to access your resources and perform tasks on your behalf\.
1. Sign in to the IAM console \([https://console\.aws\.amazon\.com/iam](https://console.aws.amazon.com/iam)\)\.
1. In the navigation pane, choose **Roles**\.
1. Choose **Create role**\.
1. For **Select type of trusted entity**, choose **AWS service**\.
1. For **Choose the service that will use this role**, choose **Amazon Personalize**\.
1. Choose **Next: Permissions**\.
1. For **Attach permissions policies**, either choose the policy you created in [Creating a New IAM Policy](#set-up-required-permissions) or choose `AmazonPersonalizeFullAccess` \(see [AWS Managed Policies](security_iam_id-based-policy-examples.md#using-managed-policies)\)\.
1. To display the policy in the list, type part of the policy name in the **Filter policies** query filter\.
1. Choose the check box next to the policy name\.
1. Choose **Next: Tags**\. You don't need to add any tags, so choose **Next: Review**\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/aws-personalize-set-up-permissions.md |
2afe6c6b30f0-1 | 1. Choose **Next: Tags**\. You don't need to add any tags, so choose **Next: Review**\.
1. In the **Review** section, for **Role name**, enter a name for the role \(for example, `PersonalizeRole`\)\. Update the description for the role in **Role description**, then choose **Create role**\.
1. Choose the new role to open the role's summary page\.
1. Copy the **Role ARN** value and save it\. You need it to import a dataset into Amazon Personalize\.
Next, you need upload training data and grant Amazon Personalize access to your Amazon S3 bucket\. See [Creating the Training Data](gs-prerequisites.md#gs-upload-to-bucket)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/aws-personalize-set-up-permissions.md |
968dd0f62799-0 | Deletes all versions of a solution and the `Solution` object itself\. Before deleting a solution, you must delete all campaigns based on the solution\. To determine what campaigns are using the solution, call [ListCampaigns](API_ListCampaigns.md) and supply the Amazon Resource Name \(ARN\) of the solution\. You can't delete a solution if an associated `SolutionVersion` is in the CREATE PENDING or IN PROGRESS state\. For more information on solutions, see | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DeleteSolution.md |
968dd0f62799-1 | state\. For more information on solutions, see [CreateSolution](API_CreateSolution.md)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DeleteSolution.md |
6286e6387567-0 | ```
{
"solutionArn": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DeleteSolution.md |
4e7ce9ec1bb8-0 | The request accepts the following data in JSON format\.
** [solutionArn](#API_DeleteSolution_RequestSyntax) ** <a name="personalize-DeleteSolution-request-solutionArn"></a>
The ARN of the solution 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_DeleteSolution.md |
33a6f33badd8-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_DeleteSolution.md |
85ea596f04a7-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_DeleteSolution.md |
ec618e06a791-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/DeleteSolution)
+ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/personalize-2018-05-22/DeleteSolution)
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DeleteSolution)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/DeleteSolution)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/DeleteSolution)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/personalize-2018-05-22/DeleteSolution)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DeleteSolution) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DeleteSolution.md |
ec618e06a791-1 | + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DeleteSolution)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DeleteSolution) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DeleteSolution.md |
d219c92ca303-0 | Use filter expressions to explicitly define which items are included or excluded from your Amazon Personalize recommendations\. To configure filters, you must use a properly formatted *filter expression*\. Filter expressions are composed of dataset and property identifiers in `dataset`\.`property` format, along with logical operators and keywords\.
For a complete list of filter expression elements, see [Filter Expression Elements](#filter-expression-elements)\. For examples of filter expressions, see [Filter Expression Examples](#filter-expression-examples)\.
**Note**
Amazon Personalize ignores case only when matching event types\. It recognizes event types and items that were present during solution version training or that are streamed using the [PutEvents](API_UBS_PutEvents.md) operation\. For more information, see [Creating a Solution](training-deploying-solutions.md)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/filter-expressions.md |
868a4cd74238-0 | You can either manually create filter expressions or get help with expression syntax and structure by using the [Expression builder](filter-real-time.md#using-filter-expression-builder) in the console\. You can use filter expressions to filter items that are contained in the following datasets:
+ **Interactions**: Use filter expressions to include or exclude items that a user has interacted with \(for example, user events such as click or stream\)\. Amazon Personalize filters recommendations based on the most recent 200 historical and 100 new interaction events recorded in a user's Interactions dataset\.
+ **Items**: Use filter expressions to include or exclude items based on specific item conditions\.
+ **Users**: Use filter expressions to include or exclude items based on specific user conditions\. You can add `CurrentUser`, which is part of the User dataset, to any expression regardless of the dataset that is being used in the expression\.
**Note**
You can't chain Interaction and Item datasets into one expression\. To create a filter that filters by Interaction and then Item datasets \(or the opposite\), you must chain two or more expressions together\. For more information, see [Multiple Expressions Example](#multiple-expression-example)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/filter-expressions.md |
dc8980505e8d-0 | Use the following elements to create filter expressions:
+ INCLUDE: Use `INCLUDE` to make sure certain items are in recommendations\.
+ EXCLUDE: Use `EXCLUDE` to remove certain items from recommendations\.
+ ItemID: Use `ItemID` as a placeholder following an `INCLUDE` or `EXCLUDE` element\.
+ WHERE: Use `WHERE` to check conditions for items\. You must use the `WHERE` element after the `ItemID`\.
+ AND/OR: Use `AND` or `OR` to chain multiple conditions together within the same filter expression\.
+ IF: Use `IF` *only* to check conditions for the `CurrentUser` and only once at the end of an expression\. However, you can extend an `IF` condition using `AND`\.
+ IN/NOT IN: Use `IN` or `NOT IN` as comparison operators to filter based on matching \(or not matching\) one or more string values\. Amazon Personalize filters only on exact strings\.
+ Use =, <, <=, >, >= operators to test numerical data for equality\.
+ Use `*` only only for filters that use the `EVENT_TYPE` property of the `Interaction` dataset\.
+ Use the pipe separator \(`|`\) to chain multiple expressions together\. For more information, see [Multiple Expressions Example](#multiple-expression-example)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/filter-expressions.md |
56e0bddcb006-0 | Use the following examples to learn how to build your own filter expressions\. They are organized by dataset type\.
**Interactions**
The following expression excludes items that the user clicked or streamed\.
```
EXCLUDE ItemID WHERE Interactions.EVENT_TYPE IN ("click", "stream")
```
The following expression includes items that the user has interacted with in any way\.
```
INCLUDE ItemID WHERE Interactions.EVENT_TYPE IN ("*")
```
**Items**
The following expression excludes items in the `shoe` category that *do not* have a description of `boot`\.
```
EXCLUDE ItemID WHERE Items.CATEGORY IN ("shoe") AND Items.DESCRIPTION NOT IN ("boot")
```
The following expression includes items with a `NUMBER_OF_DOWNLOADS` less than `20`\.
```
INCLUDE ItemID WHERE Items.NUMBER_OF_DOWNLOADS < 20
```
**Users**
The following expression excludes items where the `NUMBER_OF_DOWNLOADS` is less than `20` if the current user's age is over `18`, but less than `30`\.
```
EXCLUDE ItemID WHERE Items.NUMBER_OF_DOWNLOADS < 20 IF CurrentUser.AGE > 18 AND CurrentUser.AGE < 30
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/filter-expressions.md |
56e0bddcb006-1 | EXCLUDE ItemID WHERE Items.NUMBER_OF_DOWNLOADS < 20 IF CurrentUser.AGE > 18 AND CurrentUser.AGE < 30
```
The following expression includes items in the `watch` category, with a description of `luxury`, if the current user's age is over `18`\.
```
INCLUDE ItemID WHERE Items.CATEGORY IN ("watch") AND Items.DESCRIPTION IN ("luxury") IF CurrentUser.AGE > 18
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/filter-expressions.md |
51d7e1c05e2c-0 | You can chain multiple expressions together using a pipe separator\. This allows you pass the results of one expression to an additional expression so you can filter by multiple datasets and use more precise filtering\.
The following example includes two expressions\. The first includes items in the `drama` genre, and the result of this filter is passed to another expression that excludes items that the user has clicked or streamed\.
```
INCLUDE ItemID WHERE Items.GENRE IN ("drama") | EXCLUDE ItemID WHERE Interactions.EVENT_TYPE IN ("click", "stream")
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/filter-expressions.md |
737319bf0bbd-0 | Describes an algorithm image\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_AlgorithmImage.md |
84a80407bbd9-0 | **dockerURI** <a name="personalize-Type-AlgorithmImage-dockerURI"></a>
The URI of the Docker container for the algorithm image\.
Type: String
Length Constraints: Maximum length of 256\.
Required: Yes
**name** <a name="personalize-Type-AlgorithmImage-name"></a>
The name of the algorithm image\.
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_AlgorithmImage.md |
97d4b2944d00-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/AlgorithmImage)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/AlgorithmImage)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/AlgorithmImage)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/AlgorithmImage) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_AlgorithmImage.md |
90e626610114-0 | Provides the name and default range of a categorical 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_DefaultCategoricalHyperParameterRange.md |
ae5997221b30-0 | **isTunable** <a name="personalize-Type-DefaultCategoricalHyperParameterRange-isTunable"></a>
Whether the hyperparameter is tunable\.
Type: Boolean
Required: No
**name** <a name="personalize-Type-DefaultCategoricalHyperParameterRange-name"></a>
The name of the hyperparameter\.
Type: String
Length Constraints: Maximum length of 256\.
Required: No
**values** <a name="personalize-Type-DefaultCategoricalHyperParameterRange-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_DefaultCategoricalHyperParameterRange.md |
b86f8e235fc3-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/DefaultCategoricalHyperParameterRange)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/DefaultCategoricalHyperParameterRange)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/DefaultCategoricalHyperParameterRange)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DefaultCategoricalHyperParameterRange) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DefaultCategoricalHyperParameterRange.md |
9867ca1fc37d-0 | Describes the given algorithm\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeAlgorithm.md |
adf885513fac-0 | ```
{
"algorithmArn": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeAlgorithm.md |
81f6fd432c0c-0 | The request accepts the following data in JSON format\.
** [algorithmArn](#API_DescribeAlgorithm_RequestSyntax) ** <a name="personalize-DescribeAlgorithm-request-algorithmArn"></a>
The Amazon Resource Name \(ARN\) of the algorithm 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_DescribeAlgorithm.md |
658039426467-0 | ```
{
"algorithm": {
"algorithmArn": "string",
"algorithmImage": {
"dockerURI": "string",
"name": "string"
},
"creationDateTime": number,
"defaultHyperParameterRanges": {
"categoricalHyperParameterRanges": [
{
"isTunable": boolean,
"name": "string",
"values": [ "string" ]
}
],
"continuousHyperParameterRanges": [
{
"isTunable": boolean,
"maxValue": number,
"minValue": number,
"name": "string"
}
],
"integerHyperParameterRanges": [
{
"isTunable": boolean,
"maxValue": number,
"minValue": number,
"name": "string"
}
]
},
"defaultHyperParameters": {
"string" : "string"
},
"defaultResourceConfig": {
"string" : "string"
}, | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeAlgorithm.md |
658039426467-1 | },
"defaultResourceConfig": {
"string" : "string"
},
"lastUpdatedDateTime": number,
"name": "string",
"roleArn": "string",
"trainingInputMode": "string"
}
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeAlgorithm.md |
918d9700b958-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\.
** [algorithm](#API_DescribeAlgorithm_ResponseSyntax) ** <a name="personalize-DescribeAlgorithm-response-algorithm"></a>
A listing of the properties of the algorithm\.
Type: [Algorithm](API_Algorithm.md) object | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeAlgorithm.md |
86c4040e5f16-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_DescribeAlgorithm.md |
9c847f965701-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/DescribeAlgorithm)
+ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/personalize-2018-05-22/DescribeAlgorithm)
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeAlgorithm)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/DescribeAlgorithm)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/DescribeAlgorithm)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/personalize-2018-05-22/DescribeAlgorithm) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeAlgorithm.md |
9c847f965701-1 | + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeAlgorithm)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeAlgorithm)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeAlgorithm) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeAlgorithm.md |
5719a9968675-0 | The AWS Command Line Interface \(AWS CLI\) is a unified developer tool for managing AWS services, including Amazon Personalize\. We recommend that you install it\.
1. To install the AWS CLI, follow the instructions in [Installing the AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/userguide/installing.html) in the *AWS Command Line Interface User Guide*\.
1. To configure the AWS CLI and set up a profile to call the AWS CLI, follow the instructions in [Configuring the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) in the *AWS Command Line Interface User Guide*\.
1. To confirm that the AWS CLI profile is configured properly, run the following command\.
```
aws configure --profile default
```
If your profile has been configured correctly, you will see output similar to the following\.
```
AWS Access Key ID [****************52FQ]:
AWS Secret Access Key [****************xgyZ]:
Default region name [us-west-2]:
Default output format [json]:
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/aws-personalize-set-up-aws-cli.md |
5719a9968675-1 | Default region name [us-west-2]:
Default output format [json]:
```
1. To verify that the AWS CLI is configured for use with Amazon Personalize, run the following commands\.
```
aws personalize help
```
and
```
aws personalize-runtime help
```
and
```
aws personalize-events help
```
If the AWS CLI is configured correctly, you will see a list of the supported AWS CLI commands for Amazon Personalize, Amazon Personalize runtime, and Amazon Personalize events\.
If you set up the AWS CLI and it doesn't recognize the commands for Amazon Personalize, update the AWS CLI\. To update the AWS CLI, run the following command\.
```
pip3 install awscli --upgrade --user
```
For more information, see [Installing the AWS CLI Using pip](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html#install-tool-pip)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/aws-personalize-set-up-aws-cli.md |
146dc762cd69-0 | You can filter real\-time recommendations with the Amazon Personalize console or the AWS SDK\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/filter-real-time.md |
cda462caff82-0 | To filter real\-time recommendations using the console, create a filter and then apply it to a recommendation request\.
**Note**
To filter recommendations using a campaign you deployed before July 30, 2020, you must re\-deploy the campaign by using the [UpdateCampaign](API_UpdateCampaign.md) call or by creating a new campaign\.
**To filter real\-time recommendations \(console\)**
1. Open the Amazon Personalize console at [https://console\.aws\.amazon\.com/personalize/](https://console.aws.amazon.com/personalize/) and sign into your account\.
1. Choose the dataset group that contains the campaign that you want to filter results for\.
1. In the navigation page, choose **Filters** and then choose **Create new filter**\. The **Create filter** page displays\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/personalize/latest/dg/images/create-filter-page.png)
1. For **Filter name**, enter a name for your filter\. You will choose the filter by this name when you apply it to a recommendation request\.
1. For **Expression**, choose either **Build expression** or **Add expression manually** and build or insert your expression: | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/filter-real-time.md |
cda462caff82-1 | 1. For **Expression**, choose either **Build expression** or **Add expression manually** and build or insert your expression:
+ To use the expression builder, choose **Build expression **\. The expression builder provides structure, fields, and guidelines for building correctly formatted filter expressions\. For more information, see [Using the Filter Expression Builder](#using-filter-expression-builder)\.
+ To input your own expression, choose **Add expression manually** \. For information, see [Filter Expression Elements](filter-expressions.md#filter-expression-elements)\.
1. Choose **Finish**\. The filter's overview page shows the filter’s Amazon Resource Name \(ARN\), status, and full filter expression\. To delete the filter, choose **Delete**\. For information about finding and deleting filters after you have left the overview page, see [Deleting a Filter \(Console\)](#delete-filter-console)\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/personalize/latest/dg/images/filter-details-page.png)
1. In the navigation pane, choose **Campaigns**\.
1. On the **Campaigns** page, choose the target campaign\.
1. For comparison, start by getting recommendations for a user without applying a filter\. Under **Test campaign results**, enter the ID of a user that you want to get recommendations for, and choose **Get recommendations**\. A table containing the user’s top recommendations appears\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/filter-real-time.md |
cda462caff82-2 | ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/personalize/latest/dg/images/Recommendations_no-filter.PNG)
1. From the **Filter name** menu, choose the filter that you created\.
1. Using the same `User ID` as in the earlier step, choose **Get recommendations**\. The recommendations table appears\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/personalize/latest/dg/images/Recommendations_filter.png)
If the user already bought a recommended item, the filter removes it from the recommendation list\. In this example, items 2657, 2985 were replaced by the most suitable items that the user had not purchased \(items 2641 and 1573\)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/filter-real-time.md |
d05085dca416-0 | The **Expression builder** on the **Create filter** page provides structure, fields, and guidelines for building correctly formatted filter expressions\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/personalize/latest/dg/images/expression-builder-empty.png)
To build a filter expression:
+ Use the **Action**, **Property**, **Operator**, and **Value** fields to choose elements and create an expression\. For the **Value** field, separate multiple values with a comma\.
**Note**
After you choose a **Property** \(in `dataset.property` format\), the **Property** value for any succeeding rows chained by `AND` or `OR` conditions must use the same `dataset`\.
+ Use the **\+** and **X** buttons to add or delete a row from your expression\. You can't delete the first row\.
+ For new rows, use the `AND`, `IF`, or `OR` operators on the **AND** menu to create a chain of conditions\.
For `IF` conditions:
+ Each expression can contain only one `IF` item\. If you remove an IF condition, the Expression builder removes any `AND` conditions following it\.
+ You can use `IF` conditions only for the `CurrentUser`\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/filter-real-time.md |
d05085dca416-1 | + You can use `IF` conditions only for the `CurrentUser`\.
+ Choose the **Add expression** button to add an additional filter expression for more precise filtering, including filtering using Item and Interactions datasets\. The results of the first expression are passed to the added expression\.
**Note**
To create a filter that uses both Item and Interaction datasets, you *must* use multiple expressions\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/filter-real-time.md |
f815a07e4e11-0 | The following example shows how to build a filter that includes items in the `action` or `horror` genres with a `DOWNLOAD_COUNT` of more than `200`, but only if the current user's age is greater than `17`\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/personalize/latest/dg/images/create-filter-expression-builder.png) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/filter-real-time.md |
b53d2d2159d6-0 | Deleting a filter removes the filter from the list of filters for a dataset group\.
**Important**
You can't delete a filter while a batch inference job is in progress\.
**To delete a filter \(console\)**
1. Open the Amazon Personalize console at [https://console\.aws\.amazon\.com/personalize/](https://console.aws.amazon.com/personalize/) and sign into your account\.
1. From the **Dataset groups** list, choose the dataset group that contains the filter that you want to delete\.
1. In the navigation pane, choose **Filters**\.
1. From the list of filters, choose the filter that you want to delete and choose **View Details**\. The filter details page appears\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/personalize/latest/dg/images/filter-details-page.png)
1. Choose **Delete** and confirm the deletion in the confirmation dialog box\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/filter-real-time.md |
db5bdf180856-0 | For real\-time filtering, you create a filter and then specify it in a [GetRecommendations](API_RS_GetRecommendations.md), [CreateBatchInferenceJob](API_CreateBatchInferenceJob.md), or [GetPersonalizedRanking](API_RS_GetPersonalizedRanking.md) request\.
**Note**
To filter recommendations using a campaign you deployed before July 30, 2020, you must re\-deploy the campaign by using the [UpdateCampaign](API_UpdateCampaign.md) call or by creating a new campaign\.
**To filter real\-time recommendations \(AWS SDK**\)
Use the [CreateFilter](API_CreateFilter.md) operation to create a filter and specify its filtering properties\. The following example creates a filter that filters previously purchased items out of recommendation responses\. Then, it uses the filter to get filtered recommendations\.
```
import boto3
personalize = boto3.client('personalize')
personalize_runtime = boto3.client('personalize-runtime') | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/filter-real-time.md |
28adf4a4ec49-0 | response = personalize.create_filter(
name = "Filter name",
datasetGroupArn = "Dataset group ARN",
filterExpression = "EXCLUDE itemId WHERE INTERACTIONS.EVENT_TYPE in (\"Purchase\")"
)
filter_arn = response["filterArn"]
print("Filter ARN: " + filter_arn) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/filter-real-time.md |
ff5548640fa6-0 | print("Getting recommendations")
response = personalize_runtime.get_recommendations(
campaignArn = "Campaign ARN",
userId = "User ID",
filterArn = filter_arn
)
print("Recommended items")
for item in response['itemList']:
print (item['itemId'])
```
To verify that the filter is active, use the [DescribeFilter](API_DescribeFilter.md) operation before using the `GetRecommendations` operation\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/filter-real-time.md |
0e90f8c02580-0 | 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_Amazon_Personalize_Runtime.md |
0e7a5bb4176d-0 | In this exercise, you use the Amazon Personalize console to create a campaign that returns movie recommendations for a given user\.
Before you start this exercise, review the Getting Started [Getting Started Prerequisites](gs-prerequisites.md)\.
After you finish this exercise, see [Clean Up Resources](gs-cleanup.md)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/getting-started-console.md |
c40681927eb4-0 | In this procedure, you first create a dataset group\. Next, you create an Amazon Personalize *user\-item interaction* dataset in the dataset group and a schema to match your training data\. Next, you import your training data into the dataset\.
**To import training data**
1. Open the Amazon Personalize console at [https://console\.aws\.amazon\.com/personalize/](https://console.aws.amazon.com/personalize/) and sign in to your account\.
1. Choose **Create dataset group**\.
1. If this is your first time using Amazon Personalize, on the **Create dataset group** page, in **New dataset group**, choose **Get started**\.
1. In **Dataset group details**, for **Dataset group name**, specify a name for your dataset group\. Your screen should look similar to the following:
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/personalize/latest/dg/images/gs-1-dataset-group-v02.png)
1. Choose **Next**\.
1. On the **Create user\-item interaction data** page, in **Dataset details**, for **Dataset name**, specify a name for your dataset\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/getting-started-console.md |
c40681927eb4-1 | 1. In **Schema details**, for **Schema selection**, choose **Create new schema**\. A minimal Interactions schema is displayed in the **Schema definition** field\. The schema matches the headers you previously added to the `ratings.csv` file\. For more information see [Creating the Training Data](gs-prerequisites.md#gs-upload-to-bucket)\.
1. For **New schema name**, specify a name for the new schema\.
Your screen should look similar to the following:
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/personalize/latest/dg/images/gs-2-schema.png)
1. Choose **Next**\.
1. On the **Import user\-item interaction data** page, in **Dataset import job details**, for **Dataset import job name**, specify a name for your import job\.
1. For **IAM service role**, keep the default selection of **Enter a custom IAM role ARN**\.
1. For **Custom IAM role ARN**, specify the role that you created in [Creating an IAM Role for Amazon Personalize](aws-personalize-set-up-permissions.md#set-up-create-role-with-permissions)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/getting-started-console.md |
c40681927eb4-2 | 1. In the informational dialog box named **Additional S3 bucket policy required**, follow the [instructions](data-prep-upload-s3.md) to add the required Amazon S3 bucket policy\.
1. For **Data location**, specify where your movie data file is stored in Amazon Simple Storage Service \(S3\)\. Use the following syntax:
**s3://<name of your S3 bucket>/<folder path>/<CSV filename>**
Your screen should look similar to the following:
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/personalize/latest/dg/images/gs-4-job-details.png)
1. Choose **Finish**\. The data import job starts and the **Dashboard Overview** page is displayed\.
1. Initially, in **Upload datasets**, the **User\-item interaction data** status is **Create pending** \(followed by **Create in progress**\), and the **Create solutions \- Start** button is disabled\.
**Note**
The time it takes for the data to be imported depends on the size of the dataset\.
When the data import job has finished, the **User\-item interaction data** status changes to **Active** and the **Create solutions \- Start** button is enabled\. Your screen should look similar to the following: | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/getting-started-console.md |
c40681927eb4-3 | ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/personalize/latest/dg/images/gs-2-dataset-uploaded.png)
1. After the import job has finished, choose the **Create solutions \- Start** button\. The **Create solution** page is displayed\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/getting-started-console.md |
ae20f02ef3f2-0 | In this procedure, you use the dataset that you imported in the previous step to train a model\. A trained model is referred to as a *solution version*\.
**To create a solution**
1. If the **Create solution** page is not already displayed, in the navigation pane, under the dataset group that you created, choose the Solution creation **Start** button\.
1. For **Solution name**, specify a name for your solution\.
1. For **Recipe**, choose **aws\-user\-personalization**\. Leave the optional **Solution configuration** fields unchanged\.
Your screen should look similar to the following:
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/personalize/latest/dg/images/gs-create-solution.png)
1. Choose **Next** to display the **Create solution version** screen\.
Your screen should look similar to the following:
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/personalize/latest/dg/images/gs-create-solution-version-console.png)
1. There's no need to modify the **Solution config**, so choose **Finish**\. Model training starts and the **Dashboard Overview** page is displayed\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/getting-started-console.md |
ae20f02ef3f2-1 | 1. Initially, in **Create solutions**, the **Solution creation** status is **Create pending** \(followed by **Create in progress**\), the **Launch campaigns \- Start** button is disabled, and a banner is displayed on the top of the console showing the progress\.
**Note**
The time it takes to train a model depends on the size of the dataset and the chosen recipe\.
1. After training has finished, in the navigation pane choose Dashboard and choose **Create new campaign**\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/getting-started-console.md |
86243d967bd6-0 | In this procedure, you create a campaign by deploying the solution version you created in the previous step\.
**To create a campaign**
1. If the **Create new campaign** page is not already displayed, in the navigation pane, in the dataset group that you created, choose **Dashboard**, and then choose **Create new campaign**\.
1. In **Campaign details**, for **Campaign name**, specify a name for your campaign\.
1. For **Solution**, choose the solution you created in the previous step and for **Solution version ID** keep the default\.
1. For **Minimum provisioned transactions per second**, keep the default of `1`\.
Your screen should look similar to the following:
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/personalize/latest/dg/images/getting-started-create-new-campaign.png)
1. Choose **Create campaign**\. Campaign creation starts and the **Campaign** page appears with the **Campaign inference** section displayed\.
Your screen should look similar to the following:
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/personalize/latest/dg/images/gs-6-campaign-inference-in-progress.png)
**Note**
Creating a campaign takes time\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/getting-started-console.md |
86243d967bd6-1 | **Note**
Creating a campaign takes time\.
After the campaign is created, the page is updated to show the **Test campaign results** section\. Your screen should look similar to the following:
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/personalize/latest/dg/images/gs-campaign-test-before-results.png) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/getting-started-console.md |
69cf49d5caa4-0 | In this procedure, use the campaign that you created in the previous step to get recommendations\.
**To get recommendations**
1. In **Test campaign results**, for **User ID**, specify a value from the *ratings* dataset, for example, **83**\. For **Filter name** keep the default selection of *None*\.
1. Choose **Get recommendations**\. The **Recommended item ID** list displays the recommended item IDs\.
Your screen should look similar to the following:
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/personalize/latest/dg/images/gs-test-campaign-with-results.png) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/getting-started-console.md |
9230f0979288-0 | This section provides information about monitoring and logging Amazon Personalize with Amazon CloudWatch and AWS CloudTrail\.
**Topics**
+ [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) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/logging-monitoring.md |
60493a7abc13-0 | Provides information about a recipe\. Each recipe provides an algorithm that Amazon Personalize uses in model training when you use the [CreateSolution](API_CreateSolution.md) operation\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_Recipe.md |
ee758e59341e-0 | **algorithmArn** <a name="personalize-Type-Recipe-algorithmArn"></a>
The Amazon Resource Name \(ARN\) of the algorithm that Amazon Personalize uses to train the model\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
**creationDateTime** <a name="personalize-Type-Recipe-creationDateTime"></a>
The date and time \(in Unix format\) that the recipe was created\.
Type: Timestamp
Required: No
**description** <a name="personalize-Type-Recipe-description"></a>
The description of the recipe\.
Type: String
Required: No
**featureTransformationArn** <a name="personalize-Type-Recipe-featureTransformationArn"></a>
The ARN of the FeatureTransformation object\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
**lastUpdatedDateTime** <a name="personalize-Type-Recipe-lastUpdatedDateTime"></a> | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_Recipe.md |
ee758e59341e-1 | **lastUpdatedDateTime** <a name="personalize-Type-Recipe-lastUpdatedDateTime"></a>
The date and time \(in Unix format\) that the recipe was last updated\.
Type: Timestamp
Required: No
**name** <a name="personalize-Type-Recipe-name"></a>
The name of the recipe\.
Type: String
Length Constraints: Minimum length of 1\. Maximum length of 63\.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
**recipeArn** <a name="personalize-Type-Recipe-recipeArn"></a>
The Amazon Resource Name \(ARN\) of the recipe\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
**recipeType** <a name="personalize-Type-Recipe-recipeType"></a>
One of the following values:
+ PERSONALIZED\_RANKING
+ RELATED\_ITEMS
+ USER\_PERSONALIZATION
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_Recipe.md |
ee758e59341e-2 | + USER\_PERSONALIZATION
Type: String
Length Constraints: Maximum length of 256\.
Required: No
**status** <a name="personalize-Type-Recipe-status"></a>
The status of the recipe\.
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_Recipe.md |
d11c0ebcf59a-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/Recipe)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/Recipe)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/Recipe)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/Recipe) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_Recipe.md |
5aa514fb7d36-0 | This section contains information about the Amazon CloudWatch metrics available for Amazon Personalize\. You can also see an aggregate view of Amazon Personalize metrics from the Amazon Personalize console\. For more information, see [Monitoring Amazon Personalize](personalize-monitoring.md)\.
The following table lists the Amazon Personalize metrics\. All metrics support these statistics: `Average, Minimum, Maximum, Sum`\.
| Metric | Description |
| --- | --- |
| DatasetImportJobRequests | The number of successful [CreateDatasetImportJob](API_CreateDatasetImportJob.md) API calls\. Dimensions: `DatasetGroupArn, DatasetArn, DatasetImportJobArn` |
| DatasetImportJobError | The number of `CreateDatasetImportJob` API calls that resulted in an error\. Dimensions: `DatasetGroupArn, DatasetArn, DatasetImportJobArn` |
| DatasetImportJobExecutionTime | The time between the `CreateDatasetImportJob` API call and the completion \(or failure\) of the operation\. Dimensions: `DatasetGroupArn, DatasetArn, DatasetImportJobArn` Unit: Seconds |
| DatasetSize | The size of data imported by the dataset import job\. Dimensions: `DatasetGroupArn, DatasetArn, DatasetImportJobArn` Unit: Bytes | | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/cloudwatch-metrics.md |
5aa514fb7d36-1 | | SolutionTrainingJobRequests | The number of successful [CreateSolutionVersion](API_CreateSolutionVersion.md) API calls\. Dimensions: `SolutionArn, SolutionVersionArn` |
| SolutionTrainingJobError | The number of `CreateSolutionVersion` API calls that resulted in an error\. Dimensions: `SolutionArn, SolutionVersionArn` |
| SolutionTrainingJobExecutionTime | The time between the `CreateSolutionVersion` API call and the completion \(or failure\) of the operation\. Dimensions: `SolutionArn, SolutionVersionArn` Unit: Seconds |
| GetPersonalizedRankingRequests | The number of successful [GetPersonalizedRanking](API_RS_GetPersonalizedRanking.md) API calls\. Dimension: `CampaignArn` |
| GetPersonalizedRanking4xxErrors | The number of `GetPersonalizedRanking` API calls that returned a 4xx HTTP response code\. Dimension: `CampaignArn` |
| GetPersonalizedRanking5xxErrors | The number of `GetPersonalizedRanking` API calls that returned a 5xx HTTP response code\. Dimension: `CampaignArn` |
| GetPersonalizedRankingLatency | The time between receiving the `GetPersonalizedRanking` API call and the sending of recommendations \(excludes 4xx and 5xx errors\)\. Dimension: `CampaignArn` Unit: Milliseconds | | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/cloudwatch-metrics.md |
5aa514fb7d36-2 | | GetRecommendationsRequests | The number of successful [GetRecommendations](API_RS_GetRecommendations.md) API calls\. Dimension: `CampaignArn` |
| GetRecommendations4xxErrors | The number of `GetRecommendations` API calls that returned a 4xx HTTP response code\. Dimension: `CampaignArn` |
| GetRecommendations5xxErrors | The number of `GetRecommendations` API calls that returned a 5xx HTTP response code\. Dimension: CampaignArn |
| GetRecommendationsLatency | The time between receiving the `GetRecommendations` API call and the sending of recommendations \(excludes 4xx and 5xx errors\)\. Dimension: `CampaignArn` Unit: Milliseconds |
| PutEventsRequests | The number of successful [PutEvents](API_UBS_PutEvents.md) API calls\. Dimension:` EventTrackerArn` |
| PutEvents4xxErrors | The number of `PutEvents` API calls that returned a 4xx HTTP response code\. Dimension: `EventTrackerArn` |
| PutEvents5xxErrors | The number of `PutEvents` API calls that returned a 5xx HTTP response code\. Dimension: `EventTrackerArn` |
| PutEventsLatency | The time taken for the completion of the `PutEvents` API call \(excludes 4xx and 5xx errors\)\. Dimension: `EventTrackerArn` Unit: Milliseconds | | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/cloudwatch-metrics.md |
da9baca19272-0 | Provides feature transformation information\. Feature transformation is the process of modifying raw input data into a form more suitable for model training\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_FeatureTransformation.md |
ff5e9f50442f-0 | **creationDateTime** <a name="personalize-Type-FeatureTransformation-creationDateTime"></a>
The creation date and time \(in Unix time\) of the feature transformation\.
Type: Timestamp
Required: No
**defaultParameters** <a name="personalize-Type-FeatureTransformation-defaultParameters"></a>
Provides the default parameters for feature transformation\.
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
**featureTransformationArn** <a name="personalize-Type-FeatureTransformation-featureTransformationArn"></a>
The Amazon Resource Name \(ARN\) of the FeatureTransformation object\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
**lastUpdatedDateTime** <a name="personalize-Type-FeatureTransformation-lastUpdatedDateTime"></a>
The last update date and time \(in Unix time\) of the feature transformation\.
Type: Timestamp
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_FeatureTransformation.md |
ff5e9f50442f-1 | The last update date and time \(in Unix time\) of the feature transformation\.
Type: Timestamp
Required: No
**name** <a name="personalize-Type-FeatureTransformation-name"></a>
The name of the feature transformation\.
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-FeatureTransformation-status"></a>
The status of the feature transformation\.
A feature transformation 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_FeatureTransformation.md |
5da9137e8e23-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/FeatureTransformation)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/FeatureTransformation)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/FeatureTransformation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/FeatureTransformation) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_FeatureTransformation.md |
d4a7a6a5686b-0 | Before you use IAM to manage access to Amazon Personalize, you should understand what IAM features are available to use with Amazon Personalize\. To get a high\-level view of how Amazon Personalize and other AWS services work with IAM, see [AWS Services That Work with IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html) in the *IAM User Guide*\.
**Topics**
+ [Amazon Personalize Identity\-Based Policies](#security_iam_service-with-iam-id-based-policies)
+ [Amazon Personalize Resource\-Based Policies](#security_iam_service-with-iam-resource-based-policies)
+ [Authorization Based on Amazon Personalize Tags](#security_iam_service-with-iam-tags)
+ [Amazon Personalize IAM Roles](#security_iam_service-with-iam-roles) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security_iam_service-with-iam.md |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.