recommender_configurations

Creates, updates, deletes, gets or lists a recommender_configurations resource.

Overview

Name	recommender_configurations
Type	Resource
Id	aws.pinpoint.recommender_configurations

Fields

The following fields are returned by SELECT queries:

get_recommender_configuration

Name	Datatype	Description
attributes	object	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. This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
creation_date	string	The date, in extended ISO 8601 format, when the configuration was created for the recommender model.
description	string	The custom description of the configuration for the recommender model.
id	string	The unique identifier for the recommender model configuration.
last_modified_date	string	The date, in extended ISO 8601 format, when the configuration for the recommender model was last modified.
name	string	The custom name of the configuration for the recommender model.
recommendation_provider_id_type	string	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: 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 in Amazon Pinpoint. This is the default value. PINPOINT_USER_ID - Each user in the model is associated with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If this value is specified, 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.
recommendation_provider_role_arn	string	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.
recommendation_provider_uri	string	The Amazon Resource Name (ARN) of the recommender model that Amazon Pinpoint retrieves the recommendation data from. This value is the ARN of an Amazon Personalize campaign.
recommendation_transformer_uri	string	The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to perform additional processing of recommendation data that it retrieves from the recommender model.
recommendations_display_name	string	The 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 name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
recommendations_per_message	integer	The number of recommended items that are retrieved 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.

get_recommender_configurations

Name	Datatype	Description
item	array	An array of responses, one for each recommender model configuration that's associated with your Amazon Pinpoint account.
next_token	string	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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_recommender_configuration	select	recommender-id, region		Retrieves information about an Amazon Pinpoint configuration for a recommender model.
get_recommender_configurations	select	region	page-size, token	Retrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account.
create_recommender_configuration	insert	region, CreateRecommenderConfiguration		Creates an Amazon Pinpoint configuration for a recommender model.
update_recommender_configuration	update	recommender-id, region, UpdateRecommenderConfiguration		Updates an Amazon Pinpoint configuration for a recommender model.
delete_recommender_configuration	delete	recommender-id, region		Deletes an Amazon Pinpoint configuration for a recommender model.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
recommender-id	string	The unique identifier for the recommender model configuration. This identifier is displayed as the Recommender ID on the Amazon Pinpoint console.
region	string	AWS region (default: us-east-1)
page-size	string	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.
token	string	The NextToken string that specifies which page of results to return in a paginated response.

SELECT examples

get_recommender_configuration

Retrieves information about an Amazon Pinpoint configuration for a recommender model.

SELECT
attributes,
creation_date,
description,
id,
last_modified_date,
name,
recommendation_provider_id_type,
recommendation_provider_role_arn,
recommendation_provider_uri,
recommendation_transformer_uri,
recommendations_display_name,
recommendations_per_message
FROM aws.pinpoint.recommender_configurations
WHERE `recommender-id` = '{{ recommender-id }}' -- required
AND region = '{{ region }}' -- required
;

get_recommender_configurations

Retrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account.

SELECT
item,
next_token
FROM aws.pinpoint.recommender_configurations
WHERE region = '{{ region }}' -- required
AND `page-size` = '{{ page-size }}'
AND token = '{{ token }}'
;

INSERT examples

create_recommender_configuration

Creates an Amazon Pinpoint configuration for a recommender model.

INSERT INTO aws.pinpoint.recommender_configurations (
CreateRecommenderConfiguration,
region
)
SELECT 
'{{ CreateRecommenderConfiguration }}' /* required */,
'{{ region }}'
RETURNING
recommender_configuration_response
;

Manifest

# Description fields are for documentation purposes
- name: recommender_configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the recommender_configurations resource.
  - name: CreateRecommenderConfiguration
    description: |
      Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.
    value:
      Attributes: "{{ Attributes }}"
      Description: "{{ Description }}"
      Name: "{{ Name }}"
      RecommendationProviderIdType: "{{ RecommendationProviderIdType }}"
      RecommendationProviderRoleArn: "{{ RecommendationProviderRoleArn }}"
      RecommendationProviderUri: "{{ RecommendationProviderUri }}"
      RecommendationTransformerUri: "{{ RecommendationTransformerUri }}"
      RecommendationsDisplayName: "{{ RecommendationsDisplayName }}"
      RecommendationsPerMessage: {{ RecommendationsPerMessage }}

UPDATE examples

update_recommender_configuration

Updates an Amazon Pinpoint configuration for a recommender model.

UPDATE aws.pinpoint.recommender_configurations
SET 
UpdateRecommenderConfiguration = '{{ UpdateRecommenderConfiguration }}'
WHERE 
`recommender-id` = '{{ recommender-id }}' --required
AND region = '{{ region }}' --required
AND UpdateRecommenderConfiguration = '{{ UpdateRecommenderConfiguration }}' --required
RETURNING
recommender_configuration_response;

DELETE examples

delete_recommender_configuration

Deletes an Amazon Pinpoint configuration for a recommender model.

DELETE FROM aws.pinpoint.recommender_configurations
WHERE `recommender-id` = '{{ recommender-id }}' --required
AND region = '{{ region }}' --required
;