list_recommenders

list_recommenders(**kwargs)

Returns a list of recommenders in a given Domain dataset group. When a Domain dataset group is not specified, all the recommenders associated with the account are listed. The response provides the properties for each recommender, including the Amazon Resource Name (ARN). For more information on recommenders, see CreateRecommender.

See also: AWS API Documentation

Request Syntax

response = client.list_recommenders(
    datasetGroupArn='string',
    nextToken='string',
    maxResults=123
)

Parameters

• datasetGroupArn (string) -- The Amazon Resource Name (ARN) of the Domain dataset group to list the recommenders for. When a Domain dataset group is not specified, all the recommenders associated with the account are listed.
• nextToken (string) -- A token returned from the previous call to ListRecommenders for getting the next set of recommenders (if they exist).
• maxResults (integer) -- The maximum number of recommenders to return.

Return type

dict

Returns

Response Syntax

{
    'recommenders': [
        {
            'name': 'string',
            'recommenderArn': 'string',
            'datasetGroupArn': 'string',
            'recipeArn': 'string',
            'recommenderConfig': {
                'itemExplorationConfig': {
                    'string': 'string'
                },
                'minRecommendationRequestsPerSecond': 123
            },
            'status': 'string',
            'creationDateTime': datetime(2015, 1, 1),
            'lastUpdatedDateTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • recommenders (list) --

    A list of the recommenders.

    • (dict) --

      Provides a summary of the properties of the recommender.

      • name (string) --

        The name of the recommender.

      • recommenderArn (string) --

        The Amazon Resource Name (ARN) of the recommender.

      • datasetGroupArn (string) --

        The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.

      • recipeArn (string) --

        The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.

      • recommenderConfig (dict) --

        The configuration details of the recommender.

        • itemExplorationConfig (dict) --

          Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff , you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your recommenders generate personalized recommendations for a user (not popular items or similar items).

          • (string) --
            • (string) --

        • minRecommendationRequestsPerSecond (integer) --

          Specifies the requested minimum provisioned recommendation requests per second that Amazon Personalize will support.

      • status (string) --

        The status of the recommender. A recommender can be in one of the following states:

        • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
        • STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
        • DELETE PENDING > DELETE IN_PROGRESS

      • creationDateTime (datetime) --

        The date and time (in Unix format) that the recommender was created.

      • lastUpdatedDateTime (datetime) --

        The date and time (in Unix format) that the recommender was last updated.

  • nextToken (string) --

    A token for getting the next set of recommenders (if they exist).

Exceptions

• Personalize.Client.exceptions.InvalidInputException
• Personalize.Client.exceptions.InvalidNextTokenException