AmazonPersonalize (AWS SDK for Java

All Known Subinterfaces:

AmazonPersonalizeAsync

All Known Implementing Classes:

AbstractAmazonPersonalize, AbstractAmazonPersonalizeAsync, AmazonPersonalizeAsyncClient, AmazonPersonalizeClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonPersonalize
```
Interface for accessing Amazon Personalize.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonPersonalize instead.

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

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CreateBatchInferenceJobResult`	`createBatchInferenceJob(CreateBatchInferenceJobRequest createBatchInferenceJobRequest)` Creates a batch inference job.
`CreateCampaignResult`	`createCampaign(CreateCampaignRequest createCampaignRequest)` Creates a campaign by deploying a solution version.
`CreateDatasetResult`	`createDataset(CreateDatasetRequest createDatasetRequest)` Creates an empty dataset and adds it to the specified dataset group.
`CreateDatasetExportJobResult`	`createDatasetExportJob(CreateDatasetExportJobRequest createDatasetExportJobRequest)` Creates a job that exports data from your dataset to an Amazon S3 bucket.
`CreateDatasetGroupResult`	`createDatasetGroup(CreateDatasetGroupRequest createDatasetGroupRequest)` Creates an empty dataset group.
`CreateDatasetImportJobResult`	`createDatasetImportJob(CreateDatasetImportJobRequest createDatasetImportJobRequest)` Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset.
`CreateEventTrackerResult`	`createEventTracker(CreateEventTrackerRequest createEventTrackerRequest)` Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API.
`CreateFilterResult`	`createFilter(CreateFilterRequest createFilterRequest)` Creates a recommendation filter.
`CreateSchemaResult`	`createSchema(CreateSchemaRequest createSchemaRequest)` Creates an Amazon Personalize schema from the specified schema string.
`CreateSolutionResult`	`createSolution(CreateSolutionRequest createSolutionRequest)` Creates the configuration for training a model.
`CreateSolutionVersionResult`	`createSolutionVersion(CreateSolutionVersionRequest createSolutionVersionRequest)` Trains or retrains an active solution.
`DeleteCampaignResult`	`deleteCampaign(DeleteCampaignRequest deleteCampaignRequest)` Removes a campaign by deleting the solution deployment.
`DeleteDatasetResult`	`deleteDataset(DeleteDatasetRequest deleteDatasetRequest)` Deletes a dataset.
`DeleteDatasetGroupResult`	`deleteDatasetGroup(DeleteDatasetGroupRequest deleteDatasetGroupRequest)` Deletes a dataset group.
`DeleteEventTrackerResult`	`deleteEventTracker(DeleteEventTrackerRequest deleteEventTrackerRequest)` Deletes the event tracker.
`DeleteFilterResult`	`deleteFilter(DeleteFilterRequest deleteFilterRequest)` Deletes a filter.
`DeleteSchemaResult`	`deleteSchema(DeleteSchemaRequest deleteSchemaRequest)` Deletes a schema.
`DeleteSolutionResult`	`deleteSolution(DeleteSolutionRequest deleteSolutionRequest)` Deletes all versions of a solution and the `Solution` object itself.
`DescribeAlgorithmResult`	`describeAlgorithm(DescribeAlgorithmRequest describeAlgorithmRequest)` Describes the given algorithm.
`DescribeBatchInferenceJobResult`	`describeBatchInferenceJob(DescribeBatchInferenceJobRequest describeBatchInferenceJobRequest)` 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.
`DescribeCampaignResult`	`describeCampaign(DescribeCampaignRequest describeCampaignRequest)` Describes the given campaign, including its status.
`DescribeDatasetResult`	`describeDataset(DescribeDatasetRequest describeDatasetRequest)` Describes the given dataset.
`DescribeDatasetExportJobResult`	`describeDatasetExportJob(DescribeDatasetExportJobRequest describeDatasetExportJobRequest)` Describes the dataset export job created by CreateDatasetExportJob, including the export job status.
`DescribeDatasetGroupResult`	`describeDatasetGroup(DescribeDatasetGroupRequest describeDatasetGroupRequest)` Describes the given dataset group.
`DescribeDatasetImportJobResult`	`describeDatasetImportJob(DescribeDatasetImportJobRequest describeDatasetImportJobRequest)` Describes the dataset import job created by CreateDatasetImportJob, including the import job status.
`DescribeEventTrackerResult`	`describeEventTracker(DescribeEventTrackerRequest describeEventTrackerRequest)` Describes an event tracker.
`DescribeFeatureTransformationResult`	`describeFeatureTransformation(DescribeFeatureTransformationRequest describeFeatureTransformationRequest)` Describes the given feature transformation.
`DescribeFilterResult`	`describeFilter(DescribeFilterRequest describeFilterRequest)` Describes a filter's properties.
`DescribeRecipeResult`	`describeRecipe(DescribeRecipeRequest describeRecipeRequest)` Describes a recipe.
`DescribeSchemaResult`	`describeSchema(DescribeSchemaRequest describeSchemaRequest)` Describes a schema.
`DescribeSolutionResult`	`describeSolution(DescribeSolutionRequest describeSolutionRequest)` Describes a solution.
`DescribeSolutionVersionResult`	`describeSolutionVersion(DescribeSolutionVersionRequest describeSolutionVersionRequest)` Describes a specific version of a solution.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetSolutionMetricsResult`	`getSolutionMetrics(GetSolutionMetricsRequest getSolutionMetricsRequest)` Gets the metrics for the specified solution version.
`ListBatchInferenceJobsResult`	`listBatchInferenceJobs(ListBatchInferenceJobsRequest listBatchInferenceJobsRequest)` Gets a list of the batch inference jobs that have been performed off of a solution version.
`ListCampaignsResult`	`listCampaigns(ListCampaignsRequest listCampaignsRequest)` Returns a list of campaigns that use the given solution.
`ListDatasetExportJobsResult`	`listDatasetExportJobs(ListDatasetExportJobsRequest listDatasetExportJobsRequest)` Returns a list of dataset export jobs that use the given dataset.
`ListDatasetGroupsResult`	`listDatasetGroups(ListDatasetGroupsRequest listDatasetGroupsRequest)` Returns a list of dataset groups.
`ListDatasetImportJobsResult`	`listDatasetImportJobs(ListDatasetImportJobsRequest listDatasetImportJobsRequest)` Returns a list of dataset import jobs that use the given dataset.
`ListDatasetsResult`	`listDatasets(ListDatasetsRequest listDatasetsRequest)` Returns the list of datasets contained in the given dataset group.
`ListEventTrackersResult`	`listEventTrackers(ListEventTrackersRequest listEventTrackersRequest)` Returns the list of event trackers associated with the account.
`ListFiltersResult`	`listFilters(ListFiltersRequest listFiltersRequest)` Lists all filters that belong to a given dataset group.
`ListRecipesResult`	`listRecipes(ListRecipesRequest listRecipesRequest)` Returns a list of available recipes.
`ListSchemasResult`	`listSchemas(ListSchemasRequest listSchemasRequest)` Returns the list of schemas associated with the account.
`ListSolutionsResult`	`listSolutions(ListSolutionsRequest listSolutionsRequest)` Returns a list of solutions that use the given dataset group.
`ListSolutionVersionsResult`	`listSolutionVersions(ListSolutionVersionsRequest listSolutionVersionsRequest)` Returns a list of solution versions for the given solution.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StopSolutionVersionCreationResult`	`stopSolutionVersionCreation(StopSolutionVersionCreationRequest stopSolutionVersionCreationRequest)` Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS.
`UpdateCampaignResult`	`updateCampaign(UpdateCampaignRequest updateCampaignRequest)` Updates a campaign by either deploying a new solution or changing the value of the campaign's `minProvisionedTPS` parameter.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - createBatchInferenceJob
```
CreateBatchInferenceJobResult createBatchInferenceJob(CreateBatchInferenceJobRequest createBatchInferenceJobRequest)
```
    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 recommendations-batch.
    
    Parameters:
    
    createBatchInferenceJobRequest -
    
    Returns:
    
    Result of the CreateBatchInferenceJob operation returned by the service.
    
    Throws:
    
    InvalidInputException - Provide a valid value for the field or parameter.
    
    ResourceAlreadyExistsException - The specified resource already exists.
    
    LimitExceededException - The limit on the number of requests per second has been exceeded.
    
    ResourceNotFoundException - Could not find the specified resource.
    
    ResourceInUseException - The specified resource is in use.
    
    See Also:
    
    AWS API Documentation
  - createCampaign
```
CreateCampaignResult createCampaign(CreateCampaignRequest createCampaignRequest)
```
    Creates a campaign by deploying a solution version. When a client calls the GetRecommendations and GetPersonalizedRanking APIs, a campaign is specified in the request.
    
    Minimum Provisioned TPS and Auto-Scaling
    
    A transaction is a single GetRecommendations or GetPersonalizedRanking call. Transactions per second (TPS) is the throughput and unit of billing for Amazon Personalize. The minimum provisioned TPS (minProvisionedTPS) specifies the baseline throughput provisioned by Amazon Personalize, and thus, the minimum billing charge.
    
    If your TPS increases beyond minProvisionedTPS, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minProvisionedTPS. There's a short time delay while the capacity is increased that might cause loss of transactions.
    
    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 minProvisionedTPS, track your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS as necessary.
    
    Status
    
    A campaign can be in one of the following states:
    - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
    - DELETE PENDING > DELETE IN_PROGRESS
    To get the campaign status, call DescribeCampaign.
    
    Wait until the status of the campaign is ACTIVE before asking the campaign for recommendations.
    
    Related APIs
    Parameters:
    
    createCampaignRequest -
    
    Returns:
    
    Result of the CreateCampaign operation returned by the service.
    
    Throws:
    
    InvalidInputException - Provide a valid value for the field or parameter.
    
    ResourceNotFoundException - Could not find the specified resource.
    
    ResourceAlreadyExistsException - The specified resource already exists.
    
    LimitExceededException - The limit on the number of requests per second has been exceeded.
    
    ResourceInUseException - The specified resource is in use.
    
    See Also:
    
    AWS API Documentation
  - createDataset
```
CreateDatasetResult createDataset(CreateDatasetRequest createDatasetRequest)
```
    Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import your training data to a dataset.
    
    There are three types of datasets:
    - Interactions
    - Items
    - Users
    Each dataset type has an associated schema with required field types. Only the Interactions dataset is required in order to train a model (also referred to as creating a solution).
    
    A dataset can be in one of the following states:
    - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
    - DELETE PENDING > DELETE IN_PROGRESS
    To get the status of the dataset, call DescribeDataset.
    
    Related APIs
    Parameters:
    
    createDatasetRequest -
    
    Returns:
    
    Result of the CreateDataset operation returned by the service.
    
    Throws:
    
    InvalidInputException - Provide a valid value for the field or parameter.
    
    ResourceNotFoundException - Could not find the specified resource.
    
    ResourceAlreadyExistsException - The specified resource already exists.
    
    LimitExceededException - The limit on the number of requests per second has been exceeded.
    
    ResourceInUseException - The specified resource is in use.
    
    See Also:
    
    AWS API Documentation
  - createDatasetExportJob
```
CreateDatasetExportJobResult createDatasetExportJob(CreateDatasetExportJobRequest createDatasetExportJobRequest)
```
    Creates a job that exports data from your dataset to an Amazon S3 bucket. To allow Amazon Personalize to export the training data, you must specify an service-linked IAM role that gives Amazon Personalize PutObject permissions for your Amazon S3 bucket. For information, see Exporting a dataset in the Amazon Personalize developer guide.
    
    Status
    
    A dataset export job can be in one of the following states:
    - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
    To get the status of the export job, call DescribeDatasetExportJob, and specify the Amazon Resource Name (ARN) of the dataset export job. The dataset export is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.
    Parameters:
    
    createDatasetExportJobRequest -
    
    Returns:
    
    Result of the CreateDatasetExportJob operation returned by the service.
    
    Throws:
    
    InvalidInputException - Provide a valid value for the field or parameter.
    
    ResourceNotFoundException - Could not find the specified resource.
    
    ResourceAlreadyExistsException - The specified resource already exists.
    
    LimitExceededException - The limit on the number of requests per second has been exceeded.
    
    ResourceInUseException - The specified resource is in use.
    
    See Also:
    
    AWS API Documentation
  - createDatasetGroup
```
CreateDatasetGroupResult createDatasetGroup(CreateDatasetGroupRequest createDatasetGroupRequest)
```
    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:
    - Interactions
    - Items
    - Users
    To train a model (create a solution), a dataset group that contains an Interactions dataset is required. Call CreateDataset to add a dataset to the group.
    
    A dataset group can be in one of the following states:
    - CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
    - DELETE PENDING
    To get the status of the dataset group, call DescribeDatasetGroup. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the creation failed.
    
    You must wait until the status of the dataset group is ACTIVE before adding a dataset to the group.
    
    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.
    
    APIs that require a dataset group ARN in the request
    Related APIs
    Parameters:
    
    createDatasetGroupRequest -
    
    Returns:
    
    Result of the CreateDatasetGroup operation returned by the service.
    
    Throws:
    
    InvalidInputException - Provide a valid value for the field or parameter.
    
    ResourceAlreadyExistsException - The specified resource already exists.
    
    LimitExceededException - The limit on the number of requests per second has been exceeded.
    
    See Also:
    
    AWS API Documentation
  - createDatasetImportJob
```
CreateDatasetImportJobResult createDatasetImportJob(CreateDatasetImportJobRequest createDatasetImportJobRequest)
```
    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 ACTIVE -or- CREATE FAILED
  To get the status of the import job, call DescribeDatasetImportJob, providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.
  
  Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset.
  
  Related APIs
  - ListDatasetImportJobs
  - DescribeDatasetImportJob

Parameters:: createDatasetImportJobRequest -
Returns:: Result of the CreateDatasetImportJob operation returned by the service.
Throws:: InvalidInputException - Provide a valid value for the field or parameter.; ResourceNotFoundException - Could not find the specified resource.; ResourceAlreadyExistsException - The specified resource already exists.; LimitExceededException - The limit on the number of requests per second has been exceeded.; ResourceInUseException - The specified resource is in use.
See Also:: AWS API Documentation

createEventTracker
```
CreateEventTrackerResult createEventTracker(CreateEventTrackerRequest createEventTrackerRequest)
```
Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API.

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

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

The event tracker can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
- DELETE PENDING > DELETE IN_PROGRESS
To get the status of the event tracker, call DescribeEventTracker.

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

Related APIs
Parameters:

createEventTrackerRequest -

Returns:

Result of the CreateEventTracker operation returned by the service.

Throws:

InvalidInputException - Provide a valid value for the field or parameter.

ResourceAlreadyExistsException - The specified resource already exists.

ResourceNotFoundException - Could not find the specified resource.

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

ResourceInUseException - The specified resource is in use.

See Also:

AWS API Documentation

createFilter
```
CreateFilterResult createFilter(CreateFilterRequest createFilterRequest)
```
Creates a recommendation filter. For more information, see filter.

Parameters:

createFilterRequest -

Returns:

Result of the CreateFilter operation returned by the service.

Throws:

InvalidInputException - Provide a valid value for the field or parameter.

ResourceAlreadyExistsException - The specified resource already exists.

ResourceNotFoundException - Could not find the specified resource.

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

See Also:

AWS API Documentation

createSchema
```
CreateSchemaResult createSchema(CreateSchemaRequest createSchemaRequest)
```
Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format.

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

Related APIs
Parameters:

createSchemaRequest -

Returns:

Result of the CreateSchema operation returned by the service.

Throws:

InvalidInputException - Provide a valid value for the field or parameter.

ResourceAlreadyExistsException - The specified resource already exists.

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

See Also:

AWS API Documentation

createSolution
```
CreateSolutionResult createSolution(CreateSolutionRequest createSolutionRequest)
```
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 CreateSolutionVersion operation. Every time you call CreateSolutionVersion, a new version of the solution is created.

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

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 performAutoML and Amazon Personalize will analyze your data and select the optimum USER_PERSONALIZATION recipe for you.

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

Status

A solution can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
- DELETE PENDING > DELETE IN_PROGRESS
To get the status of the solution, call DescribeSolution. Wait until the status shows as ACTIVE before calling CreateSolutionVersion.

Related APIs
- ListSolutionVersions
- DescribeSolutionVersion
Parameters:

createSolutionRequest -

Returns:

Result of the CreateSolution operation returned by the service.

Throws:

InvalidInputException - Provide a valid value for the field or parameter.

ResourceAlreadyExistsException - The specified resource already exists.

ResourceNotFoundException - Could not find the specified resource.

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

ResourceInUseException - The specified resource is in use.

See Also:

AWS API Documentation

createSolutionVersion
```
CreateSolutionVersionResult createSolutionVersion(CreateSolutionVersionRequest createSolutionVersionRequest)
```
Trains or retrains an active solution. A solution is created using the CreateSolution operation and must be in the ACTIVE state before calling CreateSolutionVersion. A new version of the solution is created every time you call this operation.

Status

A solution version can be in one of the following states:
- CREATE PENDING
- CREATE IN_PROGRESS
- ACTIVE
- CREATE FAILED
- CREATE STOPPING
- CREATE STOPPED
To get the status of the version, call DescribeSolutionVersion. Wait until the status shows as ACTIVE before calling CreateCampaign.

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

Related APIs
- ListSolutionVersions
- DescribeSolutionVersion
Parameters:

createSolutionVersionRequest -

Returns:

Result of the CreateSolutionVersion operation returned by the service.

Throws:

InvalidInputException - Provide a valid value for the field or parameter.

ResourceNotFoundException - Could not find the specified resource.

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

ResourceInUseException - The specified resource is in use.

See Also:

AWS API Documentation

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

Parameters:

deleteCampaignRequest -

Returns:

Result of the DeleteCampaign operation returned by the service.

Throws:

InvalidInputException - Provide a valid value for the field or parameter.

ResourceNotFoundException - Could not find the specified resource.

ResourceInUseException - The specified resource is in use.

See Also:

AWS API Documentation

deleteDataset
```
DeleteDatasetResult deleteDataset(DeleteDatasetRequest deleteDatasetRequest)
```
Deletes a dataset. You can't delete a dataset if an associated DatasetImportJob or SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on datasets, see CreateDataset.

Parameters:

deleteDatasetRequest -

Returns:

Result of the DeleteDataset operation returned by the service.

Throws:

InvalidInputException - Provide a valid value for the field or parameter.

ResourceNotFoundException - Could not find the specified resource.

ResourceInUseException - The specified resource is in use.

See Also:

AWS API Documentation

deleteDatasetGroup
```
DeleteDatasetGroupResult deleteDatasetGroup(DeleteDatasetGroupRequest deleteDatasetGroupRequest)
```
Deletes a dataset group. Before you delete a dataset group, you must delete the following:
- All associated event trackers.
- All associated solutions.
- All datasets in the dataset group.
Parameters:

deleteDatasetGroupRequest -

Returns:

Result of the DeleteDatasetGroup operation returned by the service.

Throws:

InvalidInputException - Provide a valid value for the field or parameter.

ResourceNotFoundException - Could not find the specified resource.

ResourceInUseException - The specified resource is in use.

See Also:

AWS API Documentation

deleteEventTracker
```
DeleteEventTrackerResult deleteEventTracker(DeleteEventTrackerRequest deleteEventTrackerRequest)
```
Deletes the event tracker. Does not delete the event-interactions dataset from the associated dataset group. For more information on event trackers, see CreateEventTracker.

Parameters:

deleteEventTrackerRequest -

Returns:

Result of the DeleteEventTracker operation returned by the service.

Throws:

InvalidInputException - Provide a valid value for the field or parameter.

ResourceNotFoundException - Could not find the specified resource.

ResourceInUseException - The specified resource is in use.

See Also:

AWS API Documentation

deleteFilter
```
DeleteFilterResult deleteFilter(DeleteFilterRequest deleteFilterRequest)
```
Deletes a filter.

Parameters:

deleteFilterRequest -

Returns:

Result of the DeleteFilter operation returned by the service.

Throws:

InvalidInputException - Provide a valid value for the field or parameter.

ResourceNotFoundException - Could not find the specified resource.

ResourceInUseException - The specified resource is in use.

See Also:

AWS API Documentation

deleteSchema
```
DeleteSchemaResult deleteSchema(DeleteSchemaRequest deleteSchemaRequest)
```
Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema.

Parameters:

deleteSchemaRequest -

Returns:

Result of the DeleteSchema operation returned by the service.

Throws:

InvalidInputException - Provide a valid value for the field or parameter.

ResourceNotFoundException - Could not find the specified resource.

ResourceInUseException - The specified resource is in use.

See Also:

AWS API Documentation

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

Parameters:

deleteSolutionRequest -

Returns:

Result of the DeleteSolution operation returned by the service.

Throws:

InvalidInputException - Provide a valid value for the field or parameter.

ResourceNotFoundException - Could not find the specified resource.

ResourceInUseException - The specified resource is in use.

See Also:

AWS API Documentation

describeAlgorithm
```
DescribeAlgorithmResult describeAlgorithm(DescribeAlgorithmRequest describeAlgorithmRequest)
```
Describes the given algorithm.

Parameters:

describeAlgorithmRequest -

Returns:

Result of the DescribeAlgorithm operation returned by the service.

Throws:

InvalidInputException - Provide a valid value for the field or parameter.

ResourceNotFoundException - Could not find the specified resource.

See Also:

AWS API Documentation

describeBatchInferenceJob
```
DescribeBatchInferenceJobResult describeBatchInferenceJob(DescribeBatchInferenceJobRequest describeBatchInferenceJobRequest)
```
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.

Parameters:

describeBatchInferenceJobRequest -

Returns:

Result of the DescribeBatchInferenceJob operation returned by the service.

Throws:

InvalidInputException - Provide a valid value for the field or parameter.

ResourceNotFoundException - Could not find the specified resource.

See Also:

AWS API Documentation

describeCampaign
```
DescribeCampaignResult describeCampaign(DescribeCampaignRequest describeCampaignRequest)
```
Describes the given campaign, including its status.

A campaign can be in one of the following states:
- CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
- DELETE PENDING > DELETE IN_PROGRESS
When the status is CREATE FAILED, the response includes the failureReason key, which describes why.

For more information on campaigns, see CreateCampaign.
Parameters:

describeCampaignRequest -

Returns:

Result of the DescribeCampaign operation returned by the service.

Throws:

InvalidInputException - Provide a valid value for the field or parameter.

ResourceNotFoundException - Could not find the specified resource.

See Also:

AWS API Documentation

describeDataset
```
DescribeDatasetResult describeDataset(DescribeDatasetRequest describeDatasetRequest)
```
Describes the given dataset. For more information on datasets, see CreateDataset.

Parameters:

describeDatasetRequest -

Returns:

Result of the DescribeDataset operation returned by the service.

Throws:

InvalidInputException - Provide a valid value for the field or parameter.

ResourceNotFoundException - Could not find the specified resource.

See Also:

AWS API Documentation

describeDatasetExportJob
```
DescribeDatasetExportJobResult describeDatasetExportJob(DescribeDatasetExportJobRequest describeDatasetExportJobRequest)
```
Describes the dataset export job created by CreateDatasetExportJob, including the export job status.

Parameters:

describeDatasetExportJobRequest -

Returns:

Result of the DescribeDatasetExportJob operation returned by the service.

Throws:

InvalidInputException - Provide a valid value for the field or parameter.

ResourceNotFoundException - Could not find the specified resource.

See Also:

AWS API Documentation

describeDatasetGroup
```
DescribeDatasetGroupResult describeDatasetGroup(DescribeDatasetGroupRequest describeDatasetGroupRequest)
```
Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.

Parameters:

describeDatasetGroupRequest -

Returns:

Result of the DescribeDatasetGroup operation returned by the service.

Throws:

InvalidInputException - Provide a valid value for the field or parameter.

ResourceNotFoundException - Could not find the specified resource.

See Also:

AWS API Documentation

describeDatasetImportJob
```
DescribeDatasetImportJobResult describeDatasetImportJob(DescribeDatasetImportJobRequest describeDatasetImportJobRequest)
```
Describes the dataset import job created by CreateDatasetImportJob, including the import job status.

Parameters:

describeDatasetImportJobRequest -

Returns:

Result of the DescribeDatasetImportJob operation returned by the service.

Throws:

InvalidInputException - Provide a valid value for the field or parameter.

ResourceNotFoundException - Could not find the specified resource.

See Also:

AWS API Documentation

describeEventTracker
```
DescribeEventTrackerResult describeEventTracker(DescribeEventTrackerRequest describeEventTrackerRequest)
```
Describes an event tracker. The response includes the trackingId and status of the event tracker. For more information on event trackers, see CreateEventTracker.

Parameters:

describeEventTrackerRequest -

Returns:

Result of the DescribeEventTracker operation returned by the service.

Throws:

InvalidInputException - Provide a valid value for the field or parameter.

ResourceNotFoundException - Could not find the specified resource.

See Also:

AWS API Documentation

describeFeatureTransformation
```
DescribeFeatureTransformationResult describeFeatureTransformation(DescribeFeatureTransformationRequest describeFeatureTransformationRequest)
```
Describes the given feature transformation.

Parameters:

describeFeatureTransformationRequest -

Returns:

Result of the DescribeFeatureTransformation operation returned by the service.

Throws:

InvalidInputException - Provide a valid value for the field or parameter.

ResourceNotFoundException - Could not find the specified resource.

See Also:

AWS API Documentation

describeFilter
```
DescribeFilterResult describeFilter(DescribeFilterRequest describeFilterRequest)
```
Describes a filter's properties.

Parameters:

describeFilterRequest -

Returns:

Result of the DescribeFilter operation returned by the service.

Throws:

InvalidInputException - Provide a valid value for the field or parameter.

ResourceNotFoundException - Could not find the specified resource.

See Also:

AWS API Documentation

describeRecipe
```
DescribeRecipeResult describeRecipe(DescribeRecipeRequest describeRecipeRequest)
```
Describes a recipe.

A recipe contains three items:
- An algorithm that trains a model.
- Hyperparameters that govern the training.
- Feature transformation information for modifying the input data before training.
Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a solution with the CreateSolution API. CreateSolution trains a model by using the algorithm in the specified recipe and a training dataset. The solution, when deployed as a campaign, can provide recommendations using the GetRecommendations API.
Parameters:

describeRecipeRequest -

Returns:

Result of the DescribeRecipe operation returned by the service.

Throws:

InvalidInputException - Provide a valid value for the field or parameter.

ResourceNotFoundException - Could not find the specified resource.

See Also:

AWS API Documentation

describeSchema
```
DescribeSchemaResult describeSchema(DescribeSchemaRequest describeSchemaRequest)
```
Describes a schema. For more information on schemas, see CreateSchema.

Parameters:

describeSchemaRequest -

Returns:

Result of the DescribeSchema operation returned by the service.

Throws:

InvalidInputException - Provide a valid value for the field or parameter.

ResourceNotFoundException - Could not find the specified resource.

See Also:

AWS API Documentation

describeSolution
```
DescribeSolutionResult describeSolution(DescribeSolutionRequest describeSolutionRequest)
```
Describes a solution. For more information on solutions, see CreateSolution.

Parameters:

describeSolutionRequest -

Returns:

Result of the DescribeSolution operation returned by the service.

Throws:

InvalidInputException - Provide a valid value for the field or parameter.

ResourceNotFoundException - Could not find the specified resource.

See Also:

AWS API Documentation

describeSolutionVersion
```
DescribeSolutionVersionResult describeSolutionVersion(DescribeSolutionVersionRequest describeSolutionVersionRequest)
```
Describes a specific version of a solution. For more information on solutions, see CreateSolution.

Parameters:

describeSolutionVersionRequest -

Returns:

Result of the DescribeSolutionVersion operation returned by the service.

Throws:

InvalidInputException - Provide a valid value for the field or parameter.

ResourceNotFoundException - Could not find the specified resource.

See Also:

AWS API Documentation

getSolutionMetrics
```
GetSolutionMetricsResult getSolutionMetrics(GetSolutionMetricsRequest getSolutionMetricsRequest)
```
Gets the metrics for the specified solution version.

Parameters:

getSolutionMetricsRequest -

Returns:

Result of the GetSolutionMetrics operation returned by the service.

Throws:

InvalidInputException - Provide a valid value for the field or parameter.

ResourceNotFoundException - Could not find the specified resource.

ResourceInUseException - The specified resource is in use.

See Also:

AWS API Documentation

listBatchInferenceJobs
```
ListBatchInferenceJobsResult listBatchInferenceJobs(ListBatchInferenceJobsRequest listBatchInferenceJobsRequest)
```
Gets a list of the batch inference jobs that have been performed off of a solution version.

Parameters:

listBatchInferenceJobsRequest -

Returns:

Result of the ListBatchInferenceJobs operation returned by the service.

Throws:

InvalidInputException - Provide a valid value for the field or parameter.

InvalidNextTokenException - The token is not valid.

See Also:

AWS API Documentation

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

Parameters:

listCampaignsRequest -

Returns:

Result of the ListCampaigns operation returned by the service.

Throws:

InvalidInputException - Provide a valid value for the field or parameter.

InvalidNextTokenException - The token is not valid.

See Also:

AWS API Documentation

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

Parameters:

listDatasetExportJobsRequest -

Returns:

Result of the ListDatasetExportJobs operation returned by the service.

Throws:

InvalidInputException - Provide a valid value for the field or parameter.

InvalidNextTokenException - The token is not valid.

See Also:

AWS API Documentation

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

Parameters:

listDatasetGroupsRequest -

Returns:

Result of the ListDatasetGroups operation returned by the service.

Throws:

InvalidNextTokenException - The token is not valid.

See Also:

AWS API Documentation

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

Parameters:

listDatasetImportJobsRequest -

Returns:

Result of the ListDatasetImportJobs operation returned by the service.

Throws:

InvalidInputException - Provide a valid value for the field or parameter.

InvalidNextTokenException - The token is not valid.

See Also:

AWS API Documentation

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

Parameters:

listDatasetsRequest -

Returns:

Result of the ListDatasets operation returned by the service.

Throws:

InvalidInputException - Provide a valid value for the field or parameter.

InvalidNextTokenException - The token is not valid.

See Also:

AWS API Documentation

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

Parameters:

listEventTrackersRequest -

Returns:

Result of the ListEventTrackers operation returned by the service.

Throws:

InvalidInputException - Provide a valid value for the field or parameter.

InvalidNextTokenException - The token is not valid.

See Also:

AWS API Documentation

listFilters
```
ListFiltersResult listFilters(ListFiltersRequest listFiltersRequest)
```
Lists all filters that belong to a given dataset group.

Parameters:

listFiltersRequest -

Returns:

Result of the ListFilters operation returned by the service.

Throws:

InvalidInputException - Provide a valid value for the field or parameter.

InvalidNextTokenException - The token is not valid.

See Also:

AWS API Documentation

listRecipes
```
ListRecipesResult listRecipes(ListRecipesRequest listRecipesRequest)
```
Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).

