Amazon Connect Customer Profiles

2026/03/11 - Amazon Connect Customer Profiles - 4 new 6 updated api methods

Changes  Today, Amazon Connect is announcing the ability to filter (include or exclude) recommendations based on properties of items and interactions.

GetRecommenderFilter (new) Link ¶

Retrieves information about a specific recommender filter in a domain.

See also: AWS API Documentation

Request Syntax

client.get_recommender_filter(
    DomainName='string',
    RecommenderFilterName='string'
)
type DomainName:

string

param DomainName:

[REQUIRED]

The unique name of the domain.

type RecommenderFilterName:

string

param RecommenderFilterName:

[REQUIRED]

The name of the recommender filter to retrieve.

rtype:

dict

returns:

Response Syntax

{
    'RecommenderFilterName': 'string',
    'RecommenderFilterExpression': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'Status': 'ACTIVE'|'PENDING'|'IN_PROGRESS'|'FAILED'|'DELETING',
    'Description': 'string',
    'FailureReason': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • RecommenderFilterName (string) --

      The name of the recommender filter.

    • RecommenderFilterExpression (string) --

      The filter expression that defines which items to include or exclude from recommendations.

    • CreatedAt (datetime) --

      The timestamp of when the recommender filter was created.

    • Status (string) --

      The status of the recommender filter.

    • Description (string) --

      The description of the recommender filter.

    • FailureReason (string) --

      If the recommender filter failed, provides the reason for the failure.

    • Tags (dict) --

      The tags used to organize, track, or control access for this resource.

      • (string) --

        • (string) --

DeleteRecommenderFilter (new) Link ¶

Deletes a recommender filter from a domain.

See also: AWS API Documentation

Request Syntax

client.delete_recommender_filter(
    DomainName='string',
    RecommenderFilterName='string'
)
type DomainName:

string

param DomainName:

[REQUIRED]

The unique name of the domain.

type RecommenderFilterName:

string

param RecommenderFilterName:

[REQUIRED]

The name of the recommender filter to delete.

rtype:

dict

returns:

Response Syntax

{
    'Message': 'string'
}

Response Structure

  • (dict) --

    • Message (string) --

      A message that indicates the delete request is done.

ListRecommenderFilters (new) Link ¶

Returns a list of recommender filters in the specified domain.

See also: AWS API Documentation

Request Syntax

client.list_recommender_filters(
    DomainName='string',
    MaxResults=123,
    NextToken='string'
)
type DomainName:

string

param DomainName:

[REQUIRED]

The unique name of the domain.

type MaxResults:

integer

param MaxResults:

The maximum number of recommender filters to return in the response. The default value is 100.

type NextToken:

string

param NextToken:

A token received from a previous ListRecommenderFilters call to retrieve the next page of results.

rtype:

dict

returns:

Response Syntax

{
    'NextToken': 'string',
    'RecommenderFilters': [
        {
            'RecommenderFilterName': 'string',
            'RecommenderFilterExpression': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'Description': 'string',
            'Status': 'ACTIVE'|'PENDING'|'IN_PROGRESS'|'FAILED'|'DELETING',
            'FailureReason': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      A token to retrieve the next page of results. Null if there are no more results to retrieve.

    • RecommenderFilters (list) --

      A list of recommender filters and their properties in the specified domain.

      • (dict) --

        Provides a summary of a recommender filter's configuration and current state.

        • RecommenderFilterName (string) --

          The name of the recommender filter.

        • RecommenderFilterExpression (string) --

          The filter expression that defines which items to include or exclude from recommendations.

        • CreatedAt (datetime) --

          The timestamp when the recommender filter was created.

        • Description (string) --

          A description of the recommender filter's purpose and characteristics.

        • Status (string) --

          The current operational status of the recommender filter.

        • FailureReason (string) --

          If the recommender filter is in a failed state, provides the reason for the failure.

        • Tags (dict) --

          The tags used to organize, track, or control access for this resource.

          • (string) --

            • (string) --

CreateRecommenderFilter (new) Link ¶

Creates a recommender filter. A recommender filter specifies which items to include or exclude from recommendations.

See also: AWS API Documentation

Request Syntax

client.create_recommender_filter(
    DomainName='string',
    RecommenderFilterName='string',
    RecommenderFilterExpression='string',
    Description='string',
    Tags={
        'string': 'string'
    }
)
type DomainName:

string

param DomainName:

[REQUIRED]

The unique name of the domain.

type RecommenderFilterName:

string

param RecommenderFilterName:

[REQUIRED]

The name of the recommender filter. The name must be unique within the domain.

type RecommenderFilterExpression:

string

param RecommenderFilterExpression:

[REQUIRED]

The filter expression that defines which items to include or exclude from recommendations.

type Description:

string

param Description:

A description of the recommender filter.

type Tags:

dict

param Tags:

The tags used to organize, track, or control access for this resource.

  • (string) --

    • (string) --

rtype:

dict

returns:

Response Syntax

{
    'RecommenderFilterArn': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • RecommenderFilterArn (string) --

      The Amazon Resource Name (ARN) of the recommender filter.

    • Tags (dict) --

      The tags used to organize, track, or control access for this resource.

      • (string) --

        • (string) --

CreateRecommender (updated) Link ¶
Changes (request)
{'RecommenderConfig': {'EventsConfig': {'EventParametersList': {'EventWeight': 'double'}},
                       'InferenceConfig': {'MinProvisionedTPS': 'integer'}},
 'RecommenderRecipeName': {'personalized-ranking'}}

Creates a recommender

See also: AWS API Documentation

Request Syntax

client.create_recommender(
    DomainName='string',
    RecommenderName='string',
    RecommenderRecipeName='recommended-for-you'|'similar-items'|'frequently-paired-items'|'popular-items'|'trending-now'|'personalized-ranking',
    RecommenderConfig={
        'EventsConfig': {
            'EventParametersList': [
                {
                    'EventType': 'string',
                    'EventValueThreshold': 123.0,
                    'EventWeight': 123.0
                },
            ]
        },
        'TrainingFrequency': 123,
        'InferenceConfig': {
            'MinProvisionedTPS': 123
        }
    },
    Description='string',
    Tags={
        'string': 'string'
    }
)
type DomainName:

string

param DomainName:

[REQUIRED]

The unique name of the domain.

type RecommenderName:

string

param RecommenderName:

[REQUIRED]

The name of the recommender.

type RecommenderRecipeName:

string

param RecommenderRecipeName:

[REQUIRED]

The name of the recommeder recipe.

type RecommenderConfig:

dict

param RecommenderConfig:

The recommender configuration.

  • EventsConfig (dict) --

    Configuration settings for how the recommender processes and uses events.

    • EventParametersList (list) -- [REQUIRED]

      A list of event parameters configurations that specify how different event types should be handled.

      • (dict) --

        Configuration parameters for events in the personalization system.

        • EventType (string) -- [REQUIRED]

          The type of event being tracked (e.g., 'click', 'purchase', 'view').

        • EventValueThreshold (float) --

          The minimum value threshold that an event must meet to be considered valid.

        • EventWeight (float) --

          The weight of the event type. A higher weight means higher importance of the event type for the created solution.

  • TrainingFrequency (integer) --

    How often the recommender should retrain its model with new data.

  • InferenceConfig (dict) --

    Configuration settings for how the recommender handles inference requests.

    • MinProvisionedTPS (integer) --

      The minimum provisioned transactions per second (TPS) that the recommender supports. The default value is 1. A high MinProvisionedTPS will increase your cost.

type Description:

string

param Description:

The description of the domain object type.

type Tags:

dict

param Tags:

The tags used to organize, track, or control access for this resource.

  • (string) --

    • (string) --

rtype:

dict

returns:

Response Syntax

{
    'RecommenderArn': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • RecommenderArn (string) --

      The ARN of the recommender

    • Tags (dict) --

      The tags used to organize, track, or control access for this resource.

      • (string) --

        • (string) --

GetProfileRecommendations (updated) Link ¶
Changes (request)
{'CandidateIds': ['string'],
 'MetadataConfig': {'MetadataColumns': ['string']},
 'RecommenderFilters': [{'Name': 'string', 'Values': {'string': 'string'}}],
 'RecommenderPromotionalFilters': [{'Name': 'string',
                                    'PercentPromotedItems': 'integer',
                                    'PromotionName': 'string',
                                    'Values': {'string': 'string'}}]}

Fetches the recommendations for a profile in the input Customer Profiles domain. Fetches all the profile recommendations

See also: AWS API Documentation

Request Syntax

client.get_profile_recommendations(
    DomainName='string',
    ProfileId='string',
    RecommenderName='string',
    Context={
        'string': 'string'
    },
    RecommenderFilters=[
        {
            'Name': 'string',
            'Values': {
                'string': 'string'
            }
        },
    ],
    RecommenderPromotionalFilters=[
        {
            'Name': 'string',
            'Values': {
                'string': 'string'
            },
            'PromotionName': 'string',
            'PercentPromotedItems': 123
        },
    ],
    CandidateIds=[
        'string',
    ],
    MaxResults=123,
    MetadataConfig={
        'MetadataColumns': [
            'string',
        ]
    }
)
type DomainName:

string

param DomainName:

[REQUIRED]

The unique name of the domain.

type ProfileId:

string

param ProfileId:

[REQUIRED]

The unique identifier of the profile for which to retrieve recommendations.

type RecommenderName:

string

param RecommenderName:

[REQUIRED]

The unique name of the recommender.

type Context:

dict

param Context:

The contextual metadata used to provide dynamic runtime information to tailor recommendations.

  • (string) --

    • (string) --

type RecommenderFilters:

list

param RecommenderFilters:

A list of filters to apply to the returned recommendations. Filters define criteria for including or excluding items from the recommendation results.

  • (dict) --

    A filter that specifies criteria for including or excluding items from recommendations.

    • Name (string) --

      The name of the recommender filter to apply.

    • Values (dict) --

      The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.

      • (string) --

        • (string) --

type RecommenderPromotionalFilters:

list

param RecommenderPromotionalFilters:

A list of promotional filters to apply to the recommendations. Promotional filters allow you to promote specific items within a configurable subset of recommendation results.

  • (dict) --

    Contains information on a promotion. A promotion defines additional business rules that apply to a configurable subset of recommended items.

    • Name (string) --

      The name of the recommender filter to use for the promotion.

    • Values (dict) --

      The values to use when promoting items. For each placeholder parameter in your promotion's filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.

      • (string) --

        • (string) --

    • PromotionName (string) --

      The name of the promotion.

    • PercentPromotedItems (integer) --

      The percentage of recommended items to apply the promotion to.

type CandidateIds:

list

param CandidateIds:

A list of item IDs to rank for the user. Use this when you want to re-rank a specific set of items rather than getting recommendations from the full item catalog. Required for personalized-ranking use cases.

  • (string) --

type MaxResults:

integer

param MaxResults:

The maximum number of recommendations to return. The default value is 10.

type MetadataConfig:

dict

param MetadataConfig:

Configuration for including item metadata in the recommendation response. Use this to specify which metadata columns to return alongside recommended items.

  • MetadataColumns (list) --

    A list of metadata column names from your Items dataset to include in the recommendation response.

    • (string) --

rtype:

dict

returns:

Response Syntax

{
    'Recommendations': [
        {
            'CatalogItem': {
                'Id': 'string',
                'Name': 'string',
                'Code': 'string',
                'Type': 'string',
                'Category': 'string',
                'Description': 'string',
                'AdditionalInformation': 'string',
                'ImageLink': 'string',
                'Link': 'string',
                'CreatedAt': datetime(2015, 1, 1),
                'UpdatedAt': datetime(2015, 1, 1),
                'Price': 'string',
                'Attributes': {
                    'string': 'string'
                }
            },
            'Score': 123.0
        },
    ]
}

Response Structure

  • (dict) --

    • Recommendations (list) --

      List of recommendations generated by the recommender.

      • (dict) --

        Represents a single recommendation generated by the recommender system.

        • CatalogItem (dict) --

          The catalog item being recommended, including its complete details and attributes.

          • Id (string) --

            The unique identifier for the catalog item.

          • Name (string) --

            The display name of the catalog item.

          • Code (string) --

            The product code or SKU of the catalog item.

          • Type (string) --

            The type classification of the catalog item.

          • Category (string) --

            The category to which the catalog item belongs.

          • Description (string) --

            A detailed description of the catalog item.

          • AdditionalInformation (string) --

            Supplementary information about the catalog item beyond the basic description.

          • ImageLink (string) --

            The URL link to the item's image.

          • Link (string) --

            The URL link to the item's detailed page or external resource.

          • CreatedAt (datetime) --

            The timestamp when the catalog item was created.

          • UpdatedAt (datetime) --

            The timestamp when the catalog item was last updated.

          • Price (string) --

            The price of the catalog item.

          • Attributes (dict) --

            Additional attributes or properties associated with the catalog item stored as key-value pairs.

            • (string) --

              • (string) --

        • Score (float) --

          Recommendation Score between 0 and 1.

GetRecommender (updated) Link ¶
Changes (response)
{'LatestRecommenderUpdate': {'RecommenderConfig': {'EventsConfig': {'EventParametersList': {'EventWeight': 'double'}},
                                                   'InferenceConfig': {'MinProvisionedTPS': 'integer'}}},
 'RecommenderConfig': {'EventsConfig': {'EventParametersList': {'EventWeight': 'double'}},
                       'InferenceConfig': {'MinProvisionedTPS': 'integer'}},
 'RecommenderRecipeName': {'personalized-ranking'}}

Retrieves a recommender.

See also: AWS API Documentation

Request Syntax

client.get_recommender(
    DomainName='string',
    RecommenderName='string',
    TrainingMetricsCount=123
)
type DomainName:

string

param DomainName:

[REQUIRED]

The unique name of the domain.

type RecommenderName:

string

param RecommenderName:

[REQUIRED]

The name of the recommender.

type TrainingMetricsCount:

integer

param TrainingMetricsCount:

The number of training metrics to retrieve for the recommender.

rtype:

dict

returns:

Response Syntax

{
    'RecommenderName': 'string',
    'RecommenderRecipeName': 'recommended-for-you'|'similar-items'|'frequently-paired-items'|'popular-items'|'trending-now'|'personalized-ranking',
    'RecommenderConfig': {
        'EventsConfig': {
            'EventParametersList': [
                {
                    'EventType': 'string',
                    'EventValueThreshold': 123.0,
                    'EventWeight': 123.0
                },
            ]
        },
        'TrainingFrequency': 123,
        'InferenceConfig': {
            'MinProvisionedTPS': 123
        }
    },
    'Description': 'string',
    'Status': 'PENDING'|'IN_PROGRESS'|'ACTIVE'|'FAILED'|'STOPPING'|'INACTIVE'|'STARTING'|'DELETING',
    'LastUpdatedAt': datetime(2015, 1, 1),
    'CreatedAt': datetime(2015, 1, 1),
    'FailureReason': 'string',
    'LatestRecommenderUpdate': {
        'RecommenderConfig': {
            'EventsConfig': {
                'EventParametersList': [
                    {
                        'EventType': 'string',
                        'EventValueThreshold': 123.0,
                        'EventWeight': 123.0
                    },
                ]
            },
            'TrainingFrequency': 123,
            'InferenceConfig': {
                'MinProvisionedTPS': 123
            }
        },
        'Status': 'PENDING'|'IN_PROGRESS'|'ACTIVE'|'FAILED'|'STOPPING'|'INACTIVE'|'STARTING'|'DELETING',
        'CreatedAt': datetime(2015, 1, 1),
        'LastUpdatedAt': datetime(2015, 1, 1),
        'FailureReason': 'string'
    },
    'TrainingMetrics': [
        {
            'Time': datetime(2015, 1, 1),
            'Metrics': {
                'string': 123.0
            }
        },
    ],
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • RecommenderName (string) --

      The name of the recommender.

    • RecommenderRecipeName (string) --

      The name of the recipe used by the recommender to generate recommendations.

    • RecommenderConfig (dict) --

      The configuration settings for the recommender, including parameters and settings that define its behavior.

      • EventsConfig (dict) --

        Configuration settings for how the recommender processes and uses events.

        • EventParametersList (list) --

          A list of event parameters configurations that specify how different event types should be handled.

          • (dict) --

            Configuration parameters for events in the personalization system.

            • EventType (string) --

              The type of event being tracked (e.g., 'click', 'purchase', 'view').

            • EventValueThreshold (float) --

              The minimum value threshold that an event must meet to be considered valid.

            • EventWeight (float) --

              The weight of the event type. A higher weight means higher importance of the event type for the created solution.

      • TrainingFrequency (integer) --

        How often the recommender should retrain its model with new data.

      • InferenceConfig (dict) --

        Configuration settings for how the recommender handles inference requests.

        • MinProvisionedTPS (integer) --

          The minimum provisioned transactions per second (TPS) that the recommender supports. The default value is 1. A high MinProvisionedTPS will increase your cost.

    • Description (string) --

      A detailed description of the recommender providing information about its purpose and functionality.

    • Status (string) --

      The current status of the recommender, indicating whether it is active, creating, updating, or in another state.

    • LastUpdatedAt (datetime) --

      The timestamp of when the recommender was edited.

    • CreatedAt (datetime) --

      The timestamp of when the recommender was created.

    • FailureReason (string) --

      If the recommender fails, provides the reason for the failure.

    • LatestRecommenderUpdate (dict) --

      Information about the most recent update performed on the recommender, including status and timestamp.

      • RecommenderConfig (dict) --

        The updated configuration settings applied to the recommender during this update.

        • EventsConfig (dict) --

          Configuration settings for how the recommender processes and uses events.

          • EventParametersList (list) --

            A list of event parameters configurations that specify how different event types should be handled.

            • (dict) --

              Configuration parameters for events in the personalization system.

              • EventType (string) --

                The type of event being tracked (e.g., 'click', 'purchase', 'view').

              • EventValueThreshold (float) --

                The minimum value threshold that an event must meet to be considered valid.

              • EventWeight (float) --

                The weight of the event type. A higher weight means higher importance of the event type for the created solution.

        • TrainingFrequency (integer) --

          How often the recommender should retrain its model with new data.

        • InferenceConfig (dict) --

          Configuration settings for how the recommender handles inference requests.

          • MinProvisionedTPS (integer) --

            The minimum provisioned transactions per second (TPS) that the recommender supports. The default value is 1. A high MinProvisionedTPS will increase your cost.

      • Status (string) --

        The current status of the recommender update operation.

      • CreatedAt (datetime) --

        The timestamp when this recommender update was initiated.

      • LastUpdatedAt (datetime) --

        The timestamp of when the recommender was edited.

      • FailureReason (string) --

        If the update operation failed, provides the reason for the failure.

    • TrainingMetrics (list) --

      A set of metrics that provide information about the recommender's training performance and accuracy.

      • (dict) --

        Contains metrics and performance indicators from the training of a recommender model.

        • Time (datetime) --

          The timestamp when these training metrics were recorded.

        • Metrics (dict) --

          A collection of performance metrics and statistics from the training process.

          • (string) --

            • (float) --

    • Tags (dict) --

      The tags used to organize, track, or control access for this resource.

      • (string) --

        • (string) --

ListRecommenderRecipes (updated) Link ¶
Changes (response)
{'RecommenderRecipes': {'name': {'personalized-ranking'}}}

Returns a list of available recommender recipes that can be used to create recommenders.

See also: AWS API Documentation

Request Syntax

client.list_recommender_recipes(
    MaxResults=123,
    NextToken='string'
)
type MaxResults:

integer

param MaxResults:

The maximum number of recommender recipes to return in the response. The default value is 100.

type NextToken:

string

param NextToken:

A token received from a previous ListRecommenderRecipes call to retrieve the next page of results.

rtype:

dict

returns:

Response Syntax

{
    'NextToken': 'string',
    'RecommenderRecipes': [
        {
            'name': 'recommended-for-you'|'similar-items'|'frequently-paired-items'|'popular-items'|'trending-now'|'personalized-ranking',
            'description': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      A token to retrieve the next page of results. Null if there are no more results to retrieve.

    • RecommenderRecipes (list) --

      A list of available recommender recipes and their properties.

      • (dict) --

        Defines the algorithm and approach used to generate recommendations.

        • name (string) --

          The name of the recommender recipe.

        • description (string) --

          A description of the recommender recipe's purpose and functionality.

ListRecommenders (updated) Link ¶
Changes (response)
{'Recommenders': {'LatestRecommenderUpdate': {'RecommenderConfig': {'EventsConfig': {'EventParametersList': {'EventWeight': 'double'}},
                                                                    'InferenceConfig': {'MinProvisionedTPS': 'integer'}}},
                  'RecipeName': {'personalized-ranking'},
                  'RecommenderConfig': {'EventsConfig': {'EventParametersList': {'EventWeight': 'double'}},
                                        'InferenceConfig': {'MinProvisionedTPS': 'integer'}}}}

Returns a list of recommenders in the specified domain.

See also: AWS API Documentation

Request Syntax

client.list_recommenders(
    DomainName='string',
    MaxResults=123,
    NextToken='string'
)
type DomainName:

string

param DomainName:

[REQUIRED]

The unique name of the domain.

type MaxResults:

integer

param MaxResults:

The maximum number of recommenders to return in the response. The default value is 100.

type NextToken:

string

param NextToken:

A token received from a previous ListRecommenders call to retrieve the next page of results.

rtype:

dict

returns:

Response Syntax

{
    'NextToken': 'string',
    'Recommenders': [
        {
            'RecommenderName': 'string',
            'RecipeName': 'recommended-for-you'|'similar-items'|'frequently-paired-items'|'popular-items'|'trending-now'|'personalized-ranking',
            'RecommenderConfig': {
                'EventsConfig': {
                    'EventParametersList': [
                        {
                            'EventType': 'string',
                            'EventValueThreshold': 123.0,
                            'EventWeight': 123.0
                        },
                    ]
                },
                'TrainingFrequency': 123,
                'InferenceConfig': {
                    'MinProvisionedTPS': 123
                }
            },
            'CreatedAt': datetime(2015, 1, 1),
            'Description': 'string',
            'Status': 'PENDING'|'IN_PROGRESS'|'ACTIVE'|'FAILED'|'STOPPING'|'INACTIVE'|'STARTING'|'DELETING',
            'LastUpdatedAt': datetime(2015, 1, 1),
            'Tags': {
                'string': 'string'
            },
            'FailureReason': 'string',
            'LatestRecommenderUpdate': {
                'RecommenderConfig': {
                    'EventsConfig': {
                        'EventParametersList': [
                            {
                                'EventType': 'string',
                                'EventValueThreshold': 123.0,
                                'EventWeight': 123.0
                            },
                        ]
                    },
                    'TrainingFrequency': 123,
                    'InferenceConfig': {
                        'MinProvisionedTPS': 123
                    }
                },
                'Status': 'PENDING'|'IN_PROGRESS'|'ACTIVE'|'FAILED'|'STOPPING'|'INACTIVE'|'STARTING'|'DELETING',
                'CreatedAt': datetime(2015, 1, 1),
                'LastUpdatedAt': datetime(2015, 1, 1),
                'FailureReason': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      A token to retrieve the next page of results. Null if there are no more results to retrieve.

    • Recommenders (list) --

      A list of recommenders and their properties in the specified domain.

      • (dict) --

        Provides a summary of a recommender's configuration and current state.

        • RecommenderName (string) --

          The name of the recommender.

        • RecipeName (string) --

          The name of the recipe used by this recommender.

        • RecommenderConfig (dict) --

          The configuration settings applied to this recommender.

          • EventsConfig (dict) --

            Configuration settings for how the recommender processes and uses events.

            • EventParametersList (list) --

              A list of event parameters configurations that specify how different event types should be handled.

              • (dict) --

                Configuration parameters for events in the personalization system.

                • EventType (string) --

                  The type of event being tracked (e.g., 'click', 'purchase', 'view').

                • EventValueThreshold (float) --

                  The minimum value threshold that an event must meet to be considered valid.

                • EventWeight (float) --

                  The weight of the event type. A higher weight means higher importance of the event type for the created solution.

          • TrainingFrequency (integer) --

            How often the recommender should retrain its model with new data.

          • InferenceConfig (dict) --

            Configuration settings for how the recommender handles inference requests.

            • MinProvisionedTPS (integer) --

              The minimum provisioned transactions per second (TPS) that the recommender supports. The default value is 1. A high MinProvisionedTPS will increase your cost.

        • CreatedAt (datetime) --

          The timestamp when the recommender was created.

        • Description (string) --

          A description of the recommender's purpose and characteristics.

        • Status (string) --

          The current operational status of the recommender.

        • LastUpdatedAt (datetime) --

          The timestamp of when the recommender was edited.

        • Tags (dict) --

          The tags used to organize, track, or control access for this resource.

          • (string) --

            • (string) --

        • FailureReason (string) --

          If the recommender is in a failed state, provides the reason for the failure.

        • LatestRecommenderUpdate (dict) --

          Information about the most recent update performed on the recommender, including its status and timing.

          • RecommenderConfig (dict) --

            The updated configuration settings applied to the recommender during this update.

            • EventsConfig (dict) --

              Configuration settings for how the recommender processes and uses events.

              • EventParametersList (list) --

                A list of event parameters configurations that specify how different event types should be handled.

                • (dict) --

                  Configuration parameters for events in the personalization system.

                  • EventType (string) --

                    The type of event being tracked (e.g., 'click', 'purchase', 'view').

                  • EventValueThreshold (float) --

                    The minimum value threshold that an event must meet to be considered valid.

                  • EventWeight (float) --

                    The weight of the event type. A higher weight means higher importance of the event type for the created solution.

            • TrainingFrequency (integer) --

              How often the recommender should retrain its model with new data.

            • InferenceConfig (dict) --

              Configuration settings for how the recommender handles inference requests.

              • MinProvisionedTPS (integer) --

                The minimum provisioned transactions per second (TPS) that the recommender supports. The default value is 1. A high MinProvisionedTPS will increase your cost.

          • Status (string) --

            The current status of the recommender update operation.

          • CreatedAt (datetime) --

            The timestamp when this recommender update was initiated.

          • LastUpdatedAt (datetime) --

            The timestamp of when the recommender was edited.

          • FailureReason (string) --

            If the update operation failed, provides the reason for the failure.

UpdateRecommender (updated) Link ¶
Changes (request)
{'RecommenderConfig': {'EventsConfig': {'EventParametersList': {'EventWeight': 'double'}},
                       'InferenceConfig': {'MinProvisionedTPS': 'integer'}}}

Updates the properties of an existing recommender, allowing you to modify its configuration and description.

See also: AWS API Documentation

Request Syntax

client.update_recommender(
    DomainName='string',
    RecommenderName='string',
    Description='string',
    RecommenderConfig={
        'EventsConfig': {
            'EventParametersList': [
                {
                    'EventType': 'string',
                    'EventValueThreshold': 123.0,
                    'EventWeight': 123.0
                },
            ]
        },
        'TrainingFrequency': 123,
        'InferenceConfig': {
            'MinProvisionedTPS': 123
        }
    }
)
type DomainName:

string

param DomainName:

[REQUIRED]

The unique name of the domain.

type RecommenderName:

string

param RecommenderName:

[REQUIRED]

The name of the recommender to update.

type Description:

string

param Description:

The new description to assign to the recommender.

type RecommenderConfig:

dict

param RecommenderConfig:

The new configuration settings to apply to the recommender, including updated parameters and settings that define its behavior.

  • EventsConfig (dict) --

    Configuration settings for how the recommender processes and uses events.

    • EventParametersList (list) -- [REQUIRED]

      A list of event parameters configurations that specify how different event types should be handled.

      • (dict) --

        Configuration parameters for events in the personalization system.

        • EventType (string) -- [REQUIRED]

          The type of event being tracked (e.g., 'click', 'purchase', 'view').

        • EventValueThreshold (float) --

          The minimum value threshold that an event must meet to be considered valid.

        • EventWeight (float) --

          The weight of the event type. A higher weight means higher importance of the event type for the created solution.

  • TrainingFrequency (integer) --

    How often the recommender should retrain its model with new data.

  • InferenceConfig (dict) --

    Configuration settings for how the recommender handles inference requests.

    • MinProvisionedTPS (integer) --

      The minimum provisioned transactions per second (TPS) that the recommender supports. The default value is 1. A high MinProvisionedTPS will increase your cost.

rtype:

dict

returns:

Response Syntax

{
    'RecommenderName': 'string'
}

Response Structure

  • (dict) --

    • RecommenderName (string) --

      The name of the recommender that was updated.