Struct Recommender

#[non_exhaustive]
pub struct Recommender {
    pub recommender_arn: Option<String>,
    pub dataset_group_arn: Option<String>,
    pub name: Option<String>,
    pub recipe_arn: Option<String>,
    pub recommender_config: Option<RecommenderConfig>,
    pub creation_date_time: Option<DateTime>,
    pub last_updated_date_time: Option<DateTime>,
    pub status: Option<String>,
    pub failure_reason: Option<String>,
    pub latest_recommender_update: Option<RecommenderUpdateSummary>,
    pub model_metrics: Option<HashMap<String, f64>>,
}

Describes a recommendation generator for a Domain dataset group. You create a recommender in a Domain dataset group for a specific domain use case (domain recipe), and specify the recommender in a GetRecommendations request.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

recommender_arn: Option<String>

The Amazon Resource Name (ARN) of the recommender.

dataset_group_arn: Option<String>

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

name: Option<String>

The name of the recommender.

recipe_arn: Option<String>

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

recommender_config: Option<RecommenderConfig>

The configuration details of the recommender.

creation_date_time: Option<DateTime>

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

last_updated_date_time: Option<DateTime>

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

status: Option<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

failure_reason: Option<String>

If a recommender fails, the reason behind the failure.

latest_recommender_update: Option<RecommenderUpdateSummary>

Provides a summary of the latest updates to the recommender.

model_metrics: Option<HashMap<String, f64>>

Provides evaluation metrics that help you determine the performance of a recommender. For more information, see Evaluating a recommender.

Implementations

impl Recommender

pub fn recommender_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the recommender.

pub fn dataset_group_arn(&self) -> Option<&str>

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

pub fn name(&self) -> Option<&str>

The name of the recommender.

pub fn recipe_arn(&self) -> Option<&str>

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

pub fn recommender_config(&self) -> Option<&RecommenderConfig>

The configuration details of the recommender.

pub fn creation_date_time(&self) -> Option<&DateTime>

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

pub fn last_updated_date_time(&self) -> Option<&DateTime>

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

pub fn status(&self) -> Option<&str>

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

pub fn failure_reason(&self) -> Option<&str>

If a recommender fails, the reason behind the failure.

pub fn latest_recommender_update(&self) -> Option<&RecommenderUpdateSummary>

Provides a summary of the latest updates to the recommender.

pub fn model_metrics(&self) -> Option<&HashMap<String, f64>>

Provides evaluation metrics that help you determine the performance of a recommender. For more information, see Evaluating a recommender.

impl Recommender

pub fn builder() -> RecommenderBuilder

Creates a new builder-style object to manufacture Recommender.

Trait Implementations

impl Clone for Recommender

fn clone(&self) -> Recommender

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Recommender

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Recommender

fn eq(&self, other: &Recommender) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Recommender