# Amazon Personalize API

> Amazon Personalize API on Apizie: 67 endpoints (Creates a batch inference job. The operation can handle up to 50 million records and the input file must be…, Creates a batch segment job. The operation can handle up to 50 million records and the input file must be in…, Creates a campaign that deploys a solution version. When a client calls the GetRecommendations and…, Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import…, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:amazonaws-personalize`
- Category: Cloud
- Status: byok
- Source: https://github.com/mermade/aws2openapi
- Page: https://zieapi.vercel.app/api/cloud/amazonaws-personalize
- OpenAPI: https://zieapi.vercel.app/api/cloud/amazonaws-personalize/openapi.json

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

## Endpoints

### Creates a batch inference job. The operation can handle up to 50 million records and the input file must be…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/create-batch-inference-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Creates a batch segment job. The operation can handle up to 50 million records and the input file must be in…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/create-batch-segment-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Creates a campaign that deploys a solution version. When a client calls the GetRecommendations and…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/create-campaign` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/create-dataset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Creates a job that exports data from your dataset to an Amazon S3 bucket. To allow Amazon Personalize to…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/create-dataset-export-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Creates an empty dataset group. A dataset group is a container for Amazon Personalize resources. A dataset…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/create-dataset-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/create-dataset-import-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Creates an event tracker that you use when adding event data to a specified dataset group using the…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/create-event-tracker` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Creates a recommendation filter. For more information, see Filtering recommendations and user segments .
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/create-filter` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Creates a metric attribution. A metric attribution creates reports on the data that you import into Amazon…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/create-metric-attribution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Creates a recommender with the recipe (a Domain dataset group use case) you specify. You create recommenders…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/create-recommender` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/create-schema` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Creates the configuration for training a model. A trained model is known as a solution version. After the…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/create-solution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Trains or retrains an active solution in a Custom dataset group. A solution is created using the…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/create-solution-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Removes a campaign by deleting the solution deployment. The solution that the campaign is based on is not…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/delete-campaign` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Deletes a dataset. You can't delete a dataset if an associated DatasetImportJob or SolutionVersion is in the…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/delete-dataset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Deletes a dataset group. Before you delete a dataset group, you must delete the following: All associated…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/delete-dataset-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Deletes the event tracker. Does not delete the event-interactions dataset from the associated dataset group.…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/delete-event-tracker` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Deletes a filter.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/delete-filter` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Deletes a metric attribution.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/delete-metric-attribution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Deactivates and removes a recommender. A deleted recommender can no longer be specified in a…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/delete-recommender` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/delete-schema` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Deletes all versions of a solution and the Solution object itself. Before deleting a solution, you must…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/delete-solution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Describes the given algorithm.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/describe-algorithm` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Gets the properties of a batch inference job including name, Amazon Resource Name (ARN), status, input and…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/describe-batch-inference-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Gets the properties of a batch segment job including name, Amazon Resource Name (ARN), status, input and…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/describe-batch-segment-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Describes the given campaign, including its status. A campaign can be in one of the following states: CREATE…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/describe-campaign` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Describes the given dataset. For more information on datasets, see CreateDataset .
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/describe-dataset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Describes the dataset export job created by CreateDatasetExportJob , including the export job status.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/describe-dataset-export-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup .
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/describe-dataset-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Describes the dataset import job created by CreateDatasetImportJob , including the import job status.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/describe-dataset-import-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Describes an event tracker. The response includes the trackingId and status of the event tracker. For more…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/describe-event-tracker` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Describes the given feature transformation.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/describe-feature-transformation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Describes a filter's properties.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/describe-filter` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Describes a metric attribution.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/describe-metric-attribution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Describes a recipe. A recipe contains three items: An algorithm that trains a model. Hyperparameters that…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/describe-recipe` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Describes the given recommender, including its status. A recommender can be in one of the following states:…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/describe-recommender` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Describes a schema. For more information on schemas, see CreateSchema .
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/describe-schema` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Describes a solution. For more information on solutions, see CreateSolution .
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/describe-solution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Describes a specific version of a solution. For more information on solutions, see CreateSolution
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/describe-solution-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Gets the metrics for the specified solution version.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/get-solution-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Gets a list of the batch inference jobs that have been performed off of a solution version.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/list-batch-inference-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | string | no | Pagination limit |
| nextToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/list-batch-segment-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | string | no | Pagination limit |
| nextToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Returns a list of campaigns that use the given solution. When a solution is not specified, all the campaigns…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/list-campaigns` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | string | no | Pagination limit |
| nextToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Returns a list of dataset export jobs that use the given dataset. When a dataset is not specified, all the…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/list-dataset-export-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | string | no | Pagination limit |
| nextToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Returns a list of dataset groups. The response provides the properties for each dataset group, including the…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/list-dataset-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | string | no | Pagination limit |
| nextToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Returns a list of dataset import jobs that use the given dataset. When a dataset is not specified, all the…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/list-dataset-import-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | string | no | Pagination limit |
| nextToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Returns the list of datasets contained in the given dataset group. The response provides the properties for…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/list-datasets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | string | no | Pagination limit |
| nextToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Returns the list of event trackers associated with the account. The response provides the properties for…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/list-event-trackers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | string | no | Pagination limit |
| nextToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Lists all filters that belong to a given dataset group.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/list-filters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | string | no | Pagination limit |
| nextToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Lists the metrics for the metric attribution.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/list-metric-attribution-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | string | no | Pagination limit |
| nextToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Lists metric attributions.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/list-metric-attributions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | string | no | Pagination limit |
| nextToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Returns a list of available recipes. The response provides the properties for each recipe, including the…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/list-recipes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | string | no | Pagination limit |
| nextToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Returns a list of recommenders in a given Domain dataset group. When a Domain dataset group is not…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/list-recommenders` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | string | no | Pagination limit |
| nextToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Returns the list of schemas associated with the account. The response provides the properties for each…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/list-schemas` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | string | no | Pagination limit |
| nextToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Returns a list of solution versions for the given solution. When a solution is not specified, all the…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/list-solution-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | string | no | Pagination limit |
| nextToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Returns a list of solutions that use the given dataset group. When a dataset group is not specified, all the…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/list-solutions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | string | no | Pagination limit |
| nextToken | string | no | Pagination token |
| body | object | no | JSON request body |

### Get a list of tags attached to a resource.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/list-tags-for-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Starts a recommender that is INACTIVE. Starting a recommender does not create any new models, but resumes…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/start-recommender` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Stops a recommender that is ACTIVE. Stopping a recommender halts billing and automatic retraining for the…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/stop-recommender` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS. Depending on…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/stop-solution-version-creation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Add a list of tags to a resource.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/tag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Remove tags that are attached to a resource.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/untag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Updates a campaign by either deploying a new solution or changing the value of the campaign's…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/update-campaign` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Update a dataset to replace its schema with a new or existing one. For more information, see Replacing a…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/update-dataset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Updates a metric attribution.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/update-metric-attribution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

### Updates the recommender to modify the recommender configuration. If you update the recommender to modify the…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/update-recommender` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | no | JSON request body |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/create-batch-inference-job" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Amazon Personalize API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:amazonaws-personalize/create-batch-inference-job with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Amazon Personalize API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Amazon Personalize itself also needs your own key from amazonaws.com.

### Can AI agents use the Amazon Personalize API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:amazonaws-personalize.

### What is the status of the Amazon Personalize API?
Needs your own provider key (bring your own key)