Skip to content

aws.pinpoint.get_recommender_configurations

Example SQL Queries

SELECT * FROM
aws.pinpoint.get_recommender_configurations;

Description

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

Table Definition

Column NameColumn Data Type
page_size Input Column

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.

VARCHAR
token Input Column

The NextToken string that specifies which page of results to return in a paginated response.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
list_recommender_configurations_response

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

STRUCT(
"item" STRUCT(
"attributes" MAP(VARCHAR, VARCHAR),
"creation_date" VARCHAR,
"description" VARCHAR,
"id" VARCHAR,
"last_modified_date" VARCHAR,
"name" VARCHAR,
"recommendation_provider_id_type" VARCHAR,
"recommendation_provider_role_arn" VARCHAR,
"recommendation_provider_uri" VARCHAR,
"recommendation_transformer_uri" VARCHAR,
"recommendations_display_name" VARCHAR,
"recommendations_per_message" BIGINT
)[],
"next_token" VARCHAR
)
Show child fields
list_recommender_configurations_response.item[]
Show child fields
list_recommender_configurations_response.item[].attributes

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.

list_recommender_configurations_response.item[].creation_date

The date, in extended ISO 8601 format, when the configuration was created for the recommender model.

list_recommender_configurations_response.item[].description

The custom description of the configuration for the recommender model.

list_recommender_configurations_response.item[].id

The unique identifier for the recommender model configuration.

list_recommender_configurations_response.item[].last_modified_date

The date, in extended ISO 8601 format, when the configuration for the recommender model was last modified.

list_recommender_configurations_response.item[].name

The custom name of the configuration for the recommender model.

list_recommender_configurations_response.item[].recommendation_provider_id_type

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.

list_recommender_configurations_response.item[].recommendation_provider_role_arn

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.

list_recommender_configurations_response.item[].recommendation_provider_uri

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.

list_recommender_configurations_response.item[].recommendation_transformer_uri

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.

list_recommender_configurations_response.item[].recommendations_display_name

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.

list_recommender_configurations_response.item[].recommendations_per_message

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.

list_recommender_configurations_response.next_token

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.