The configuration details of a batch inference job.

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

The number of recommendations to retrieve.

A list of tags to apply to the batch inference job.

The name of the batch inference job to create.

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

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

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

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.

The ARN of the batch inference job.

The response's http status code.

The ARN of the filter to apply to the batch segment job. For more information on using filters, see Filtering batch recommendations.

The number of predicted users generated by the batch segment job for each line of input data.

A list of tags to apply to the batch segment job.

The name of the batch segment job to create.

The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate batch segments.

The Amazon S3 path for the input data used to generate the batch segment job.

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

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.

The ARN of the batch segment job.

The response's http status code.

The configuration details of a campaign.

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

A list of tags to apply to the campaign.

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

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

The Amazon Resource Name (ARN) of the campaign.

The response's http status code.

A list of tags to apply to the dataset.

The name for the dataset.

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

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

The type of dataset.

One of the following (case insensitive) values:

• Interactions
• Items
• Users

The ARN of the dataset.

The response's http status code.

The data to export, based on how you imported the data. You can choose to export only BULK data that you imported using a dataset import job, only PUT data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is PUT.

A list of tags to apply to the dataset export job.

The name for the dataset export job.

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

The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.

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

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

The response's http status code.

The domain of the dataset group. Specify a domain to create a Domain dataset group. The domain you specify determines the default schemas for datasets and the use cases available for recommenders. If you don't specify a domain, you create a Custom dataset group with solution versions that you deploy with a campaign.

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

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.

A list of tags to apply to the dataset group.

The name for the new dataset group.

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

The domain for the new Domain dataset group.

The response's http status code.

Specify how to add the new records to an existing dataset. The default import mode is FULL. If you haven't imported bulk records into the dataset previously, you can only specify FULL.

• Specify FULL to overwrite all existing bulk data in your dataset. Data you imported individually is not replaced.
• Specify INCREMENTAL to append the new records to the existing data in your dataset. Amazon Personalize replaces any record with the same ID with the new one.

If you created a metric attribution, specify whether to publish metrics for this import job to Amazon S3

A list of tags to apply to the dataset import job.

The name for the dataset import job.

The ARN of the dataset that receives the imported data.

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

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

The ARN of the dataset import job.

The response's http status code.

A list of tags to apply to the event tracker.

The name for the event tracker.

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

The ARN of the event tracker.

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

The response's http status code.

A list of tags to apply to the filter.

The name of the filter to create.

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

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

The ARN of the new filter.

The response's http status code.

A name for the metric attribution.

The Amazon Resource Name (ARN) of the destination dataset group for the metric attribution.

A list of metric attributes for the metric attribution. Each metric attribute specifies an event type to track and a function. Available functions are SUM() or SAMPLECOUNT(). For SUM() functions, provide the dataset type (either Interactions or Items) and column to sum as a parameter. For example SUM(Items.PRICE).

The output configuration details for the metric attribution.

The Amazon Resource Name (ARN) for the new metric attribution.

The response's http status code.

The configuration details of the recommender.

A list of tags to apply to the recommender.

The name of the recommender.

The Amazon Resource Name (ARN) of the destination domain dataset group for the recommender.

The Amazon Resource Name (ARN) of the recipe that the recommender will use. For a recommender, a recipe is a Domain dataset group use case. Only Domain dataset group use cases can be used to create a recommender. For information about use cases see Choosing recommender use cases.

The Amazon Resource Name (ARN) of the recommender.

The response's http status code.

The domain for the schema. If you are creating a schema for a dataset in a Domain dataset group, specify the domain you chose when you created the Domain dataset group.

The name for the schema.

A schema in Avro JSON format.

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

The response's http status code.

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

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

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

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

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

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

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

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

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

A list of tags to apply to the solution.

The name for the solution.

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

The ARN of the solution.

The response's http status code.

The name of the solution version.

A list of tags to apply to the solution version.

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

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

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

The ARN of the new solution version.

The response's http status code.

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

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

The ARN of the dataset group to delete.

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

The ARN of the filter to delete.

The metric attribution's Amazon Resource Name (ARN).

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

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

The ARN of the solution to delete.

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

A listing of the properties of the algorithm.

The response's http status code.

The ARN of the batch inference job to describe.

Information on the specified batch inference job.

The response's http status code.

The ARN of the batch segment job to describe.

Information on the specified batch segment job.

The response's http status code.

The Amazon Resource Name (ARN) of the campaign.

The properties of the campaign.

The response's http status code.

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

A listing of the dataset's properties.

The response's http status code.

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

Information about the dataset export job, including the status.

The status is one of the following values:

• CREATE PENDING
• CREATE IN_PROGRESS
• ACTIVE
• CREATE FAILED

The response's http status code.

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

A listing of the dataset group's properties.

The response's http status code.

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

Information about the dataset import job, including the status.

The status is one of the following values:

• CREATE PENDING
• CREATE IN_PROGRESS
• ACTIVE
• CREATE FAILED

The response's http status code.

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

An object that describes the event tracker.

The response's http status code.

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

A listing of the FeatureTransformation properties.

The response's http status code.

The ARN of the filter to describe.

The filter's details.

The response's http status code.

The metric attribution's Amazon Resource Name (ARN).

The details of the metric attribution.

The response's http status code.

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

An object that describes the recipe.

The response's http status code.

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

The properties of the recommender.

The response's http status code.

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

