openapi: 3.0.0
info:
version: 2016-12-01
x-release: v4
title: Amazon Pinpoint Applications Recommenders API
description: Doc Engage API - Amazon Pinpoint API
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: pinpoint
x-aws-signingName: mobiletargeting
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/pinpoint-2016-12-01.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://pinpoint.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Amazon Pinpoint multi-region endpoint
- url: https://pinpoint.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Amazon Pinpoint multi-region endpoint
- url: http://pinpoint.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon Pinpoint endpoint for China (Beijing) and China (Ningxia)
- url: https://pinpoint.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon Pinpoint endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Recommenders
paths:
/v1/recommenders:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateRecommenderConfiguration
description: Creates an Amazon Pinpoint configuration for a recommender model.
responses:
'201':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateRecommenderConfigurationResponse'
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
'482':
description: PayloadTooLargeException
content:
application/json:
schema:
$ref: '#/components/schemas/PayloadTooLargeException'
'483':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
'484':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'485':
description: MethodNotAllowedException
content:
application/json:
schema:
$ref: '#/components/schemas/MethodNotAllowedException'
'486':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- CreateRecommenderConfiguration
properties:
CreateRecommenderConfiguration:
description: Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.
type: object
properties:
Attributes:
allOf:
- $ref: '#/components/schemas/MapOf__string'
- description: <p>A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.</p> <p>In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the <b>Attribute finder</b> of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:</p> <ul><li><p>An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.</p></li> <li><p>An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).</p></li></ul> <p>This object is required if the configuration invokes an AWS Lambda function (RecommendationTransformerUri) to process recommendation data. Otherwise, don't include this object in your request.</p>
Description:
allOf:
- $ref: '#/components/schemas/__string'
- description: 'A custom description of the configuration for the recommender model. The description can contain up to 128 characters. The characters can be letters, numbers, spaces, or the following symbols: _ ; () , ‐.'
Name:
allOf:
- $ref: '#/components/schemas/__string'
- description: A custom name of the configuration for the recommender model. The name must start with a letter or number and it can contain up to 128 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).
RecommendationProviderIdType:
allOf:
- $ref: '#/components/schemas/__string'
- description: <p>The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are:</p> <ul><li><p>PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.</p></li> <li><p>PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.</p></li></ul>
RecommendationProviderRoleArn:
allOf:
- $ref: '#/components/schemas/__string'
- description: The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.
RecommendationProviderUri:
allOf:
- $ref: '#/components/schemas/__string'
- description: The Amazon Resource Name (ARN) of the recommender model to retrieve recommendation data from. This value must match the ARN of an Amazon Personalize campaign.
RecommendationTransformerUri:
allOf:
- $ref: '#/components/schemas/__string'
- description: The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke for additional processing of recommendation data that's retrieved from the recommender model.
RecommendationsDisplayName:
allOf:
- $ref: '#/components/schemas/__string'
- description: <p>A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.</p> <p>This name appears in the <b>Attribute finder</b> of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.</p>
RecommendationsPerMessage:
allOf:
- $ref: '#/components/schemas/__integer'
- description: <p>The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables. The minimum value is 1. The maximum value is 5. The default value is 5.</p> <p>To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.</p>
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Amazon Pinpoint Create Recommender Configuration
tags:
- Recommenders
get:
operationId: GetRecommenderConfigurations
description: Retrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetRecommenderConfigurationsResponse'
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
'482':
description: PayloadTooLargeException
content:
application/json:
schema:
$ref: '#/components/schemas/PayloadTooLargeException'
'483':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
'484':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'485':
description: MethodNotAllowedException
content:
application/json:
schema:
$ref: '#/components/schemas/MethodNotAllowedException'
'486':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
parameters:
- name: page-size
in: query
required: false
description: The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
schema:
type: string
- name: token
in: query
required: false
description: The NextToken string that specifies which page of results to return in a paginated response.
schema:
type: string
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Amazon Pinpoint Get Recommender Configurations
tags:
- Recommenders
/v1/recommenders/{recommender-id}:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
delete:
operationId: DeleteRecommenderConfiguration
description: Deletes an Amazon Pinpoint configuration for a recommender model.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteRecommenderConfigurationResponse'
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
'482':
description: PayloadTooLargeException
content:
application/json:
schema:
$ref: '#/components/schemas/PayloadTooLargeException'
'483':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
'484':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'485':
description: MethodNotAllowedException
content:
application/json:
schema:
$ref: '#/components/schemas/MethodNotAllowedException'
'486':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
parameters:
- name: recommender-id
in: path
required: true
description: The unique identifier for the recommender model configuration. This identifier is displayed as the <b>Recommender ID</b> on the Amazon Pinpoint console.
schema:
type: string
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Amazon Pinpoint Delete Recommender Configuration
tags:
- Recommenders
get:
operationId: GetRecommenderConfiguration
description: Retrieves information about an Amazon Pinpoint configuration for a recommender model.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetRecommenderConfigurationResponse'
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
'482':
description: PayloadTooLargeException
content:
application/json:
schema:
$ref: '#/components/schemas/PayloadTooLargeException'
'483':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
'484':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'485':
description: MethodNotAllowedException
content:
application/json:
schema:
$ref: '#/components/schemas/MethodNotAllowedException'
'486':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
parameters:
- name: recommender-id
in: path
required: true
description: The unique identifier for the recommender model configuration. This identifier is displayed as the <b>Recommender ID</b> on the Amazon Pinpoint console.
schema:
type: string
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Amazon Pinpoint Get Recommender Configuration
tags:
- Recommenders
put:
operationId: UpdateRecommenderConfiguration
description: Updates an Amazon Pinpoint configuration for a recommender model.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateRecommenderConfigurationResponse'
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
'482':
description: PayloadTooLargeException
content:
application/json:
schema:
$ref: '#/components/schemas/PayloadTooLargeException'
'483':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
'484':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'485':
description: MethodNotAllowedException
content:
application/json:
schema:
$ref: '#/components/schemas/MethodNotAllowedException'
'486':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
parameters:
- name: recommender-id
in: path
required: true
description: The unique identifier for the recommender model configuration. This identifier is displayed as the <b>Recommender ID</b> on the Amazon Pinpoint console.
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- UpdateRecommenderConfiguration
properties:
UpdateRecommenderConfiguration:
description: Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.
type: object
properties:
Attributes:
allOf:
- $ref: '#/components/schemas/MapOf__string'
- description: <p>A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.</p> <p>In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the <b>Attribute finder</b> of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:</p> <ul><li><p>An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.</p></li> <li><p>An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).</p></li></ul> <p>This object is required if the configuration invokes an AWS Lambda function (RecommendationTransformerUri) to process recommendation data. Otherwise, don't include this object in your request.</p>
Description:
allOf:
- $ref: '#/components/schemas/__string'
- description: 'A custom description of the configuration for the recommender model. The description can contain up to 128 characters. The characters can be letters, numbers, spaces, or the following symbols: _ ; () , ‐.'
Name:
allOf:
- $ref: '#/components/schemas/__string'
- description: A custom name of the configuration for the recommender model. The name must start with a letter or number and it can contain up to 128 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).
RecommendationProviderIdType:
allOf:
- $ref: '#/components/schemas/__string'
- description: <p>The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are:</p> <ul><li><p>PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.</p></li> <li><p>PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.</p></li></ul>
RecommendationProviderRoleArn:
allOf:
- $ref: '#/components/schemas/__string'
- description: The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.
RecommendationProviderUri:
allOf:
- $ref: '#/components/schemas/__string'
- description: The Amazon Resource Name (ARN) of the recommender model to retrieve recommendation data from. This value must match the ARN of an Amazon Personalize campaign.
RecommendationTransformerUri:
allOf:
- $ref: '#/components/schemas/__string'
- description: The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke for additional processing of recommendation data that's retrieved from the recommender model.
RecommendationsDisplayName:
allOf:
- $ref: '#/components/schemas/__string'
- description: <p>A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.</p> <p>This name appears in the <b>Attribute finder</b> of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.</p>
RecommendationsPerMessage:
allOf:
- $ref: '#/components/schemas/__integer'
- description: <p>The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables. The minimum value is 1. The maximum value is 5. The default value is 5.</p> <p>To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.</p>
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Amazon Pinpoint Update Recommender Configuration
tags:
- Recommenders
components:
schemas:
MethodNotAllowedException: {}
ListRecommenderConfigurationsResponse:
type: object
required:
- Item
properties:
Item:
allOf:
- $ref: '#/components/schemas/ListOfRecommenderConfigurationResponse'
- description: An array of responses, one for each recommender model configuration that's associated with your Amazon Pinpoint account.
NextToken:
allOf:
- $ref: '#/components/schemas/__string'
- description: The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
description: Provides information about all the recommender model configurations that are associated with your Amazon Pinpoint account.
GetRecommenderConfigurationResponse:
type: object
required:
- RecommenderConfigurationResponse
properties:
RecommenderConfigurationResponse:
$ref: '#/components/schemas/RecommenderConfigurationResponse'
ForbiddenException: {}
GetRecommenderConfigurationsResponse:
type: object
required:
- ListRecommenderConfigurationsResponse
properties:
ListRecommenderConfigurationsResponse:
$ref: '#/components/schemas/ListRecommenderConfigurationsResponse'
ListOfRecommenderConfigurationResponse:
type: array
items:
$ref: '#/components/schemas/RecommenderConfigurationResponse'
__string:
type: string
CreateRecommenderConfigurationResponse:
type: object
required:
- RecommenderConfigurationResponse
properties:
RecommenderConfigurationResponse:
$ref: '#/components/schemas/RecommenderConfigurationResponse'
__integer:
type: integer
PayloadTooLargeException: {}
DeleteRecommenderConfigurationResponse:
type: object
required:
- RecommenderConfigurationResponse
properties:
RecommenderConfigurationResponse:
$ref: '#/components/schemas/RecommenderConfigurationResponse'
NotFoundException: {}
BadRequestException: {}
InternalServerErrorException: {}
UpdateRecommenderConfigurationResponse:
type: object
required:
- RecommenderConfigurationResponse
properties:
RecommenderConfigurationResponse:
$ref: '#/components/schemas/RecommenderConfigurationResponse'
TooManyRequestsException: {}
RecommenderConfigurationResponse:
type: object
required:
- RecommendationProviderUri
- LastModifiedDate
- CreationDate
- RecommendationProviderRoleArn
- Id
properties:
Attributes:
allOf:
- $ref: '#/components/schemas/MapOf__string'
- description: <p>A map that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.</p> <p>This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.</p>
CreationDate:
allOf:
- $ref: '#/components/schemas/__string'
- description: The date, in extended ISO 8601 format, when the configuration was created for the recommender model.
Description:
allOf:
- $ref: '#/components/schemas/__string'
- description: The custom description of the configuration for the recommender model.
Id:
allOf:
- $ref: '#/components/schemas/__string'
- description: The unique identifier for the recommender model configuration.
LastModifiedDate:
allOf:
- $ref: '#/components/schemas/__string'
- description: The date, in extended ISO 8601 format, when the configuration for the recommender model was last modified.
Name:
allOf:
- $ref: '#/components/schemas/__string'
- description: The custom name of the configuration for the recommender model.
RecommendationProviderIdType:
allOf:
- $ref: '#/components/schemas/__string'
- description: <p>The type of Amazon Pinpoint ID that's associated with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Possible values are:</p> <ul><li><p>PINPOINT_ENDPOINT_ID - Each user in the model is associated with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs
# --- truncated at 32 KB (35 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/openapi/amazon-pinpoint-recommenders-api-openapi.yml