# API reference
This section provides documentation for the Amazon Personalize API operations. For a list of Amazon Personalize endpoints by region, see [Amazon regions and endpoints](https://docs.aws.amazon.com/general/latest/gr/personalize.html) in the *Amazon General Reference*.
**Topics**
+ [
# Actions
](API_Operations.md)
+ [
# Data Types
](API_Types.md)
+ [
# Common Error Types
](CommonErrors.md)
+ [
# Common Parameters
](CommonParameters.md)
# Actions
The following actions are supported by Amazon Personalize:
+ [CreateBatchInferenceJob](API_CreateBatchInferenceJob.md)
+ [CreateBatchSegmentJob](API_CreateBatchSegmentJob.md)
+ [CreateCampaign](API_CreateCampaign.md)
+ [CreateDataDeletionJob](API_CreateDataDeletionJob.md)
+ [CreateDataset](API_CreateDataset.md)
+ [CreateDatasetExportJob](API_CreateDatasetExportJob.md)
+ [CreateDatasetGroup](API_CreateDatasetGroup.md)
+ [CreateDatasetImportJob](API_CreateDatasetImportJob.md)
+ [CreateEventTracker](API_CreateEventTracker.md)
+ [CreateFilter](API_CreateFilter.md)
+ [CreateMetricAttribution](API_CreateMetricAttribution.md)
+ [CreateRecommender](API_CreateRecommender.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)
+ [DeleteMetricAttribution](API_DeleteMetricAttribution.md)
+ [DeleteRecommender](API_DeleteRecommender.md)
+ [DeleteSchema](API_DeleteSchema.md)
+ [DeleteSolution](API_DeleteSolution.md)
+ [DescribeAlgorithm](API_DescribeAlgorithm.md)
+ [DescribeBatchInferenceJob](API_DescribeBatchInferenceJob.md)
+ [DescribeBatchSegmentJob](API_DescribeBatchSegmentJob.md)
+ [DescribeCampaign](API_DescribeCampaign.md)
+ [DescribeDataDeletionJob](API_DescribeDataDeletionJob.md)
+ [DescribeDataset](API_DescribeDataset.md)
+ [DescribeDatasetExportJob](API_DescribeDatasetExportJob.md)
+ [DescribeDatasetGroup](API_DescribeDatasetGroup.md)
+ [DescribeDatasetImportJob](API_DescribeDatasetImportJob.md)
+ [DescribeEventTracker](API_DescribeEventTracker.md)
+ [DescribeFeatureTransformation](API_DescribeFeatureTransformation.md)
+ [DescribeFilter](API_DescribeFilter.md)
+ [DescribeMetricAttribution](API_DescribeMetricAttribution.md)
+ [DescribeRecipe](API_DescribeRecipe.md)
+ [DescribeRecommender](API_DescribeRecommender.md)
+ [DescribeSchema](API_DescribeSchema.md)
+ [DescribeSolution](API_DescribeSolution.md)
+ [DescribeSolutionVersion](API_DescribeSolutionVersion.md)
+ [GetSolutionMetrics](API_GetSolutionMetrics.md)
+ [ListBatchInferenceJobs](API_ListBatchInferenceJobs.md)
+ [ListBatchSegmentJobs](API_ListBatchSegmentJobs.md)
+ [ListCampaigns](API_ListCampaigns.md)
+ [ListDataDeletionJobs](API_ListDataDeletionJobs.md)
+ [ListDatasetExportJobs](API_ListDatasetExportJobs.md)
+ [ListDatasetGroups](API_ListDatasetGroups.md)
+ [ListDatasetImportJobs](API_ListDatasetImportJobs.md)
+ [ListDatasets](API_ListDatasets.md)
+ [ListEventTrackers](API_ListEventTrackers.md)
+ [ListFilters](API_ListFilters.md)
+ [ListMetricAttributionMetrics](API_ListMetricAttributionMetrics.md)
+ [ListMetricAttributions](API_ListMetricAttributions.md)
+ [ListRecipes](API_ListRecipes.md)
+ [ListRecommenders](API_ListRecommenders.md)
+ [ListSchemas](API_ListSchemas.md)
+ [ListSolutions](API_ListSolutions.md)
+ [ListSolutionVersions](API_ListSolutionVersions.md)
+ [ListTagsForResource](API_ListTagsForResource.md)
+ [StartRecommender](API_StartRecommender.md)
+ [StopRecommender](API_StopRecommender.md)
+ [StopSolutionVersionCreation](API_StopSolutionVersionCreation.md)
+ [TagResource](API_TagResource.md)
+ [UntagResource](API_UntagResource.md)
+ [UpdateCampaign](API_UpdateCampaign.md)
+ [UpdateDataset](API_UpdateDataset.md)
+ [UpdateMetricAttribution](API_UpdateMetricAttribution.md)
+ [UpdateRecommender](API_UpdateRecommender.md)
+ [UpdateSolution](API_UpdateSolution.md)
The following actions are supported by Amazon Personalize Events:
+ [PutActionInteractions](API_UBS_PutActionInteractions.md)
+ [PutActions](API_UBS_PutActions.md)
+ [PutEvents](API_UBS_PutEvents.md)
+ [PutItems](API_UBS_PutItems.md)
+ [PutUsers](API_UBS_PutUsers.md)
The following actions are supported by Amazon Personalize Runtime:
+ [GetActionRecommendations](API_RS_GetActionRecommendations.md)
+ [GetPersonalizedRanking](API_RS_GetPersonalizedRanking.md)
+ [GetRecommendations](API_RS_GetRecommendations.md)
# Amazon Personalize
The following actions are supported by Amazon Personalize:
+ [CreateBatchInferenceJob](API_CreateBatchInferenceJob.md)
+ [CreateBatchSegmentJob](API_CreateBatchSegmentJob.md)
+ [CreateCampaign](API_CreateCampaign.md)
+ [CreateDataDeletionJob](API_CreateDataDeletionJob.md)
+ [CreateDataset](API_CreateDataset.md)
+ [CreateDatasetExportJob](API_CreateDatasetExportJob.md)
+ [CreateDatasetGroup](API_CreateDatasetGroup.md)
+ [CreateDatasetImportJob](API_CreateDatasetImportJob.md)
+ [CreateEventTracker](API_CreateEventTracker.md)
+ [CreateFilter](API_CreateFilter.md)
+ [CreateMetricAttribution](API_CreateMetricAttribution.md)
+ [CreateRecommender](API_CreateRecommender.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)
+ [DeleteMetricAttribution](API_DeleteMetricAttribution.md)
+ [DeleteRecommender](API_DeleteRecommender.md)
+ [DeleteSchema](API_DeleteSchema.md)
+ [DeleteSolution](API_DeleteSolution.md)
+ [DescribeAlgorithm](API_DescribeAlgorithm.md)
+ [DescribeBatchInferenceJob](API_DescribeBatchInferenceJob.md)
+ [DescribeBatchSegmentJob](API_DescribeBatchSegmentJob.md)
+ [DescribeCampaign](API_DescribeCampaign.md)
+ [DescribeDataDeletionJob](API_DescribeDataDeletionJob.md)
+ [DescribeDataset](API_DescribeDataset.md)
+ [DescribeDatasetExportJob](API_DescribeDatasetExportJob.md)
+ [DescribeDatasetGroup](API_DescribeDatasetGroup.md)
+ [DescribeDatasetImportJob](API_DescribeDatasetImportJob.md)
+ [DescribeEventTracker](API_DescribeEventTracker.md)
+ [DescribeFeatureTransformation](API_DescribeFeatureTransformation.md)
+ [DescribeFilter](API_DescribeFilter.md)
+ [DescribeMetricAttribution](API_DescribeMetricAttribution.md)
+ [DescribeRecipe](API_DescribeRecipe.md)
+ [DescribeRecommender](API_DescribeRecommender.md)
+ [DescribeSchema](API_DescribeSchema.md)
+ [DescribeSolution](API_DescribeSolution.md)
+ [DescribeSolutionVersion](API_DescribeSolutionVersion.md)
+ [GetSolutionMetrics](API_GetSolutionMetrics.md)
+ [ListBatchInferenceJobs](API_ListBatchInferenceJobs.md)
+ [ListBatchSegmentJobs](API_ListBatchSegmentJobs.md)
+ [ListCampaigns](API_ListCampaigns.md)
+ [ListDataDeletionJobs](API_ListDataDeletionJobs.md)
+ [ListDatasetExportJobs](API_ListDatasetExportJobs.md)
+ [ListDatasetGroups](API_ListDatasetGroups.md)
+ [ListDatasetImportJobs](API_ListDatasetImportJobs.md)
+ [ListDatasets](API_ListDatasets.md)
+ [ListEventTrackers](API_ListEventTrackers.md)
+ [ListFilters](API_ListFilters.md)
+ [ListMetricAttributionMetrics](API_ListMetricAttributionMetrics.md)
+ [ListMetricAttributions](API_ListMetricAttributions.md)
+ [ListRecipes](API_ListRecipes.md)
+ [ListRecommenders](API_ListRecommenders.md)
+ [ListSchemas](API_ListSchemas.md)
+ [ListSolutions](API_ListSolutions.md)
+ [ListSolutionVersions](API_ListSolutionVersions.md)
+ [ListTagsForResource](API_ListTagsForResource.md)
+ [StartRecommender](API_StartRecommender.md)
+ [StopRecommender](API_StopRecommender.md)
+ [StopSolutionVersionCreation](API_StopSolutionVersionCreation.md)
+ [TagResource](API_TagResource.md)
+ [UntagResource](API_UntagResource.md)
+ [UpdateCampaign](API_UpdateCampaign.md)
+ [UpdateDataset](API_UpdateDataset.md)
+ [UpdateMetricAttribution](API_UpdateMetricAttribution.md)
+ [UpdateRecommender](API_UpdateRecommender.md)
+ [UpdateSolution](API_UpdateSolution.md)
# CreateBatchInferenceJob
Generates batch recommendations based on a list of items or users stored in Amazon S3 and exports the recommendations to an Amazon S3 bucket.
To generate batch recommendations, specify the ARN of a solution version and an Amazon S3 URI for the input and output data. For user personalization, popular items, and personalized ranking solutions, the batch inference job generates a list of recommended items for each user ID in the input file. For related items solutions, the job generates a list of recommended items for each item ID in the input file.
For more information, see [Creating a batch inference job ](https://docs.amazonaws.cn/personalize/latest/dg/getting-batch-recommendations.html).
If you use the Similar-Items recipe, Amazon Personalize can add descriptive themes to batch recommendations. To generate themes, set the job's mode to `THEME_GENERATION` and specify the name of the field that contains item names in the input data.
For more information about generating themes, see [Batch recommendations with themes from Content Generator ](https://docs.amazonaws.cn/personalize/latest/dg/themed-batch-recommendations.html).
You can't get batch recommendations with the Trending-Now or Next-Best-Action recipes.
## Request Syntax
```
{
"batchInferenceJobConfig": {
"itemExplorationConfig": {
"string" : "string"
},
"rankingInfluence": {
"string" : number
}
},
"batchInferenceJobMode": "string",
"filterArn": "string",
"jobInput": {
"s3DataSource": {
"kmsKeyArn": "string",
"path": "string"
}
},
"jobName": "string",
"jobOutput": {
"s3DataDestination": {
"kmsKeyArn": "string",
"path": "string"
}
},
"numResults": number,
"roleArn": "string",
"solutionVersionArn": "string",
"tags": [
{
"tagKey": "string",
"tagValue": "string"
}
],
"themeGenerationConfig": {
"fieldsForThemeGeneration": {
"itemName": "string"
}
}
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [batchInferenceJobConfig](#API_CreateBatchInferenceJob_RequestSyntax) **
The configuration details of a batch inference job.
Type: [BatchInferenceJobConfig](API_BatchInferenceJobConfig.md) object
Required: No
** [batchInferenceJobMode](#API_CreateBatchInferenceJob_RequestSyntax) **
The mode of the batch inference job. To generate descriptive themes for groups of similar items, set the job mode to `THEME_GENERATION`. If you don't want to generate themes, use the default `BATCH_INFERENCE`.
When you get batch recommendations with themes, you will incur additional costs. For more information, see [Amazon Personalize pricing](https://aws.amazon.com/personalize/pricing/).
Type: String
Valid Values: `BATCH_INFERENCE | THEME_GENERATION`
Required: No
** [filterArn](#API_CreateBatchInferenceJob_RequestSyntax) **
The ARN of the filter to apply to the batch inference job. For more information on using filters, see [Filtering batch recommendations](https://docs.amazonaws.cn/personalize/latest/dg/filter-batch.html).
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** [jobInput](#API_CreateBatchInferenceJob_RequestSyntax) **
The Amazon S3 path that leads to the input file to base your recommendations on. The input material must be in JSON format.
Type: [BatchInferenceJobInput](API_BatchInferenceJobInput.md) object
Required: Yes
** [jobName](#API_CreateBatchInferenceJob_RequestSyntax) **
The name of the batch inference job to create.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: Yes
** [jobOutput](#API_CreateBatchInferenceJob_RequestSyntax) **
The path to the Amazon S3 bucket where the job's output will be stored.
Type: [BatchInferenceJobOutput](API_BatchInferenceJobOutput.md) object
Required: Yes
** [numResults](#API_CreateBatchInferenceJob_RequestSyntax) **
The number of recommendations to retrieve.
Type: Integer
Required: No
** [roleArn](#API_CreateBatchInferenceJob_RequestSyntax) **
The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`
Required: Yes
** [solutionVersionArn](#API_CreateBatchInferenceJob_RequestSyntax) **
The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
** [tags](#API_CreateBatchInferenceJob_RequestSyntax) **
A list of [tags](https://docs.amazonaws.cn/personalize/latest/dg/tagging-resources.html) to apply to the batch inference job.
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
** [themeGenerationConfig](#API_CreateBatchInferenceJob_RequestSyntax) **
For theme generation jobs, specify the name of the column in your Items dataset that contains each item's name.
Type: [ThemeGenerationConfig](API_ThemeGenerationConfig.md) object
Required: No
## Response Syntax
```
{
"batchInferenceJobArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [batchInferenceJobArn](#API_CreateBatchInferenceJob_ResponseSyntax) **
The ARN of the batch inference job.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
## Errors
** 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
** TooManyTagsException **
You have exceeded the maximum number of tags you can apply to this resource.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/CreateBatchInferenceJob)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/CreateBatchInferenceJob)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/CreateBatchInferenceJob)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/CreateBatchInferenceJob)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/CreateBatchInferenceJob)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateBatchInferenceJob)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/CreateBatchInferenceJob)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/CreateBatchInferenceJob)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/CreateBatchInferenceJob)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/CreateBatchInferenceJob)
# CreateBatchSegmentJob
Creates a batch segment job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see [Getting batch recommendations and user segments](https://docs.amazonaws.cn/personalize/latest/dg/recommendations-batch.html).
## Request Syntax
```
{
"filterArn": "string",
"jobInput": {
"s3DataSource": {
"kmsKeyArn": "string",
"path": "string"
}
},
"jobName": "string",
"jobOutput": {
"s3DataDestination": {
"kmsKeyArn": "string",
"path": "string"
}
},
"numResults": number,
"roleArn": "string",
"solutionVersionArn": "string",
"tags": [
{
"tagKey": "string",
"tagValue": "string"
}
]
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [filterArn](#API_CreateBatchSegmentJob_RequestSyntax) **
The ARN of the filter to apply to the batch segment job. For more information on using filters, see [Filtering batch recommendations](https://docs.amazonaws.cn/personalize/latest/dg/filter-batch.html).
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** [jobInput](#API_CreateBatchSegmentJob_RequestSyntax) **
The Amazon S3 path for the input data used to generate the batch segment job.
Type: [BatchSegmentJobInput](API_BatchSegmentJobInput.md) object
Required: Yes
** [jobName](#API_CreateBatchSegmentJob_RequestSyntax) **
The name of the batch segment job to create.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: Yes
** [jobOutput](#API_CreateBatchSegmentJob_RequestSyntax) **
The Amazon S3 path for the bucket where the job's output will be stored.
Type: [BatchSegmentJobOutput](API_BatchSegmentJobOutput.md) object
Required: Yes
** [numResults](#API_CreateBatchSegmentJob_RequestSyntax) **
The number of predicted users generated by the batch segment job for each line of input data. The maximum number of users per segment is 5 million.
Type: Integer
Required: No
** [roleArn](#API_CreateBatchSegmentJob_RequestSyntax) **
The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`
Required: Yes
** [solutionVersionArn](#API_CreateBatchSegmentJob_RequestSyntax) **
The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate batch segments.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
** [tags](#API_CreateBatchSegmentJob_RequestSyntax) **
A list of [tags](https://docs.amazonaws.cn/personalize/latest/dg/tagging-resources.html) to apply to the batch segment job.
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
## Response Syntax
```
{
"batchSegmentJobArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [batchSegmentJobArn](#API_CreateBatchSegmentJob_ResponseSyntax) **
The ARN of the batch segment job.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
## Errors
** 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
** TooManyTagsException **
You have exceeded the maximum number of tags you can apply to this resource.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/CreateBatchSegmentJob)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/CreateBatchSegmentJob)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/CreateBatchSegmentJob)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/CreateBatchSegmentJob)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/CreateBatchSegmentJob)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateBatchSegmentJob)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/CreateBatchSegmentJob)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/CreateBatchSegmentJob)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/CreateBatchSegmentJob)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/CreateBatchSegmentJob)
# CreateCampaign
**Important**
You incur campaign costs while it is active. To avoid unnecessary costs, make sure to delete the campaign when you are finished. For information about campaign costs, see [Amazon Personalize pricing](https://aws.amazon.com/personalize/pricing/).
Creates a campaign that deploys a solution version. When a client calls the [GetRecommendations](https://docs.amazonaws.cn/personalize/latest/dg/API_RS_GetRecommendations.html) and [GetPersonalizedRanking](https://docs.amazonaws.cn/personalize/latest/dg/API_RS_GetPersonalizedRanking.html) APIs, a campaign is specified in the request.
**Minimum Provisioned TPS and Auto-Scaling**
**Important**
A high `minProvisionedTPS` will increase your cost. We recommend starting with 1 for `minProvisionedTPS` (the default). Track your usage using Amazon CloudWatch metrics, and increase the `minProvisionedTPS` as necessary.
When you create an Amazon Personalize campaign, you can specify the minimum provisioned transactions per second (`minProvisionedTPS`) for the campaign. This is the baseline transaction throughput for the campaign provisioned by Amazon Personalize. It sets the minimum billing charge for the campaign while it is active. A transaction is a single `GetRecommendations` or `GetPersonalizedRanking` request. The default `minProvisionedTPS` is 1.
If your TPS increases beyond the `minProvisionedTPS`, Amazon Personalize auto-scales the provisioned capacity up and down, but never below `minProvisionedTPS`. There's a short time delay while the capacity is increased that might cause loss of transactions. When your traffic reduces, capacity returns to the `minProvisionedTPS`.
You are charged for the the minimum provisioned TPS or, if your requests exceed the `minProvisionedTPS`, the actual TPS. The actual TPS is the total number of recommendation requests you make. We recommend starting with a low `minProvisionedTPS`, track your usage using Amazon CloudWatch metrics, and then increase the `minProvisionedTPS` as necessary.
For more information about campaign costs, see [Amazon Personalize pricing](https://aws.amazon.com/personalize/pricing/).
**Status**
A campaign can be in one of the following states:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
To get the campaign status, call [DescribeCampaign](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeCampaign.html).
**Note**
Wait until the `status` of the campaign is `ACTIVE` before asking the campaign for recommendations.
**Related APIs**
+ [ListCampaigns](https://docs.amazonaws.cn/personalize/latest/dg/API_ListCampaigns.html)
+ [DescribeCampaign](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeCampaign.html)
+ [UpdateCampaign](https://docs.amazonaws.cn/personalize/latest/dg/API_UpdateCampaign.html)
+ [DeleteCampaign](https://docs.amazonaws.cn/personalize/latest/dg/API_DeleteCampaign.html)
## Request Syntax
```
{
"campaignConfig": {
"enableMetadataWithRecommendations": boolean,
"itemExplorationConfig": {
"string" : "string"
},
"rankingInfluence": {
"string" : number
},
"syncWithLatestSolutionVersion": boolean
},
"minProvisionedTPS": number,
"name": "string",
"solutionVersionArn": "string",
"tags": [
{
"tagKey": "string",
"tagValue": "string"
}
]
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [campaignConfig](#API_CreateCampaign_RequestSyntax) **
The configuration details of a campaign.
Type: [CampaignConfig](API_CampaignConfig.md) object
Required: No
** [minProvisionedTPS](#API_CreateCampaign_RequestSyntax) **
Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support. A high `minProvisionedTPS` will increase your bill. We recommend starting with 1 for `minProvisionedTPS` (the default). Track your usage using Amazon CloudWatch metrics, and increase the `minProvisionedTPS` as necessary.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
** [name](#API_CreateCampaign_RequestSyntax) **
A name for the new campaign. The campaign name must be unique within your account.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: Yes
** [solutionVersionArn](#API_CreateCampaign_RequestSyntax) **
The Amazon Resource Name (ARN) of the trained model to deploy with the campaign. To specify the latest solution version of your solution, specify the ARN of your *solution* in `SolutionArn/$LATEST` format. You must use this format if you set `syncWithLatestSolutionVersion` to `True` in the [CampaignConfig](https://docs.amazonaws.cn/personalize/latest/dg/API_CampaignConfig.html).
To deploy a model that isn't the latest solution version of your solution, specify the ARN of the solution version.
For more information about automatic campaign updates, see [Enabling automatic campaign updates](https://docs.amazonaws.cn/personalize/latest/dg/campaigns.html#create-campaign-automatic-latest-sv-update).
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
** [tags](#API_CreateCampaign_RequestSyntax) **
A list of [tags](https://docs.amazonaws.cn/personalize/latest/dg/tagging-resources.html) to apply to the campaign.
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
## Response Syntax
```
{
"campaignArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [campaignArn](#API_CreateCampaign_ResponseSyntax) **
The Amazon Resource Name (ARN) of the campaign.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
## Errors
** 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
** TooManyTagsException **
You have exceeded the maximum number of tags you can apply to this resource.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/CreateCampaign)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/CreateCampaign)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/CreateCampaign)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/CreateCampaign)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/CreateCampaign)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateCampaign)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/CreateCampaign)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/CreateCampaign)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/CreateCampaign)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/CreateCampaign)
# CreateDataDeletionJob
Creates a batch job that deletes all references to specific users from an Amazon Personalize dataset group in batches. You specify the users to delete in a CSV file of userIds in an Amazon S3 bucket. After a job completes, Amazon Personalize no longer trains on the users’ data and no longer considers the users when generating user segments. For more information about creating a data deletion job, see [Deleting users](https://docs.amazonaws.cn/personalize/latest/dg/delete-records.html).
+ Your input file must be a CSV file with a single USER\$1ID column that lists the users IDs. For more information about preparing the CSV file, see [Preparing your data deletion file and uploading it to Amazon S3](https://docs.amazonaws.cn/personalize/latest/dg/prepare-deletion-input-file.html).
+ To give Amazon Personalize permission to access your input CSV file of userIds, you must specify an IAM service role that has permission to read from the data source. This role needs `GetObject` and `ListBucket` permissions for the bucket and its content. These permissions are the same as importing data. For information on granting access to your Amazon S3 bucket, see [Giving Amazon Personalize Access to Amazon S3 Resources](https://docs.amazonaws.cn/personalize/latest/dg/granting-personalize-s3-access.html).
After you create a job, it can take up to a day to delete all references to the users from datasets and models. Until the job completes, Amazon Personalize continues to use the data when training. And if you use a User Segmentation recipe, the users might appear in user segments.
**Status**
A data deletion job can have one of the following statuses:
+ PENDING > IN\$1PROGRESS > COMPLETED -or- FAILED
To get the status of the data deletion job, call [DescribeDataDeletionJob](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeDataDeletionJob.html) API operation and specify the Amazon Resource Name (ARN) of the job. If the status is FAILED, the response includes a `failureReason` key, which describes why the job failed.
**Related APIs**
+ [ListDataDeletionJobs](https://docs.amazonaws.cn/personalize/latest/dg/API_ListDataDeletionJobs.html)
+ [DescribeDataDeletionJob](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeDataDeletionJob.html)
## Request Syntax
```
{
"datasetGroupArn": "string",
"dataSource": {
"dataLocation": "string"
},
"jobName": "string",
"roleArn": "string",
"tags": [
{
"tagKey": "string",
"tagValue": "string"
}
]
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [datasetGroupArn](#API_CreateDataDeletionJob_RequestSyntax) **
The Amazon Resource Name (ARN) of the dataset group that has the datasets you want to delete records from.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
** [dataSource](#API_CreateDataDeletionJob_RequestSyntax) **
The Amazon S3 bucket that contains the list of userIds of the users to delete.
Type: [DataSource](API_DataSource.md) object
Required: Yes
** [jobName](#API_CreateDataDeletionJob_RequestSyntax) **
The name for the data deletion job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: Yes
** [roleArn](#API_CreateDataDeletionJob_RequestSyntax) **
The Amazon Resource Name (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
** [tags](#API_CreateDataDeletionJob_RequestSyntax) **
A list of [tags](https://docs.amazonaws.cn/personalize/latest/dg/tagging-resources.html) to apply to the data deletion job.
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
## Response Syntax
```
{
"dataDeletionJobArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [dataDeletionJobArn](#API_CreateDataDeletionJob_ResponseSyntax) **
The Amazon Resource Name (ARN) of the data deletion job.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
## Errors
** 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
** TooManyTagsException **
You have exceeded the maximum number of tags you can apply to this resource.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/CreateDataDeletionJob)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/CreateDataDeletionJob)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/CreateDataDeletionJob)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/CreateDataDeletionJob)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/CreateDataDeletionJob)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateDataDeletionJob)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/CreateDataDeletionJob)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/CreateDataDeletionJob)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/CreateDataDeletionJob)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/CreateDataDeletionJob)
# CreateDataset
Creates an empty dataset and adds it to the specified dataset group. Use [CreateDatasetImportJob](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateDatasetImportJob.html) to import your training data to a dataset.
There are 5 types of datasets:
+ Item interactions
+ Items
+ Users
+ Action interactions
+ Actions
Each dataset type has an associated schema with required field types. Only the `Item interactions` dataset is required in order to train a model (also referred to as creating a solution).
A dataset can be in one of the following states:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
To get the status of the dataset, call [DescribeDataset](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeDataset.html).
**Related APIs**
+ [CreateDatasetGroup](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateDatasetGroup.html)
+ [ListDatasets](https://docs.amazonaws.cn/personalize/latest/dg/API_ListDatasets.html)
+ [DescribeDataset](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeDataset.html)
+ [DeleteDataset](https://docs.amazonaws.cn/personalize/latest/dg/API_DeleteDataset.html)
## Request Syntax
```
{
"datasetGroupArn": "string",
"datasetType": "string",
"name": "string",
"schemaArn": "string",
"tags": [
{
"tagKey": "string",
"tagValue": "string"
}
]
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [datasetGroupArn](#API_CreateDataset_RequestSyntax) **
The Amazon Resource Name (ARN) of the dataset group to add the dataset to.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
** [datasetType](#API_CreateDataset_RequestSyntax) **
The type of dataset.
One of the following (case insensitive) values:
+ Interactions
+ Items
+ Users
+ Actions
+ Action\$1Interactions
Type: String
Length Constraints: Maximum length of 256.
Pattern: `^[A-Za-z_]+$`
Required: Yes
** [name](#API_CreateDataset_RequestSyntax) **
The name for the dataset.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: Yes
** [schemaArn](#API_CreateDataset_RequestSyntax) **
The ARN of the schema to associate with the dataset. The schema defines the dataset fields.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
** [tags](#API_CreateDataset_RequestSyntax) **
A list of [tags](https://docs.amazonaws.cn/personalize/latest/dg/tagging-resources.html) to apply to the dataset.
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
## Response Syntax
```
{
"datasetArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [datasetArn](#API_CreateDataset_ResponseSyntax) **
The ARN of the dataset.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
## Errors
** 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
** TooManyTagsException **
You have exceeded the maximum number of tags you can apply to this resource.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/CreateDataset)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/CreateDataset)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/CreateDataset)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/CreateDataset)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/CreateDataset)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateDataset)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/CreateDataset)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/CreateDataset)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/CreateDataset)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/CreateDataset)
# CreateDatasetExportJob
Creates a job that exports data from your dataset to an Amazon S3 bucket. To allow Amazon Personalize to export the training data, you must specify an service-linked IAM role that gives Amazon Personalize `PutObject` permissions for your Amazon S3 bucket. For information, see [Exporting a dataset](https://docs.amazonaws.cn/personalize/latest/dg/export-data.html) in the Amazon Personalize developer guide.
**Status**
A dataset export job can be in one of the following states:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
To get the status of the export job, call [DescribeDatasetExportJob](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeDatasetExportJob.html), and specify the Amazon Resource Name (ARN) of the dataset export job. The dataset export 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.
## Request Syntax
```
{
"datasetArn": "string",
"ingestionMode": "string",
"jobName": "string",
"jobOutput": {
"s3DataDestination": {
"kmsKeyArn": "string",
"path": "string"
}
},
"roleArn": "string",
"tags": [
{
"tagKey": "string",
"tagValue": "string"
}
]
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [datasetArn](#API_CreateDatasetExportJob_RequestSyntax) **
The Amazon Resource Name (ARN) of the dataset that contains the data to export.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
** [ingestionMode](#API_CreateDatasetExportJob_RequestSyntax) **
The data to export, based on how you imported the data. You can choose to export only `BULK` data that you imported using a dataset import job, only `PUT` data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or `ALL` for both types. The default value is `PUT`.
Type: String
Valid Values: `BULK | PUT | ALL`
Required: No
** [jobName](#API_CreateDatasetExportJob_RequestSyntax) **
The name for the dataset export job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: Yes
** [jobOutput](#API_CreateDatasetExportJob_RequestSyntax) **
The path to the Amazon S3 bucket where the job's output is stored.
Type: [DatasetExportJobOutput](API_DatasetExportJobOutput.md) object
Required: Yes
** [roleArn](#API_CreateDatasetExportJob_RequestSyntax) **
The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`
Required: Yes
** [tags](#API_CreateDatasetExportJob_RequestSyntax) **
A list of [tags](https://docs.amazonaws.cn/personalize/latest/dg/tagging-resources.html) to apply to the dataset export job.
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
## Response Syntax
```
{
"datasetExportJobArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [datasetExportJobArn](#API_CreateDatasetExportJob_ResponseSyntax) **
The Amazon Resource Name (ARN) of the dataset export job.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
## Errors
** 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
** TooManyTagsException **
You have exceeded the maximum number of tags you can apply to this resource.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/CreateDatasetExportJob)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/CreateDatasetExportJob)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/CreateDatasetExportJob)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/CreateDatasetExportJob)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/CreateDatasetExportJob)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateDatasetExportJob)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/CreateDatasetExportJob)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/CreateDatasetExportJob)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/CreateDatasetExportJob)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/CreateDatasetExportJob)
# CreateDatasetGroup
Creates an empty dataset group. A dataset group is a container for Amazon Personalize resources. A dataset group can contain at most three datasets, one for each type of dataset:
+ Item interactions
+ Items
+ Users
+ Actions
+ Action interactions
A dataset group can be a Domain dataset group, where you specify a domain and use pre-configured resources like recommenders, or a Custom dataset group, where you use custom resources, such as a solution with a solution version, that you deploy with a campaign. If you start with a Domain dataset group, you can still add custom resources such as solutions and solution versions trained with recipes for custom use cases and deployed with campaigns.
A dataset group can be in one of the following states:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING
To get the status of the dataset group, call [DescribeDatasetGroup](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeDatasetGroup.html). If the status shows as CREATE FAILED, the response includes a `failureReason` key, which describes why the creation failed.
**Note**
You must wait until the `status` of the dataset group is `ACTIVE` before adding a dataset to the group.
You can specify an Amazon Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an Amazon Identity and Access Management (IAM) role that has permission to access the key.
**APIs that require a dataset group ARN in the request**
+ [CreateDataset](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateDataset.html)
+ [CreateEventTracker](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateEventTracker.html)
+ [CreateSolution](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateSolution.html)
**Related APIs**
+ [ListDatasetGroups](https://docs.amazonaws.cn/personalize/latest/dg/API_ListDatasetGroups.html)
+ [DescribeDatasetGroup](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeDatasetGroup.html)
+ [DeleteDatasetGroup](https://docs.amazonaws.cn/personalize/latest/dg/API_DeleteDatasetGroup.html)
## Request Syntax
```
{
"domain": "string",
"kmsKeyArn": "string",
"name": "string",
"roleArn": "string",
"tags": [
{
"tagKey": "string",
"tagValue": "string"
}
]
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [domain](#API_CreateDatasetGroup_RequestSyntax) **
The domain of the dataset group. Specify a domain to create a Domain dataset group. The domain you specify determines the default schemas for datasets and the use cases available for recommenders. If you don't specify a domain, you create a Custom dataset group with solution versions that you deploy with a campaign.
Type: String
Valid Values: `ECOMMERCE | VIDEO_ON_DEMAND`
Required: No
** [kmsKeyArn](#API_CreateDatasetGroup_RequestSyntax) **
The Amazon Resource Name (ARN) of a Amazon Key Management Service (KMS) key used to encrypt the datasets.
Type: String
Length Constraints: Maximum length of 2048.
Pattern: `arn:aws.*:kms:.*:[0-9]{12}:key/.*`
Required: No
** [name](#API_CreateDatasetGroup_RequestSyntax) **
The name for the new dataset group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: Yes
** [roleArn](#API_CreateDatasetGroup_RequestSyntax) **
The ARN of the Amazon Identity and Access Management (IAM) role that has permissions to access the Amazon Key Management Service (KMS) key. Supplying an IAM role is only valid when also specifying a KMS key.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`
Required: No
** [tags](#API_CreateDatasetGroup_RequestSyntax) **
A list of [tags](https://docs.amazonaws.cn/personalize/latest/dg/tagging-resources.html) to apply to the dataset group.
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
## Response Syntax
```
{
"datasetGroupArn": "string",
"domain": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [datasetGroupArn](#API_CreateDatasetGroup_ResponseSyntax) **
The Amazon Resource Name (ARN) of the new dataset group.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
** [domain](#API_CreateDatasetGroup_ResponseSyntax) **
The domain for the new Domain dataset group.
Type: String
Valid Values: `ECOMMERCE | VIDEO_ON_DEMAND`
## Errors
** 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
** TooManyTagsException **
You have exceeded the maximum number of tags you can apply to this resource.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/CreateDatasetGroup)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/CreateDatasetGroup)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/CreateDatasetGroup)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/CreateDatasetGroup)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/CreateDatasetGroup)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateDatasetGroup)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/CreateDatasetGroup)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/CreateDatasetGroup)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/CreateDatasetGroup)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/CreateDatasetGroup)
# CreateDatasetImportJob
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 IAM service role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it internally. For information on granting access to your Amazon S3 bucket, see [Giving Amazon Personalize Access to Amazon S3 Resources](https://docs.amazonaws.cn/personalize/latest/dg/granting-personalize-s3-access.html).
If you already created a recommender or deployed a custom solution version with a campaign, how new bulk records influence recommendations depends on the domain use case or recipe that you use. For more information, see [How new data influences real-time recommendations](https://docs.amazonaws.cn/personalize/latest/dg/how-new-data-influences-recommendations.html).
**Important**
By default, a dataset import job replaces any existing data in the dataset that you imported in bulk. To add new records without replacing existing data, specify INCREMENTAL for the import mode in the CreateDatasetImportJob operation.
**Status**
A dataset import job can be in one of the following states:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
To get the status of the import job, call [DescribeDatasetImportJob](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeDatasetImportJob.html), 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](https://docs.amazonaws.cn/personalize/latest/dg/API_ListDatasetImportJobs.html)
+ [DescribeDatasetImportJob](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeDatasetImportJob.html)
## Request Syntax
```
{
"datasetArn": "string",
"dataSource": {
"dataLocation": "string"
},
"importMode": "string",
"jobName": "string",
"publishAttributionMetricsToS3": boolean,
"roleArn": "string",
"tags": [
{
"tagKey": "string",
"tagValue": "string"
}
]
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [datasetArn](#API_CreateDatasetImportJob_RequestSyntax) **
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) **
The Amazon S3 bucket that contains the training data to import.
Type: [DataSource](API_DataSource.md) object
Required: Yes
** [importMode](#API_CreateDatasetImportJob_RequestSyntax) **
Specify how to add the new records to an existing dataset. The default import mode is `FULL`. If you haven't imported bulk records into the dataset previously, you can only specify `FULL`.
+ Specify `FULL` to overwrite all existing bulk data in your dataset. Data you imported individually is not replaced.
+ Specify `INCREMENTAL` to append the new records to the existing data in your dataset. Amazon Personalize replaces any record with the same ID with the new one.
Type: String
Valid Values: `FULL | INCREMENTAL`
Required: No
** [jobName](#API_CreateDatasetImportJob_RequestSyntax) **
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
** [publishAttributionMetricsToS3](#API_CreateDatasetImportJob_RequestSyntax) **
If you created a metric attribution, specify whether to publish metrics for this import job to Amazon S3
Type: Boolean
Required: No
** [roleArn](#API_CreateDatasetImportJob_RequestSyntax) **
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: No
** [tags](#API_CreateDatasetImportJob_RequestSyntax) **
A list of [tags](https://docs.amazonaws.cn/personalize/latest/dg/tagging-resources.html) to apply to the dataset import job.
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
## Response Syntax
```
{
"datasetImportJobArn": "string"
}
```
## Response Elements
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) **
The ARN of the dataset import job.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
## Errors
** 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
** TooManyTagsException **
You have exceeded the maximum number of tags you can apply to this resource.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/CreateDatasetImportJob)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/CreateDatasetImportJob)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/CreateDatasetImportJob)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/CreateDatasetImportJob)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/CreateDatasetImportJob)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateDatasetImportJob)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/CreateDatasetImportJob)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/CreateDatasetImportJob)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/CreateDatasetImportJob)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/CreateDatasetImportJob)
# CreateEventTracker
Creates an event tracker that you use when adding event data to a specified dataset group using the [PutEvents](https://docs.amazonaws.cn/personalize/latest/dg/API_UBS_PutEvents.html) API.
**Note**
Only one event tracker can be associated with a dataset group. You will get an error if you call `CreateEventTracker` using the same dataset group as an existing event tracker.
When you create an event tracker, the response includes a tracking ID, which you pass as a parameter when you use the [PutEvents](https://docs.amazonaws.cn/personalize/latest/dg/API_UBS_PutEvents.html) operation. Amazon Personalize then appends the event data to the Item interactions dataset of the dataset group you specify in your event tracker.
The event tracker can be in one of the following states:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
To get the status of the event tracker, call [DescribeEventTracker](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeEventTracker.html).
**Note**
The event tracker must be in the ACTIVE state before using the tracking ID.
**Related APIs**
+ [ListEventTrackers](https://docs.amazonaws.cn/personalize/latest/dg/API_ListEventTrackers.html)
+ [DescribeEventTracker](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeEventTracker.html)
+ [DeleteEventTracker](https://docs.amazonaws.cn/personalize/latest/dg/API_DeleteEventTracker.html)
## Request Syntax
```
{
"datasetGroupArn": "string",
"name": "string",
"tags": [
{
"tagKey": "string",
"tagValue": "string"
}
]
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [datasetGroupArn](#API_CreateEventTracker_RequestSyntax) **
The Amazon Resource Name (ARN) of the dataset group that receives the event data.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
** [name](#API_CreateEventTracker_RequestSyntax) **
The name for the event tracker.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: Yes
** [tags](#API_CreateEventTracker_RequestSyntax) **
A list of [tags](https://docs.amazonaws.cn/personalize/latest/dg/tagging-resources.html) to apply to the event tracker.
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
## Response Syntax
```
{
"eventTrackerArn": "string",
"trackingId": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [eventTrackerArn](#API_CreateEventTracker_ResponseSyntax) **
The ARN of the event tracker.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
** [trackingId](#API_CreateEventTracker_ResponseSyntax) **
The ID of the event tracker. Include this ID in requests to the [PutEvents](https://docs.amazonaws.cn/personalize/latest/dg/API_UBS_PutEvents.html) API.
Type: String
Length Constraints: Maximum length of 256.
## Errors
** 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
** TooManyTagsException **
You have exceeded the maximum number of tags you can apply to this resource.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/CreateEventTracker)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/CreateEventTracker)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/CreateEventTracker)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/CreateEventTracker)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/CreateEventTracker)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateEventTracker)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/CreateEventTracker)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/CreateEventTracker)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/CreateEventTracker)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/CreateEventTracker)
# CreateFilter
Creates a recommendation filter. For more information, see [Filtering recommendations and user segments](https://docs.amazonaws.cn/personalize/latest/dg/filter.html).
## Request Syntax
```
{
"datasetGroupArn": "string",
"filterExpression": "string",
"name": "string",
"tags": [
{
"tagKey": "string",
"tagValue": "string"
}
]
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [datasetGroupArn](#API_CreateFilter_RequestSyntax) **
The ARN of the dataset group that the filter will belong to.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
** [filterExpression](#API_CreateFilter_RequestSyntax) **
The filter expression defines which items are included or excluded from recommendations. Filter expression must follow specific format rules. For information about filter expression structure and syntax, see [Filter expressions](https://docs.amazonaws.cn/personalize/latest/dg/filter-expressions.html).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2500.
Required: Yes
** [name](#API_CreateFilter_RequestSyntax) **
The name of the filter to create.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: Yes
** [tags](#API_CreateFilter_RequestSyntax) **
A list of [tags](https://docs.amazonaws.cn/personalize/latest/dg/tagging-resources.html) to apply to the filter.
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
## Response Syntax
```
{
"filterArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [filterArn](#API_CreateFilter_ResponseSyntax) **
The ARN of the new filter.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
## Errors
** 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
** ResourceNotFoundException **
Could not find the specified resource.
HTTP Status Code: 400
** TooManyTagsException **
You have exceeded the maximum number of tags you can apply to this resource.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/CreateFilter)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/CreateFilter)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/CreateFilter)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/CreateFilter)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/CreateFilter)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateFilter)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/CreateFilter)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/CreateFilter)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/CreateFilter)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/CreateFilter)
# CreateMetricAttribution
Creates a metric attribution. A metric attribution creates reports on the data that you import into Amazon Personalize. Depending on how you imported the data, you can view reports in Amazon CloudWatch or Amazon S3. For more information, see [Measuring impact of recommendations](https://docs.amazonaws.cn/personalize/latest/dg/measuring-recommendation-impact.html).
## Request Syntax
```
{
"datasetGroupArn": "string",
"metrics": [
{
"eventType": "string",
"expression": "string",
"metricName": "string"
}
],
"metricsOutputConfig": {
"roleArn": "string",
"s3DataDestination": {
"kmsKeyArn": "string",
"path": "string"
}
},
"name": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [datasetGroupArn](#API_CreateMetricAttribution_RequestSyntax) **
The Amazon Resource Name (ARN) of the destination dataset group for the metric attribution.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
** [metrics](#API_CreateMetricAttribution_RequestSyntax) **
A list of metric attributes for the metric attribution. Each metric attribute specifies an event type to track and a function. Available functions are `SUM()` or `SAMPLECOUNT()`. For SUM() functions, provide the dataset type (either Interactions or Items) and column to sum as a parameter. For example SUM(Items.PRICE).
Type: Array of [MetricAttribute](API_MetricAttribute.md) objects
Array Members: Maximum number of 10 items.
Required: Yes
** [metricsOutputConfig](#API_CreateMetricAttribution_RequestSyntax) **
The output configuration details for the metric attribution.
Type: [MetricAttributionOutput](API_MetricAttributionOutput.md) object
Required: Yes
** [name](#API_CreateMetricAttribution_RequestSyntax) **
A name for the metric attribution.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: Yes
## Response Syntax
```
{
"metricAttributionArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [metricAttributionArn](#API_CreateMetricAttribution_ResponseSyntax) **
The Amazon Resource Name (ARN) for the new metric attribution.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
## Errors
** 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
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/CreateMetricAttribution)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/CreateMetricAttribution)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/CreateMetricAttribution)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/CreateMetricAttribution)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/CreateMetricAttribution)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateMetricAttribution)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/CreateMetricAttribution)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/CreateMetricAttribution)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/CreateMetricAttribution)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/CreateMetricAttribution)
# CreateRecommender
Creates a recommender with the recipe (a Domain dataset group use case) you specify. You create recommenders for a Domain dataset group and specify the recommender's Amazon Resource Name (ARN) when you make a [GetRecommendations](https://docs.amazonaws.cn/personalize/latest/dg/API_RS_GetRecommendations.html) request.
**Minimum recommendation requests per second**
**Important**
A high `minRecommendationRequestsPerSecond` will increase your bill. We recommend starting with 1 for `minRecommendationRequestsPerSecond` (the default). Track your usage using Amazon CloudWatch metrics, and increase the `minRecommendationRequestsPerSecond` as necessary.
When you create a recommender, you can configure the recommender's minimum recommendation requests per second. The minimum recommendation requests per second (`minRecommendationRequestsPerSecond`) specifies the baseline recommendation request throughput provisioned by Amazon Personalize. The default minRecommendationRequestsPerSecond is `1`. A recommendation request is a single `GetRecommendations` operation. Request throughput is measured in requests per second and Amazon Personalize uses your requests per second to derive your requests per hour and the price of your recommender usage.
If your requests per second increases beyond `minRecommendationRequestsPerSecond`, Amazon Personalize auto-scales the provisioned capacity up and down, but never below `minRecommendationRequestsPerSecond`. There's a short time delay while the capacity is increased that might cause loss of requests.
Your bill is the greater of either the minimum requests per hour (based on minRecommendationRequestsPerSecond) or the actual number of requests. The actual request throughput used is calculated as the average requests/second within a one-hour window. We recommend starting with the default `minRecommendationRequestsPerSecond`, track your usage using Amazon CloudWatch metrics, and then increase the `minRecommendationRequestsPerSecond` as necessary.
**Status**
A recommender can be in one of the following states:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ STOP PENDING > STOP IN\$1PROGRESS > INACTIVE > START PENDING > START IN\$1PROGRESS > ACTIVE
+ DELETE PENDING > DELETE IN\$1PROGRESS
To get the recommender status, call [DescribeRecommender](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeRecommender.html).
**Note**
Wait until the `status` of the recommender is `ACTIVE` before asking the recommender for recommendations.
**Related APIs**
+ [ListRecommenders](https://docs.amazonaws.cn/personalize/latest/dg/API_ListRecommenders.html)
+ [DescribeRecommender](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeRecommender.html)
+ [UpdateRecommender](https://docs.amazonaws.cn/personalize/latest/dg/API_UpdateRecommender.html)
+ [DeleteRecommender](https://docs.amazonaws.cn/personalize/latest/dg/API_DeleteRecommender.html)
## Request Syntax
```
{
"datasetGroupArn": "string",
"name": "string",
"recipeArn": "string",
"recommenderConfig": {
"enableMetadataWithRecommendations": boolean,
"itemExplorationConfig": {
"string" : "string"
},
"minRecommendationRequestsPerSecond": number,
"trainingDataConfig": {
"excludedDatasetColumns": {
"string" : [ "string" ]
},
"includedDatasetColumns": {
"string" : [ "string" ]
}
}
},
"tags": [
{
"tagKey": "string",
"tagValue": "string"
}
]
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [datasetGroupArn](#API_CreateRecommender_RequestSyntax) **
The Amazon Resource Name (ARN) of the destination domain dataset group for the recommender.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
** [name](#API_CreateRecommender_RequestSyntax) **
The name of the recommender.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: Yes
** [recipeArn](#API_CreateRecommender_RequestSyntax) **
The Amazon Resource Name (ARN) of the recipe that the recommender will use. For a recommender, a recipe is a Domain dataset group use case. Only Domain dataset group use cases can be used to create a recommender. For information about use cases see [Choosing recommender use cases](https://docs.amazonaws.cn/personalize/latest/dg/domain-use-cases.html).
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
** [recommenderConfig](#API_CreateRecommender_RequestSyntax) **
The configuration details of the recommender.
Type: [RecommenderConfig](API_RecommenderConfig.md) object
Required: No
** [tags](#API_CreateRecommender_RequestSyntax) **
A list of [tags](https://docs.amazonaws.cn/personalize/latest/dg/tagging-resources.html) to apply to the recommender.
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
## Response Syntax
```
{
"recommenderArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [recommenderArn](#API_CreateRecommender_ResponseSyntax) **
The Amazon Resource Name (ARN) of the recommender.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
## Errors
** 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
** TooManyTagsException **
You have exceeded the maximum number of tags you can apply to this resource.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/CreateRecommender)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/CreateRecommender)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/CreateRecommender)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/CreateRecommender)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/CreateRecommender)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateRecommender)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/CreateRecommender)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/CreateRecommender)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/CreateRecommender)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/CreateRecommender)
# CreateSchema
Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format.
Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset type and has a set of required field and keywords. If you are creating a schema for a dataset in a Domain dataset group, you provide the domain of the Domain dataset group. You specify a schema when you call [CreateDataset](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateDataset.html).
For more information on schemas, see [Datasets and schemas](https://docs.amazonaws.cn/personalize/latest/dg/how-it-works-dataset-schema.html).
**Related APIs**
+ [ListSchemas](https://docs.amazonaws.cn/personalize/latest/dg/API_ListSchemas.html)
+ [DescribeSchema](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeSchema.html)
+ [DeleteSchema](https://docs.amazonaws.cn/personalize/latest/dg/API_DeleteSchema.html)
## Request Syntax
```
{
"domain": "string",
"name": "string",
"schema": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [domain](#API_CreateSchema_RequestSyntax) **
The domain for the schema. If you are creating a schema for a dataset in a Domain dataset group, specify the domain you chose when you created the Domain dataset group.
Type: String
Valid Values: `ECOMMERCE | VIDEO_ON_DEMAND`
Required: No
** [name](#API_CreateSchema_RequestSyntax) **
The name for the schema.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: Yes
** [schema](#API_CreateSchema_RequestSyntax) **
A schema in Avro JSON format.
Type: String
Length Constraints: Maximum length of 20000.
Required: Yes
## Response Syntax
```
{
"schemaArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [schemaArn](#API_CreateSchema_ResponseSyntax) **
The Amazon Resource Name (ARN) of the created schema.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
## Errors
** 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
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/CreateSchema)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/CreateSchema)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/CreateSchema)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/CreateSchema)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/CreateSchema)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateSchema)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/CreateSchema)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/CreateSchema)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/CreateSchema)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/CreateSchema)
# CreateSolution
**Important**
By default, all new solutions use automatic training. With automatic training, you incur training costs while your solution is active. To avoid unnecessary costs, when you are finished you can [update the solution](https://docs.amazonaws.cn/personalize/latest/dg/API_UpdateSolution.html) to turn off automatic training. For information about training costs, see [Amazon Personalize pricing](https://aws.amazon.com/personalize/pricing/).
Creates the configuration for training a model (creating a solution version). This configuration includes the recipe to use for model training and optional training configuration, such as columns to use in training and feature transformation parameters. For more information about configuring a solution, see [Creating and configuring a solution](https://docs.amazonaws.cn/personalize/latest/dg/customizing-solution-config.html).
By default, new solutions use automatic training to create solution versions every 7 days. You can change the training frequency. Automatic solution version creation starts within one hour after the solution is ACTIVE. If you manually create a solution version within the hour, the solution skips the first automatic training. For more information, see [Configuring automatic training](https://docs.amazonaws.cn/personalize/latest/dg/solution-config-auto-training.html).
To turn off automatic training, set `performAutoTraining` to false. If you turn off automatic training, you must manually create a solution version by calling the [CreateSolutionVersion](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateSolutionVersion.html) operation.
After training starts, you can get the solution version's Amazon Resource Name (ARN) with the [ListSolutionVersions](https://docs.amazonaws.cn/personalize/latest/dg/API_ListSolutionVersions.html) API operation. To get its status, use the [DescribeSolutionVersion](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeSolutionVersion.html).
After training completes you can evaluate model accuracy by calling [GetSolutionMetrics](https://docs.amazonaws.cn/personalize/latest/dg/API_GetSolutionMetrics.html). When you are satisfied with the solution version, you deploy it using [CreateCampaign](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateCampaign.html). The campaign provides recommendations to a client through the [GetRecommendations](https://docs.amazonaws.cn/personalize/latest/dg/API_RS_GetRecommendations.html) API.
**Note**
Amazon Personalize doesn't support configuring the `hpoObjective` for solution hyperparameter optimization at this time.
**Status**
A solution can be in one of the following states:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
To get the status of the solution, call [DescribeSolution](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeSolution.html). If you use manual training, the status must be ACTIVE before you call `CreateSolutionVersion`.
**Related APIs**
+ [UpdateSolution](https://docs.amazonaws.cn/personalize/latest/dg/API_UpdateSolution.html)
+ [ListSolutions](https://docs.amazonaws.cn/personalize/latest/dg/API_ListSolutions.html)
+ [CreateSolutionVersion](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateSolutionVersion.html)
+ [DescribeSolution](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeSolution.html)
+ [DeleteSolution](https://docs.amazonaws.cn/personalize/latest/dg/API_DeleteSolution.html)
+ [ListSolutionVersions](https://docs.amazonaws.cn/personalize/latest/dg/API_ListSolutionVersions.html)
+ [DescribeSolutionVersion](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeSolutionVersion.html)
## Request Syntax
```
{
"datasetGroupArn": "string",
"eventType": "string",
"name": "string",
"performAutoML": boolean,
"performAutoTraining": boolean,
"performHPO": boolean,
"performIncrementalUpdate": boolean,
"recipeArn": "string",
"solutionConfig": {
"algorithmHyperParameters": {
"string" : "string"
},
"autoMLConfig": {
"metricName": "string",
"recipeList": [ "string" ]
},
"autoTrainingConfig": {
"schedulingExpression": "string"
},
"eventsConfig": {
"eventParametersList": [
{
"eventType": "string",
"eventValueThreshold": number,
"weight": number
}
]
},
"eventValueThreshold": "string",
"featureTransformationParameters": {
"string" : "string"
},
"hpoConfig": {
"algorithmHyperParameterRanges": {
"categoricalHyperParameterRanges": [
{
"name": "string",
"values": [ "string" ]
}
],
"continuousHyperParameterRanges": [
{
"maxValue": number,
"minValue": number,
"name": "string"
}
],
"integerHyperParameterRanges": [
{
"maxValue": number,
"minValue": number,
"name": "string"
}
]
},
"hpoObjective": {
"metricName": "string",
"metricRegex": "string",
"type": "string"
},
"hpoResourceConfig": {
"maxNumberOfTrainingJobs": "string",
"maxParallelTrainingJobs": "string"
}
},
"optimizationObjective": {
"itemAttribute": "string",
"objectiveSensitivity": "string"
},
"trainingDataConfig": {
"excludedDatasetColumns": {
"string" : [ "string" ]
},
"includedDatasetColumns": {
"string" : [ "string" ]
}
}
},
"tags": [
{
"tagKey": "string",
"tagValue": "string"
}
]
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [datasetGroupArn](#API_CreateSolution_RequestSyntax) **
The Amazon Resource Name (ARN) of the dataset group that provides the training data.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
** [eventType](#API_CreateSolution_RequestSyntax) **
When your have multiple event types (using an `EVENT_TYPE` schema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model.
If you do not provide an `eventType`, Amazon Personalize will use all interactions for training with equal weight regardless of type.
Type: String
Length Constraints: Maximum length of 256.
Required: No
** [name](#API_CreateSolution_RequestSyntax) **
The name for the solution.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: Yes
** [performAutoML](#API_CreateSolution_RequestSyntax) **
We don't recommend enabling automated machine learning. Instead, match your use case to the available Amazon Personalize recipes. For more information, see [Choosing a recipe](https://docs.amazonaws.cn/personalize/latest/dg/working-with-predefined-recipes.html).
Whether to perform automated machine learning (AutoML). The default is `false`. For this case, you must specify `recipeArn`.
When set to `true`, Amazon Personalize analyzes your training data and selects the optimal USER\$1PERSONALIZATION recipe and hyperparameters. In this case, you must omit `recipeArn`. Amazon Personalize determines the optimal recipe by running tests with different values for the hyperparameters. AutoML lengthens the training process as compared to selecting a specific recipe.
Type: Boolean
Required: No
** [performAutoTraining](#API_CreateSolution_RequestSyntax) **
Whether the solution uses automatic training to create new solution versions (trained models). The default is `True` and the solution automatically creates new solution versions every 7 days. You can change the training frequency by specifying a `schedulingExpression` in the `AutoTrainingConfig` as part of solution configuration. For more information about automatic training, see [Configuring automatic training](https://docs.amazonaws.cn/personalize/latest/dg/solution-config-auto-training.html).
Automatic solution version creation starts within one hour after the solution is ACTIVE. If you manually create a solution version within the hour, the solution skips the first automatic training.
After training starts, you can get the solution version's Amazon Resource Name (ARN) with the [ListSolutionVersions](https://docs.amazonaws.cn/personalize/latest/dg/API_ListSolutionVersions.html) API operation. To get its status, use the [DescribeSolutionVersion](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeSolutionVersion.html).
Type: Boolean
Required: No
** [performHPO](#API_CreateSolution_RequestSyntax) **
Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is `false`.
When performing AutoML, this parameter is always `true` and you should not set it to `false`.
Type: Boolean
Required: No
** [performIncrementalUpdate](#API_CreateSolution_RequestSyntax) **
Whether to perform incremental training updates on your model. When enabled, this allows the model to learn from new data more frequently without requiring full retraining, which enables near real-time personalization. This parameter is supported only for solutions that use the semantic-similarity recipe.
Type: Boolean
Required: No
** [recipeArn](#API_CreateSolution_RequestSyntax) **
The Amazon Resource Name (ARN) of the recipe to use for model training. This is required when `performAutoML` is false. For information about different Amazon Personalize recipes and their ARNs, see [Choosing a recipe](https://docs.amazonaws.cn/personalize/latest/dg/working-with-predefined-recipes.html).
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** [solutionConfig](#API_CreateSolution_RequestSyntax) **
The configuration properties for the solution. When `performAutoML` is set to true, Amazon Personalize only evaluates the `autoMLConfig` section of the solution configuration.
Amazon Personalize doesn't support configuring the `hpoObjective` at this time.
Type: [SolutionConfig](API_SolutionConfig.md) object
Required: No
** [tags](#API_CreateSolution_RequestSyntax) **
A list of [tags](https://docs.amazonaws.cn/personalize/latest/dg/tagging-resources.html) to apply to the solution.
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
## Response Syntax
```
{
"solutionArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [solutionArn](#API_CreateSolution_ResponseSyntax) **
The ARN of the solution.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
## Errors
** 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
** TooManyTagsException **
You have exceeded the maximum number of tags you can apply to this resource.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/CreateSolution)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/CreateSolution)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/CreateSolution)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/CreateSolution)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/CreateSolution)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateSolution)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/CreateSolution)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/CreateSolution)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/CreateSolution)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/CreateSolution)
# CreateSolutionVersion
Trains or retrains an active solution in a Custom dataset group. A solution is created using the [CreateSolution](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateSolution.html) 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\$1PROGRESS
+ ACTIVE
+ CREATE FAILED
+ CREATE STOPPING
+ CREATE STOPPED
To get the status of the version, call [DescribeSolutionVersion](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeSolutionVersion.html). 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](https://docs.amazonaws.cn/personalize/latest/dg/API_ListSolutionVersions.html)
+ [DescribeSolutionVersion](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeSolutionVersion.html)
+ [ListSolutions](https://docs.amazonaws.cn/personalize/latest/dg/API_ListSolutions.html)
+ [CreateSolution](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateSolution.html)
+ [DescribeSolution](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeSolution.html)
+ [DeleteSolution](https://docs.amazonaws.cn/personalize/latest/dg/API_DeleteSolution.html)
## Request Syntax
```
{
"name": "string",
"solutionArn": "string",
"tags": [
{
"tagKey": "string",
"tagValue": "string"
}
],
"trainingMode": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [name](#API_CreateSolutionVersion_RequestSyntax) **
The name of the solution version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
** [solutionArn](#API_CreateSolutionVersion_RequestSyntax) **
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
** [tags](#API_CreateSolutionVersion_RequestSyntax) **
A list of [tags](https://docs.amazonaws.cn/personalize/latest/dg/tagging-resources.html) to apply to the solution version.
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
** [trainingMode](#API_CreateSolutionVersion_RequestSyntax) **
The scope of training to be performed when creating the solution version. The default is `FULL`. This creates a completely new model based on the entirety of the training data from the datasets in your dataset group.
If you use [User-Personalization](https://docs.amazonaws.cn/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html), you can specify a training mode of `UPDATE`. This updates the model to consider new items for recommendations. It is not a full retraining. You should still complete a full retraining weekly. If you specify `UPDATE`, Amazon Personalize will stop automatic updates for the solution version. To resume updates, create a new solution with training mode set to `FULL` and deploy it in a campaign. For more information about automatic updates, see [Automatic updates](https://docs.amazonaws.cn/personalize/latest/dg/use-case-recipe-features.html#maintaining-with-automatic-updates).
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](https://docs.amazonaws.cn/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html) recipe or the legacy [HRNN-Coldstart](https://docs.amazonaws.cn/personalize/latest/dg/native-recipe-hrnn-coldstart.html) recipe.
Type: String
Valid Values: `FULL | UPDATE | AUTOTRAIN`
Required: No
## Response Syntax
```
{
"solutionVersionArn": "string"
}
```
## Response Elements
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) **
The ARN of the new solution version.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
## Errors
** 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
** TooManyTagsException **
You have exceeded the maximum number of tags you can apply to this resource.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/CreateSolutionVersion)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/CreateSolutionVersion)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/CreateSolutionVersion)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/CreateSolutionVersion)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/CreateSolutionVersion)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/CreateSolutionVersion)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/CreateSolutionVersion)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/CreateSolutionVersion)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/CreateSolutionVersion)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/CreateSolutionVersion)
# DeleteCampaign
Removes a campaign by deleting the solution deployment. The solution that the campaign is based on is not deleted and can be redeployed when needed. A deleted campaign can no longer be specified in a [GetRecommendations](https://docs.amazonaws.cn/personalize/latest/dg/API_RS_GetRecommendations.html) request. For information on creating campaigns, see [CreateCampaign](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateCampaign.html).
## Request Syntax
```
{
"campaignArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [campaignArn](#API_DeleteCampaign_RequestSyntax) **
The Amazon Resource Name (ARN) of the campaign to delete.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** ResourceInUseException **
The specified resource is in use.
HTTP Status Code: 400
** ResourceNotFoundException **
Could not find the specified resource.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/DeleteCampaign)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/DeleteCampaign)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DeleteCampaign)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/DeleteCampaign)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DeleteCampaign)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/DeleteCampaign)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/DeleteCampaign)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/DeleteCampaign)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/DeleteCampaign)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DeleteCampaign)
# DeleteDataset
Deletes a dataset. You can't delete a dataset if an associated `DatasetImportJob` or `SolutionVersion` is in the CREATE PENDING or IN PROGRESS state. For more information about deleting datasets, see [Deleting a dataset](https://docs.amazonaws.cn/personalize/latest/dg/delete-dataset.html).
## Request Syntax
```
{
"datasetArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [datasetArn](#API_DeleteDataset_RequestSyntax) **
The Amazon Resource Name (ARN) of the dataset to delete.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** ResourceInUseException **
The specified resource is in use.
HTTP Status Code: 400
** ResourceNotFoundException **
Could not find the specified resource.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/DeleteDataset)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/DeleteDataset)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DeleteDataset)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/DeleteDataset)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DeleteDataset)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/DeleteDataset)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/DeleteDataset)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/DeleteDataset)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/DeleteDataset)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DeleteDataset)
# DeleteDatasetGroup
Deletes a dataset group. Before you delete a dataset group, you must delete the following:
+ All associated event trackers.
+ All associated solutions.
+ All datasets in the dataset group.
## Request Syntax
```
{
"datasetGroupArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [datasetGroupArn](#API_DeleteDatasetGroup_RequestSyntax) **
The ARN of the dataset group to delete.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** ResourceInUseException **
The specified resource is in use.
HTTP Status Code: 400
** ResourceNotFoundException **
Could not find the specified resource.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/DeleteDatasetGroup)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/DeleteDatasetGroup)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DeleteDatasetGroup)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/DeleteDatasetGroup)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DeleteDatasetGroup)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/DeleteDatasetGroup)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/DeleteDatasetGroup)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/DeleteDatasetGroup)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/DeleteDatasetGroup)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DeleteDatasetGroup)
# DeleteEventTracker
Deletes the event tracker. Does not delete the dataset from the dataset group. For more information on event trackers, see [CreateEventTracker](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateEventTracker.html).
## Request Syntax
```
{
"eventTrackerArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [eventTrackerArn](#API_DeleteEventTracker_RequestSyntax) **
The Amazon Resource Name (ARN) of the event tracker to delete.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** ResourceInUseException **
The specified resource is in use.
HTTP Status Code: 400
** ResourceNotFoundException **
Could not find the specified resource.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/DeleteEventTracker)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/DeleteEventTracker)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DeleteEventTracker)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/DeleteEventTracker)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DeleteEventTracker)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/DeleteEventTracker)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/DeleteEventTracker)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/DeleteEventTracker)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/DeleteEventTracker)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DeleteEventTracker)
# DeleteFilter
Deletes a filter.
## Request Syntax
```
{
"filterArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [filterArn](#API_DeleteFilter_RequestSyntax) **
The ARN of the filter to delete.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** ResourceInUseException **
The specified resource is in use.
HTTP Status Code: 400
** ResourceNotFoundException **
Could not find the specified resource.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/DeleteFilter)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/DeleteFilter)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DeleteFilter)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/DeleteFilter)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DeleteFilter)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/DeleteFilter)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/DeleteFilter)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/DeleteFilter)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/DeleteFilter)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DeleteFilter)
# DeleteMetricAttribution
Deletes a metric attribution.
## Request Syntax
```
{
"metricAttributionArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [metricAttributionArn](#API_DeleteMetricAttribution_RequestSyntax) **
The metric attribution's Amazon Resource Name (ARN).
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** ResourceInUseException **
The specified resource is in use.
HTTP Status Code: 400
** ResourceNotFoundException **
Could not find the specified resource.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/DeleteMetricAttribution)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/DeleteMetricAttribution)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DeleteMetricAttribution)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/DeleteMetricAttribution)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DeleteMetricAttribution)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/DeleteMetricAttribution)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/DeleteMetricAttribution)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/DeleteMetricAttribution)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/DeleteMetricAttribution)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DeleteMetricAttribution)
# DeleteRecommender
Deactivates and removes a recommender. A deleted recommender can no longer be specified in a [GetRecommendations](https://docs.amazonaws.cn/personalize/latest/dg/API_RS_GetRecommendations.html) request.
## Request Syntax
```
{
"recommenderArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [recommenderArn](#API_DeleteRecommender_RequestSyntax) **
The Amazon Resource Name (ARN) of the recommender to delete.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** ResourceInUseException **
The specified resource is in use.
HTTP Status Code: 400
** ResourceNotFoundException **
Could not find the specified resource.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/DeleteRecommender)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/DeleteRecommender)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DeleteRecommender)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/DeleteRecommender)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DeleteRecommender)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/DeleteRecommender)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/DeleteRecommender)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/DeleteRecommender)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/DeleteRecommender)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DeleteRecommender)
# DeleteSchema
Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see [CreateSchema](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateSchema.html).
## Request Syntax
```
{
"schemaArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [schemaArn](#API_DeleteSchema_RequestSyntax) **
The Amazon Resource Name (ARN) of the schema to delete.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** ResourceInUseException **
The specified resource is in use.
HTTP Status Code: 400
** ResourceNotFoundException **
Could not find the specified resource.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/DeleteSchema)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/DeleteSchema)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DeleteSchema)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/DeleteSchema)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DeleteSchema)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/DeleteSchema)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/DeleteSchema)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/DeleteSchema)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/DeleteSchema)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DeleteSchema)
# DeleteSolution
Deletes all versions of a solution and the `Solution` object itself. Before deleting a solution, you must delete all campaigns based on the solution. To determine what campaigns are using the solution, call [ListCampaigns](https://docs.amazonaws.cn/personalize/latest/dg/API_ListCampaigns.html) and supply the Amazon Resource Name (ARN) of the solution. You can't delete a solution if an associated `SolutionVersion` is in the CREATE PENDING or IN PROGRESS state. For more information on solutions, see [CreateSolution](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateSolution.html).
## Request Syntax
```
{
"solutionArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [solutionArn](#API_DeleteSolution_RequestSyntax) **
The ARN of the solution to delete.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** ResourceInUseException **
The specified resource is in use.
HTTP Status Code: 400
** ResourceNotFoundException **
Could not find the specified resource.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/DeleteSolution)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/DeleteSolution)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DeleteSolution)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/DeleteSolution)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DeleteSolution)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/DeleteSolution)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/DeleteSolution)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/DeleteSolution)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/DeleteSolution)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DeleteSolution)
# DescribeAlgorithm
Describes the given algorithm.
## Request Syntax
```
{
"algorithmArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [algorithmArn](#API_DescribeAlgorithm_RequestSyntax) **
The Amazon Resource Name (ARN) of the algorithm to describe.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
## Response Syntax
```
{
"algorithm": {
"algorithmArn": "string",
"algorithmImage": {
"dockerURI": "string",
"name": "string"
},
"creationDateTime": number,
"defaultHyperParameterRanges": {
"categoricalHyperParameterRanges": [
{
"isTunable": boolean,
"name": "string",
"values": [ "string" ]
}
],
"continuousHyperParameterRanges": [
{
"isTunable": boolean,
"maxValue": number,
"minValue": number,
"name": "string"
}
],
"integerHyperParameterRanges": [
{
"isTunable": boolean,
"maxValue": number,
"minValue": number,
"name": "string"
}
]
},
"defaultHyperParameters": {
"string" : "string"
},
"defaultResourceConfig": {
"string" : "string"
},
"lastUpdatedDateTime": number,
"name": "string",
"roleArn": "string",
"trainingInputMode": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [algorithm](#API_DescribeAlgorithm_ResponseSyntax) **
A listing of the properties of the algorithm.
Type: [Algorithm](API_Algorithm.md) object
## Errors
** 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
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/DescribeAlgorithm)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/DescribeAlgorithm)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DescribeAlgorithm)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/DescribeAlgorithm)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DescribeAlgorithm)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeAlgorithm)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/DescribeAlgorithm)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/DescribeAlgorithm)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/DescribeAlgorithm)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DescribeAlgorithm)
# DescribeBatchInferenceJob
Gets the properties of a batch inference job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate the recommendations.
## Request Syntax
```
{
"batchInferenceJobArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [batchInferenceJobArn](#API_DescribeBatchInferenceJob_RequestSyntax) **
The ARN of the batch inference job to describe.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
## Response Syntax
```
{
"batchInferenceJob": {
"batchInferenceJobArn": "string",
"batchInferenceJobConfig": {
"itemExplorationConfig": {
"string" : "string"
},
"rankingInfluence": {
"string" : number
}
},
"batchInferenceJobMode": "string",
"creationDateTime": number,
"failureReason": "string",
"filterArn": "string",
"jobInput": {
"s3DataSource": {
"kmsKeyArn": "string",
"path": "string"
}
},
"jobName": "string",
"jobOutput": {
"s3DataDestination": {
"kmsKeyArn": "string",
"path": "string"
}
},
"lastUpdatedDateTime": number,
"numResults": number,
"roleArn": "string",
"solutionVersionArn": "string",
"status": "string",
"themeGenerationConfig": {
"fieldsForThemeGeneration": {
"itemName": "string"
}
}
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [batchInferenceJob](#API_DescribeBatchInferenceJob_ResponseSyntax) **
Information on the specified batch inference job.
Type: [BatchInferenceJob](API_BatchInferenceJob.md) object
## Errors
** 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
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/DescribeBatchInferenceJob)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/DescribeBatchInferenceJob)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DescribeBatchInferenceJob)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/DescribeBatchInferenceJob)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DescribeBatchInferenceJob)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeBatchInferenceJob)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/DescribeBatchInferenceJob)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/DescribeBatchInferenceJob)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/DescribeBatchInferenceJob)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DescribeBatchInferenceJob)
# DescribeBatchSegmentJob
Gets the properties of a batch segment job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate segments.
## Request Syntax
```
{
"batchSegmentJobArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [batchSegmentJobArn](#API_DescribeBatchSegmentJob_RequestSyntax) **
The ARN of the batch segment job to describe.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
## Response Syntax
```
{
"batchSegmentJob": {
"batchSegmentJobArn": "string",
"creationDateTime": number,
"failureReason": "string",
"filterArn": "string",
"jobInput": {
"s3DataSource": {
"kmsKeyArn": "string",
"path": "string"
}
},
"jobName": "string",
"jobOutput": {
"s3DataDestination": {
"kmsKeyArn": "string",
"path": "string"
}
},
"lastUpdatedDateTime": number,
"numResults": number,
"roleArn": "string",
"solutionVersionArn": "string",
"status": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [batchSegmentJob](#API_DescribeBatchSegmentJob_ResponseSyntax) **
Information on the specified batch segment job.
Type: [BatchSegmentJob](API_BatchSegmentJob.md) object
## Errors
** 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
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/DescribeBatchSegmentJob)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/DescribeBatchSegmentJob)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DescribeBatchSegmentJob)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/DescribeBatchSegmentJob)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DescribeBatchSegmentJob)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeBatchSegmentJob)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/DescribeBatchSegmentJob)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/DescribeBatchSegmentJob)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/DescribeBatchSegmentJob)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DescribeBatchSegmentJob)
# DescribeCampaign
Describes the given campaign, including its status.
A campaign can be in one of the following states:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
When the `status` is `CREATE FAILED`, the response includes the `failureReason` key, which describes why.
For more information on campaigns, see [CreateCampaign](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateCampaign.html).
## Request Syntax
```
{
"campaignArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [campaignArn](#API_DescribeCampaign_RequestSyntax) **
The Amazon Resource Name (ARN) of the campaign.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
## Response Syntax
```
{
"campaign": {
"campaignArn": "string",
"campaignConfig": {
"enableMetadataWithRecommendations": boolean,
"itemExplorationConfig": {
"string" : "string"
},
"rankingInfluence": {
"string" : number
},
"syncWithLatestSolutionVersion": boolean
},
"creationDateTime": number,
"failureReason": "string",
"lastUpdatedDateTime": number,
"latestCampaignUpdate": {
"campaignConfig": {
"enableMetadataWithRecommendations": boolean,
"itemExplorationConfig": {
"string" : "string"
},
"rankingInfluence": {
"string" : number
},
"syncWithLatestSolutionVersion": boolean
},
"creationDateTime": number,
"failureReason": "string",
"lastUpdatedDateTime": number,
"minProvisionedTPS": number,
"solutionVersionArn": "string",
"status": "string"
},
"minProvisionedTPS": number,
"name": "string",
"solutionVersionArn": "string",
"status": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [campaign](#API_DescribeCampaign_ResponseSyntax) **
The `latestCampaignUpdate` field is only returned when the campaign has had at least one `UpdateCampaign` call.
The properties of the campaign.
The `latestCampaignUpdate` field is only returned when the campaign has had at least one `UpdateCampaign` call.
Type: [Campaign](API_Campaign.md) object
## Errors
** 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
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/DescribeCampaign)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/DescribeCampaign)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DescribeCampaign)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/DescribeCampaign)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DescribeCampaign)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeCampaign)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/DescribeCampaign)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/DescribeCampaign)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/DescribeCampaign)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DescribeCampaign)
# DescribeDataDeletionJob
Describes the data deletion job created by [CreateDataDeletionJob](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateDataDeletionJob.html), including the job status.
## Request Syntax
```
{
"dataDeletionJobArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [dataDeletionJobArn](#API_DescribeDataDeletionJob_RequestSyntax) **
The Amazon Resource Name (ARN) of the data deletion job.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
## Response Syntax
```
{
"dataDeletionJob": {
"creationDateTime": number,
"dataDeletionJobArn": "string",
"datasetGroupArn": "string",
"dataSource": {
"dataLocation": "string"
},
"failureReason": "string",
"jobName": "string",
"lastUpdatedDateTime": number,
"numDeleted": number,
"roleArn": "string",
"status": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [dataDeletionJob](#API_DescribeDataDeletionJob_ResponseSyntax) **
Information about the data deletion job, including the status.
The status is one of the following values:
+ PENDING
+ IN\$1PROGRESS
+ COMPLETED
+ FAILED
Type: [DataDeletionJob](API_DataDeletionJob.md) object
## Errors
** 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
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/DescribeDataDeletionJob)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/DescribeDataDeletionJob)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DescribeDataDeletionJob)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/DescribeDataDeletionJob)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DescribeDataDeletionJob)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeDataDeletionJob)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/DescribeDataDeletionJob)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/DescribeDataDeletionJob)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/DescribeDataDeletionJob)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DescribeDataDeletionJob)
# DescribeDataset
Describes the given dataset. For more information on datasets, see [CreateDataset](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateDataset.html).
## Request Syntax
```
{
"datasetArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [datasetArn](#API_DescribeDataset_RequestSyntax) **
The Amazon Resource Name (ARN) of the dataset to describe.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
## Response Syntax
```
{
"dataset": {
"creationDateTime": number,
"datasetArn": "string",
"datasetGroupArn": "string",
"datasetType": "string",
"lastUpdatedDateTime": number,
"latestDatasetUpdate": {
"creationDateTime": number,
"failureReason": "string",
"lastUpdatedDateTime": number,
"schemaArn": "string",
"status": "string"
},
"name": "string",
"schemaArn": "string",
"status": "string",
"trackingId": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [dataset](#API_DescribeDataset_ResponseSyntax) **
A listing of the dataset's properties.
Type: [Dataset](API_Dataset.md) object
## Errors
** 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
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/DescribeDataset)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/DescribeDataset)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DescribeDataset)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/DescribeDataset)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DescribeDataset)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeDataset)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/DescribeDataset)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/DescribeDataset)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/DescribeDataset)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DescribeDataset)
# DescribeDatasetExportJob
Describes the dataset export job created by [CreateDatasetExportJob](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateDatasetExportJob.html), including the export job status.
## Request Syntax
```
{
"datasetExportJobArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [datasetExportJobArn](#API_DescribeDatasetExportJob_RequestSyntax) **
The Amazon Resource Name (ARN) of the dataset export job to describe.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
## Response Syntax
```
{
"datasetExportJob": {
"creationDateTime": number,
"datasetArn": "string",
"datasetExportJobArn": "string",
"failureReason": "string",
"ingestionMode": "string",
"jobName": "string",
"jobOutput": {
"s3DataDestination": {
"kmsKeyArn": "string",
"path": "string"
}
},
"lastUpdatedDateTime": number,
"roleArn": "string",
"status": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [datasetExportJob](#API_DescribeDatasetExportJob_ResponseSyntax) **
Information about the dataset export job, including the status.
The status is one of the following values:
+ CREATE PENDING
+ CREATE IN\$1PROGRESS
+ ACTIVE
+ CREATE FAILED
Type: [DatasetExportJob](API_DatasetExportJob.md) object
## Errors
** 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
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/DescribeDatasetExportJob)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/DescribeDatasetExportJob)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DescribeDatasetExportJob)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/DescribeDatasetExportJob)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DescribeDatasetExportJob)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeDatasetExportJob)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/DescribeDatasetExportJob)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/DescribeDatasetExportJob)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/DescribeDatasetExportJob)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DescribeDatasetExportJob)
# DescribeDatasetGroup
Describes the given dataset group. For more information on dataset groups, see [CreateDatasetGroup](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateDatasetGroup.html).
## Request Syntax
```
{
"datasetGroupArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [datasetGroupArn](#API_DescribeDatasetGroup_RequestSyntax) **
The Amazon Resource Name (ARN) of the dataset group to describe.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
## Response Syntax
```
{
"datasetGroup": {
"creationDateTime": number,
"datasetGroupArn": "string",
"domain": "string",
"failureReason": "string",
"kmsKeyArn": "string",
"lastUpdatedDateTime": number,
"name": "string",
"roleArn": "string",
"status": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [datasetGroup](#API_DescribeDatasetGroup_ResponseSyntax) **
A listing of the dataset group's properties.
Type: [DatasetGroup](API_DatasetGroup.md) object
## Errors
** 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
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/DescribeDatasetGroup)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/DescribeDatasetGroup)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DescribeDatasetGroup)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/DescribeDatasetGroup)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DescribeDatasetGroup)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeDatasetGroup)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/DescribeDatasetGroup)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/DescribeDatasetGroup)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/DescribeDatasetGroup)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DescribeDatasetGroup)
# DescribeDatasetImportJob
Describes the dataset import job created by [CreateDatasetImportJob](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateDatasetImportJob.html), including the import job status.
## Request Syntax
```
{
"datasetImportJobArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [datasetImportJobArn](#API_DescribeDatasetImportJob_RequestSyntax) **
The Amazon Resource Name (ARN) of the dataset import job to describe.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
## Response Syntax
```
{
"datasetImportJob": {
"creationDateTime": number,
"datasetArn": "string",
"datasetImportJobArn": "string",
"dataSource": {
"dataLocation": "string"
},
"failureReason": "string",
"importMode": "string",
"jobName": "string",
"lastUpdatedDateTime": number,
"publishAttributionMetricsToS3": boolean,
"roleArn": "string",
"status": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [datasetImportJob](#API_DescribeDatasetImportJob_ResponseSyntax) **
Information about the dataset import job, including the status.
The status is one of the following values:
+ CREATE PENDING
+ CREATE IN\$1PROGRESS
+ ACTIVE
+ CREATE FAILED
Type: [DatasetImportJob](API_DatasetImportJob.md) object
## Errors
** 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
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/DescribeDatasetImportJob)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/DescribeDatasetImportJob)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DescribeDatasetImportJob)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/DescribeDatasetImportJob)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DescribeDatasetImportJob)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeDatasetImportJob)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/DescribeDatasetImportJob)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/DescribeDatasetImportJob)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/DescribeDatasetImportJob)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DescribeDatasetImportJob)
# DescribeEventTracker
Describes an event tracker. The response includes the `trackingId` and `status` of the event tracker. For more information on event trackers, see [CreateEventTracker](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateEventTracker.html).
## Request Syntax
```
{
"eventTrackerArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [eventTrackerArn](#API_DescribeEventTracker_RequestSyntax) **
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
## Response Syntax
```
{
"eventTracker": {
"accountId": "string",
"creationDateTime": number,
"datasetGroupArn": "string",
"eventTrackerArn": "string",
"lastUpdatedDateTime": number,
"name": "string",
"status": "string",
"trackingId": "string"
}
}
```
## Response Elements
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) **
An object that describes the event tracker.
Type: [EventTracker](API_EventTracker.md) object
## Errors
** 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
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/DescribeEventTracker)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/DescribeEventTracker)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DescribeEventTracker)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/DescribeEventTracker)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DescribeEventTracker)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeEventTracker)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/DescribeEventTracker)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/DescribeEventTracker)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/DescribeEventTracker)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DescribeEventTracker)
# DescribeFeatureTransformation
Describes the given feature transformation.
## Request Syntax
```
{
"featureTransformationArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [featureTransformationArn](#API_DescribeFeatureTransformation_RequestSyntax) **
The Amazon Resource Name (ARN) of the feature transformation to describe.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
## Response Syntax
```
{
"featureTransformation": {
"creationDateTime": number,
"defaultParameters": {
"string" : "string"
},
"featureTransformationArn": "string",
"lastUpdatedDateTime": number,
"name": "string",
"status": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [featureTransformation](#API_DescribeFeatureTransformation_ResponseSyntax) **
A listing of the FeatureTransformation properties.
Type: [FeatureTransformation](API_FeatureTransformation.md) object
## Errors
** 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
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/DescribeFeatureTransformation)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/DescribeFeatureTransformation)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DescribeFeatureTransformation)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/DescribeFeatureTransformation)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DescribeFeatureTransformation)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeFeatureTransformation)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/DescribeFeatureTransformation)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/DescribeFeatureTransformation)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/DescribeFeatureTransformation)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DescribeFeatureTransformation)
# DescribeFilter
Describes a filter's properties.
## Request Syntax
```
{
"filterArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [filterArn](#API_DescribeFilter_RequestSyntax) **
The ARN of the filter to describe.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
## Response Syntax
```
{
"filter": {
"creationDateTime": number,
"datasetGroupArn": "string",
"failureReason": "string",
"filterArn": "string",
"filterExpression": "string",
"lastUpdatedDateTime": number,
"name": "string",
"status": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [filter](#API_DescribeFilter_ResponseSyntax) **
The filter's details.
Type: [Filter](API_Filter.md) object
## Errors
** 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
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/DescribeFilter)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/DescribeFilter)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DescribeFilter)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/DescribeFilter)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DescribeFilter)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeFilter)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/DescribeFilter)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/DescribeFilter)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/DescribeFilter)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DescribeFilter)
# DescribeMetricAttribution
Describes a metric attribution.
## Request Syntax
```
{
"metricAttributionArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [metricAttributionArn](#API_DescribeMetricAttribution_RequestSyntax) **
The metric attribution's Amazon Resource Name (ARN).
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
## Response Syntax
```
{
"metricAttribution": {
"creationDateTime": number,
"datasetGroupArn": "string",
"failureReason": "string",
"lastUpdatedDateTime": number,
"metricAttributionArn": "string",
"metricsOutputConfig": {
"roleArn": "string",
"s3DataDestination": {
"kmsKeyArn": "string",
"path": "string"
}
},
"name": "string",
"status": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [metricAttribution](#API_DescribeMetricAttribution_ResponseSyntax) **
The details of the metric attribution.
Type: [MetricAttribution](API_MetricAttribution.md) object
## Errors
** 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
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/DescribeMetricAttribution)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/DescribeMetricAttribution)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DescribeMetricAttribution)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/DescribeMetricAttribution)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DescribeMetricAttribution)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeMetricAttribution)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/DescribeMetricAttribution)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/DescribeMetricAttribution)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/DescribeMetricAttribution)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DescribeMetricAttribution)
# DescribeRecipe
Describes a recipe.
A recipe contains three items:
+ An algorithm that trains a model.
+ Hyperparameters that govern the training.
+ Feature transformation information for modifying the input data before training.
Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a solution with the [CreateSolution](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateSolution.html) API. `CreateSolution` trains a model by using the algorithm in the specified recipe and a training dataset. The solution, when deployed as a campaign, can provide recommendations using the [GetRecommendations](https://docs.amazonaws.cn/personalize/latest/dg/API_RS_GetRecommendations.html) API.
## Request Syntax
```
{
"recipeArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [recipeArn](#API_DescribeRecipe_RequestSyntax) **
The Amazon Resource Name (ARN) of the recipe to describe.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
## Response Syntax
```
{
"recipe": {
"algorithmArn": "string",
"creationDateTime": number,
"description": "string",
"featureTransformationArn": "string",
"lastUpdatedDateTime": number,
"name": "string",
"recipeArn": "string",
"recipeType": "string",
"status": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [recipe](#API_DescribeRecipe_ResponseSyntax) **
An object that describes the recipe.
Type: [Recipe](API_Recipe.md) object
## Errors
** 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
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/DescribeRecipe)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/DescribeRecipe)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DescribeRecipe)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/DescribeRecipe)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DescribeRecipe)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeRecipe)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/DescribeRecipe)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/DescribeRecipe)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/DescribeRecipe)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DescribeRecipe)
# DescribeRecommender
Describes the given recommender, including its status.
A recommender can be in one of the following states:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ STOP PENDING > STOP IN\$1PROGRESS > INACTIVE > START PENDING > START IN\$1PROGRESS > ACTIVE
+ DELETE PENDING > DELETE IN\$1PROGRESS
When the `status` is `CREATE FAILED`, the response includes the `failureReason` key, which describes why.
The `modelMetrics` key is null when the recommender is being created or deleted.
For more information on recommenders, see [CreateRecommender](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateRecommender.html).
## Request Syntax
```
{
"recommenderArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [recommenderArn](#API_DescribeRecommender_RequestSyntax) **
The Amazon Resource Name (ARN) of the recommender to describe.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
## Response Syntax
```
{
"recommender": {
"creationDateTime": number,
"datasetGroupArn": "string",
"failureReason": "string",
"lastUpdatedDateTime": number,
"latestRecommenderUpdate": {
"creationDateTime": number,
"failureReason": "string",
"lastUpdatedDateTime": number,
"recommenderConfig": {
"enableMetadataWithRecommendations": boolean,
"itemExplorationConfig": {
"string" : "string"
},
"minRecommendationRequestsPerSecond": number,
"trainingDataConfig": {
"excludedDatasetColumns": {
"string" : [ "string" ]
},
"includedDatasetColumns": {
"string" : [ "string" ]
}
}
},
"status": "string"
},
"modelMetrics": {
"string" : number
},
"name": "string",
"recipeArn": "string",
"recommenderArn": "string",
"recommenderConfig": {
"enableMetadataWithRecommendations": boolean,
"itemExplorationConfig": {
"string" : "string"
},
"minRecommendationRequestsPerSecond": number,
"trainingDataConfig": {
"excludedDatasetColumns": {
"string" : [ "string" ]
},
"includedDatasetColumns": {
"string" : [ "string" ]
}
}
},
"status": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [recommender](#API_DescribeRecommender_ResponseSyntax) **
The properties of the recommender.
Type: [Recommender](API_Recommender.md) object
## Errors
** 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
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/DescribeRecommender)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/DescribeRecommender)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DescribeRecommender)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/DescribeRecommender)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DescribeRecommender)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeRecommender)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/DescribeRecommender)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/DescribeRecommender)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/DescribeRecommender)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DescribeRecommender)
# DescribeSchema
Describes a schema. For more information on schemas, see [CreateSchema](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateSchema.html).
## Request Syntax
```
{
"schemaArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [schemaArn](#API_DescribeSchema_RequestSyntax) **
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
## Response Syntax
```
{
"schema": {
"creationDateTime": number,
"domain": "string",
"lastUpdatedDateTime": number,
"name": "string",
"schema": "string",
"schemaArn": "string"
}
}
```
## Response Elements
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) **
The requested schema.
Type: [DatasetSchema](API_DatasetSchema.md) object
## Errors
** 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
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/DescribeSchema)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/DescribeSchema)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DescribeSchema)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/DescribeSchema)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DescribeSchema)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeSchema)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/DescribeSchema)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/DescribeSchema)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/DescribeSchema)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DescribeSchema)
# DescribeSolution
Describes a solution. For more information on solutions, see [CreateSolution](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateSolution.html).
## Request Syntax
```
{
"solutionArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [solutionArn](#API_DescribeSolution_RequestSyntax) **
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
## Response Syntax
```
{
"solution": {
"autoMLResult": {
"bestRecipeArn": "string"
},
"creationDateTime": number,
"datasetGroupArn": "string",
"eventType": "string",
"lastUpdatedDateTime": number,
"latestSolutionUpdate": {
"creationDateTime": number,
"failureReason": "string",
"lastUpdatedDateTime": number,
"performAutoTraining": boolean,
"performIncrementalUpdate": boolean,
"solutionUpdateConfig": {
"autoTrainingConfig": {
"schedulingExpression": "string"
},
"eventsConfig": {
"eventParametersList": [
{
"eventType": "string",
"eventValueThreshold": number,
"weight": number
}
]
}
},
"status": "string"
},
"latestSolutionVersion": {
"creationDateTime": number,
"failureReason": "string",
"lastUpdatedDateTime": number,
"solutionVersionArn": "string",
"status": "string",
"trainingMode": "string",
"trainingType": "string"
},
"name": "string",
"performAutoML": boolean,
"performAutoTraining": boolean,
"performHPO": boolean,
"performIncrementalUpdate": boolean,
"recipeArn": "string",
"solutionArn": "string",
"solutionConfig": {
"algorithmHyperParameters": {
"string" : "string"
},
"autoMLConfig": {
"metricName": "string",
"recipeList": [ "string" ]
},
"autoTrainingConfig": {
"schedulingExpression": "string"
},
"eventsConfig": {
"eventParametersList": [
{
"eventType": "string",
"eventValueThreshold": number,
"weight": number
}
]
},
"eventValueThreshold": "string",
"featureTransformationParameters": {
"string" : "string"
},
"hpoConfig": {
"algorithmHyperParameterRanges": {
"categoricalHyperParameterRanges": [
{
"name": "string",
"values": [ "string" ]
}
],
"continuousHyperParameterRanges": [
{
"maxValue": number,
"minValue": number,
"name": "string"
}
],
"integerHyperParameterRanges": [
{
"maxValue": number,
"minValue": number,
"name": "string"
}
]
},
"hpoObjective": {
"metricName": "string",
"metricRegex": "string",
"type": "string"
},
"hpoResourceConfig": {
"maxNumberOfTrainingJobs": "string",
"maxParallelTrainingJobs": "string"
}
},
"optimizationObjective": {
"itemAttribute": "string",
"objectiveSensitivity": "string"
},
"trainingDataConfig": {
"excludedDatasetColumns": {
"string" : [ "string" ]
},
"includedDatasetColumns": {
"string" : [ "string" ]
}
}
},
"status": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [solution](#API_DescribeSolution_ResponseSyntax) **
An object that describes the solution.
Type: [Solution](API_Solution.md) object
## Errors
** 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
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/DescribeSolution)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/DescribeSolution)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DescribeSolution)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/DescribeSolution)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DescribeSolution)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeSolution)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/DescribeSolution)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/DescribeSolution)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/DescribeSolution)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DescribeSolution)
# DescribeSolutionVersion
Describes a specific version of a solution. For more information on solutions, see [CreateSolution](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateSolution.html)
## Request Syntax
```
{
"solutionVersionArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [solutionVersionArn](#API_DescribeSolutionVersion_RequestSyntax) **
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
## Response Syntax
```
{
"solutionVersion": {
"creationDateTime": number,
"datasetGroupArn": "string",
"eventType": "string",
"failureReason": "string",
"lastUpdatedDateTime": number,
"name": "string",
"performAutoML": boolean,
"performHPO": boolean,
"performIncrementalUpdate": boolean,
"recipeArn": "string",
"solutionArn": "string",
"solutionConfig": {
"algorithmHyperParameters": {
"string" : "string"
},
"autoMLConfig": {
"metricName": "string",
"recipeList": [ "string" ]
},
"autoTrainingConfig": {
"schedulingExpression": "string"
},
"eventsConfig": {
"eventParametersList": [
{
"eventType": "string",
"eventValueThreshold": number,
"weight": number
}
]
},
"eventValueThreshold": "string",
"featureTransformationParameters": {
"string" : "string"
},
"hpoConfig": {
"algorithmHyperParameterRanges": {
"categoricalHyperParameterRanges": [
{
"name": "string",
"values": [ "string" ]
}
],
"continuousHyperParameterRanges": [
{
"maxValue": number,
"minValue": number,
"name": "string"
}
],
"integerHyperParameterRanges": [
{
"maxValue": number,
"minValue": number,
"name": "string"
}
]
},
"hpoObjective": {
"metricName": "string",
"metricRegex": "string",
"type": "string"
},
"hpoResourceConfig": {
"maxNumberOfTrainingJobs": "string",
"maxParallelTrainingJobs": "string"
}
},
"optimizationObjective": {
"itemAttribute": "string",
"objectiveSensitivity": "string"
},
"trainingDataConfig": {
"excludedDatasetColumns": {
"string" : [ "string" ]
},
"includedDatasetColumns": {
"string" : [ "string" ]
}
}
},
"solutionVersionArn": "string",
"status": "string",
"trainingHours": number,
"trainingMode": "string",
"trainingType": "string",
"tunedHPOParams": {
"algorithmHyperParameters": {
"string" : "string"
}
}
}
}
```
## Response Elements
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) **
The solution version.
Type: [SolutionVersion](API_SolutionVersion.md) object
## Errors
** 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
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/DescribeSolutionVersion)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/DescribeSolutionVersion)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DescribeSolutionVersion)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/DescribeSolutionVersion)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DescribeSolutionVersion)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeSolutionVersion)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/DescribeSolutionVersion)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/DescribeSolutionVersion)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/DescribeSolutionVersion)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DescribeSolutionVersion)
# GetSolutionMetrics
Gets the metrics for the specified solution version.
## Request Syntax
```
{
"solutionVersionArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [solutionVersionArn](#API_GetSolutionMetrics_RequestSyntax) **
The Amazon Resource Name (ARN) of the solution version for which to get metrics.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
## Response Syntax
```
{
"metrics": {
"string" : number
},
"solutionVersionArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [metrics](#API_GetSolutionMetrics_ResponseSyntax) **
The metrics for the solution version. For more information, see [ Evaluating a solution version with metrics ](https://docs.amazonaws.cn/personalize/latest/dg/working-with-training-metrics.html).
Type: String to double map
Map Entries: Maximum number of 100 items.
Key Length Constraints: Maximum length of 256.
** [solutionVersionArn](#API_GetSolutionMetrics_ResponseSyntax) **
The same solution version ARN as specified in the request.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** ResourceInUseException **
The specified resource is in use.
HTTP Status Code: 400
** ResourceNotFoundException **
Could not find the specified resource.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/GetSolutionMetrics)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/GetSolutionMetrics)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/GetSolutionMetrics)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/GetSolutionMetrics)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/GetSolutionMetrics)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/GetSolutionMetrics)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/GetSolutionMetrics)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/GetSolutionMetrics)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/GetSolutionMetrics)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/GetSolutionMetrics)
# ListBatchInferenceJobs
Gets a list of the batch inference jobs that have been performed off of a solution version.
## Request Syntax
```
{
"maxResults": number,
"nextToken": "string",
"solutionVersionArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [maxResults](#API_ListBatchInferenceJobs_RequestSyntax) **
The maximum number of batch inference job results to return in each page. The default value is 100.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [nextToken](#API_ListBatchInferenceJobs_RequestSyntax) **
The token to request the next page of results.
Type: String
Length Constraints: Maximum length of 1500.
Pattern: `\p{ASCII}{0,1500}`
Required: No
** [solutionVersionArn](#API_ListBatchInferenceJobs_RequestSyntax) **
The Amazon Resource Name (ARN) of the solution version from which the batch inference jobs were created.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
## Response Syntax
```
{
"batchInferenceJobs": [
{
"batchInferenceJobArn": "string",
"batchInferenceJobMode": "string",
"creationDateTime": number,
"failureReason": "string",
"jobName": "string",
"lastUpdatedDateTime": number,
"solutionVersionArn": "string",
"status": "string"
}
],
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [batchInferenceJobs](#API_ListBatchInferenceJobs_ResponseSyntax) **
A list containing information on each job that is returned.
Type: Array of [BatchInferenceJobSummary](API_BatchInferenceJobSummary.md) objects
Array Members: Maximum number of 100 items.
** [nextToken](#API_ListBatchInferenceJobs_ResponseSyntax) **
The token to use to retrieve the next page of results. The value is `null` when there are no more results to return.
Type: String
Length Constraints: Maximum length of 1500.
Pattern: `\p{ASCII}{0,1500}`
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** InvalidNextTokenException **
The token is not valid.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/ListBatchInferenceJobs)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/ListBatchInferenceJobs)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/ListBatchInferenceJobs)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/ListBatchInferenceJobs)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/ListBatchInferenceJobs)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListBatchInferenceJobs)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/ListBatchInferenceJobs)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/ListBatchInferenceJobs)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/ListBatchInferenceJobs)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/ListBatchInferenceJobs)
# ListBatchSegmentJobs
Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.
## Request Syntax
```
{
"maxResults": number,
"nextToken": "string",
"solutionVersionArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [maxResults](#API_ListBatchSegmentJobs_RequestSyntax) **
The maximum number of batch segment job results to return in each page. The default value is 100.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [nextToken](#API_ListBatchSegmentJobs_RequestSyntax) **
The token to request the next page of results.
Type: String
Length Constraints: Maximum length of 1500.
Pattern: `\p{ASCII}{0,1500}`
Required: No
** [solutionVersionArn](#API_ListBatchSegmentJobs_RequestSyntax) **
The Amazon Resource Name (ARN) of the solution version that the batch segment jobs used to generate batch segments.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
## Response Syntax
```
{
"batchSegmentJobs": [
{
"batchSegmentJobArn": "string",
"creationDateTime": number,
"failureReason": "string",
"jobName": "string",
"lastUpdatedDateTime": number,
"solutionVersionArn": "string",
"status": "string"
}
],
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [batchSegmentJobs](#API_ListBatchSegmentJobs_ResponseSyntax) **
A list containing information on each job that is returned.
Type: Array of [BatchSegmentJobSummary](API_BatchSegmentJobSummary.md) objects
Array Members: Maximum number of 100 items.
** [nextToken](#API_ListBatchSegmentJobs_ResponseSyntax) **
The token to use to retrieve the next page of results. The value is `null` when there are no more results to return.
Type: String
Length Constraints: Maximum length of 1500.
Pattern: `\p{ASCII}{0,1500}`
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** InvalidNextTokenException **
The token is not valid.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/ListBatchSegmentJobs)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/ListBatchSegmentJobs)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/ListBatchSegmentJobs)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/ListBatchSegmentJobs)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/ListBatchSegmentJobs)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListBatchSegmentJobs)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/ListBatchSegmentJobs)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/ListBatchSegmentJobs)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/ListBatchSegmentJobs)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/ListBatchSegmentJobs)
# ListCampaigns
Returns a list of campaigns that use the given solution. When a solution is not specified, all the campaigns associated with the account are listed. The response provides the properties for each campaign, including the Amazon Resource Name (ARN). For more information on campaigns, see [CreateCampaign](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateCampaign.html).
## Request Syntax
```
{
"maxResults": number,
"nextToken": "string",
"solutionArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [maxResults](#API_ListCampaigns_RequestSyntax) **
The maximum number of campaigns to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [nextToken](#API_ListCampaigns_RequestSyntax) **
A token returned from the previous call to [ListCampaigns](https://docs.amazonaws.cn/personalize/latest/dg/API_ListCampaigns.html) for getting the next set of campaigns (if they exist).
Type: String
Length Constraints: Maximum length of 1500.
Pattern: `\p{ASCII}{0,1500}`
Required: No
** [solutionArn](#API_ListCampaigns_RequestSyntax) **
The Amazon Resource Name (ARN) of the solution to list the campaigns for. When a solution is not specified, all the campaigns associated with the account are listed.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
## Response Syntax
```
{
"campaigns": [
{
"campaignArn": "string",
"creationDateTime": number,
"failureReason": "string",
"lastUpdatedDateTime": number,
"name": "string",
"status": "string"
}
],
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [campaigns](#API_ListCampaigns_ResponseSyntax) **
A list of the campaigns.
Type: Array of [CampaignSummary](API_CampaignSummary.md) objects
Array Members: Maximum number of 100 items.
** [nextToken](#API_ListCampaigns_ResponseSyntax) **
A token for getting the next set of campaigns (if they exist).
Type: String
Length Constraints: Maximum length of 1500.
Pattern: `\p{ASCII}{0,1500}`
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** InvalidNextTokenException **
The token is not valid.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/ListCampaigns)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/ListCampaigns)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/ListCampaigns)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/ListCampaigns)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/ListCampaigns)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListCampaigns)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/ListCampaigns)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/ListCampaigns)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/ListCampaigns)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/ListCampaigns)
# ListDataDeletionJobs
Returns a list of data deletion jobs for a dataset group ordered by creation time, with the most recent first. When a dataset group is not specified, all the data deletion jobs associated with the account are listed. The response provides the properties for each job, including the Amazon Resource Name (ARN). For more information on data deletion jobs, see [Deleting users](https://docs.amazonaws.cn/personalize/latest/dg/delete-records.html).
## Request Syntax
```
{
"datasetGroupArn": "string",
"maxResults": number,
"nextToken": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [datasetGroupArn](#API_ListDataDeletionJobs_RequestSyntax) **
The Amazon Resource Name (ARN) of the dataset group to list data deletion jobs for.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** [maxResults](#API_ListDataDeletionJobs_RequestSyntax) **
The maximum number of data deletion jobs to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [nextToken](#API_ListDataDeletionJobs_RequestSyntax) **
A token returned from the previous call to `ListDataDeletionJobs` for getting the next set of jobs (if they exist).
Type: String
Length Constraints: Maximum length of 1500.
Pattern: `\p{ASCII}{0,1500}`
Required: No
## Response Syntax
```
{
"dataDeletionJobs": [
{
"creationDateTime": number,
"dataDeletionJobArn": "string",
"datasetGroupArn": "string",
"failureReason": "string",
"jobName": "string",
"lastUpdatedDateTime": number,
"status": "string"
}
],
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [dataDeletionJobs](#API_ListDataDeletionJobs_ResponseSyntax) **
The list of data deletion jobs.
Type: Array of [DataDeletionJobSummary](API_DataDeletionJobSummary.md) objects
Array Members: Maximum number of 100 items.
** [nextToken](#API_ListDataDeletionJobs_ResponseSyntax) **
A token for getting the next set of data deletion jobs (if they exist).
Type: String
Length Constraints: Maximum length of 1500.
Pattern: `\p{ASCII}{0,1500}`
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** InvalidNextTokenException **
The token is not valid.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/ListDataDeletionJobs)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/ListDataDeletionJobs)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/ListDataDeletionJobs)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/ListDataDeletionJobs)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/ListDataDeletionJobs)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListDataDeletionJobs)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/ListDataDeletionJobs)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/ListDataDeletionJobs)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/ListDataDeletionJobs)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/ListDataDeletionJobs)
# ListDatasetExportJobs
Returns a list of dataset export jobs that use the given dataset. When a dataset is not specified, all the dataset export jobs associated with the account are listed. The response provides the properties for each dataset export job, including the Amazon Resource Name (ARN). For more information on dataset export jobs, see [CreateDatasetExportJob](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateDatasetExportJob.html). For more information on datasets, see [CreateDataset](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateDataset.html).
## Request Syntax
```
{
"datasetArn": "string",
"maxResults": number,
"nextToken": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [datasetArn](#API_ListDatasetExportJobs_RequestSyntax) **
The Amazon Resource Name (ARN) of the dataset to list the dataset export jobs for.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** [maxResults](#API_ListDatasetExportJobs_RequestSyntax) **
The maximum number of dataset export jobs to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [nextToken](#API_ListDatasetExportJobs_RequestSyntax) **
A token returned from the previous call to `ListDatasetExportJobs` for getting the next set of dataset export jobs (if they exist).
Type: String
Length Constraints: Maximum length of 1500.
Pattern: `\p{ASCII}{0,1500}`
Required: No
## Response Syntax
```
{
"datasetExportJobs": [
{
"creationDateTime": number,
"datasetExportJobArn": "string",
"failureReason": "string",
"jobName": "string",
"lastUpdatedDateTime": number,
"status": "string"
}
],
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [datasetExportJobs](#API_ListDatasetExportJobs_ResponseSyntax) **
The list of dataset export jobs.
Type: Array of [DatasetExportJobSummary](API_DatasetExportJobSummary.md) objects
Array Members: Maximum number of 100 items.
** [nextToken](#API_ListDatasetExportJobs_ResponseSyntax) **
A token for getting the next set of dataset export jobs (if they exist).
Type: String
Length Constraints: Maximum length of 1500.
Pattern: `\p{ASCII}{0,1500}`
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** InvalidNextTokenException **
The token is not valid.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/ListDatasetExportJobs)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/ListDatasetExportJobs)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/ListDatasetExportJobs)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/ListDatasetExportJobs)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/ListDatasetExportJobs)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListDatasetExportJobs)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/ListDatasetExportJobs)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/ListDatasetExportJobs)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/ListDatasetExportJobs)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/ListDatasetExportJobs)
# ListDatasetGroups
Returns a list of dataset groups. The response provides the properties for each dataset group, including the Amazon Resource Name (ARN). For more information on dataset groups, see [CreateDatasetGroup](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateDatasetGroup.html).
## Request Syntax
```
{
"maxResults": number,
"nextToken": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [maxResults](#API_ListDatasetGroups_RequestSyntax) **
The maximum number of dataset groups to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [nextToken](#API_ListDatasetGroups_RequestSyntax) **
A token returned from the previous call to `ListDatasetGroups` for getting the next set of dataset groups (if they exist).
Type: String
Length Constraints: Maximum length of 1500.
Pattern: `\p{ASCII}{0,1500}`
Required: No
## Response Syntax
```
{
"datasetGroups": [
{
"creationDateTime": number,
"datasetGroupArn": "string",
"domain": "string",
"failureReason": "string",
"lastUpdatedDateTime": number,
"name": "string",
"status": "string"
}
],
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [datasetGroups](#API_ListDatasetGroups_ResponseSyntax) **
The list of your dataset groups.
Type: Array of [DatasetGroupSummary](API_DatasetGroupSummary.md) objects
Array Members: Maximum number of 100 items.
** [nextToken](#API_ListDatasetGroups_ResponseSyntax) **
A token for getting the next set of dataset groups (if they exist).
Type: String
Length Constraints: Maximum length of 1500.
Pattern: `\p{ASCII}{0,1500}`
## Errors
** InvalidNextTokenException **
The token is not valid.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/ListDatasetGroups)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/ListDatasetGroups)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/ListDatasetGroups)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/ListDatasetGroups)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/ListDatasetGroups)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListDatasetGroups)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/ListDatasetGroups)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/ListDatasetGroups)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/ListDatasetGroups)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/ListDatasetGroups)
# ListDatasetImportJobs
Returns a list of dataset import jobs that use the given dataset. When a dataset is not specified, all the dataset import jobs associated with the account are listed. The response provides the properties for each dataset import job, including the Amazon Resource Name (ARN). For more information on dataset import jobs, see [CreateDatasetImportJob](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateDatasetImportJob.html). For more information on datasets, see [CreateDataset](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateDataset.html).
## Request Syntax
```
{
"datasetArn": "string",
"maxResults": number,
"nextToken": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [datasetArn](#API_ListDatasetImportJobs_RequestSyntax) **
The Amazon Resource Name (ARN) of the dataset to list the dataset import jobs for.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** [maxResults](#API_ListDatasetImportJobs_RequestSyntax) **
The maximum number of dataset import jobs to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [nextToken](#API_ListDatasetImportJobs_RequestSyntax) **
A token returned from the previous call to `ListDatasetImportJobs` for getting the next set of dataset import jobs (if they exist).
Type: String
Length Constraints: Maximum length of 1500.
Pattern: `\p{ASCII}{0,1500}`
Required: No
## Response Syntax
```
{
"datasetImportJobs": [
{
"creationDateTime": number,
"datasetImportJobArn": "string",
"failureReason": "string",
"importMode": "string",
"jobName": "string",
"lastUpdatedDateTime": number,
"status": "string"
}
],
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [datasetImportJobs](#API_ListDatasetImportJobs_ResponseSyntax) **
The list of dataset import jobs.
Type: Array of [DatasetImportJobSummary](API_DatasetImportJobSummary.md) objects
Array Members: Maximum number of 100 items.
** [nextToken](#API_ListDatasetImportJobs_ResponseSyntax) **
A token for getting the next set of dataset import jobs (if they exist).
Type: String
Length Constraints: Maximum length of 1500.
Pattern: `\p{ASCII}{0,1500}`
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** InvalidNextTokenException **
The token is not valid.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/ListDatasetImportJobs)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/ListDatasetImportJobs)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/ListDatasetImportJobs)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/ListDatasetImportJobs)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/ListDatasetImportJobs)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListDatasetImportJobs)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/ListDatasetImportJobs)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/ListDatasetImportJobs)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/ListDatasetImportJobs)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/ListDatasetImportJobs)
# ListDatasets
Returns the list of datasets contained in the given dataset group. The response provides the properties for each dataset, including the Amazon Resource Name (ARN). For more information on datasets, see [CreateDataset](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateDataset.html).
## Request Syntax
```
{
"datasetGroupArn": "string",
"maxResults": number,
"nextToken": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [datasetGroupArn](#API_ListDatasets_RequestSyntax) **
The Amazon Resource Name (ARN) of the dataset group that contains the datasets to list.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** [maxResults](#API_ListDatasets_RequestSyntax) **
The maximum number of datasets to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [nextToken](#API_ListDatasets_RequestSyntax) **
A token returned from the previous call to `ListDatasets` for getting the next set of dataset import jobs (if they exist).
Type: String
Length Constraints: Maximum length of 1500.
Pattern: `\p{ASCII}{0,1500}`
Required: No
## Response Syntax
```
{
"datasets": [
{
"creationDateTime": number,
"datasetArn": "string",
"datasetType": "string",
"lastUpdatedDateTime": number,
"name": "string",
"status": "string"
}
],
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [datasets](#API_ListDatasets_ResponseSyntax) **
An array of `Dataset` objects. Each object provides metadata information.
Type: Array of [DatasetSummary](API_DatasetSummary.md) objects
Array Members: Maximum number of 100 items.
** [nextToken](#API_ListDatasets_ResponseSyntax) **
A token for getting the next set of datasets (if they exist).
Type: String
Length Constraints: Maximum length of 1500.
Pattern: `\p{ASCII}{0,1500}`
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** InvalidNextTokenException **
The token is not valid.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/ListDatasets)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/ListDatasets)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/ListDatasets)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/ListDatasets)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/ListDatasets)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListDatasets)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/ListDatasets)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/ListDatasets)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/ListDatasets)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/ListDatasets)
# ListEventTrackers
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](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateEventTracker.html).
## Request Syntax
```
{
"datasetGroupArn": "string",
"maxResults": number,
"nextToken": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [datasetGroupArn](#API_ListEventTrackers_RequestSyntax) **
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) **
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 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 1500.
Pattern: `\p{ASCII}{0,1500}`
Required: No
## Response Syntax
```
{
"eventTrackers": [
{
"creationDateTime": number,
"eventTrackerArn": "string",
"lastUpdatedDateTime": number,
"name": "string",
"status": "string"
}
],
"nextToken": "string"
}
```
## Response Elements
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 list of event trackers.
Type: Array of [EventTrackerSummary](API_EventTrackerSummary.md) objects
Array Members: Maximum number of 100 items.
** [nextToken](#API_ListEventTrackers_ResponseSyntax) **
A token for getting the next set of event trackers (if they exist).
Type: String
Length Constraints: Maximum length of 1500.
Pattern: `\p{ASCII}{0,1500}`
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** InvalidNextTokenException **
The token is not valid.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/ListEventTrackers)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/ListEventTrackers)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/ListEventTrackers)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/ListEventTrackers)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/ListEventTrackers)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListEventTrackers)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/ListEventTrackers)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/ListEventTrackers)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/ListEventTrackers)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/ListEventTrackers)
# ListFilters
Lists all filters that belong to a given dataset group.
## Request Syntax
```
{
"datasetGroupArn": "string",
"maxResults": number,
"nextToken": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [datasetGroupArn](#API_ListFilters_RequestSyntax) **
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) **
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 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 1500.
Pattern: `\p{ASCII}{0,1500}`
Required: No
## Response Syntax
```
{
"Filters": [
{
"creationDateTime": number,
"datasetGroupArn": "string",
"failureReason": "string",
"filterArn": "string",
"lastUpdatedDateTime": number,
"name": "string",
"status": "string"
}
],
"nextToken": "string"
}
```
## Response Elements
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 list of returned filters.
Type: Array of [FilterSummary](API_FilterSummary.md) objects
Array Members: Maximum number of 100 items.
** [nextToken](#API_ListFilters_ResponseSyntax) **
A token for getting the next set of filters (if they exist).
Type: String
Length Constraints: Maximum length of 1500.
Pattern: `\p{ASCII}{0,1500}`
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** InvalidNextTokenException **
The token is not valid.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/ListFilters)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/ListFilters)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/ListFilters)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/ListFilters)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/ListFilters)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListFilters)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/ListFilters)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/ListFilters)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/ListFilters)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/ListFilters)
# ListMetricAttributionMetrics
Lists the metrics for the metric attribution.
## Request Syntax
```
{
"maxResults": number,
"metricAttributionArn": "string",
"nextToken": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [maxResults](#API_ListMetricAttributionMetrics_RequestSyntax) **
The maximum number of metrics to return in one page of results.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [metricAttributionArn](#API_ListMetricAttributionMetrics_RequestSyntax) **
The Amazon Resource Name (ARN) of the metric attribution to retrieve attributes for.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** [nextToken](#API_ListMetricAttributionMetrics_RequestSyntax) **
Specify the pagination token from a previous request to retrieve the next page of results.
Type: String
Length Constraints: Maximum length of 1500.
Pattern: `\p{ASCII}{0,1500}`
Required: No
## Response Syntax
```
{
"metrics": [
{
"eventType": "string",
"expression": "string",
"metricName": "string"
}
],
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [metrics](#API_ListMetricAttributionMetrics_ResponseSyntax) **
The metrics for the specified metric attribution.
Type: Array of [MetricAttribute](API_MetricAttribute.md) objects
Array Members: Maximum number of 10 items.
** [nextToken](#API_ListMetricAttributionMetrics_ResponseSyntax) **
Specify the pagination token from a previous `ListMetricAttributionMetricsResponse` request to retrieve the next page of results.
Type: String
Length Constraints: Maximum length of 1500.
Pattern: `\p{ASCII}{0,1500}`
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** InvalidNextTokenException **
The token is not valid.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/ListMetricAttributionMetrics)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/ListMetricAttributionMetrics)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/ListMetricAttributionMetrics)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/ListMetricAttributionMetrics)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/ListMetricAttributionMetrics)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListMetricAttributionMetrics)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/ListMetricAttributionMetrics)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/ListMetricAttributionMetrics)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/ListMetricAttributionMetrics)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/ListMetricAttributionMetrics)
# ListMetricAttributions
Lists metric attributions.
## Request Syntax
```
{
"datasetGroupArn": "string",
"maxResults": number,
"nextToken": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [datasetGroupArn](#API_ListMetricAttributions_RequestSyntax) **
The metric attributions' dataset group Amazon Resource Name (ARN).
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** [maxResults](#API_ListMetricAttributions_RequestSyntax) **
The maximum number of metric attributions to return in one page of results.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [nextToken](#API_ListMetricAttributions_RequestSyntax) **
Specify the pagination token from a previous request to retrieve the next page of results.
Type: String
Length Constraints: Maximum length of 1500.
Pattern: `\p{ASCII}{0,1500}`
Required: No
## Response Syntax
```
{
"metricAttributions": [
{
"creationDateTime": number,
"failureReason": "string",
"lastUpdatedDateTime": number,
"metricAttributionArn": "string",
"name": "string",
"status": "string"
}
],
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [metricAttributions](#API_ListMetricAttributions_ResponseSyntax) **
The list of metric attributions.
Type: Array of [MetricAttributionSummary](API_MetricAttributionSummary.md) objects
Array Members: Maximum number of 100 items.
** [nextToken](#API_ListMetricAttributions_ResponseSyntax) **
Specify the pagination token from a previous request to retrieve the next page of results.
Type: String
Length Constraints: Maximum length of 1500.
Pattern: `\p{ASCII}{0,1500}`
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** InvalidNextTokenException **
The token is not valid.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/ListMetricAttributions)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/ListMetricAttributions)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/ListMetricAttributions)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/ListMetricAttributions)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/ListMetricAttributions)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListMetricAttributions)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/ListMetricAttributions)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/ListMetricAttributions)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/ListMetricAttributions)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/ListMetricAttributions)
# ListRecipes
Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).
## Request Syntax
```
{
"domain": "string",
"maxResults": number,
"nextToken": "string",
"recipeProvider": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [domain](#API_ListRecipes_RequestSyntax) **
Filters returned recipes by domain for a Domain dataset group. Only recipes (Domain dataset group use cases) for this domain are included in the response. If you don't specify a domain, all recipes are returned.
Type: String
Valid Values: `ECOMMERCE | VIDEO_ON_DEMAND`
Required: No
** [maxResults](#API_ListRecipes_RequestSyntax) **
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 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 1500.
Pattern: `\p{ASCII}{0,1500}`
Required: No
** [recipeProvider](#API_ListRecipes_RequestSyntax) **
The default is `SERVICE`.
Type: String
Valid Values: `SERVICE`
Required: No
## Response Syntax
```
{
"nextToken": "string",
"recipes": [
{
"creationDateTime": number,
"domain": "string",
"lastUpdatedDateTime": number,
"name": "string",
"recipeArn": "string",
"status": "string"
}
]
}
```
## Response Elements
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 token for getting the next set of recipes.
Type: String
Length Constraints: Maximum length of 1500.
Pattern: `\p{ASCII}{0,1500}`
** [recipes](#API_ListRecipes_ResponseSyntax) **
The list of available recipes.
Type: Array of [RecipeSummary](API_RecipeSummary.md) objects
Array Members: Maximum number of 100 items.
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** InvalidNextTokenException **
The token is not valid.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/ListRecipes)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/ListRecipes)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/ListRecipes)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/ListRecipes)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/ListRecipes)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListRecipes)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/ListRecipes)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/ListRecipes)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/ListRecipes)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/ListRecipes)
# ListRecommenders
Returns a list of recommenders in a given Domain dataset group. When a Domain dataset group is not specified, all the recommenders associated with the account are listed. The response provides the properties for each recommender, including the Amazon Resource Name (ARN). For more information on recommenders, see [CreateRecommender](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateRecommender.html).
## Request Syntax
```
{
"datasetGroupArn": "string",
"maxResults": number,
"nextToken": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [datasetGroupArn](#API_ListRecommenders_RequestSyntax) **
The Amazon Resource Name (ARN) of the Domain dataset group to list the recommenders for. When a Domain dataset group is not specified, all the recommenders associated with the account are listed.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** [maxResults](#API_ListRecommenders_RequestSyntax) **
The maximum number of recommenders to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [nextToken](#API_ListRecommenders_RequestSyntax) **
A token returned from the previous call to `ListRecommenders` for getting the next set of recommenders (if they exist).
Type: String
Length Constraints: Maximum length of 1500.
Pattern: `\p{ASCII}{0,1500}`
Required: No
## Response Syntax
```
{
"nextToken": "string",
"recommenders": [
{
"creationDateTime": number,
"datasetGroupArn": "string",
"lastUpdatedDateTime": number,
"name": "string",
"recipeArn": "string",
"recommenderArn": "string",
"recommenderConfig": {
"enableMetadataWithRecommendations": boolean,
"itemExplorationConfig": {
"string" : "string"
},
"minRecommendationRequestsPerSecond": number,
"trainingDataConfig": {
"excludedDatasetColumns": {
"string" : [ "string" ]
},
"includedDatasetColumns": {
"string" : [ "string" ]
}
}
},
"status": "string"
}
]
}
```
## Response Elements
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_ListRecommenders_ResponseSyntax) **
A token for getting the next set of recommenders (if they exist).
Type: String
Length Constraints: Maximum length of 1500.
Pattern: `\p{ASCII}{0,1500}`
** [recommenders](#API_ListRecommenders_ResponseSyntax) **
A list of the recommenders.
Type: Array of [RecommenderSummary](API_RecommenderSummary.md) objects
Array Members: Maximum number of 100 items.
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** InvalidNextTokenException **
The token is not valid.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/ListRecommenders)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/ListRecommenders)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/ListRecommenders)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/ListRecommenders)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/ListRecommenders)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListRecommenders)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/ListRecommenders)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/ListRecommenders)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/ListRecommenders)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/ListRecommenders)
# ListSchemas
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](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateSchema.html).
## Request Syntax
```
{
"maxResults": number,
"nextToken": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [maxResults](#API_ListSchemas_RequestSyntax) **
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 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 1500.
Pattern: `\p{ASCII}{0,1500}`
Required: No
## Response Syntax
```
{
"nextToken": "string",
"schemas": [
{
"creationDateTime": number,
"domain": "string",
"lastUpdatedDateTime": number,
"name": "string",
"schemaArn": "string"
}
]
}
```
## Response Elements
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 token used to get the next set of schemas (if they exist).
Type: String
Length Constraints: Maximum length of 1500.
Pattern: `\p{ASCII}{0,1500}`
** [schemas](#API_ListSchemas_ResponseSyntax) **
A list of schemas.
Type: Array of [DatasetSchemaSummary](API_DatasetSchemaSummary.md) objects
Array Members: Maximum number of 100 items.
## Errors
** InvalidNextTokenException **
The token is not valid.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/ListSchemas)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/ListSchemas)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/ListSchemas)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/ListSchemas)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/ListSchemas)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListSchemas)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/ListSchemas)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/ListSchemas)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/ListSchemas)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/ListSchemas)
# ListSolutions
Returns a list of solutions in a given dataset group. When a dataset group is not specified, all the solutions associated with the account are listed. The response provides the properties for each solution, including the Amazon Resource Name (ARN). For more information on solutions, see [CreateSolution](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateSolution.html).
## Request Syntax
```
{
"datasetGroupArn": "string",
"maxResults": number,
"nextToken": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [datasetGroupArn](#API_ListSolutions_RequestSyntax) **
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
** [maxResults](#API_ListSolutions_RequestSyntax) **
The maximum number of solutions to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [nextToken](#API_ListSolutions_RequestSyntax) **
A token returned from the previous call to `ListSolutions` for getting the next set of solutions (if they exist).
Type: String
Length Constraints: Maximum length of 1500.
Pattern: `\p{ASCII}{0,1500}`
Required: No
## Response Syntax
```
{
"nextToken": "string",
"solutions": [
{
"creationDateTime": number,
"lastUpdatedDateTime": number,
"name": "string",
"recipeArn": "string",
"solutionArn": "string",
"status": "string"
}
]
}
```
## Response Elements
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_ListSolutions_ResponseSyntax) **
A token for getting the next set of solutions (if they exist).
Type: String
Length Constraints: Maximum length of 1500.
Pattern: `\p{ASCII}{0,1500}`
** [solutions](#API_ListSolutions_ResponseSyntax) **
A list of the current solutions.
Type: Array of [SolutionSummary](API_SolutionSummary.md) objects
Array Members: Maximum number of 100 items.
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** InvalidNextTokenException **
The token is not valid.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/ListSolutions)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/ListSolutions)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/ListSolutions)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/ListSolutions)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/ListSolutions)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListSolutions)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/ListSolutions)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/ListSolutions)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/ListSolutions)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/ListSolutions)
# ListSolutionVersions
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).
## Request Syntax
```
{
"maxResults": number,
"nextToken": "string",
"solutionArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [maxResults](#API_ListSolutionVersions_RequestSyntax) **
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 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 1500.
Pattern: `\p{ASCII}{0,1500}`
Required: No
** [solutionArn](#API_ListSolutionVersions_RequestSyntax) **
The Amazon Resource Name (ARN) of the solution.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
## Response Syntax
```
{
"nextToken": "string",
"solutionVersions": [
{
"creationDateTime": number,
"failureReason": "string",
"lastUpdatedDateTime": number,
"solutionVersionArn": "string",
"status": "string",
"trainingMode": "string",
"trainingType": "string"
}
]
}
```
## Response Elements
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 token for getting the next set of solution versions (if they exist).
Type: String
Length Constraints: Maximum length of 1500.
Pattern: `\p{ASCII}{0,1500}`
** [solutionVersions](#API_ListSolutionVersions_ResponseSyntax) **
A list of solution versions describing the version properties.
Type: Array of [SolutionVersionSummary](API_SolutionVersionSummary.md) objects
Array Members: Maximum number of 100 items.
## Errors
** 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
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/ListSolutionVersions)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/ListSolutionVersions)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/ListSolutionVersions)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/ListSolutionVersions)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/ListSolutionVersions)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListSolutionVersions)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/ListSolutionVersions)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/ListSolutionVersions)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/ListSolutionVersions)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/ListSolutionVersions)
# ListTagsForResource
Get a list of [tags](https://docs.amazonaws.cn/personalize/latest/dg/tagging-resources.html) attached to a resource.
## Request Syntax
```
{
"resourceArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [resourceArn](#API_ListTagsForResource_RequestSyntax) **
The resource's Amazon Resource Name (ARN).
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
## Response Syntax
```
{
"tags": [
{
"tagKey": "string",
"tagValue": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [tags](#API_ListTagsForResource_ResponseSyntax) **
The resource's tags.
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** ResourceInUseException **
The specified resource is in use.
HTTP Status Code: 400
** ResourceNotFoundException **
Could not find the specified resource.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/ListTagsForResource)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/ListTagsForResource)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/ListTagsForResource)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/ListTagsForResource)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/ListTagsForResource)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/ListTagsForResource)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/ListTagsForResource)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/ListTagsForResource)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/ListTagsForResource)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/ListTagsForResource)
# StartRecommender
Starts a recommender that is INACTIVE. Starting a recommender does not create any new models, but resumes billing and automatic retraining for the recommender.
## Request Syntax
```
{
"recommenderArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [recommenderArn](#API_StartRecommender_RequestSyntax) **
The Amazon Resource Name (ARN) of the recommender to start.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
## Response Syntax
```
{
"recommenderArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [recommenderArn](#API_StartRecommender_ResponseSyntax) **
The Amazon Resource Name (ARN) of the recommender you started.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** ResourceInUseException **
The specified resource is in use.
HTTP Status Code: 400
** ResourceNotFoundException **
Could not find the specified resource.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/StartRecommender)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/StartRecommender)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/StartRecommender)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/StartRecommender)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/StartRecommender)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/StartRecommender)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/StartRecommender)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/StartRecommender)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/StartRecommender)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/StartRecommender)
# StopRecommender
Stops a recommender that is ACTIVE. Stopping a recommender halts billing and automatic retraining for the recommender.
## Request Syntax
```
{
"recommenderArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [recommenderArn](#API_StopRecommender_RequestSyntax) **
The Amazon Resource Name (ARN) of the recommender to stop.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
## Response Syntax
```
{
"recommenderArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [recommenderArn](#API_StopRecommender_ResponseSyntax) **
The Amazon Resource Name (ARN) of the recommender you stopped.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** ResourceInUseException **
The specified resource is in use.
HTTP Status Code: 400
** ResourceNotFoundException **
Could not find the specified resource.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/StopRecommender)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/StopRecommender)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/StopRecommender)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/StopRecommender)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/StopRecommender)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/StopRecommender)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/StopRecommender)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/StopRecommender)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/StopRecommender)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/StopRecommender)
# StopSolutionVersionCreation
Stops creating a solution version that is in a state of CREATE\$1PENDING or CREATE IN\$1PROGRESS.
Depending on the current state of the solution version, the solution version state changes as follows:
+ CREATE\$1PENDING > CREATE\$1STOPPED
or
+ CREATE\$1IN\$1PROGRESS > CREATE\$1STOPPING > CREATE\$1STOPPED
You are billed for all of the training completed up until you stop the solution version creation. You cannot resume creating a solution version once it has been stopped.
## Request Syntax
```
{
"solutionVersionArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [solutionVersionArn](#API_StopSolutionVersionCreation_RequestSyntax) **
The Amazon Resource Name (ARN) of the solution version you want to stop creating.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** ResourceInUseException **
The specified resource is in use.
HTTP Status Code: 400
** ResourceNotFoundException **
Could not find the specified resource.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/StopSolutionVersionCreation)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/StopSolutionVersionCreation)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/StopSolutionVersionCreation)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/StopSolutionVersionCreation)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/StopSolutionVersionCreation)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/StopSolutionVersionCreation)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/StopSolutionVersionCreation)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/StopSolutionVersionCreation)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/StopSolutionVersionCreation)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/StopSolutionVersionCreation)
# TagResource
Add a list of tags to a resource.
## Request Syntax
```
{
"resourceArn": "string",
"tags": [
{
"tagKey": "string",
"tagValue": "string"
}
]
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [resourceArn](#API_TagResource_RequestSyntax) **
The resource's Amazon Resource Name (ARN).
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
** [tags](#API_TagResource_RequestSyntax) **
Tags to apply to the resource. For more information see [Tagging Amazon Personalize resources](https://docs.amazonaws.cn/personalize/latest/dg/tagging-resources.html).
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
** 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
** ResourceInUseException **
The specified resource is in use.
HTTP Status Code: 400
** ResourceNotFoundException **
Could not find the specified resource.
HTTP Status Code: 400
** TooManyTagsException **
You have exceeded the maximum number of tags you can apply to this resource.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/TagResource)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/TagResource)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/TagResource)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/TagResource)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/TagResource)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/TagResource)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/TagResource)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/TagResource)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/TagResource)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/TagResource)
# UntagResource
Removes the specified tags that are attached to a resource. For more information, see [Removing tags from Amazon Personalize resources](https://docs.amazonaws.cn/personalize/latest/dg/tags-remove.html).
## Request Syntax
```
{
"resourceArn": "string",
"tagKeys": [ "string" ]
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [resourceArn](#API_UntagResource_RequestSyntax) **
The resource's Amazon Resource Name (ARN).
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
** [tagKeys](#API_UntagResource_RequestSyntax) **
The keys of the tags to be removed.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** ResourceInUseException **
The specified resource is in use.
HTTP Status Code: 400
** ResourceNotFoundException **
Could not find the specified resource.
HTTP Status Code: 400
** TooManyTagKeysException **
The request contains more tag keys than can be associated with a resource (50 tag keys per resource).
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/UntagResource)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/UntagResource)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/UntagResource)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/UntagResource)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/UntagResource)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/UntagResource)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/UntagResource)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/UntagResource)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/UntagResource)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/UntagResource)
# UpdateCampaign
Updates a campaign to deploy a retrained solution version with an existing campaign, change your campaign's `minProvisionedTPS`, or modify your campaign's configuration. For example, you can set `enableMetadataWithRecommendations` to true for an existing campaign.
To update a campaign to start automatically using the latest solution version, specify the following:
+ For the `SolutionVersionArn` parameter, specify the Amazon Resource Name (ARN) of your solution in `SolutionArn/$LATEST` format.
+ In the `campaignConfig`, set `syncWithLatestSolutionVersion` to `true`.
To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the [DescribeCampaign](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeCampaign.html) operation.
**Note**
You can still get recommendations from a campaign while an update is in progress. The campaign will use the previous solution version and campaign configuration to generate recommendations until the latest campaign update status is `Active`.
For more information about updating a campaign, including code samples, see [Updating a campaign](https://docs.amazonaws.cn/personalize/latest/dg/update-campaigns.html). For more information about campaigns, see [Creating a campaign](https://docs.amazonaws.cn/personalize/latest/dg/campaigns.html).
## Request Syntax
```
{
"campaignArn": "string",
"campaignConfig": {
"enableMetadataWithRecommendations": boolean,
"itemExplorationConfig": {
"string" : "string"
},
"rankingInfluence": {
"string" : number
},
"syncWithLatestSolutionVersion": boolean
},
"minProvisionedTPS": number,
"solutionVersionArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [campaignArn](#API_UpdateCampaign_RequestSyntax) **
The Amazon Resource Name (ARN) of the campaign.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
** [campaignConfig](#API_UpdateCampaign_RequestSyntax) **
The configuration details of a campaign.
Type: [CampaignConfig](API_CampaignConfig.md) object
Required: No
** [minProvisionedTPS](#API_UpdateCampaign_RequestSyntax) **
Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support. A high `minProvisionedTPS` will increase your bill. We recommend starting with 1 for `minProvisionedTPS` (the default). Track your usage using Amazon CloudWatch metrics, and increase the `minProvisionedTPS` as necessary.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
** [solutionVersionArn](#API_UpdateCampaign_RequestSyntax) **
The Amazon Resource Name (ARN) of a new model to deploy. To specify the latest solution version of your solution, specify the ARN of your *solution* in `SolutionArn/$LATEST` format. You must use this format if you set `syncWithLatestSolutionVersion` to `True` in the [CampaignConfig](https://docs.amazonaws.cn/personalize/latest/dg/API_CampaignConfig.html).
To deploy a model that isn't the latest solution version of your solution, specify the ARN of the solution version.
For more information about automatic campaign updates, see [Enabling automatic campaign updates](https://docs.amazonaws.cn/personalize/latest/dg/campaigns.html#create-campaign-automatic-latest-sv-update).
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
## Response Syntax
```
{
"campaignArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [campaignArn](#API_UpdateCampaign_ResponseSyntax) **
The same campaign ARN as given in the request.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** ResourceInUseException **
The specified resource is in use.
HTTP Status Code: 400
** ResourceNotFoundException **
Could not find the specified resource.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/UpdateCampaign)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/UpdateCampaign)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/UpdateCampaign)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/UpdateCampaign)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/UpdateCampaign)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/UpdateCampaign)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/UpdateCampaign)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/UpdateCampaign)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/UpdateCampaign)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/UpdateCampaign)
# UpdateDataset
Update a dataset to replace its schema with a new or existing one. For more information, see [Replacing a dataset's schema](https://docs.amazonaws.cn/personalize/latest/dg/updating-dataset-schema.html).
## Request Syntax
```
{
"datasetArn": "string",
"schemaArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [datasetArn](#API_UpdateDataset_RequestSyntax) **
The Amazon Resource Name (ARN) of the dataset that you want to update.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
** [schemaArn](#API_UpdateDataset_RequestSyntax) **
The Amazon Resource Name (ARN) of the new schema you want use.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
## Response Syntax
```
{
"datasetArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [datasetArn](#API_UpdateDataset_ResponseSyntax) **
The Amazon Resource Name (ARN) of the dataset you updated.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** ResourceInUseException **
The specified resource is in use.
HTTP Status Code: 400
** ResourceNotFoundException **
Could not find the specified resource.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/UpdateDataset)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/UpdateDataset)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/UpdateDataset)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/UpdateDataset)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/UpdateDataset)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/UpdateDataset)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/UpdateDataset)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/UpdateDataset)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/UpdateDataset)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/UpdateDataset)
# UpdateMetricAttribution
Updates a metric attribution.
## Request Syntax
```
{
"addMetrics": [
{
"eventType": "string",
"expression": "string",
"metricName": "string"
}
],
"metricAttributionArn": "string",
"metricsOutputConfig": {
"roleArn": "string",
"s3DataDestination": {
"kmsKeyArn": "string",
"path": "string"
}
},
"removeMetrics": [ "string" ]
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [addMetrics](#API_UpdateMetricAttribution_RequestSyntax) **
Add new metric attributes to the metric attribution.
Type: Array of [MetricAttribute](API_MetricAttribute.md) objects
Array Members: Maximum number of 10 items.
Required: No
** [metricAttributionArn](#API_UpdateMetricAttribution_RequestSyntax) **
The Amazon Resource Name (ARN) for the metric attribution to update.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** [metricsOutputConfig](#API_UpdateMetricAttribution_RequestSyntax) **
An output config for the metric attribution.
Type: [MetricAttributionOutput](API_MetricAttributionOutput.md) object
Required: No
** [removeMetrics](#API_UpdateMetricAttribution_RequestSyntax) **
Remove metric attributes from the metric attribution.
Type: Array of strings
Array Members: Maximum number of 10 items.
Length Constraints: Maximum length of 256.
Required: No
## Response Syntax
```
{
"metricAttributionArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [metricAttributionArn](#API_UpdateMetricAttribution_ResponseSyntax) **
The Amazon Resource Name (ARN) for the metric attribution that you updated.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
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
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/UpdateMetricAttribution)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/UpdateMetricAttribution)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/UpdateMetricAttribution)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/UpdateMetricAttribution)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/UpdateMetricAttribution)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/UpdateMetricAttribution)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/UpdateMetricAttribution)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/UpdateMetricAttribution)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/UpdateMetricAttribution)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/UpdateMetricAttribution)
# UpdateRecommender
Updates the recommender to modify the recommender configuration. If you update the recommender to modify the columns used in training, Amazon Personalize automatically starts a full retraining of the models backing your recommender. While the update completes, you can still get recommendations from the recommender. The recommender uses the previous configuration until the update completes. To track the status of this update, use the `latestRecommenderUpdate` returned in the [DescribeRecommender](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeRecommender.html) operation.
## Request Syntax
```
{
"recommenderArn": "string",
"recommenderConfig": {
"enableMetadataWithRecommendations": boolean,
"itemExplorationConfig": {
"string" : "string"
},
"minRecommendationRequestsPerSecond": number,
"trainingDataConfig": {
"excludedDatasetColumns": {
"string" : [ "string" ]
},
"includedDatasetColumns": {
"string" : [ "string" ]
}
}
}
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [recommenderArn](#API_UpdateRecommender_RequestSyntax) **
The Amazon Resource Name (ARN) of the recommender to modify.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
** [recommenderConfig](#API_UpdateRecommender_RequestSyntax) **
The configuration details of the recommender.
Type: [RecommenderConfig](API_RecommenderConfig.md) object
Required: Yes
## Response Syntax
```
{
"recommenderArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [recommenderArn](#API_UpdateRecommender_ResponseSyntax) **
The same recommender Amazon Resource Name (ARN) as given in the request.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** ResourceInUseException **
The specified resource is in use.
HTTP Status Code: 400
** ResourceNotFoundException **
Could not find the specified resource.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/UpdateRecommender)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/UpdateRecommender)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/UpdateRecommender)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/UpdateRecommender)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/UpdateRecommender)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/UpdateRecommender)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/UpdateRecommender)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/UpdateRecommender)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/UpdateRecommender)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/UpdateRecommender)
# UpdateSolution
Updates an Amazon Personalize solution to use a different automatic training configuration. When you update a solution, you can change whether the solution uses automatic training, and you can change the training frequency. For more information about updating a solution, see [Updating a solution](https://docs.amazonaws.cn/personalize/latest/dg/updating-solution.html).
A solution update can be in one of the following states:
CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
To get the status of a solution update, call the [DescribeSolution](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeSolution.html) API operation and find the status in the `latestSolutionUpdate`.
## Request Syntax
```
{
"performAutoTraining": boolean,
"performIncrementalUpdate": boolean,
"solutionArn": "string",
"solutionUpdateConfig": {
"autoTrainingConfig": {
"schedulingExpression": "string"
},
"eventsConfig": {
"eventParametersList": [
{
"eventType": "string",
"eventValueThreshold": number,
"weight": number
}
]
}
}
}
```
## Request Parameters
The request accepts the following data in JSON format.
** [performAutoTraining](#API_UpdateSolution_RequestSyntax) **
Whether the solution uses automatic training to create new solution versions (trained models). You can change the training frequency by specifying a `schedulingExpression` in the `AutoTrainingConfig` as part of solution configuration.
If you turn on automatic training, the first automatic training starts within one hour after the solution update completes. If you manually create a solution version within the hour, the solution skips the first automatic training. For more information about automatic training, see [Configuring automatic training](https://docs.amazonaws.cn/personalize/latest/dg/solution-config-auto-training.html).
After training starts, you can get the solution version's Amazon Resource Name (ARN) with the [ListSolutionVersions](https://docs.amazonaws.cn/personalize/latest/dg/API_ListSolutionVersions.html) API operation. To get its status, use the [DescribeSolutionVersion](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeSolutionVersion.html).
Type: Boolean
Required: No
** [performIncrementalUpdate](#API_UpdateSolution_RequestSyntax) **
Whether to perform incremental training updates on your model. When enabled, this allows the model to learn from new data more frequently without requiring full retraining, which enables near real-time personalization. This parameter is supported only for solutions that use the semantic-similarity recipe.
Type: Boolean
Required: No
** [solutionArn](#API_UpdateSolution_RequestSyntax) **
The Amazon Resource Name (ARN) of the solution to update.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
** [solutionUpdateConfig](#API_UpdateSolution_RequestSyntax) **
The new configuration details of the solution.
Type: [SolutionUpdateConfig](API_SolutionUpdateConfig.md) object
Required: No
## Response Syntax
```
{
"solutionArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [solutionArn](#API_UpdateSolution_ResponseSyntax) **
The same solution Amazon Resource Name (ARN) as given in the request.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
## Errors
** 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
** ResourceInUseException **
The specified resource is in use.
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
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-2018-05-22/UpdateSolution)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-2018-05-22/UpdateSolution)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/UpdateSolution)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-2018-05-22/UpdateSolution)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/UpdateSolution)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-2018-05-22/UpdateSolution)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-2018-05-22/UpdateSolution)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-2018-05-22/UpdateSolution)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-2018-05-22/UpdateSolution)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/UpdateSolution)
# Amazon Personalize Events
The following actions are supported by Amazon Personalize Events:
+ [PutActionInteractions](API_UBS_PutActionInteractions.md)
+ [PutActions](API_UBS_PutActions.md)
+ [PutEvents](API_UBS_PutEvents.md)
+ [PutItems](API_UBS_PutItems.md)
+ [PutUsers](API_UBS_PutUsers.md)
# PutActionInteractions
Records action interaction event data. An *action interaction* event is an interaction between a user and an *action*. For example, a user taking an action, such a enrolling in a membership program or downloading your app.
For more information about recording action interactions, see [Recording action interaction events](https://docs.amazonaws.cn/personalize/latest/dg/recording-action-interaction-events.html). For more information about actions in an Actions dataset, see [Actions dataset](https://docs.amazonaws.cn/personalize/latest/dg/actions-datasets.html).
## Request Syntax
```
POST /action-interactions HTTP/1.1
Content-type: application/json
{
"actionInteractions": [
{
"actionId": "string",
"eventId": "string",
"eventType": "string",
"impression": [ "string" ],
"properties": "string",
"recommendationId": "string",
"sessionId": "string",
"timestamp": number,
"userId": "string"
}
],
"trackingId": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [actionInteractions](#API_UBS_PutActionInteractions_RequestSyntax) **
A list of action interaction events from the session.
Type: Array of [ActionInteraction](API_UBS_ActionInteraction.md) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: Yes
** [trackingId](#API_UBS_PutActionInteractions_RequestSyntax) **
The ID of your action interaction event tracker. When you create an Action interactions dataset, Amazon Personalize creates an action interaction event tracker for you. For more information, see [Action interaction event tracker ID](https://docs.amazonaws.cn/personalize/latest/dg/action-interaction-tracker-id.html).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** ResourceInUseException **
The specified resource is in use.
HTTP Status Code: 409
** ResourceNotFoundException **
Could not find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-events-2018-03-22/PutActionInteractions)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-events-2018-03-22/PutActionInteractions)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-events-2018-03-22/PutActionInteractions)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-events-2018-03-22/PutActionInteractions)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-events-2018-03-22/PutActionInteractions)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-events-2018-03-22/PutActionInteractions)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-events-2018-03-22/PutActionInteractions)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-events-2018-03-22/PutActionInteractions)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-events-2018-03-22/PutActionInteractions)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-events-2018-03-22/PutActionInteractions)
# PutActions
Adds one or more actions to an Actions dataset. For more information see [Importing actions individually](https://docs.amazonaws.cn/personalize/latest/dg/importing-actions.html).
## Request Syntax
```
POST /actions HTTP/1.1
Content-type: application/json
{
"actions": [
{
"actionId": "string",
"properties": "string"
}
],
"datasetArn": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [actions](#API_UBS_PutActions_RequestSyntax) **
A list of action data.
Type: Array of [Action](API_UBS_Action.md) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: Yes
** [datasetArn](#API_UBS_PutActions_RequestSyntax) **
The Amazon Resource Name (ARN) of the Actions dataset you are adding the action or actions to.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** ResourceInUseException **
The specified resource is in use.
HTTP Status Code: 409
** ResourceNotFoundException **
Could not find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-events-2018-03-22/PutActions)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-events-2018-03-22/PutActions)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-events-2018-03-22/PutActions)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-events-2018-03-22/PutActions)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-events-2018-03-22/PutActions)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-events-2018-03-22/PutActions)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-events-2018-03-22/PutActions)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-events-2018-03-22/PutActions)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-events-2018-03-22/PutActions)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-events-2018-03-22/PutActions)
# PutEvents
Records item interaction event data. For more information see [Recording item interaction events](https://docs.amazonaws.cn/personalize/latest/dg/recording-item-interaction-events.html).
**Note**
If you use an Amazon Lambda function to call the PutEvents operation, your function's execution role must have permission to perform the `personalize:PutEvents` action with the wildcard `*` in the `Resource` element.
## Request Syntax
```
POST /events HTTP/1.1
Content-type: application/json
{
"eventList": [
{
"eventId": "string",
"eventType": "string",
"eventValue": number,
"impression": [ "string" ],
"itemId": "string",
"metricAttribution": {
"eventAttributionSource": "string"
},
"properties": "string",
"recommendationId": "string",
"sentAt": number
}
],
"sessionId": "string",
"trackingId": "string",
"userId": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [eventList](#API_UBS_PutEvents_RequestSyntax) **
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) **
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 [Recording item interaction events](https://docs.amazonaws.cn/personalize/latest/dg/recording-item-interaction-events.html).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
** [trackingId](#API_UBS_PutEvents_RequestSyntax) **
The tracking ID for the event. The ID is generated by a call to the [CreateEventTracker](https://docs.amazonaws.cn/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) **
The user associated with the event.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-events-2018-03-22/PutEvents)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-events-2018-03-22/PutEvents)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-events-2018-03-22/PutEvents)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-events-2018-03-22/PutEvents)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-events-2018-03-22/PutEvents)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-events-2018-03-22/PutEvents)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-events-2018-03-22/PutEvents)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-events-2018-03-22/PutEvents)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-events-2018-03-22/PutEvents)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-events-2018-03-22/PutEvents)
# PutItems
Adds one or more items to an Items dataset. For more information see [Importing items individually](https://docs.amazonaws.cn/personalize/latest/dg/importing-items.html).
## Request Syntax
```
POST /items HTTP/1.1
Content-type: application/json
{
"datasetArn": "string",
"items": [
{
"itemId": "string",
"properties": "string"
}
]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [datasetArn](#API_UBS_PutItems_RequestSyntax) **
The Amazon Resource Name (ARN) of the Items dataset you are adding the item or items to.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
** [items](#API_UBS_PutItems_RequestSyntax) **
A list of item data.
Type: Array of [Item](API_UBS_Item.md) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: Yes
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** ResourceInUseException **
The specified resource is in use.
HTTP Status Code: 409
** ResourceNotFoundException **
Could not find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-events-2018-03-22/PutItems)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-events-2018-03-22/PutItems)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-events-2018-03-22/PutItems)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-events-2018-03-22/PutItems)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-events-2018-03-22/PutItems)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-events-2018-03-22/PutItems)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-events-2018-03-22/PutItems)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-events-2018-03-22/PutItems)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-events-2018-03-22/PutItems)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-events-2018-03-22/PutItems)
# PutUsers
Adds one or more users to a Users dataset. For more information see [Importing users individually](https://docs.amazonaws.cn/personalize/latest/dg/importing-users.html).
## Request Syntax
```
POST /users HTTP/1.1
Content-type: application/json
{
"datasetArn": "string",
"users": [
{
"properties": "string",
"userId": "string"
}
]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [datasetArn](#API_UBS_PutUsers_RequestSyntax) **
The Amazon Resource Name (ARN) of the Users dataset you are adding the user or users to.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
** [users](#API_UBS_PutUsers_RequestSyntax) **
A list of user data.
Type: Array of [User](API_UBS_User.md) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: Yes
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** ResourceInUseException **
The specified resource is in use.
HTTP Status Code: 409
** ResourceNotFoundException **
Could not find the specified resource.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-events-2018-03-22/PutUsers)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-events-2018-03-22/PutUsers)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-events-2018-03-22/PutUsers)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-events-2018-03-22/PutUsers)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-events-2018-03-22/PutUsers)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-events-2018-03-22/PutUsers)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-events-2018-03-22/PutUsers)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-events-2018-03-22/PutUsers)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-events-2018-03-22/PutUsers)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-events-2018-03-22/PutUsers)
# Amazon Personalize Runtime
The following actions are supported by Amazon Personalize Runtime:
+ [GetActionRecommendations](API_RS_GetActionRecommendations.md)
+ [GetPersonalizedRanking](API_RS_GetPersonalizedRanking.md)
+ [GetRecommendations](API_RS_GetRecommendations.md)
# GetActionRecommendations
Returns a list of recommended actions in sorted in descending order by prediction score. Use the `GetActionRecommendations` API if you have a custom campaign that deploys a solution version trained with a PERSONALIZED\$1ACTIONS recipe.
For more information about PERSONALIZED\$1ACTIONS recipes, see [PERSONALIZED\$1ACTIONS recipes](https://docs.amazonaws.cn/personalize/latest/dg/nexts-best-action-recipes.html). For more information about getting action recommendations, see [Getting action recommendations](https://docs.amazonaws.cn/personalize/latest/dg/get-action-recommendations.html).
## Request Syntax
```
POST /action-recommendations HTTP/1.1
Content-type: application/json
{
"campaignArn": "string",
"filterArn": "string",
"filterValues": {
"string" : "string"
},
"numResults": number,
"userId": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [campaignArn](#API_RS_GetActionRecommendations_RequestSyntax) **
The Amazon Resource Name (ARN) of the campaign to use for getting action recommendations. This campaign must deploy a solution version trained with a PERSONALIZED\$1ACTIONS recipe.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** [filterArn](#API_RS_GetActionRecommendations_RequestSyntax) **
The ARN of the filter to apply to the returned recommendations. For more information, see [Filtering Recommendations](https://docs.aws.amazon.com/personalize/latest/dg/filter.html).
When using this parameter, be sure the filter resource is `ACTIVE`.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** [filterValues](#API_RS_GetActionRecommendations_RequestSyntax) **
The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.
For filter expressions that use an `INCLUDE` element to include actions, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an `EXCLUDE` element to exclude actions, you can omit the `filter-values`. In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.
For more information, see [Filtering recommendations and user segments](https://docs.aws.amazon.com/personalize/latest/dg/filter.html).
Type: String to string map
Map Entries: Maximum number of 25 items.
Key Length Constraints: Maximum length of 50.
Key Pattern: `[A-Za-z0-9_]+`
Value Length Constraints: Maximum length of 1000.
Required: No
** [numResults](#API_RS_GetActionRecommendations_RequestSyntax) **
The number of results to return. The default is 5. The maximum is 100.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
** [userId](#API_RS_GetActionRecommendations_RequestSyntax) **
The user ID of the user to provide action recommendations for.
Type: String
Length Constraints: Maximum length of 256.
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"actionList": [
{
"actionId": "string",
"score": number
}
],
"recommendationId": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [actionList](#API_RS_GetActionRecommendations_ResponseSyntax) **
A list of action recommendations sorted in descending order by prediction score. There can be a maximum of 100 actions in the list. For information about action scores, see [How action recommendation scoring works](https://docs.amazonaws.cn/personalize/latest/dg/how-action-recommendation-scoring-works.html).
Type: Array of [PredictedAction](API_RS_PredictedAction.md) objects
** [recommendationId](#API_RS_GetActionRecommendations_ResponseSyntax) **
The ID of the recommendation.
Type: String
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** ResourceNotFoundException **
The specified resource does not exist.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-runtime-2018-05-22/GetActionRecommendations)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-runtime-2018-05-22/GetActionRecommendations)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-runtime-2018-05-22/GetActionRecommendations)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-runtime-2018-05-22/GetActionRecommendations)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-runtime-2018-05-22/GetActionRecommendations)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-runtime-2018-05-22/GetActionRecommendations)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-runtime-2018-05-22/GetActionRecommendations)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-runtime-2018-05-22/GetActionRecommendations)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-runtime-2018-05-22/GetActionRecommendations)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-runtime-2018-05-22/GetActionRecommendations)
# GetPersonalizedRanking
Re-ranks a list of recommended items for the given user. The first item in the list is deemed the most likely item to be of interest to the user.
**Note**
The solution backing the campaign must have been created using a recipe of type PERSONALIZED\$1RANKING.
## Request Syntax
```
POST /personalize-ranking HTTP/1.1
Content-type: application/json
{
"campaignArn": "string",
"context": {
"string" : "string"
},
"filterArn": "string",
"filterValues": {
"string" : "string"
},
"inputList": [ "string" ],
"metadataColumns": {
"string" : [ "string" ]
},
"userId": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [campaignArn](#API_RS_GetPersonalizedRanking_RequestSyntax) **
The Amazon Resource Name (ARN) of the campaign to use for generating the personalized ranking.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
** [context](#API_RS_GetPersonalizedRanking_RequestSyntax) **
The contextual metadata to use when getting recommendations. Contextual metadata includes any interaction information that might be relevant when getting a user's recommendations, such as the user's current location or device type.
Type: String to string map
Map Entries: Maximum number of 150 items.
Key Length Constraints: Maximum length of 150.
Key Pattern: `[A-Za-z\d_]+`
Value Length Constraints: Maximum length of 1000.
Required: No
** [filterArn](#API_RS_GetPersonalizedRanking_RequestSyntax) **
The Amazon Resource Name (ARN) of a filter you created to include items or exclude items from recommendations for a given user. For more information, see [Filtering Recommendations](https://docs.aws.amazon.com/personalize/latest/dg/filter.html).
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** [filterValues](#API_RS_GetPersonalizedRanking_RequestSyntax) **
The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.
For filter expressions that use an `INCLUDE` element to include items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an `EXCLUDE` element to exclude items, you can omit the `filter-values`.In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.
For more information, see [Filtering Recommendations](https://docs.aws.amazon.com/personalize/latest/dg/filter.html).
Type: String to string map
Map Entries: Maximum number of 25 items.
Key Length Constraints: Maximum length of 50.
Key Pattern: `[A-Za-z0-9_]+`
Value Length Constraints: Maximum length of 1000.
Required: No
** [inputList](#API_RS_GetPersonalizedRanking_RequestSyntax) **
A list of items (by `itemId`) to rank. If an item was not included in the training dataset, the item is appended to the end of the reranked list. If you are including metadata in recommendations, the maximum is 50. Otherwise, the maximum is 500.
Type: Array of strings
Length Constraints: Maximum length of 256.
Required: Yes
** [metadataColumns](#API_RS_GetPersonalizedRanking_RequestSyntax) **
If you enabled metadata in recommendations when you created or updated the campaign, specify metadata columns from your Items dataset to include in the personalized ranking. The map key is `ITEMS` and the value is a list of column names from your Items dataset. The maximum number of columns you can provide is 10.
For information about enabling metadata for a campaign, see [Enabling metadata in recommendations for a campaign](https://docs.amazonaws.cn/personalize/latest/dg/campaigns.html#create-campaign-return-metadata).
Type: String to array of strings map
Map Entries: Maximum number of 1 item.
Key Length Constraints: Maximum length of 256.
Array Members: Maximum number of 99 items.
Length Constraints: Maximum length of 150.
Required: No
** [userId](#API_RS_GetPersonalizedRanking_RequestSyntax) **
The user for which you want the campaign to provide a personalized ranking.
Type: String
Length Constraints: Maximum length of 256.
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"personalizedRanking": [
{
"itemId": "string",
"metadata": {
"string" : "string"
},
"promotionName": "string",
"reason": [ "string" ],
"score": number
}
],
"recommendationId": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [personalizedRanking](#API_RS_GetPersonalizedRanking_ResponseSyntax) **
A list of items in order of most likely interest to the user. The maximum is 500.
Type: Array of [PredictedItem](API_RS_PredictedItem.md) objects
** [recommendationId](#API_RS_GetPersonalizedRanking_ResponseSyntax) **
The ID of the recommendation.
Type: String
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** ResourceNotFoundException **
The specified resource does not exist.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-runtime-2018-05-22/GetPersonalizedRanking)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-runtime-2018-05-22/GetPersonalizedRanking)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-runtime-2018-05-22/GetPersonalizedRanking)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-runtime-2018-05-22/GetPersonalizedRanking)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-runtime-2018-05-22/GetPersonalizedRanking)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-runtime-2018-05-22/GetPersonalizedRanking)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-runtime-2018-05-22/GetPersonalizedRanking)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-runtime-2018-05-22/GetPersonalizedRanking)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-runtime-2018-05-22/GetPersonalizedRanking)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-runtime-2018-05-22/GetPersonalizedRanking)
# GetRecommendations
Returns a list of recommended items. For campaigns, the campaign's Amazon Resource Name (ARN) is required and the required user and item input depends on the recipe type used to create the solution backing the campaign as follows:
+ USER\$1PERSONALIZATION - `userId` required, `itemId` not used
+ RELATED\$1ITEMS - `itemId` required, `userId` not used
**Note**
Campaigns that are backed by a solution created using a recipe of type PERSONALIZED\$1RANKING use the [GetPersonalizedRanking](API_RS_GetPersonalizedRanking.md) API.
For recommenders, the recommender's ARN is required and the required item and user input depends on the use case (domain-based recipe) backing the recommender. For information on use case requirements see [Choosing recommender use cases](https://docs.amazonaws.cn/personalize/latest/dg/domain-use-cases.html).
## Request Syntax
```
POST /recommendations HTTP/1.1
Content-type: application/json
{
"campaignArn": "string",
"context": {
"string" : "string"
},
"filterArn": "string",
"filterValues": {
"string" : "string"
},
"itemId": "string",
"metadataColumns": {
"string" : [ "string" ]
},
"numResults": number,
"promotions": [
{
"filterArn": "string",
"filterValues": {
"string" : "string"
},
"name": "string",
"percentPromotedItems": number
}
],
"recommenderArn": "string",
"userId": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [campaignArn](#API_RS_GetRecommendations_RequestSyntax) **
The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** [context](#API_RS_GetRecommendations_RequestSyntax) **
The contextual metadata to use when getting recommendations. Contextual metadata includes any interaction information that might be relevant when getting a user's recommendations, such as the user's current location or device type.
Type: String to string map
Map Entries: Maximum number of 150 items.
Key Length Constraints: Maximum length of 150.
Key Pattern: `[A-Za-z\d_]+`
Value Length Constraints: Maximum length of 1000.
Required: No
** [filterArn](#API_RS_GetRecommendations_RequestSyntax) **
The ARN of the filter to apply to the returned recommendations. For more information, see [Filtering Recommendations](https://docs.aws.amazon.com/personalize/latest/dg/filter.html).
When using this parameter, be sure the filter resource is `ACTIVE`.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** [filterValues](#API_RS_GetRecommendations_RequestSyntax) **
The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.
For filter expressions that use an `INCLUDE` element to include items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an `EXCLUDE` element to exclude items, you can omit the `filter-values`.In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.
For more information, see [Filtering recommendations and user segments](https://docs.aws.amazon.com/personalize/latest/dg/filter.html).
Type: String to string map
Map Entries: Maximum number of 25 items.
Key Length Constraints: Maximum length of 50.
Key Pattern: `[A-Za-z0-9_]+`
Value Length Constraints: Maximum length of 1000.
Required: No
** [itemId](#API_RS_GetRecommendations_RequestSyntax) **
The item ID to provide recommendations for.
Required for `RELATED_ITEMS` recipe type.
Type: String
Length Constraints: Maximum length of 256.
Required: No
** [metadataColumns](#API_RS_GetRecommendations_RequestSyntax) **
If you enabled metadata in recommendations when you created or updated the campaign or recommender, specify the metadata columns from your Items dataset to include in item recommendations. The map key is `ITEMS` and the value is a list of column names from your Items dataset. The maximum number of columns you can provide is 10.
For information about enabling metadata for a campaign, see [Enabling metadata in recommendations for a campaign](https://docs.amazonaws.cn/personalize/latest/dg/campaigns.html#create-campaign-return-metadata). For information about enabling metadata for a recommender, see [Enabling metadata in recommendations for a recommender](https://docs.amazonaws.cn/personalize/latest/dg/creating-recommenders.html#create-recommender-return-metadata).
Type: String to array of strings map
Map Entries: Maximum number of 1 item.
Key Length Constraints: Maximum length of 256.
Array Members: Maximum number of 99 items.
Length Constraints: Maximum length of 150.
Required: No
** [numResults](#API_RS_GetRecommendations_RequestSyntax) **
The number of results to return. The default is 25. If you are including metadata in recommendations, the maximum is 50. Otherwise, the maximum is 500.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
** [promotions](#API_RS_GetRecommendations_RequestSyntax) **
The promotions to apply to the recommendation request. A promotion defines additional business rules that apply to a configurable subset of recommended items.
Type: Array of [Promotion](API_RS_Promotion.md) objects
Array Members: Maximum number of 1 item.
Required: No
** [recommenderArn](#API_RS_GetRecommendations_RequestSyntax) **
The Amazon Resource Name (ARN) of the recommender to use to get recommendations. Provide a recommender ARN if you created a Domain dataset group with a recommender for a domain use case.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** [userId](#API_RS_GetRecommendations_RequestSyntax) **
The user ID to provide recommendations for.
Required for `USER_PERSONALIZATION` recipe type.
Type: String
Length Constraints: Maximum length of 256.
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"itemList": [
{
"itemId": "string",
"metadata": {
"string" : "string"
},
"promotionName": "string",
"reason": [ "string" ],
"score": number
}
],
"recommendationId": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [itemList](#API_RS_GetRecommendations_ResponseSyntax) **
A list of recommendations sorted in descending order by prediction score. There can be a maximum of 500 items in the list.
Type: Array of [PredictedItem](API_RS_PredictedItem.md) objects
** [recommendationId](#API_RS_GetRecommendations_ResponseSyntax) **
The ID of the recommendation.
Type: String
## Errors
** InvalidInputException **
Provide a valid value for the field or parameter.
HTTP Status Code: 400
** ResourceNotFoundException **
The specified resource does not exist.
HTTP Status Code: 404
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/personalize-runtime-2018-05-22/GetRecommendations)
+ [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/personalize-runtime-2018-05-22/GetRecommendations)
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-runtime-2018-05-22/GetRecommendations)
+ [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/personalize-runtime-2018-05-22/GetRecommendations)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-runtime-2018-05-22/GetRecommendations)
+ [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/personalize-runtime-2018-05-22/GetRecommendations)
+ [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/personalize-runtime-2018-05-22/GetRecommendations)
+ [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/personalize-runtime-2018-05-22/GetRecommendations)
+ [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/personalize-runtime-2018-05-22/GetRecommendations)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-runtime-2018-05-22/GetRecommendations)
# Data Types
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)
+ [AutoTrainingConfig](API_AutoTrainingConfig.md)
+ [BatchInferenceJob](API_BatchInferenceJob.md)
+ [BatchInferenceJobConfig](API_BatchInferenceJobConfig.md)
+ [BatchInferenceJobInput](API_BatchInferenceJobInput.md)
+ [BatchInferenceJobOutput](API_BatchInferenceJobOutput.md)
+ [BatchInferenceJobSummary](API_BatchInferenceJobSummary.md)
+ [BatchSegmentJob](API_BatchSegmentJob.md)
+ [BatchSegmentJobInput](API_BatchSegmentJobInput.md)
+ [BatchSegmentJobOutput](API_BatchSegmentJobOutput.md)
+ [BatchSegmentJobSummary](API_BatchSegmentJobSummary.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)
+ [DataDeletionJob](API_DataDeletionJob.md)
+ [DataDeletionJobSummary](API_DataDeletionJobSummary.md)
+ [Dataset](API_Dataset.md)
+ [DatasetExportJob](API_DatasetExportJob.md)
+ [DatasetExportJobOutput](API_DatasetExportJobOutput.md)
+ [DatasetExportJobSummary](API_DatasetExportJobSummary.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)
+ [DatasetUpdateSummary](API_DatasetUpdateSummary.md)
+ [DataSource](API_DataSource.md)
+ [DefaultCategoricalHyperParameterRange](API_DefaultCategoricalHyperParameterRange.md)
+ [DefaultContinuousHyperParameterRange](API_DefaultContinuousHyperParameterRange.md)
+ [DefaultHyperParameterRanges](API_DefaultHyperParameterRanges.md)
+ [DefaultIntegerHyperParameterRange](API_DefaultIntegerHyperParameterRange.md)
+ [EventParameters](API_EventParameters.md)
+ [EventsConfig](API_EventsConfig.md)
+ [EventTracker](API_EventTracker.md)
+ [EventTrackerSummary](API_EventTrackerSummary.md)
+ [FeatureTransformation](API_FeatureTransformation.md)
+ [FieldsForThemeGeneration](API_FieldsForThemeGeneration.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)
+ [MetricAttribute](API_MetricAttribute.md)
+ [MetricAttribution](API_MetricAttribution.md)
+ [MetricAttributionOutput](API_MetricAttributionOutput.md)
+ [MetricAttributionSummary](API_MetricAttributionSummary.md)
+ [OptimizationObjective](API_OptimizationObjective.md)
+ [Recipe](API_Recipe.md)
+ [RecipeSummary](API_RecipeSummary.md)
+ [Recommender](API_Recommender.md)
+ [RecommenderConfig](API_RecommenderConfig.md)
+ [RecommenderSummary](API_RecommenderSummary.md)
+ [RecommenderUpdateSummary](API_RecommenderUpdateSummary.md)
+ [S3DataConfig](API_S3DataConfig.md)
+ [Solution](API_Solution.md)
+ [SolutionConfig](API_SolutionConfig.md)
+ [SolutionSummary](API_SolutionSummary.md)
+ [SolutionUpdateConfig](API_SolutionUpdateConfig.md)
+ [SolutionUpdateSummary](API_SolutionUpdateSummary.md)
+ [SolutionVersion](API_SolutionVersion.md)
+ [SolutionVersionSummary](API_SolutionVersionSummary.md)
+ [Tag](API_Tag.md)
+ [ThemeGenerationConfig](API_ThemeGenerationConfig.md)
+ [TrainingDataConfig](API_TrainingDataConfig.md)
+ [TunedHPOParams](API_TunedHPOParams.md)
The following data types are supported by Amazon Personalize Events:
+ [Action](API_UBS_Action.md)
+ [ActionInteraction](API_UBS_ActionInteraction.md)
+ [Event](API_UBS_Event.md)
+ [Item](API_UBS_Item.md)
+ [MetricAttribution](API_UBS_MetricAttribution.md)
+ [User](API_UBS_User.md)
The following data types are supported by Amazon Personalize Runtime:
+ [PredictedAction](API_RS_PredictedAction.md)
+ [PredictedItem](API_RS_PredictedItem.md)
+ [Promotion](API_RS_Promotion.md)
# Amazon Personalize
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)
+ [AutoTrainingConfig](API_AutoTrainingConfig.md)
+ [BatchInferenceJob](API_BatchInferenceJob.md)
+ [BatchInferenceJobConfig](API_BatchInferenceJobConfig.md)
+ [BatchInferenceJobInput](API_BatchInferenceJobInput.md)
+ [BatchInferenceJobOutput](API_BatchInferenceJobOutput.md)
+ [BatchInferenceJobSummary](API_BatchInferenceJobSummary.md)
+ [BatchSegmentJob](API_BatchSegmentJob.md)
+ [BatchSegmentJobInput](API_BatchSegmentJobInput.md)
+ [BatchSegmentJobOutput](API_BatchSegmentJobOutput.md)
+ [BatchSegmentJobSummary](API_BatchSegmentJobSummary.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)
+ [DataDeletionJob](API_DataDeletionJob.md)
+ [DataDeletionJobSummary](API_DataDeletionJobSummary.md)
+ [Dataset](API_Dataset.md)
+ [DatasetExportJob](API_DatasetExportJob.md)
+ [DatasetExportJobOutput](API_DatasetExportJobOutput.md)
+ [DatasetExportJobSummary](API_DatasetExportJobSummary.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)
+ [DatasetUpdateSummary](API_DatasetUpdateSummary.md)
+ [DataSource](API_DataSource.md)
+ [DefaultCategoricalHyperParameterRange](API_DefaultCategoricalHyperParameterRange.md)
+ [DefaultContinuousHyperParameterRange](API_DefaultContinuousHyperParameterRange.md)
+ [DefaultHyperParameterRanges](API_DefaultHyperParameterRanges.md)
+ [DefaultIntegerHyperParameterRange](API_DefaultIntegerHyperParameterRange.md)
+ [EventParameters](API_EventParameters.md)
+ [EventsConfig](API_EventsConfig.md)
+ [EventTracker](API_EventTracker.md)
+ [EventTrackerSummary](API_EventTrackerSummary.md)
+ [FeatureTransformation](API_FeatureTransformation.md)
+ [FieldsForThemeGeneration](API_FieldsForThemeGeneration.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)
+ [MetricAttribute](API_MetricAttribute.md)
+ [MetricAttribution](API_MetricAttribution.md)
+ [MetricAttributionOutput](API_MetricAttributionOutput.md)
+ [MetricAttributionSummary](API_MetricAttributionSummary.md)
+ [OptimizationObjective](API_OptimizationObjective.md)
+ [Recipe](API_Recipe.md)
+ [RecipeSummary](API_RecipeSummary.md)
+ [Recommender](API_Recommender.md)
+ [RecommenderConfig](API_RecommenderConfig.md)
+ [RecommenderSummary](API_RecommenderSummary.md)
+ [RecommenderUpdateSummary](API_RecommenderUpdateSummary.md)
+ [S3DataConfig](API_S3DataConfig.md)
+ [Solution](API_Solution.md)
+ [SolutionConfig](API_SolutionConfig.md)
+ [SolutionSummary](API_SolutionSummary.md)
+ [SolutionUpdateConfig](API_SolutionUpdateConfig.md)
+ [SolutionUpdateSummary](API_SolutionUpdateSummary.md)
+ [SolutionVersion](API_SolutionVersion.md)
+ [SolutionVersionSummary](API_SolutionVersionSummary.md)
+ [Tag](API_Tag.md)
+ [ThemeGenerationConfig](API_ThemeGenerationConfig.md)
+ [TrainingDataConfig](API_TrainingDataConfig.md)
+ [TunedHPOParams](API_TunedHPOParams.md)
# Algorithm
Describes a custom algorithm.
## Contents
** algorithmArn **
The Amazon Resource Name (ARN) of the algorithm.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** algorithmImage **
The URI of the Docker container for the algorithm image.
Type: [AlgorithmImage](API_AlgorithmImage.md) object
Required: No
** creationDateTime **
The date and time (in Unix time) that the algorithm was created.
Type: Timestamp
Required: No
** defaultHyperParameterRanges **
Specifies the default hyperparameters, their ranges, and whether they are tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).
Type: [DefaultHyperParameterRanges](API_DefaultHyperParameterRanges.md) object
Required: No
** defaultHyperParameters **
Specifies the default hyperparameters.
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
** defaultResourceConfig **
Specifies the default maximum number of training jobs and parallel training jobs.
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
** lastUpdatedDateTime **
The date and time (in Unix time) that the algorithm was last updated.
Type: Timestamp
Required: No
** name **
The name of the algorithm.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
** roleArn **
The Amazon Resource Name (ARN) of the role.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** trainingInputMode **
The training input mode.
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/Algorithm)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/Algorithm)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/Algorithm)
# AlgorithmImage
Describes an algorithm image.
## Contents
** dockerURI **
The URI of the Docker container for the algorithm image.
Type: String
Length Constraints: Maximum length of 256.
Required: Yes
** name **
The name of the algorithm image.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/AlgorithmImage)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/AlgorithmImage)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/AlgorithmImage)
# AutoMLConfig
When the solution performs AutoML (`performAutoML` is true in [CreateSolution](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateSolution.html)), Amazon Personalize determines which recipe, from the specified list, optimizes the given metric. Amazon Personalize then uses that recipe for the solution.
## Contents
** metricName **
The metric to optimize.
Type: String
Length Constraints: Maximum length of 256.
Required: No
** recipeList **
The list of candidate recipes.
Type: Array of strings
Array Members: Maximum number of 100 items.
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/AutoMLConfig)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/AutoMLConfig)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/AutoMLConfig)
# AutoMLResult
When the solution performs AutoML (`performAutoML` is true in [CreateSolution](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateSolution.html)), specifies the recipe that best optimized the specified metric.
## Contents
** bestRecipeArn **
The Amazon Resource Name (ARN) of the best recipe.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/AutoMLResult)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/AutoMLResult)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/AutoMLResult)
# AutoTrainingConfig
The automatic training configuration to use when `performAutoTraining` is true.
## Contents
** schedulingExpression **
Specifies how often to automatically train new solution versions. Specify a rate expression in rate(*value* *unit*) format. For value, specify a number between 1 and 30. For unit, specify `day` or `days`. For example, to automatically create a new solution version every 5 days, specify `rate(5 days)`. The default is every 7 days.
For more information about auto training, see [Creating and configuring a solution](https://docs.amazonaws.cn/personalize/latest/dg/customizing-solution-config.html).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 16.
Pattern: `rate\(\d+ days?\)`
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/AutoTrainingConfig)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/AutoTrainingConfig)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/AutoTrainingConfig)
# BatchInferenceJob
Contains information on a batch inference job.
## Contents
** batchInferenceJobArn **
The Amazon Resource Name (ARN) of the batch inference job.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** batchInferenceJobConfig **
A string to string map of the configuration details of a batch inference job.
Type: [BatchInferenceJobConfig](API_BatchInferenceJobConfig.md) object
Required: No
** batchInferenceJobMode **
The job's mode.
Type: String
Valid Values: `BATCH_INFERENCE | THEME_GENERATION`
Required: No
** creationDateTime **
The time at which the batch inference job was created.
Type: Timestamp
Required: No
** failureReason **
If the batch inference job failed, the reason for the failure.
Type: String
Required: No
** filterArn **
The ARN of the filter used on the batch inference job.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** jobInput **
The Amazon S3 path that leads to the input data used to generate the batch inference job.
Type: [BatchInferenceJobInput](API_BatchInferenceJobInput.md) object
Required: No
** jobName **
The name of the batch inference job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
** jobOutput **
The Amazon S3 bucket that contains the output data generated by the batch inference job.
Type: [BatchInferenceJobOutput](API_BatchInferenceJobOutput.md) object
Required: No
** lastUpdatedDateTime **
The time at which the batch inference job was last updated.
Type: Timestamp
Required: No
** numResults **
The number of recommendations generated by the batch inference job. This number includes the error messages generated for failed input records.
Type: Integer
Required: No
** roleArn **
The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`
Required: No
** solutionVersionArn **
The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** status **
The status of the batch inference job. The status is one of the following values:
+ PENDING
+ IN PROGRESS
+ ACTIVE
+ CREATE FAILED
Type: String
Length Constraints: Maximum length of 256.
Required: No
** themeGenerationConfig **
The job's theme generation settings.
Type: [ThemeGenerationConfig](API_ThemeGenerationConfig.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/BatchInferenceJob)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/BatchInferenceJob)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/BatchInferenceJob)
# BatchInferenceJobConfig
The configuration details of a batch inference job.
## Contents
** itemExplorationConfig **
A string to string map specifying the exploration configuration hyperparameters, including `explorationWeight` and `explorationItemAgeCutOff`, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. See [User-Personalization](https://docs.amazonaws.cn/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html).
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
** rankingInfluence **
A map of ranking influence values for POPULARITY and FRESHNESS. For each key, specify a numerical value between 0.0 and 1.0 that determines how much influence that ranking factor has on the final recommendations. A value closer to 1.0 gives more weight to the factor, while a value closer to 0.0 reduces its influence. If not specified, both default to 0.0.
Type: String to double map
Valid Keys: `POPULARITY | FRESHNESS`
Valid Range: Minimum value of 0. Maximum value of 1.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/BatchInferenceJobConfig)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/BatchInferenceJobConfig)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/BatchInferenceJobConfig)
# BatchInferenceJobInput
The input configuration of a batch inference job.
## Contents
** s3DataSource **
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
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/BatchInferenceJobInput)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/BatchInferenceJobInput)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/BatchInferenceJobInput)
# BatchInferenceJobOutput
The output configuration parameters of a batch inference job.
## Contents
** s3DataDestination **
Information on the Amazon S3 bucket in which the batch inference job's output is stored.
Type: [S3DataConfig](API_S3DataConfig.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/BatchInferenceJobOutput)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/BatchInferenceJobOutput)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/BatchInferenceJobOutput)
# BatchInferenceJobSummary
A truncated version of the [BatchInferenceJob](https://docs.amazonaws.cn/personalize/latest/dg/API_BatchInferenceJob.html). The [ListBatchInferenceJobs](https://docs.amazonaws.cn/personalize/latest/dg/API_ListBatchInferenceJobs.html) operation returns a list of batch inference job summaries.
## Contents
** batchInferenceJobArn **
The Amazon Resource Name (ARN) of the batch inference job.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** batchInferenceJobMode **
The job's mode.
Type: String
Valid Values: `BATCH_INFERENCE | THEME_GENERATION`
Required: No
** creationDateTime **
The time at which the batch inference job was created.
Type: Timestamp
Required: No
** failureReason **
If the batch inference job failed, the reason for the failure.
Type: String
Required: No
** jobName **
The name of the batch inference job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
** lastUpdatedDateTime **
The time at which the batch inference job was last updated.
Type: Timestamp
Required: No
** solutionVersionArn **
The ARN of the solution version used by the batch inference job.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** status **
The status of the batch inference job. The status is one of the following values:
+ PENDING
+ IN PROGRESS
+ ACTIVE
+ CREATE FAILED
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/BatchInferenceJobSummary)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/BatchInferenceJobSummary)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/BatchInferenceJobSummary)
# BatchSegmentJob
Contains information on a batch segment job.
## Contents
** batchSegmentJobArn **
The Amazon Resource Name (ARN) of the batch segment job.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** creationDateTime **
The time at which the batch segment job was created.
Type: Timestamp
Required: No
** failureReason **
If the batch segment job failed, the reason for the failure.
Type: String
Required: No
** filterArn **
The ARN of the filter used on the batch segment job.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** jobInput **
The Amazon S3 path that leads to the input data used to generate the batch segment job.
Type: [BatchSegmentJobInput](API_BatchSegmentJobInput.md) object
Required: No
** jobName **
The name of the batch segment job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
** jobOutput **
The Amazon S3 bucket that contains the output data generated by the batch segment job.
Type: [BatchSegmentJobOutput](API_BatchSegmentJobOutput.md) object
Required: No
** lastUpdatedDateTime **
The time at which the batch segment job last updated.
Type: Timestamp
Required: No
** numResults **
The number of predicted users generated by the batch segment job for each line of input data. The maximum number of users per segment is 5 million.
Type: Integer
Required: No
** roleArn **
The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`
Required: No
** solutionVersionArn **
The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** status **
The status of the batch segment job. The status is one of the following values:
+ PENDING
+ IN PROGRESS
+ ACTIVE
+ CREATE FAILED
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/BatchSegmentJob)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/BatchSegmentJob)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/BatchSegmentJob)
# BatchSegmentJobInput
The input configuration of a batch segment job.
## Contents
** s3DataSource **
The configuration details of an Amazon S3 input or output bucket.
Type: [S3DataConfig](API_S3DataConfig.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/BatchSegmentJobInput)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/BatchSegmentJobInput)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/BatchSegmentJobInput)
# BatchSegmentJobOutput
The output configuration parameters of a batch segment job.
## Contents
** s3DataDestination **
The configuration details of an Amazon S3 input or output bucket.
Type: [S3DataConfig](API_S3DataConfig.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/BatchSegmentJobOutput)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/BatchSegmentJobOutput)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/BatchSegmentJobOutput)
# BatchSegmentJobSummary
A truncated version of the [BatchSegmentJob](https://docs.amazonaws.cn/personalize/latest/dg/API_BatchSegmentJob.html) datatype. [ListBatchSegmentJobs](https://docs.amazonaws.cn/personalize/latest/dg/API_ListBatchSegmentJobs.html) operation returns a list of batch segment job summaries.
## Contents
** batchSegmentJobArn **
The Amazon Resource Name (ARN) of the batch segment job.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** creationDateTime **
The time at which the batch segment job was created.
Type: Timestamp
Required: No
** failureReason **
If the batch segment job failed, the reason for the failure.
Type: String
Required: No
** jobName **
The name of the batch segment job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
** lastUpdatedDateTime **
The time at which the batch segment job was last updated.
Type: Timestamp
Required: No
** solutionVersionArn **
The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** status **
The status of the batch segment job. The status is one of the following values:
+ PENDING
+ IN PROGRESS
+ ACTIVE
+ CREATE FAILED
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/BatchSegmentJobSummary)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/BatchSegmentJobSummary)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/BatchSegmentJobSummary)
# Campaign
An object that describes the deployment of a solution version. For more information on campaigns, see [CreateCampaign](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateCampaign.html).
## Contents
** campaignArn **
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 **
The configuration details of a campaign.
Type: [CampaignConfig](API_CampaignConfig.md) object
Required: No
** creationDateTime **
The date and time (in Unix format) that the campaign was created.
Type: Timestamp
Required: No
** failureReason **
If a campaign fails, the reason behind the failure.
Type: String
Required: No
** lastUpdatedDateTime **
The date and time (in Unix format) that the campaign was last updated.
Type: Timestamp
Required: No
** latestCampaignUpdate **
Provides a summary of the properties of a campaign update. For a complete listing, call the [DescribeCampaign](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeCampaign.html) API.
The `latestCampaignUpdate` field is only returned when the campaign has had at least one `UpdateCampaign` call.
Type: [CampaignUpdateSummary](API_CampaignUpdateSummary.md) object
Required: No
** minProvisionedTPS **
Specifies the requested minimum provisioned transactions (recommendations) per second. A high `minProvisionedTPS` will increase your bill. We recommend starting with 1 for `minProvisionedTPS` (the default). Track your usage using Amazon CloudWatch metrics, and increase the `minProvisionedTPS` as necessary.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
** name **
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 **
The Amazon Resource Name (ARN) of the solution version the campaign uses.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** status **
The status of the campaign.
A campaign can be in one of the following states:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/Campaign)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/Campaign)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/Campaign)
# CampaignConfig
The configuration details of a campaign.
## Contents
** enableMetadataWithRecommendations **
Whether metadata with recommendations is enabled for the campaign. If enabled, you can specify the columns from your Items dataset in your request for recommendations. Amazon Personalize returns this data for each item in the recommendation response. For information about enabling metadata for a campaign, see [Enabling metadata in recommendations for a campaign](https://docs.amazonaws.cn/personalize/latest/dg/campaigns.html#create-campaign-return-metadata).
If you enable metadata in recommendations, you will incur additional costs. For more information, see [Amazon Personalize pricing](https://aws.amazon.com/personalize/pricing/).
Type: Boolean
Required: No
** itemExplorationConfig **
Specifies the exploration configuration hyperparameters, including `explorationWeight` and `explorationItemAgeCutOff`, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide `itemExplorationConfig` data only if your solution uses the [User-Personalization](https://docs.amazonaws.cn/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html) recipe.
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
** rankingInfluence **
A map of ranking influence values for POPULARITY and FRESHNESS. For each key, specify a numerical value between 0.0 and 1.0 that determines how much influence that ranking factor has on the final recommendations. A value closer to 1.0 gives more weight to the factor, while a value closer to 0.0 reduces its influence. If not specified, both default to 0.0.
Type: String to double map
Valid Keys: `POPULARITY | FRESHNESS`
Valid Range: Minimum value of 0. Maximum value of 1.
Required: No
** syncWithLatestSolutionVersion **
Whether the campaign automatically updates to use the latest solution version (trained model) of a solution. If you specify `True`, you must specify the ARN of your *solution* for the `SolutionVersionArn` parameter. It must be in `SolutionArn/$LATEST` format. The default is `False` and you must manually update the campaign to deploy the latest solution version.
For more information about automatic campaign updates, see [Enabling automatic campaign updates](https://docs.amazonaws.cn/personalize/latest/dg/campaigns.html#create-campaign-automatic-latest-sv-update).
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/CampaignConfig)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/CampaignConfig)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/CampaignConfig)
# CampaignSummary
Provides a summary of the properties of a campaign. For a complete listing, call the [DescribeCampaign](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeCampaign.html) API.
## Contents
** campaignArn **
The Amazon Resource Name (ARN) of the campaign.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** creationDateTime **
The date and time (in Unix time) that the campaign was created.
Type: Timestamp
Required: No
** failureReason **
If a campaign fails, the reason behind the failure.
Type: String
Required: No
** lastUpdatedDateTime **
The date and time (in Unix time) that the campaign was last updated.
Type: Timestamp
Required: No
** name **
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
** status **
The status of the campaign.
A campaign can be in one of the following states:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/CampaignSummary)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/CampaignSummary)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/CampaignSummary)
# CampaignUpdateSummary
Provides a summary of the properties of a campaign update. For a complete listing, call the [DescribeCampaign](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeCampaign.html) API.
## Contents
** campaignConfig **
The configuration details of a campaign.
Type: [CampaignConfig](API_CampaignConfig.md) object
Required: No
** creationDateTime **
The date and time (in Unix time) that the campaign update was created.
Type: Timestamp
Required: No
** failureReason **
If a campaign update fails, the reason behind the failure.
Type: String
Required: No
** lastUpdatedDateTime **
The date and time (in Unix time) that the campaign update was last updated.
Type: Timestamp
Required: No
** minProvisionedTPS **
Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
** solutionVersionArn **
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 **
The status of the campaign update.
A campaign update can be in one of the following states:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/CampaignUpdateSummary)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/CampaignUpdateSummary)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/CampaignUpdateSummary)
# CategoricalHyperParameterRange
Provides the name and range of a categorical hyperparameter.
## Contents
** name **
The name of the hyperparameter.
Type: String
Length Constraints: Maximum length of 256.
Required: No
** values **
A list of the categories for the hyperparameter.
Type: Array of strings
Array Members: Maximum number of 100 items.
Length Constraints: Maximum length of 1000.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/CategoricalHyperParameterRange)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/CategoricalHyperParameterRange)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/CategoricalHyperParameterRange)
# ContinuousHyperParameterRange
Provides the name and range of a continuous hyperparameter.
## Contents
** maxValue **
The maximum allowable value for the hyperparameter.
Type: Double
Valid Range: Minimum value of -1000000.
Required: No
** minValue **
The minimum allowable value for the hyperparameter.
Type: Double
Valid Range: Minimum value of -1000000.
Required: No
** name **
The name of the hyperparameter.
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/ContinuousHyperParameterRange)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/ContinuousHyperParameterRange)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/ContinuousHyperParameterRange)
# DataDeletionJob
Describes a job that deletes all references to specific users from an Amazon Personalize dataset group in batches. For information about creating a data deletion job, see [Deleting users](https://docs.amazonaws.cn/personalize/latest/dg/delete-records.html).
## Contents
** creationDateTime **
The creation date and time (in Unix time) of the data deletion job.
Type: Timestamp
Required: No
** dataDeletionJobArn **
The Amazon Resource Name (ARN) of the data deletion job.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** datasetGroupArn **
The Amazon Resource Name (ARN) of the dataset group the job deletes records from.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** dataSource **
Describes the data source that contains the data to upload to a dataset, or the list of records to delete from Amazon Personalize.
Type: [DataSource](API_DataSource.md) object
Required: No
** failureReason **
If a data deletion job fails, provides the reason why.
Type: String
Required: No
** jobName **
The name of the data deletion job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
** lastUpdatedDateTime **
The date and time (in Unix time) the data deletion job was last updated.
Type: Timestamp
Required: No
** numDeleted **
The number of records deleted by a COMPLETED job.
Type: Integer
Required: No
** roleArn **
The Amazon Resource Name (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: No
** status **
The status of the data deletion job.
A data deletion job can have one of the following statuses:
+ PENDING > IN\$1PROGRESS > COMPLETED -or- FAILED
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DataDeletionJob)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DataDeletionJob)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DataDeletionJob)
# DataDeletionJobSummary
Provides a summary of the properties of a data deletion job. For a complete listing, call the [DescribeDataDeletionJob](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeDataDeletionJob.html) API operation.
## Contents
** creationDateTime **
The creation date and time (in Unix time) of the data deletion job.
Type: Timestamp
Required: No
** dataDeletionJobArn **
The Amazon Resource Name (ARN) of the data deletion job.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** datasetGroupArn **
The Amazon Resource Name (ARN) of the dataset group the job deleted records from.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** failureReason **
If a data deletion job fails, provides the reason why.
Type: String
Required: No
** jobName **
The name of the data deletion job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
** lastUpdatedDateTime **
The date and time (in Unix time) the data deletion job was last updated.
Type: Timestamp
Required: No
** status **
The status of the data deletion job.
A data deletion job can have one of the following statuses:
+ PENDING > IN\$1PROGRESS > COMPLETED -or- FAILED
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DataDeletionJobSummary)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DataDeletionJobSummary)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DataDeletionJobSummary)
# Dataset
Provides metadata for a dataset.
## Contents
** creationDateTime **
The creation date and time (in Unix time) of the dataset.
Type: Timestamp
Required: No
** datasetArn **
The Amazon Resource Name (ARN) of the dataset that you want metadata for.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** datasetGroupArn **
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
** datasetType **
One of the following values:
+ Interactions
+ Items
+ Users
+ Actions
+ Action\$1Interactions
Type: String
Length Constraints: Maximum length of 256.
Pattern: `^[A-Za-z_]+$`
Required: No
** lastUpdatedDateTime **
A time stamp that shows when the dataset was updated.
Type: Timestamp
Required: No
** latestDatasetUpdate **
Describes the latest update to the dataset.
Type: [DatasetUpdateSummary](API_DatasetUpdateSummary.md) object
Required: No
** name **
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
** schemaArn **
The ARN of the associated schema.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** status **
The status of the dataset.
A dataset can be in one of the following states:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
Type: String
Length Constraints: Maximum length of 256.
Required: No
** trackingId **
The ID of the event tracker for an Action interactions dataset. You specify the tracker's ID in the `PutActionInteractions` API operation. Amazon Personalize uses it to direct new data to the Action interactions dataset in your dataset group.
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/Dataset)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/Dataset)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/Dataset)
# DatasetExportJob
Describes a job that exports a dataset to an Amazon S3 bucket. For more information, see [CreateDatasetExportJob](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateDatasetExportJob.html).
A dataset export job can be in one of the following states:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
## Contents
** creationDateTime **
The creation date and time (in Unix time) of the dataset export job.
Type: Timestamp
Required: No
** datasetArn **
The Amazon Resource Name (ARN) of the dataset to export.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** datasetExportJobArn **
The Amazon Resource Name (ARN) of the dataset export job.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** failureReason **
If a dataset export job fails, provides the reason why.
Type: String
Required: No
** ingestionMode **
The data to export, based on how you imported the data. You can choose to export `BULK` data that you imported using a dataset import job, `PUT` data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or `ALL` for both types. The default value is `PUT`.
Type: String
Valid Values: `BULK | PUT | ALL`
Required: No
** jobName **
The name of the export job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
** jobOutput **
The path to the Amazon S3 bucket where the job's output is stored. For example:
`s3://bucket-name/folder-name/`
Type: [DatasetExportJobOutput](API_DatasetExportJobOutput.md) object
Required: No
** lastUpdatedDateTime **
The date and time (in Unix time) the status of the dataset export job was last updated.
Type: Timestamp
Required: No
** roleArn **
The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** status **
The status of the dataset export job.
A dataset export job can be in one of the following states:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DatasetExportJob)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DatasetExportJob)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DatasetExportJob)
# DatasetExportJobOutput
The output configuration parameters of a dataset export job.
## Contents
** s3DataDestination **
The configuration details of an Amazon S3 input or output bucket.
Type: [S3DataConfig](API_S3DataConfig.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DatasetExportJobOutput)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DatasetExportJobOutput)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DatasetExportJobOutput)
# DatasetExportJobSummary
Provides a summary of the properties of a dataset export job. For a complete listing, call the [DescribeDatasetExportJob](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeDatasetExportJob.html) API.
## Contents
** creationDateTime **
The date and time (in Unix time) that the dataset export job was created.
Type: Timestamp
Required: No
** datasetExportJobArn **
The Amazon Resource Name (ARN) of the dataset export job.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** failureReason **
If a dataset export job fails, the reason behind the failure.
Type: String
Required: No
** jobName **
The name of the dataset export job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
** lastUpdatedDateTime **
The date and time (in Unix time) that the dataset export job status was last updated.
Type: Timestamp
Required: No
** status **
The status of the dataset export job.
A dataset export job can be in one of the following states:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DatasetExportJobSummary)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DatasetExportJobSummary)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DatasetExportJobSummary)
# DatasetGroup
A dataset group is a collection of related datasets (Item interactions, Users, Items, Actions, Action interactions). You create a dataset group by calling [CreateDatasetGroup](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateDatasetGroup.html). You then create a dataset and add it to a dataset group by calling [CreateDataset](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateDataset.html). The dataset group is used to create and train a solution by calling [CreateSolution](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateSolution.html). A dataset group can contain only one of each type of dataset.
You can specify an Amazon Key Management Service (KMS) key to encrypt the datasets in the group.
## Contents
** creationDateTime **
The creation date and time (in Unix time) of the dataset group.
Type: Timestamp
Required: No
** datasetGroupArn **
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
** domain **
The domain of a Domain dataset group.
Type: String
Valid Values: `ECOMMERCE | VIDEO_ON_DEMAND`
Required: No
** failureReason **
If creating a dataset group fails, provides the reason why.
Type: String
Required: No
** kmsKeyArn **
The Amazon Resource Name (ARN) of the Amazon Key Management Service (KMS) key used to encrypt the datasets.
Type: String
Length Constraints: Maximum length of 2048.
Pattern: `arn:aws.*:kms:.*:[0-9]{12}:key/.*`
Required: No
** lastUpdatedDateTime **
The last update date and time (in Unix time) of the dataset group.
Type: Timestamp
Required: No
** name **
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 **
The ARN of the Amazon Identity and Access Management (IAM) role that has permissions to access the Amazon Key Management Service (KMS) key. Supplying an IAM role is only valid when also specifying a KMS key.
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 **
The current status of the dataset group.
A dataset group can be in one of the following states:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DatasetGroup)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DatasetGroup)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DatasetGroup)
# DatasetGroupSummary
Provides a summary of the properties of a dataset group. For a complete listing, call the [DescribeDatasetGroup](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeDatasetGroup.html) API.
## Contents
** creationDateTime **
The date and time (in Unix time) that the dataset group was created.
Type: Timestamp
Required: No
** datasetGroupArn **
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
** domain **
The domain of a Domain dataset group.
Type: String
Valid Values: `ECOMMERCE | VIDEO_ON_DEMAND`
Required: No
** failureReason **
If creating a dataset group fails, the reason behind the failure.
Type: String
Required: No
** lastUpdatedDateTime **
The date and time (in Unix time) that the dataset group was last updated.
Type: Timestamp
Required: No
** name **
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
** status **
The status of the dataset group.
A dataset group can be in one of the following states:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DatasetGroupSummary)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DatasetGroupSummary)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DatasetGroupSummary)
# DatasetImportJob
Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset. For more information, see [CreateDatasetImportJob](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateDatasetImportJob.html).
A dataset import job can be in one of the following states:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
## Contents
** creationDateTime **
The creation date and time (in Unix time) of the dataset import job.
Type: Timestamp
Required: No
** datasetArn **
The Amazon Resource Name (ARN) of the dataset that receives the imported data.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** datasetImportJobArn **
The ARN of the dataset import job.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** dataSource **
The Amazon S3 bucket that contains the training data to import.
Type: [DataSource](API_DataSource.md) object
Required: No
** failureReason **
If a dataset import job fails, provides the reason why.
Type: String
Required: No
** importMode **
The import mode used by the dataset import job to import new records.
Type: String
Valid Values: `FULL | INCREMENTAL`
Required: No
** jobName **
The name of the import job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
** lastUpdatedDateTime **
The date and time (in Unix time) the dataset was last updated.
Type: Timestamp
Required: No
** publishAttributionMetricsToS3 **
Whether the job publishes metrics to Amazon S3 for a metric attribution.
Type: Boolean
Required: No
** roleArn **
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-]+):personalize:.*:.*:.+`
Required: No
** status **
The status of the dataset import job.
A dataset import job can be in one of the following states:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DatasetImportJob)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DatasetImportJob)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DatasetImportJob)
# DatasetImportJobSummary
Provides a summary of the properties of a dataset import job. For a complete listing, call the [DescribeDatasetImportJob](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeDatasetImportJob.html) API.
## Contents
** creationDateTime **
The date and time (in Unix time) that the dataset import job was created.
Type: Timestamp
Required: No
** datasetImportJobArn **
The Amazon Resource Name (ARN) of the dataset import job.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** failureReason **
If a dataset import job fails, the reason behind the failure.
Type: String
Required: No
** importMode **
The import mode the dataset import job used to update the data in the dataset. For more information see [Updating existing bulk data](https://docs.amazonaws.cn/personalize/latest/dg/updating-existing-bulk-data.html).
Type: String
Valid Values: `FULL | INCREMENTAL`
Required: No
** jobName **
The name of the dataset import job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
** lastUpdatedDateTime **
The date and time (in Unix time) that the dataset import job status was last updated.
Type: Timestamp
Required: No
** status **
The status of the dataset import job.
A dataset import job can be in one of the following states:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DatasetImportJobSummary)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DatasetImportJobSummary)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DatasetImportJobSummary)
# DatasetSchema
Describes the schema for a dataset. For more information on schemas, see [CreateSchema](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateSchema.html).
## Contents
** creationDateTime **
The date and time (in Unix time) that the schema was created.
Type: Timestamp
Required: No
** domain **
The domain of a schema that you created for a dataset in a Domain dataset group.
Type: String
Valid Values: `ECOMMERCE | VIDEO_ON_DEMAND`
Required: No
** lastUpdatedDateTime **
The date and time (in Unix time) that the schema was last updated.
Type: Timestamp
Required: No
** name **
The name of the schema.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
** schema **
The schema.
Type: String
Length Constraints: Maximum length of 20000.
Required: No
** schemaArn **
The Amazon Resource Name (ARN) of the schema.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DatasetSchema)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DatasetSchema)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DatasetSchema)
# DatasetSchemaSummary
Provides a summary of the properties of a dataset schema. For a complete listing, call the [DescribeSchema](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeSchema.html) API.
## Contents
** creationDateTime **
The date and time (in Unix time) that the schema was created.
Type: Timestamp
Required: No
** domain **
The domain of a schema that you created for a dataset in a Domain dataset group.
Type: String
Valid Values: `ECOMMERCE | VIDEO_ON_DEMAND`
Required: No
** lastUpdatedDateTime **
The date and time (in Unix time) that the schema was last updated.
Type: Timestamp
Required: No
** name **
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 **
The Amazon Resource Name (ARN) of the schema.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DatasetSchemaSummary)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DatasetSchemaSummary)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DatasetSchemaSummary)
# DatasetSummary
Provides a summary of the properties of a dataset. For a complete listing, call the [DescribeDataset](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeDataset.html) API.
## Contents
** creationDateTime **
The date and time (in Unix time) that the dataset was created.
Type: Timestamp
Required: No
** datasetArn **
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 **
The dataset type. One of the following values:
+ Interactions
+ Items
+ Users
+ Event-Interactions
Type: String
Length Constraints: Maximum length of 256.
Pattern: `^[A-Za-z_]+$`
Required: No
** lastUpdatedDateTime **
The date and time (in Unix time) that the dataset was last updated.
Type: Timestamp
Required: No
** name **
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 **
The status of the dataset.
A dataset can be in one of the following states:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DatasetSummary)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DatasetSummary)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DatasetSummary)
# DatasetUpdateSummary
Describes an update to a dataset.
## Contents
** creationDateTime **
The creation date and time (in Unix time) of the dataset update.
Type: Timestamp
Required: No
** failureReason **
If updating a dataset fails, provides the reason why.
Type: String
Required: No
** lastUpdatedDateTime **
The last update date and time (in Unix time) of the dataset.
Type: Timestamp
Required: No
** schemaArn **
The Amazon Resource Name (ARN) of the schema that replaced the previous schema of the dataset.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** status **
The status of the dataset update.
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DatasetUpdateSummary)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DatasetUpdateSummary)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DatasetUpdateSummary)
# DataSource
Describes the data source that contains the data to upload to a dataset, or the list of records to delete from Amazon Personalize.
## Contents
** dataLocation **
For dataset import jobs, the path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored. For data deletion jobs, the path to the Amazon S3 bucket that stores the list of records to delete.
For example:
`s3://bucket-name/folder-name/fileName.csv`
If your CSV files are in a folder in your Amazon S3 bucket and you want your import job or data deletion job to consider multiple files, you can specify the path to the folder. With a data deletion job, Amazon Personalize uses all files in the folder and any sub folder. Use the following syntax with a `/` after the folder name:
`s3://bucket-name/folder-name/`
Type: String
Length Constraints: Maximum length of 256.
Pattern: `(s3|http|https)://.+`
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DataSource)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DataSource)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DataSource)
# DefaultCategoricalHyperParameterRange
Provides the name and default range of a categorical hyperparameter and whether the hyperparameter is tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).
## Contents
** isTunable **
Whether the hyperparameter is tunable.
Type: Boolean
Required: No
** name **
The name of the hyperparameter.
Type: String
Length Constraints: Maximum length of 256.
Required: No
** values **
A list of the categories for the hyperparameter.
Type: Array of strings
Array Members: Maximum number of 100 items.
Length Constraints: Maximum length of 1000.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DefaultCategoricalHyperParameterRange)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DefaultCategoricalHyperParameterRange)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DefaultCategoricalHyperParameterRange)
# DefaultContinuousHyperParameterRange
Provides the name and default range of a continuous hyperparameter and whether the hyperparameter is tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).
## Contents
** isTunable **
Whether the hyperparameter is tunable.
Type: Boolean
Required: No
** maxValue **
The maximum allowable value for the hyperparameter.
Type: Double
Valid Range: Minimum value of -1000000.
Required: No
** minValue **
The minimum allowable value for the hyperparameter.
Type: Double
Valid Range: Minimum value of -1000000.
Required: No
** name **
The name of the hyperparameter.
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DefaultContinuousHyperParameterRange)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DefaultContinuousHyperParameterRange)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DefaultContinuousHyperParameterRange)
# DefaultHyperParameterRanges
Specifies the hyperparameters and their default ranges. Hyperparameters can be categorical, continuous, or integer-valued.
## Contents
** categoricalHyperParameterRanges **
The categorical hyperparameters and their default ranges.
Type: Array of [DefaultCategoricalHyperParameterRange](API_DefaultCategoricalHyperParameterRange.md) objects
Array Members: Maximum number of 100 items.
Required: No
** continuousHyperParameterRanges **
The continuous hyperparameters and their default ranges.
Type: Array of [DefaultContinuousHyperParameterRange](API_DefaultContinuousHyperParameterRange.md) objects
Array Members: Maximum number of 100 items.
Required: No
** integerHyperParameterRanges **
The integer-valued hyperparameters and their default ranges.
Type: Array of [DefaultIntegerHyperParameterRange](API_DefaultIntegerHyperParameterRange.md) objects
Array Members: Maximum number of 100 items.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DefaultHyperParameterRanges)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DefaultHyperParameterRanges)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DefaultHyperParameterRanges)
# DefaultIntegerHyperParameterRange
Provides the name and default range of a integer-valued hyperparameter and whether the hyperparameter is tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).
## Contents
** isTunable **
Indicates whether the hyperparameter is tunable.
Type: Boolean
Required: No
** maxValue **
The maximum allowable value for the hyperparameter.
Type: Integer
Valid Range: Maximum value of 1000000.
Required: No
** minValue **
The minimum allowable value for the hyperparameter.
Type: Integer
Valid Range: Minimum value of -1000000.
Required: No
** name **
The name of the hyperparameter.
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/DefaultIntegerHyperParameterRange)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/DefaultIntegerHyperParameterRange)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/DefaultIntegerHyperParameterRange)
# EventParameters
Describes the parameters of events, which are used in solution creation.
## Contents
** eventType **
The name of the event type to be considered for solution creation.
Type: String
Length Constraints: Maximum length of 256.
Required: No
** eventValueThreshold **
The threshold of the event type. Only events with a value greater or equal to this threshold will be considered for solution creation.
Type: Double
Required: No
** weight **
The weight of the event type. A higher weight means higher importance of the event type for the created solution.
Type: Double
Valid Range: Minimum value of 0. Maximum value of 1.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/EventParameters)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/EventParameters)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/EventParameters)
# EventsConfig
Describes the configuration of events, which are used in solution creation.
## Contents
** eventParametersList **
A list of event parameters, which includes event types and their event value thresholds and weights.
Type: Array of [EventParameters](API_EventParameters.md) objects
Array Members: Maximum number of 10 items.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/EventsConfig)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/EventsConfig)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/EventsConfig)
# EventTracker
Provides information about an event tracker.
## Contents
** accountId **
The Amazon account that owns the event tracker.
Type: String
Length Constraints: Maximum length of 256.
Required: No
** creationDateTime **
The date and time (in Unix format) that the event tracker was created.
Type: Timestamp
Required: No
** datasetGroupArn **
The Amazon Resource Name (ARN) of the dataset group that receives the event data.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** eventTrackerArn **
The ARN of the event tracker.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** lastUpdatedDateTime **
The date and time (in Unix time) that the event tracker was last updated.
Type: Timestamp
Required: No
** name **
The name of the event tracker.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
** status **
The status of the event tracker.
An event tracker can be in one of the following states:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
Type: String
Length Constraints: Maximum length of 256.
Required: No
** trackingId **
The ID of the event tracker. Include this ID in requests to the [PutEvents](https://docs.amazonaws.cn/personalize/latest/dg/API_UBS_PutEvents.html) API.
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/EventTracker)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/EventTracker)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/EventTracker)
# EventTrackerSummary
Provides a summary of the properties of an event tracker. For a complete listing, call the [DescribeEventTracker](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeEventTracker.html) API.
## Contents
** creationDateTime **
The date and time (in Unix time) that the event tracker was created.
Type: Timestamp
Required: No
** eventTrackerArn **
The Amazon Resource Name (ARN) of the event tracker.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** lastUpdatedDateTime **
The date and time (in Unix time) that the event tracker was last updated.
Type: Timestamp
Required: No
** name **
The name of the event tracker.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
** status **
The status of the event tracker.
An event tracker can be in one of the following states:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/EventTrackerSummary)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/EventTrackerSummary)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/EventTrackerSummary)
# FeatureTransformation
Provides feature transformation information. Feature transformation is the process of modifying raw input data into a form more suitable for model training.
## Contents
** creationDateTime **
The creation date and time (in Unix time) of the feature transformation.
Type: Timestamp
Required: No
** defaultParameters **
Provides the default parameters for feature transformation.
Type: String to string map
Map Entries: Maximum number of 100 items.
Key Length Constraints: Maximum length of 256.
Value Length Constraints: Maximum length of 1000.
Required: No
** featureTransformationArn **
The Amazon Resource Name (ARN) of the FeatureTransformation object.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** lastUpdatedDateTime **
The last update date and time (in Unix time) of the feature transformation.
Type: Timestamp
Required: No
** name **
The name of the feature transformation.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
** status **
The status of the feature transformation.
A feature transformation can be in one of the following states:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/FeatureTransformation)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/FeatureTransformation)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/FeatureTransformation)
# FieldsForThemeGeneration
A string to string map of the configuration details for theme generation.
## Contents
** itemName **
The name of the Items dataset column that stores the name of each item in the dataset.
Type: String
Length Constraints: Maximum length of 150.
Pattern: `[A-Za-z_][A-Za-z\d_]*`
Required: Yes
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/FieldsForThemeGeneration)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/FieldsForThemeGeneration)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/FieldsForThemeGeneration)
# Filter
Contains information on a recommendation filter, including its ARN, status, and filter expression.
## Contents
** creationDateTime **
The time at which the filter was created.
Type: Timestamp
Required: No
** datasetGroupArn **
The ARN of the dataset group to which the filter belongs.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** failureReason **
If the filter failed, the reason for its failure.
Type: String
Required: No
** filterArn **
The ARN of the filter.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** filterExpression **
Specifies the type of item interactions to filter out of recommendation results. The filter expression must follow specific format rules. For information about filter expression structure and syntax, see [Filter expressions](https://docs.amazonaws.cn/personalize/latest/dg/filter-expressions.html).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2500.
Required: No
** lastUpdatedDateTime **
The time at which the filter was last updated.
Type: Timestamp
Required: No
** name **
The name of the filter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
** status **
The status of the filter.
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/Filter)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/Filter)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/Filter)
# FilterSummary
A short summary of a filter's attributes.
## Contents
** creationDateTime **
The time at which the filter was created.
Type: Timestamp
Required: No
** datasetGroupArn **
The ARN of the dataset group to which the filter belongs.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** failureReason **
If the filter failed, the reason for the failure.
Type: String
Required: No
** filterArn **
The ARN of the filter.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** lastUpdatedDateTime **
The time at which the filter was last updated.
Type: Timestamp
Required: No
** name **
The name of the filter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
** status **
The status of the filter.
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/FilterSummary)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/FilterSummary)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/FilterSummary)
# HPOConfig
Describes the properties for hyperparameter optimization (HPO).
## Contents
** algorithmHyperParameterRanges **
The hyperparameters and their allowable ranges.
Type: [HyperParameterRanges](API_HyperParameterRanges.md) object
Required: No
** hpoObjective **
The metric to optimize during HPO.
Amazon Personalize doesn't support configuring the `hpoObjective` at this time.
Type: [HPOObjective](API_HPOObjective.md) object
Required: No
** hpoResourceConfig **
Describes the resource configuration for HPO.
Type: [HPOResourceConfig](API_HPOResourceConfig.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/HPOConfig)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/HPOConfig)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/HPOConfig)
# HPOObjective
The metric to optimize during hyperparameter optimization (HPO).
**Note**
Amazon Personalize doesn't support configuring the `hpoObjective` at this time.
## Contents
** metricName **
The name of the metric.
Type: String
Length Constraints: Maximum length of 256.
Required: No
** metricRegex **
A regular expression for finding the metric in the training job logs.
Type: String
Length Constraints: Maximum length of 256.
Required: No
** type **
The type of the metric. Valid values are `Maximize` and `Minimize`.
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/HPOObjective)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/HPOObjective)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/HPOObjective)
# HPOResourceConfig
Describes the resource configuration for hyperparameter optimization (HPO).
## Contents
** maxNumberOfTrainingJobs **
The maximum number of training jobs when you create a solution version. The maximum value for `maxNumberOfTrainingJobs` is `40`.
Type: String
Length Constraints: Maximum length of 256.
Required: No
** maxParallelTrainingJobs **
The maximum number of parallel training jobs when you create a solution version. The maximum value for `maxParallelTrainingJobs` is `10`.
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/HPOResourceConfig)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/HPOResourceConfig)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/HPOResourceConfig)
# HyperParameterRanges
Specifies the hyperparameters and their ranges. Hyperparameters can be categorical, continuous, or integer-valued.
## Contents
** categoricalHyperParameterRanges **
The categorical hyperparameters and their ranges.
Type: Array of [CategoricalHyperParameterRange](API_CategoricalHyperParameterRange.md) objects
Array Members: Maximum number of 100 items.
Required: No
** continuousHyperParameterRanges **
The continuous hyperparameters and their ranges.
Type: Array of [ContinuousHyperParameterRange](API_ContinuousHyperParameterRange.md) objects
Array Members: Maximum number of 100 items.
Required: No
** integerHyperParameterRanges **
The integer-valued hyperparameters and their ranges.
Type: Array of [IntegerHyperParameterRange](API_IntegerHyperParameterRange.md) objects
Array Members: Maximum number of 100 items.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/HyperParameterRanges)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/HyperParameterRanges)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/HyperParameterRanges)
# IntegerHyperParameterRange
Provides the name and range of an integer-valued hyperparameter.
## Contents
** maxValue **
The maximum allowable value for the hyperparameter.
Type: Integer
Valid Range: Maximum value of 1000000.
Required: No
** minValue **
The minimum allowable value for the hyperparameter.
Type: Integer
Valid Range: Minimum value of -1000000.
Required: No
** name **
The name of the hyperparameter.
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/IntegerHyperParameterRange)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/IntegerHyperParameterRange)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/IntegerHyperParameterRange)
# MetricAttribute
Contains information on a metric that a metric attribution reports on. For more information, see [Measuring impact of recommendations](https://docs.amazonaws.cn/personalize/latest/dg/measuring-recommendation-impact.html).
## Contents
** eventType **
The metric's event type.
Type: String
Length Constraints: Maximum length of 256.
Required: Yes
** expression **
The attribute's expression. Available functions are `SUM()` or `SAMPLECOUNT()`. For SUM() functions, provide the dataset type (either Interactions or Items) and column to sum as a parameter. For example SUM(Items.PRICE).
Type: String
Length Constraints: Maximum length of 256.
Required: Yes
** metricName **
The metric's name. The name helps you identify the metric in Amazon CloudWatch or Amazon S3.
Type: String
Length Constraints: Maximum length of 256.
Required: Yes
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/MetricAttribute)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/MetricAttribute)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/MetricAttribute)
# MetricAttribution
Contains information on a metric attribution. A metric attribution creates reports on the data that you import into Amazon Personalize. Depending on how you import the data, you can view reports in Amazon CloudWatch or Amazon S3. For more information, see [Measuring impact of recommendations](https://docs.amazonaws.cn/personalize/latest/dg/measuring-recommendation-impact.html).
## Contents
** creationDateTime **
The metric attribution's creation date time.
Type: Timestamp
Required: No
** datasetGroupArn **
The metric attribution's dataset group Amazon Resource Name (ARN).
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** failureReason **
The metric attribution's failure reason.
Type: String
Required: No
** lastUpdatedDateTime **
The metric attribution's last updated date time.
Type: Timestamp
Required: No
** metricAttributionArn **
The metric attribution's Amazon Resource Name (ARN).
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** metricsOutputConfig **
The metric attribution's output configuration.
Type: [MetricAttributionOutput](API_MetricAttributionOutput.md) object
Required: No
** name **
The metric attribution's name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
** status **
The metric attribution's status.
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/MetricAttribution)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/MetricAttribution)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/MetricAttribution)
# MetricAttributionOutput
The output configuration details for a metric attribution.
## Contents
** roleArn **
The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket and add metrics to Amazon CloudWatch. For more information, see [Measuring impact of recommendations](https://docs.amazonaws.cn/personalize/latest/dg/measuring-recommendation-impact.html).
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`
Required: Yes
** s3DataDestination **
The configuration details of an Amazon S3 input or output bucket.
Type: [S3DataConfig](API_S3DataConfig.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/MetricAttributionOutput)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/MetricAttributionOutput)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/MetricAttributionOutput)
# MetricAttributionSummary
Provides a summary of the properties of a metric attribution. For a complete listing, call the [DescribeMetricAttribution](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeMetricAttribution.html).
## Contents
** creationDateTime **
The metric attribution's creation date time.
Type: Timestamp
Required: No
** failureReason **
The metric attribution's failure reason.
Type: String
Required: No
** lastUpdatedDateTime **
The metric attribution's last updated date time.
Type: Timestamp
Required: No
** metricAttributionArn **
The metric attribution's Amazon Resource Name (ARN).
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** name **
The name of the metric attribution.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
** status **
The metric attribution's status.
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/MetricAttributionSummary)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/MetricAttributionSummary)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/MetricAttributionSummary)
# OptimizationObjective
Describes the additional objective for the solution, such as maximizing streaming minutes or increasing revenue. For more information see [Optimizing a solution](https://docs.amazonaws.cn/personalize/latest/dg/optimizing-solution-for-objective.html).
## Contents
** itemAttribute **
The numerical metadata column in an Items dataset related to the optimization objective. For example, VIDEO\$1LENGTH (to maximize streaming minutes), or PRICE (to maximize revenue).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 150.
Required: No
** objectiveSensitivity **
Specifies how Amazon Personalize balances the importance of your optimization objective versus relevance.
Type: String
Valid Values: `LOW | MEDIUM | HIGH | OFF`
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/OptimizationObjective)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/OptimizationObjective)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/OptimizationObjective)
# Recipe
Provides information about a recipe. Each recipe provides an algorithm that Amazon Personalize uses in model training when you use the [CreateSolution](https://docs.amazonaws.cn/personalize/latest/dg/API_CreateSolution.html) operation.
## Contents
** algorithmArn **
The Amazon Resource Name (ARN) of the algorithm that Amazon Personalize uses to train the model.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** creationDateTime **
The date and time (in Unix format) that the recipe was created.
Type: Timestamp
Required: No
** description **
The description of the recipe.
Type: String
Required: No
** featureTransformationArn **
The ARN of the FeatureTransformation object.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** lastUpdatedDateTime **
The date and time (in Unix format) that the recipe was last updated.
Type: Timestamp
Required: No
** name **
The name of the recipe.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
** recipeArn **
The Amazon Resource Name (ARN) of the recipe.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** recipeType **
One of the following values:
+ PERSONALIZED\$1RANKING
+ RELATED\$1ITEMS
+ USER\$1PERSONALIZATION
Type: String
Length Constraints: Maximum length of 256.
Required: No
** status **
The status of the recipe.
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/Recipe)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/Recipe)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/Recipe)
# RecipeSummary
Provides a summary of the properties of a recipe. For a complete listing, call the [DescribeRecipe](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeRecipe.html) API.
## Contents
** creationDateTime **
The date and time (in Unix time) that the recipe was created.
Type: Timestamp
Required: No
** domain **
The domain of the recipe (if the recipe is a Domain dataset group use case).
Type: String
Valid Values: `ECOMMERCE | VIDEO_ON_DEMAND`
Required: No
** lastUpdatedDateTime **
The date and time (in Unix time) that the recipe was last updated.
Type: Timestamp
Required: No
** name **
The name of the recipe.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
** recipeArn **
The Amazon Resource Name (ARN) of the recipe.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** status **
The status of the recipe.
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/RecipeSummary)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/RecipeSummary)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/RecipeSummary)
# Recommender
Describes a recommendation generator for a Domain dataset group. You create a recommender in a Domain dataset group for a specific domain use case (domain recipe), and specify the recommender in a [GetRecommendations](https://docs.amazonaws.cn/personalize/latest/dg/API_RS_GetRecommendations.html) request.
## Contents
** creationDateTime **
The date and time (in Unix format) that the recommender was created.
Type: Timestamp
Required: No
** datasetGroupArn **
The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** failureReason **
If a recommender fails, the reason behind the failure.
Type: String
Required: No
** lastUpdatedDateTime **
The date and time (in Unix format) that the recommender was last updated.
Type: Timestamp
Required: No
** latestRecommenderUpdate **
Provides a summary of the latest updates to the recommender.
Type: [RecommenderUpdateSummary](API_RecommenderUpdateSummary.md) object
Required: No
** modelMetrics **
Provides evaluation metrics that help you determine the performance of a recommender. For more information, see [ Evaluating a recommender](https://docs.amazonaws.cn/personalize/latest/dg/evaluating-recommenders.html).
Type: String to double map
Map Entries: Maximum number of 100 items.
Key Length Constraints: Maximum length of 256.
Required: No
** name **
The name of the recommender.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
** recipeArn **
The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** recommenderArn **
The Amazon Resource Name (ARN) of the recommender.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** recommenderConfig **
The configuration details of the recommender.
Type: [RecommenderConfig](API_RecommenderConfig.md) object
Required: No
** status **
The status of the recommender.
A recommender can be in one of the following states:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ STOP PENDING > STOP IN\$1PROGRESS > INACTIVE > START PENDING > START IN\$1PROGRESS > ACTIVE
+ DELETE PENDING > DELETE IN\$1PROGRESS
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/Recommender)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/Recommender)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/Recommender)
# RecommenderConfig
The configuration details of the recommender.
## Contents
** enableMetadataWithRecommendations **
Whether metadata with recommendations is enabled for the recommender. If enabled, you can specify the columns from your Items dataset in your request for recommendations. Amazon Personalize returns this data for each item in the recommendation response. For information about enabling metadata for a recommender, see [Enabling metadata in recommendations for a recommender](https://docs.amazonaws.cn/personalize/latest/dg/creating-recommenders.html#create-recommender-return-metadata).
If you enable metadata in recommendations, you will incur additional costs. For more information, see [Amazon Personalize pricing](https://aws.amazon.com/personalize/pricing/).
Type: Boolean
Required: No
** itemExplorationConfig **
Specifies the exploration configuration hyperparameters, including `explorationWeight` and `explorationItemAgeCutOff`, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide `itemExplorationConfig` data only if your recommenders generate personalized recommendations for a user (not popular items or similar items).
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
** minRecommendationRequestsPerSecond **
Specifies the requested minimum provisioned recommendation requests per second that Amazon Personalize will support. A high `minRecommendationRequestsPerSecond` will increase your bill. We recommend starting with 1 for `minRecommendationRequestsPerSecond` (the default). Track your usage using Amazon CloudWatch metrics, and increase the `minRecommendationRequestsPerSecond` as necessary.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
** trainingDataConfig **
Specifies the training data configuration to use when creating a domain recommender.
Type: [TrainingDataConfig](API_TrainingDataConfig.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/RecommenderConfig)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/RecommenderConfig)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/RecommenderConfig)
# RecommenderSummary
Provides a summary of the properties of the recommender.
## Contents
** creationDateTime **
The date and time (in Unix format) that the recommender was created.
Type: Timestamp
Required: No
** datasetGroupArn **
The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** lastUpdatedDateTime **
The date and time (in Unix format) that the recommender was last updated.
Type: Timestamp
Required: No
** name **
The name of the recommender.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
** recipeArn **
The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** recommenderArn **
The Amazon Resource Name (ARN) of the recommender.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** recommenderConfig **
The configuration details of the recommender.
Type: [RecommenderConfig](API_RecommenderConfig.md) object
Required: No
** status **
The status of the recommender. A recommender can be in one of the following states:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ STOP PENDING > STOP IN\$1PROGRESS > INACTIVE > START PENDING > START IN\$1PROGRESS > ACTIVE
+ DELETE PENDING > DELETE IN\$1PROGRESS
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/RecommenderSummary)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/RecommenderSummary)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/RecommenderSummary)
# RecommenderUpdateSummary
Provides a summary of the properties of a recommender update. For a complete listing, call the [DescribeRecommender](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeRecommender.html) API.
## Contents
** creationDateTime **
The date and time (in Unix format) that the recommender update was created.
Type: Timestamp
Required: No
** failureReason **
If a recommender update fails, the reason behind the failure.
Type: String
Required: No
** lastUpdatedDateTime **
The date and time (in Unix time) that the recommender update was last updated.
Type: Timestamp
Required: No
** recommenderConfig **
The configuration details of the recommender update.
Type: [RecommenderConfig](API_RecommenderConfig.md) object
Required: No
** status **
The status of the recommender update. A recommender update can be in one of the following states:
CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/RecommenderUpdateSummary)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/RecommenderUpdateSummary)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/RecommenderUpdateSummary)
# S3DataConfig
The configuration details of an Amazon S3 input or output bucket.
## Contents
** path **
The file path of the Amazon S3 bucket.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `(s3|http|https)://.+`
Required: Yes
** kmsKeyArn **
The Amazon Resource Name (ARN) of the Amazon Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.
Type: String
Length Constraints: Maximum length of 2048.
Pattern: `arn:aws.*:kms:.*:[0-9]{12}:key/.*`
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/S3DataConfig)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/S3DataConfig)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/S3DataConfig)
# Solution
**Important**
By default, all new solutions use automatic training. With automatic training, you incur training costs while your solution is active. To avoid unnecessary costs, when you are finished you can [update the solution](https://docs.amazonaws.cn/personalize/latest/dg/API_UpdateSolution.html) to turn off automatic training. For information about training costs, see [Amazon Personalize pricing](https://aws.amazon.com/personalize/pricing/).
An object that provides information about a solution. A solution includes the custom recipe, customized parameters, and trained models (Solution Versions) that Amazon Personalize uses to generate recommendations.
After you create a solution, you can’t change its configuration. If you need to make changes, you can [clone the solution](https://docs.amazonaws.cn/personalize/latest/dg/cloning-solution.html) with the Amazon Personalize console or create a new one.
## Contents
** autoMLResult **
When `performAutoML` is true, specifies the best recipe found.
Type: [AutoMLResult](API_AutoMLResult.md) object
Required: No
** creationDateTime **
The creation date and time (in Unix time) of the solution.
Type: Timestamp
Required: No
** datasetGroupArn **
The Amazon Resource Name (ARN) of the dataset group that provides the training data.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** eventType **
The event type (for example, 'click' or 'like') that is used for training the model. If no `eventType` is provided, Amazon Personalize uses all interactions for training with equal weight regardless of type.
Type: String
Length Constraints: Maximum length of 256.
Required: No
** lastUpdatedDateTime **
The date and time (in Unix time) that the solution was last updated.
Type: Timestamp
Required: No
** latestSolutionUpdate **
Provides a summary of the latest updates to the solution.
Type: [SolutionUpdateSummary](API_SolutionUpdateSummary.md) object
Required: No
** latestSolutionVersion **
Describes the latest version of the solution, including the status and the ARN.
Type: [SolutionVersionSummary](API_SolutionVersionSummary.md) object
Required: No
** name **
The name of the solution.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
** performAutoML **
We don't recommend enabling automated machine learning. Instead, match your use case to the available Amazon Personalize recipes. For more information, see [Determining your use case.](https://docs.amazonaws.cn/personalize/latest/dg/determining-use-case.html)
When true, Amazon Personalize performs a search for the best USER\$1PERSONALIZATION recipe from the list specified in the solution configuration (`recipeArn` must not be specified). When false (the default), Amazon Personalize uses `recipeArn` for training.
Type: Boolean
Required: No
** performAutoTraining **
Specifies whether the solution automatically creates solution versions. The default is `True` and the solution automatically creates new solution versions every 7 days.
For more information about auto training, see [Creating and configuring a solution](https://docs.amazonaws.cn/personalize/latest/dg/customizing-solution-config.html).
Type: Boolean
Required: No
** performHPO **
Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is `false`.
Type: Boolean
Required: No
** performIncrementalUpdate **
A Boolean value that indicates whether incremental training updates are performed on the model. When enabled, this allows the model to learn from new data more frequently without requiring full retraining, which enables near real-time personalization. This parameter is supported only for solutions that use the semantic-similarity recipe
Type: Boolean
Required: No
** recipeArn **
The ARN of the recipe used to create the solution. This is required when `performAutoML` is false.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** solutionArn **
The ARN of the solution.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** solutionConfig **
Describes the configuration properties for the solution.
Type: [SolutionConfig](API_SolutionConfig.md) object
Required: No
** status **
The status of the solution.
A solution can be in one of the following states:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/Solution)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/Solution)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/Solution)
# SolutionConfig
Describes the configuration properties for the solution.
## Contents
** algorithmHyperParameters **
Lists the algorithm hyperparameters and their values.
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 **
The [AutoMLConfig](https://docs.amazonaws.cn/personalize/latest/dg/API_AutoMLConfig.html) object containing a list of recipes to search when AutoML is performed.
Type: [AutoMLConfig](API_AutoMLConfig.md) object
Required: No
** autoTrainingConfig **
Specifies the automatic training configuration to use.
Type: [AutoTrainingConfig](API_AutoTrainingConfig.md) object
Required: No
** eventsConfig **
Describes the configuration of an event, which includes a list of event parameters. You can specify up to 10 event parameters. Events are used in solution creation.
Type: [EventsConfig](API_EventsConfig.md) object
Required: No
** eventValueThreshold **
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 **
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 **
Describes the properties for hyperparameter optimization (HPO).
Type: [HPOConfig](API_HPOConfig.md) object
Required: No
** optimizationObjective **
Describes the additional objective for the solution, such as maximizing streaming minutes or increasing revenue. For more information see [Optimizing a solution](https://docs.amazonaws.cn/personalize/latest/dg/optimizing-solution-for-objective.html).
Type: [OptimizationObjective](API_OptimizationObjective.md) object
Required: No
** trainingDataConfig **
Specifies the training data configuration to use when creating a custom solution version (trained model).
Type: [TrainingDataConfig](API_TrainingDataConfig.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/SolutionConfig)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/SolutionConfig)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/SolutionConfig)
# SolutionSummary
Provides a summary of the properties of a solution. For a complete listing, call the [DescribeSolution](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeSolution.html) API.
## Contents
** creationDateTime **
The date and time (in Unix time) that the solution was created.
Type: Timestamp
Required: No
** lastUpdatedDateTime **
The date and time (in Unix time) that the solution was last updated.
Type: Timestamp
Required: No
** name **
The name of the solution.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
** recipeArn **
The Amazon Resource Name (ARN) of the recipe used by the solution.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** solutionArn **
The Amazon Resource Name (ARN) of the solution.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** status **
The status of the solution.
A solution can be in one of the following states:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
+ DELETE PENDING > DELETE IN\$1PROGRESS
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/SolutionSummary)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/SolutionSummary)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/SolutionSummary)
# SolutionUpdateConfig
The configuration details of the solution update.
## Contents
** autoTrainingConfig **
The automatic training configuration to use when `performAutoTraining` is true.
Type: [AutoTrainingConfig](API_AutoTrainingConfig.md) object
Required: No
** eventsConfig **
Describes the configuration of an event, which includes a list of event parameters. You can specify up to 10 event parameters. Events are used in solution creation.
Type: [EventsConfig](API_EventsConfig.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/SolutionUpdateConfig)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/SolutionUpdateConfig)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/SolutionUpdateConfig)
# SolutionUpdateSummary
Provides a summary of the properties of a solution update. For a complete listing, call the [DescribeSolution](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeSolution.html) API.
## Contents
** creationDateTime **
The date and time (in Unix format) that the solution update was created.
Type: Timestamp
Required: No
** failureReason **
If a solution update fails, the reason behind the failure.
Type: String
Required: No
** lastUpdatedDateTime **
The date and time (in Unix time) that the solution update was last updated.
Type: Timestamp
Required: No
** performAutoTraining **
Whether the solution automatically creates solution versions.
Type: Boolean
Required: No
** performIncrementalUpdate **
A Boolean value that indicates whether incremental training updates are performed on the model. When enabled, incremental training is performed for solution versions with active campaigns and allows the model to learn from new data more frequently without requiring full retraining, which enables near real-time personalization. This parameter is supported only for solutions that use the semantic-similarity recipe. The default is `true`.
Note that certain scores and attributes (like updates to item popularity and freshness used for ranking influence with aws-semantic-similarity recipe) may not update until the next full training occurs.
Type: Boolean
Required: No
** solutionUpdateConfig **
The configuration details of the solution.
Type: [SolutionUpdateConfig](API_SolutionUpdateConfig.md) object
Required: No
** status **
The status of the solution update. A solution update can be in one of the following states:
CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
Type: String
Length Constraints: Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/SolutionUpdateSummary)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/SolutionUpdateSummary)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/SolutionUpdateSummary)
# SolutionVersion
An object that provides information about a specific version of a [Solution](https://docs.amazonaws.cn/personalize/latest/dg/API_Solution.html) in a Custom dataset group.
## Contents
** creationDateTime **
The date and time (in Unix time) that this version of the solution was created.
Type: Timestamp
Required: No
** datasetGroupArn **
The Amazon Resource Name (ARN) of the dataset group providing the training data.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** eventType **
The event type (for example, 'click' or 'like') that is used for training the model.
Type: String
Length Constraints: Maximum length of 256.
Required: No
** failureReason **
If training a solution version fails, the reason for the failure.
Type: String
Required: No
** lastUpdatedDateTime **
The date and time (in Unix time) that the solution was last updated.
Type: Timestamp
Required: No
** name **
The name of the solution version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
** performAutoML **
When true, Amazon Personalize searches for the most optimal recipe according to the solution configuration. When false (the default), Amazon Personalize uses `recipeArn`.
Type: Boolean
Required: No
** performHPO **
Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is `false`.
Type: Boolean
Required: No
** performIncrementalUpdate **
Whether the solution version should perform an incremental update. When set to true, the training will process only the data that has changed since the latest training, similar to when trainingMode is set to UPDATE. This can only be used with solution versions that use the User-Personalization recipe.
Type: Boolean
Required: No
** recipeArn **
The ARN of the recipe used in the solution.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** solutionArn **
The ARN of the solution.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** solutionConfig **
Describes the configuration properties for the solution.
Type: [SolutionConfig](API_SolutionConfig.md) object
Required: No
** solutionVersionArn **
The ARN of the solution version.
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** status **
The status of the solution version.
A solution version can be in one of the following states:
+ CREATE PENDING
+ CREATE IN\$1PROGRESS
+ ACTIVE
+ CREATE FAILED
+ CREATE STOPPING
+ CREATE STOPPED
Type: String
Length Constraints: Maximum length of 256.
Required: No
** trainingHours **
The time used to train the model. You are billed for the time it takes to train a model. This field is visible only after Amazon Personalize successfully trains a model.
Type: Double
Valid Range: Minimum value of 0.
Required: No
** trainingMode **
The scope of training to be performed when creating the solution version. A `FULL` training considers all of the data in your dataset group. An `UPDATE` processes only the data that has changed since the latest training. Only solution versions created with the User-Personalization recipe can use `UPDATE`.
Type: String
Valid Values: `FULL | UPDATE | AUTOTRAIN`
Required: No
** trainingType **
Whether the solution version was created automatically or manually.
Type: String
Valid Values: `AUTOMATIC | MANUAL`
Required: No
** tunedHPOParams **
If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model.
Type: [TunedHPOParams](API_TunedHPOParams.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/SolutionVersion)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/SolutionVersion)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/SolutionVersion)
# SolutionVersionSummary
Provides a summary of the properties of a solution version. For a complete listing, call the [DescribeSolutionVersion](https://docs.amazonaws.cn/personalize/latest/dg/API_DescribeSolutionVersion.html) API.
## Contents
** creationDateTime **
The date and time (in Unix time) that this version of a solution was created.
Type: Timestamp
Required: No
** failureReason **
If a solution version fails, the reason behind the failure.
Type: String
Required: No
** lastUpdatedDateTime **
The date and time (in Unix time) that the solution version was last updated.
Type: Timestamp
Required: No
** solutionVersionArn **
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 **
The status of the solution version.
A solution version can be in one of the following states:
+ CREATE PENDING > CREATE IN\$1PROGRESS > ACTIVE -or- CREATE FAILED
Type: String
Length Constraints: Maximum length of 256.
Required: No
** trainingMode **
The scope of training to be performed when creating the solution version. A `FULL` training considers all of the data in your dataset group. An `UPDATE` processes only the data that has changed since the latest training. Only solution versions created with the User-Personalization recipe can use `UPDATE`.
Type: String
Valid Values: `FULL | UPDATE | AUTOTRAIN`
Required: No
** trainingType **
Whether the solution version was created automatically or manually.
Type: String
Valid Values: `AUTOMATIC | MANUAL`
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/SolutionVersionSummary)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/SolutionVersionSummary)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/SolutionVersionSummary)
# Tag
The optional metadata that you apply to resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information see [Tagging Amazon Personalize resources](https://docs.amazonaws.cn/personalize/latest/dg/tagging-resources.html).
## Contents
** tagKey **
One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`
Required: Yes
** tagValue **
The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`
Required: Yes
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/Tag)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/Tag)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/Tag)
# ThemeGenerationConfig
The configuration details for generating themes with a batch inference job.
## Contents
** fieldsForThemeGeneration **
Fields used to generate descriptive themes for a batch inference job.
Type: [FieldsForThemeGeneration](API_FieldsForThemeGeneration.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/ThemeGenerationConfig)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/ThemeGenerationConfig)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/ThemeGenerationConfig)
# TrainingDataConfig
The training data configuration to use when creating a domain recommender or custom solution version (trained model).
## Contents
** excludedDatasetColumns **
Specifies the columns to exclude from training. Each key is a dataset type, and each value is a list of columns. Exclude columns to control what data Amazon Personalize uses to generate recommendations.
For example, you might have a column that you want to use only to filter recommendations. You can exclude this column from training and Amazon Personalize considers it only when filtering.
Type: String to array of strings map
Map Entries: Maximum number of 3 items.
Key Length Constraints: Maximum length of 256.
Key Pattern: `^[A-Za-z_]+$`
Array Members: Maximum number of 50 items.
Length Constraints: Maximum length of 150.
Pattern: `[A-Za-z_][A-Za-z\d_]*`
Required: No
** includedDatasetColumns **
Specifies the columns to include from training. Each key is a dataset type, and each value is a list of columns. Include columns to control what data Amazon Personalize uses to generate recommendations.
For example, you might have multiple columns in you items dataset but want to use only title and description for training. You can include only these two columns for training and Amazon Personalize will consider only the included columns for training.
Type: String to array of strings map
Map Entries: Maximum number of 3 items.
Key Length Constraints: Maximum length of 256.
Key Pattern: `^[A-Za-z_]+$`
Array Members: Maximum number of 50 items.
Length Constraints: Maximum length of 150.
Pattern: `[A-Za-z_][A-Za-z\d_]*`
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/TrainingDataConfig)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/TrainingDataConfig)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/TrainingDataConfig)
# TunedHPOParams
If hyperparameter optimization (HPO) was performed, contains the hyperparameter values of the best performing model.
## Contents
** algorithmHyperParameters **
A list of the hyperparameter values of the best performing model.
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
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-2018-05-22/TunedHPOParams)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-2018-05-22/TunedHPOParams)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-2018-05-22/TunedHPOParams)
# Amazon Personalize Events
The following data types are supported by Amazon Personalize Events:
+ [Action](API_UBS_Action.md)
+ [ActionInteraction](API_UBS_ActionInteraction.md)
+ [Event](API_UBS_Event.md)
+ [Item](API_UBS_Item.md)
+ [MetricAttribution](API_UBS_MetricAttribution.md)
+ [User](API_UBS_User.md)
# Action
Represents action metadata added to an Action dataset using the `PutActions` API. For more information see [Importing actions individually](https://docs.amazonaws.cn/personalize/latest/dg/importing-actions.html).
## Contents
** actionId **
The ID associated with the action.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
** properties **
A string map of action-specific metadata. Each element in the map consists of a key-value pair. For example, `{"value": "100"}`.
The keys use camel case names that match the fields in the schema for the Actions dataset. In the previous example, the `value` matches the 'VALUE' field defined in the Actions schema. For categorical string data, to include multiple categories for a single action, separate each category with a pipe separator (`|`). For example, `\"Deluxe|Premium\"`.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32000.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-events-2018-03-22/Action)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-events-2018-03-22/Action)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-events-2018-03-22/Action)
# ActionInteraction
Represents an action interaction event sent using the `PutActionInteractions` API.
## Contents
** actionId **
The ID of the action the user interacted with. This corresponds to the `ACTION_ID` field of the Action interaction schema.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
** eventType **
The type of action interaction event. You can specify `Viewed`, `Taken`, and `Not Taken` event types. For more information about action interaction event type data, see [Event type data](https://docs.amazonaws.cn/personalize/latest/dg/action-interaction-event-type-data.html).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
** sessionId **
The ID associated with the user's visit. Your application generates a unique `sessionId` when a user first visits your website or uses your application.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
** timestamp **
The timestamp for when the action interaction event occurred. Timestamps must be in Unix epoch time format, in seconds.
Type: Timestamp
Required: Yes
** eventId **
An ID associated with the event. If an event ID is not provided, Amazon Personalize generates a unique ID for the event. An event ID is not used as an input to the model. Amazon Personalize uses the event ID to distinguish unique events. Any subsequent events after the first with the same event ID are not used in model training.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
** impression **
A list of action IDs that represents the sequence of actions you have shown the user. For example, `["actionId1", "actionId2", "actionId3"]`. Amazon Personalize doesn't use impressions data from action interaction events. Instead, record multiple events for each action and use the `Viewed` event type.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 25 items.
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
** properties **
A string map of event-specific data that you might choose to record. For example, if a user takes an action, other than the action ID, you might also send the number of actions taken by the user.
Each item in the map consists of a key-value pair. For example,
`{"numberOfActions": "12"}`
The keys use camel case names that match the fields in the Action interactions schema. In the above example, the `numberOfActions` would match the 'NUMBER\$1OF\$1ACTIONS' field defined in the Action interactions schema.
The following can't be included as a keyword for properties (case insensitive).
+ userId
+ sessionId
+ eventType
+ timestamp
+ recommendationId
+ impression
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
** recommendationId **
The ID of the list of recommendations that contains the action the user interacted with.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 40.
Required: No
** userId **
The ID of the user who interacted with the action. This corresponds to the `USER_ID` field of the Action interaction schema.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-events-2018-03-22/ActionInteraction)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-events-2018-03-22/ActionInteraction)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-events-2018-03-22/ActionInteraction)
# Event
Represents item interaction event information sent using the `PutEvents` API.
## Contents
** eventType **
The type of event, such as click or download. This property corresponds to the `EVENT_TYPE` field of your Item interactions dataset's schema and depends on the types of events you are tracking.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
** sentAt **
The timestamp (in Unix time) on the client side when the event occurred.
Type: Timestamp
Required: Yes
** eventId **
An ID associated with the event. If an event ID is not provided, Amazon Personalize generates a unique ID for the event. An event ID is not used as an input to the model. Amazon Personalize uses the event ID to distinguish unique events. Any subsequent events after the first with the same event ID are not used in model training.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
** eventValue **
The event value that corresponds to the `EVENT_VALUE` field of the Item interactions schema.
Type: Float
Required: No
** impression **
A list of item IDs that represents the sequence of items you have shown the user. For example, `["itemId1", "itemId2", "itemId3"]`. Provide a list of items to manually record impressions data for an event. For more information on recording impressions data, see [Recording impressions data](https://docs.amazonaws.cn/personalize/latest/dg/recording-events.html#putevents-including-impressions-data).
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 25 items.
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
** itemId **
The item ID key that corresponds to the `ITEM_ID` field of the Item interactions dataset's schema.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
** metricAttribution **
Contains information about the metric attribution associated with an event. For more information about metric attributions, see [Measuring impact of recommendations](https://docs.amazonaws.cn/personalize/latest/dg/measuring-recommendation-impact.html).
Type: [MetricAttribution](API_UBS_MetricAttribution.md) object
Required: No
** properties **
A string map of event-specific data that you might choose to record. For example, if a user rates a movie on your site, other than movie ID (`itemId`) and rating (`eventValue`) , you might also send the number of movie ratings made by the user.
Each item in the map consists of a key-value pair. For example,
`{"numberOfRatings": "12"}`
The keys use camel case names that match the fields in the Item interactions dataset's schema. In the above example, the `numberOfRatings` would match the 'NUMBER\$1OF\$1RATINGS' field defined in the Item interactions dataset's schema.
The following can't be included as a keyword for properties (case insensitive).
+ userId
+ sessionId
+ eventType
+ timestamp
+ recommendationId
+ impression
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
** recommendationId **
The ID of the list of recommendations that contains the item the user interacted with. Provide a `recommendationId` to have Amazon Personalize implicitly record the recommendations you show your user as impressions data. Or provide a `recommendationId` if you use a metric attribution to measure the impact of recommendations.
For more information on recording impressions data, see [Recording impressions data](https://docs.amazonaws.cn/personalize/latest/dg/recording-events.html#putevents-including-impressions-data). For more information on creating a metric attribution see [Measuring impact of recommendations](https://docs.amazonaws.cn/personalize/latest/dg/measuring-recommendation-impact.html).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 40.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-events-2018-03-22/Event)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-events-2018-03-22/Event)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-events-2018-03-22/Event)
# Item
Represents item metadata added to an Items dataset using the `PutItems` API. For more information see [Importing items individually](https://docs.amazonaws.cn/personalize/latest/dg/importing-items.html).
## Contents
** itemId **
The ID associated with the item.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
** properties **
A string map of item-specific metadata. Each element in the map consists of a key-value pair. For example, `{"numberOfRatings": "12"}`.
The keys use camel case names that match the fields in the schema for the Items dataset. In the previous example, the `numberOfRatings` matches the 'NUMBER\$1OF\$1RATINGS' field defined in the Items schema. For categorical string data, to include multiple categories for a single item, separate each category with a pipe separator (`|`). For example, `\"Horror|Action\"`.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32000.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-events-2018-03-22/Item)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-events-2018-03-22/Item)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-events-2018-03-22/Item)
# MetricAttribution
Contains information about a metric attribution associated with an event. For more information about metric attributions, see [Measuring impact of recommendations](https://docs.amazonaws.cn/personalize/latest/dg/measuring-recommendation-impact.html).
## Contents
** eventAttributionSource **
The source of the event, such as a third party.
Type: String
Length Constraints: Maximum length of 1024.
Pattern: `^[\x20-\x7E]*[\x21-\x7E]+[\x20-\x7E]*$`
Required: Yes
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-events-2018-03-22/MetricAttribution)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-events-2018-03-22/MetricAttribution)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-events-2018-03-22/MetricAttribution)
# User
Represents user metadata added to a Users dataset using the `PutUsers` API. For more information see [Importing users individually](https://docs.amazonaws.cn/personalize/latest/dg/importing-users.html).
## Contents
** userId **
The ID associated with the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
** properties **
A string map of user-specific metadata. Each element in the map consists of a key-value pair. For example, `{"numberOfVideosWatched": "45"}`.
The keys use camel case names that match the fields in the schema for the Users dataset. In the previous example, the `numberOfVideosWatched` matches the 'NUMBER\$1OF\$1VIDEOS\$1WATCHED' field defined in the Users schema. For categorical string data, to include multiple categories for a single user, separate each category with a pipe separator (`|`). For example, `\"Member|Frequent shopper\"`.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 24000.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-events-2018-03-22/User)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-events-2018-03-22/User)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-events-2018-03-22/User)
# Amazon Personalize Runtime
The following data types are supported by Amazon Personalize Runtime:
+ [PredictedAction](API_RS_PredictedAction.md)
+ [PredictedItem](API_RS_PredictedItem.md)
+ [Promotion](API_RS_Promotion.md)
# PredictedAction
An object that identifies an action.
The [GetActionRecommendations](API_RS_GetActionRecommendations.md) API returns a list of `PredictedAction`s.
## Contents
** actionId **
The ID of the recommended action.
Type: String
Length Constraints: Maximum length of 256.
Required: No
** score **
The score of the recommended action. For information about action scores, see [How action recommendation scoring works](https://docs.amazonaws.cn/personalize/latest/dg/how-action-recommendation-scoring-works.html).
Type: Double
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-runtime-2018-05-22/PredictedAction)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-runtime-2018-05-22/PredictedAction)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-runtime-2018-05-22/PredictedAction)
# PredictedItem
An object that identifies an item.
The [GetRecommendations](API_RS_GetRecommendations.md) and [GetPersonalizedRanking](API_RS_GetPersonalizedRanking.md) APIs return a list of `PredictedItem`s.
## Contents
** itemId **
The recommended item ID.
Type: String
Length Constraints: Maximum length of 256.
Required: No
** metadata **
Metadata about the item from your Items dataset.
Type: String to string map
Key Length Constraints: Maximum length of 150.
Value Length Constraints: Maximum length of 20000.
Required: No
** promotionName **
The name of the promotion that included the predicted item.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
** reason **
If you use User-Personalization-v2, a list of reasons for why the item was included in recommendations. Possible reasons include the following:
+ Promoted item - Indicates the item was included as part of a promotion that you applied in your recommendation request.
+ Exploration - Indicates the item was included with exploration. With exploration, recommendations include items with less interactions data or relevance for the user. For more information about exploration, see [Exploration](https://docs.amazonaws.cn/personalize/latest/dg/use-case-recipe-features.html#about-exploration).
+ Popular item - Indicates the item was included as a placeholder popular item. If you use a filter, depending on how many recommendations the filter removes, Amazon Personalize might add placeholder items to meet the `numResults` for your recommendation request. These items are popular items, based on interactions data, that satisfy your filter criteria. They don't have a relevance score for the user.
Type: Array of strings
Length Constraints: Maximum length of 256.
Required: No
** score **
A numeric representation of the model's certainty that the item will be the next user selection. For more information on scoring logic, see [Recommendation scores](getting-recommendations.md#how-scores-work).
Type: Double
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-runtime-2018-05-22/PredictedItem)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-runtime-2018-05-22/PredictedItem)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-runtime-2018-05-22/PredictedItem)
# Promotion
Contains information on a promotion. A promotion defines additional business rules that apply to a configurable subset of recommended items.
## Contents
** filterArn **
The Amazon Resource Name (ARN) of the filter used by the promotion. This filter defines the criteria for promoted items. For more information, see [Promotion filters](https://docs.amazonaws.cn/personalize/latest/dg/promoting-items.html#promotion-filters).
Type: String
Length Constraints: Maximum length of 256.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** filterValues **
The values to use when promoting items. For each placeholder parameter in your promotion's filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.
For filter expressions that use an `INCLUDE` element to include items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an `EXCLUDE` element to exclude items, you can omit the `filter-values`. In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.
For more information on creating filters, see [Filtering recommendations and user segments](https://docs.aws.amazon.com/personalize/latest/dg/filter.html).
Type: String to string map
Map Entries: Maximum number of 25 items.
Key Length Constraints: Maximum length of 50.
Key Pattern: `[A-Za-z0-9_]+`
Value Length Constraints: Maximum length of 1000.
Required: No
** name **
The name of the promotion.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
** percentPromotedItems **
The percentage of recommended items to apply the promotion to.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
## See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+ [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/personalize-runtime-2018-05-22/Promotion)
+ [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/personalize-runtime-2018-05-22/Promotion)
+ [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/personalize-runtime-2018-05-22/Promotion)
# Common Error Types
This section lists common error types that this Amazon service may return. Not all services return all error types listed here. For errors specific to an API action for this service, see the topic for that API action.
**AccessDeniedException**
You don't have permission to perform this action. Verify that your IAM policy includes the required permissions.
HTTP Status Code: 403
**ExpiredTokenException**
The security token included in the request has expired. Request a new security token and try again.
HTTP Status Code: 403
**IncompleteSignature**
The request signature doesn't conform to Amazon standards. Verify that you're using valid Amazon credentials and that your request is properly formatted. If you're using an SDK, ensure it's up to date.
HTTP Status Code: 403
**InternalFailure**
The request can't be processed right now because of an internal server issue. Try again later. If the problem persists, contact Amazon Support.
HTTP Status Code: 500
**MalformedHttpRequestException**
The request body can't be processed. This typically happens when the request body can't be decompressed using the specified content encoding algorithm. Verify that the content encoding header matches the compression format used.
HTTP Status Code: 400
**NotAuthorized**
You don't have permissions to perform this action. Verify that your IAM policy includes the required permissions.
HTTP Status Code: 401
**OptInRequired**
Your Amazon account needs a subscription for this service. Verify that you've enabled the service in your account.
HTTP Status Code: 403
**RequestAbortedException**
The request was aborted before a response could be returned. This typically happens when the client closes the connection.
HTTP Status Code: 400
**RequestEntityTooLargeException**
The request entity is too large. Reduce the size of the request body and try again.
HTTP Status Code: 413
**RequestTimeoutException**
The request timed out. The server didn't receive the complete request within the expected time frame. Try again.
HTTP Status Code: 408
**ServiceUnavailable**
The service is temporarily unavailable. Try again later.
HTTP Status Code: 503
**ThrottlingException**
Your request rate is too high. The Amazon SDKs automatically retry requests that receive this exception. Reduce the frequency of requests.
HTTP Status Code: 400
**UnknownOperationException**
The action or operation isn't recognized. Verify that the action name is spelled correctly and that it's supported by the API version you're using.
HTTP Status Code: 404
**UnrecognizedClientException**
The X.509 certificate or Amazon access key ID you provided doesn't exist in our records. Verify that you're using valid credentials and that they haven't expired.
HTTP Status Code: 403
**ValidationError**
The input doesn't meet the required format or constraints. Check that all required parameters are included and that values are valid.
HTTP Status Code: 400
# Common Parameters
The following list contains the parameters that all actions use for signing Signature Version 4 requests with a query string. Any action-specific parameters are listed in the topic for that action. For more information about Signature Version 4, see [Signing Amazon API requests](https://docs.amazonaws.cn/IAM/latest/UserGuide/reference_aws-signing.html) in the *IAM User Guide*.
**X-Amz-Algorithm**
The hash algorithm that you used to create the request signature.
Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header.
Type: string
Valid Values: `AWS4-HMAC-SHA256`
Required: Conditional
**X-Amz-Credential**
The credential scope value, which is a string that includes your access key, the date, the region you are targeting, the service you are requesting, and a termination string ("aws4\$1request"). The value is expressed in the following format: *access\$1key*/*YYYYMMDD*/*region*/*service*/aws4\$1request.
For more information, see [Create a signed Amazon API request](https://docs.amazonaws.cn/IAM/latest/UserGuide/create-signed-request.html) in the *IAM User Guide*.
Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header.
Type: string
Required: Conditional
**X-Amz-Date**
The date that is used to create the signature. The format must be ISO 8601 basic format (YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value: `20120325T120000Z`.
Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for signing requests. If the Date header is specified in the ISO 8601 basic format, X-Amz-Date is not required. When X-Amz-Date is used, it always overrides the value of the Date header. For more information, see [Elements of an Amazon API request signature](https://docs.amazonaws.cn/IAM/latest/UserGuide/signing-elements.html) in the *IAM User Guide*.
Type: string
Required: Conditional
**X-Amz-Security-Token**
The temporary security token that was obtained through a call to Amazon Security Token Service (Amazon STS). For a list of services that support temporary security credentials from Amazon STS, see [Amazon Web Services services that work with IAM](https://docs.amazonaws.cn/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html) in the *IAM User Guide*.
Condition: If you're using temporary security credentials from Amazon STS, you must include the security token.
Type: string
Required: Conditional
**X-Amz-Signature**
Specifies the hex-encoded signature that was calculated from the string to sign and the derived signing key.
Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header.
Type: string
Required: Conditional
**X-Amz-SignedHeaders**
Specifies all the HTTP headers that were included as part of the canonical request. For more information about specifying signed headers, see [Create a signed Amazon API request](https://docs.amazonaws.cn/IAM/latest/UserGuide/create-signed-request.html) in the *IAM User Guide*.
Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header.
Type: string
Required: Conditional