id
stringlengths 14
16
| text
stringlengths 1
2.43k
| source
stringlengths 99
229
|
|---|---|---|
2050382e6afc-0 | ```
{
"eventTrackerArn": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeEventTracker.md |
f1d616e04e38-0 | The request accepts the following data in JSON format\.
** [eventTrackerArn](#API_DescribeEventTracker_RequestSyntax) ** <a name="personalize-DescribeEventTracker-request-eventTrackerArn"></a>
The Amazon Resource Name \(ARN\) of the event tracker 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_DescribeEventTracker.md |
9b35dca9d361-0 | ```
{
"eventTracker": {
"accountId": "string",
"creationDateTime": number,
"datasetGroupArn": "string",
"eventTrackerArn": "string",
"lastUpdatedDateTime": number,
"name": "string",
"status": "string",
"trackingId": "string"
}
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeEventTracker.md |
ee74803e935a-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\.
** [eventTracker](#API_DescribeEventTracker_ResponseSyntax) ** <a name="personalize-DescribeEventTracker-response-eventTracker"></a>
An object that describes the event tracker\.
Type: [EventTracker](API_EventTracker.md) object | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeEventTracker.md |
de55aafe4b5c-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_DescribeEventTracker.md |
9f407b206c26-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/DescribeEventTracker)
+ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/personalize-2018-05-22/DescribeEventTracker)
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeEventTracker)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/DescribeEventTracker)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/DescribeEventTracker)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/personalize-2018-05-22/DescribeEventTracker) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeEventTracker.md |
9f407b206c26-1 | + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeEventTracker)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeEventTracker)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeEventTracker) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeEventTracker.md |
766834e74c07-0 | Creates a job that imports training data from your data source \(an Amazon S3 bucket\) to an Amazon Personalize dataset\. To allow Amazon Personalize to import the training data, you must specify an AWS Identity and Access Management \(IAM\) role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it in an internal AWS system\.
**Important**
The dataset import job replaces any previous data in the dataset\.
**Status**
A dataset import job can be in one of the following states:
+ CREATE PENDING > CREATE IN\_PROGRESS > ACTIVE \-or\- CREATE FAILED
To get the status of the import job, call [DescribeDatasetImportJob](API_DescribeDatasetImportJob.md), providing the Amazon Resource Name \(ARN\) of the dataset import job\. The dataset import is complete when the status shows as ACTIVE\. If the status shows as CREATE FAILED, the response includes a `failureReason` key, which describes why the job failed\.
**Note**
Importing takes time\. You must wait until the status shows as ACTIVE before training a model using the dataset\.
**Related APIs**
+ [ListDatasetImportJobs](API_ListDatasetImportJobs.md)
+ [DescribeDatasetImportJob](API_DescribeDatasetImportJob.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CreateDatasetImportJob.md |
04117a7ec3e9-0 | ```
{
"datasetArn": "string",
"dataSource": {
"dataLocation": "string"
},
"jobName": "string",
"roleArn": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CreateDatasetImportJob.md |
721bc092f8fa-0 | The request accepts the following data in JSON format\.
** [datasetArn](#API_CreateDatasetImportJob_RequestSyntax) ** <a name="personalize-CreateDatasetImportJob-request-datasetArn"></a>
The ARN of the dataset that receives the imported data\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
** [dataSource](#API_CreateDatasetImportJob_RequestSyntax) ** <a name="personalize-CreateDatasetImportJob-request-dataSource"></a>
The Amazon S3 bucket that contains the training data to import\.
Type: [DataSource](API_DataSource.md) object
Required: Yes
** [jobName](#API_CreateDatasetImportJob_RequestSyntax) ** <a name="personalize-CreateDatasetImportJob-request-jobName"></a>
The name for the dataset import job\.
Type: String
Length Constraints: Minimum length of 1\. Maximum length of 63\.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: Yes | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CreateDatasetImportJob.md |
721bc092f8fa-1 | Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: Yes
** [roleArn](#API_CreateDatasetImportJob_RequestSyntax) ** <a name="personalize-CreateDatasetImportJob-request-roleArn"></a>
The ARN of the IAM role that has permissions to read from the Amazon S3 data source\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`
Required: Yes | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CreateDatasetImportJob.md |
369fff7784d9-0 | ```
{
"datasetImportJobArn": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CreateDatasetImportJob.md |
40b1b57665e8-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\.
** [datasetImportJobArn](#API_CreateDatasetImportJob_ResponseSyntax) ** <a name="personalize-CreateDatasetImportJob-response-datasetImportJobArn"></a>
The ARN of the dataset import job\.
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_CreateDatasetImportJob.md |
f5bd82e0a1e1-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_CreateDatasetImportJob.md |
b89f66e20f61-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/CreateDatasetImportJob)
+ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/personalize-2018-05-22/CreateDatasetImportJob)
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CreateDatasetImportJob)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/CreateDatasetImportJob)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/CreateDatasetImportJob)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/personalize-2018-05-22/CreateDatasetImportJob) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CreateDatasetImportJob.md |
b89f66e20f61-1 | + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/CreateDatasetImportJob)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/CreateDatasetImportJob)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CreateDatasetImportJob) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CreateDatasetImportJob.md |
710553ebfb91-0 | By default, IAM users and roles don't have permission to create or modify Amazon Personalize resources\. They also can't perform tasks using the AWS Management Console, AWS CLI, or AWS API\. An IAM administrator must create IAM policies that grant users and roles permission to perform specific API operations on the specified resources they need\. The administrator must then attach those policies to the IAM users or groups that require those permissions\.
To learn how to create an IAM identity\-based policy using these example JSON policy documents, see [Creating Policies on the JSON Tab](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_create.html#access_policies_create-json-editor) in the *IAM User Guide*\.
**Topics**
+ [Policy Best Practices](#security_iam_service-with-iam-policy-best-practices)
+ [AWS Managed Policies](#using-managed-policies)
+ [Using the Amazon Personalize Console](#security_iam_id-based-policy-examples-console)
+ [Allow Users to View Their Own Permissions](#security_iam_id-based-policy-examples-view-own-permissions)
+ [Allowing Full Access to Amazon Personalize Resources](#security_iam_id-based-policy-examples-full-access)
+ [Allowing Read\-Only Access to Amazon Personalize Resources](#security_iam_id-based-policy-examples-read-only) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security_iam_id-based-policy-examples.md |
27bf1ad97348-0 | Identity\-based policies are very powerful\. They determine whether someone can create, access, or delete Amazon Personalize resources in your account\. These actions can incur costs for your AWS account\. When you create or edit identity\-based policies, follow these guidelines and recommendations:
+ **Get Started Using AWS Managed Policies** – To start using Amazon Personalize quickly, use AWS managed policies to give your employees the permissions they need\. These policies are already available in your account and are maintained and updated by AWS\. For more information, see [Get Started Using Permissions With AWS Managed Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#bp-use-aws-defined-policies) in the *IAM User Guide*\.
+ **Grant Least Privilege** – When you create custom policies, grant only the permissions required to perform a task\. Start with a minimum set of permissions and grant additional permissions as necessary\. Doing so is more secure than starting with permissions that are too lenient and then trying to tighten them later\. For more information, see [Grant Least Privilege](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege) in the *IAM User Guide*\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security_iam_id-based-policy-examples.md |
27bf1ad97348-1 | + **Enable MFA for Sensitive Operations** – For extra security, require IAM users to use multi\-factor authentication \(MFA\) to access sensitive resources or API operations\. For more information, see [Using Multi\-Factor Authentication \(MFA\) in AWS](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa.html) in the *IAM User Guide*\.
+ **Use Policy Conditions for Extra Security** – To the extent that it's practical, define the conditions under which your identity\-based policies allow access to a resource\. For example, you can write conditions to specify a range of allowable IP addresses that a request must come from\. You can also write conditions to allow requests only within a specified date or time range, or to require the use of SSL or MFA\. For more information, see [IAM JSON Policy Elements: Condition](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition.html) in the *IAM User Guide*\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security_iam_id-based-policy-examples.md |
542758e069f6-0 | AWS managed polices are policies that are created and managed by AWS\. The following are examples of AWS managed policies you can attach to your IAM user or group to grant permissions for Amazon Personalize\.
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*\.
**AmazonPersonalizeFullAccess Policy**
Instead of creating a new policy, you can attach the AWS managed `AmazonPersonalizeFullAccess` policy to your IAM users and roles\. However, `AmazonPersonalizeFullAccess` provides more permissions than are necessary to use Amazon Personalize\.
Instead of using the `AmazonPersonalizeFullAccess` policy, we recommend creating a new IAM policy that only grants the necessary permissions \(see [Creating a New IAM Policy](aws-personalize-set-up-permissions.md#set-up-required-permissions)\)\.
The `AmazonPersonalizeFullAccess` policy allows IAM users to perform the following actions:
+ Access all Amazon Personalize resources
+ Publish and list metrics on Amazon CloudWatch | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security_iam_id-based-policy-examples.md |
542758e069f6-1 | + Access all Amazon Personalize resources
+ Publish and list metrics on Amazon CloudWatch
+ List, read, write, and delete all objects in an Amazon S3 bucket that contains `Personalize` or `personalize` in the bucket name
+ Pass a role to Amazon Personalize
**CloudWatchFullAccess**
To give users permission to monitor Amazon Personalize with CloudWatch, attach the `CloudWatchFullAccess` policy to your Amazon Personalize IAM users or groups\. For more information, see [Monitoring Amazon Personalize](personalize-monitoring.md)\.
The `CloudWatchFullAccess` policy is optional and allows IAM users to perform the following actions:
+ Publish and list Amazon Personalize metrics in CloudWatch
+ View metrics and metric statistics\.
+ Set metric based alarms\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security_iam_id-based-policy-examples.md |
02140e203852-0 | To access the Amazon Personalize console, you must have a minimum set of permissions\. These permissions must allow you to list and view details about the Amazon Personalize resources in your AWS account\. If you create an identity\-based policy that is more restrictive than the minimum required permissions, the console won't function as intended for entities \(IAM users or roles\) with that policy\.
To ensure that those entities can still use the Amazon Personalize console, also attach the following AWS managed policy to the entities\. For more information, see [Adding Permissions to a User](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_change-permissions.html#users_change_permissions-add-console) in the *IAM User Guide*\.
```
AWSPersonalizeConsoleAccess
```
You don't need to allow minimum console permissions for users that are making calls only to the AWS CLI or the AWS API\. Instead, allow access to only the actions that match the API operation that you're trying to perform\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security_iam_id-based-policy-examples.md |
47c0cc28e880-0 | This example shows how you might create a policy that allows IAM users to view the inline and managed policies that are attached to their user identity\. This policy includes permissions to complete this action on the console or programmatically using the AWS CLI or AWS API\.
```
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "ViewOwnUserInfo",
"Effect": "Allow",
"Action": [
"iam:GetUserPolicy",
"iam:ListGroupsForUser",
"iam:ListAttachedUserPolicies",
"iam:ListUserPolicies",
"iam:GetUser"
],
"Resource": ["arn:aws:iam::*:user/${aws:username}"]
},
{
"Sid": "NavigateInConsole",
"Effect": "Allow",
"Action": [
"iam:GetGroupPolicy",
"iam:GetPolicyVersion",
"iam:GetPolicy",
"iam:ListAttachedGroupPolicies",
"iam:ListGroupPolicies",
"iam:ListPolicyVersions", | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security_iam_id-based-policy-examples.md |
47c0cc28e880-1 | "iam:ListGroupPolicies",
"iam:ListPolicyVersions",
"iam:ListPolicies",
"iam:ListUsers"
],
"Resource": "*"
}
]
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security_iam_id-based-policy-examples.md |
abd28c12ca71-0 | The following example gives an IAM user in your AWS account full access to all Amazon Personalize resources and actions\.
```
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"personalize:*"
],
"Resource": "*"
}
]
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security_iam_id-based-policy-examples.md |
75e3b109d52a-0 | In this example, you grant an IAM user in your AWS account read\-only access to your Amazon Personalize resources, including Amazon Personalize datasets, dataset groups, solutions, and campaigns\.
```
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"personalize:DescribeAlgorithm",
"personalize:DescribeBatchInferenceJob",
"personalize:DescribeCampaign",
"personalize:DescribeDataset",
"personalize:DescribeDatasetGroup",
"personalize:DescribeDatasetImportJob",
"personalize:DescribeDatasetImportJobRun",
"personalize:DescribeEventTracker",
"personalize:DescribeFeatureExportJob",
"personalize:DescribeFeatureTransformation",
"personalize:DescribeRecipe",
"personalize:DescribeSchema",
"personalize:DescribeSolution",
"personalize:DescribeSolutionVersion",
"personalize:GetSolutionMetrics",
"personalize:ListBatchInferenceJobs",
"personalize:ListCampaigns",
"personalize:ListDatasetGroups", | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security_iam_id-based-policy-examples.md |
75e3b109d52a-1 | "personalize:ListCampaigns",
"personalize:ListDatasetGroups",
"personalize:ListDatasetImportJobs",
"personalize:ListDatasets",
"personalize:ListEventTrackers",
"personalize:ListRecipes",
"personalize:ListSchemas",
"personalize:ListSolutions",
"personalize:ListSolutionVersions"
],
"Resource": "*"
}
]
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security_iam_id-based-policy-examples.md |
1a775186fb5f-0 | Returns a list of available recipes\. The response provides the properties for each recipe, including the recipe's Amazon Resource Name \(ARN\)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListRecipes.md |
dfe3dd3b4f4d-0 | ```
{
"maxResults": number,
"nextToken": "string",
"recipeProvider": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListRecipes.md |
4dff0d5e867f-0 | The request accepts the following data in JSON format\.
** [maxResults](#API_ListRecipes_RequestSyntax) ** <a name="personalize-ListRecipes-request-maxResults"></a>
The maximum number of recipes to return\.
Type: Integer
Valid Range: Minimum value of 1\. Maximum value of 100\.
Required: No
** [nextToken](#API_ListRecipes_RequestSyntax) ** <a name="personalize-ListRecipes-request-nextToken"></a>
A token returned from the previous call to `ListRecipes` for getting the next set of recipes \(if they exist\)\.
Type: String
Length Constraints: Maximum length of 1300\.
Required: No
** [recipeProvider](#API_ListRecipes_RequestSyntax) ** <a name="personalize-ListRecipes-request-recipeProvider"></a>
The default is `SERVICE`\.
Type: String
Valid Values:` SERVICE`
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListRecipes.md |
a357c844fc46-0 | ```
{
"nextToken": "string",
"recipes": [
{
"creationDateTime": number,
"lastUpdatedDateTime": number,
"name": "string",
"recipeArn": "string",
"status": "string"
}
]
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListRecipes.md |
bc43bef8f894-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\.
** [nextToken](#API_ListRecipes_ResponseSyntax) ** <a name="personalize-ListRecipes-response-nextToken"></a>
A token for getting the next set of recipes\.
Type: String
Length Constraints: Maximum length of 1300\.
** [recipes](#API_ListRecipes_ResponseSyntax) ** <a name="personalize-ListRecipes-response-recipes"></a>
The list of available recipes\.
Type: Array of [RecipeSummary](API_RecipeSummary.md) objects
Array Members: Maximum number of 100 items\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListRecipes.md |
cd5b1bb3ad5f-0 | **InvalidNextTokenException**
The token is not valid\.
HTTP Status Code: 400 | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListRecipes.md |
ce7dac6f1813-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/ListRecipes)
+ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/personalize-2018-05-22/ListRecipes)
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListRecipes)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/ListRecipes)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/ListRecipes)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/personalize-2018-05-22/ListRecipes)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListRecipes) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListRecipes.md |
ce7dac6f1813-1 | + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListRecipes)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListRecipes) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListRecipes.md |
4cd4820a2fd9-0 | This section provides documentation for the Amazon Personalize API operations\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_Reference.md |
08d2bb35544b-0 | The Personalized\-Ranking recipe generates personalized rankings\. A *personalized ranking* is a list of recommended items that are re\-ranked for a specific user\. This recipe has the following properties:
+ **Name** – `aws-personalized-ranking`
+ **Recipe Amazon Resource Name \(ARN\)** – `arn:aws:personalize:::recipe/aws-personalized-ranking`
+ **Algorithm ARN** – `arn:aws:personalize:::algorithm/aws-personalized-ranking`
+ **Feature transformation ARN** – `arn:aws:personalize:::feature-transformation/JSON-percentile-filtering`
+ **Recipe type** – `PERSONALIZED_RANKING` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/native-recipe-search.md |
49375e7bfec9-0 | The following table describes the hyperparameters for the Personalize\-Ranking 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-search.md |
49375e7bfec9-1 | | 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: 149 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-search.md |
49375e7bfec9-2 | | 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-search.md |
49375e7bfec9-3 | | 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-search.md |
4d30c870070b-0 | For a sample Jupyter notebook that shows how to use the Personalized\-Ranking recipe, see [Personalize Ranking Example](https://github.com/aws-samples/amazon-personalize-samples/blob/master/next_steps/core_use_cases/personalized_ranking/personalize_ranking_example.ipynb)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/native-recipe-search.md |
3bcc493064b7-0 | Returns the list of schemas associated with the account\. The response provides the properties for each schema, including the Amazon Resource Name \(ARN\)\. For more information on schemas, see [CreateSchema](API_CreateSchema.md)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListSchemas.md |
26bc93e2e0f4-0 | ```
{
"maxResults": number,
"nextToken": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListSchemas.md |
5f25390ad115-0 | The request accepts the following data in JSON format\.
** [maxResults](#API_ListSchemas_RequestSyntax) ** <a name="personalize-ListSchemas-request-maxResults"></a>
The maximum number of schemas to return\.
Type: Integer
Valid Range: Minimum value of 1\. Maximum value of 100\.
Required: No
** [nextToken](#API_ListSchemas_RequestSyntax) ** <a name="personalize-ListSchemas-request-nextToken"></a>
A token returned from the previous call to `ListSchemas` for getting the next set of schemas \(if they exist\)\.
Type: String
Length Constraints: Maximum length of 1300\.
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListSchemas.md |
75dac7394624-0 | ```
{
"nextToken": "string",
"schemas": [
{
"creationDateTime": number,
"lastUpdatedDateTime": number,
"name": "string",
"schemaArn": "string"
}
]
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListSchemas.md |
25eb8c566f51-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\.
** [nextToken](#API_ListSchemas_ResponseSyntax) ** <a name="personalize-ListSchemas-response-nextToken"></a>
A token used to get the next set of schemas \(if they exist\)\.
Type: String
Length Constraints: Maximum length of 1300\.
** [schemas](#API_ListSchemas_ResponseSyntax) ** <a name="personalize-ListSchemas-response-schemas"></a>
A list of schemas\.
Type: Array of [DatasetSchemaSummary](API_DatasetSchemaSummary.md) objects
Array Members: Maximum number of 100 items\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListSchemas.md |
fb0a85c177e4-0 | **InvalidNextTokenException**
The token is not valid\.
HTTP Status Code: 400 | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListSchemas.md |
d8b6d0033484-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/ListSchemas)
+ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/personalize-2018-05-22/ListSchemas)
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListSchemas)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/ListSchemas)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/ListSchemas)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/personalize-2018-05-22/ListSchemas)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListSchemas) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListSchemas.md |
d8b6d0033484-1 | + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListSchemas)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListSchemas) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListSchemas.md |
5b96e6eebc23-0 | A campaign is used to make recommendations for your users\. You create a campaign by deploying a solution version\. For an example using the AWS CLI, see [Step 3: Create a Campaign \(Deploy the Solution\)](getting-started-cli.md#gs-create-campaign)\.
To create a campaign with the SDK, call the [CreateCampaign](API_CreateCampaign.md) API and pass the following:
+ A name for the campaign\.
+ The Amazon Resource Name \(ARN\) of the solution version to deploy\.
+ The minimum provisioned transactions per second \(`minProvisionedTPS`\) that Amazon Personalize will support\. For more information on `minProvisionedTPS`, see the `CreateCampaign` API\.
**Create a campaign using the AWS Python SDK**
1. Create a solution version to deploy\. For more information, see [Creating a Solution](training-deploying-solutions.md)\.
1. Use the following code to create a campaign for a solution version trained using the User\-Personalization recipe with the optional default `explorationWeight` and `explorationItemAgeCutOff` for `itemExplorationConfig`\. For more information, see [User\-Personalization](native-recipe-new-item-USER_PERSONALIZATION.md)
```
import boto3
personalize = boto3.client('personalize')
create_campaign_response = personalize.create_campaign(
name = 'campaign name', | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/campaigns.md |
5b96e6eebc23-1 | create_campaign_response = personalize.create_campaign(
name = 'campaign name',
solutionVersionArn = 'solution version arn',
minProvisionedTPS = 1,
campaignConfig = {"itemExplorationConfig": {"explorationWeight": "0.3", "explorationItemAgeCutOff": "30"}}
)
arn = response['campaignArn']
description = personalize.describe_campaign(campaignArn = arn)['campaign']
print('Name: ' + description['name'])
print('ARN: ' + description['campaignArn'])
print('Status: ' + description['status'])
```
The campaign isn't ready for use until its status is active\. To get the current status, call [DescribeCampaign](API_DescribeCampaign.md) and check that the `status` field is `ACTIVE`\.
Amazon Personalize provides operations for managing campaigns such as [ListCampaigns](API_ListCampaigns.md) to list the campaigns you have created\. You can delete a campaign by calling [DeleteCampaign](API_DeleteCampaign.md)\. If you delete a campaign, the solution versions that are part of the campaign are not deleted\.
After you have created your campaign, use it to make recommendations\. For more information, see [Getting Recommendations](getting-recommendations.md)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/campaigns.md |
b0c12ff89d52-0 | Provides a summary of the properties of a solution version\. For a complete listing, call the [DescribeSolutionVersion](API_DescribeSolutionVersion.md) API\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_SolutionVersionSummary.md |
61be0c61e880-0 | **creationDateTime** <a name="personalize-Type-SolutionVersionSummary-creationDateTime"></a>
The date and time \(in Unix time\) that this version of a solution was created\.
Type: Timestamp
Required: No
**failureReason** <a name="personalize-Type-SolutionVersionSummary-failureReason"></a>
If a solution version fails, the reason behind the failure\.
Type: String
Required: No
**lastUpdatedDateTime** <a name="personalize-Type-SolutionVersionSummary-lastUpdatedDateTime"></a>
The date and time \(in Unix time\) that the solution version was last updated\.
Type: Timestamp
Required: No
**solutionVersionArn** <a name="personalize-Type-SolutionVersionSummary-solutionVersionArn"></a>
The Amazon Resource Name \(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-SolutionVersionSummary-status"></a>
The status of the solution version\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_SolutionVersionSummary.md |
61be0c61e880-1 | The status of the solution version\.
A solution version 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_SolutionVersionSummary.md |
975f70ebea28-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/SolutionVersionSummary)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/SolutionVersionSummary)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/SolutionVersionSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/SolutionVersionSummary) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_SolutionVersionSummary.md |
ab88e4da9461-0 | Lists all filters that belong to a given dataset group\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListFilters.md |
1caacee355d1-0 | ```
{
"datasetGroupArn": "string",
"maxResults": number,
"nextToken": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListFilters.md |
940209d3151b-0 | The request accepts the following data in JSON format\.
** [datasetGroupArn](#API_ListFilters_RequestSyntax) ** <a name="personalize-ListFilters-request-datasetGroupArn"></a>
The ARN of the dataset group that contains the filters\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** [maxResults](#API_ListFilters_RequestSyntax) ** <a name="personalize-ListFilters-request-maxResults"></a>
The maximum number of filters to return\.
Type: Integer
Valid Range: Minimum value of 1\. Maximum value of 100\.
Required: No
** [nextToken](#API_ListFilters_RequestSyntax) ** <a name="personalize-ListFilters-request-nextToken"></a>
A token returned from the previous call to `ListFilters` for getting the next set of filters \(if they exist\)\.
Type: String
Length Constraints: Maximum length of 1300\.
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListFilters.md |
1a957d516c0e-0 | ```
{
"Filters": [
{
"creationDateTime": number,
"datasetGroupArn": "string",
"failureReason": "string",
"filterArn": "string",
"lastUpdatedDateTime": number,
"name": "string",
"status": "string"
}
],
"nextToken": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListFilters.md |
9cd565eaedec-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\.
** [Filters](#API_ListFilters_ResponseSyntax) ** <a name="personalize-ListFilters-response-Filters"></a>
A list of returned filters\.
Type: Array of [FilterSummary](API_FilterSummary.md) objects
Array Members: Maximum number of 100 items\.
** [nextToken](#API_ListFilters_ResponseSyntax) ** <a name="personalize-ListFilters-response-nextToken"></a>
A token for getting the next set of filters \(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_ListFilters.md |
de2e6f20ff58-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_ListFilters.md |
dc37a695b7da-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/ListFilters)
+ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/personalize-2018-05-22/ListFilters)
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListFilters)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/ListFilters)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/ListFilters)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/personalize-2018-05-22/ListFilters)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListFilters) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListFilters.md |
dc37a695b7da-1 | + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListFilters)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListFilters) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListFilters.md |
4dbba00ef153-0 | Provides a summary of the properties of a campaign update\. For a complete listing, call the [DescribeCampaign](API_DescribeCampaign.md) API\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CampaignUpdateSummary.md |
37a372e7dc48-0 | **campaignConfig** <a name="personalize-Type-CampaignUpdateSummary-campaignConfig"></a>
The configuration details of a campaign\.
Type: [CampaignConfig](API_CampaignConfig.md) object
Required: No
**creationDateTime** <a name="personalize-Type-CampaignUpdateSummary-creationDateTime"></a>
The date and time \(in Unix time\) that the campaign update was created\.
Type: Timestamp
Required: No
**failureReason** <a name="personalize-Type-CampaignUpdateSummary-failureReason"></a>
If a campaign update fails, the reason behind the failure\.
Type: String
Required: No
**lastUpdatedDateTime** <a name="personalize-Type-CampaignUpdateSummary-lastUpdatedDateTime"></a>
The date and time \(in Unix time\) that the campaign update was last updated\.
Type: Timestamp
Required: No
**minProvisionedTPS** <a name="personalize-Type-CampaignUpdateSummary-minProvisionedTPS"></a>
Specifies the requested minimum provisioned transactions \(recommendations\) per second that Amazon Personalize will support\.
Type: Integer
Valid Range: Minimum value of 1\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CampaignUpdateSummary.md |
37a372e7dc48-1 | Type: Integer
Valid Range: Minimum value of 1\.
Required: No
**solutionVersionArn** <a name="personalize-Type-CampaignUpdateSummary-solutionVersionArn"></a>
The Amazon Resource Name \(ARN\) of the deployed solution version\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
**status** <a name="personalize-Type-CampaignUpdateSummary-status"></a>
The status of the campaign update\.
A campaign update can be in one of the following states:
+ CREATE PENDING > CREATE IN\_PROGRESS > ACTIVE \-or\- CREATE FAILED
+ DELETE PENDING > DELETE IN\_PROGRESS
Type: String
Length Constraints: Maximum length of 256\.
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CampaignUpdateSummary.md |
23261a1cff98-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/CampaignUpdateSummary)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/CampaignUpdateSummary)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/CampaignUpdateSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CampaignUpdateSummary) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CampaignUpdateSummary.md |
4d96c7c56378-0 | To avoid incurring unnecessary charges, delete the resources you created after you're done with the getting started exercise\. To delete the resources, use either the Amazon Personalize console or the `Delete` APIs from the SDKs or the AWS Command Line Interface \(AWS CLI\)\. For example, use the [DeleteCampaign](API_DeleteCampaign.md) API to delete a campaign\.
You can't delete a resource whose status is CREATE PENDING or IN PROGRESS\. The resource status must be ACTIVE or CREATE FAILED\. Check the status using the `Describe` APIs, for example, [DescribeCampaign](API_DescribeCampaign.md)\.
Some resources must be deleted before others, as shown in the following table\. This process can take some time\.
To delete the training data you uploaded, `ratings.csv`, see [How Do I Delete Objects from an S3 Bucket?](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/delete-objects.html)\.
| Resource to be Deleted | Delete This First | Notes |
| --- | --- | --- |
| [Campaign](API_Campaign.md) | | |
| [DatasetImportJob](API_DatasetImportJob.md) | | Can not be deleted\. |
| [EventTracker](API_EventTracker.md) | | The event\-interactions dataset that is associated with the event tracker is not deleted and continues to be used by the solution version\. | | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/gs-cleanup.md |
4d96c7c56378-1 | | [Dataset](API_Dataset.md) | | No associated `DatasetImportJob` can have a status of CREATE PENDING or IN PROGRESS\. No associated `SolutionVersion` can have a status of CREATE PENDING or IN PROGRESS\. |
| [DatasetSchema](API_DatasetSchema.md) | All datasets that reference the schema\. | |
| [Solution](API_Solution.md) | All campaigns based on the solution version\. | No associated SolutionVersion can have a status of CREATE PENDING or IN PROGRESS\. |
| [SolutionVersion](API_SolutionVersion.md) | | Deleted when the associated Solution is deleted\. |
| [DatasetGroup](API_DatasetGroup.md) | All associated event trackers\. All associated solutions\. All datasets in the dataset group\. | | | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/gs-cleanup.md |
ff6154eb32cb-0 | Describes a specific version of a solution\. 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_DescribeSolutionVersion.md |
312f30008cf0-0 | ```
{
"solutionVersionArn": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeSolutionVersion.md |
912ba47966c0-0 | The request accepts the following data in JSON format\.
** [solutionVersionArn](#API_DescribeSolutionVersion_RequestSyntax) ** <a name="personalize-DescribeSolutionVersion-request-solutionVersionArn"></a>
The Amazon Resource Name \(ARN\) of the solution version\.
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_DescribeSolutionVersion.md |
4f1dfeeff587-0 | ```
{
"solutionVersion": {
"creationDateTime": number,
"datasetGroupArn": "string",
"eventType": "string",
"failureReason": "string",
"lastUpdatedDateTime": number,
"performAutoML": boolean,
"performHPO": boolean,
"recipeArn": "string",
"solutionArn": "string",
"solutionConfig": {
"algorithmHyperParameters": {
"string" : "string"
},
"autoMLConfig": {
"metricName": "string",
"recipeList": [ "string" ]
},
"eventValueThreshold": "string",
"featureTransformationParameters": {
"string" : "string"
},
"hpoConfig": {
"algorithmHyperParameterRanges": {
"categoricalHyperParameterRanges": [
{
"name": "string",
"values": [ "string" ]
}
],
"continuousHyperParameterRanges": [
{ | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeSolutionVersion.md |
4f1dfeeff587-1 | }
],
"continuousHyperParameterRanges": [
{
"maxValue": number,
"minValue": number,
"name": "string"
}
],
"integerHyperParameterRanges": [
{
"maxValue": number,
"minValue": number,
"name": "string"
}
]
},
"hpoObjective": {
"metricName": "string",
"metricRegex": "string",
"type": "string"
},
"hpoResourceConfig": {
"maxNumberOfTrainingJobs": "string",
"maxParallelTrainingJobs": "string"
}
}
},
"solutionVersionArn": "string",
"status": "string",
"trainingHours": number,
"trainingMode": "string",
"tunedHPOParams": {
"algorithmHyperParameters": {
"string" : "string"
}
}
}
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeSolutionVersion.md |
f94ec03cedcc-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\.
** [solutionVersion](#API_DescribeSolutionVersion_ResponseSyntax) ** <a name="personalize-DescribeSolutionVersion-response-solutionVersion"></a>
The solution version\.
Type: [SolutionVersion](API_SolutionVersion.md) object | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeSolutionVersion.md |
34dd3d7eb0bf-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_DescribeSolutionVersion.md |
a02c9819b89f-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/DescribeSolutionVersion)
+ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/personalize-2018-05-22/DescribeSolutionVersion)
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeSolutionVersion)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/DescribeSolutionVersion)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/DescribeSolutionVersion)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/personalize-2018-05-22/DescribeSolutionVersion)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeSolutionVersion) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeSolutionVersion.md |
a02c9819b89f-1 | + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeSolutionVersion)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeSolutionVersion) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeSolutionVersion.md |
1649c938cae5-0 | USER\_PERSONALIZATION recipes predict the items that a user will interact with based on Interactions, Items, and Users datasets\.
**Note**
When choosing a recipe with AutoML, Amazon Personalize considers only the HRNN, HRNN\-Metadata, and HRNN\-Coldstart recipes | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/user-personalization-recipes.md |
09c4dd82a99e-0 | The User\-Personalization \(aws\-user\-personalization\) recipe is optimized for all USER\_PERSONALIZATION recommendation scenarios and uses automatic item exploration when recommending items\. With automatic exploration, Amazon Personalize automatically tests different item recommendations, learns from how users interact with these recommended items, and boosts recommendations for items that drive better engagement and conversion\. This is improves item discovery and engagement when you have a fast\-changing catalog, or when new items, such as news articles or promotions, are more relevant to users when fresh\.
To train a model, User\-Personalization uses the Interactions dataset from a dataset group\. A dataset group is a set of related datasets, which can include the Users, Items, and Interactions datasets\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/user-personalization-recipes.md |
0fd8890442d4-0 | HRNN is a hierarchical recurrent neural network, which can model the user\-item interactions across a given timeframe\. Use the HRNN recipe when user behavior changes over time, which is referred to the evolving intent problem\.
To train a model, HRNN uses the Interactions dataset from a dataset group\. A dataset group is a set of related datasets, which can include the Users, Items, and Interactions datasets\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/user-personalization-recipes.md |
b4d4d60a5036-0 | HRNN\-Metadata is the HRNN recipe with additional features derived from metadata found in the Interactions, Users, and Items datasets\. For example, rating, movie genre, or release year\. The training data *must* include metadata in at least one of the datasets\. HRNN\-Metadata performs better than non\-metadata models when high\-quality metadata is available\. Training with this recipe can involve longer training times\.
To train a model, HRNN\-Metadata uses the Users, Items, and Interactions datasets from a dataset group\. A dataset group is a set of related datasets, which can include the Users, Items, and Interactions datasets\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/user-personalization-recipes.md |
7a197ec8f5b1-0 | HRNN\-Coldstart is similar to the HRNN\-Metadata recipe, but also includes personalized exploration of new items\. Use the HRNN\-Coldstart recipe when you frequently add new items to a catalog and want the items to immediately be included in recommendations\.
To train a model, HRNN\-Coldstart uses the Users, Items, and Interactions datasets from a dataset group\. A dataset group is a set of related datasets, which can include the Users, Items, and Interactions datasets\. The dataset group that supplies the training data must include an Items dataset\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/user-personalization-recipes.md |
69ea609d975e-0 | The Popularity\-Count recipe calculates the popularity of items based on a count of events against that item in the Interactions dataset\. Use the Popularity\-Count recipe to create a baseline to compare results with other USER\-PERSONALIZATION recipes\.
To train a model, the Popularity\-Count recipe uses the Interactions dataset from a dataset group\. A dataset group is a set of related datasets, which can include the Users, Items, and Interactions datasets\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/user-personalization-recipes.md |
510b0bced890-0 | Provides a summary of the properties of a dataset\. For a complete listing, call the [DescribeDataset](API_DescribeDataset.md) API\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DatasetSummary.md |
ab1924ef4b03-0 | **creationDateTime** <a name="personalize-Type-DatasetSummary-creationDateTime"></a>
The date and time \(in Unix time\) that the dataset was created\.
Type: Timestamp
Required: No
**datasetArn** <a name="personalize-Type-DatasetSummary-datasetArn"></a>
The Amazon Resource Name \(ARN\) of the dataset\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
**datasetType** <a name="personalize-Type-DatasetSummary-datasetType"></a>
The dataset type\. One of the following values:
+ Interactions
+ Items
+ Users
+ Event\-Interactions
Type: String
Length Constraints: Maximum length of 256\.
Required: No
**lastUpdatedDateTime** <a name="personalize-Type-DatasetSummary-lastUpdatedDateTime"></a>
The date and time \(in Unix time\) that the dataset was last updated\.
Type: Timestamp
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DatasetSummary.md |
ab1924ef4b03-1 | The date and time \(in Unix time\) that the dataset was last updated\.
Type: Timestamp
Required: No
**name** <a name="personalize-Type-DatasetSummary-name"></a>
The name of the dataset\.
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-DatasetSummary-status"></a>
The status of the dataset\.
A dataset can be in one of the following states:
+ CREATE PENDING > CREATE IN\_PROGRESS > ACTIVE \-or\- CREATE FAILED
+ DELETE PENDING > DELETE IN\_PROGRESS
Type: String
Length Constraints: Maximum length of 256\.
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DatasetSummary.md |
644a9b1943bc-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/DatasetSummary)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/DatasetSummary)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/DatasetSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetSummary) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DatasetSummary.md |
4af5c9401a6b-0 | Returns a list of solution versions for the given solution\. When a solution is not specified, all the solution versions associated with the account are listed\. The response provides the properties for each solution version, including the Amazon Resource Name \(ARN\)\. 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_ListSolutionVersions.md |
87b0e6107214-0 | ```
{
"maxResults": number,
"nextToken": "string",
"solutionArn": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListSolutionVersions.md |
011c64f1e747-0 | The request accepts the following data in JSON format\.
** [maxResults](#API_ListSolutionVersions_RequestSyntax) ** <a name="personalize-ListSolutionVersions-request-maxResults"></a>
The maximum number of solution versions to return\.
Type: Integer
Valid Range: Minimum value of 1\. Maximum value of 100\.
Required: No
** [nextToken](#API_ListSolutionVersions_RequestSyntax) ** <a name="personalize-ListSolutionVersions-request-nextToken"></a>
A token returned from the previous call to `ListSolutionVersions` for getting the next set of solution versions \(if they exist\)\.
Type: String
Length Constraints: Maximum length of 1300\.
Required: No
** [solutionArn](#API_ListSolutionVersions_RequestSyntax) ** <a name="personalize-ListSolutionVersions-request-solutionArn"></a>
The Amazon Resource Name \(ARN\) of the solution\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListSolutionVersions.md |
94145b0d1e71-0 | ```
{
"nextToken": "string",
"solutionVersions": [
{
"creationDateTime": number,
"failureReason": "string",
"lastUpdatedDateTime": number,
"solutionVersionArn": "string",
"status": "string"
}
]
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListSolutionVersions.md |
4470db90f467-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\.
** [nextToken](#API_ListSolutionVersions_ResponseSyntax) ** <a name="personalize-ListSolutionVersions-response-nextToken"></a>
A token for getting the next set of solution versions \(if they exist\)\.
Type: String
Length Constraints: Maximum length of 1300\.
** [solutionVersions](#API_ListSolutionVersions_ResponseSyntax) ** <a name="personalize-ListSolutionVersions-response-solutionVersions"></a>
A list of solution versions describing the version properties\.
Type: Array of [SolutionVersionSummary](API_SolutionVersionSummary.md) objects
Array Members: Maximum number of 100 items\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListSolutionVersions.md |
468dfa29d4b9-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
**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_ListSolutionVersions.md |
860a9aa0c37f-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/ListSolutionVersions)
+ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/personalize-2018-05-22/ListSolutionVersions)
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListSolutionVersions)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/ListSolutionVersions)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/ListSolutionVersions)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/personalize-2018-05-22/ListSolutionVersions) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListSolutionVersions.md |
860a9aa0c37f-1 | + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListSolutionVersions)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListSolutionVersions)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListSolutionVersions) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListSolutionVersions.md |
0dfebd02b2c9-0 | Describes a solution\. 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_DescribeSolution.md |
f5b480faa3d1-0 | ```
{
"solutionArn": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeSolution.md |
4d328261eaa0-0 | The request accepts the following data in JSON format\.
** [solutionArn](#API_DescribeSolution_RequestSyntax) ** <a name="personalize-DescribeSolution-request-solutionArn"></a>
The Amazon Resource Name \(ARN\) of the solution 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_DescribeSolution.md |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.