{ "smithy": "1.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.personalize#AccountId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.personalize#Algorithm": { "type": "structure", "members": { "name": { "target": "com.amazonaws.personalize#Name", "traits": { "smithy.api#documentation": "

The name of the algorithm.

" } }, "algorithmArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the algorithm.

" } }, "algorithmImage": { "target": "com.amazonaws.personalize#AlgorithmImage", "traits": { "smithy.api#documentation": "

The URI of the Docker container for the algorithm image.

" } }, "defaultHyperParameters": { "target": "com.amazonaws.personalize#HyperParameters", "traits": { "smithy.api#documentation": "

Specifies the default hyperparameters.

" } }, "defaultHyperParameterRanges": { "target": "com.amazonaws.personalize#DefaultHyperParameterRanges", "traits": { "smithy.api#documentation": "

Specifies the default hyperparameters, their ranges, and whether they\n are tunable. A tunable hyperparameter can\n have its value determined during hyperparameter optimization (HPO).

" } }, "defaultResourceConfig": { "target": "com.amazonaws.personalize#ResourceConfig", "traits": { "smithy.api#documentation": "

Specifies the default maximum number of training jobs and parallel training jobs.

" } }, "trainingInputMode": { "target": "com.amazonaws.personalize#TrainingInputMode", "traits": { "smithy.api#documentation": "

The training input mode.

" } }, "roleArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role.

" } }, "creationDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The date and time (in Unix time) that the algorithm was created.

" } }, "lastUpdatedDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The date and time (in Unix time) that the algorithm was last updated.

" } } }, "traits": { "smithy.api#documentation": "

Describes a custom algorithm.

" } }, "com.amazonaws.personalize#AlgorithmImage": { "type": "structure", "members": { "name": { "target": "com.amazonaws.personalize#Name", "traits": { "smithy.api#documentation": "

The name of the algorithm image.

" } }, "dockerURI": { "target": "com.amazonaws.personalize#DockerURI", "traits": { "smithy.api#documentation": "

The URI of the Docker container for the algorithm image.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Describes an algorithm image.

" } }, "com.amazonaws.personalize#AmazonPersonalize": { "type": "service", "version": "2018-05-22", "operations": [ { "target": "com.amazonaws.personalize#CreateBatchInferenceJob" }, { "target": "com.amazonaws.personalize#CreateCampaign" }, { "target": "com.amazonaws.personalize#CreateDataset" }, { "target": "com.amazonaws.personalize#CreateDatasetExportJob" }, { "target": "com.amazonaws.personalize#CreateDatasetGroup" }, { "target": "com.amazonaws.personalize#CreateDatasetImportJob" }, { "target": "com.amazonaws.personalize#CreateEventTracker" }, { "target": "com.amazonaws.personalize#CreateFilter" }, { "target": "com.amazonaws.personalize#CreateSchema" }, { "target": "com.amazonaws.personalize#CreateSolution" }, { "target": "com.amazonaws.personalize#CreateSolutionVersion" }, { "target": "com.amazonaws.personalize#DeleteCampaign" }, { "target": "com.amazonaws.personalize#DeleteDataset" }, { "target": "com.amazonaws.personalize#DeleteDatasetGroup" }, { "target": "com.amazonaws.personalize#DeleteEventTracker" }, { "target": "com.amazonaws.personalize#DeleteFilter" }, { "target": "com.amazonaws.personalize#DeleteSchema" }, { "target": "com.amazonaws.personalize#DeleteSolution" }, { "target": "com.amazonaws.personalize#DescribeAlgorithm" }, { "target": "com.amazonaws.personalize#DescribeBatchInferenceJob" }, { "target": "com.amazonaws.personalize#DescribeCampaign" }, { "target": "com.amazonaws.personalize#DescribeDataset" }, { "target": "com.amazonaws.personalize#DescribeDatasetExportJob" }, { "target": "com.amazonaws.personalize#DescribeDatasetGroup" }, { "target": "com.amazonaws.personalize#DescribeDatasetImportJob" }, { "target": "com.amazonaws.personalize#DescribeEventTracker" }, { "target": "com.amazonaws.personalize#DescribeFeatureTransformation" }, { "target": "com.amazonaws.personalize#DescribeFilter" }, { "target": "com.amazonaws.personalize#DescribeRecipe" }, { "target": "com.amazonaws.personalize#DescribeSchema" }, { "target": "com.amazonaws.personalize#DescribeSolution" }, { "target": "com.amazonaws.personalize#DescribeSolutionVersion" }, { "target": "com.amazonaws.personalize#GetSolutionMetrics" }, { "target": "com.amazonaws.personalize#ListBatchInferenceJobs" }, { "target": "com.amazonaws.personalize#ListCampaigns" }, { "target": "com.amazonaws.personalize#ListDatasetExportJobs" }, { "target": "com.amazonaws.personalize#ListDatasetGroups" }, { "target": "com.amazonaws.personalize#ListDatasetImportJobs" }, { "target": "com.amazonaws.personalize#ListDatasets" }, { "target": "com.amazonaws.personalize#ListEventTrackers" }, { "target": "com.amazonaws.personalize#ListFilters" }, { "target": "com.amazonaws.personalize#ListRecipes" }, { "target": "com.amazonaws.personalize#ListSchemas" }, { "target": "com.amazonaws.personalize#ListSolutions" }, { "target": "com.amazonaws.personalize#ListSolutionVersions" }, { "target": "com.amazonaws.personalize#StopSolutionVersionCreation" }, { "target": "com.amazonaws.personalize#UpdateCampaign" } ], "traits": { "aws.api#service": { "sdkId": "Personalize", "arnNamespace": "personalize", "cloudFormationName": "Personalize", "cloudTrailEventSource": "personalize.amazonaws.com", "endpointPrefix": "personalize" }, "aws.auth#sigv4": { "name": "personalize" }, "aws.protocols#awsJson1_1": {}, "smithy.api#documentation": "

Amazon Personalize is a machine learning service that makes it easy to add individualized\n recommendations to customers.

", "smithy.api#title": "Amazon Personalize" } }, "com.amazonaws.personalize#Arn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^arn:([a-z\\d-]+):personalize:.*:.*:.+$" } }, "com.amazonaws.personalize#ArnList": { "type": "list", "member": { "target": "com.amazonaws.personalize#Arn" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.personalize#AutoMLConfig": { "type": "structure", "members": { "metricName": { "target": "com.amazonaws.personalize#MetricName", "traits": { "smithy.api#documentation": "

The metric to optimize.

" } }, "recipeList": { "target": "com.amazonaws.personalize#ArnList", "traits": { "smithy.api#documentation": "

The list of candidate recipes.

" } } }, "traits": { "smithy.api#documentation": "

When the solution performs AutoML (performAutoML is true in\n CreateSolution), Amazon Personalize\n determines which recipe, from the specified list, optimizes the given metric.\n Amazon Personalize then uses that recipe for the solution.

" } }, "com.amazonaws.personalize#AutoMLResult": { "type": "structure", "members": { "bestRecipeArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the best recipe.

" } } }, "traits": { "smithy.api#documentation": "

When the solution performs AutoML (performAutoML is true in\n CreateSolution), specifies the recipe that best optimized the\n specified metric.

" } }, "com.amazonaws.personalize#AvroSchema": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 10000 } } }, "com.amazonaws.personalize#BatchInferenceJob": { "type": "structure", "members": { "jobName": { "target": "com.amazonaws.personalize#Name", "traits": { "smithy.api#documentation": "

The name of the batch inference job.

" } }, "batchInferenceJobArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the batch inference job.

" } }, "filterArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The ARN of the filter used on the batch inference job.

" } }, "failureReason": { "target": "com.amazonaws.personalize#FailureReason", "traits": { "smithy.api#documentation": "

If the batch inference job failed, the reason for the failure.

" } }, "solutionVersionArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the solution version from which the batch inference job\n was created.

" } }, "numResults": { "target": "com.amazonaws.personalize#NumBatchResults", "traits": { "smithy.api#documentation": "

The number of recommendations generated by the batch inference job. This number includes\n the error messages generated for failed input records.

" } }, "jobInput": { "target": "com.amazonaws.personalize#BatchInferenceJobInput", "traits": { "smithy.api#documentation": "

The Amazon S3 path that leads to the input data used to generate the batch inference\n job.

" } }, "jobOutput": { "target": "com.amazonaws.personalize#BatchInferenceJobOutput", "traits": { "smithy.api#documentation": "

The Amazon S3 bucket that contains the output data generated by the batch inference job.

" } }, "batchInferenceJobConfig": { "target": "com.amazonaws.personalize#BatchInferenceJobConfig", "traits": { "smithy.api#documentation": "

A string to string map of the configuration details of a batch inference job.

" } }, "roleArn": { "target": "com.amazonaws.personalize#RoleArn", "traits": { "smithy.api#documentation": "

The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.

" } }, "status": { "target": "com.amazonaws.personalize#Status", "traits": { "smithy.api#documentation": "

The status of the batch inference job. The status is one of the following values:

\n " } }, "creationDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The time at which the batch inference job was created.

" } }, "lastUpdatedDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The time at which the batch inference job was last updated.

" } } }, "traits": { "smithy.api#documentation": "

Contains information on a batch inference job.

" } }, "com.amazonaws.personalize#BatchInferenceJobConfig": { "type": "structure", "members": { "itemExplorationConfig": { "target": "com.amazonaws.personalize#HyperParameters", "traits": { "smithy.api#documentation": "

A string to string map specifying the exploration configuration hyperparameters, including explorationWeight and \n explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when\n recommending items. \n See User-Personalization.

" } } }, "traits": { "smithy.api#documentation": "

The configuration details of a batch inference job.

" } }, "com.amazonaws.personalize#BatchInferenceJobInput": { "type": "structure", "members": { "s3DataSource": { "target": "com.amazonaws.personalize#S3DataConfig", "traits": { "smithy.api#documentation": "

The URI of the Amazon S3 location that contains your input data. The Amazon S3 bucket must be in the\n same region as the API endpoint you are calling.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The input configuration of a batch inference job.

" } }, "com.amazonaws.personalize#BatchInferenceJobOutput": { "type": "structure", "members": { "s3DataDestination": { "target": "com.amazonaws.personalize#S3DataConfig", "traits": { "smithy.api#documentation": "

Information on the Amazon S3 bucket in which the batch inference job's output is stored.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The output configuration parameters of a batch inference job.

" } }, "com.amazonaws.personalize#BatchInferenceJobSummary": { "type": "structure", "members": { "batchInferenceJobArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the batch inference job.

" } }, "jobName": { "target": "com.amazonaws.personalize#Name", "traits": { "smithy.api#documentation": "

The name of the batch inference job.

" } }, "status": { "target": "com.amazonaws.personalize#Status", "traits": { "smithy.api#documentation": "

The status of the batch inference job. The status is one of the following values:

\n " } }, "creationDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The time at which the batch inference job was created.

" } }, "lastUpdatedDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The time at which the batch inference job was last updated.

" } }, "failureReason": { "target": "com.amazonaws.personalize#FailureReason", "traits": { "smithy.api#documentation": "

If the batch inference job failed, the reason for the failure.

" } }, "solutionVersionArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The ARN of the solution version used by the batch inference job.

" } } }, "traits": { "smithy.api#documentation": "

A truncated version of the BatchInferenceJob datatype. The ListBatchInferenceJobs operation returns a list of batch inference job\n summaries.

" } }, "com.amazonaws.personalize#BatchInferenceJobs": { "type": "list", "member": { "target": "com.amazonaws.personalize#BatchInferenceJobSummary" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.personalize#Boolean": { "type": "boolean", "traits": { "smithy.api#box": {} } }, "com.amazonaws.personalize#Campaign": { "type": "structure", "members": { "name": { "target": "com.amazonaws.personalize#Name", "traits": { "smithy.api#documentation": "

The name of the campaign.

" } }, "campaignArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the campaign.

" } }, "solutionVersionArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a specific version of the solution.

" } }, "minProvisionedTPS": { "target": "com.amazonaws.personalize#TransactionsPerSecond", "traits": { "smithy.api#documentation": "

Specifies the requested minimum provisioned transactions (recommendations) per second.

" } }, "campaignConfig": { "target": "com.amazonaws.personalize#CampaignConfig", "traits": { "smithy.api#documentation": "

The configuration details of a campaign.

" } }, "status": { "target": "com.amazonaws.personalize#Status", "traits": { "smithy.api#documentation": "

The status of the campaign.

\n

A campaign can be in one of the following states:

\n " } }, "failureReason": { "target": "com.amazonaws.personalize#FailureReason", "traits": { "smithy.api#documentation": "

If a campaign fails, the reason behind the failure.

" } }, "creationDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The date and time (in Unix format) that the campaign was created.

" } }, "lastUpdatedDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The date and time (in Unix format) that the campaign was last updated.

" } }, "latestCampaignUpdate": { "target": "com.amazonaws.personalize#CampaignUpdateSummary" } }, "traits": { "smithy.api#documentation": "

Describes a deployed solution version, otherwise known as a campaign.\n For more information on campaigns, see CreateCampaign.

" } }, "com.amazonaws.personalize#CampaignConfig": { "type": "structure", "members": { "itemExplorationConfig": { "target": "com.amazonaws.personalize#HyperParameters", "traits": { "smithy.api#documentation": "

A string to string map specifying the exploration configuration hyperparameters, including explorationWeight and \n explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when\n recommending items. Provide itemExplorationConfig data only if your solution uses the\n User-Personalization recipe.

" } } }, "traits": { "smithy.api#documentation": "

The configuration details of a campaign.

" } }, "com.amazonaws.personalize#CampaignSummary": { "type": "structure", "members": { "name": { "target": "com.amazonaws.personalize#Name", "traits": { "smithy.api#documentation": "

The name of the campaign.

" } }, "campaignArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the campaign.

" } }, "status": { "target": "com.amazonaws.personalize#Status", "traits": { "smithy.api#documentation": "

The status of the campaign.

\n

A campaign can be in one of the following states:

\n " } }, "creationDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The date and time (in Unix time) that the campaign was created.

" } }, "lastUpdatedDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The date and time (in Unix time) that the campaign was last updated.

" } }, "failureReason": { "target": "com.amazonaws.personalize#FailureReason", "traits": { "smithy.api#documentation": "

If a campaign fails, the reason behind the failure.

" } } }, "traits": { "smithy.api#documentation": "

Provides a summary of the properties of a campaign. For a complete listing, call the\n DescribeCampaign API.

" } }, "com.amazonaws.personalize#CampaignUpdateSummary": { "type": "structure", "members": { "solutionVersionArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the deployed solution version.

" } }, "minProvisionedTPS": { "target": "com.amazonaws.personalize#TransactionsPerSecond", "traits": { "smithy.api#documentation": "

Specifies the requested minimum provisioned transactions (recommendations) per second that\n Amazon Personalize will support.

" } }, "campaignConfig": { "target": "com.amazonaws.personalize#CampaignConfig" }, "status": { "target": "com.amazonaws.personalize#Status", "traits": { "smithy.api#documentation": "

The status of the campaign update.

\n

A campaign update can be in one of the following states:

\n " } }, "failureReason": { "target": "com.amazonaws.personalize#FailureReason", "traits": { "smithy.api#documentation": "

If a campaign update fails, the reason behind the failure.

" } }, "creationDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The date and time (in Unix time) that the campaign update was created.

" } }, "lastUpdatedDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The date and time (in Unix time) that the campaign update was last updated.

" } } }, "traits": { "smithy.api#documentation": "

Provides a summary of the properties of a campaign update. For a complete listing, call the\n DescribeCampaign API.

" } }, "com.amazonaws.personalize#Campaigns": { "type": "list", "member": { "target": "com.amazonaws.personalize#CampaignSummary" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.personalize#CategoricalHyperParameterRange": { "type": "structure", "members": { "name": { "target": "com.amazonaws.personalize#ParameterName", "traits": { "smithy.api#documentation": "

The name of the hyperparameter.

" } }, "values": { "target": "com.amazonaws.personalize#CategoricalValues", "traits": { "smithy.api#documentation": "

A list of the categories for the hyperparameter.

" } } }, "traits": { "smithy.api#documentation": "

Provides the name and range of a categorical hyperparameter.

" } }, "com.amazonaws.personalize#CategoricalHyperParameterRanges": { "type": "list", "member": { "target": "com.amazonaws.personalize#CategoricalHyperParameterRange" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.personalize#CategoricalValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 } } }, "com.amazonaws.personalize#CategoricalValues": { "type": "list", "member": { "target": "com.amazonaws.personalize#CategoricalValue" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.personalize#ContinuousHyperParameterRange": { "type": "structure", "members": { "name": { "target": "com.amazonaws.personalize#ParameterName", "traits": { "smithy.api#documentation": "

The name of the hyperparameter.

" } }, "minValue": { "target": "com.amazonaws.personalize#ContinuousMinValue", "traits": { "smithy.api#documentation": "

The minimum allowable value for the hyperparameter.

" } }, "maxValue": { "target": "com.amazonaws.personalize#ContinuousMaxValue", "traits": { "smithy.api#documentation": "

The maximum allowable value for the hyperparameter.

" } } }, "traits": { "smithy.api#documentation": "

Provides the name and range of a continuous hyperparameter.

" } }, "com.amazonaws.personalize#ContinuousHyperParameterRanges": { "type": "list", "member": { "target": "com.amazonaws.personalize#ContinuousHyperParameterRange" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.personalize#ContinuousMaxValue": { "type": "double", "traits": { "smithy.api#range": { "min": -1000000 } } }, "com.amazonaws.personalize#ContinuousMinValue": { "type": "double", "traits": { "smithy.api#range": { "min": -1000000 } } }, "com.amazonaws.personalize#CreateBatchInferenceJob": { "type": "operation", "input": { "target": "com.amazonaws.personalize#CreateBatchInferenceJobRequest" }, "output": { "target": "com.amazonaws.personalize#CreateBatchInferenceJobResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#LimitExceededException" }, { "target": "com.amazonaws.personalize#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.personalize#ResourceInUseException" }, { "target": "com.amazonaws.personalize#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Creates a batch inference job. The operation can handle up to 50 million records and the\n input file must be in JSON format. For more information, see recommendations-batch.

" } }, "com.amazonaws.personalize#CreateBatchInferenceJobRequest": { "type": "structure", "members": { "jobName": { "target": "com.amazonaws.personalize#Name", "traits": { "smithy.api#documentation": "

The name of the batch inference job to create.

", "smithy.api#required": {} } }, "solutionVersionArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the solution version that will be used to generate the\n batch inference recommendations.

", "smithy.api#required": {} } }, "filterArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The ARN of the filter to apply to the batch inference job. For more information on using\n filters, see\n Filtering Batch Recommendations..

" } }, "numResults": { "target": "com.amazonaws.personalize#NumBatchResults", "traits": { "smithy.api#documentation": "

The number of recommendations to retreive.

" } }, "jobInput": { "target": "com.amazonaws.personalize#BatchInferenceJobInput", "traits": { "smithy.api#documentation": "

The Amazon S3 path that leads to the input file to base your recommendations on. The input\n material must be in JSON format.

", "smithy.api#required": {} } }, "jobOutput": { "target": "com.amazonaws.personalize#BatchInferenceJobOutput", "traits": { "smithy.api#documentation": "

The path to the Amazon S3 bucket where the job's output will be stored.

", "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.personalize#RoleArn", "traits": { "smithy.api#documentation": "

The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output\n Amazon S3 buckets respectively.

", "smithy.api#required": {} } }, "batchInferenceJobConfig": { "target": "com.amazonaws.personalize#BatchInferenceJobConfig", "traits": { "smithy.api#documentation": "

The configuration details of a batch inference job.

" } } } }, "com.amazonaws.personalize#CreateBatchInferenceJobResponse": { "type": "structure", "members": { "batchInferenceJobArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The ARN of the batch inference job.

" } } } }, "com.amazonaws.personalize#CreateCampaign": { "type": "operation", "input": { "target": "com.amazonaws.personalize#CreateCampaignRequest" }, "output": { "target": "com.amazonaws.personalize#CreateCampaignResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#LimitExceededException" }, { "target": "com.amazonaws.personalize#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.personalize#ResourceInUseException" }, { "target": "com.amazonaws.personalize#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Creates a campaign by deploying a solution version. When a client calls the\n GetRecommendations\n and\n GetPersonalizedRanking\n APIs, a campaign is specified in the request.

\n\n

\n Minimum Provisioned TPS and Auto-Scaling\n

\n \n

A transaction is a single GetRecommendations or\n GetPersonalizedRanking call. Transactions per second (TPS) is the throughput\n and unit of billing for Amazon Personalize. The minimum provisioned TPS\n (minProvisionedTPS) specifies the baseline throughput provisioned by\n Amazon Personalize, and thus, the minimum billing charge. \n

\n

\n If your TPS increases beyond\n minProvisionedTPS, Amazon Personalize auto-scales the provisioned capacity up and down,\n but never below minProvisionedTPS.\n There's a short time delay while the capacity is increased that might cause loss of\n transactions.

\n

The actual TPS used is calculated as the average requests/second within a 5-minute window.\n You pay for maximum of either the minimum provisioned TPS or the actual TPS.\n We recommend starting with a low minProvisionedTPS, track\n your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS\n as necessary.

\n\n

\n Status\n

\n

A campaign can be in one of the following states:

\n \n

To get the campaign status, call DescribeCampaign.

\n \n

Wait until the status of the campaign\n is ACTIVE before asking the campaign for recommendations.

\n \n \n

\n Related APIs\n

\n ", "smithy.api#idempotent": {} } }, "com.amazonaws.personalize#CreateCampaignRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.personalize#Name", "traits": { "smithy.api#documentation": "

A name for the new campaign. The campaign name must be unique within your account.

", "smithy.api#required": {} } }, "solutionVersionArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the solution version to deploy.

", "smithy.api#required": {} } }, "minProvisionedTPS": { "target": "com.amazonaws.personalize#TransactionsPerSecond", "traits": { "smithy.api#documentation": "

Specifies the requested minimum provisioned transactions (recommendations) per second that\n Amazon Personalize will support.

", "smithy.api#required": {} } }, "campaignConfig": { "target": "com.amazonaws.personalize#CampaignConfig", "traits": { "smithy.api#documentation": "

The configuration details of a campaign.

" } } } }, "com.amazonaws.personalize#CreateCampaignResponse": { "type": "structure", "members": { "campaignArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the campaign.

" } } } }, "com.amazonaws.personalize#CreateDataset": { "type": "operation", "input": { "target": "com.amazonaws.personalize#CreateDatasetRequest" }, "output": { "target": "com.amazonaws.personalize#CreateDatasetResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#LimitExceededException" }, { "target": "com.amazonaws.personalize#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.personalize#ResourceInUseException" }, { "target": "com.amazonaws.personalize#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import your training data to a dataset.

\n

There are three types of datasets:

\n \n

Each dataset type has an associated schema with required field types. Only the\n Interactions dataset is required in order to train a model (also referred to as\n creating a solution).

\n

A dataset can be in one of the following states:

\n \n

To get the status of the dataset, call DescribeDataset.

\n

\n Related APIs\n

\n ", "smithy.api#idempotent": {} } }, "com.amazonaws.personalize#CreateDatasetExportJob": { "type": "operation", "input": { "target": "com.amazonaws.personalize#CreateDatasetExportJobRequest" }, "output": { "target": "com.amazonaws.personalize#CreateDatasetExportJobResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#LimitExceededException" }, { "target": "com.amazonaws.personalize#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.personalize#ResourceInUseException" }, { "target": "com.amazonaws.personalize#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

\n Creates a job that exports data from your dataset to an Amazon S3 bucket. \n To allow Amazon Personalize to export the training data, you must specify an\n service-linked AWS Identity and Access Management (IAM) role that gives Amazon Personalize PutObject permissions for your Amazon S3 bucket. \n For information, see Exporting a dataset \n in the Amazon Personalize developer guide.\n

\n

\n Status\n

\n

A dataset export job can be in one of the following states:

\n \n

\n To get the status of the export job, call DescribeDatasetExportJob,\n and specify the Amazon Resource Name (ARN) of the dataset export job. The dataset export is\n complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response\n includes a failureReason key, which describes why the job failed.\n

", "smithy.api#idempotent": {} } }, "com.amazonaws.personalize#CreateDatasetExportJobRequest": { "type": "structure", "members": { "jobName": { "target": "com.amazonaws.personalize#Name", "traits": { "smithy.api#documentation": "

The name for the dataset export job.

", "smithy.api#required": {} } }, "datasetArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset that contains the data to export.

", "smithy.api#required": {} } }, "ingestionMode": { "target": "com.amazonaws.personalize#IngestionMode", "traits": { "smithy.api#documentation": "

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, \n only PUT data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL \n for both types. The default value is PUT.\n

" } }, "roleArn": { "target": "com.amazonaws.personalize#RoleArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management service role that has permissions to add data to your\n output Amazon S3 bucket.

", "smithy.api#required": {} } }, "jobOutput": { "target": "com.amazonaws.personalize#DatasetExportJobOutput", "traits": { "smithy.api#documentation": "

The path to the Amazon S3 bucket where the job's output is stored.

", "smithy.api#required": {} } } } }, "com.amazonaws.personalize#CreateDatasetExportJobResponse": { "type": "structure", "members": { "datasetExportJobArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset export job.

" } } } }, "com.amazonaws.personalize#CreateDatasetGroup": { "type": "operation", "input": { "target": "com.amazonaws.personalize#CreateDatasetGroupRequest" }, "output": { "target": "com.amazonaws.personalize#CreateDatasetGroupResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#LimitExceededException" }, { "target": "com.amazonaws.personalize#ResourceAlreadyExistsException" } ], "traits": { "smithy.api#documentation": "

Creates an empty dataset group. A dataset group contains related datasets that supply data\n for training a model. A dataset group can contain at most three datasets, one for each type of\n dataset:

\n \n

To train a model (create a solution), a dataset group that contains an\n Interactions dataset is required. Call CreateDataset to add a\n dataset to the group.

\n

A dataset group can be in one of the following states:

\n \n

To get the status of the dataset group, call DescribeDatasetGroup. If\n the status shows as CREATE FAILED, the response includes a failureReason key,\n which describes why the creation failed.

\n \n

You must wait until the status of the dataset group is ACTIVE\n before adding a dataset to the group.

\n \n

You can specify an AWS Key Management Service (KMS) key to encrypt the datasets in the group. If you\n specify a KMS key, you must also include an AWS Identity and Access Management (IAM) role that has permission to\n access the key.

\n

\n APIs that require a dataset group ARN in the request\n

\n \n

\n Related APIs\n

\n " } }, "com.amazonaws.personalize#CreateDatasetGroupRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.personalize#Name", "traits": { "smithy.api#documentation": "

The name for the new dataset group.

", "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.personalize#RoleArn", "traits": { "smithy.api#documentation": "

The ARN of the IAM role that has permissions to access the KMS key. Supplying an IAM\n role is only valid when also specifying a KMS key.

" } }, "kmsKeyArn": { "target": "com.amazonaws.personalize#KmsKeyArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a KMS key used to encrypt the datasets.

" } } } }, "com.amazonaws.personalize#CreateDatasetGroupResponse": { "type": "structure", "members": { "datasetGroupArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the new dataset group.

" } } } }, "com.amazonaws.personalize#CreateDatasetImportJob": { "type": "operation", "input": { "target": "com.amazonaws.personalize#CreateDatasetImportJobRequest" }, "output": { "target": "com.amazonaws.personalize#CreateDatasetImportJobResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#LimitExceededException" }, { "target": "com.amazonaws.personalize#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.personalize#ResourceInUseException" }, { "target": "com.amazonaws.personalize#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Creates a job that imports training data from your data source (an Amazon S3 bucket) to an\n Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an\n AWS Identity and Access Management (IAM) service role that has permission to read from the data source, as Amazon Personalize makes a\n copy of your data and processes it in an internal AWS system. For information on granting access\n to your Amazon S3 bucket, see Giving Amazon Personalize \n Access to Amazon S3 Resources.

\n \n

The dataset import job replaces any existing data in the dataset that you imported in bulk.

\n \n

\n Status\n

\n

A dataset import job can be in one of the following states:

\n \n

To get the status of the import job, call DescribeDatasetImportJob,\n providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is\n complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response\n includes a failureReason key, which describes why the job failed.

\n \n

Importing takes time. You must wait until the status shows as ACTIVE before training a\n model using the dataset.

\n \n \n

\n Related APIs\n

\n " } }, "com.amazonaws.personalize#CreateDatasetImportJobRequest": { "type": "structure", "members": { "jobName": { "target": "com.amazonaws.personalize#Name", "traits": { "smithy.api#documentation": "

The name for the dataset import job.

", "smithy.api#required": {} } }, "datasetArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The ARN of the dataset that receives the imported data.

", "smithy.api#required": {} } }, "dataSource": { "target": "com.amazonaws.personalize#DataSource", "traits": { "smithy.api#documentation": "

The Amazon S3 bucket that contains the training data to import.

", "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.personalize#RoleArn", "traits": { "smithy.api#documentation": "

The ARN of the IAM role that has permissions to read from the Amazon S3 data source.

", "smithy.api#required": {} } } } }, "com.amazonaws.personalize#CreateDatasetImportJobResponse": { "type": "structure", "members": { "datasetImportJobArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The ARN of the dataset import job.

" } } } }, "com.amazonaws.personalize#CreateDatasetRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.personalize#Name", "traits": { "smithy.api#documentation": "

The name for the dataset.

", "smithy.api#required": {} } }, "schemaArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The ARN of the schema to associate with the dataset. The schema defines the dataset\n fields.

", "smithy.api#required": {} } }, "datasetGroupArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset group to add the dataset to.

", "smithy.api#required": {} } }, "datasetType": { "target": "com.amazonaws.personalize#DatasetType", "traits": { "smithy.api#documentation": "

The type of dataset.

\n

One of the following (case insensitive) values:

\n ", "smithy.api#required": {} } } } }, "com.amazonaws.personalize#CreateDatasetResponse": { "type": "structure", "members": { "datasetArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The ARN of the dataset.

" } } } }, "com.amazonaws.personalize#CreateEventTracker": { "type": "operation", "input": { "target": "com.amazonaws.personalize#CreateEventTrackerRequest" }, "output": { "target": "com.amazonaws.personalize#CreateEventTrackerResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#LimitExceededException" }, { "target": "com.amazonaws.personalize#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.personalize#ResourceInUseException" }, { "target": "com.amazonaws.personalize#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Creates an event tracker that you use when adding event data to a specified dataset\n group using the\n PutEvents API.

\n \n

Only one event tracker can be associated with a dataset group. You will get\n an error if you call CreateEventTracker using the same dataset group as an\n existing event tracker.

\n \n

When you create an event tracker, the response includes a tracking ID, which you pass as a parameter when you use the\n PutEvents operation.\n Amazon Personalize then appends the event data to the Interactions dataset of the dataset group you specify \n in your event tracker.\n

\n

The event tracker can be in one of the following states:

\n \n

To get the status of the event tracker, call DescribeEventTracker.

\n \n

The event tracker must be in the ACTIVE state before using the tracking ID.

\n \n

\n Related APIs\n

\n ", "smithy.api#idempotent": {} } }, "com.amazonaws.personalize#CreateEventTrackerRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.personalize#Name", "traits": { "smithy.api#documentation": "

The name for the event tracker.

", "smithy.api#required": {} } }, "datasetGroupArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset group that receives the event data.

", "smithy.api#required": {} } } } }, "com.amazonaws.personalize#CreateEventTrackerResponse": { "type": "structure", "members": { "eventTrackerArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The ARN of the event tracker.

" } }, "trackingId": { "target": "com.amazonaws.personalize#TrackingId", "traits": { "smithy.api#documentation": "

The ID of the event tracker. Include this ID in requests to the\n PutEvents API.

" } } } }, "com.amazonaws.personalize#CreateFilter": { "type": "operation", "input": { "target": "com.amazonaws.personalize#CreateFilterRequest" }, "output": { "target": "com.amazonaws.personalize#CreateFilterResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#LimitExceededException" }, { "target": "com.amazonaws.personalize#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.personalize#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Creates a recommendation filter. For more information, see filter.

" } }, "com.amazonaws.personalize#CreateFilterRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.personalize#Name", "traits": { "smithy.api#documentation": "

The name of the filter to create.

", "smithy.api#required": {} } }, "datasetGroupArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The ARN of the dataset group that the filter will belong to.

", "smithy.api#required": {} } }, "filterExpression": { "target": "com.amazonaws.personalize#FilterExpression", "traits": { "smithy.api#documentation": "

The filter expression defines which items are included or excluded from recommendations. Filter expression must follow specific format rules. \n For information about filter expression structure and syntax, see\n filter-expressions.

", "smithy.api#required": {} } } } }, "com.amazonaws.personalize#CreateFilterResponse": { "type": "structure", "members": { "filterArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The ARN of the new filter.

" } } } }, "com.amazonaws.personalize#CreateSchema": { "type": "operation", "input": { "target": "com.amazonaws.personalize#CreateSchemaRequest" }, "output": { "target": "com.amazonaws.personalize#CreateSchemaResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#LimitExceededException" }, { "target": "com.amazonaws.personalize#ResourceAlreadyExistsException" } ], "traits": { "smithy.api#documentation": "

Creates an Amazon Personalize schema from the specified schema string. The schema you create\n must be in Avro JSON format.

\n

Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset\n type and has a set of required field and keywords.\n You specify a schema when you call CreateDataset.

\n \n

\n Related APIs\n

\n ", "smithy.api#idempotent": {} } }, "com.amazonaws.personalize#CreateSchemaRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.personalize#Name", "traits": { "smithy.api#documentation": "

The name for the schema.

", "smithy.api#required": {} } }, "schema": { "target": "com.amazonaws.personalize#AvroSchema", "traits": { "smithy.api#documentation": "

A schema in Avro JSON format.

", "smithy.api#required": {} } } } }, "com.amazonaws.personalize#CreateSchemaResponse": { "type": "structure", "members": { "schemaArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the created schema.

" } } } }, "com.amazonaws.personalize#CreateSolution": { "type": "operation", "input": { "target": "com.amazonaws.personalize#CreateSolutionRequest" }, "output": { "target": "com.amazonaws.personalize#CreateSolutionResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#LimitExceededException" }, { "target": "com.amazonaws.personalize#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.personalize#ResourceInUseException" }, { "target": "com.amazonaws.personalize#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Creates the configuration for training a model. A trained model is known as\n a solution. After the configuration is created, you train the model (create a solution)\n by calling the CreateSolutionVersion operation. Every time you call\n CreateSolutionVersion, a new version of the solution is created.

\n

After creating a solution version, you check its accuracy by calling\n GetSolutionMetrics. When you are satisfied with the version, you\n deploy it using CreateCampaign. The campaign provides recommendations\n to a client through the\n GetRecommendations API.

\n

To train a model, Amazon Personalize requires training data and a recipe. The training data\n comes from the dataset group that you provide in the request. A recipe specifies\n the training algorithm and a feature transformation. You can specify one of the predefined\n recipes provided by Amazon Personalize. Alternatively, you can specify\n performAutoML and Amazon Personalize will analyze your data and select the\n optimum USER_PERSONALIZATION recipe for you.

\n \n

Amazon Personalize doesn't support configuring the hpoObjective \n for solution hyperparameter optimization at this time.

\n \n

\n Status\n

\n

A solution can be in one of the following states:

\n \n

To get the status of the solution, call DescribeSolution. Wait\n until the status shows as ACTIVE before calling CreateSolutionVersion.

\n \n \n \n

\n Related APIs\n

\n \n " } }, "com.amazonaws.personalize#CreateSolutionRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.personalize#Name", "traits": { "smithy.api#documentation": "

The name for the solution.

", "smithy.api#required": {} } }, "performHPO": { "target": "com.amazonaws.personalize#Boolean", "traits": { "smithy.api#documentation": "

Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe.\n The default is false.

\n

When performing AutoML, this parameter is always true and you\n should not set it to false.

" } }, "performAutoML": { "target": "com.amazonaws.personalize#PerformAutoML", "traits": { "smithy.api#documentation": "

Whether to perform automated machine learning (AutoML). The default is false.\n For this case, you must specify recipeArn.

\n

When set to true, Amazon Personalize analyzes your training data and selects\n the optimal USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit\n recipeArn. Amazon Personalize determines the optimal recipe by running tests with\n different values for the hyperparameters.\n AutoML lengthens the training process as compared to selecting a specific recipe.

" } }, "recipeArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The ARN of the recipe to use for model training. Only specified when\n performAutoML is false.

" } }, "datasetGroupArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset group that provides the training data.

", "smithy.api#required": {} } }, "eventType": { "target": "com.amazonaws.personalize#EventType", "traits": { "smithy.api#documentation": "

When your have multiple event types (using an EVENT_TYPE schema field),\n this parameter specifies which event type (for example, 'click' or 'like') is used for\n training the model.

\n

If you do not provide an eventType, Amazon Personalize will use all interactions for training with\n equal weight regardless of type.

" } }, "solutionConfig": { "target": "com.amazonaws.personalize#SolutionConfig", "traits": { "smithy.api#documentation": "

The configuration to use with the solution. When performAutoML is set to\n true, Amazon Personalize only evaluates the autoMLConfig section\n of the solution configuration.

\n \n

Amazon Personalize doesn't support configuring the hpoObjective \n at this time.

\n " } } } }, "com.amazonaws.personalize#CreateSolutionResponse": { "type": "structure", "members": { "solutionArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The ARN of the solution.

" } } } }, "com.amazonaws.personalize#CreateSolutionVersion": { "type": "operation", "input": { "target": "com.amazonaws.personalize#CreateSolutionVersionRequest" }, "output": { "target": "com.amazonaws.personalize#CreateSolutionVersionResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#LimitExceededException" }, { "target": "com.amazonaws.personalize#ResourceInUseException" }, { "target": "com.amazonaws.personalize#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Trains or retrains an active solution. A solution is created using the CreateSolution operation and must be in the ACTIVE state before calling\n CreateSolutionVersion. A new version of the solution is created every time you\n call this operation.

\n

\n Status\n

\n

A solution version can be in one of the following states:

\n \n

To get the status of the version, call DescribeSolutionVersion. Wait\n until the status shows as ACTIVE before calling CreateCampaign.

\n

If the status shows as CREATE FAILED, the response includes a failureReason\n key, which describes why the job failed.

\n

\n Related APIs\n

\n \n " } }, "com.amazonaws.personalize#CreateSolutionVersionRequest": { "type": "structure", "members": { "solutionArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the solution containing the training configuration\n information.

", "smithy.api#required": {} } }, "trainingMode": { "target": "com.amazonaws.personalize#TrainingMode", "traits": { "smithy.api#documentation": "

The scope of training to be performed when creating the solution version. The\n FULL option trains the solution version based on the entirety of the input\n solution's training data, while the UPDATE option processes only the data that\n has changed in comparison to the input solution. Choose UPDATE when you want to\n incrementally update your solution version instead of creating an entirely new one.

\n \n

The UPDATE option can only be used when you already have an active solution\n version created from the input solution using the FULL option and the input\n solution was trained with the \n User-Personalization\n recipe or the \n HRNN-Coldstart recipe.

\n " } } } }, "com.amazonaws.personalize#CreateSolutionVersionResponse": { "type": "structure", "members": { "solutionVersionArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The ARN of the new solution version.

" } } } }, "com.amazonaws.personalize#DataSource": { "type": "structure", "members": { "dataLocation": { "target": "com.amazonaws.personalize#S3Location", "traits": { "smithy.api#documentation": "

The path to the Amazon S3 bucket where the data that you want to upload to your dataset is\n stored. For example:

\n

\n s3://bucket-name/folder-name/\n

" } } }, "traits": { "smithy.api#documentation": "

Describes the data source that contains the data to upload to a dataset.

" } }, "com.amazonaws.personalize#Dataset": { "type": "structure", "members": { "name": { "target": "com.amazonaws.personalize#Name", "traits": { "smithy.api#documentation": "

The name of the dataset.

" } }, "datasetArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset that you want metadata for.

" } }, "datasetGroupArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset group.

" } }, "datasetType": { "target": "com.amazonaws.personalize#DatasetType", "traits": { "smithy.api#documentation": "

One of the following values:

\n " } }, "schemaArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The ARN of the associated schema.

" } }, "status": { "target": "com.amazonaws.personalize#Status", "traits": { "smithy.api#documentation": "

The status of the dataset.

\n

A dataset can be in one of the following states:

\n " } }, "creationDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The creation date and time (in Unix time) of the dataset.

" } }, "lastUpdatedDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

A time stamp that shows when the dataset was updated.

" } } }, "traits": { "smithy.api#documentation": "

Provides metadata for a dataset.

" } }, "com.amazonaws.personalize#DatasetExportJob": { "type": "structure", "members": { "jobName": { "target": "com.amazonaws.personalize#Name", "traits": { "smithy.api#documentation": "

The name of the export job.

" } }, "datasetExportJobArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset export job.

" } }, "datasetArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset to export.

" } }, "ingestionMode": { "target": "com.amazonaws.personalize#IngestionMode", "traits": { "smithy.api#documentation": "

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, \n PUT data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL \n for both types. The default value is PUT.\n

" } }, "roleArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management service role that has permissions to add data to your\n output Amazon S3 bucket.

" } }, "status": { "target": "com.amazonaws.personalize#Status", "traits": { "smithy.api#documentation": "

The status of the dataset export job.

\n

A dataset export job can be in one of the following states:

\n " } }, "jobOutput": { "target": "com.amazonaws.personalize#DatasetExportJobOutput", "traits": { "smithy.api#documentation": "

The path to the Amazon S3 bucket where the job's output is stored. For example:

\n

\n s3://bucket-name/folder-name/\n

" } }, "creationDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The creation date and time (in Unix time) of the dataset export job.

" } }, "lastUpdatedDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The date and time (in Unix time) the status of the dataset export job was last updated.

" } }, "failureReason": { "target": "com.amazonaws.personalize#FailureReason", "traits": { "smithy.api#documentation": "

If a dataset export job fails, provides the reason why.

" } } }, "traits": { "smithy.api#documentation": "

Describes a job that exports a dataset to an Amazon S3 bucket. For more information, see CreateDatasetExportJob.

\n

A dataset export job can be in one of the following states:

\n " } }, "com.amazonaws.personalize#DatasetExportJobOutput": { "type": "structure", "members": { "s3DataDestination": { "target": "com.amazonaws.personalize#S3DataConfig", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The output configuration parameters of a dataset export job.

" } }, "com.amazonaws.personalize#DatasetExportJobSummary": { "type": "structure", "members": { "datasetExportJobArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset export job.

" } }, "jobName": { "target": "com.amazonaws.personalize#Name", "traits": { "smithy.api#documentation": "

The name of the dataset export job.

" } }, "status": { "target": "com.amazonaws.personalize#Status", "traits": { "smithy.api#documentation": "

The status of the dataset export job.

\n

A dataset export job can be in one of the following states:

\n " } }, "creationDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The date and time (in Unix time) that the dataset export job was created.

" } }, "lastUpdatedDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The date and time (in Unix time) that the dataset export job status was last updated.

" } }, "failureReason": { "target": "com.amazonaws.personalize#FailureReason", "traits": { "smithy.api#documentation": "

If a dataset export job fails, the reason behind the failure.

" } } }, "traits": { "smithy.api#documentation": "

Provides a summary of the properties of a dataset export job. For a complete listing, call the\n DescribeDatasetExportJob API.

" } }, "com.amazonaws.personalize#DatasetExportJobs": { "type": "list", "member": { "target": "com.amazonaws.personalize#DatasetExportJobSummary" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.personalize#DatasetGroup": { "type": "structure", "members": { "name": { "target": "com.amazonaws.personalize#Name", "traits": { "smithy.api#documentation": "

The name of the dataset group.

" } }, "datasetGroupArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset group.

" } }, "status": { "target": "com.amazonaws.personalize#Status", "traits": { "smithy.api#documentation": "

The current status of the dataset group.

\n

A dataset group can be in one of the following states:

\n " } }, "roleArn": { "target": "com.amazonaws.personalize#RoleArn", "traits": { "smithy.api#documentation": "

The ARN of the IAM role that has permissions to create the dataset group.

" } }, "kmsKeyArn": { "target": "com.amazonaws.personalize#KmsKeyArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key used to encrypt the datasets.

" } }, "creationDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The creation date and time (in Unix time) of the dataset group.

" } }, "lastUpdatedDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The last update date and time (in Unix time) of the dataset group.

" } }, "failureReason": { "target": "com.amazonaws.personalize#FailureReason", "traits": { "smithy.api#documentation": "

If creating a dataset group fails, provides the reason why.

" } } }, "traits": { "smithy.api#documentation": "

A dataset group is a collection of related datasets (Interactions, User, and Item). You\n create a dataset group by calling CreateDatasetGroup. You then create a\n dataset and add it to a dataset group by calling CreateDataset. The dataset\n group is used to create and train a solution by calling CreateSolution. A\n dataset group can contain only one of each type of dataset.

\n

You can specify an AWS Key Management Service (KMS) key to encrypt the datasets in the group.

" } }, "com.amazonaws.personalize#DatasetGroupSummary": { "type": "structure", "members": { "name": { "target": "com.amazonaws.personalize#Name", "traits": { "smithy.api#documentation": "

The name of the dataset group.

" } }, "datasetGroupArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset group.

" } }, "status": { "target": "com.amazonaws.personalize#Status", "traits": { "smithy.api#documentation": "

The status of the dataset group.

\n

A dataset group can be in one of the following states:

\n " } }, "creationDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The date and time (in Unix time) that the dataset group was created.

" } }, "lastUpdatedDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The date and time (in Unix time) that the dataset group was last updated.

" } }, "failureReason": { "target": "com.amazonaws.personalize#FailureReason", "traits": { "smithy.api#documentation": "

If creating a dataset group fails, the reason behind the failure.

" } } }, "traits": { "smithy.api#documentation": "

Provides a summary of the properties of a dataset group. For a complete listing, call the\n DescribeDatasetGroup API.

" } }, "com.amazonaws.personalize#DatasetGroups": { "type": "list", "member": { "target": "com.amazonaws.personalize#DatasetGroupSummary" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.personalize#DatasetImportJob": { "type": "structure", "members": { "jobName": { "target": "com.amazonaws.personalize#Name", "traits": { "smithy.api#documentation": "

The name of the import job.

" } }, "datasetImportJobArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The ARN of the dataset import job.

" } }, "datasetArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset that receives the imported data.

" } }, "dataSource": { "target": "com.amazonaws.personalize#DataSource", "traits": { "smithy.api#documentation": "

The Amazon S3 bucket that contains the training data to import.

" } }, "roleArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The ARN of the AWS Identity and Access Management (IAM) role that has permissions to read from the Amazon S3 data\n source.

" } }, "status": { "target": "com.amazonaws.personalize#Status", "traits": { "smithy.api#documentation": "

The status of the dataset import job.

\n

A dataset import job can be in one of the following states:

\n " } }, "creationDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The creation date and time (in Unix time) of the dataset import job.

" } }, "lastUpdatedDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The date and time (in Unix time) the dataset was last updated.

" } }, "failureReason": { "target": "com.amazonaws.personalize#FailureReason", "traits": { "smithy.api#documentation": "

If a dataset import job fails, provides the reason why.

" } } }, "traits": { "smithy.api#documentation": "

Describes a job that imports training data from a data source (Amazon S3 bucket) to an\n Amazon Personalize dataset. For more information, see CreateDatasetImportJob.

\n

A dataset import job can be in one of the following states:

\n " } }, "com.amazonaws.personalize#DatasetImportJobSummary": { "type": "structure", "members": { "datasetImportJobArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset import job.

" } }, "jobName": { "target": "com.amazonaws.personalize#Name", "traits": { "smithy.api#documentation": "

The name of the dataset import job.

" } }, "status": { "target": "com.amazonaws.personalize#Status", "traits": { "smithy.api#documentation": "

The status of the dataset import job.

\n

A dataset import job can be in one of the following states:

\n " } }, "creationDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The date and time (in Unix time) that the dataset import job was created.

" } }, "lastUpdatedDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The date and time (in Unix time) that the dataset import job status was last updated.

" } }, "failureReason": { "target": "com.amazonaws.personalize#FailureReason", "traits": { "smithy.api#documentation": "

If a dataset import job fails, the reason behind the failure.

" } } }, "traits": { "smithy.api#documentation": "

Provides a summary of the properties of a dataset import job. For a complete listing, call the\n DescribeDatasetImportJob API.

" } }, "com.amazonaws.personalize#DatasetImportJobs": { "type": "list", "member": { "target": "com.amazonaws.personalize#DatasetImportJobSummary" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.personalize#DatasetSchema": { "type": "structure", "members": { "name": { "target": "com.amazonaws.personalize#Name", "traits": { "smithy.api#documentation": "

The name of the schema.

" } }, "schemaArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the schema.

" } }, "schema": { "target": "com.amazonaws.personalize#AvroSchema", "traits": { "smithy.api#documentation": "

The schema.

" } }, "creationDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The date and time (in Unix time) that the schema was created.

" } }, "lastUpdatedDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The date and time (in Unix time) that the schema was last updated.

" } } }, "traits": { "smithy.api#documentation": "

Describes the schema for a dataset. For more information on schemas, see\n CreateSchema.

" } }, "com.amazonaws.personalize#DatasetSchemaSummary": { "type": "structure", "members": { "name": { "target": "com.amazonaws.personalize#Name", "traits": { "smithy.api#documentation": "

The name of the schema.

" } }, "schemaArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the schema.

" } }, "creationDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The date and time (in Unix time) that the schema was created.

" } }, "lastUpdatedDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The date and time (in Unix time) that the schema was last updated.

" } } }, "traits": { "smithy.api#documentation": "

Provides a summary of the properties of a dataset schema. For a complete listing, call the\n DescribeSchema API.

" } }, "com.amazonaws.personalize#DatasetSummary": { "type": "structure", "members": { "name": { "target": "com.amazonaws.personalize#Name", "traits": { "smithy.api#documentation": "

The name of the dataset.

" } }, "datasetArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" } }, "datasetType": { "target": "com.amazonaws.personalize#DatasetType", "traits": { "smithy.api#documentation": "

The dataset type. One of the following values:

\n " } }, "status": { "target": "com.amazonaws.personalize#Status", "traits": { "smithy.api#documentation": "

The status of the dataset.

\n

A dataset can be in one of the following states:

\n " } }, "creationDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The date and time (in Unix time) that the dataset was created.

" } }, "lastUpdatedDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The date and time (in Unix time) that the dataset was last updated.

" } } }, "traits": { "smithy.api#documentation": "

Provides a summary of the properties of a dataset. For a complete listing, call the\n DescribeDataset API.

" } }, "com.amazonaws.personalize#DatasetType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.personalize#Datasets": { "type": "list", "member": { "target": "com.amazonaws.personalize#DatasetSummary" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.personalize#Date": { "type": "timestamp" }, "com.amazonaws.personalize#DefaultCategoricalHyperParameterRange": { "type": "structure", "members": { "name": { "target": "com.amazonaws.personalize#ParameterName", "traits": { "smithy.api#documentation": "

The name of the hyperparameter.

" } }, "values": { "target": "com.amazonaws.personalize#CategoricalValues", "traits": { "smithy.api#documentation": "

A list of the categories for the hyperparameter.

" } }, "isTunable": { "target": "com.amazonaws.personalize#Tunable", "traits": { "smithy.api#documentation": "

Whether the hyperparameter is tunable.

" } } }, "traits": { "smithy.api#documentation": "

Provides the name and default range of a categorical hyperparameter\n and whether the hyperparameter is tunable. A tunable hyperparameter can\n have its value determined during hyperparameter optimization (HPO).

" } }, "com.amazonaws.personalize#DefaultCategoricalHyperParameterRanges": { "type": "list", "member": { "target": "com.amazonaws.personalize#DefaultCategoricalHyperParameterRange" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.personalize#DefaultContinuousHyperParameterRange": { "type": "structure", "members": { "name": { "target": "com.amazonaws.personalize#ParameterName", "traits": { "smithy.api#documentation": "

The name of the hyperparameter.

" } }, "minValue": { "target": "com.amazonaws.personalize#ContinuousMinValue", "traits": { "smithy.api#documentation": "

The minimum allowable value for the hyperparameter.

" } }, "maxValue": { "target": "com.amazonaws.personalize#ContinuousMaxValue", "traits": { "smithy.api#documentation": "

The maximum allowable value for the hyperparameter.

" } }, "isTunable": { "target": "com.amazonaws.personalize#Tunable", "traits": { "smithy.api#documentation": "

Whether the hyperparameter is tunable.

" } } }, "traits": { "smithy.api#documentation": "

Provides the name and default range of a continuous hyperparameter\n and whether the hyperparameter is tunable. A tunable hyperparameter can\n have its value determined during hyperparameter optimization (HPO).

" } }, "com.amazonaws.personalize#DefaultContinuousHyperParameterRanges": { "type": "list", "member": { "target": "com.amazonaws.personalize#DefaultContinuousHyperParameterRange" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.personalize#DefaultHyperParameterRanges": { "type": "structure", "members": { "integerHyperParameterRanges": { "target": "com.amazonaws.personalize#DefaultIntegerHyperParameterRanges", "traits": { "smithy.api#documentation": "

The integer-valued hyperparameters and their default ranges.

" } }, "continuousHyperParameterRanges": { "target": "com.amazonaws.personalize#DefaultContinuousHyperParameterRanges", "traits": { "smithy.api#documentation": "

The continuous hyperparameters and their default ranges.

" } }, "categoricalHyperParameterRanges": { "target": "com.amazonaws.personalize#DefaultCategoricalHyperParameterRanges", "traits": { "smithy.api#documentation": "

The categorical hyperparameters and their default ranges.

" } } }, "traits": { "smithy.api#documentation": "

Specifies the hyperparameters and their default ranges.\n Hyperparameters can be categorical, continuous, or integer-valued.

" } }, "com.amazonaws.personalize#DefaultIntegerHyperParameterRange": { "type": "structure", "members": { "name": { "target": "com.amazonaws.personalize#ParameterName", "traits": { "smithy.api#documentation": "

The name of the hyperparameter.

" } }, "minValue": { "target": "com.amazonaws.personalize#IntegerMinValue", "traits": { "smithy.api#documentation": "

The minimum allowable value for the hyperparameter.

" } }, "maxValue": { "target": "com.amazonaws.personalize#IntegerMaxValue", "traits": { "smithy.api#documentation": "

The maximum allowable value for the hyperparameter.

" } }, "isTunable": { "target": "com.amazonaws.personalize#Tunable", "traits": { "smithy.api#documentation": "

Indicates whether the hyperparameter is tunable.

" } } }, "traits": { "smithy.api#documentation": "

Provides the name and default range of a integer-valued hyperparameter\n and whether the hyperparameter is tunable. A tunable hyperparameter can\n have its value determined during hyperparameter optimization (HPO).

" } }, "com.amazonaws.personalize#DefaultIntegerHyperParameterRanges": { "type": "list", "member": { "target": "com.amazonaws.personalize#DefaultIntegerHyperParameterRange" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.personalize#DeleteCampaign": { "type": "operation", "input": { "target": "com.amazonaws.personalize#DeleteCampaignRequest" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#ResourceInUseException" }, { "target": "com.amazonaws.personalize#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Removes a campaign by deleting the solution deployment. The solution that\n the campaign is based on is not deleted and can be redeployed when needed. A deleted campaign can no\n longer be specified in a\n GetRecommendations\n request.\n For more information on campaigns, see CreateCampaign.

", "smithy.api#idempotent": {} } }, "com.amazonaws.personalize#DeleteCampaignRequest": { "type": "structure", "members": { "campaignArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the campaign to delete.

", "smithy.api#required": {} } } } }, "com.amazonaws.personalize#DeleteDataset": { "type": "operation", "input": { "target": "com.amazonaws.personalize#DeleteDatasetRequest" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#ResourceInUseException" }, { "target": "com.amazonaws.personalize#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Deletes a dataset. You can't delete a dataset if an associated\n DatasetImportJob or SolutionVersion is in the CREATE PENDING or IN\n PROGRESS state. For more information on datasets, see CreateDataset.

", "smithy.api#idempotent": {} } }, "com.amazonaws.personalize#DeleteDatasetGroup": { "type": "operation", "input": { "target": "com.amazonaws.personalize#DeleteDatasetGroupRequest" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#ResourceInUseException" }, { "target": "com.amazonaws.personalize#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Deletes a dataset group. Before you delete a dataset group, you must delete the\n following:

\n ", "smithy.api#idempotent": {} } }, "com.amazonaws.personalize#DeleteDatasetGroupRequest": { "type": "structure", "members": { "datasetGroupArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The ARN of the dataset group to delete.

", "smithy.api#required": {} } } } }, "com.amazonaws.personalize#DeleteDatasetRequest": { "type": "structure", "members": { "datasetArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset to delete.

", "smithy.api#required": {} } } } }, "com.amazonaws.personalize#DeleteEventTracker": { "type": "operation", "input": { "target": "com.amazonaws.personalize#DeleteEventTrackerRequest" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#ResourceInUseException" }, { "target": "com.amazonaws.personalize#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Deletes the event tracker. Does not delete the event-interactions dataset from\n the associated dataset group. For more\n information on event trackers, see CreateEventTracker.

", "smithy.api#idempotent": {} } }, "com.amazonaws.personalize#DeleteEventTrackerRequest": { "type": "structure", "members": { "eventTrackerArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the event tracker to delete.

", "smithy.api#required": {} } } } }, "com.amazonaws.personalize#DeleteFilter": { "type": "operation", "input": { "target": "com.amazonaws.personalize#DeleteFilterRequest" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#ResourceInUseException" }, { "target": "com.amazonaws.personalize#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Deletes a filter.

" } }, "com.amazonaws.personalize#DeleteFilterRequest": { "type": "structure", "members": { "filterArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The ARN of the filter to delete.

", "smithy.api#required": {} } } } }, "com.amazonaws.personalize#DeleteSchema": { "type": "operation", "input": { "target": "com.amazonaws.personalize#DeleteSchemaRequest" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#ResourceInUseException" }, { "target": "com.amazonaws.personalize#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Deletes a schema. Before deleting a schema, you must delete all\n datasets referencing the schema. For more information on schemas, see\n CreateSchema.

", "smithy.api#idempotent": {} } }, "com.amazonaws.personalize#DeleteSchemaRequest": { "type": "structure", "members": { "schemaArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the schema to delete.

", "smithy.api#required": {} } } } }, "com.amazonaws.personalize#DeleteSolution": { "type": "operation", "input": { "target": "com.amazonaws.personalize#DeleteSolutionRequest" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#ResourceInUseException" }, { "target": "com.amazonaws.personalize#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Deletes all versions of a solution and the Solution object itself.\n Before deleting a solution, you must delete all campaigns based on\n the solution. To determine what campaigns are using the solution, call\n ListCampaigns and supply the Amazon Resource Name (ARN) of the solution.\n You can't delete a solution if an associated SolutionVersion is in the\n CREATE PENDING or IN PROGRESS state.\n For more information on solutions, see CreateSolution.

", "smithy.api#idempotent": {} } }, "com.amazonaws.personalize#DeleteSolutionRequest": { "type": "structure", "members": { "solutionArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The ARN of the solution to delete.

", "smithy.api#required": {} } } } }, "com.amazonaws.personalize#DescribeAlgorithm": { "type": "operation", "input": { "target": "com.amazonaws.personalize#DescribeAlgorithmRequest" }, "output": { "target": "com.amazonaws.personalize#DescribeAlgorithmResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Describes the given algorithm.

", "smithy.api#idempotent": {} } }, "com.amazonaws.personalize#DescribeAlgorithmRequest": { "type": "structure", "members": { "algorithmArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the algorithm to describe.

", "smithy.api#required": {} } } } }, "com.amazonaws.personalize#DescribeAlgorithmResponse": { "type": "structure", "members": { "algorithm": { "target": "com.amazonaws.personalize#Algorithm", "traits": { "smithy.api#documentation": "

A listing of the properties of the algorithm.

" } } } }, "com.amazonaws.personalize#DescribeBatchInferenceJob": { "type": "operation", "input": { "target": "com.amazonaws.personalize#DescribeBatchInferenceJobRequest" }, "output": { "target": "com.amazonaws.personalize#DescribeBatchInferenceJobResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Gets the properties of a batch inference job including name, Amazon Resource Name (ARN),\n status, input and output configurations, and the ARN of the solution version used to generate\n the recommendations.

", "smithy.api#idempotent": {} } }, "com.amazonaws.personalize#DescribeBatchInferenceJobRequest": { "type": "structure", "members": { "batchInferenceJobArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The ARN of the batch inference job to describe.

", "smithy.api#required": {} } } } }, "com.amazonaws.personalize#DescribeBatchInferenceJobResponse": { "type": "structure", "members": { "batchInferenceJob": { "target": "com.amazonaws.personalize#BatchInferenceJob", "traits": { "smithy.api#documentation": "

Information on the specified batch inference job.

" } } } }, "com.amazonaws.personalize#DescribeCampaign": { "type": "operation", "input": { "target": "com.amazonaws.personalize#DescribeCampaignRequest" }, "output": { "target": "com.amazonaws.personalize#DescribeCampaignResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Describes the given campaign, including its status.

\n

A campaign can be in one of the following states:

\n \n

When the status is CREATE FAILED, the response includes the\n failureReason key, which describes why.

\n

For more information on campaigns, see CreateCampaign.

", "smithy.api#idempotent": {} } }, "com.amazonaws.personalize#DescribeCampaignRequest": { "type": "structure", "members": { "campaignArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the campaign.

", "smithy.api#required": {} } } } }, "com.amazonaws.personalize#DescribeCampaignResponse": { "type": "structure", "members": { "campaign": { "target": "com.amazonaws.personalize#Campaign", "traits": { "smithy.api#documentation": "

The properties of the campaign.

" } } } }, "com.amazonaws.personalize#DescribeDataset": { "type": "operation", "input": { "target": "com.amazonaws.personalize#DescribeDatasetRequest" }, "output": { "target": "com.amazonaws.personalize#DescribeDatasetResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Describes the given dataset. For more information on datasets, see CreateDataset.

", "smithy.api#idempotent": {} } }, "com.amazonaws.personalize#DescribeDatasetExportJob": { "type": "operation", "input": { "target": "com.amazonaws.personalize#DescribeDatasetExportJobRequest" }, "output": { "target": "com.amazonaws.personalize#DescribeDatasetExportJobResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Describes the dataset export job created by CreateDatasetExportJob,\n including the export job status.

", "smithy.api#idempotent": {} } }, "com.amazonaws.personalize#DescribeDatasetExportJobRequest": { "type": "structure", "members": { "datasetExportJobArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset export job to describe.

", "smithy.api#required": {} } } } }, "com.amazonaws.personalize#DescribeDatasetExportJobResponse": { "type": "structure", "members": { "datasetExportJob": { "target": "com.amazonaws.personalize#DatasetExportJob", "traits": { "smithy.api#documentation": "

Information about the dataset export job, including the status.

\n

The status is one of the following values:

\n " } } } }, "com.amazonaws.personalize#DescribeDatasetGroup": { "type": "operation", "input": { "target": "com.amazonaws.personalize#DescribeDatasetGroupRequest" }, "output": { "target": "com.amazonaws.personalize#DescribeDatasetGroupResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.

", "smithy.api#idempotent": {} } }, "com.amazonaws.personalize#DescribeDatasetGroupRequest": { "type": "structure", "members": { "datasetGroupArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset group to describe.

", "smithy.api#required": {} } } } }, "com.amazonaws.personalize#DescribeDatasetGroupResponse": { "type": "structure", "members": { "datasetGroup": { "target": "com.amazonaws.personalize#DatasetGroup", "traits": { "smithy.api#documentation": "

A listing of the dataset group's properties.

" } } } }, "com.amazonaws.personalize#DescribeDatasetImportJob": { "type": "operation", "input": { "target": "com.amazonaws.personalize#DescribeDatasetImportJobRequest" }, "output": { "target": "com.amazonaws.personalize#DescribeDatasetImportJobResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Describes the dataset import job created by CreateDatasetImportJob,\n including the import job status.

", "smithy.api#idempotent": {} } }, "com.amazonaws.personalize#DescribeDatasetImportJobRequest": { "type": "structure", "members": { "datasetImportJobArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset import job to describe.

", "smithy.api#required": {} } } } }, "com.amazonaws.personalize#DescribeDatasetImportJobResponse": { "type": "structure", "members": { "datasetImportJob": { "target": "com.amazonaws.personalize#DatasetImportJob", "traits": { "smithy.api#documentation": "

Information about the dataset import job, including the status.

\n

The status is one of the following values:

\n " } } } }, "com.amazonaws.personalize#DescribeDatasetRequest": { "type": "structure", "members": { "datasetArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset to describe.

", "smithy.api#required": {} } } } }, "com.amazonaws.personalize#DescribeDatasetResponse": { "type": "structure", "members": { "dataset": { "target": "com.amazonaws.personalize#Dataset", "traits": { "smithy.api#documentation": "

A listing of the dataset's properties.

" } } } }, "com.amazonaws.personalize#DescribeEventTracker": { "type": "operation", "input": { "target": "com.amazonaws.personalize#DescribeEventTrackerRequest" }, "output": { "target": "com.amazonaws.personalize#DescribeEventTrackerResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Describes an event tracker. The response includes the trackingId and\n status of the event tracker.\n For more information on event trackers, see CreateEventTracker.

", "smithy.api#idempotent": {} } }, "com.amazonaws.personalize#DescribeEventTrackerRequest": { "type": "structure", "members": { "eventTrackerArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the event tracker to describe.

", "smithy.api#required": {} } } } }, "com.amazonaws.personalize#DescribeEventTrackerResponse": { "type": "structure", "members": { "eventTracker": { "target": "com.amazonaws.personalize#EventTracker", "traits": { "smithy.api#documentation": "

An object that describes the event tracker.

" } } } }, "com.amazonaws.personalize#DescribeFeatureTransformation": { "type": "operation", "input": { "target": "com.amazonaws.personalize#DescribeFeatureTransformationRequest" }, "output": { "target": "com.amazonaws.personalize#DescribeFeatureTransformationResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Describes the given feature transformation.

", "smithy.api#idempotent": {} } }, "com.amazonaws.personalize#DescribeFeatureTransformationRequest": { "type": "structure", "members": { "featureTransformationArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the feature transformation to describe.

", "smithy.api#required": {} } } } }, "com.amazonaws.personalize#DescribeFeatureTransformationResponse": { "type": "structure", "members": { "featureTransformation": { "target": "com.amazonaws.personalize#FeatureTransformation", "traits": { "smithy.api#documentation": "

A listing of the FeatureTransformation properties.

" } } } }, "com.amazonaws.personalize#DescribeFilter": { "type": "operation", "input": { "target": "com.amazonaws.personalize#DescribeFilterRequest" }, "output": { "target": "com.amazonaws.personalize#DescribeFilterResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Describes a filter's properties.

", "smithy.api#idempotent": {} } }, "com.amazonaws.personalize#DescribeFilterRequest": { "type": "structure", "members": { "filterArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The ARN of the filter to describe.

", "smithy.api#required": {} } } } }, "com.amazonaws.personalize#DescribeFilterResponse": { "type": "structure", "members": { "filter": { "target": "com.amazonaws.personalize#Filter", "traits": { "smithy.api#documentation": "

The filter's details.

" } } } }, "com.amazonaws.personalize#DescribeRecipe": { "type": "operation", "input": { "target": "com.amazonaws.personalize#DescribeRecipeRequest" }, "output": { "target": "com.amazonaws.personalize#DescribeRecipeResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Describes a recipe.

\n

A recipe contains three items:

\n \n

Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a\n solution with the CreateSolution API.\n CreateSolution trains a model by using the algorithm\n in the specified recipe and a training dataset. The solution, when deployed as a campaign,\n can provide recommendations using the\n GetRecommendations API.

", "smithy.api#idempotent": {} } }, "com.amazonaws.personalize#DescribeRecipeRequest": { "type": "structure", "members": { "recipeArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recipe to describe.

", "smithy.api#required": {} } } } }, "com.amazonaws.personalize#DescribeRecipeResponse": { "type": "structure", "members": { "recipe": { "target": "com.amazonaws.personalize#Recipe", "traits": { "smithy.api#documentation": "

An object that describes the recipe.

" } } } }, "com.amazonaws.personalize#DescribeSchema": { "type": "operation", "input": { "target": "com.amazonaws.personalize#DescribeSchemaRequest" }, "output": { "target": "com.amazonaws.personalize#DescribeSchemaResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Describes a schema. For more information on schemas, see\n CreateSchema.

", "smithy.api#idempotent": {} } }, "com.amazonaws.personalize#DescribeSchemaRequest": { "type": "structure", "members": { "schemaArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the schema to retrieve.

", "smithy.api#required": {} } } } }, "com.amazonaws.personalize#DescribeSchemaResponse": { "type": "structure", "members": { "schema": { "target": "com.amazonaws.personalize#DatasetSchema", "traits": { "smithy.api#documentation": "

The requested schema.

" } } } }, "com.amazonaws.personalize#DescribeSolution": { "type": "operation", "input": { "target": "com.amazonaws.personalize#DescribeSolutionRequest" }, "output": { "target": "com.amazonaws.personalize#DescribeSolutionResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Describes a solution.\n For more information on solutions, see CreateSolution.

", "smithy.api#idempotent": {} } }, "com.amazonaws.personalize#DescribeSolutionRequest": { "type": "structure", "members": { "solutionArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the solution to describe.

", "smithy.api#required": {} } } } }, "com.amazonaws.personalize#DescribeSolutionResponse": { "type": "structure", "members": { "solution": { "target": "com.amazonaws.personalize#Solution", "traits": { "smithy.api#documentation": "

An object that describes the solution.

" } } } }, "com.amazonaws.personalize#DescribeSolutionVersion": { "type": "operation", "input": { "target": "com.amazonaws.personalize#DescribeSolutionVersionRequest" }, "output": { "target": "com.amazonaws.personalize#DescribeSolutionVersionResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Describes a specific version of a solution. For more information on solutions, see CreateSolution.

", "smithy.api#idempotent": {} } }, "com.amazonaws.personalize#DescribeSolutionVersionRequest": { "type": "structure", "members": { "solutionVersionArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the solution version.

", "smithy.api#required": {} } } } }, "com.amazonaws.personalize#DescribeSolutionVersionResponse": { "type": "structure", "members": { "solutionVersion": { "target": "com.amazonaws.personalize#SolutionVersion", "traits": { "smithy.api#documentation": "

The solution version.

" } } } }, "com.amazonaws.personalize#Description": { "type": "string" }, "com.amazonaws.personalize#DockerURI": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.personalize#ErrorMessage": { "type": "string" }, "com.amazonaws.personalize#EventTracker": { "type": "structure", "members": { "name": { "target": "com.amazonaws.personalize#Name", "traits": { "smithy.api#documentation": "

The name of the event tracker.

" } }, "eventTrackerArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The ARN of the event tracker.

" } }, "accountId": { "target": "com.amazonaws.personalize#AccountId", "traits": { "smithy.api#documentation": "

The Amazon AWS account that owns the event tracker.

" } }, "trackingId": { "target": "com.amazonaws.personalize#TrackingId", "traits": { "smithy.api#documentation": "

The ID of the event tracker. Include this ID in requests to the\n PutEvents API.

" } }, "datasetGroupArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset group that receives the event data.

" } }, "status": { "target": "com.amazonaws.personalize#Status", "traits": { "smithy.api#documentation": "

The status of the event tracker.

\n

An event tracker can be in one of the following states:

\n " } }, "creationDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The date and time (in Unix format) that the event tracker was created.

" } }, "lastUpdatedDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The date and time (in Unix time) that the event tracker was last updated.

" } } }, "traits": { "smithy.api#documentation": "

Provides information about an event tracker.

" } }, "com.amazonaws.personalize#EventTrackerSummary": { "type": "structure", "members": { "name": { "target": "com.amazonaws.personalize#Name", "traits": { "smithy.api#documentation": "

The name of the event tracker.

" } }, "eventTrackerArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the event tracker.

" } }, "status": { "target": "com.amazonaws.personalize#Status", "traits": { "smithy.api#documentation": "

The status of the event tracker.

\n

An event tracker can be in one of the following states:

\n " } }, "creationDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The date and time (in Unix time) that the event tracker was created.

" } }, "lastUpdatedDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The date and time (in Unix time) that the event tracker was last updated.

" } } }, "traits": { "smithy.api#documentation": "

Provides a summary of the properties of an event tracker. For a complete listing, call the\n DescribeEventTracker API.

" } }, "com.amazonaws.personalize#EventTrackers": { "type": "list", "member": { "target": "com.amazonaws.personalize#EventTrackerSummary" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.personalize#EventType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.personalize#EventValueThreshold": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.personalize#FailureReason": { "type": "string" }, "com.amazonaws.personalize#FeatureTransformation": { "type": "structure", "members": { "name": { "target": "com.amazonaws.personalize#Name", "traits": { "smithy.api#documentation": "

The name of the feature transformation.

" } }, "featureTransformationArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the FeatureTransformation object.

" } }, "defaultParameters": { "target": "com.amazonaws.personalize#FeaturizationParameters", "traits": { "smithy.api#documentation": "

Provides the default parameters for feature transformation.

" } }, "creationDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The creation date and time (in Unix time) of the feature transformation.

" } }, "lastUpdatedDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The last update date and time (in Unix time) of the feature transformation.

" } }, "status": { "target": "com.amazonaws.personalize#Status", "traits": { "smithy.api#documentation": "

The status of the feature transformation.

\n

A feature transformation can be in one of the following states:

\n " } } }, "traits": { "smithy.api#documentation": "

Provides feature transformation information. Feature transformation is the process\n of modifying raw input data into a form more suitable for model training.

" } }, "com.amazonaws.personalize#FeatureTransformationParameters": { "type": "map", "key": { "target": "com.amazonaws.personalize#ParameterName" }, "value": { "target": "com.amazonaws.personalize#ParameterValue" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.personalize#FeaturizationParameters": { "type": "map", "key": { "target": "com.amazonaws.personalize#ParameterName" }, "value": { "target": "com.amazonaws.personalize#ParameterValue" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.personalize#Filter": { "type": "structure", "members": { "name": { "target": "com.amazonaws.personalize#Name", "traits": { "smithy.api#documentation": "

The name of the filter.

" } }, "filterArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The ARN of the filter.

" } }, "creationDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The time at which the filter was created.

" } }, "lastUpdatedDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The time at which the filter was last updated.

" } }, "datasetGroupArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The ARN of the dataset group to which the filter belongs.

" } }, "failureReason": { "target": "com.amazonaws.personalize#FailureReason", "traits": { "smithy.api#documentation": "

If the filter failed, the reason for its failure.

" } }, "filterExpression": { "target": "com.amazonaws.personalize#FilterExpression", "traits": { "smithy.api#documentation": "

Specifies the type of item interactions to filter out of recommendation results. The\n filter expression must follow specific format rules. For information about filter expression structure and syntax, see\n filter-expressions.

" } }, "status": { "target": "com.amazonaws.personalize#Status", "traits": { "smithy.api#documentation": "

The status of the filter.

" } } }, "traits": { "smithy.api#documentation": "

Contains information on a recommendation filter, including its ARN, status, and filter\n expression.

" } }, "com.amazonaws.personalize#FilterExpression": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2500 }, "smithy.api#sensitive": {} } }, "com.amazonaws.personalize#FilterSummary": { "type": "structure", "members": { "name": { "target": "com.amazonaws.personalize#Name", "traits": { "smithy.api#documentation": "

The name of the filter.

" } }, "filterArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The ARN of the filter.

" } }, "creationDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The time at which the filter was created.

" } }, "lastUpdatedDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The time at which the filter was last updated.

" } }, "datasetGroupArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The ARN of the dataset group to which the filter belongs.

" } }, "failureReason": { "target": "com.amazonaws.personalize#FailureReason", "traits": { "smithy.api#documentation": "

If the filter failed, the reason for the failure.

" } }, "status": { "target": "com.amazonaws.personalize#Status", "traits": { "smithy.api#documentation": "

The status of the filter.

" } } }, "traits": { "smithy.api#documentation": "

A short summary of a filter's attributes.

" } }, "com.amazonaws.personalize#Filters": { "type": "list", "member": { "target": "com.amazonaws.personalize#FilterSummary" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.personalize#GetSolutionMetrics": { "type": "operation", "input": { "target": "com.amazonaws.personalize#GetSolutionMetricsRequest" }, "output": { "target": "com.amazonaws.personalize#GetSolutionMetricsResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#ResourceInUseException" }, { "target": "com.amazonaws.personalize#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Gets the metrics for the specified solution version.

" } }, "com.amazonaws.personalize#GetSolutionMetricsRequest": { "type": "structure", "members": { "solutionVersionArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the solution version for which to get metrics.

", "smithy.api#required": {} } } } }, "com.amazonaws.personalize#GetSolutionMetricsResponse": { "type": "structure", "members": { "solutionVersionArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The same solution version ARN as specified in the request.

" } }, "metrics": { "target": "com.amazonaws.personalize#Metrics", "traits": { "smithy.api#documentation": "

The metrics for the solution version.

" } } } }, "com.amazonaws.personalize#HPOConfig": { "type": "structure", "members": { "hpoObjective": { "target": "com.amazonaws.personalize#HPOObjective", "traits": { "smithy.api#documentation": "

The metric to optimize during HPO.

\n \n

Amazon Personalize doesn't support configuring the hpoObjective \n at this time.

\n " } }, "hpoResourceConfig": { "target": "com.amazonaws.personalize#HPOResourceConfig", "traits": { "smithy.api#documentation": "

Describes the resource configuration for HPO.

" } }, "algorithmHyperParameterRanges": { "target": "com.amazonaws.personalize#HyperParameterRanges", "traits": { "smithy.api#documentation": "

The hyperparameters and their allowable ranges.

" } } }, "traits": { "smithy.api#documentation": "

Describes the properties for hyperparameter optimization (HPO).

" } }, "com.amazonaws.personalize#HPOObjective": { "type": "structure", "members": { "type": { "target": "com.amazonaws.personalize#HPOObjectiveType", "traits": { "smithy.api#documentation": "

The type of the metric. Valid values are Maximize and Minimize.

" } }, "metricName": { "target": "com.amazonaws.personalize#MetricName", "traits": { "smithy.api#documentation": "

The name of the metric.

" } }, "metricRegex": { "target": "com.amazonaws.personalize#MetricRegex", "traits": { "smithy.api#documentation": "

A regular expression for finding the metric in the training job logs.

" } } }, "traits": { "smithy.api#documentation": "

The metric to optimize during hyperparameter optimization (HPO).

\n \n

Amazon Personalize doesn't support configuring the hpoObjective \n at this time.

\n " } }, "com.amazonaws.personalize#HPOObjectiveType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.personalize#HPOResource": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.personalize#HPOResourceConfig": { "type": "structure", "members": { "maxNumberOfTrainingJobs": { "target": "com.amazonaws.personalize#HPOResource", "traits": { "smithy.api#documentation": "

The maximum number of training\n jobs when you create a\n solution\n version.\n The maximum value for maxNumberOfTrainingJobs is\n 40.

" } }, "maxParallelTrainingJobs": { "target": "com.amazonaws.personalize#HPOResource", "traits": { "smithy.api#documentation": "

The maximum number of parallel training\n jobs when you create a\n solution\n version.\n The maximum value for maxParallelTrainingJobs is\n 10.

" } } }, "traits": { "smithy.api#documentation": "

Describes the resource configuration for hyperparameter optimization (HPO).

" } }, "com.amazonaws.personalize#HyperParameterRanges": { "type": "structure", "members": { "integerHyperParameterRanges": { "target": "com.amazonaws.personalize#IntegerHyperParameterRanges", "traits": { "smithy.api#documentation": "

The integer-valued hyperparameters and their ranges.

" } }, "continuousHyperParameterRanges": { "target": "com.amazonaws.personalize#ContinuousHyperParameterRanges", "traits": { "smithy.api#documentation": "

The continuous hyperparameters and their ranges.

" } }, "categoricalHyperParameterRanges": { "target": "com.amazonaws.personalize#CategoricalHyperParameterRanges", "traits": { "smithy.api#documentation": "

The categorical hyperparameters and their ranges.

" } } }, "traits": { "smithy.api#documentation": "

Specifies the hyperparameters and their ranges.\n Hyperparameters can be categorical, continuous, or integer-valued.

" } }, "com.amazonaws.personalize#HyperParameters": { "type": "map", "key": { "target": "com.amazonaws.personalize#ParameterName" }, "value": { "target": "com.amazonaws.personalize#ParameterValue" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.personalize#IngestionMode": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "BULK", "name": "BULK" }, { "value": "PUT", "name": "PUT" }, { "value": "ALL", "name": "ALL" } ] } }, "com.amazonaws.personalize#IntegerHyperParameterRange": { "type": "structure", "members": { "name": { "target": "com.amazonaws.personalize#ParameterName", "traits": { "smithy.api#documentation": "

The name of the hyperparameter.

" } }, "minValue": { "target": "com.amazonaws.personalize#IntegerMinValue", "traits": { "smithy.api#documentation": "

The minimum allowable value for the hyperparameter.

" } }, "maxValue": { "target": "com.amazonaws.personalize#IntegerMaxValue", "traits": { "smithy.api#documentation": "

The maximum allowable value for the hyperparameter.

" } } }, "traits": { "smithy.api#documentation": "

Provides the name and range of an integer-valued hyperparameter.

" } }, "com.amazonaws.personalize#IntegerHyperParameterRanges": { "type": "list", "member": { "target": "com.amazonaws.personalize#IntegerHyperParameterRange" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.personalize#IntegerMaxValue": { "type": "integer", "traits": { "smithy.api#range": { "max": 1000000 } } }, "com.amazonaws.personalize#IntegerMinValue": { "type": "integer", "traits": { "smithy.api#range": { "min": -1000000 } } }, "com.amazonaws.personalize#InvalidInputException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.personalize#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

Provide a valid value for the field or parameter.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.personalize#InvalidNextTokenException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.personalize#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

The token is not valid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.personalize#ItemAttribute": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 150 } } }, "com.amazonaws.personalize#KmsKeyArn": { "type": "string" }, "com.amazonaws.personalize#LimitExceededException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.personalize#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

The limit on the number of requests per second has been exceeded.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.personalize#ListBatchInferenceJobs": { "type": "operation", "input": { "target": "com.amazonaws.personalize#ListBatchInferenceJobsRequest" }, "output": { "target": "com.amazonaws.personalize#ListBatchInferenceJobsResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#InvalidNextTokenException" } ], "traits": { "smithy.api#documentation": "

Gets a list of the batch inference jobs that have been performed off of a solution\n version.

", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "batchInferenceJobs", "pageSize": "maxResults" } } }, "com.amazonaws.personalize#ListBatchInferenceJobsRequest": { "type": "structure", "members": { "solutionVersionArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the solution version from which the batch inference jobs\n were created.

" } }, "nextToken": { "target": "com.amazonaws.personalize#NextToken", "traits": { "smithy.api#documentation": "

The token to request the next page of results.

" } }, "maxResults": { "target": "com.amazonaws.personalize#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of batch inference job results to return in each page. The default\n value is 100.

" } } } }, "com.amazonaws.personalize#ListBatchInferenceJobsResponse": { "type": "structure", "members": { "batchInferenceJobs": { "target": "com.amazonaws.personalize#BatchInferenceJobs", "traits": { "smithy.api#documentation": "

A list containing information on each job that is returned.

" } }, "nextToken": { "target": "com.amazonaws.personalize#NextToken", "traits": { "smithy.api#documentation": "

The token to use to retrieve the next page of results. The value is null when\n there are no more results to return.

" } } } }, "com.amazonaws.personalize#ListCampaigns": { "type": "operation", "input": { "target": "com.amazonaws.personalize#ListCampaignsRequest" }, "output": { "target": "com.amazonaws.personalize#ListCampaignsResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#InvalidNextTokenException" } ], "traits": { "smithy.api#documentation": "

Returns a list of campaigns that use the given solution.\n When a solution is not specified, all the campaigns associated with the account are listed.\n The response provides the properties for each campaign, including the Amazon Resource Name (ARN).\n For more information on campaigns, see CreateCampaign.

", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "campaigns", "pageSize": "maxResults" } } }, "com.amazonaws.personalize#ListCampaignsRequest": { "type": "structure", "members": { "solutionArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the solution to list the campaigns for. When\n a solution is not specified, all the campaigns associated with the account are listed.

" } }, "nextToken": { "target": "com.amazonaws.personalize#NextToken", "traits": { "smithy.api#documentation": "

A token returned from the previous call to ListCampaigns for getting\n the next set of campaigns (if they exist).

" } }, "maxResults": { "target": "com.amazonaws.personalize#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of campaigns to return.

" } } } }, "com.amazonaws.personalize#ListCampaignsResponse": { "type": "structure", "members": { "campaigns": { "target": "com.amazonaws.personalize#Campaigns", "traits": { "smithy.api#documentation": "

A list of the campaigns.

" } }, "nextToken": { "target": "com.amazonaws.personalize#NextToken", "traits": { "smithy.api#documentation": "

A token for getting the next set of campaigns (if they exist).

" } } } }, "com.amazonaws.personalize#ListDatasetExportJobs": { "type": "operation", "input": { "target": "com.amazonaws.personalize#ListDatasetExportJobsRequest" }, "output": { "target": "com.amazonaws.personalize#ListDatasetExportJobsResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#InvalidNextTokenException" } ], "traits": { "smithy.api#documentation": "

Returns a list of dataset export jobs that use the given dataset. When a dataset is not\n specified, all the dataset export jobs associated with the account are listed. The response\n provides the properties for each dataset export job, including the Amazon Resource Name (ARN).\n For more information on dataset export jobs, see CreateDatasetExportJob. For\n more information on datasets, see CreateDataset.

", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "datasetExportJobs", "pageSize": "maxResults" } } }, "com.amazonaws.personalize#ListDatasetExportJobsRequest": { "type": "structure", "members": { "datasetArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset to list the dataset export jobs for.

" } }, "nextToken": { "target": "com.amazonaws.personalize#NextToken", "traits": { "smithy.api#documentation": "

A token returned from the previous call to ListDatasetExportJobs for getting\n the next set of dataset export jobs (if they exist).

" } }, "maxResults": { "target": "com.amazonaws.personalize#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of dataset export jobs to return.

" } } } }, "com.amazonaws.personalize#ListDatasetExportJobsResponse": { "type": "structure", "members": { "datasetExportJobs": { "target": "com.amazonaws.personalize#DatasetExportJobs", "traits": { "smithy.api#documentation": "

The list of dataset export jobs.

" } }, "nextToken": { "target": "com.amazonaws.personalize#NextToken", "traits": { "smithy.api#documentation": "

A token for getting the next set of dataset export jobs (if they exist).

" } } } }, "com.amazonaws.personalize#ListDatasetGroups": { "type": "operation", "input": { "target": "com.amazonaws.personalize#ListDatasetGroupsRequest" }, "output": { "target": "com.amazonaws.personalize#ListDatasetGroupsResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidNextTokenException" } ], "traits": { "smithy.api#documentation": "

Returns a list of dataset groups. The response provides the properties for each dataset\n group, including the Amazon Resource Name (ARN). For more information on dataset groups, see\n CreateDatasetGroup.

", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "datasetGroups", "pageSize": "maxResults" } } }, "com.amazonaws.personalize#ListDatasetGroupsRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.personalize#NextToken", "traits": { "smithy.api#documentation": "

A token returned from the previous call to ListDatasetGroups for getting the\n next set of dataset groups (if they exist).

" } }, "maxResults": { "target": "com.amazonaws.personalize#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of dataset groups to return.

" } } } }, "com.amazonaws.personalize#ListDatasetGroupsResponse": { "type": "structure", "members": { "datasetGroups": { "target": "com.amazonaws.personalize#DatasetGroups", "traits": { "smithy.api#documentation": "

The list of your dataset groups.

" } }, "nextToken": { "target": "com.amazonaws.personalize#NextToken", "traits": { "smithy.api#documentation": "

A token for getting the next set of dataset groups (if they exist).

" } } } }, "com.amazonaws.personalize#ListDatasetImportJobs": { "type": "operation", "input": { "target": "com.amazonaws.personalize#ListDatasetImportJobsRequest" }, "output": { "target": "com.amazonaws.personalize#ListDatasetImportJobsResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#InvalidNextTokenException" } ], "traits": { "smithy.api#documentation": "

Returns a list of dataset import jobs that use the given dataset. When a dataset is not\n specified, all the dataset import jobs associated with the account are listed. The response\n provides the properties for each dataset import job, including the Amazon Resource Name (ARN).\n For more information on dataset import jobs, see CreateDatasetImportJob. For\n more information on datasets, see CreateDataset.

", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "datasetImportJobs", "pageSize": "maxResults" } } }, "com.amazonaws.personalize#ListDatasetImportJobsRequest": { "type": "structure", "members": { "datasetArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset to list the dataset import jobs for.

" } }, "nextToken": { "target": "com.amazonaws.personalize#NextToken", "traits": { "smithy.api#documentation": "

A token returned from the previous call to ListDatasetImportJobs for getting\n the next set of dataset import jobs (if they exist).

" } }, "maxResults": { "target": "com.amazonaws.personalize#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of dataset import jobs to return.

" } } } }, "com.amazonaws.personalize#ListDatasetImportJobsResponse": { "type": "structure", "members": { "datasetImportJobs": { "target": "com.amazonaws.personalize#DatasetImportJobs", "traits": { "smithy.api#documentation": "

The list of dataset import jobs.

" } }, "nextToken": { "target": "com.amazonaws.personalize#NextToken", "traits": { "smithy.api#documentation": "

A token for getting the next set of dataset import jobs (if they exist).

" } } } }, "com.amazonaws.personalize#ListDatasets": { "type": "operation", "input": { "target": "com.amazonaws.personalize#ListDatasetsRequest" }, "output": { "target": "com.amazonaws.personalize#ListDatasetsResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#InvalidNextTokenException" } ], "traits": { "smithy.api#documentation": "

Returns the list of datasets contained in the given dataset group. The response provides\n the properties for each dataset, including the Amazon Resource Name (ARN). For more\n information on datasets, see CreateDataset.

", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "datasets", "pageSize": "maxResults" } } }, "com.amazonaws.personalize#ListDatasetsRequest": { "type": "structure", "members": { "datasetGroupArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset group that contains the datasets to\n list.

" } }, "nextToken": { "target": "com.amazonaws.personalize#NextToken", "traits": { "smithy.api#documentation": "

A token returned from the previous call to ListDatasetImportJobs for getting\n the next set of dataset import jobs (if they exist).

" } }, "maxResults": { "target": "com.amazonaws.personalize#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of datasets to return.

" } } } }, "com.amazonaws.personalize#ListDatasetsResponse": { "type": "structure", "members": { "datasets": { "target": "com.amazonaws.personalize#Datasets", "traits": { "smithy.api#documentation": "

An array of Dataset objects. Each object provides metadata\n information.

" } }, "nextToken": { "target": "com.amazonaws.personalize#NextToken", "traits": { "smithy.api#documentation": "

A token for getting the next set of datasets (if they exist).

" } } } }, "com.amazonaws.personalize#ListEventTrackers": { "type": "operation", "input": { "target": "com.amazonaws.personalize#ListEventTrackersRequest" }, "output": { "target": "com.amazonaws.personalize#ListEventTrackersResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#InvalidNextTokenException" } ], "traits": { "smithy.api#documentation": "

Returns the list of event trackers associated with the account.\n The response provides the properties for each event tracker, including the Amazon Resource\n Name (ARN) and tracking ID. For more\n information on event trackers, see CreateEventTracker.

", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "eventTrackers", "pageSize": "maxResults" } } }, "com.amazonaws.personalize#ListEventTrackersRequest": { "type": "structure", "members": { "datasetGroupArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The ARN of a dataset group used to filter the response.

" } }, "nextToken": { "target": "com.amazonaws.personalize#NextToken", "traits": { "smithy.api#documentation": "

A token returned from the previous call to ListEventTrackers for getting\n the next set of event trackers (if they exist).

" } }, "maxResults": { "target": "com.amazonaws.personalize#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of event trackers to return.

" } } } }, "com.amazonaws.personalize#ListEventTrackersResponse": { "type": "structure", "members": { "eventTrackers": { "target": "com.amazonaws.personalize#EventTrackers", "traits": { "smithy.api#documentation": "

A list of event trackers.

" } }, "nextToken": { "target": "com.amazonaws.personalize#NextToken", "traits": { "smithy.api#documentation": "

A token for getting the next set of event trackers (if they exist).

" } } } }, "com.amazonaws.personalize#ListFilters": { "type": "operation", "input": { "target": "com.amazonaws.personalize#ListFiltersRequest" }, "output": { "target": "com.amazonaws.personalize#ListFiltersResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#InvalidNextTokenException" } ], "traits": { "smithy.api#documentation": "

Lists all filters that belong to a given dataset group.

", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "Filters", "pageSize": "maxResults" } } }, "com.amazonaws.personalize#ListFiltersRequest": { "type": "structure", "members": { "datasetGroupArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The ARN of the dataset group that contains the filters.

" } }, "nextToken": { "target": "com.amazonaws.personalize#NextToken", "traits": { "smithy.api#documentation": "

A token returned from the previous call to ListFilters for getting the\n next set of filters (if they exist).

" } }, "maxResults": { "target": "com.amazonaws.personalize#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of filters to return.

" } } } }, "com.amazonaws.personalize#ListFiltersResponse": { "type": "structure", "members": { "Filters": { "target": "com.amazonaws.personalize#Filters", "traits": { "smithy.api#documentation": "

A list of returned filters.

" } }, "nextToken": { "target": "com.amazonaws.personalize#NextToken", "traits": { "smithy.api#documentation": "

A token for getting the next set of filters (if they exist).

" } } } }, "com.amazonaws.personalize#ListRecipes": { "type": "operation", "input": { "target": "com.amazonaws.personalize#ListRecipesRequest" }, "output": { "target": "com.amazonaws.personalize#ListRecipesResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidNextTokenException" } ], "traits": { "smithy.api#documentation": "

Returns a list of available recipes. The response provides the properties\n for each recipe, including the recipe's Amazon Resource Name (ARN).

", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "recipes", "pageSize": "maxResults" } } }, "com.amazonaws.personalize#ListRecipesRequest": { "type": "structure", "members": { "recipeProvider": { "target": "com.amazonaws.personalize#RecipeProvider", "traits": { "smithy.api#documentation": "

The default is SERVICE.

" } }, "nextToken": { "target": "com.amazonaws.personalize#NextToken", "traits": { "smithy.api#documentation": "

A token returned from the previous call to ListRecipes for getting\n the next set of recipes (if they exist).

" } }, "maxResults": { "target": "com.amazonaws.personalize#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of recipes to return.

" } } } }, "com.amazonaws.personalize#ListRecipesResponse": { "type": "structure", "members": { "recipes": { "target": "com.amazonaws.personalize#Recipes", "traits": { "smithy.api#documentation": "

The list of available recipes.

" } }, "nextToken": { "target": "com.amazonaws.personalize#NextToken", "traits": { "smithy.api#documentation": "

A token for getting the next set of recipes.

" } } } }, "com.amazonaws.personalize#ListSchemas": { "type": "operation", "input": { "target": "com.amazonaws.personalize#ListSchemasRequest" }, "output": { "target": "com.amazonaws.personalize#ListSchemasResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidNextTokenException" } ], "traits": { "smithy.api#documentation": "

Returns the list of schemas associated with the account. The response provides the\n properties for each schema, including the Amazon Resource Name (ARN).\n For more information on schemas, see CreateSchema.

", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "schemas", "pageSize": "maxResults" } } }, "com.amazonaws.personalize#ListSchemasRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.personalize#NextToken", "traits": { "smithy.api#documentation": "

A token returned from the previous call to ListSchemas for getting\n the next set of schemas (if they exist).

" } }, "maxResults": { "target": "com.amazonaws.personalize#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of schemas to return.

" } } } }, "com.amazonaws.personalize#ListSchemasResponse": { "type": "structure", "members": { "schemas": { "target": "com.amazonaws.personalize#Schemas", "traits": { "smithy.api#documentation": "

A list of schemas.

" } }, "nextToken": { "target": "com.amazonaws.personalize#NextToken", "traits": { "smithy.api#documentation": "

A token used to get the next set of schemas (if they exist).

" } } } }, "com.amazonaws.personalize#ListSolutionVersions": { "type": "operation", "input": { "target": "com.amazonaws.personalize#ListSolutionVersionsRequest" }, "output": { "target": "com.amazonaws.personalize#ListSolutionVersionsResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#InvalidNextTokenException" }, { "target": "com.amazonaws.personalize#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Returns a list of solution versions for the given solution. When a solution is not\n specified, all the solution versions associated with the account are listed. The response\n provides the properties for each solution version, including the Amazon Resource Name (ARN).\n For more information on solutions, see CreateSolution.

", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "solutionVersions", "pageSize": "maxResults" } } }, "com.amazonaws.personalize#ListSolutionVersionsRequest": { "type": "structure", "members": { "solutionArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the solution.

" } }, "nextToken": { "target": "com.amazonaws.personalize#NextToken", "traits": { "smithy.api#documentation": "

A token returned from the previous call to ListSolutionVersions for getting\n the next set of solution versions (if they exist).

" } }, "maxResults": { "target": "com.amazonaws.personalize#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of solution versions to return.

" } } } }, "com.amazonaws.personalize#ListSolutionVersionsResponse": { "type": "structure", "members": { "solutionVersions": { "target": "com.amazonaws.personalize#SolutionVersions", "traits": { "smithy.api#documentation": "

A list of solution versions describing the version properties.

" } }, "nextToken": { "target": "com.amazonaws.personalize#NextToken", "traits": { "smithy.api#documentation": "

A token for getting the next set of solution versions (if they exist).

" } } } }, "com.amazonaws.personalize#ListSolutions": { "type": "operation", "input": { "target": "com.amazonaws.personalize#ListSolutionsRequest" }, "output": { "target": "com.amazonaws.personalize#ListSolutionsResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#InvalidNextTokenException" } ], "traits": { "smithy.api#documentation": "

Returns a list of solutions that use the given dataset group.\n When a dataset group is not specified, all the solutions associated with the account are listed.\n The response provides the properties for each solution, including the Amazon Resource Name (ARN).\n For more information on solutions, see CreateSolution.

", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "solutions", "pageSize": "maxResults" } } }, "com.amazonaws.personalize#ListSolutionsRequest": { "type": "structure", "members": { "datasetGroupArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset group.

" } }, "nextToken": { "target": "com.amazonaws.personalize#NextToken", "traits": { "smithy.api#documentation": "

A token returned from the previous call to ListSolutions for getting\n the next set of solutions (if they exist).

" } }, "maxResults": { "target": "com.amazonaws.personalize#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of solutions to return.

" } } } }, "com.amazonaws.personalize#ListSolutionsResponse": { "type": "structure", "members": { "solutions": { "target": "com.amazonaws.personalize#Solutions", "traits": { "smithy.api#documentation": "

A list of the current solutions.

" } }, "nextToken": { "target": "com.amazonaws.personalize#NextToken", "traits": { "smithy.api#documentation": "

A token for getting the next set of solutions (if they exist).

" } } } }, "com.amazonaws.personalize#MaxResults": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.personalize#MetricName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.personalize#MetricRegex": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.personalize#MetricValue": { "type": "double" }, "com.amazonaws.personalize#Metrics": { "type": "map", "key": { "target": "com.amazonaws.personalize#MetricName" }, "value": { "target": "com.amazonaws.personalize#MetricValue" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.personalize#Name": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 63 }, "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*$" } }, "com.amazonaws.personalize#NextToken": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1300 } } }, "com.amazonaws.personalize#NumBatchResults": { "type": "integer", "traits": { "smithy.api#box": {} } }, "com.amazonaws.personalize#ObjectiveSensitivity": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "LOW", "name": "LOW" }, { "value": "MEDIUM", "name": "MEDIUM" }, { "value": "HIGH", "name": "HIGH" }, { "value": "OFF", "name": "OFF" } ] } }, "com.amazonaws.personalize#OptimizationObjective": { "type": "structure", "members": { "itemAttribute": { "target": "com.amazonaws.personalize#ItemAttribute", "traits": { "smithy.api#documentation": "

The numerical metadata column in an Items dataset related to the optimization objective. For example, VIDEO_LENGTH (to maximize streaming minutes), or PRICE (to maximize revenue).

" } }, "objectiveSensitivity": { "target": "com.amazonaws.personalize#ObjectiveSensitivity", "traits": { "smithy.api#documentation": "

Specifies how Amazon Personalize balances the importance of your optimization objective versus relevance.

" } } }, "traits": { "smithy.api#documentation": "

Describes the additional objective for the solution, such as maximizing streaming \n minutes or increasing revenue. For more information see Optimizing a solution.

" } }, "com.amazonaws.personalize#ParameterName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.personalize#ParameterValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 } } }, "com.amazonaws.personalize#PerformAutoML": { "type": "boolean" }, "com.amazonaws.personalize#PerformHPO": { "type": "boolean" }, "com.amazonaws.personalize#Recipe": { "type": "structure", "members": { "name": { "target": "com.amazonaws.personalize#Name", "traits": { "smithy.api#documentation": "

The name of the recipe.

" } }, "recipeArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recipe.

" } }, "algorithmArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the algorithm that Amazon Personalize uses to train\n the model.

" } }, "featureTransformationArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The ARN of the FeatureTransformation object.

" } }, "status": { "target": "com.amazonaws.personalize#Status", "traits": { "smithy.api#documentation": "

The status of the recipe.

" } }, "description": { "target": "com.amazonaws.personalize#Description", "traits": { "smithy.api#documentation": "

The description of the recipe.

" } }, "creationDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The date and time (in Unix format) that the recipe was created.

" } }, "recipeType": { "target": "com.amazonaws.personalize#RecipeType", "traits": { "smithy.api#documentation": "

One of the following values:

\n " } }, "lastUpdatedDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The date and time (in Unix format) that the recipe was last updated.

" } } }, "traits": { "smithy.api#documentation": "

Provides information about a recipe. Each recipe provides an algorithm\n that Amazon Personalize uses in model training when you use the CreateSolution\n operation.

" } }, "com.amazonaws.personalize#RecipeProvider": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "SERVICE", "name": "SERVICE" } ] } }, "com.amazonaws.personalize#RecipeSummary": { "type": "structure", "members": { "name": { "target": "com.amazonaws.personalize#Name", "traits": { "smithy.api#documentation": "

The name of the recipe.

" } }, "recipeArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recipe.

" } }, "status": { "target": "com.amazonaws.personalize#Status", "traits": { "smithy.api#documentation": "

The status of the recipe.

" } }, "creationDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The date and time (in Unix time) that the recipe was created.

" } }, "lastUpdatedDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The date and time (in Unix time) that the recipe was last updated.

" } } }, "traits": { "smithy.api#documentation": "

Provides a summary of the properties of a recipe. For a complete listing, call the\n DescribeRecipe API.

" } }, "com.amazonaws.personalize#RecipeType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.personalize#Recipes": { "type": "list", "member": { "target": "com.amazonaws.personalize#RecipeSummary" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.personalize#ResourceAlreadyExistsException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.personalize#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

The specified resource already exists.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.personalize#ResourceConfig": { "type": "map", "key": { "target": "com.amazonaws.personalize#ParameterName" }, "value": { "target": "com.amazonaws.personalize#ParameterValue" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.personalize#ResourceInUseException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.personalize#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

The specified resource is in use.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.personalize#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.personalize#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

Could not find the specified resource.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.personalize#RoleArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^arn:([a-z\\d-]+):iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$" } }, "com.amazonaws.personalize#S3DataConfig": { "type": "structure", "members": { "path": { "target": "com.amazonaws.personalize#S3Location", "traits": { "smithy.api#documentation": "

The file path of the Amazon S3 bucket.

", "smithy.api#required": {} } }, "kmsKeyArn": { "target": "com.amazonaws.personalize#KmsKeyArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Key Management Service (KMS) key that Amazon Personalize uses to\n encrypt or decrypt the input and output files of a batch inference job.

" } } }, "traits": { "smithy.api#documentation": "

The configuration details of an Amazon S3 input or output bucket.

" } }, "com.amazonaws.personalize#S3Location": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.personalize#Schemas": { "type": "list", "member": { "target": "com.amazonaws.personalize#DatasetSchemaSummary" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.personalize#Solution": { "type": "structure", "members": { "name": { "target": "com.amazonaws.personalize#Name", "traits": { "smithy.api#documentation": "

The name of the solution.

" } }, "solutionArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The ARN of the solution.

" } }, "performHPO": { "target": "com.amazonaws.personalize#PerformHPO", "traits": { "smithy.api#documentation": "

Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The\n default is false.

" } }, "performAutoML": { "target": "com.amazonaws.personalize#PerformAutoML", "traits": { "smithy.api#documentation": "

When true, Amazon Personalize performs a search for the best USER_PERSONALIZATION recipe from\n the list specified in the solution configuration (recipeArn must not be specified).\n When false (the default), Amazon Personalize uses recipeArn for training.

" } }, "recipeArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The ARN of the recipe used to create the solution.

" } }, "datasetGroupArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset group that provides the training data.

" } }, "eventType": { "target": "com.amazonaws.personalize#EventType", "traits": { "smithy.api#documentation": "

The event type (for example, 'click' or 'like') that is used for training the model. \n If no eventType is provided, Amazon Personalize uses all interactions for training with\n equal weight regardless of type.

" } }, "solutionConfig": { "target": "com.amazonaws.personalize#SolutionConfig", "traits": { "smithy.api#documentation": "

Describes the configuration properties for the solution.

" } }, "autoMLResult": { "target": "com.amazonaws.personalize#AutoMLResult", "traits": { "smithy.api#documentation": "

When performAutoML is true, specifies the best recipe found.

" } }, "status": { "target": "com.amazonaws.personalize#Status", "traits": { "smithy.api#documentation": "

The status of the solution.

\n

A solution can be in one of the following states:

\n " } }, "creationDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The creation date and time (in Unix time) of the solution.

" } }, "lastUpdatedDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The date and time (in Unix time) that the solution was last updated.

" } }, "latestSolutionVersion": { "target": "com.amazonaws.personalize#SolutionVersionSummary", "traits": { "smithy.api#documentation": "

Describes the latest version of the solution, including the status and the ARN.

" } } }, "traits": { "smithy.api#documentation": "

An object that provides information about a solution. A solution is a trained model\n that can be deployed as a campaign.

" } }, "com.amazonaws.personalize#SolutionConfig": { "type": "structure", "members": { "eventValueThreshold": { "target": "com.amazonaws.personalize#EventValueThreshold", "traits": { "smithy.api#documentation": "

Only events with a value greater than or equal to this threshold are\n used for training a model.

" } }, "hpoConfig": { "target": "com.amazonaws.personalize#HPOConfig", "traits": { "smithy.api#documentation": "

Describes the properties for hyperparameter optimization (HPO).

" } }, "algorithmHyperParameters": { "target": "com.amazonaws.personalize#HyperParameters", "traits": { "smithy.api#documentation": "

Lists the hyperparameter names and ranges.

" } }, "featureTransformationParameters": { "target": "com.amazonaws.personalize#FeatureTransformationParameters", "traits": { "smithy.api#documentation": "

Lists the feature transformation parameters.

" } }, "autoMLConfig": { "target": "com.amazonaws.personalize#AutoMLConfig", "traits": { "smithy.api#documentation": "

The AutoMLConfig object containing a list of recipes to search\n when AutoML is performed.

" } }, "optimizationObjective": { "target": "com.amazonaws.personalize#OptimizationObjective", "traits": { "smithy.api#documentation": "

Describes the additional objective for the solution, such as maximizing streaming \n minutes or increasing revenue. For more information see Optimizing a solution.

" } } }, "traits": { "smithy.api#documentation": "

Describes the configuration properties for the solution.

" } }, "com.amazonaws.personalize#SolutionSummary": { "type": "structure", "members": { "name": { "target": "com.amazonaws.personalize#Name", "traits": { "smithy.api#documentation": "

The name of the solution.

" } }, "solutionArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the solution.

" } }, "status": { "target": "com.amazonaws.personalize#Status", "traits": { "smithy.api#documentation": "

The status of the solution.

\n

A solution can be in one of the following states:

\n " } }, "creationDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The date and time (in Unix time) that the solution was created.

" } }, "lastUpdatedDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The date and time (in Unix time) that the solution was last updated.

" } } }, "traits": { "smithy.api#documentation": "

Provides a summary of the properties of a solution. For a complete listing, call the\n DescribeSolution API.

" } }, "com.amazonaws.personalize#SolutionVersion": { "type": "structure", "members": { "solutionVersionArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The ARN of the solution version.

" } }, "solutionArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The ARN of the solution.

" } }, "performHPO": { "target": "com.amazonaws.personalize#PerformHPO", "traits": { "smithy.api#documentation": "

Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is\n false.

" } }, "performAutoML": { "target": "com.amazonaws.personalize#PerformAutoML", "traits": { "smithy.api#documentation": "

When true, Amazon Personalize searches for the most optimal recipe according to the solution\n configuration. When false (the default), Amazon Personalize uses recipeArn.

" } }, "recipeArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The ARN of the recipe used in the solution.

" } }, "eventType": { "target": "com.amazonaws.personalize#EventType", "traits": { "smithy.api#documentation": "

The event type (for example, 'click' or 'like') that is used for training the\n model.

" } }, "datasetGroupArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset group providing the training data.

" } }, "solutionConfig": { "target": "com.amazonaws.personalize#SolutionConfig", "traits": { "smithy.api#documentation": "

Describes the configuration properties for the solution.

" } }, "trainingHours": { "target": "com.amazonaws.personalize#TrainingHours", "traits": { "smithy.api#documentation": "

The time used to train the model. You are billed for the time it takes to train a model.\n This field is visible only after Amazon Personalize successfully trains a model.

" } }, "trainingMode": { "target": "com.amazonaws.personalize#TrainingMode", "traits": { "smithy.api#documentation": "

The scope of training to be performed when creating the solution version. The\n FULL option trains the solution version based on the entirety of the input\n solution's training data, while the UPDATE option processes only the data that\n has changed in comparison to the input solution. Choose UPDATE when you want to\n incrementally update your solution version instead of creating an entirely new one.

\n \n

The UPDATE option can only be used when you already have an active solution\n version created from the input solution using the FULL option and the input\n solution was trained with the \n User-Personalization\n recipe or the \n HRNN-Coldstart recipe.

\n " } }, "tunedHPOParams": { "target": "com.amazonaws.personalize#TunedHPOParams", "traits": { "smithy.api#documentation": "

If hyperparameter optimization was performed, contains the hyperparameter values of the\n best performing model.

" } }, "status": { "target": "com.amazonaws.personalize#Status", "traits": { "smithy.api#documentation": "

The status of the solution version.

\n

A solution version can be in one of the following states:

\n " } }, "failureReason": { "target": "com.amazonaws.personalize#FailureReason", "traits": { "smithy.api#documentation": "

If training a solution version fails, the reason for the failure.

" } }, "creationDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The date and\n time\n (in Unix time) that this version of the solution was created.

" } }, "lastUpdatedDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The date and time (in\n Unix\n time) that the solution was last updated.

" } } }, "traits": { "smithy.api#documentation": "

An object that provides information about a specific version of a Solution.

" } }, "com.amazonaws.personalize#SolutionVersionSummary": { "type": "structure", "members": { "solutionVersionArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the solution version.

" } }, "status": { "target": "com.amazonaws.personalize#Status", "traits": { "smithy.api#documentation": "

The status of the solution version.

\n

A solution version can be in one of the following states:

\n " } }, "creationDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The date and time (in Unix time) that this version of a solution was created.

" } }, "lastUpdatedDateTime": { "target": "com.amazonaws.personalize#Date", "traits": { "smithy.api#documentation": "

The date and time (in Unix time) that the solution version was last updated.

" } }, "failureReason": { "target": "com.amazonaws.personalize#FailureReason", "traits": { "smithy.api#documentation": "

If a solution version fails, the reason behind the failure.

" } } }, "traits": { "smithy.api#documentation": "

Provides a summary of the properties of a solution version. For a complete listing, call the\n DescribeSolutionVersion API.

" } }, "com.amazonaws.personalize#SolutionVersions": { "type": "list", "member": { "target": "com.amazonaws.personalize#SolutionVersionSummary" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.personalize#Solutions": { "type": "list", "member": { "target": "com.amazonaws.personalize#SolutionSummary" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.personalize#Status": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.personalize#StopSolutionVersionCreation": { "type": "operation", "input": { "target": "com.amazonaws.personalize#StopSolutionVersionCreationRequest" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#ResourceInUseException" }, { "target": "com.amazonaws.personalize#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS.\n

\n

Depending on the current state of the solution version, the solution version state changes as follows:

\n \n

You are billed for all of the training completed up\n until you stop the solution version creation. You cannot resume creating a solution version once it has been stopped.

", "smithy.api#idempotent": {} } }, "com.amazonaws.personalize#StopSolutionVersionCreationRequest": { "type": "structure", "members": { "solutionVersionArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the solution version you want to stop creating.

", "smithy.api#required": {} } } } }, "com.amazonaws.personalize#TrackingId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.personalize#TrainingHours": { "type": "double", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 0 } } }, "com.amazonaws.personalize#TrainingInputMode": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.personalize#TrainingMode": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "FULL", "name": "FULL" }, { "value": "UPDATE", "name": "UPDATE" } ] } }, "com.amazonaws.personalize#TransactionsPerSecond": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1 } } }, "com.amazonaws.personalize#Tunable": { "type": "boolean" }, "com.amazonaws.personalize#TunedHPOParams": { "type": "structure", "members": { "algorithmHyperParameters": { "target": "com.amazonaws.personalize#HyperParameters", "traits": { "smithy.api#documentation": "

A list of the hyperparameter values of the best performing model.

" } } }, "traits": { "smithy.api#documentation": "

If hyperparameter optimization (HPO) was performed, contains the hyperparameter values of\n the best performing model.

" } }, "com.amazonaws.personalize#UpdateCampaign": { "type": "operation", "input": { "target": "com.amazonaws.personalize#UpdateCampaignRequest" }, "output": { "target": "com.amazonaws.personalize#UpdateCampaignResponse" }, "errors": [ { "target": "com.amazonaws.personalize#InvalidInputException" }, { "target": "com.amazonaws.personalize#ResourceInUseException" }, { "target": "com.amazonaws.personalize#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Updates a campaign by either deploying a new solution or changing the value of the\n campaign's minProvisionedTPS parameter.

\n

To update a campaign, the campaign status must be ACTIVE or CREATE FAILED.\n Check the campaign status using the DescribeCampaign API.

\n \n

You must wait until the status of the\n updated campaign is ACTIVE before asking the campaign for recommendations.

\n \n

For more information on campaigns, see CreateCampaign.

", "smithy.api#idempotent": {} } }, "com.amazonaws.personalize#UpdateCampaignRequest": { "type": "structure", "members": { "campaignArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the campaign.

", "smithy.api#required": {} } }, "solutionVersionArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The ARN of a new solution version to deploy.

" } }, "minProvisionedTPS": { "target": "com.amazonaws.personalize#TransactionsPerSecond", "traits": { "smithy.api#documentation": "

Specifies the requested minimum provisioned transactions (recommendations) per second that\n Amazon Personalize will support.

" } }, "campaignConfig": { "target": "com.amazonaws.personalize#CampaignConfig", "traits": { "smithy.api#documentation": "

The configuration details of a campaign.

" } } } }, "com.amazonaws.personalize#UpdateCampaignResponse": { "type": "structure", "members": { "campaignArn": { "target": "com.amazonaws.personalize#Arn", "traits": { "smithy.api#documentation": "

The same campaign ARN as given in the request.

" } } } } } }