Parameters:

listRecipesRequest -

Returns:

Result of the ListRecipes operation returned by the service.

Throws:

InvalidNextTokenException - The token is not valid.

See Also:

AWS API Documentation

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

Parameters:

listSchemasRequest -

Returns:

Result of the ListSchemas operation returned by the service.

Throws:

InvalidNextTokenException - The token is not valid.

See Also:

AWS API Documentation

listSolutionVersions
```
ListSolutionVersionsResult listSolutionVersions(ListSolutionVersionsRequest listSolutionVersionsRequest)
```
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 CreateSolution.

Parameters:

listSolutionVersionsRequest -

Returns:

Result of the ListSolutionVersions operation returned by the service.

Throws:

InvalidInputException - Provide a valid value for the field or parameter.

ResourceNotFoundException - Could not find the specified resource.

InvalidNextTokenException - The token is not valid.

See Also:

AWS API Documentation

listSolutions
```
ListSolutionsResult listSolutions(ListSolutionsRequest listSolutionsRequest)
```
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 CreateSolution.

Parameters:

listSolutionsRequest -

Returns:

Result of the ListSolutions operation returned by the service.

Throws:

InvalidInputException - Provide a valid value for the field or parameter.

InvalidNextTokenException - The token is not valid.

See Also:

AWS API Documentation

