Amazon Personalize Personalize Filter API
The Personalize Filter API from Amazon Personalize — 4 operation(s) for personalize filter.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-personalize:amazon-personalize-filter-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Amazon Personalize Filter API
version: '2018-05-22'
description: Generated from AWS's published Smithy model for Amazon Personalize. 4 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://personalize.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
tags:
- name: Filter
paths:
/#CreateFilter:
post:
operationId: CreateFilter
summary: Create Filter
description: Creates a recommendation filter. For more information, see Filtering recommendations and user segments.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/CreateFilterResponse'
'400':
description: InvalidInputException; TooManyTagsException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/InvalidInputException'
'409':
description: LimitExceededException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/LimitExceededException'
'403':
description: ResourceAlreadyExistsException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ResourceAlreadyExistsException'
'404':
description: ResourceNotFoundException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AmazonPersonalize.CreateFilter
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/CreateFilterRequest'
tags:
- Filter
/#DeleteFilter:
post:
operationId: DeleteFilter
summary: Delete Filter
description: Deletes a filter.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
type: string
'400':
description: InvalidInputException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/InvalidInputException'
'409':
description: ResourceInUseException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ResourceInUseException'
'404':
description: ResourceNotFoundException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AmazonPersonalize.DeleteFilter
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DeleteFilterRequest'
tags:
- Filter
/#DescribeFilter:
post:
operationId: DescribeFilter
summary: Describe Filter
description: Describes a filter's properties.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DescribeFilterResponse'
'400':
description: InvalidInputException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/InvalidInputException'
'404':
description: ResourceNotFoundException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AmazonPersonalize.DescribeFilter
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DescribeFilterRequest'
tags:
- Filter
/#ListFilters:
post:
operationId: ListFilters
summary: List Filters
description: Lists all filters that belong to a given dataset group.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ListFiltersResponse'
'400':
description: InvalidInputException; InvalidNextTokenException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/InvalidInputException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AmazonPersonalize.ListFilters
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ListFiltersRequest'
tags:
- Filter
components:
schemas:
DescribeFilterRequest:
type: object
properties:
filterArn:
type: string
description: The ARN of the filter to describe.
required:
- filterArn
LimitExceededException:
type: object
properties:
message:
type: string
Filter:
type: object
properties:
name:
type: string
description: The name of the filter.
filterArn:
type: string
description: The ARN of the filter.
creationDateTime:
type: string
format: date-time
description: The time at which the filter was created.
lastUpdatedDateTime:
type: string
format: date-time
description: The time at which the filter was last updated.
datasetGroupArn:
type: string
description: The ARN of the dataset group to which the filter belongs.
failureReason:
type: string
description: If the filter failed, the reason for its failure.
filterExpression:
type: string
description: Specifies the type of item interactions to filter out of recommendation results. The filter expression must follow specific format rules. For information about filter expression structure and syntax, see Filter expressions.
status:
type: string
description: The status of the filter.
ListFiltersResponse:
type: object
properties:
Filters:
type: array
items:
$ref: '#/components/schemas/FilterSummary'
description: A list of returned filters.
nextToken:
type: string
description: A token for getting the next set of filters (if they exist).
ResourceNotFoundException:
type: object
properties:
message:
type: string
ResourceInUseException:
type: object
properties:
message:
type: string
ResourceAlreadyExistsException:
type: object
properties:
message:
type: string
Tag:
type: object
properties:
tagKey:
type: string
description: One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
tagValue:
type: string
description: The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).
required:
- tagKey
- tagValue
CreateFilterRequest:
type: object
properties:
name:
type: string
description: The name of the filter to create.
datasetGroupArn:
type: string
description: The ARN of the dataset group that the filter will belong to.
filterExpression:
type: string
description: 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.
tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: A list of tags to apply to the filter.
required:
- name
- datasetGroupArn
- filterExpression
CreateFilterResponse:
type: object
properties:
filterArn:
type: string
description: The ARN of the new filter.
ListFiltersRequest:
type: object
properties:
datasetGroupArn:
type: string
description: The ARN of the dataset group that contains the filters.
nextToken:
type: string
description: A token returned from the previous call to ListFilters for getting the next set of filters (if they exist).
maxResults:
type: integer
description: The maximum number of filters to return.
FilterSummary:
type: object
properties:
name:
type: string
description: The name of the filter.
filterArn:
type: string
description: The ARN of the filter.
creationDateTime:
type: string
format: date-time
description: The time at which the filter was created.
lastUpdatedDateTime:
type: string
format: date-time
description: The time at which the filter was last updated.
datasetGroupArn:
type: string
description: The ARN of the dataset group to which the filter belongs.
failureReason:
type: string
description: If the filter failed, the reason for the failure.
status:
type: string
description: The status of the filter.
InvalidInputException:
type: object
properties:
message:
type: string
DeleteFilterRequest:
type: object
properties:
filterArn:
type: string
description: The ARN of the filter to delete.
required:
- filterArn
DescribeFilterResponse:
type: object
properties:
filter:
$ref: '#/components/schemas/Filter'
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: personalize
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/personalize/service/2018-05-22/personalize-2018-05-22.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)