id
stringlengths 14
16
| text
stringlengths 1
2.43k
| source
stringlengths 99
229
|
|---|---|---|
9e972feb1958-0 | **s3DataSource** <a name="personalize-Type-BatchInferenceJobInput-s3DataSource"></a>
The URI of the Amazon S3 location that contains your input data\. The Amazon S3 bucket must be in the same region as the API endpoint you are calling\.
Type: [S3DataConfig](API_S3DataConfig.md) object
Required: Yes | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_BatchInferenceJobInput.md |
85a8cb35acf1-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/BatchInferenceJobInput)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/BatchInferenceJobInput)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/BatchInferenceJobInput)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchInferenceJobInput) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_BatchInferenceJobInput.md |
a9347ca23a53-0 | Amazon Personalize is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service in Amazon Personalize\. CloudTrail captures a subset of API calls for Amazon Personalize as events, including calls from the Amazon Personalize console and from code calls to the Amazon Personalize APIs\. If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for Amazon Personalize\. If you don't configure a trail, you can still view the most recent events in the CloudTrail console in **Event history**\. Using the information collected by CloudTrail, you can determine the request that was made to Amazon Personalize, the IP address from which the request was made, who made the request, when it was made, and additional details\.
To learn more about CloudTrail, including how to configure and enable it, see the [AWS CloudTrail User Guide](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/logging-using-cloudtrail.md |
b7f8a6171dcc-0 | CloudTrail is enabled on your AWS account when you create the account\. When supported event activity occurs in Amazon Personalize, that activity is recorded in a CloudTrail event along with other AWS service events in **Event history**\. You can view, search, and download recent events in your AWS account\. For more information, see [Viewing Events with CloudTrail Event History](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/view-cloudtrail-events.html)\.
For an ongoing record of events in your AWS account, including events for Amazon Personalize, create a trail\. A trail enables CloudTrail to deliver log files to an Amazon S3 bucket\. By default, when you create a trail in the console, the trail applies to all regions\. The trail logs events from all regions in the AWS partition and delivers the log files to the Amazon S3 bucket that you specify\. Additionally, you can configure other AWS services to further analyze and act upon the event data collected in CloudTrail logs\. For more information, see:
+ [Overview for Creating a Trail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-create-and-update-a-trail.html)
+ [CloudTrail Supported Services and Integrations](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-aws-service-specific-topics.html#cloudtrail-aws-service-specific-topics-integrations) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/logging-using-cloudtrail.md |
b7f8a6171dcc-1 | + [Configuring Amazon SNS Notifications for CloudTrail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/getting_notifications_top_level.html)
+ [Receiving CloudTrail Log Files from Multiple Regions](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/receive-cloudtrail-log-files-from-multiple-regions.html) and [Receiving CloudTrail Log Files from Multiple Accounts](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-receive-logs-from-multiple-accounts.html)
Amazon Personalize supports logging every action \(API operation\) as an event in CloudTrail log files\. For more information, see [Actions](API_Operations.md)\.
Every event or log entry contains information about who generated the request\. The identity information helps you determine the following:
+ Whether the request was made with root or IAM user credentials\.
+ Whether the request was made with temporary security credentials for a role or federated user\.
+ Whether the request was made by another AWS service\.
For more information, see the [CloudTrail userIdentity Element](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-event-reference-user-identity.html)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/logging-using-cloudtrail.md |
a885437ea646-0 | A trail is a configuration that enables delivery of events as log files to an Amazon S3 bucket that you specify\. CloudTrail log files contain one or more log entries\. An event represents a single request from any source and includes information about the requested action, the date and time of the action, request parameters, and so on\. CloudTrail log files are not an ordered stack trace of the public API calls, so they do not appear in any specific order\.
The following example shows a CloudTrail log entry with actions for the ListDatasetGroups API operation:
```
{
"eventVersion": "1.05",
"userIdentity": {
"type": "IAMUser",
"principalId": "principal-id",
"arn": "arn:aws:iam::user-arn",
"accountId": "account-id",
"accessKeyId": "access-key,
"userName": "user-name"
},
"eventTime": "2018-11-22T02:18:03Z",
"eventSource": "personalize.amazonaws.com",
"eventName": "ListDatasetGroups",
"awsRegion": "us-west-2",
"sourceIPAddress": "source-ip-address", | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/logging-using-cloudtrail.md |
a885437ea646-1 | "awsRegion": "us-west-2",
"sourceIPAddress": "source-ip-address",
"userAgent": "aws-cli/1.11.16 Python/2.7.11 Darwin/15.6.0 botocore/1.4.73",
"requestParameters": null,
"responseElements": {
"datasetGroups": [
{
"name": "testdatasetgroup",
"datasetGroupArn": "arn:aws:personalize:us-west-2:nnnnnnnnnn:dataset-group/testdataset",
"status": "ACTIVE",
"creationDateTime": "Nov 5, 2018 6:06:01 AM"
}
]
},
"requestID": "request-id",
"eventID": "event-id",
"eventType": "AwsApiCall",
"recipientAccountId": "recipient-account-id"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/logging-using-cloudtrail.md |
d338935c12c4-0 | Use the following information to help you diagnose and fix common issues that you might encounter when working with Amazon Personalize and IAM\.
**Topics**
+ [I Am Not Authorized to Perform an Action in Amazon Personalize](#security_iam_troubleshoot-no-permissions)
+ [I Am Not Authorized to Perform iam:PassRole](#security_iam_troubleshoot-passrole)
+ [I Want to View My Access Keys](#security_iam_troubleshoot-access-keys)
+ [I'm an Administrator and Want to Allow Others to Access Amazon Personalize](#security_iam_troubleshoot-admin-delegate)
+ [I Want to Allow People Outside of My AWS Account to Access My Amazon Personalize Resources](#security_iam_troubleshoot-cross-account-access) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security_iam_troubleshoot.md |
f29846161694-0 | If the AWS Management Console tells you that you're not authorized to perform an action, then you must contact your administrator for assistance\. Your administrator is the person that provided you with your user name and password\.
The following example error occurs when the `mateojackson` IAM user tries to use the console to view details about a *widget* but does not have `personalize:GetWidget` permissions\.
```
User: arn:aws:iam::123456789012:user/mateojackson is not authorized to perform: personalize:GetWidget on resource: my-example-widget
```
In this case, Mateo asks his administrator to update his policies to allow him to access the `my-example-widget` resource using the `personalize:GetWidget` action\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security_iam_troubleshoot.md |
8d554d80f103-0 | If you receive an error that you're not authorized to perform the `iam:PassRole` action, then you must contact your administrator for assistance\. Your administrator is the person that provided you with your user name and password\. Ask that person to update your policies to allow you to pass a role to Amazon Personalize\.
Some AWS services allow you to pass an existing role to that service, instead of creating a new service role or service\-linked role\. To do this, you must have permissions to pass the role to the service\.
The following example error occurs when an IAM user named `marymajor` tries to use the console to perform an action in Amazon Personalize\. However, the action requires the service to have permissions granted by a service role\. Mary does not have permissions to pass the role to the service\.
```
User: arn:aws:iam::123456789012:user/marymajor is not authorized to perform: iam:PassRole
```
In this case, Mary asks her administrator to update her policies to allow her to perform the `iam:PassRole` action\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security_iam_troubleshoot.md |
1319db10a31f-0 | After you create your IAM user access keys, you can view your access key ID at any time\. However, you can't view your secret access key again\. If you lose your secret key, you must create a new access key pair\.
Access keys consist of two parts: an access key ID \(for example, `AKIAIOSFODNN7EXAMPLE`\) and a secret access key \(for example, `wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY`\)\. Like a user name and password, you must use both the access key ID and secret access key together to authenticate your requests\. Manage your access keys as securely as you do your user name and password\.
**Important**
Do not provide your access keys to a third party, even to help [find your canonical user ID](https://docs.aws.amazon.com/general/latest/gr/acct-identifiers.html#FindingCanonicalId)\. By doing this, you might give someone permanent access to your account\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security_iam_troubleshoot.md |
1319db10a31f-1 | When you create an access key pair, you are prompted to save the access key ID and secret access key in a secure location\. The secret access key is available only at the time you create it\. If you lose your secret access key, you must add new access keys to your IAM user\. You can have a maximum of two access keys\. If you already have two, you must delete one key pair before creating a new one\. To view instructions, see [Managing Access Keys](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html#Using_CreateAccessKey) in the *IAM User Guide*\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security_iam_troubleshoot.md |
3c3c797af650-0 | To allow others to access Amazon Personalize, you must create an IAM entity \(user or role\) for the person or application that needs access\. They will use the credentials for that entity to access AWS\. You must then attach a policy to the entity that grants them the correct permissions in Amazon Personalize\.
To get started right away, see [Creating Your First IAM Delegated User and Group](https://docs.aws.amazon.com/IAM/latest/UserGuide/getting-started_create-delegated-user.html) in the *IAM User Guide*\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security_iam_troubleshoot.md |
88f251372879-0 | You can create a role that users in other accounts or people outside of your organization can use to access your resources\. You can specify who is trusted to assume the role\. For services that support resource\-based policies or access control lists \(ACLs\), you can use those policies to grant people access to your resources\.
To learn more, consult the following:
+ To learn whether Amazon Personalize supports these features, see [How Amazon Personalize Works with IAM](security_iam_service-with-iam.md)\.
+ To learn how to provide access to your resources across AWS accounts that you own, see [Providing Access to an IAM User in Another AWS Account That You Own](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_common-scenarios_aws-accounts.html) in the *IAM User Guide*\.
+ To learn how to provide access to your resources to third\-party AWS accounts, see [Providing Access to AWS Accounts Owned by Third Parties](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_common-scenarios_third-party.html) in the *IAM User Guide*\.
+ To learn how to provide access through identity federation, see [Providing Access to Externally Authenticated Users \(Identity Federation\)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_common-scenarios_federated-users.html) in the *IAM User Guide*\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security_iam_troubleshoot.md |
88f251372879-1 | + To learn the difference between using roles and resource\-based policies for cross\-account access, see [How IAM Roles Differ from Resource\-based Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_compare-resource-policies.html) in the *IAM User Guide*\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security_iam_troubleshoot.md |
8f60d4d75113-0 | The following actions are supported by Amazon Personalize:
+ [CreateBatchInferenceJob](API_CreateBatchInferenceJob.md)
+ [CreateCampaign](API_CreateCampaign.md)
+ [CreateDataset](API_CreateDataset.md)
+ [CreateDatasetGroup](API_CreateDatasetGroup.md)
+ [CreateDatasetImportJob](API_CreateDatasetImportJob.md)
+ [CreateEventTracker](API_CreateEventTracker.md)
+ [CreateFilter](API_CreateFilter.md)
+ [CreateSchema](API_CreateSchema.md)
+ [CreateSolution](API_CreateSolution.md)
+ [CreateSolutionVersion](API_CreateSolutionVersion.md)
+ [DeleteCampaign](API_DeleteCampaign.md)
+ [DeleteDataset](API_DeleteDataset.md)
+ [DeleteDatasetGroup](API_DeleteDatasetGroup.md)
+ [DeleteEventTracker](API_DeleteEventTracker.md)
+ [DeleteFilter](API_DeleteFilter.md)
+ [DeleteSchema](API_DeleteSchema.md)
+ [DeleteSolution](API_DeleteSolution.md)
+ [DescribeAlgorithm](API_DescribeAlgorithm.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_Operations_Amazon_Personalize.md |
8f60d4d75113-1 | + [DescribeAlgorithm](API_DescribeAlgorithm.md)
+ [DescribeBatchInferenceJob](API_DescribeBatchInferenceJob.md)
+ [DescribeCampaign](API_DescribeCampaign.md)
+ [DescribeDataset](API_DescribeDataset.md)
+ [DescribeDatasetGroup](API_DescribeDatasetGroup.md)
+ [DescribeDatasetImportJob](API_DescribeDatasetImportJob.md)
+ [DescribeEventTracker](API_DescribeEventTracker.md)
+ [DescribeFeatureTransformation](API_DescribeFeatureTransformation.md)
+ [DescribeFilter](API_DescribeFilter.md)
+ [DescribeRecipe](API_DescribeRecipe.md)
+ [DescribeSchema](API_DescribeSchema.md)
+ [DescribeSolution](API_DescribeSolution.md)
+ [DescribeSolutionVersion](API_DescribeSolutionVersion.md)
+ [GetSolutionMetrics](API_GetSolutionMetrics.md)
+ [ListBatchInferenceJobs](API_ListBatchInferenceJobs.md)
+ [ListCampaigns](API_ListCampaigns.md)
+ [ListDatasetGroups](API_ListDatasetGroups.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_Operations_Amazon_Personalize.md |
8f60d4d75113-2 | + [ListDatasetGroups](API_ListDatasetGroups.md)
+ [ListDatasetImportJobs](API_ListDatasetImportJobs.md)
+ [ListDatasets](API_ListDatasets.md)
+ [ListEventTrackers](API_ListEventTrackers.md)
+ [ListFilters](API_ListFilters.md)
+ [ListRecipes](API_ListRecipes.md)
+ [ListSchemas](API_ListSchemas.md)
+ [ListSolutions](API_ListSolutions.md)
+ [ListSolutionVersions](API_ListSolutionVersions.md)
+ [UpdateCampaign](API_UpdateCampaign.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_Operations_Amazon_Personalize.md |
e174ba3b2e7b-0 | Returns the list of event trackers associated with the account\. The response provides the properties for each event tracker, including the Amazon Resource Name \(ARN\) and tracking ID\. For more information on event trackers, see [CreateEventTracker](API_CreateEventTracker.md)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListEventTrackers.md |
7aec86cb8b9f-0 | ```
{
"datasetGroupArn": "string",
"maxResults": number,
"nextToken": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListEventTrackers.md |
4973f755000d-0 | The request accepts the following data in JSON format\.
** [datasetGroupArn](#API_ListEventTrackers_RequestSyntax) ** <a name="personalize-ListEventTrackers-request-datasetGroupArn"></a>
The ARN of a dataset group used to filter the response\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** [maxResults](#API_ListEventTrackers_RequestSyntax) ** <a name="personalize-ListEventTrackers-request-maxResults"></a>
The maximum number of event trackers to return\.
Type: Integer
Valid Range: Minimum value of 1\. Maximum value of 100\.
Required: No
** [nextToken](#API_ListEventTrackers_RequestSyntax) ** <a name="personalize-ListEventTrackers-request-nextToken"></a>
A token returned from the previous call to `ListEventTrackers` for getting the next set of event trackers \(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_ListEventTrackers.md |
740564ce3729-0 | ```
{
"eventTrackers": [
{
"creationDateTime": number,
"eventTrackerArn": "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_ListEventTrackers.md |
c1bc98c0c320-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\.
** [eventTrackers](#API_ListEventTrackers_ResponseSyntax) ** <a name="personalize-ListEventTrackers-response-eventTrackers"></a>
A list of event trackers\.
Type: Array of [EventTrackerSummary](API_EventTrackerSummary.md) objects
Array Members: Maximum number of 100 items\.
** [nextToken](#API_ListEventTrackers_ResponseSyntax) ** <a name="personalize-ListEventTrackers-response-nextToken"></a>
A token for getting the next set of event trackers \(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_ListEventTrackers.md |
5d5a81766bcc-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_ListEventTrackers.md |
91b2a77c0097-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/ListEventTrackers)
+ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/personalize-2018-05-22/ListEventTrackers)
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ListEventTrackers)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/ListEventTrackers)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/ListEventTrackers)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/personalize-2018-05-22/ListEventTrackers) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListEventTrackers.md |
91b2a77c0097-1 | + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/ListEventTrackers)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/ListEventTrackers)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ListEventTrackers) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ListEventTrackers.md |
434cab9b1186-0 | Describes a deployed solution version, otherwise known as a campaign\. 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_Campaign.md |
d33e7194f700-0 | **campaignArn** <a name="personalize-Type-Campaign-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: No
**campaignConfig** <a name="personalize-Type-Campaign-campaignConfig"></a>
The configuration details of a campaign\.
Type: [CampaignConfig](API_CampaignConfig.md) object
Required: No
**creationDateTime** <a name="personalize-Type-Campaign-creationDateTime"></a>
The date and time \(in Unix format\) that the campaign was created\.
Type: Timestamp
Required: No
**failureReason** <a name="personalize-Type-Campaign-failureReason"></a>
If a campaign fails, the reason behind the failure\.
Type: String
Required: No
**lastUpdatedDateTime** <a name="personalize-Type-Campaign-lastUpdatedDateTime"></a>
The date and time \(in Unix format\) that the campaign was last updated\.
Type: Timestamp
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_Campaign.md |
d33e7194f700-1 | The date and time \(in Unix format\) that the campaign was last updated\.
Type: Timestamp
Required: No
**latestCampaignUpdate** <a name="personalize-Type-Campaign-latestCampaignUpdate"></a>
Provides a summary of the properties of a campaign update\. For a complete listing, call the [DescribeCampaign](API_DescribeCampaign.md) API\.
Type: [CampaignUpdateSummary](API_CampaignUpdateSummary.md) object
Required: No
**minProvisionedTPS** <a name="personalize-Type-Campaign-minProvisionedTPS"></a>
Specifies the requested minimum provisioned transactions \(recommendations\) per second\.
Type: Integer
Valid Range: Minimum value of 1\.
Required: No
**name** <a name="personalize-Type-Campaign-name"></a>
The name of the campaign\.
Type: String
Length Constraints: Minimum length of 1\. Maximum length of 63\.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
**solutionVersionArn** <a name="personalize-Type-Campaign-solutionVersionArn"></a>
The Amazon Resource Name \(ARN\) of a specific version of the solution\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_Campaign.md |
d33e7194f700-2 | The Amazon Resource Name \(ARN\) of a specific version of the solution\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
**status** <a name="personalize-Type-Campaign-status"></a>
The status of the campaign\.
A campaign 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_Campaign.md |
f4bb48139465-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/Campaign)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/Campaign)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/Campaign)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/Campaign) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_Campaign.md |
2bfdf408b334-0 | Amazon Personalize is a machine learning service that makes it easy for developers to add individualized recommendations to customers who use their applications\. It reflects the vast experience that Amazon has in building personalization systems\.
You can use Amazon Personalize in a variety of scenarios, such as giving users recommendations based on their preferences and behavior, personalized re\-ranking of results, and personalizing content for emails and notifications\.
Amazon Personalize does not require extensive machine learning experience\. You can build, train, and deploy a solution version \(a trained Amazon Personalize recommendation model\) with the AWS console or programmatically by using the AWS SDK\. As the developer, you only need to do the following:
+ Format input data and upload the data into an Amazon S3 bucket, or send real\-time event data\.
+ Select a training recipe \(algorithm\) to use on the data\.
+ Train a solution version using the recipe\.
+ Deploy the solution version\.
Amazon Personalize can capture live events from your users to achieve real\-time personalization\. Amazon Personalize can blend real\-time user activity data with existing user profile and item information to recommend the most relevant items, according to the user’s current session and activity\. You can also use Amazon Personalize to collect data for new properties, such as a brand new website, and after enough data has been collected, Amazon Personalize can start to make recommendations\.
To give recommendations to your users, call one of the recommendation APIs, and then create personalized experiences for them\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/what-is-personalize.md |
2bfdf408b334-1 | To give recommendations to your users, call one of the recommendation APIs, and then create personalized experiences for them\.
Amazon Personalize can improve its recommendations over time as new user activity data is collected\. For example, a new movie rental event by a user can result in better movie recommendations\.
Amazon Personalize can provide recommendations based on a user's browsing context\. For example, Amazon Personalize can provide different recommendations when a user is browsing on a mobile device than when that same user is browsing on a desktop\.
With Amazon Personalize you can train a solution for different use cases\. For example, user personalization, items related to an item, and re\-ranking of items\. You choose a recipe based on your use case and provide the input data\. A recipe performs featurization of your data, and applies a choice of learning algorithms, along with default hyperparameters, and hyperparameter optimization job configuration\.
Recipes in Amazon Personalize allow you to create custom personalization models without needing machine learning expertise\. You can choose which recipe to use to train a solution version, or let Amazon Personalize decide on the best recipe to use for your data\. To help you decide which recipe to use, Amazon Personalize provides extensive metrics on the performance of a trained solution version\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/what-is-personalize.md |
e59fdf38bed6-0 | If you are a first\-time user of Amazon Personalize, we recommend that you read the following sections in order:
1. **[How It Works](how-it-works.md)** – This section introduces various Amazon Personalize components that you work with to create an end\-to\-end experience\.
1. **[Getting Started](getting-started.md)** – In this section you set up your account, and test the Amazon Personalize Console and API\.
1. **[Preparing and Importing Data](data-prep.md)** – This section describes how to prepare and import your training data into Amazon Personalize\.
1. **[Recording Events](recording-events.md)** – This section provides information about improving user recommendations by recording user events\.
1. **[Creating a Solution](training-deploying-solutions.md)** – This section provides information about creating a solution version by training a model\.
1. **[Creating a Campaign](campaigns.md)** – This section provides information about deploying a solution version as a campaign\.
1. **[Getting Recommendations](getting-recommendations.md)** – This section shows how to get recommendations from a campaign\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/what-is-personalize.md |
b0092ab26818-0 | If you are an experienced Amazon Personalize user, you can find in\-depth tutorials and code samples in the [amazon\-personalize\-samples GitHub repository](https://github.com/aws-samples/amazon-personalize-samples)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/what-is-personalize.md |
e17f4d750d60-0 | This getting started guide shows you how to create a campaign that returns movie recommendations for a user, based on historical data that consists of 100,000 movie ratings on 9,700 movies from 600 users\.
**To simplify this guide:**
+ We rely on the fact that a user saw a movie and not on what they rated the movie\. This simplifies the preparation of the training data\.
+ We don't record live user interaction events\. For information on capturing user events, see [Recording Events](recording-events.md)\.
To begin, download and prepare the training data\. Next, create an AWS Identity and Access Management \(IAM\) role that allows Amazon Personalize to access the data on your behalf\. After creating the training data and role, proceed to either [Getting Started \(Console\)](getting-started-console.md) or [Getting Started \(AWS CLI\)](getting-started-cli.md)\.
When you finish the getting started exercise, you might want to delete the resources you created\.
**Topics**
+ [Getting Started Prerequisites](gs-prerequisites.md)
+ [Getting Started \(Console\)](getting-started-console.md)
+ [Getting Started \(AWS CLI\)](getting-started-cli.md)
+ [Getting Started \(AWS SDK for Python\)](getting-started-python.md)
+ [Clean Up Resources](gs-cleanup.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/getting-started.md |
3c2d959ad302-0 | The following data types are supported by Amazon Personalize:
+ [Algorithm](API_Algorithm.md)
+ [AlgorithmImage](API_AlgorithmImage.md)
+ [AutoMLConfig](API_AutoMLConfig.md)
+ [AutoMLResult](API_AutoMLResult.md)
+ [BatchInferenceJob](API_BatchInferenceJob.md)
+ [BatchInferenceJobConfig](API_BatchInferenceJobConfig.md)
+ [BatchInferenceJobInput](API_BatchInferenceJobInput.md)
+ [BatchInferenceJobOutput](API_BatchInferenceJobOutput.md)
+ [BatchInferenceJobSummary](API_BatchInferenceJobSummary.md)
+ [Campaign](API_Campaign.md)
+ [CampaignConfig](API_CampaignConfig.md)
+ [CampaignSummary](API_CampaignSummary.md)
+ [CampaignUpdateSummary](API_CampaignUpdateSummary.md)
+ [CategoricalHyperParameterRange](API_CategoricalHyperParameterRange.md)
+ [ContinuousHyperParameterRange](API_ContinuousHyperParameterRange.md)
+ [Dataset](API_Dataset.md)
+ [DatasetGroup](API_DatasetGroup.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_Types_Amazon_Personalize.md |
3c2d959ad302-1 | + [Dataset](API_Dataset.md)
+ [DatasetGroup](API_DatasetGroup.md)
+ [DatasetGroupSummary](API_DatasetGroupSummary.md)
+ [DatasetImportJob](API_DatasetImportJob.md)
+ [DatasetImportJobSummary](API_DatasetImportJobSummary.md)
+ [DatasetSchema](API_DatasetSchema.md)
+ [DatasetSchemaSummary](API_DatasetSchemaSummary.md)
+ [DatasetSummary](API_DatasetSummary.md)
+ [DataSource](API_DataSource.md)
+ [DefaultCategoricalHyperParameterRange](API_DefaultCategoricalHyperParameterRange.md)
+ [DefaultContinuousHyperParameterRange](API_DefaultContinuousHyperParameterRange.md)
+ [DefaultHyperParameterRanges](API_DefaultHyperParameterRanges.md)
+ [DefaultIntegerHyperParameterRange](API_DefaultIntegerHyperParameterRange.md)
+ [EventTracker](API_EventTracker.md)
+ [EventTrackerSummary](API_EventTrackerSummary.md)
+ [FeatureTransformation](API_FeatureTransformation.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_Types_Amazon_Personalize.md |
3c2d959ad302-2 | + [FeatureTransformation](API_FeatureTransformation.md)
+ [Filter](API_Filter.md)
+ [FilterSummary](API_FilterSummary.md)
+ [HPOConfig](API_HPOConfig.md)
+ [HPOObjective](API_HPOObjective.md)
+ [HPOResourceConfig](API_HPOResourceConfig.md)
+ [HyperParameterRanges](API_HyperParameterRanges.md)
+ [IntegerHyperParameterRange](API_IntegerHyperParameterRange.md)
+ [Recipe](API_Recipe.md)
+ [RecipeSummary](API_RecipeSummary.md)
+ [S3DataConfig](API_S3DataConfig.md)
+ [Solution](API_Solution.md)
+ [SolutionConfig](API_SolutionConfig.md)
+ [SolutionSummary](API_SolutionSummary.md)
+ [SolutionVersion](API_SolutionVersion.md)
+ [SolutionVersionSummary](API_SolutionVersionSummary.md)
+ [TunedHPOParams](API_TunedHPOParams.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_Types_Amazon_Personalize.md |
63ff0c17eb45-0 | The following sections contain information about Amazon Personalize guidelines and quotas\.
**Topics**
+ [Supported AWS Regions](#regions)
+ [Compliance](#ompliance)
+ [Service Quotas](#limits-table)
+ [Requesting a Quota Increase](#requesting-limit-increase) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/limits.md |
dfa1202927d9-0 | For a list of AWS Regions that support Amazon Personalize, see [AWS Regions and Endpoints](https://docs.aws.amazon.com/general/latest/gr/personalize.html) in the *Amazon Web Services General Reference*\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/limits.md |
68719012f952-0 | For more information about Amazon Personalize compliance programs, see [AWS Compliance](https://aws.amazon.com/compliance/), [AWS Compliance Programs](https://aws.amazon.com/compliance/programs/), and [AWS Services in Scope by Compliance Program](https://aws.amazon.com/compliance/services-in-scope)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/limits.md |
5268ceadf6b7-0 | Your AWS account has the following quotas for Amazon Personalize\.
| Resource | Quota |
| --- | --- |
| Maximum amount of data for an individual dataset \(Users, Items, or Interactions\) for HRNN, SIMS, Popularity\-Count, and Personalized\-Ranking recipes\. | 100 GB |
| Maximum amount of data for Interactions dataset for HRNN\-metadata and HRNN\-coldstart recipes\. | 100 GB |
| Maximum amount of combined data for Users and Items datasets for HRNN\-metadata and HRNN\-coldstart recipes\. | 5 GB |
| Maximum number of filters per account | 10 filters |
| Minimum number of unique combined historical and event interactions \(after filtering by eventType and eventValueThreshold, if provided\) required to train a model \(training a model means you create a solution version\)\. | 1000 |
| Minimum number of unique users, with at least 2 interactions each, required to train a model \(training a model means you create a solution version\)\. | 25 |
| Maximum number of interactions that are considered by a model during training\. | 500 million |
| Maximum number of items that are considered by a model during training\. | 750 thousand |
| Maximum number of cold start items the HRNN\-Coldstart recipe supports to train a model \(training a model means you create a solution version\)\. | 80,000 | | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/limits.md |
5268ceadf6b7-1 | | Minimum number of cold start items the HRNN\-Coldstart recipe requires to train a model \(training a model means you create a solution version\)\. | 100 |
| Maximum transaction rate \(GetRecommendations and GetPersonalizedRanking requests\)\. | 2500/sec |
| Maximum number of GetRecommendations requests per second per campaign\. | 500/sec |
| Maximum number of GetPersonalizedRanking requests per second per campaign\. | 500/sec |
| Maximum rate of PutEvents requests\. | 1000 per second sec |
| Maximum number of events in a PutEvents call\. | 10 |
| Maximum size of an event\. | 10 KB |
| Maximum number of input files in a batch inference job\. | 1000 |
| Maximum size of batch inference job input\. | 1 GB |
| Maximum number of records per input file in a batch inference job\. | 50 million |
Your AWS account has the following quotas per region for Amazon Personalize\.
| Resource | Quota |
| --- | --- |
| Total number of active schemas\. | 500 |
| Total number of active datasets\. | 500 |
| Total number of active dataset groups\. | 500 |
| Total number of active event trackers\. | 500 |
| Total number of active solutions\. | 500 |
| Total number of active campaigns\. | 5 |
| Total number of pending or in progress batch inference jobs | 5 | | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/limits.md |
5268ceadf6b7-2 | | Total number of active campaigns\. | 5 |
| Total number of pending or in progress batch inference jobs | 5 |
| Total number of pending or in progress solution versions | 20 | | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/limits.md |
9d703bfa0225-0 | For adjustable quotas, you can request a quota increase\. The following Amazon Personalize quotas are adjustable:
+ Total number of active campaigns
+ Maximum number of filters per account
+ Total number of pending or in progress batch inference jobs
+ Total number of pending or in progress solution versions
+ Maximum rate of `PutEvents` requests
To request a quota increase, use the [Service Quotas console](https://console.aws.amazon.com/servicequotas/) and follow the steps in the [Requesting a Quota Increase](https://docs.aws.amazon.com/servicequotas/latest/userguide/request-quota-increase.html) section of the *Service Quotas User Guide*\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/limits.md |
3532b77fe40e-0 | Provides a summary of the properties of a dataset schema\. For a complete listing, call the [DescribeSchema](API_DescribeSchema.md) API\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DatasetSchemaSummary.md |
69ee637498df-0 | **creationDateTime** <a name="personalize-Type-DatasetSchemaSummary-creationDateTime"></a>
The date and time \(in Unix time\) that the schema was created\.
Type: Timestamp
Required: No
**lastUpdatedDateTime** <a name="personalize-Type-DatasetSchemaSummary-lastUpdatedDateTime"></a>
The date and time \(in Unix time\) that the schema was last updated\.
Type: Timestamp
Required: No
**name** <a name="personalize-Type-DatasetSchemaSummary-name"></a>
The name of the schema\.
Type: String
Length Constraints: Minimum length of 1\. Maximum length of 63\.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
**schemaArn** <a name="personalize-Type-DatasetSchemaSummary-schemaArn"></a>
The Amazon Resource Name \(ARN\) of the schema\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DatasetSchemaSummary.md |
05e6089281e6-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/DatasetSchemaSummary)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/DatasetSchemaSummary)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/DatasetSchemaSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetSchemaSummary) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DatasetSchemaSummary.md |
98f63f14170e-0 | A solution version is the term Amazon Personalize uses for a trained machine learning model that makes recommendations to customers\. Creating a solution entails optimizing the model to deliver the best results for a specific business need\. Amazon Personalize uses recipes to create these personalized solutions\.
A recipe in Amazon Personalize is made up of an algorithm with hyperparameters, and a feature transformation\. An algorithm is a mathematical expression that when trained becomes the model\. The algorithm contains parameters whose unknown values are determined by training on input data\. Hyperparameters are external to the algorithm and specify details of the training process, such as the number of training passes to run over the complete dataset or the number of hidden layers to use\.
Amazon Personalize provides a number of predefined recipes that allow you to make recommendations with no knowledge of machine learning\. The predefined recipes are also useful for quick experimentation\. For more information, see [Choosing a Recipe](working-with-predefined-recipes.md)\.
A solution is created by calling the [CreateSolution](API_CreateSolution.md) and [CreateSolutionVersion](API_CreateSolutionVersion.md) operations\. `CreateSolution` creates the configuration for training a model\. `CreateSolutionVersion` starts the training process, which results in a specific version of the solution\. A new version of the solution is created each time you call `CreateSolutionVersion`\. A condensed, reorganized version of the `CreateSolution` request is shown\. The various options and configuration objects are discussed in the following sections\.
```
{
"name": "string", | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/training-deploying-solutions.md |
98f63f14170e-1 | ```
{
"name": "string",
"datasetGroupArn": "string",
"performAutoML": boolean,
"recipeArn": "string",
"performHPO": boolean,
"eventType": "string",
"solutionConfig": {
"autoMLConfig": {
"metricName": "string",
"recipeList": [ "string" ]
},
"eventValueThreshold": "string",
"algorithmHyperParameters": { },
"featureTransformationParameters": { },
"hpoConfig": { }
},
}
```
**Customize the Training**
To customize the training, supply the `solutionConfig` parameter\. The `SolutionConfig` object allows you to override the default solution and recipe parameters\. For more information see [Overriding Default Recipe Parameters](customizing-solution-config.md)\.
**Create a solution version using the AWS Python SDK**
1. Create and import a dataset into a dataset group\. For more information, see [Preparing and Importing Data](data-prep.md)\.
1. Create the solution version using the dataset group and the following code\.
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/training-deploying-solutions.md |
98f63f14170e-2 | 1. Create the solution version using the dataset group and the following code\.
```
import boto3
personalize = boto3.client('personalize')
print ('Creating solution')
response = personalize.create_solution(
name = "SolutionName",
datasetGroupArn = "Dataset group arn",
performAutoML = True) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/training-deploying-solutions.md |
5d5c0f626ca1-0 | solution_arn = response['solutionArn']
print('Solution ARN: ' + solution_arn) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/training-deploying-solutions.md |
db255fdf5529-0 | solution_description = personalize.describe_solution(solutionArn = solution_arn)['solution']
print('Solution status: ' + solution_description['status']) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/training-deploying-solutions.md |
9d6e6ae3de4f-0 | print ('Creating solution version')
response = personalize.create_solution_version(solutionArn = solution_arn)
solution_version_arn = response['solutionVersionArn']
print('Solution version ARN: ' + solution_version_arn) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/training-deploying-solutions.md |
f332ba6985d3-0 | solution_version_description = personalize.describe_solution_version(
solutionVersionArn = solution_version_arn)['solutionVersion']
print('Solution version status: ' + solution_version_description['status'])
```
Training a model takes time\. To check the current solution version status, call the [DescribeSolutionVersion](API_DescribeSolutionVersion.md) operation and pass the ARN of the solution version returned from the `CreateSolutionVersion` operation\. Training is complete when the `status` is `ACTIVE`\.
Now that you have a solution version, evaluate it using metrics supplied by Amazon Personalize\. For more information, see [Evaluating a Solution Version](working-with-training-metrics.md)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/training-deploying-solutions.md |
8ea962aa2213-0 | Describes the configuration properties for the solution\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_SolutionConfig.md |
276ca37bf979-0 | **algorithmHyperParameters** <a name="personalize-Type-SolutionConfig-algorithmHyperParameters"></a>
Lists the hyperparameter names and ranges\.
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
**autoMLConfig** <a name="personalize-Type-SolutionConfig-autoMLConfig"></a>
The [AutoMLConfig](API_AutoMLConfig.md) object containing a list of recipes to search when AutoML is performed\.
Type: [AutoMLConfig](API_AutoMLConfig.md) object
Required: No
**eventValueThreshold** <a name="personalize-Type-SolutionConfig-eventValueThreshold"></a>
Only events with a value greater than or equal to this threshold are used for training a model\.
Type: String
Length Constraints: Maximum length of 256\.
Required: No
**featureTransformationParameters** <a name="personalize-Type-SolutionConfig-featureTransformationParameters"></a>
Lists the feature transformation parameters\.
Type: String to string map
Map Entries: Maximum number of 100 items\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_SolutionConfig.md |
276ca37bf979-1 | Lists the feature transformation parameters\.
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
**hpoConfig** <a name="personalize-Type-SolutionConfig-hpoConfig"></a>
Describes the properties for hyperparameter optimization \(HPO\)\.
Type: [HPOConfig](API_HPOConfig.md) object
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_SolutionConfig.md |
29188dc41fd7-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/SolutionConfig)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/SolutionConfig)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/SolutionConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/SolutionConfig) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_SolutionConfig.md |
cc9d6386072f-0 | A dataset group is a collection of related datasets \(Interactions, User, and Item\)\. You create a dataset group by calling [CreateDatasetGroup](API_CreateDatasetGroup.md)\. You then create a dataset and add it to a dataset group by calling [CreateDataset](API_CreateDataset.md)\. The dataset group is used to create and train a solution by calling [CreateSolution](API_CreateSolution.md)\. A dataset group can contain only one of each type of dataset\.
You can specify an AWS Key Management Service \(KMS\) key to encrypt the datasets in the group\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DatasetGroup.md |
552a0f5030c2-0 | **creationDateTime** <a name="personalize-Type-DatasetGroup-creationDateTime"></a>
The creation date and time \(in Unix time\) of the dataset group\.
Type: Timestamp
Required: No
**datasetGroupArn** <a name="personalize-Type-DatasetGroup-datasetGroupArn"></a>
The Amazon Resource Name \(ARN\) of the dataset group\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
**failureReason** <a name="personalize-Type-DatasetGroup-failureReason"></a>
If creating a dataset group fails, provides the reason why\.
Type: String
Required: No
**kmsKeyArn** <a name="personalize-Type-DatasetGroup-kmsKeyArn"></a>
The Amazon Resource Name \(ARN\) of the KMS key used to encrypt the datasets\.
Type: String
Required: No
**lastUpdatedDateTime** <a name="personalize-Type-DatasetGroup-lastUpdatedDateTime"></a> | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DatasetGroup.md |
552a0f5030c2-1 | **lastUpdatedDateTime** <a name="personalize-Type-DatasetGroup-lastUpdatedDateTime"></a>
The last update date and time \(in Unix time\) of the dataset group\.
Type: Timestamp
Required: No
**name** <a name="personalize-Type-DatasetGroup-name"></a>
The name of the dataset group\.
Type: String
Length Constraints: Minimum length of 1\. Maximum length of 63\.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
**roleArn** <a name="personalize-Type-DatasetGroup-roleArn"></a>
The ARN of the IAM role that has permissions to create the dataset group\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`
Required: No
**status** <a name="personalize-Type-DatasetGroup-status"></a>
The current status of the dataset group\.
A dataset group can be in one of the following states: | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DatasetGroup.md |
552a0f5030c2-2 | The current status of the dataset group\.
A dataset group can be in one of the following states:
+ CREATE PENDING > CREATE IN\_PROGRESS > ACTIVE \-or\- CREATE FAILED
+ DELETE PENDING
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_DatasetGroup.md |
c3149232cde0-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/DatasetGroup)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/DatasetGroup)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/DatasetGroup)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DatasetGroup) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DatasetGroup.md |
0a3fab20c0ba-0 | Describes a schema\. 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_DescribeSchema.md |
8dedc476b0a1-0 | ```
{
"schemaArn": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeSchema.md |
e6bcbc4a5ed7-0 | The request accepts the following data in JSON format\.
** [schemaArn](#API_DescribeSchema_RequestSyntax) ** <a name="personalize-DescribeSchema-request-schemaArn"></a>
The Amazon Resource Name \(ARN\) of the schema to retrieve\.
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_DescribeSchema.md |
93f20ae4eb39-0 | ```
{
"schema": {
"creationDateTime": number,
"lastUpdatedDateTime": number,
"name": "string",
"schema": "string",
"schemaArn": "string"
}
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeSchema.md |
02f079b1ddf0-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\.
** [schema](#API_DescribeSchema_ResponseSyntax) ** <a name="personalize-DescribeSchema-response-schema"></a>
The requested schema\.
Type: [DatasetSchema](API_DatasetSchema.md) object | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeSchema.md |
11582f9a5c05-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_DescribeSchema.md |
fd5437a62d02-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/DescribeSchema)
+ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/personalize-2018-05-22/DescribeSchema)
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeSchema)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/DescribeSchema)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/DescribeSchema)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/personalize-2018-05-22/DescribeSchema)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeSchema) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeSchema.md |
fd5437a62d02-1 | + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeSchema)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeSchema) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeSchema.md |
f558f829de5e-0 | Records user interaction event data\. For more information see [PutEvents Operation](recording-events.md#event-record-api)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_UBS_PutEvents.md |
ecd2bb46fb83-0 | ```
POST /events HTTP/1.1
Content-type: application/json
{
"eventList": [
{
"eventId": "string",
"eventType": "string",
"eventValue": number,
"impression": [ "string" ],
"itemId": "string",
"properties": "string",
"recommendationId": "string",
"sentAt": number
}
],
"sessionId": "string",
"trackingId": "string",
"userId": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_UBS_PutEvents.md |
cba1ac2ba438-0 | The request does not use any URI parameters\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_UBS_PutEvents.md |
a121b95faca9-0 | The request accepts the following data in JSON format\.
** [eventList](#API_UBS_PutEvents_RequestSyntax) ** <a name="personalize-UBS_PutEvents-request-eventList"></a>
A list of event data from the session\.
Type: Array of [Event](API_UBS_Event.md) objects
Array Members: Minimum number of 1 item\. Maximum number of 10 items\.
Required: Yes
** [sessionId](#API_UBS_PutEvents_RequestSyntax) ** <a name="personalize-UBS_PutEvents-request-sessionId"></a>
The session ID associated with the user's visit\. Your application generates the sessionId when a user first visits your website or uses your application\. Amazon Personalize uses the sessionId to associate events with the user before they log in\. For more information see [PutEvents Operation](recording-events.md#event-record-api)\.
Type: String
Length Constraints: Minimum length of 1\. Maximum length of 256\.
Required: Yes
** [trackingId](#API_UBS_PutEvents_RequestSyntax) ** <a name="personalize-UBS_PutEvents-request-trackingId"></a> | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_UBS_PutEvents.md |
a121b95faca9-1 | The tracking ID for the event\. The ID is generated by a call to the [CreateEventTracker](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html) API\.
Type: String
Length Constraints: Minimum length of 1\. Maximum length of 256\.
Required: Yes
** [userId](#API_UBS_PutEvents_RequestSyntax) ** <a name="personalize-UBS_PutEvents-request-userId"></a>
The user associated with the event\.
Type: String
Length Constraints: Minimum length of 1\. Maximum length of 256\.
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_UBS_PutEvents.md |
b4ac9bbbbf2b-0 | ```
HTTP/1.1 200
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_UBS_PutEvents.md |
d527f10ff07e-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_UBS_PutEvents.md |
92f04aa6729f-0 | **InvalidInputException**
Provide a valid value for the field or parameter\.
HTTP Status Code: 400 | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_UBS_PutEvents.md |
295d760f0bd7-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-events-2018-03-22/PutEvents)
+ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/personalize-events-2018-03-22/PutEvents)
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-events-2018-03-22/PutEvents)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-events-2018-03-22/PutEvents)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-events-2018-03-22/PutEvents)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/personalize-events-2018-03-22/PutEvents) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_UBS_PutEvents.md |
295d760f0bd7-1 | + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-events-2018-03-22/PutEvents)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-events-2018-03-22/PutEvents)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-events-2018-03-22/PutEvents) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_UBS_PutEvents.md |
da485f8d037f-0 | Amazon Personalize conforms to the AWS [shared responsibility model](http://aws.amazon.com/compliance/shared-responsibility-model/), which includes regulations and guidelines for data protection\. AWS is responsible for protecting the global infrastructure that runs all the AWS services\. AWS maintains control over data hosted on this infrastructure, including the security configuration controls for handling customer content and personal data\. AWS customers and APN partners, acting either as data controllers or data processors, are responsible for any personal data that they put in the AWS Cloud\.
For data protection purposes, we recommend that you protect AWS account credentials and set up individual user accounts with AWS Identity and Access Management \(IAM\), so that each user is given only the permissions necessary to fulfill their job duties\. We also recommend that you secure your data in the following ways:
+ Use multi\-factor authentication \(MFA\) with each account\.
+ Use SSL/TLS to communicate with AWS resources\.
+ Set up API and user activity logging with AWS CloudTrail\.
+ Use AWS encryption solutions, along with all default security controls within AWS services\.
+ Use advanced managed security services such as Amazon Macie, which assists in discovering and securing personal data that is stored in Amazon Simple Storage Service \(Amazon S3\)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/data-protection.md |
da485f8d037f-1 | + Use advanced managed security services such as Amazon Macie, which assists in discovering and securing personal data that is stored in Amazon Simple Storage Service \(Amazon S3\)\.
We strongly recommend that you never put sensitive identifying information, such as your customers' account numbers, into free\-form fields such as a **Name** field\. This includes when you work with Amazon Personalize or other AWS services using the console, API, AWS CLI, or AWS SDKs\. Any data that you enter into Amazon Personalize or other services might get picked up for inclusion in diagnostic logs\. When you provide a URL to an external server, don't include credentials information in the URL to validate your request to that server\.
For more information about data protection, see the [AWS Shared Responsibility Model and GDPR](http://aws.amazon.com/blogs/security/the-aws-shared-responsibility-model-and-gdpr/) blog post on the *AWS Security Blog*\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/data-protection.md |
ce2f45e46fde-0 | Amazon Personalize uses the default Amazon S3 key \(SSE\-S3\) for server\-side encryption of Amazon Personalize data placed in your S3 buckets\. You can also use one of your own AWS Key Management Service \(AWS KMS\) keys\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/data-protection.md |
dbb517e8c088-0 | Amazon Personalize copies data out of your account and processes it in an internal AWS system\. By default, Amazon Personalize uses TLS 1\.2 with AWS certificates to encrypt data in transit\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/data-protection.md |
4643d3d9e4fc-0 | The default Amazon S3 key is managed by AWS\. It is the responsibility of the customer to manage any customer\-provided [AWS Key Management Service \(AWS KMS\)](https://docs.aws.amazon.com/kms/latest/developerguide/overview.html) keys\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/data-protection.md |
ad0c8ceca6a3-0 | The Item\-to\-item similarities \(SIMS\) recipe is based on the concept of collaborative filtering\. A SIMS model leverages user\-item interaction data to recommend items similar to a given item\. In the absence of sufficient user behavior data for an item, this recipe recommends popular items\.
This predefined recipe has the following properties:
+ **Name** – `aws-sims`
+ **Recipe Amazon Resource Name \(ARN\)** – `arn:aws:personalize:::recipe/aws-sims`
+ **Algorithm ARN** – `arn:aws:personalize:::algorithm/aws-sims`
+ **Feature transformation ARN** – `arn:aws:personalize:::feature-transformation/sims`
+ **Recipe type** – `RELATED_ITEMS`
The following table describes the hyperparameters for the SIMS 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\] | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/native-recipe-sims.md |
ad0c8ceca6a3-1 | 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 |
| popularity\_discount\_factor | Affects the balance between popularity and correlation when you calculate similarity\. If you calculate similarities to a specific item, a value of `0` makes the most popular items appear as recommendations regardless of their correlation\. A value of `1` makes most items that have co\-interactions \(shared interaction\) with the specific item appear as recommendations regardless of their popularity\. Using either extreme might create an overly long list of recommend items\. For most cases, a value around 0\.5 works best\. Default value: 0\.5 Range: \[0\.0, 1\.0\] Value type: Float HPO tunable: Yes |
| min\_cointeraction\_count | The minimum number of co\-interactions you need to calculate the similarity between a pair of items\. For example, a value of `3` means that you need three or more users who interacted with both items for the algorithm to calculate their similarity\. Default value: 3 Range: \[0, 10\] Value type: Integer HPO tunable: Yes |
| Featurization Hyperparameters | | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/native-recipe-sims.md |
ad0c8ceca6a3-2 | | 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 available data on 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\. Default value: 0\.005 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-sims.md |
ad0c8ceca6a3-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 available data on a user\. Use `max_user_history_length_percentile` to exclude a percentage of users with long history lengths\. Users with a long history 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, `min_hist_length_percentile = 0.05` and `max_hist_length_percentile = 0.95` includes all users except ones with history lengths at the bottom or top 5%\. Default value: 0\.995 Range: \[0\.0, 1\.0\] Value type: Float HPO tunable: No |
| min\_item\_interaction\_count\_percentile | The minimum percentile of item interaction counts to include in model training\. Use `min_item_interaction_count_percentile` to exclude a percentage of items with a short history of interactions\. Items with a short history often are new items\. Removing them can train models with more focus on items with a known history\. 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 items, but removes the edge cases\. Default value: 0\.01 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-sims.md |
ad0c8ceca6a3-4 | | max\_item\_interaction\_count\_percentile | The maximum percentile of item interaction counts to include in model training\. Use `max_item_interaction_count_percentile` to exclude a percentage of items with a long history of interactions\. Items with a long history tend to be older and might be out of date\. For example, a movie release that is out of print\. Removing these items can focus on more relevant items\. 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 items but removes the edge cases\. For example, `min_item_interaction_count_percentile = 0.05` and `max_item_interaction_count_percentile = 0.95` includes all items except ones with an interaction count at the bottom or top 5%\. Default value: 0\.9 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-sims.md |
f6d78b398a01-0 | For a sample Jupyter notebook that shows you how to use the SIMS recipe, see [Finding similar items \+ HPO](https://github.com/aws-samples/amazon-personalize-samples/blob/master/next_steps/core_use_cases/related_items/personalize_sims_example.ipynb)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/native-recipe-sims.md |
e5f6b10f307a-0 | Trains or retrains an active solution\. A solution is created using the [CreateSolution](API_CreateSolution.md) operation and must be in the ACTIVE state before calling `CreateSolutionVersion`\. A new version of the solution is created every time you call this operation\.
**Status**
A solution version can be in one of the following states:
+ CREATE PENDING > CREATE IN\_PROGRESS > ACTIVE \-or\- CREATE FAILED
To get the status of the version, call [DescribeSolutionVersion](API_DescribeSolutionVersion.md)\. Wait until the status shows as ACTIVE before calling `CreateCampaign`\.
If the status shows as CREATE FAILED, the response includes a `failureReason` key, which describes why the job failed\.
**Related APIs**
+ [ListSolutionVersions](API_ListSolutionVersions.md)
+ [DescribeSolutionVersion](API_DescribeSolutionVersion.md)
+ [ListSolutions](API_ListSolutions.md)
+ [CreateSolution](API_CreateSolution.md)
+ [DescribeSolution](API_DescribeSolution.md)
+ [DeleteSolution](API_DeleteSolution.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CreateSolutionVersion.md |
2553c023ad12-0 | ```
{
"solutionArn": "string",
"trainingMode": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CreateSolutionVersion.md |
3a0b37a4fe63-0 | The request accepts the following data in JSON format\.
** [solutionArn](#API_CreateSolutionVersion_RequestSyntax) ** <a name="personalize-CreateSolutionVersion-request-solutionArn"></a>
The Amazon Resource Name \(ARN\) of the solution containing the training configuration information\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
** [trainingMode](#API_CreateSolutionVersion_RequestSyntax) ** <a name="personalize-CreateSolutionVersion-request-trainingMode"></a>
The scope of training to be performed when creating the solution version\. The `FULL` option trains the solution version based on the entirety of the input solution's training data, while the `UPDATE` option processes only the data that has changed in comparison to the input solution\. Choose `UPDATE` when you want to incrementally update your solution version instead of creating an entirely new one\.
The `UPDATE` option can only be used when you already have an active solution version created from the input solution using the `FULL` option and the input solution was trained with the [User\-Personalization Recipe](native-recipe-new-item-USER_PERSONALIZATION.md) or the [HRNN\-Coldstart Recipe](native-recipe-hrnn-coldstart.md) recipe\.
Type: String
Valid Values:` FULL | UPDATE` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CreateSolutionVersion.md |
3a0b37a4fe63-1 | Type: String
Valid Values:` FULL | UPDATE`
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CreateSolutionVersion.md |
fcae896ebaf9-0 | ```
{
"solutionVersionArn": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CreateSolutionVersion.md |
b68fad10c1ab-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\.
** [solutionVersionArn](#API_CreateSolutionVersion_ResponseSyntax) ** <a name="personalize-CreateSolutionVersion-response-solutionVersionArn"></a>
The ARN of the new solution version\.
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_CreateSolutionVersion.md |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.