stopSolutionVersionCreation
```
StopSolutionVersionCreationResult stopSolutionVersionCreation(StopSolutionVersionCreationRequest stopSolutionVersionCreationRequest)
```
Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS.

Depending on the current state of the solution version, the solution version state changes as follows:
- CREATE_PENDING > CREATE_STOPPED
  
  or
- CREATE_IN_PROGRESS > CREATE_STOPPING > CREATE_STOPPED
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.
Parameters:

stopSolutionVersionCreationRequest -

Returns:

Result of the StopSolutionVersionCreation operation returned by the service.

Throws:

InvalidInputException - Provide a valid value for the field or parameter.

ResourceNotFoundException - Could not find the specified resource.

ResourceInUseException - The specified resource is in use.

See Also:

AWS API Documentation

updateCampaign
```
UpdateCampaignResult updateCampaign(UpdateCampaignRequest updateCampaignRequest)
```
Updates a campaign by either deploying a new solution or changing the value of the campaign's minProvisionedTPS parameter.

To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign API.

You must wait until the status of the updated campaign is ACTIVE before asking the campaign for recommendations.

For more information on campaigns, see CreateCampaign.

Parameters:

updateCampaignRequest -

Returns:

Result of the UpdateCampaign operation returned by the service.

Throws:

InvalidInputException - Provide a valid value for the field or parameter.

ResourceNotFoundException - Could not find the specified resource.

ResourceInUseException - The specified resource is in use.

See Also:

AWS API Documentation

shutdown
```
void shutdown()
```
Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.

Did this page help you?

Interface AmazonPersonalize

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

createBatchInferenceJob

createCampaign

createDataset

createDatasetExportJob

createDatasetGroup

createDatasetImportJob

createEventTracker

createFilter

createSchema

createSolution

createSolutionVersion

deleteCampaign

deleteDataset

deleteDatasetGroup

deleteEventTracker

deleteFilter

deleteSchema

deleteSolution

describeAlgorithm

describeBatchInferenceJob

describeCampaign

describeDataset

describeDatasetExportJob

describeDatasetGroup

describeDatasetImportJob

describeEventTracker

describeFeatureTransformation

describeFilter

describeRecipe

describeSchema

describeSolution

describeSolutionVersion

getSolutionMetrics

listBatchInferenceJobs

listCampaigns

listDatasetExportJobs

listDatasetGroups

listDatasetImportJobs

listDatasets

listEventTrackers

listFilters

listRecipes

listSchemas

listSolutionVersions

listSolutions

stopSolutionVersionCreation

updateCampaign

shutdown

getCachedResponseMetadata