The requested schema.

The response's http status code.

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

An object that describes the solution.

The response's http status code.

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

The solution version.

The response's http status code.

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

The metrics for the solution version. For more information, see Evaluating a solution version with metrics .

The same solution version ARN as specified in the request.

The response's http status code.

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

The token to request the next page of results.

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

A list containing information on each job that is returned.

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

The response's http status code.

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

The token to request the next page of results.

The Amazon Resource Name (ARN) of the solution version that the batch segment jobs used to generate batch segments.

A list containing information on each job that is returned.

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

The response's http status code.

The maximum number of campaigns to return.

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

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.

A list of the campaigns.

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

The response's http status code.

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

The maximum number of dataset export jobs to return.

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

The list of dataset export jobs.

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

The response's http status code.

The maximum number of dataset groups to return.

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

The list of your dataset groups.

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

The response's http status code.

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

The maximum number of dataset import jobs to return.

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

The list of dataset import jobs.

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

The response's http status code.

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

The maximum number of datasets to return.

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

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

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

The response's http status code.

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

The maximum number of event trackers to return.

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

A list of event trackers.

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

The response's http status code.

The ARN of the dataset group that contains the filters.

The maximum number of filters to return.

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

A list of returned filters.

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

The response's http status code.

The maximum number of metrics to return in one page of results.

The Amazon Resource Name (ARN) of the metric attribution to retrieve attributes for.

Specify the pagination token from a previous request to retrieve the next page of results.

The metrics for the specified metric attribution.

Specify the pagination token from a previous ListMetricAttributionMetricsResponse request to retrieve the next page of results.

The response's http status code.

The metric attributions' dataset group Amazon Resource Name (ARN).

The maximum number of metric attributions to return in one page of results.

Specify the pagination token from a previous request to retrieve the next page of results.

The list of metric attributions.

Specify the pagination token from a previous request to retrieve the next page of results.

The response's http status code.

Filters returned recipes by domain for a Domain dataset group. Only recipes (Domain dataset group use cases) for this domain are included in the response. If you don't specify a domain, all recipes are returned.

The maximum number of recipes to return.

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

The default is SERVICE.

A token for getting the next set of recipes.

The list of available recipes.

The response's http status code.

The Amazon Resource Name (ARN) of the Domain dataset group to list the recommenders for. When a Domain dataset group is not specified, all the recommenders associated with the account are listed.

The maximum number of recommenders to return.

A token returned from the previous call to ListRecommenders for getting the next set of recommenders (if they exist).

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

A list of the recommenders.

The response's http status code.

The maximum number of schemas to return.

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

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

A list of schemas.

The response's http status code.

The maximum number of solution versions to return.

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

The Amazon Resource Name (ARN) of the solution.

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

A list of solution versions describing the version properties.

The response's http status code.

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

The maximum number of solutions to return.

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

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

A list of the current solutions.

The response's http status code.

The resource's Amazon Resource Name.

The resource's tags.

The response's http status code.

The Amazon Resource Name (ARN) of the recommender to start.

The Amazon Resource Name (ARN) of the recommender you started.

The response's http status code.

The Amazon Resource Name (ARN) of the recommender to stop.

The Amazon Resource Name (ARN) of the recommender you stopped.

The response's http status code.

The Amazon Resource Name (ARN) of the solution version you want to stop creating.

The resource's Amazon Resource Name (ARN).

Tags to apply to the resource. For more information see Tagging Personalize resources.

The response's http status code.

The resource's Amazon Resource Name (ARN).

Keys to remove from the resource's tags.

The response's http status code.

The configuration details of a campaign.

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

The ARN of a new solution version to deploy.

The Amazon Resource Name (ARN) of the campaign.

The same campaign ARN as given in the request.

The response's http status code.

Add new metric attributes to the metric attribution.

The Amazon Resource Name (ARN) for the metric attribution to update.

An output config for the metric attribution.

Remove metric attributes from the metric attribution.

The Amazon Resource Name (ARN) for the metric attribution that you updated.

The response's http status code.

The Amazon Resource Name (ARN) of the recommender to modify.

The configuration details of the recommender.

The same recommender Amazon Resource Name (ARN) as given in the request.

The response's http status code.

The Amazon Resource Name (ARN) of the algorithm.

The URI of the Docker container for the algorithm image.

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

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

Specifies the default hyperparameters.

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

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

The name of the algorithm.

The Amazon Resource Name (ARN) of the role.

The training input mode.

The name of the algorithm image.

The URI of the Docker container for the algorithm image.

The metric to optimize.

The list of candidate recipes.

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

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

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

The time at which the batch inference job was created.

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

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

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

The name of the batch inference job.

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

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

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

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

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

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

• PENDING
• IN PROGRESS
• ACTIVE
• CREATE FAILED

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

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.

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

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

The time at which the batch inference job was created.

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

The name of the batch inference job.

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

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

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

• PENDING
• IN PROGRESS
• ACTIVE
• CREATE FAILED

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

The time at which the batch segment job was created.

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

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

The Amazon S3 path that leads to the input data used to generate the batch segment job.

The name of the batch segment job.

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

The time at which the batch segment job last updated.

The number of predicted users generated by the batch segment job for each line of input data.

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

The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.

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

• PENDING
• IN PROGRESS
• ACTIVE
• CREATE FAILED

Undocumented member.

Undocumented member.

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