github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/personalize/2018-05-22/docs-2.json (about) 1 { 2 "version": "2.0", 3 "service": "<p>Amazon Personalize is a machine learning service that makes it easy to add individualized recommendations to customers.</p>", 4 "operations": { 5 "CreateBatchInferenceJob": "<p>Creates a batch inference job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see <a>recommendations-batch</a>.</p>", 6 "CreateCampaign": "<p>Creates a campaign by deploying a solution version. When a client calls the <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html\">GetRecommendations</a> and <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetPersonalizedRanking.html\">GetPersonalizedRanking</a> APIs, a campaign is specified in the request.</p> <p> <b>Minimum Provisioned TPS and Auto-Scaling</b> </p> <p>A transaction is a single <code>GetRecommendations</code> or <code>GetPersonalizedRanking</code> call. Transactions per second (TPS) is the throughput and unit of billing for Amazon Personalize. The minimum provisioned TPS (<code>minProvisionedTPS</code>) specifies the baseline throughput provisioned by Amazon Personalize, and thus, the minimum billing charge. </p> <p> If your TPS increases beyond <code>minProvisionedTPS</code>, Amazon Personalize auto-scales the provisioned capacity up and down, but never below <code>minProvisionedTPS</code>. There's a short time delay while the capacity is increased that might cause loss of transactions.</p> <p>The actual TPS used is calculated as the average requests/second within a 5-minute window. You pay for maximum of either the minimum provisioned TPS or the actual TPS. We recommend starting with a low <code>minProvisionedTPS</code>, track your usage using Amazon CloudWatch metrics, and then increase the <code>minProvisionedTPS</code> as necessary.</p> <p> <b>Status</b> </p> <p>A campaign can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p> </li> <li> <p>DELETE PENDING > DELETE IN_PROGRESS</p> </li> </ul> <p>To get the campaign status, call <a>DescribeCampaign</a>.</p> <note> <p>Wait until the <code>status</code> of the campaign is <code>ACTIVE</code> before asking the campaign for recommendations.</p> </note> <p class=\"title\"> <b>Related APIs</b> </p> <ul> <li> <p> <a>ListCampaigns</a> </p> </li> <li> <p> <a>DescribeCampaign</a> </p> </li> <li> <p> <a>UpdateCampaign</a> </p> </li> <li> <p> <a>DeleteCampaign</a> </p> </li> </ul>", 7 "CreateDataset": "<p>Creates an empty dataset and adds it to the specified dataset group. Use <a>CreateDatasetImportJob</a> to import your training data to a dataset.</p> <p>There are three types of datasets:</p> <ul> <li> <p>Interactions</p> </li> <li> <p>Items</p> </li> <li> <p>Users</p> </li> </ul> <p>Each dataset type has an associated schema with required field types. Only the <code>Interactions</code> dataset is required in order to train a model (also referred to as creating a solution).</p> <p>A dataset can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p> </li> <li> <p>DELETE PENDING > DELETE IN_PROGRESS</p> </li> </ul> <p>To get the status of the dataset, call <a>DescribeDataset</a>.</p> <p class=\"title\"> <b>Related APIs</b> </p> <ul> <li> <p> <a>CreateDatasetGroup</a> </p> </li> <li> <p> <a>ListDatasets</a> </p> </li> <li> <p> <a>DescribeDataset</a> </p> </li> <li> <p> <a>DeleteDataset</a> </p> </li> </ul>", 8 "CreateDatasetExportJob": "<p> Creates a job that exports data from your dataset to an Amazon S3 bucket. To allow Amazon Personalize to export the training data, you must specify an service-linked IAM role that gives Amazon Personalize <code>PutObject</code> permissions for your Amazon S3 bucket. For information, see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/export-data.html\">Exporting a dataset</a> in the Amazon Personalize developer guide. </p> <p> <b>Status</b> </p> <p>A dataset export job can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p> </li> </ul> <p> To get the status of the export job, call <a>DescribeDatasetExportJob</a>, and specify the Amazon Resource Name (ARN) of the dataset export job. The dataset export is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a <code>failureReason</code> key, which describes why the job failed. </p>", 9 "CreateDatasetGroup": "<p>Creates an empty dataset group. A dataset group contains related datasets that supply data for training a model. A dataset group can contain at most three datasets, one for each type of dataset:</p> <ul> <li> <p>Interactions</p> </li> <li> <p>Items</p> </li> <li> <p>Users</p> </li> </ul> <p>To train a model (create a solution), a dataset group that contains an <code>Interactions</code> dataset is required. Call <a>CreateDataset</a> to add a dataset to the group.</p> <p>A dataset group can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p> </li> <li> <p>DELETE PENDING</p> </li> </ul> <p>To get the status of the dataset group, call <a>DescribeDatasetGroup</a>. If the status shows as CREATE FAILED, the response includes a <code>failureReason</code> key, which describes why the creation failed.</p> <note> <p>You must wait until the <code>status</code> of the dataset group is <code>ACTIVE</code> before adding a dataset to the group.</p> </note> <p>You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an Identity and Access Management (IAM) role that has permission to access the key.</p> <p class=\"title\"> <b>APIs that require a dataset group ARN in the request</b> </p> <ul> <li> <p> <a>CreateDataset</a> </p> </li> <li> <p> <a>CreateEventTracker</a> </p> </li> <li> <p> <a>CreateSolution</a> </p> </li> </ul> <p class=\"title\"> <b>Related APIs</b> </p> <ul> <li> <p> <a>ListDatasetGroups</a> </p> </li> <li> <p> <a>DescribeDatasetGroup</a> </p> </li> <li> <p> <a>DeleteDatasetGroup</a> </p> </li> </ul>", 10 "CreateDatasetImportJob": "<p>Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an IAM service role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it internally. For information on granting access to your Amazon S3 bucket, see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/granting-personalize-s3-access.html\">Giving Amazon Personalize Access to Amazon S3 Resources</a>. </p> <important> <p>The dataset import job replaces any existing data in the dataset that you imported in bulk.</p> </important> <p> <b>Status</b> </p> <p>A dataset import job can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p> </li> </ul> <p>To get the status of the import job, call <a>DescribeDatasetImportJob</a>, providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a <code>failureReason</code> key, which describes why the job failed.</p> <note> <p>Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset.</p> </note> <p class=\"title\"> <b>Related APIs</b> </p> <ul> <li> <p> <a>ListDatasetImportJobs</a> </p> </li> <li> <p> <a>DescribeDatasetImportJob</a> </p> </li> </ul>", 11 "CreateEventTracker": "<p>Creates an event tracker that you use when adding event data to a specified dataset group using the <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html\">PutEvents</a> API.</p> <note> <p>Only one event tracker can be associated with a dataset group. You will get an error if you call <code>CreateEventTracker</code> using the same dataset group as an existing event tracker.</p> </note> <p>When you create an event tracker, the response includes a tracking ID, which you pass as a parameter when you use the <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html\">PutEvents</a> operation. Amazon Personalize then appends the event data to the Interactions dataset of the dataset group you specify in your event tracker. </p> <p>The event tracker can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p> </li> <li> <p>DELETE PENDING > DELETE IN_PROGRESS</p> </li> </ul> <p>To get the status of the event tracker, call <a>DescribeEventTracker</a>.</p> <note> <p>The event tracker must be in the ACTIVE state before using the tracking ID.</p> </note> <p class=\"title\"> <b>Related APIs</b> </p> <ul> <li> <p> <a>ListEventTrackers</a> </p> </li> <li> <p> <a>DescribeEventTracker</a> </p> </li> <li> <p> <a>DeleteEventTracker</a> </p> </li> </ul>", 12 "CreateFilter": "<p>Creates a recommendation filter. For more information, see <a>filter</a>.</p>", 13 "CreateSchema": "<p>Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format.</p> <p>Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset type and has a set of required field and keywords. You specify a schema when you call <a>CreateDataset</a>.</p> <p class=\"title\"> <b>Related APIs</b> </p> <ul> <li> <p> <a>ListSchemas</a> </p> </li> <li> <p> <a>DescribeSchema</a> </p> </li> <li> <p> <a>DeleteSchema</a> </p> </li> </ul>", 14 "CreateSolution": "<p>Creates the configuration for training a model. A trained model is known as a solution. After the configuration is created, you train the model (create a solution) by calling the <a>CreateSolutionVersion</a> operation. Every time you call <code>CreateSolutionVersion</code>, a new version of the solution is created.</p> <p>After creating a solution version, you check its accuracy by calling <a>GetSolutionMetrics</a>. When you are satisfied with the version, you deploy it using <a>CreateCampaign</a>. The campaign provides recommendations to a client through the <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html\">GetRecommendations</a> API.</p> <p>To train a model, Amazon Personalize requires training data and a recipe. The training data comes from the dataset group that you provide in the request. A recipe specifies the training algorithm and a feature transformation. You can specify one of the predefined recipes provided by Amazon Personalize. Alternatively, you can specify <code>performAutoML</code> and Amazon Personalize will analyze your data and select the optimum USER_PERSONALIZATION recipe for you.</p> <note> <p>Amazon Personalize doesn't support configuring the <code>hpoObjective</code> for solution hyperparameter optimization at this time.</p> </note> <p> <b>Status</b> </p> <p>A solution can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p> </li> <li> <p>DELETE PENDING > DELETE IN_PROGRESS</p> </li> </ul> <p>To get the status of the solution, call <a>DescribeSolution</a>. Wait until the status shows as ACTIVE before calling <code>CreateSolutionVersion</code>.</p> <p class=\"title\"> <b>Related APIs</b> </p> <ul> <li> <p> <a>ListSolutions</a> </p> </li> <li> <p> <a>CreateSolutionVersion</a> </p> </li> <li> <p> <a>DescribeSolution</a> </p> </li> <li> <p> <a>DeleteSolution</a> </p> </li> </ul> <ul> <li> <p> <a>ListSolutionVersions</a> </p> </li> <li> <p> <a>DescribeSolutionVersion</a> </p> </li> </ul>", 15 "CreateSolutionVersion": "<p>Trains or retrains an active solution. A solution is created using the <a>CreateSolution</a> operation and must be in the ACTIVE state before calling <code>CreateSolutionVersion</code>. A new version of the solution is created every time you call this operation.</p> <p> <b>Status</b> </p> <p>A solution version can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING</p> </li> <li> <p>CREATE IN_PROGRESS</p> </li> <li> <p>ACTIVE</p> </li> <li> <p>CREATE FAILED</p> </li> <li> <p>CREATE STOPPING</p> </li> <li> <p>CREATE STOPPED</p> </li> </ul> <p>To get the status of the version, call <a>DescribeSolutionVersion</a>. Wait until the status shows as ACTIVE before calling <code>CreateCampaign</code>.</p> <p>If the status shows as CREATE FAILED, the response includes a <code>failureReason</code> key, which describes why the job failed.</p> <p class=\"title\"> <b>Related APIs</b> </p> <ul> <li> <p> <a>ListSolutionVersions</a> </p> </li> <li> <p> <a>DescribeSolutionVersion</a> </p> </li> </ul> <ul> <li> <p> <a>ListSolutions</a> </p> </li> <li> <p> <a>CreateSolution</a> </p> </li> <li> <p> <a>DescribeSolution</a> </p> </li> <li> <p> <a>DeleteSolution</a> </p> </li> </ul>", 16 "DeleteCampaign": "<p>Removes a campaign by deleting the solution deployment. The solution that the campaign is based on is not deleted and can be redeployed when needed. A deleted campaign can no longer be specified in a <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html\">GetRecommendations</a> request. For more information on campaigns, see <a>CreateCampaign</a>.</p>", 17 "DeleteDataset": "<p>Deletes a dataset. You can't delete a dataset if an associated <code>DatasetImportJob</code> or <code>SolutionVersion</code> is in the CREATE PENDING or IN PROGRESS state. For more information on datasets, see <a>CreateDataset</a>.</p>", 18 "DeleteDatasetGroup": "<p>Deletes a dataset group. Before you delete a dataset group, you must delete the following:</p> <ul> <li> <p>All associated event trackers.</p> </li> <li> <p>All associated solutions.</p> </li> <li> <p>All datasets in the dataset group.</p> </li> </ul>", 19 "DeleteEventTracker": "<p>Deletes the event tracker. Does not delete the event-interactions dataset from the associated dataset group. For more information on event trackers, see <a>CreateEventTracker</a>.</p>", 20 "DeleteFilter": "<p>Deletes a filter.</p>", 21 "DeleteSchema": "<p>Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see <a>CreateSchema</a>.</p>", 22 "DeleteSolution": "<p>Deletes all versions of a solution and the <code>Solution</code> object itself. Before deleting a solution, you must delete all campaigns based on the solution. To determine what campaigns are using the solution, call <a>ListCampaigns</a> and supply the Amazon Resource Name (ARN) of the solution. You can't delete a solution if an associated <code>SolutionVersion</code> is in the CREATE PENDING or IN PROGRESS state. For more information on solutions, see <a>CreateSolution</a>.</p>", 23 "DescribeAlgorithm": "<p>Describes the given algorithm.</p>", 24 "DescribeBatchInferenceJob": "<p>Gets the properties of a batch inference job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate the recommendations.</p>", 25 "DescribeCampaign": "<p>Describes the given campaign, including its status.</p> <p>A campaign can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p> </li> <li> <p>DELETE PENDING > DELETE IN_PROGRESS</p> </li> </ul> <p>When the <code>status</code> is <code>CREATE FAILED</code>, the response includes the <code>failureReason</code> key, which describes why.</p> <p>For more information on campaigns, see <a>CreateCampaign</a>.</p>", 26 "DescribeDataset": "<p>Describes the given dataset. For more information on datasets, see <a>CreateDataset</a>.</p>", 27 "DescribeDatasetExportJob": "<p>Describes the dataset export job created by <a>CreateDatasetExportJob</a>, including the export job status.</p>", 28 "DescribeDatasetGroup": "<p>Describes the given dataset group. For more information on dataset groups, see <a>CreateDatasetGroup</a>.</p>", 29 "DescribeDatasetImportJob": "<p>Describes the dataset import job created by <a>CreateDatasetImportJob</a>, including the import job status.</p>", 30 "DescribeEventTracker": "<p>Describes an event tracker. The response includes the <code>trackingId</code> and <code>status</code> of the event tracker. For more information on event trackers, see <a>CreateEventTracker</a>.</p>", 31 "DescribeFeatureTransformation": "<p>Describes the given feature transformation.</p>", 32 "DescribeFilter": "<p>Describes a filter's properties.</p>", 33 "DescribeRecipe": "<p>Describes a recipe.</p> <p>A recipe contains three items:</p> <ul> <li> <p>An algorithm that trains a model.</p> </li> <li> <p>Hyperparameters that govern the training.</p> </li> <li> <p>Feature transformation information for modifying the input data before training.</p> </li> </ul> <p>Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a solution with the <a>CreateSolution</a> API. <code>CreateSolution</code> trains a model by using the algorithm in the specified recipe and a training dataset. The solution, when deployed as a campaign, can provide recommendations using the <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html\">GetRecommendations</a> API.</p>", 34 "DescribeSchema": "<p>Describes a schema. For more information on schemas, see <a>CreateSchema</a>.</p>", 35 "DescribeSolution": "<p>Describes a solution. For more information on solutions, see <a>CreateSolution</a>.</p>", 36 "DescribeSolutionVersion": "<p>Describes a specific version of a solution. For more information on solutions, see <a>CreateSolution</a>.</p>", 37 "GetSolutionMetrics": "<p>Gets the metrics for the specified solution version.</p>", 38 "ListBatchInferenceJobs": "<p>Gets a list of the batch inference jobs that have been performed off of a solution version.</p>", 39 "ListCampaigns": "<p>Returns a list of campaigns that use the given solution. When a solution is not specified, all the campaigns associated with the account are listed. The response provides the properties for each campaign, including the Amazon Resource Name (ARN). For more information on campaigns, see <a>CreateCampaign</a>.</p>", 40 "ListDatasetExportJobs": "<p>Returns a list of dataset export jobs that use the given dataset. When a dataset is not specified, all the dataset export jobs associated with the account are listed. The response provides the properties for each dataset export job, including the Amazon Resource Name (ARN). For more information on dataset export jobs, see <a>CreateDatasetExportJob</a>. For more information on datasets, see <a>CreateDataset</a>.</p>", 41 "ListDatasetGroups": "<p>Returns a list of dataset groups. The response provides the properties for each dataset group, including the Amazon Resource Name (ARN). For more information on dataset groups, see <a>CreateDatasetGroup</a>.</p>", 42 "ListDatasetImportJobs": "<p>Returns a list of dataset import jobs that use the given dataset. When a dataset is not specified, all the dataset import jobs associated with the account are listed. The response provides the properties for each dataset import job, including the Amazon Resource Name (ARN). For more information on dataset import jobs, see <a>CreateDatasetImportJob</a>. For more information on datasets, see <a>CreateDataset</a>.</p>", 43 "ListDatasets": "<p>Returns the list of datasets contained in the given dataset group. The response provides the properties for each dataset, including the Amazon Resource Name (ARN). For more information on datasets, see <a>CreateDataset</a>.</p>", 44 "ListEventTrackers": "<p>Returns the list of event trackers associated with the account. The response provides the properties for each event tracker, including the Amazon Resource Name (ARN) and tracking ID. For more information on event trackers, see <a>CreateEventTracker</a>.</p>", 45 "ListFilters": "<p>Lists all filters that belong to a given dataset group.</p>", 46 "ListRecipes": "<p>Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).</p>", 47 "ListSchemas": "<p>Returns the list of schemas associated with the account. The response provides the properties for each schema, including the Amazon Resource Name (ARN). For more information on schemas, see <a>CreateSchema</a>.</p>", 48 "ListSolutionVersions": "<p>Returns a list of solution versions for the given solution. When a solution is not specified, all the solution versions associated with the account are listed. The response provides the properties for each solution version, including the Amazon Resource Name (ARN). For more information on solutions, see <a>CreateSolution</a>.</p>", 49 "ListSolutions": "<p>Returns a list of solutions that use the given dataset group. When a dataset group is not specified, all the solutions associated with the account are listed. The response provides the properties for each solution, including the Amazon Resource Name (ARN). For more information on solutions, see <a>CreateSolution</a>.</p>", 50 "StopSolutionVersionCreation": "<p>Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS. </p> <p>Depending on the current state of the solution version, the solution version state changes as follows:</p> <ul> <li> <p>CREATE_PENDING > CREATE_STOPPED</p> <p>or</p> </li> <li> <p>CREATE_IN_PROGRESS > CREATE_STOPPING > CREATE_STOPPED</p> </li> </ul> <p>You are billed for all of the training completed up until you stop the solution version creation. You cannot resume creating a solution version once it has been stopped.</p>", 51 "UpdateCampaign": "<p>Updates a campaign by either deploying a new solution or changing the value of the campaign's <code>minProvisionedTPS</code> parameter.</p> <p>To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the <a>DescribeCampaign</a> API.</p> <note> <p>You must wait until the <code>status</code> of the updated campaign is <code>ACTIVE</code> before asking the campaign for recommendations.</p> </note> <p>For more information on campaigns, see <a>CreateCampaign</a>.</p>" 52 }, 53 "shapes": { 54 "AccountId": { 55 "base": null, 56 "refs": { 57 "EventTracker$accountId": "<p>The Amazon Web Services account that owns the event tracker.</p>" 58 } 59 }, 60 "Algorithm": { 61 "base": "<p>Describes a custom algorithm.</p>", 62 "refs": { 63 "DescribeAlgorithmResponse$algorithm": "<p>A listing of the properties of the algorithm.</p>" 64 } 65 }, 66 "AlgorithmImage": { 67 "base": "<p>Describes an algorithm image.</p>", 68 "refs": { 69 "Algorithm$algorithmImage": "<p>The URI of the Docker container for the algorithm image.</p>" 70 } 71 }, 72 "Arn": { 73 "base": null, 74 "refs": { 75 "Algorithm$algorithmArn": "<p>The Amazon Resource Name (ARN) of the algorithm.</p>", 76 "Algorithm$roleArn": "<p>The Amazon Resource Name (ARN) of the role.</p>", 77 "ArnList$member": null, 78 "AutoMLResult$bestRecipeArn": "<p>The Amazon Resource Name (ARN) of the best recipe.</p>", 79 "BatchInferenceJob$batchInferenceJobArn": "<p>The Amazon Resource Name (ARN) of the batch inference job.</p>", 80 "BatchInferenceJob$filterArn": "<p>The ARN of the filter used on the batch inference job.</p>", 81 "BatchInferenceJob$solutionVersionArn": "<p>The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.</p>", 82 "BatchInferenceJobSummary$batchInferenceJobArn": "<p>The Amazon Resource Name (ARN) of the batch inference job.</p>", 83 "BatchInferenceJobSummary$solutionVersionArn": "<p>The ARN of the solution version used by the batch inference job.</p>", 84 "Campaign$campaignArn": "<p>The Amazon Resource Name (ARN) of the campaign. </p>", 85 "Campaign$solutionVersionArn": "<p>The Amazon Resource Name (ARN) of a specific version of the solution.</p>", 86 "CampaignSummary$campaignArn": "<p>The Amazon Resource Name (ARN) of the campaign.</p>", 87 "CampaignUpdateSummary$solutionVersionArn": "<p>The Amazon Resource Name (ARN) of the deployed solution version.</p>", 88 "CreateBatchInferenceJobRequest$solutionVersionArn": "<p>The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.</p>", 89 "CreateBatchInferenceJobRequest$filterArn": "<p>The ARN of the filter to apply to the batch inference job. For more information on using filters, see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/filter-batch.html\">Filtering Batch Recommendations</a>..</p>", 90 "CreateBatchInferenceJobResponse$batchInferenceJobArn": "<p>The ARN of the batch inference job.</p>", 91 "CreateCampaignRequest$solutionVersionArn": "<p>The Amazon Resource Name (ARN) of the solution version to deploy.</p>", 92 "CreateCampaignResponse$campaignArn": "<p>The Amazon Resource Name (ARN) of the campaign.</p>", 93 "CreateDatasetExportJobRequest$datasetArn": "<p>The Amazon Resource Name (ARN) of the dataset that contains the data to export.</p>", 94 "CreateDatasetExportJobResponse$datasetExportJobArn": "<p>The Amazon Resource Name (ARN) of the dataset export job.</p>", 95 "CreateDatasetGroupResponse$datasetGroupArn": "<p>The Amazon Resource Name (ARN) of the new dataset group.</p>", 96 "CreateDatasetImportJobRequest$datasetArn": "<p>The ARN of the dataset that receives the imported data.</p>", 97 "CreateDatasetImportJobResponse$datasetImportJobArn": "<p>The ARN of the dataset import job.</p>", 98 "CreateDatasetRequest$schemaArn": "<p>The ARN of the schema to associate with the dataset. The schema defines the dataset fields.</p>", 99 "CreateDatasetRequest$datasetGroupArn": "<p>The Amazon Resource Name (ARN) of the dataset group to add the dataset to.</p>", 100 "CreateDatasetResponse$datasetArn": "<p>The ARN of the dataset.</p>", 101 "CreateEventTrackerRequest$datasetGroupArn": "<p>The Amazon Resource Name (ARN) of the dataset group that receives the event data.</p>", 102 "CreateEventTrackerResponse$eventTrackerArn": "<p>The ARN of the event tracker.</p>", 103 "CreateFilterRequest$datasetGroupArn": "<p>The ARN of the dataset group that the filter will belong to.</p>", 104 "CreateFilterResponse$filterArn": "<p>The ARN of the new filter.</p>", 105 "CreateSchemaResponse$schemaArn": "<p>The Amazon Resource Name (ARN) of the created schema.</p>", 106 "CreateSolutionRequest$recipeArn": "<p>The ARN of the recipe to use for model training. Only specified when <code>performAutoML</code> is false.</p>", 107 "CreateSolutionRequest$datasetGroupArn": "<p>The Amazon Resource Name (ARN) of the dataset group that provides the training data.</p>", 108 "CreateSolutionResponse$solutionArn": "<p>The ARN of the solution.</p>", 109 "CreateSolutionVersionRequest$solutionArn": "<p>The Amazon Resource Name (ARN) of the solution containing the training configuration information.</p>", 110 "CreateSolutionVersionResponse$solutionVersionArn": "<p>The ARN of the new solution version.</p>", 111 "Dataset$datasetArn": "<p>The Amazon Resource Name (ARN) of the dataset that you want metadata for.</p>", 112 "Dataset$datasetGroupArn": "<p>The Amazon Resource Name (ARN) of the dataset group.</p>", 113 "Dataset$schemaArn": "<p>The ARN of the associated schema.</p>", 114 "DatasetExportJob$datasetExportJobArn": "<p>The Amazon Resource Name (ARN) of the dataset export job.</p>", 115 "DatasetExportJob$datasetArn": "<p>The Amazon Resource Name (ARN) of the dataset to export.</p>", 116 "DatasetExportJob$roleArn": "<p>The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.</p>", 117 "DatasetExportJobSummary$datasetExportJobArn": "<p>The Amazon Resource Name (ARN) of the dataset export job.</p>", 118 "DatasetGroup$datasetGroupArn": "<p>The Amazon Resource Name (ARN) of the dataset group.</p>", 119 "DatasetGroupSummary$datasetGroupArn": "<p>The Amazon Resource Name (ARN) of the dataset group.</p>", 120 "DatasetImportJob$datasetImportJobArn": "<p>The ARN of the dataset import job.</p>", 121 "DatasetImportJob$datasetArn": "<p>The Amazon Resource Name (ARN) of the dataset that receives the imported data.</p>", 122 "DatasetImportJob$roleArn": "<p>The ARN of the IAM role that has permissions to read from the Amazon S3 data source.</p>", 123 "DatasetImportJobSummary$datasetImportJobArn": "<p>The Amazon Resource Name (ARN) of the dataset import job.</p>", 124 "DatasetSchema$schemaArn": "<p>The Amazon Resource Name (ARN) of the schema.</p>", 125 "DatasetSchemaSummary$schemaArn": "<p>The Amazon Resource Name (ARN) of the schema.</p>", 126 "DatasetSummary$datasetArn": "<p>The Amazon Resource Name (ARN) of the dataset.</p>", 127 "DeleteCampaignRequest$campaignArn": "<p>The Amazon Resource Name (ARN) of the campaign to delete.</p>", 128 "DeleteDatasetGroupRequest$datasetGroupArn": "<p>The ARN of the dataset group to delete.</p>", 129 "DeleteDatasetRequest$datasetArn": "<p>The Amazon Resource Name (ARN) of the dataset to delete.</p>", 130 "DeleteEventTrackerRequest$eventTrackerArn": "<p>The Amazon Resource Name (ARN) of the event tracker to delete.</p>", 131 "DeleteFilterRequest$filterArn": "<p>The ARN of the filter to delete.</p>", 132 "DeleteSchemaRequest$schemaArn": "<p>The Amazon Resource Name (ARN) of the schema to delete.</p>", 133 "DeleteSolutionRequest$solutionArn": "<p>The ARN of the solution to delete.</p>", 134 "DescribeAlgorithmRequest$algorithmArn": "<p>The Amazon Resource Name (ARN) of the algorithm to describe.</p>", 135 "DescribeBatchInferenceJobRequest$batchInferenceJobArn": "<p>The ARN of the batch inference job to describe.</p>", 136 "DescribeCampaignRequest$campaignArn": "<p>The Amazon Resource Name (ARN) of the campaign.</p>", 137 "DescribeDatasetExportJobRequest$datasetExportJobArn": "<p>The Amazon Resource Name (ARN) of the dataset export job to describe.</p>", 138 "DescribeDatasetGroupRequest$datasetGroupArn": "<p>The Amazon Resource Name (ARN) of the dataset group to describe.</p>", 139 "DescribeDatasetImportJobRequest$datasetImportJobArn": "<p>The Amazon Resource Name (ARN) of the dataset import job to describe.</p>", 140 "DescribeDatasetRequest$datasetArn": "<p>The Amazon Resource Name (ARN) of the dataset to describe.</p>", 141 "DescribeEventTrackerRequest$eventTrackerArn": "<p>The Amazon Resource Name (ARN) of the event tracker to describe.</p>", 142 "DescribeFeatureTransformationRequest$featureTransformationArn": "<p>The Amazon Resource Name (ARN) of the feature transformation to describe.</p>", 143 "DescribeFilterRequest$filterArn": "<p>The ARN of the filter to describe.</p>", 144 "DescribeRecipeRequest$recipeArn": "<p>The Amazon Resource Name (ARN) of the recipe to describe.</p>", 145 "DescribeSchemaRequest$schemaArn": "<p>The Amazon Resource Name (ARN) of the schema to retrieve.</p>", 146 "DescribeSolutionRequest$solutionArn": "<p>The Amazon Resource Name (ARN) of the solution to describe.</p>", 147 "DescribeSolutionVersionRequest$solutionVersionArn": "<p>The Amazon Resource Name (ARN) of the solution version.</p>", 148 "EventTracker$eventTrackerArn": "<p>The ARN of the event tracker.</p>", 149 "EventTracker$datasetGroupArn": "<p>The Amazon Resource Name (ARN) of the dataset group that receives the event data.</p>", 150 "EventTrackerSummary$eventTrackerArn": "<p>The Amazon Resource Name (ARN) of the event tracker.</p>", 151 "FeatureTransformation$featureTransformationArn": "<p>The Amazon Resource Name (ARN) of the FeatureTransformation object.</p>", 152 "Filter$filterArn": "<p>The ARN of the filter.</p>", 153 "Filter$datasetGroupArn": "<p>The ARN of the dataset group to which the filter belongs.</p>", 154 "FilterSummary$filterArn": "<p>The ARN of the filter.</p>", 155 "FilterSummary$datasetGroupArn": "<p>The ARN of the dataset group to which the filter belongs.</p>", 156 "GetSolutionMetricsRequest$solutionVersionArn": "<p>The Amazon Resource Name (ARN) of the solution version for which to get metrics.</p>", 157 "GetSolutionMetricsResponse$solutionVersionArn": "<p>The same solution version ARN as specified in the request.</p>", 158 "ListBatchInferenceJobsRequest$solutionVersionArn": "<p>The Amazon Resource Name (ARN) of the solution version from which the batch inference jobs were created.</p>", 159 "ListCampaignsRequest$solutionArn": "<p>The Amazon Resource Name (ARN) of the solution to list the campaigns for. When a solution is not specified, all the campaigns associated with the account are listed.</p>", 160 "ListDatasetExportJobsRequest$datasetArn": "<p>The Amazon Resource Name (ARN) of the dataset to list the dataset export jobs for.</p>", 161 "ListDatasetImportJobsRequest$datasetArn": "<p>The Amazon Resource Name (ARN) of the dataset to list the dataset import jobs for.</p>", 162 "ListDatasetsRequest$datasetGroupArn": "<p>The Amazon Resource Name (ARN) of the dataset group that contains the datasets to list.</p>", 163 "ListEventTrackersRequest$datasetGroupArn": "<p>The ARN of a dataset group used to filter the response.</p>", 164 "ListFiltersRequest$datasetGroupArn": "<p>The ARN of the dataset group that contains the filters.</p>", 165 "ListSolutionVersionsRequest$solutionArn": "<p>The Amazon Resource Name (ARN) of the solution.</p>", 166 "ListSolutionsRequest$datasetGroupArn": "<p>The Amazon Resource Name (ARN) of the dataset group.</p>", 167 "Recipe$recipeArn": "<p>The Amazon Resource Name (ARN) of the recipe.</p>", 168 "Recipe$algorithmArn": "<p>The Amazon Resource Name (ARN) of the algorithm that Amazon Personalize uses to train the model.</p>", 169 "Recipe$featureTransformationArn": "<p>The ARN of the FeatureTransformation object.</p>", 170 "RecipeSummary$recipeArn": "<p>The Amazon Resource Name (ARN) of the recipe.</p>", 171 "Solution$solutionArn": "<p>The ARN of the solution.</p>", 172 "Solution$recipeArn": "<p>The ARN of the recipe used to create the solution.</p>", 173 "Solution$datasetGroupArn": "<p>The Amazon Resource Name (ARN) of the dataset group that provides the training data.</p>", 174 "SolutionSummary$solutionArn": "<p>The Amazon Resource Name (ARN) of the solution.</p>", 175 "SolutionVersion$solutionVersionArn": "<p>The ARN of the solution version.</p>", 176 "SolutionVersion$solutionArn": "<p>The ARN of the solution.</p>", 177 "SolutionVersion$recipeArn": "<p>The ARN of the recipe used in the solution.</p>", 178 "SolutionVersion$datasetGroupArn": "<p>The Amazon Resource Name (ARN) of the dataset group providing the training data.</p>", 179 "SolutionVersionSummary$solutionVersionArn": "<p>The Amazon Resource Name (ARN) of the solution version.</p>", 180 "StopSolutionVersionCreationRequest$solutionVersionArn": "<p>The Amazon Resource Name (ARN) of the solution version you want to stop creating.</p>", 181 "UpdateCampaignRequest$campaignArn": "<p>The Amazon Resource Name (ARN) of the campaign.</p>", 182 "UpdateCampaignRequest$solutionVersionArn": "<p>The ARN of a new solution version to deploy.</p>", 183 "UpdateCampaignResponse$campaignArn": "<p>The same campaign ARN as given in the request.</p>" 184 } 185 }, 186 "ArnList": { 187 "base": null, 188 "refs": { 189 "AutoMLConfig$recipeList": "<p>The list of candidate recipes.</p>" 190 } 191 }, 192 "AutoMLConfig": { 193 "base": "<p>When the solution performs AutoML (<code>performAutoML</code> is true in <a>CreateSolution</a>), Amazon Personalize determines which recipe, from the specified list, optimizes the given metric. Amazon Personalize then uses that recipe for the solution.</p>", 194 "refs": { 195 "SolutionConfig$autoMLConfig": "<p>The <a>AutoMLConfig</a> object containing a list of recipes to search when AutoML is performed.</p>" 196 } 197 }, 198 "AutoMLResult": { 199 "base": "<p>When the solution performs AutoML (<code>performAutoML</code> is true in <a>CreateSolution</a>), specifies the recipe that best optimized the specified metric.</p>", 200 "refs": { 201 "Solution$autoMLResult": "<p>When <code>performAutoML</code> is true, specifies the best recipe found.</p>" 202 } 203 }, 204 "AvroSchema": { 205 "base": null, 206 "refs": { 207 "CreateSchemaRequest$schema": "<p>A schema in Avro JSON format.</p>", 208 "DatasetSchema$schema": "<p>The schema.</p>" 209 } 210 }, 211 "BatchInferenceJob": { 212 "base": "<p>Contains information on a batch inference job.</p>", 213 "refs": { 214 "DescribeBatchInferenceJobResponse$batchInferenceJob": "<p>Information on the specified batch inference job.</p>" 215 } 216 }, 217 "BatchInferenceJobConfig": { 218 "base": "<p>The configuration details of a batch inference job.</p>", 219 "refs": { 220 "BatchInferenceJob$batchInferenceJobConfig": "<p>A string to string map of the configuration details of a batch inference job.</p>", 221 "CreateBatchInferenceJobRequest$batchInferenceJobConfig": "<p>The configuration details of a batch inference job.</p>" 222 } 223 }, 224 "BatchInferenceJobInput": { 225 "base": "<p>The input configuration of a batch inference job.</p>", 226 "refs": { 227 "BatchInferenceJob$jobInput": "<p>The Amazon S3 path that leads to the input data used to generate the batch inference job.</p>", 228 "CreateBatchInferenceJobRequest$jobInput": "<p>The Amazon S3 path that leads to the input file to base your recommendations on. The input material must be in JSON format.</p>" 229 } 230 }, 231 "BatchInferenceJobOutput": { 232 "base": "<p>The output configuration parameters of a batch inference job.</p>", 233 "refs": { 234 "BatchInferenceJob$jobOutput": "<p>The Amazon S3 bucket that contains the output data generated by the batch inference job.</p>", 235 "CreateBatchInferenceJobRequest$jobOutput": "<p>The path to the Amazon S3 bucket where the job's output will be stored.</p>" 236 } 237 }, 238 "BatchInferenceJobSummary": { 239 "base": "<p>A truncated version of the <a>BatchInferenceJob</a> datatype. The <a>ListBatchInferenceJobs</a> operation returns a list of batch inference job summaries.</p>", 240 "refs": { 241 "BatchInferenceJobs$member": null 242 } 243 }, 244 "BatchInferenceJobs": { 245 "base": null, 246 "refs": { 247 "ListBatchInferenceJobsResponse$batchInferenceJobs": "<p>A list containing information on each job that is returned.</p>" 248 } 249 }, 250 "Boolean": { 251 "base": null, 252 "refs": { 253 "CreateSolutionRequest$performHPO": "<p>Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is <code>false</code>.</p> <p>When performing AutoML, this parameter is always <code>true</code> and you should not set it to <code>false</code>.</p>" 254 } 255 }, 256 "Campaign": { 257 "base": "<p>Describes a deployed solution version, otherwise known as a campaign. For more information on campaigns, see <a>CreateCampaign</a>.</p>", 258 "refs": { 259 "DescribeCampaignResponse$campaign": "<p>The properties of the campaign.</p>" 260 } 261 }, 262 "CampaignConfig": { 263 "base": "<p>The configuration details of a campaign.</p>", 264 "refs": { 265 "Campaign$campaignConfig": "<p>The configuration details of a campaign.</p>", 266 "CampaignUpdateSummary$campaignConfig": null, 267 "CreateCampaignRequest$campaignConfig": "<p>The configuration details of a campaign.</p>", 268 "UpdateCampaignRequest$campaignConfig": "<p>The configuration details of a campaign.</p>" 269 } 270 }, 271 "CampaignSummary": { 272 "base": "<p>Provides a summary of the properties of a campaign. For a complete listing, call the <a>DescribeCampaign</a> API.</p>", 273 "refs": { 274 "Campaigns$member": null 275 } 276 }, 277 "CampaignUpdateSummary": { 278 "base": "<p>Provides a summary of the properties of a campaign update. For a complete listing, call the <a>DescribeCampaign</a> API.</p>", 279 "refs": { 280 "Campaign$latestCampaignUpdate": null 281 } 282 }, 283 "Campaigns": { 284 "base": null, 285 "refs": { 286 "ListCampaignsResponse$campaigns": "<p>A list of the campaigns.</p>" 287 } 288 }, 289 "CategoricalHyperParameterRange": { 290 "base": "<p>Provides the name and range of a categorical hyperparameter.</p>", 291 "refs": { 292 "CategoricalHyperParameterRanges$member": null 293 } 294 }, 295 "CategoricalHyperParameterRanges": { 296 "base": null, 297 "refs": { 298 "HyperParameterRanges$categoricalHyperParameterRanges": "<p>The categorical hyperparameters and their ranges.</p>" 299 } 300 }, 301 "CategoricalValue": { 302 "base": null, 303 "refs": { 304 "CategoricalValues$member": null 305 } 306 }, 307 "CategoricalValues": { 308 "base": null, 309 "refs": { 310 "CategoricalHyperParameterRange$values": "<p>A list of the categories for the hyperparameter.</p>", 311 "DefaultCategoricalHyperParameterRange$values": "<p>A list of the categories for the hyperparameter.</p>" 312 } 313 }, 314 "ContinuousHyperParameterRange": { 315 "base": "<p>Provides the name and range of a continuous hyperparameter.</p>", 316 "refs": { 317 "ContinuousHyperParameterRanges$member": null 318 } 319 }, 320 "ContinuousHyperParameterRanges": { 321 "base": null, 322 "refs": { 323 "HyperParameterRanges$continuousHyperParameterRanges": "<p>The continuous hyperparameters and their ranges.</p>" 324 } 325 }, 326 "ContinuousMaxValue": { 327 "base": null, 328 "refs": { 329 "ContinuousHyperParameterRange$maxValue": "<p>The maximum allowable value for the hyperparameter.</p>", 330 "DefaultContinuousHyperParameterRange$maxValue": "<p>The maximum allowable value for the hyperparameter.</p>" 331 } 332 }, 333 "ContinuousMinValue": { 334 "base": null, 335 "refs": { 336 "ContinuousHyperParameterRange$minValue": "<p>The minimum allowable value for the hyperparameter.</p>", 337 "DefaultContinuousHyperParameterRange$minValue": "<p>The minimum allowable value for the hyperparameter.</p>" 338 } 339 }, 340 "CreateBatchInferenceJobRequest": { 341 "base": null, 342 "refs": { 343 } 344 }, 345 "CreateBatchInferenceJobResponse": { 346 "base": null, 347 "refs": { 348 } 349 }, 350 "CreateCampaignRequest": { 351 "base": null, 352 "refs": { 353 } 354 }, 355 "CreateCampaignResponse": { 356 "base": null, 357 "refs": { 358 } 359 }, 360 "CreateDatasetExportJobRequest": { 361 "base": null, 362 "refs": { 363 } 364 }, 365 "CreateDatasetExportJobResponse": { 366 "base": null, 367 "refs": { 368 } 369 }, 370 "CreateDatasetGroupRequest": { 371 "base": null, 372 "refs": { 373 } 374 }, 375 "CreateDatasetGroupResponse": { 376 "base": null, 377 "refs": { 378 } 379 }, 380 "CreateDatasetImportJobRequest": { 381 "base": null, 382 "refs": { 383 } 384 }, 385 "CreateDatasetImportJobResponse": { 386 "base": null, 387 "refs": { 388 } 389 }, 390 "CreateDatasetRequest": { 391 "base": null, 392 "refs": { 393 } 394 }, 395 "CreateDatasetResponse": { 396 "base": null, 397 "refs": { 398 } 399 }, 400 "CreateEventTrackerRequest": { 401 "base": null, 402 "refs": { 403 } 404 }, 405 "CreateEventTrackerResponse": { 406 "base": null, 407 "refs": { 408 } 409 }, 410 "CreateFilterRequest": { 411 "base": null, 412 "refs": { 413 } 414 }, 415 "CreateFilterResponse": { 416 "base": null, 417 "refs": { 418 } 419 }, 420 "CreateSchemaRequest": { 421 "base": null, 422 "refs": { 423 } 424 }, 425 "CreateSchemaResponse": { 426 "base": null, 427 "refs": { 428 } 429 }, 430 "CreateSolutionRequest": { 431 "base": null, 432 "refs": { 433 } 434 }, 435 "CreateSolutionResponse": { 436 "base": null, 437 "refs": { 438 } 439 }, 440 "CreateSolutionVersionRequest": { 441 "base": null, 442 "refs": { 443 } 444 }, 445 "CreateSolutionVersionResponse": { 446 "base": null, 447 "refs": { 448 } 449 }, 450 "DataSource": { 451 "base": "<p>Describes the data source that contains the data to upload to a dataset.</p>", 452 "refs": { 453 "CreateDatasetImportJobRequest$dataSource": "<p>The Amazon S3 bucket that contains the training data to import.</p>", 454 "DatasetImportJob$dataSource": "<p>The Amazon S3 bucket that contains the training data to import.</p>" 455 } 456 }, 457 "Dataset": { 458 "base": "<p>Provides metadata for a dataset.</p>", 459 "refs": { 460 "DescribeDatasetResponse$dataset": "<p>A listing of the dataset's properties.</p>" 461 } 462 }, 463 "DatasetExportJob": { 464 "base": "<p>Describes a job that exports a dataset to an Amazon S3 bucket. For more information, see <a>CreateDatasetExportJob</a>.</p> <p>A dataset export job can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p> </li> </ul>", 465 "refs": { 466 "DescribeDatasetExportJobResponse$datasetExportJob": "<p>Information about the dataset export job, including the status.</p> <p>The status is one of the following values:</p> <ul> <li> <p>CREATE PENDING</p> </li> <li> <p>CREATE IN_PROGRESS</p> </li> <li> <p>ACTIVE</p> </li> <li> <p>CREATE FAILED</p> </li> </ul>" 467 } 468 }, 469 "DatasetExportJobOutput": { 470 "base": "<p>The output configuration parameters of a dataset export job.</p>", 471 "refs": { 472 "CreateDatasetExportJobRequest$jobOutput": "<p>The path to the Amazon S3 bucket where the job's output is stored.</p>", 473 "DatasetExportJob$jobOutput": "<p>The path to the Amazon S3 bucket where the job's output is stored. For example:</p> <p> <code>s3://bucket-name/folder-name/</code> </p>" 474 } 475 }, 476 "DatasetExportJobSummary": { 477 "base": "<p>Provides a summary of the properties of a dataset export job. For a complete listing, call the <a>DescribeDatasetExportJob</a> API.</p>", 478 "refs": { 479 "DatasetExportJobs$member": null 480 } 481 }, 482 "DatasetExportJobs": { 483 "base": null, 484 "refs": { 485 "ListDatasetExportJobsResponse$datasetExportJobs": "<p>The list of dataset export jobs.</p>" 486 } 487 }, 488 "DatasetGroup": { 489 "base": "<p>A dataset group is a collection of related datasets (Interactions, User, and Item). You create a dataset group by calling <a>CreateDatasetGroup</a>. You then create a dataset and add it to a dataset group by calling <a>CreateDataset</a>. The dataset group is used to create and train a solution by calling <a>CreateSolution</a>. A dataset group can contain only one of each type of dataset.</p> <p>You can specify an Key Management Service (KMS) key to encrypt the datasets in the group.</p>", 490 "refs": { 491 "DescribeDatasetGroupResponse$datasetGroup": "<p>A listing of the dataset group's properties.</p>" 492 } 493 }, 494 "DatasetGroupSummary": { 495 "base": "<p>Provides a summary of the properties of a dataset group. For a complete listing, call the <a>DescribeDatasetGroup</a> API.</p>", 496 "refs": { 497 "DatasetGroups$member": null 498 } 499 }, 500 "DatasetGroups": { 501 "base": null, 502 "refs": { 503 "ListDatasetGroupsResponse$datasetGroups": "<p>The list of your dataset groups.</p>" 504 } 505 }, 506 "DatasetImportJob": { 507 "base": "<p>Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset. For more information, see <a>CreateDatasetImportJob</a>.</p> <p>A dataset import job can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p> </li> </ul>", 508 "refs": { 509 "DescribeDatasetImportJobResponse$datasetImportJob": "<p>Information about the dataset import job, including the status.</p> <p>The status is one of the following values:</p> <ul> <li> <p>CREATE PENDING</p> </li> <li> <p>CREATE IN_PROGRESS</p> </li> <li> <p>ACTIVE</p> </li> <li> <p>CREATE FAILED</p> </li> </ul>" 510 } 511 }, 512 "DatasetImportJobSummary": { 513 "base": "<p>Provides a summary of the properties of a dataset import job. For a complete listing, call the <a>DescribeDatasetImportJob</a> API.</p>", 514 "refs": { 515 "DatasetImportJobs$member": null 516 } 517 }, 518 "DatasetImportJobs": { 519 "base": null, 520 "refs": { 521 "ListDatasetImportJobsResponse$datasetImportJobs": "<p>The list of dataset import jobs.</p>" 522 } 523 }, 524 "DatasetSchema": { 525 "base": "<p>Describes the schema for a dataset. For more information on schemas, see <a>CreateSchema</a>.</p>", 526 "refs": { 527 "DescribeSchemaResponse$schema": "<p>The requested schema.</p>" 528 } 529 }, 530 "DatasetSchemaSummary": { 531 "base": "<p>Provides a summary of the properties of a dataset schema. For a complete listing, call the <a>DescribeSchema</a> API.</p>", 532 "refs": { 533 "Schemas$member": null 534 } 535 }, 536 "DatasetSummary": { 537 "base": "<p>Provides a summary of the properties of a dataset. For a complete listing, call the <a>DescribeDataset</a> API.</p>", 538 "refs": { 539 "Datasets$member": null 540 } 541 }, 542 "DatasetType": { 543 "base": null, 544 "refs": { 545 "CreateDatasetRequest$datasetType": "<p>The type of dataset.</p> <p>One of the following (case insensitive) values:</p> <ul> <li> <p>Interactions</p> </li> <li> <p>Items</p> </li> <li> <p>Users</p> </li> </ul>", 546 "Dataset$datasetType": "<p>One of the following values:</p> <ul> <li> <p>Interactions</p> </li> <li> <p>Items</p> </li> <li> <p>Users</p> </li> </ul>", 547 "DatasetSummary$datasetType": "<p>The dataset type. One of the following values:</p> <ul> <li> <p>Interactions</p> </li> <li> <p>Items</p> </li> <li> <p>Users</p> </li> <li> <p>Event-Interactions</p> </li> </ul>" 548 } 549 }, 550 "Datasets": { 551 "base": null, 552 "refs": { 553 "ListDatasetsResponse$datasets": "<p>An array of <code>Dataset</code> objects. Each object provides metadata information.</p>" 554 } 555 }, 556 "Date": { 557 "base": null, 558 "refs": { 559 "Algorithm$creationDateTime": "<p>The date and time (in Unix time) that the algorithm was created.</p>", 560 "Algorithm$lastUpdatedDateTime": "<p>The date and time (in Unix time) that the algorithm was last updated.</p>", 561 "BatchInferenceJob$creationDateTime": "<p>The time at which the batch inference job was created.</p>", 562 "BatchInferenceJob$lastUpdatedDateTime": "<p>The time at which the batch inference job was last updated.</p>", 563 "BatchInferenceJobSummary$creationDateTime": "<p>The time at which the batch inference job was created.</p>", 564 "BatchInferenceJobSummary$lastUpdatedDateTime": "<p>The time at which the batch inference job was last updated.</p>", 565 "Campaign$creationDateTime": "<p>The date and time (in Unix format) that the campaign was created.</p>", 566 "Campaign$lastUpdatedDateTime": "<p>The date and time (in Unix format) that the campaign was last updated.</p>", 567 "CampaignSummary$creationDateTime": "<p>The date and time (in Unix time) that the campaign was created.</p>", 568 "CampaignSummary$lastUpdatedDateTime": "<p>The date and time (in Unix time) that the campaign was last updated.</p>", 569 "CampaignUpdateSummary$creationDateTime": "<p>The date and time (in Unix time) that the campaign update was created.</p>", 570 "CampaignUpdateSummary$lastUpdatedDateTime": "<p>The date and time (in Unix time) that the campaign update was last updated.</p>", 571 "Dataset$creationDateTime": "<p>The creation date and time (in Unix time) of the dataset.</p>", 572 "Dataset$lastUpdatedDateTime": "<p>A time stamp that shows when the dataset was updated.</p>", 573 "DatasetExportJob$creationDateTime": "<p>The creation date and time (in Unix time) of the dataset export job.</p>", 574 "DatasetExportJob$lastUpdatedDateTime": "<p>The date and time (in Unix time) the status of the dataset export job was last updated.</p>", 575 "DatasetExportJobSummary$creationDateTime": "<p>The date and time (in Unix time) that the dataset export job was created.</p>", 576 "DatasetExportJobSummary$lastUpdatedDateTime": "<p>The date and time (in Unix time) that the dataset export job status was last updated.</p>", 577 "DatasetGroup$creationDateTime": "<p>The creation date and time (in Unix time) of the dataset group.</p>", 578 "DatasetGroup$lastUpdatedDateTime": "<p>The last update date and time (in Unix time) of the dataset group.</p>", 579 "DatasetGroupSummary$creationDateTime": "<p>The date and time (in Unix time) that the dataset group was created.</p>", 580 "DatasetGroupSummary$lastUpdatedDateTime": "<p>The date and time (in Unix time) that the dataset group was last updated.</p>", 581 "DatasetImportJob$creationDateTime": "<p>The creation date and time (in Unix time) of the dataset import job.</p>", 582 "DatasetImportJob$lastUpdatedDateTime": "<p>The date and time (in Unix time) the dataset was last updated.</p>", 583 "DatasetImportJobSummary$creationDateTime": "<p>The date and time (in Unix time) that the dataset import job was created.</p>", 584 "DatasetImportJobSummary$lastUpdatedDateTime": "<p>The date and time (in Unix time) that the dataset import job status was last updated.</p>", 585 "DatasetSchema$creationDateTime": "<p>The date and time (in Unix time) that the schema was created.</p>", 586 "DatasetSchema$lastUpdatedDateTime": "<p>The date and time (in Unix time) that the schema was last updated.</p>", 587 "DatasetSchemaSummary$creationDateTime": "<p>The date and time (in Unix time) that the schema was created.</p>", 588 "DatasetSchemaSummary$lastUpdatedDateTime": "<p>The date and time (in Unix time) that the schema was last updated.</p>", 589 "DatasetSummary$creationDateTime": "<p>The date and time (in Unix time) that the dataset was created.</p>", 590 "DatasetSummary$lastUpdatedDateTime": "<p>The date and time (in Unix time) that the dataset was last updated.</p>", 591 "EventTracker$creationDateTime": "<p>The date and time (in Unix format) that the event tracker was created.</p>", 592 "EventTracker$lastUpdatedDateTime": "<p>The date and time (in Unix time) that the event tracker was last updated.</p>", 593 "EventTrackerSummary$creationDateTime": "<p>The date and time (in Unix time) that the event tracker was created.</p>", 594 "EventTrackerSummary$lastUpdatedDateTime": "<p>The date and time (in Unix time) that the event tracker was last updated.</p>", 595 "FeatureTransformation$creationDateTime": "<p>The creation date and time (in Unix time) of the feature transformation.</p>", 596 "FeatureTransformation$lastUpdatedDateTime": "<p>The last update date and time (in Unix time) of the feature transformation.</p>", 597 "Filter$creationDateTime": "<p>The time at which the filter was created.</p>", 598 "Filter$lastUpdatedDateTime": "<p>The time at which the filter was last updated.</p>", 599 "FilterSummary$creationDateTime": "<p>The time at which the filter was created.</p>", 600 "FilterSummary$lastUpdatedDateTime": "<p>The time at which the filter was last updated.</p>", 601 "Recipe$creationDateTime": "<p>The date and time (in Unix format) that the recipe was created.</p>", 602 "Recipe$lastUpdatedDateTime": "<p>The date and time (in Unix format) that the recipe was last updated.</p>", 603 "RecipeSummary$creationDateTime": "<p>The date and time (in Unix time) that the recipe was created.</p>", 604 "RecipeSummary$lastUpdatedDateTime": "<p>The date and time (in Unix time) that the recipe was last updated.</p>", 605 "Solution$creationDateTime": "<p>The creation date and time (in Unix time) of the solution.</p>", 606 "Solution$lastUpdatedDateTime": "<p>The date and time (in Unix time) that the solution was last updated.</p>", 607 "SolutionSummary$creationDateTime": "<p>The date and time (in Unix time) that the solution was created.</p>", 608 "SolutionSummary$lastUpdatedDateTime": "<p>The date and time (in Unix time) that the solution was last updated.</p>", 609 "SolutionVersion$creationDateTime": "<p>The date and time (in Unix time) that this version of the solution was created.</p>", 610 "SolutionVersion$lastUpdatedDateTime": "<p>The date and time (in Unix time) that the solution was last updated.</p>", 611 "SolutionVersionSummary$creationDateTime": "<p>The date and time (in Unix time) that this version of a solution was created.</p>", 612 "SolutionVersionSummary$lastUpdatedDateTime": "<p>The date and time (in Unix time) that the solution version was last updated.</p>" 613 } 614 }, 615 "DefaultCategoricalHyperParameterRange": { 616 "base": "<p>Provides the name and default range of a categorical hyperparameter and whether the hyperparameter is tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).</p>", 617 "refs": { 618 "DefaultCategoricalHyperParameterRanges$member": null 619 } 620 }, 621 "DefaultCategoricalHyperParameterRanges": { 622 "base": null, 623 "refs": { 624 "DefaultHyperParameterRanges$categoricalHyperParameterRanges": "<p>The categorical hyperparameters and their default ranges.</p>" 625 } 626 }, 627 "DefaultContinuousHyperParameterRange": { 628 "base": "<p>Provides the name and default range of a continuous hyperparameter and whether the hyperparameter is tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).</p>", 629 "refs": { 630 "DefaultContinuousHyperParameterRanges$member": null 631 } 632 }, 633 "DefaultContinuousHyperParameterRanges": { 634 "base": null, 635 "refs": { 636 "DefaultHyperParameterRanges$continuousHyperParameterRanges": "<p>The continuous hyperparameters and their default ranges.</p>" 637 } 638 }, 639 "DefaultHyperParameterRanges": { 640 "base": "<p>Specifies the hyperparameters and their default ranges. Hyperparameters can be categorical, continuous, or integer-valued.</p>", 641 "refs": { 642 "Algorithm$defaultHyperParameterRanges": "<p>Specifies the default hyperparameters, their ranges, and whether they are tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).</p>" 643 } 644 }, 645 "DefaultIntegerHyperParameterRange": { 646 "base": "<p>Provides the name and default range of a integer-valued hyperparameter and whether the hyperparameter is tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).</p>", 647 "refs": { 648 "DefaultIntegerHyperParameterRanges$member": null 649 } 650 }, 651 "DefaultIntegerHyperParameterRanges": { 652 "base": null, 653 "refs": { 654 "DefaultHyperParameterRanges$integerHyperParameterRanges": "<p>The integer-valued hyperparameters and their default ranges.</p>" 655 } 656 }, 657 "DeleteCampaignRequest": { 658 "base": null, 659 "refs": { 660 } 661 }, 662 "DeleteDatasetGroupRequest": { 663 "base": null, 664 "refs": { 665 } 666 }, 667 "DeleteDatasetRequest": { 668 "base": null, 669 "refs": { 670 } 671 }, 672 "DeleteEventTrackerRequest": { 673 "base": null, 674 "refs": { 675 } 676 }, 677 "DeleteFilterRequest": { 678 "base": null, 679 "refs": { 680 } 681 }, 682 "DeleteSchemaRequest": { 683 "base": null, 684 "refs": { 685 } 686 }, 687 "DeleteSolutionRequest": { 688 "base": null, 689 "refs": { 690 } 691 }, 692 "DescribeAlgorithmRequest": { 693 "base": null, 694 "refs": { 695 } 696 }, 697 "DescribeAlgorithmResponse": { 698 "base": null, 699 "refs": { 700 } 701 }, 702 "DescribeBatchInferenceJobRequest": { 703 "base": null, 704 "refs": { 705 } 706 }, 707 "DescribeBatchInferenceJobResponse": { 708 "base": null, 709 "refs": { 710 } 711 }, 712 "DescribeCampaignRequest": { 713 "base": null, 714 "refs": { 715 } 716 }, 717 "DescribeCampaignResponse": { 718 "base": null, 719 "refs": { 720 } 721 }, 722 "DescribeDatasetExportJobRequest": { 723 "base": null, 724 "refs": { 725 } 726 }, 727 "DescribeDatasetExportJobResponse": { 728 "base": null, 729 "refs": { 730 } 731 }, 732 "DescribeDatasetGroupRequest": { 733 "base": null, 734 "refs": { 735 } 736 }, 737 "DescribeDatasetGroupResponse": { 738 "base": null, 739 "refs": { 740 } 741 }, 742 "DescribeDatasetImportJobRequest": { 743 "base": null, 744 "refs": { 745 } 746 }, 747 "DescribeDatasetImportJobResponse": { 748 "base": null, 749 "refs": { 750 } 751 }, 752 "DescribeDatasetRequest": { 753 "base": null, 754 "refs": { 755 } 756 }, 757 "DescribeDatasetResponse": { 758 "base": null, 759 "refs": { 760 } 761 }, 762 "DescribeEventTrackerRequest": { 763 "base": null, 764 "refs": { 765 } 766 }, 767 "DescribeEventTrackerResponse": { 768 "base": null, 769 "refs": { 770 } 771 }, 772 "DescribeFeatureTransformationRequest": { 773 "base": null, 774 "refs": { 775 } 776 }, 777 "DescribeFeatureTransformationResponse": { 778 "base": null, 779 "refs": { 780 } 781 }, 782 "DescribeFilterRequest": { 783 "base": null, 784 "refs": { 785 } 786 }, 787 "DescribeFilterResponse": { 788 "base": null, 789 "refs": { 790 } 791 }, 792 "DescribeRecipeRequest": { 793 "base": null, 794 "refs": { 795 } 796 }, 797 "DescribeRecipeResponse": { 798 "base": null, 799 "refs": { 800 } 801 }, 802 "DescribeSchemaRequest": { 803 "base": null, 804 "refs": { 805 } 806 }, 807 "DescribeSchemaResponse": { 808 "base": null, 809 "refs": { 810 } 811 }, 812 "DescribeSolutionRequest": { 813 "base": null, 814 "refs": { 815 } 816 }, 817 "DescribeSolutionResponse": { 818 "base": null, 819 "refs": { 820 } 821 }, 822 "DescribeSolutionVersionRequest": { 823 "base": null, 824 "refs": { 825 } 826 }, 827 "DescribeSolutionVersionResponse": { 828 "base": null, 829 "refs": { 830 } 831 }, 832 "Description": { 833 "base": null, 834 "refs": { 835 "Recipe$description": "<p>The description of the recipe.</p>" 836 } 837 }, 838 "DockerURI": { 839 "base": null, 840 "refs": { 841 "AlgorithmImage$dockerURI": "<p>The URI of the Docker container for the algorithm image.</p>" 842 } 843 }, 844 "ErrorMessage": { 845 "base": null, 846 "refs": { 847 "InvalidInputException$message": null, 848 "InvalidNextTokenException$message": null, 849 "LimitExceededException$message": null, 850 "ResourceAlreadyExistsException$message": null, 851 "ResourceInUseException$message": null, 852 "ResourceNotFoundException$message": null 853 } 854 }, 855 "EventTracker": { 856 "base": "<p>Provides information about an event tracker.</p>", 857 "refs": { 858 "DescribeEventTrackerResponse$eventTracker": "<p>An object that describes the event tracker.</p>" 859 } 860 }, 861 "EventTrackerSummary": { 862 "base": "<p>Provides a summary of the properties of an event tracker. For a complete listing, call the <a>DescribeEventTracker</a> API.</p>", 863 "refs": { 864 "EventTrackers$member": null 865 } 866 }, 867 "EventTrackers": { 868 "base": null, 869 "refs": { 870 "ListEventTrackersResponse$eventTrackers": "<p>A list of event trackers.</p>" 871 } 872 }, 873 "EventType": { 874 "base": null, 875 "refs": { 876 "CreateSolutionRequest$eventType": "<p>When your have multiple event types (using an <code>EVENT_TYPE</code> schema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model.</p> <p>If you do not provide an <code>eventType</code>, Amazon Personalize will use all interactions for training with equal weight regardless of type.</p>", 877 "Solution$eventType": "<p>The event type (for example, 'click' or 'like') that is used for training the model. If no <code>eventType</code> is provided, Amazon Personalize uses all interactions for training with equal weight regardless of type.</p>", 878 "SolutionVersion$eventType": "<p>The event type (for example, 'click' or 'like') that is used for training the model.</p>" 879 } 880 }, 881 "EventValueThreshold": { 882 "base": null, 883 "refs": { 884 "SolutionConfig$eventValueThreshold": "<p>Only events with a value greater than or equal to this threshold are used for training a model.</p>" 885 } 886 }, 887 "FailureReason": { 888 "base": null, 889 "refs": { 890 "BatchInferenceJob$failureReason": "<p>If the batch inference job failed, the reason for the failure.</p>", 891 "BatchInferenceJobSummary$failureReason": "<p>If the batch inference job failed, the reason for the failure.</p>", 892 "Campaign$failureReason": "<p>If a campaign fails, the reason behind the failure.</p>", 893 "CampaignSummary$failureReason": "<p>If a campaign fails, the reason behind the failure.</p>", 894 "CampaignUpdateSummary$failureReason": "<p>If a campaign update fails, the reason behind the failure.</p>", 895 "DatasetExportJob$failureReason": "<p>If a dataset export job fails, provides the reason why.</p>", 896 "DatasetExportJobSummary$failureReason": "<p>If a dataset export job fails, the reason behind the failure.</p>", 897 "DatasetGroup$failureReason": "<p>If creating a dataset group fails, provides the reason why.</p>", 898 "DatasetGroupSummary$failureReason": "<p>If creating a dataset group fails, the reason behind the failure.</p>", 899 "DatasetImportJob$failureReason": "<p>If a dataset import job fails, provides the reason why.</p>", 900 "DatasetImportJobSummary$failureReason": "<p>If a dataset import job fails, the reason behind the failure.</p>", 901 "Filter$failureReason": "<p>If the filter failed, the reason for its failure.</p>", 902 "FilterSummary$failureReason": "<p>If the filter failed, the reason for the failure.</p>", 903 "SolutionVersion$failureReason": "<p>If training a solution version fails, the reason for the failure.</p>", 904 "SolutionVersionSummary$failureReason": "<p>If a solution version fails, the reason behind the failure.</p>" 905 } 906 }, 907 "FeatureTransformation": { 908 "base": "<p>Provides feature transformation information. Feature transformation is the process of modifying raw input data into a form more suitable for model training.</p>", 909 "refs": { 910 "DescribeFeatureTransformationResponse$featureTransformation": "<p>A listing of the FeatureTransformation properties.</p>" 911 } 912 }, 913 "FeatureTransformationParameters": { 914 "base": null, 915 "refs": { 916 "SolutionConfig$featureTransformationParameters": "<p>Lists the feature transformation parameters.</p>" 917 } 918 }, 919 "FeaturizationParameters": { 920 "base": null, 921 "refs": { 922 "FeatureTransformation$defaultParameters": "<p>Provides the default parameters for feature transformation.</p>" 923 } 924 }, 925 "Filter": { 926 "base": "<p>Contains information on a recommendation filter, including its ARN, status, and filter expression.</p>", 927 "refs": { 928 "DescribeFilterResponse$filter": "<p>The filter's details.</p>" 929 } 930 }, 931 "FilterExpression": { 932 "base": null, 933 "refs": { 934 "CreateFilterRequest$filterExpression": "<p>The filter expression defines which items are included or excluded from recommendations. Filter expression must follow specific format rules. For information about filter expression structure and syntax, see <a>filter-expressions</a>.</p>", 935 "Filter$filterExpression": "<p>Specifies the type of item interactions to filter out of recommendation results. The filter expression must follow specific format rules. For information about filter expression structure and syntax, see <a>filter-expressions</a>.</p>" 936 } 937 }, 938 "FilterSummary": { 939 "base": "<p>A short summary of a filter's attributes.</p>", 940 "refs": { 941 "Filters$member": null 942 } 943 }, 944 "Filters": { 945 "base": null, 946 "refs": { 947 "ListFiltersResponse$Filters": "<p>A list of returned filters.</p>" 948 } 949 }, 950 "GetSolutionMetricsRequest": { 951 "base": null, 952 "refs": { 953 } 954 }, 955 "GetSolutionMetricsResponse": { 956 "base": null, 957 "refs": { 958 } 959 }, 960 "HPOConfig": { 961 "base": "<p>Describes the properties for hyperparameter optimization (HPO).</p>", 962 "refs": { 963 "SolutionConfig$hpoConfig": "<p>Describes the properties for hyperparameter optimization (HPO).</p>" 964 } 965 }, 966 "HPOObjective": { 967 "base": "<p>The metric to optimize during hyperparameter optimization (HPO).</p> <note> <p>Amazon Personalize doesn't support configuring the <code>hpoObjective</code> at this time.</p> </note>", 968 "refs": { 969 "HPOConfig$hpoObjective": "<p>The metric to optimize during HPO.</p> <note> <p>Amazon Personalize doesn't support configuring the <code>hpoObjective</code> at this time.</p> </note>" 970 } 971 }, 972 "HPOObjectiveType": { 973 "base": null, 974 "refs": { 975 "HPOObjective$type": "<p>The type of the metric. Valid values are <code>Maximize</code> and <code>Minimize</code>.</p>" 976 } 977 }, 978 "HPOResource": { 979 "base": null, 980 "refs": { 981 "HPOResourceConfig$maxNumberOfTrainingJobs": "<p>The maximum number of training jobs when you create a solution version. The maximum value for <code>maxNumberOfTrainingJobs</code> is <code>40</code>.</p>", 982 "HPOResourceConfig$maxParallelTrainingJobs": "<p>The maximum number of parallel training jobs when you create a solution version. The maximum value for <code>maxParallelTrainingJobs</code> is <code>10</code>.</p>" 983 } 984 }, 985 "HPOResourceConfig": { 986 "base": "<p>Describes the resource configuration for hyperparameter optimization (HPO).</p>", 987 "refs": { 988 "HPOConfig$hpoResourceConfig": "<p>Describes the resource configuration for HPO.</p>" 989 } 990 }, 991 "HyperParameterRanges": { 992 "base": "<p>Specifies the hyperparameters and their ranges. Hyperparameters can be categorical, continuous, or integer-valued.</p>", 993 "refs": { 994 "HPOConfig$algorithmHyperParameterRanges": "<p>The hyperparameters and their allowable ranges.</p>" 995 } 996 }, 997 "HyperParameters": { 998 "base": null, 999 "refs": { 1000 "Algorithm$defaultHyperParameters": "<p>Specifies the default hyperparameters.</p>", 1001 "BatchInferenceJobConfig$itemExplorationConfig": "<p>A string to string map specifying the exploration configuration hyperparameters, including <code>explorationWeight</code> and <code>explorationItemAgeCutOff</code>, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. See <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html\">User-Personalization</a>.</p>", 1002 "CampaignConfig$itemExplorationConfig": "<p>A string to string map specifying the exploration configuration hyperparameters, including <code>explorationWeight</code> and <code>explorationItemAgeCutOff</code>, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide <code>itemExplorationConfig</code> data only if your solution uses the <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html\">User-Personalization</a> recipe.</p>", 1003 "SolutionConfig$algorithmHyperParameters": "<p>Lists the hyperparameter names and ranges.</p>", 1004 "TunedHPOParams$algorithmHyperParameters": "<p>A list of the hyperparameter values of the best performing model.</p>" 1005 } 1006 }, 1007 "IngestionMode": { 1008 "base": null, 1009 "refs": { 1010 "CreateDatasetExportJobRequest$ingestionMode": "<p>The data to export, based on how you imported the data. You can choose to export only <code>BULK</code> data that you imported using a dataset import job, only <code>PUT</code> data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or <code>ALL</code> for both types. The default value is <code>PUT</code>. </p>", 1011 "DatasetExportJob$ingestionMode": "<p>The data to export, based on how you imported the data. You can choose to export <code>BULK</code> data that you imported using a dataset import job, <code>PUT</code> data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or <code>ALL</code> for both types. The default value is <code>PUT</code>. </p>" 1012 } 1013 }, 1014 "IntegerHyperParameterRange": { 1015 "base": "<p>Provides the name and range of an integer-valued hyperparameter.</p>", 1016 "refs": { 1017 "IntegerHyperParameterRanges$member": null 1018 } 1019 }, 1020 "IntegerHyperParameterRanges": { 1021 "base": null, 1022 "refs": { 1023 "HyperParameterRanges$integerHyperParameterRanges": "<p>The integer-valued hyperparameters and their ranges.</p>" 1024 } 1025 }, 1026 "IntegerMaxValue": { 1027 "base": null, 1028 "refs": { 1029 "DefaultIntegerHyperParameterRange$maxValue": "<p>The maximum allowable value for the hyperparameter.</p>", 1030 "IntegerHyperParameterRange$maxValue": "<p>The maximum allowable value for the hyperparameter.</p>" 1031 } 1032 }, 1033 "IntegerMinValue": { 1034 "base": null, 1035 "refs": { 1036 "DefaultIntegerHyperParameterRange$minValue": "<p>The minimum allowable value for the hyperparameter.</p>", 1037 "IntegerHyperParameterRange$minValue": "<p>The minimum allowable value for the hyperparameter.</p>" 1038 } 1039 }, 1040 "InvalidInputException": { 1041 "base": "<p>Provide a valid value for the field or parameter.</p>", 1042 "refs": { 1043 } 1044 }, 1045 "InvalidNextTokenException": { 1046 "base": "<p>The token is not valid.</p>", 1047 "refs": { 1048 } 1049 }, 1050 "ItemAttribute": { 1051 "base": null, 1052 "refs": { 1053 "OptimizationObjective$itemAttribute": "<p>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).</p>" 1054 } 1055 }, 1056 "KmsKeyArn": { 1057 "base": null, 1058 "refs": { 1059 "CreateDatasetGroupRequest$kmsKeyArn": "<p>The Amazon Resource Name (ARN) of a Key Management Service (KMS) key used to encrypt the datasets.</p>", 1060 "DatasetGroup$kmsKeyArn": "<p>The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the datasets.</p>", 1061 "S3DataConfig$kmsKeyArn": "<p>The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files of a batch inference job.</p>" 1062 } 1063 }, 1064 "LimitExceededException": { 1065 "base": "<p>The limit on the number of requests per second has been exceeded.</p>", 1066 "refs": { 1067 } 1068 }, 1069 "ListBatchInferenceJobsRequest": { 1070 "base": null, 1071 "refs": { 1072 } 1073 }, 1074 "ListBatchInferenceJobsResponse": { 1075 "base": null, 1076 "refs": { 1077 } 1078 }, 1079 "ListCampaignsRequest": { 1080 "base": null, 1081 "refs": { 1082 } 1083 }, 1084 "ListCampaignsResponse": { 1085 "base": null, 1086 "refs": { 1087 } 1088 }, 1089 "ListDatasetExportJobsRequest": { 1090 "base": null, 1091 "refs": { 1092 } 1093 }, 1094 "ListDatasetExportJobsResponse": { 1095 "base": null, 1096 "refs": { 1097 } 1098 }, 1099 "ListDatasetGroupsRequest": { 1100 "base": null, 1101 "refs": { 1102 } 1103 }, 1104 "ListDatasetGroupsResponse": { 1105 "base": null, 1106 "refs": { 1107 } 1108 }, 1109 "ListDatasetImportJobsRequest": { 1110 "base": null, 1111 "refs": { 1112 } 1113 }, 1114 "ListDatasetImportJobsResponse": { 1115 "base": null, 1116 "refs": { 1117 } 1118 }, 1119 "ListDatasetsRequest": { 1120 "base": null, 1121 "refs": { 1122 } 1123 }, 1124 "ListDatasetsResponse": { 1125 "base": null, 1126 "refs": { 1127 } 1128 }, 1129 "ListEventTrackersRequest": { 1130 "base": null, 1131 "refs": { 1132 } 1133 }, 1134 "ListEventTrackersResponse": { 1135 "base": null, 1136 "refs": { 1137 } 1138 }, 1139 "ListFiltersRequest": { 1140 "base": null, 1141 "refs": { 1142 } 1143 }, 1144 "ListFiltersResponse": { 1145 "base": null, 1146 "refs": { 1147 } 1148 }, 1149 "ListRecipesRequest": { 1150 "base": null, 1151 "refs": { 1152 } 1153 }, 1154 "ListRecipesResponse": { 1155 "base": null, 1156 "refs": { 1157 } 1158 }, 1159 "ListSchemasRequest": { 1160 "base": null, 1161 "refs": { 1162 } 1163 }, 1164 "ListSchemasResponse": { 1165 "base": null, 1166 "refs": { 1167 } 1168 }, 1169 "ListSolutionVersionsRequest": { 1170 "base": null, 1171 "refs": { 1172 } 1173 }, 1174 "ListSolutionVersionsResponse": { 1175 "base": null, 1176 "refs": { 1177 } 1178 }, 1179 "ListSolutionsRequest": { 1180 "base": null, 1181 "refs": { 1182 } 1183 }, 1184 "ListSolutionsResponse": { 1185 "base": null, 1186 "refs": { 1187 } 1188 }, 1189 "MaxResults": { 1190 "base": null, 1191 "refs": { 1192 "ListBatchInferenceJobsRequest$maxResults": "<p>The maximum number of batch inference job results to return in each page. The default value is 100.</p>", 1193 "ListCampaignsRequest$maxResults": "<p>The maximum number of campaigns to return.</p>", 1194 "ListDatasetExportJobsRequest$maxResults": "<p>The maximum number of dataset export jobs to return.</p>", 1195 "ListDatasetGroupsRequest$maxResults": "<p>The maximum number of dataset groups to return.</p>", 1196 "ListDatasetImportJobsRequest$maxResults": "<p>The maximum number of dataset import jobs to return.</p>", 1197 "ListDatasetsRequest$maxResults": "<p>The maximum number of datasets to return.</p>", 1198 "ListEventTrackersRequest$maxResults": "<p>The maximum number of event trackers to return.</p>", 1199 "ListFiltersRequest$maxResults": "<p>The maximum number of filters to return.</p>", 1200 "ListRecipesRequest$maxResults": "<p>The maximum number of recipes to return.</p>", 1201 "ListSchemasRequest$maxResults": "<p>The maximum number of schemas to return.</p>", 1202 "ListSolutionVersionsRequest$maxResults": "<p>The maximum number of solution versions to return.</p>", 1203 "ListSolutionsRequest$maxResults": "<p>The maximum number of solutions to return.</p>" 1204 } 1205 }, 1206 "MetricName": { 1207 "base": null, 1208 "refs": { 1209 "AutoMLConfig$metricName": "<p>The metric to optimize.</p>", 1210 "HPOObjective$metricName": "<p>The name of the metric.</p>", 1211 "Metrics$key": null 1212 } 1213 }, 1214 "MetricRegex": { 1215 "base": null, 1216 "refs": { 1217 "HPOObjective$metricRegex": "<p>A regular expression for finding the metric in the training job logs.</p>" 1218 } 1219 }, 1220 "MetricValue": { 1221 "base": null, 1222 "refs": { 1223 "Metrics$value": null 1224 } 1225 }, 1226 "Metrics": { 1227 "base": null, 1228 "refs": { 1229 "GetSolutionMetricsResponse$metrics": "<p>The metrics for the solution version.</p>" 1230 } 1231 }, 1232 "Name": { 1233 "base": null, 1234 "refs": { 1235 "Algorithm$name": "<p>The name of the algorithm.</p>", 1236 "AlgorithmImage$name": "<p>The name of the algorithm image.</p>", 1237 "BatchInferenceJob$jobName": "<p>The name of the batch inference job.</p>", 1238 "BatchInferenceJobSummary$jobName": "<p>The name of the batch inference job.</p>", 1239 "Campaign$name": "<p>The name of the campaign.</p>", 1240 "CampaignSummary$name": "<p>The name of the campaign.</p>", 1241 "CreateBatchInferenceJobRequest$jobName": "<p>The name of the batch inference job to create.</p>", 1242 "CreateCampaignRequest$name": "<p>A name for the new campaign. The campaign name must be unique within your account.</p>", 1243 "CreateDatasetExportJobRequest$jobName": "<p>The name for the dataset export job.</p>", 1244 "CreateDatasetGroupRequest$name": "<p>The name for the new dataset group.</p>", 1245 "CreateDatasetImportJobRequest$jobName": "<p>The name for the dataset import job.</p>", 1246 "CreateDatasetRequest$name": "<p>The name for the dataset.</p>", 1247 "CreateEventTrackerRequest$name": "<p>The name for the event tracker.</p>", 1248 "CreateFilterRequest$name": "<p>The name of the filter to create.</p>", 1249 "CreateSchemaRequest$name": "<p>The name for the schema.</p>", 1250 "CreateSolutionRequest$name": "<p>The name for the solution.</p>", 1251 "Dataset$name": "<p>The name of the dataset.</p>", 1252 "DatasetExportJob$jobName": "<p>The name of the export job.</p>", 1253 "DatasetExportJobSummary$jobName": "<p>The name of the dataset export job.</p>", 1254 "DatasetGroup$name": "<p>The name of the dataset group.</p>", 1255 "DatasetGroupSummary$name": "<p>The name of the dataset group.</p>", 1256 "DatasetImportJob$jobName": "<p>The name of the import job.</p>", 1257 "DatasetImportJobSummary$jobName": "<p>The name of the dataset import job.</p>", 1258 "DatasetSchema$name": "<p>The name of the schema.</p>", 1259 "DatasetSchemaSummary$name": "<p>The name of the schema.</p>", 1260 "DatasetSummary$name": "<p>The name of the dataset.</p>", 1261 "EventTracker$name": "<p>The name of the event tracker.</p>", 1262 "EventTrackerSummary$name": "<p>The name of the event tracker.</p>", 1263 "FeatureTransformation$name": "<p>The name of the feature transformation.</p>", 1264 "Filter$name": "<p>The name of the filter.</p>", 1265 "FilterSummary$name": "<p>The name of the filter.</p>", 1266 "Recipe$name": "<p>The name of the recipe.</p>", 1267 "RecipeSummary$name": "<p>The name of the recipe.</p>", 1268 "Solution$name": "<p>The name of the solution.</p>", 1269 "SolutionSummary$name": "<p>The name of the solution.</p>" 1270 } 1271 }, 1272 "NextToken": { 1273 "base": null, 1274 "refs": { 1275 "ListBatchInferenceJobsRequest$nextToken": "<p>The token to request the next page of results.</p>", 1276 "ListBatchInferenceJobsResponse$nextToken": "<p>The token to use to retrieve the next page of results. The value is <code>null</code> when there are no more results to return.</p>", 1277 "ListCampaignsRequest$nextToken": "<p>A token returned from the previous call to <code>ListCampaigns</code> for getting the next set of campaigns (if they exist).</p>", 1278 "ListCampaignsResponse$nextToken": "<p>A token for getting the next set of campaigns (if they exist).</p>", 1279 "ListDatasetExportJobsRequest$nextToken": "<p>A token returned from the previous call to <code>ListDatasetExportJobs</code> for getting the next set of dataset export jobs (if they exist).</p>", 1280 "ListDatasetExportJobsResponse$nextToken": "<p>A token for getting the next set of dataset export jobs (if they exist).</p>", 1281 "ListDatasetGroupsRequest$nextToken": "<p>A token returned from the previous call to <code>ListDatasetGroups</code> for getting the next set of dataset groups (if they exist).</p>", 1282 "ListDatasetGroupsResponse$nextToken": "<p>A token for getting the next set of dataset groups (if they exist).</p>", 1283 "ListDatasetImportJobsRequest$nextToken": "<p>A token returned from the previous call to <code>ListDatasetImportJobs</code> for getting the next set of dataset import jobs (if they exist).</p>", 1284 "ListDatasetImportJobsResponse$nextToken": "<p>A token for getting the next set of dataset import jobs (if they exist).</p>", 1285 "ListDatasetsRequest$nextToken": "<p>A token returned from the previous call to <code>ListDatasetImportJobs</code> for getting the next set of dataset import jobs (if they exist).</p>", 1286 "ListDatasetsResponse$nextToken": "<p>A token for getting the next set of datasets (if they exist).</p>", 1287 "ListEventTrackersRequest$nextToken": "<p>A token returned from the previous call to <code>ListEventTrackers</code> for getting the next set of event trackers (if they exist).</p>", 1288 "ListEventTrackersResponse$nextToken": "<p>A token for getting the next set of event trackers (if they exist).</p>", 1289 "ListFiltersRequest$nextToken": "<p>A token returned from the previous call to <code>ListFilters</code> for getting the next set of filters (if they exist).</p>", 1290 "ListFiltersResponse$nextToken": "<p>A token for getting the next set of filters (if they exist).</p>", 1291 "ListRecipesRequest$nextToken": "<p>A token returned from the previous call to <code>ListRecipes</code> for getting the next set of recipes (if they exist).</p>", 1292 "ListRecipesResponse$nextToken": "<p>A token for getting the next set of recipes.</p>", 1293 "ListSchemasRequest$nextToken": "<p>A token returned from the previous call to <code>ListSchemas</code> for getting the next set of schemas (if they exist).</p>", 1294 "ListSchemasResponse$nextToken": "<p>A token used to get the next set of schemas (if they exist).</p>", 1295 "ListSolutionVersionsRequest$nextToken": "<p>A token returned from the previous call to <code>ListSolutionVersions</code> for getting the next set of solution versions (if they exist).</p>", 1296 "ListSolutionVersionsResponse$nextToken": "<p>A token for getting the next set of solution versions (if they exist).</p>", 1297 "ListSolutionsRequest$nextToken": "<p>A token returned from the previous call to <code>ListSolutions</code> for getting the next set of solutions (if they exist).</p>", 1298 "ListSolutionsResponse$nextToken": "<p>A token for getting the next set of solutions (if they exist).</p>" 1299 } 1300 }, 1301 "NumBatchResults": { 1302 "base": null, 1303 "refs": { 1304 "BatchInferenceJob$numResults": "<p>The number of recommendations generated by the batch inference job. This number includes the error messages generated for failed input records.</p>", 1305 "CreateBatchInferenceJobRequest$numResults": "<p>The number of recommendations to retreive.</p>" 1306 } 1307 }, 1308 "ObjectiveSensitivity": { 1309 "base": null, 1310 "refs": { 1311 "OptimizationObjective$objectiveSensitivity": "<p>Specifies how Amazon Personalize balances the importance of your optimization objective versus relevance.</p>" 1312 } 1313 }, 1314 "OptimizationObjective": { 1315 "base": "<p>Describes the additional objective for the solution, such as maximizing streaming minutes or increasing revenue. For more information see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/optimizing-solution-for-objective.html\">Optimizing a solution</a>.</p>", 1316 "refs": { 1317 "SolutionConfig$optimizationObjective": "<p>Describes the additional objective for the solution, such as maximizing streaming minutes or increasing revenue. For more information see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/optimizing-solution-for-objective.html\">Optimizing a solution</a>.</p>" 1318 } 1319 }, 1320 "ParameterName": { 1321 "base": null, 1322 "refs": { 1323 "CategoricalHyperParameterRange$name": "<p>The name of the hyperparameter.</p>", 1324 "ContinuousHyperParameterRange$name": "<p>The name of the hyperparameter.</p>", 1325 "DefaultCategoricalHyperParameterRange$name": "<p>The name of the hyperparameter.</p>", 1326 "DefaultContinuousHyperParameterRange$name": "<p>The name of the hyperparameter.</p>", 1327 "DefaultIntegerHyperParameterRange$name": "<p>The name of the hyperparameter.</p>", 1328 "FeatureTransformationParameters$key": null, 1329 "FeaturizationParameters$key": null, 1330 "HyperParameters$key": null, 1331 "IntegerHyperParameterRange$name": "<p>The name of the hyperparameter.</p>", 1332 "ResourceConfig$key": null 1333 } 1334 }, 1335 "ParameterValue": { 1336 "base": null, 1337 "refs": { 1338 "FeatureTransformationParameters$value": null, 1339 "FeaturizationParameters$value": null, 1340 "HyperParameters$value": null, 1341 "ResourceConfig$value": null 1342 } 1343 }, 1344 "PerformAutoML": { 1345 "base": null, 1346 "refs": { 1347 "CreateSolutionRequest$performAutoML": "<p>Whether to perform automated machine learning (AutoML). The default is <code>false</code>. For this case, you must specify <code>recipeArn</code>.</p> <p>When set to <code>true</code>, Amazon Personalize analyzes your training data and selects the optimal USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit <code>recipeArn</code>. Amazon Personalize determines the optimal recipe by running tests with different values for the hyperparameters. AutoML lengthens the training process as compared to selecting a specific recipe.</p>", 1348 "Solution$performAutoML": "<p>When true, Amazon Personalize performs a search for the best USER_PERSONALIZATION recipe from the list specified in the solution configuration (<code>recipeArn</code> must not be specified). When false (the default), Amazon Personalize uses <code>recipeArn</code> for training.</p>", 1349 "SolutionVersion$performAutoML": "<p>When true, Amazon Personalize searches for the most optimal recipe according to the solution configuration. When false (the default), Amazon Personalize uses <code>recipeArn</code>.</p>" 1350 } 1351 }, 1352 "PerformHPO": { 1353 "base": null, 1354 "refs": { 1355 "Solution$performHPO": "<p>Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is <code>false</code>.</p>", 1356 "SolutionVersion$performHPO": "<p>Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is <code>false</code>.</p>" 1357 } 1358 }, 1359 "Recipe": { 1360 "base": "<p>Provides information about a recipe. Each recipe provides an algorithm that Amazon Personalize uses in model training when you use the <a>CreateSolution</a> operation. </p>", 1361 "refs": { 1362 "DescribeRecipeResponse$recipe": "<p>An object that describes the recipe.</p>" 1363 } 1364 }, 1365 "RecipeProvider": { 1366 "base": null, 1367 "refs": { 1368 "ListRecipesRequest$recipeProvider": "<p>The default is <code>SERVICE</code>.</p>" 1369 } 1370 }, 1371 "RecipeSummary": { 1372 "base": "<p>Provides a summary of the properties of a recipe. For a complete listing, call the <a>DescribeRecipe</a> API.</p>", 1373 "refs": { 1374 "Recipes$member": null 1375 } 1376 }, 1377 "RecipeType": { 1378 "base": null, 1379 "refs": { 1380 "Recipe$recipeType": "<p>One of the following values:</p> <ul> <li> <p>PERSONALIZED_RANKING</p> </li> <li> <p>RELATED_ITEMS</p> </li> <li> <p>USER_PERSONALIZATION</p> </li> </ul>" 1381 } 1382 }, 1383 "Recipes": { 1384 "base": null, 1385 "refs": { 1386 "ListRecipesResponse$recipes": "<p>The list of available recipes.</p>" 1387 } 1388 }, 1389 "ResourceAlreadyExistsException": { 1390 "base": "<p>The specified resource already exists.</p>", 1391 "refs": { 1392 } 1393 }, 1394 "ResourceConfig": { 1395 "base": null, 1396 "refs": { 1397 "Algorithm$defaultResourceConfig": "<p>Specifies the default maximum number of training jobs and parallel training jobs.</p>" 1398 } 1399 }, 1400 "ResourceInUseException": { 1401 "base": "<p>The specified resource is in use.</p>", 1402 "refs": { 1403 } 1404 }, 1405 "ResourceNotFoundException": { 1406 "base": "<p>Could not find the specified resource.</p>", 1407 "refs": { 1408 } 1409 }, 1410 "RoleArn": { 1411 "base": null, 1412 "refs": { 1413 "BatchInferenceJob$roleArn": "<p>The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.</p>", 1414 "CreateBatchInferenceJobRequest$roleArn": "<p>The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.</p>", 1415 "CreateDatasetExportJobRequest$roleArn": "<p>The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.</p>", 1416 "CreateDatasetGroupRequest$roleArn": "<p>The ARN of the Identity and Access Management (IAM) role that has permissions to access the Key Management Service (KMS) key. Supplying an IAM role is only valid when also specifying a KMS key.</p>", 1417 "CreateDatasetImportJobRequest$roleArn": "<p>The ARN of the IAM role that has permissions to read from the Amazon S3 data source.</p>", 1418 "DatasetGroup$roleArn": "<p>The ARN of the IAM role that has permissions to create the dataset group.</p>" 1419 } 1420 }, 1421 "S3DataConfig": { 1422 "base": "<p>The configuration details of an Amazon S3 input or output bucket.</p>", 1423 "refs": { 1424 "BatchInferenceJobInput$s3DataSource": "<p>The URI of the Amazon S3 location that contains your input data. The Amazon S3 bucket must be in the same region as the API endpoint you are calling.</p>", 1425 "BatchInferenceJobOutput$s3DataDestination": "<p>Information on the Amazon S3 bucket in which the batch inference job's output is stored.</p>", 1426 "DatasetExportJobOutput$s3DataDestination": null 1427 } 1428 }, 1429 "S3Location": { 1430 "base": null, 1431 "refs": { 1432 "DataSource$dataLocation": "<p>The path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored. For example: </p> <p> <code>s3://bucket-name/folder-name/</code> </p>", 1433 "S3DataConfig$path": "<p>The file path of the Amazon S3 bucket.</p>" 1434 } 1435 }, 1436 "Schemas": { 1437 "base": null, 1438 "refs": { 1439 "ListSchemasResponse$schemas": "<p>A list of schemas.</p>" 1440 } 1441 }, 1442 "Solution": { 1443 "base": "<p>An object that provides information about a solution. A solution is a trained model that can be deployed as a campaign.</p>", 1444 "refs": { 1445 "DescribeSolutionResponse$solution": "<p>An object that describes the solution.</p>" 1446 } 1447 }, 1448 "SolutionConfig": { 1449 "base": "<p>Describes the configuration properties for the solution.</p>", 1450 "refs": { 1451 "CreateSolutionRequest$solutionConfig": "<p>The configuration to use with the solution. When <code>performAutoML</code> is set to true, Amazon Personalize only evaluates the <code>autoMLConfig</code> section of the solution configuration.</p> <note> <p>Amazon Personalize doesn't support configuring the <code>hpoObjective</code> at this time.</p> </note>", 1452 "Solution$solutionConfig": "<p>Describes the configuration properties for the solution.</p>", 1453 "SolutionVersion$solutionConfig": "<p>Describes the configuration properties for the solution.</p>" 1454 } 1455 }, 1456 "SolutionSummary": { 1457 "base": "<p>Provides a summary of the properties of a solution. For a complete listing, call the <a>DescribeSolution</a> API.</p>", 1458 "refs": { 1459 "Solutions$member": null 1460 } 1461 }, 1462 "SolutionVersion": { 1463 "base": "<p>An object that provides information about a specific version of a <a>Solution</a>.</p>", 1464 "refs": { 1465 "DescribeSolutionVersionResponse$solutionVersion": "<p>The solution version.</p>" 1466 } 1467 }, 1468 "SolutionVersionSummary": { 1469 "base": "<p>Provides a summary of the properties of a solution version. For a complete listing, call the <a>DescribeSolutionVersion</a> API.</p>", 1470 "refs": { 1471 "Solution$latestSolutionVersion": "<p>Describes the latest version of the solution, including the status and the ARN.</p>", 1472 "SolutionVersions$member": null 1473 } 1474 }, 1475 "SolutionVersions": { 1476 "base": null, 1477 "refs": { 1478 "ListSolutionVersionsResponse$solutionVersions": "<p>A list of solution versions describing the version properties.</p>" 1479 } 1480 }, 1481 "Solutions": { 1482 "base": null, 1483 "refs": { 1484 "ListSolutionsResponse$solutions": "<p>A list of the current solutions.</p>" 1485 } 1486 }, 1487 "Status": { 1488 "base": null, 1489 "refs": { 1490 "BatchInferenceJob$status": "<p>The status of the batch inference job. The status is one of the following values:</p> <ul> <li> <p>PENDING</p> </li> <li> <p>IN PROGRESS</p> </li> <li> <p>ACTIVE</p> </li> <li> <p>CREATE FAILED</p> </li> </ul>", 1491 "BatchInferenceJobSummary$status": "<p>The status of the batch inference job. The status is one of the following values:</p> <ul> <li> <p>PENDING</p> </li> <li> <p>IN PROGRESS</p> </li> <li> <p>ACTIVE</p> </li> <li> <p>CREATE FAILED</p> </li> </ul>", 1492 "Campaign$status": "<p>The status of the campaign.</p> <p>A campaign can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p> </li> <li> <p>DELETE PENDING > DELETE IN_PROGRESS</p> </li> </ul>", 1493 "CampaignSummary$status": "<p>The status of the campaign.</p> <p>A campaign can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p> </li> <li> <p>DELETE PENDING > DELETE IN_PROGRESS</p> </li> </ul>", 1494 "CampaignUpdateSummary$status": "<p>The status of the campaign update.</p> <p>A campaign update can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p> </li> <li> <p>DELETE PENDING > DELETE IN_PROGRESS</p> </li> </ul>", 1495 "Dataset$status": "<p>The status of the dataset.</p> <p>A dataset can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p> </li> <li> <p>DELETE PENDING > DELETE IN_PROGRESS</p> </li> </ul>", 1496 "DatasetExportJob$status": "<p>The status of the dataset export job.</p> <p>A dataset export job can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p> </li> </ul>", 1497 "DatasetExportJobSummary$status": "<p>The status of the dataset export job.</p> <p>A dataset export job can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p> </li> </ul>", 1498 "DatasetGroup$status": "<p>The current status of the dataset group.</p> <p>A dataset group can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p> </li> <li> <p>DELETE PENDING</p> </li> </ul>", 1499 "DatasetGroupSummary$status": "<p>The status of the dataset group.</p> <p>A dataset group can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p> </li> <li> <p>DELETE PENDING</p> </li> </ul>", 1500 "DatasetImportJob$status": "<p>The status of the dataset import job.</p> <p>A dataset import job can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p> </li> </ul>", 1501 "DatasetImportJobSummary$status": "<p>The status of the dataset import job.</p> <p>A dataset import job can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p> </li> </ul>", 1502 "DatasetSummary$status": "<p>The status of the dataset.</p> <p>A dataset can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p> </li> <li> <p>DELETE PENDING > DELETE IN_PROGRESS</p> </li> </ul>", 1503 "EventTracker$status": "<p>The status of the event tracker.</p> <p>An event tracker can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p> </li> <li> <p>DELETE PENDING > DELETE IN_PROGRESS</p> </li> </ul>", 1504 "EventTrackerSummary$status": "<p>The status of the event tracker.</p> <p>An event tracker can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p> </li> <li> <p>DELETE PENDING > DELETE IN_PROGRESS</p> </li> </ul>", 1505 "FeatureTransformation$status": "<p>The status of the feature transformation.</p> <p>A feature transformation can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p> </li> </ul>", 1506 "Filter$status": "<p>The status of the filter.</p>", 1507 "FilterSummary$status": "<p>The status of the filter.</p>", 1508 "Recipe$status": "<p>The status of the recipe.</p>", 1509 "RecipeSummary$status": "<p>The status of the recipe.</p>", 1510 "Solution$status": "<p>The status of the solution.</p> <p>A solution can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p> </li> <li> <p>DELETE PENDING > DELETE IN_PROGRESS</p> </li> </ul>", 1511 "SolutionSummary$status": "<p>The status of the solution.</p> <p>A solution can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p> </li> <li> <p>DELETE PENDING > DELETE IN_PROGRESS</p> </li> </ul>", 1512 "SolutionVersion$status": "<p>The status of the solution version.</p> <p>A solution version can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING</p> </li> <li> <p>CREATE IN_PROGRESS</p> </li> <li> <p>ACTIVE</p> </li> <li> <p>CREATE FAILED</p> </li> <li> <p>CREATE STOPPING</p> </li> <li> <p>CREATE STOPPED</p> </li> </ul>", 1513 "SolutionVersionSummary$status": "<p>The status of the solution version.</p> <p>A solution version can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p> </li> </ul>" 1514 } 1515 }, 1516 "StopSolutionVersionCreationRequest": { 1517 "base": null, 1518 "refs": { 1519 } 1520 }, 1521 "TrackingId": { 1522 "base": null, 1523 "refs": { 1524 "CreateEventTrackerResponse$trackingId": "<p>The ID of the event tracker. Include this ID in requests to the <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html\">PutEvents</a> API.</p>", 1525 "EventTracker$trackingId": "<p>The ID of the event tracker. Include this ID in requests to the <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html\">PutEvents</a> API.</p>" 1526 } 1527 }, 1528 "TrainingHours": { 1529 "base": null, 1530 "refs": { 1531 "SolutionVersion$trainingHours": "<p>The time used to train the model. You are billed for the time it takes to train a model. This field is visible only after Amazon Personalize successfully trains a model.</p>" 1532 } 1533 }, 1534 "TrainingInputMode": { 1535 "base": null, 1536 "refs": { 1537 "Algorithm$trainingInputMode": "<p>The training input mode.</p>" 1538 } 1539 }, 1540 "TrainingMode": { 1541 "base": null, 1542 "refs": { 1543 "CreateSolutionVersionRequest$trainingMode": "<p>The scope of training to be performed when creating the solution version. The <code>FULL</code> option trains the solution version based on the entirety of the input solution's training data, while the <code>UPDATE</code> option processes only the data that has changed in comparison to the input solution. Choose <code>UPDATE</code> when you want to incrementally update your solution version instead of creating an entirely new one.</p> <important> <p>The <code>UPDATE</code> option can only be used when you already have an active solution version created from the input solution using the <code>FULL</code> option and the input solution was trained with the <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html\">User-Personalization</a> recipe or the <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html\">HRNN-Coldstart</a> recipe.</p> </important>", 1544 "SolutionVersion$trainingMode": "<p>The scope of training to be performed when creating the solution version. The <code>FULL</code> option trains the solution version based on the entirety of the input solution's training data, while the <code>UPDATE</code> option processes only the data that has changed in comparison to the input solution. Choose <code>UPDATE</code> when you want to incrementally update your solution version instead of creating an entirely new one.</p> <important> <p>The <code>UPDATE</code> option can only be used when you already have an active solution version created from the input solution using the <code>FULL</code> option and the input solution was trained with the <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html\">User-Personalization</a> recipe or the <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html\">HRNN-Coldstart</a> recipe.</p> </important>" 1545 } 1546 }, 1547 "TransactionsPerSecond": { 1548 "base": null, 1549 "refs": { 1550 "Campaign$minProvisionedTPS": "<p>Specifies the requested minimum provisioned transactions (recommendations) per second.</p>", 1551 "CampaignUpdateSummary$minProvisionedTPS": "<p>Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.</p>", 1552 "CreateCampaignRequest$minProvisionedTPS": "<p>Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.</p>", 1553 "UpdateCampaignRequest$minProvisionedTPS": "<p>Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.</p>" 1554 } 1555 }, 1556 "Tunable": { 1557 "base": null, 1558 "refs": { 1559 "DefaultCategoricalHyperParameterRange$isTunable": "<p>Whether the hyperparameter is tunable.</p>", 1560 "DefaultContinuousHyperParameterRange$isTunable": "<p>Whether the hyperparameter is tunable.</p>", 1561 "DefaultIntegerHyperParameterRange$isTunable": "<p>Indicates whether the hyperparameter is tunable.</p>" 1562 } 1563 }, 1564 "TunedHPOParams": { 1565 "base": "<p>If hyperparameter optimization (HPO) was performed, contains the hyperparameter values of the best performing model.</p>", 1566 "refs": { 1567 "SolutionVersion$tunedHPOParams": "<p>If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model.</p>" 1568 } 1569 }, 1570 "UpdateCampaignRequest": { 1571 "base": null, 1572 "refs": { 1573 } 1574 }, 1575 "UpdateCampaignResponse": { 1576 "base": null, 1577 "refs": { 1578 } 1579 } 1580 } 1581 }