Skip to content

RecommenderSummary

Source code in docs_src/capo_personalize/types/recommender_summary.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class RecommenderSummary(TypedDict, closed=True):
    name: NotRequired["capo_personalize.types.name.Name"]
    """<p>The name of the recommender.</p>"""
    recommender_arn: NotRequired["capo_personalize.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the recommender.</p>"""
    dataset_group_arn: NotRequired["capo_personalize.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.</p>"""
    recipe_arn: NotRequired["capo_personalize.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.</p>"""
    recommender_config: NotRequired[
        "capo_personalize.types.recommender_config.RecommenderConfig"
    ]
    """<p>The configuration details of the recommender.</p>"""
    status: NotRequired["capo_personalize.types.status.Status"]
    """<p>The status of the recommender. A recommender can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p> </li> <li> <p>STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE</p> </li> <li> <p>DELETE PENDING > DELETE IN_PROGRESS</p> </li> </ul>"""
    creation_date_time: NotRequired["capo_personalize.types.date.Date"]
    """<p>The date and time (in Unix format) that the recommender was created.</p>"""
    last_updated_date_time: NotRequired["capo_personalize.types.date.Date"]
    """<p>The date and time (in Unix format) that the recommender was last updated.</p>"""

creation_date_time instance-attribute 

creation_date_time: NotRequired[Date]

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

dataset_group_arn instance-attribute 

dataset_group_arn: NotRequired[Arn]

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

last_updated_date_time instance-attribute 

last_updated_date_time: NotRequired[Date]

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

name instance-attribute 

name: NotRequired[Name]

The name of the recommender.

recipe_arn instance-attribute 

recipe_arn: NotRequired[Arn]

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

recommender_arn instance-attribute 

recommender_arn: NotRequired[Arn]

The Amazon Resource Name (ARN) of the recommender.

recommender_config instance-attribute 

recommender_config: NotRequired[RecommenderConfig]

The configuration details of the recommender.

status instance-attribute 

status: NotRequired[Status]

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