CustomerProfiles / Client / get_profile_recommendations

get_profile_recommendations

CustomerProfiles.Client.get_profile_recommendations(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_profile_recommendations(
    DomainName='string',
    ProfileId='string',
    RecommenderName='string',
    Context={
        'string': 'string'
    },
    MaxResults=123
)

Parameters:

• DomainName (string) –

  [REQUIRED]

  The unique name of the domain.

• ProfileId (string) –

  [REQUIRED]

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

• RecommenderName (string) –

  [REQUIRED]

  The unique name of the recommender.

• Context (dict) –

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

  • (string) –

    • (string) –

• MaxResults (integer) – The maximum number of recommendations to return. The default value is 10.

Return type:

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.

Exceptions

• CustomerProfiles.Client.exceptions.BadRequestException

• CustomerProfiles.Client.exceptions.AccessDeniedException

• CustomerProfiles.Client.exceptions.ResourceNotFoundException

• CustomerProfiles.Client.exceptions.ThrottlingException

• CustomerProfiles.Client.exceptions.InternalServerException