Struct ModelCard

#[non_exhaustive]
pub struct ModelCard {

    pub model_card_arn: Option<String>,
    pub model_card_name: Option<String>,
    pub model_card_version: Option<i32>,
    pub content: Option<String>,
    pub model_card_status: Option<ModelCardStatus>,
    pub security_config: Option<ModelCardSecurityConfig>,
    pub creation_time: Option<DateTime>,
    pub created_by: Option<UserContext>,
    pub last_modified_time: Option<DateTime>,
    pub last_modified_by: Option<UserContext>,
    pub tags: Option<Vec<Tag>>,
    pub model_id: Option<String>,
    pub risk_rating: Option<String>,
    pub model_package_group_name: Option<String>,
}

An Amazon SageMaker Model Card.

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.

model_card_arn: Option<String>

The Amazon Resource Name (ARN) of the model card.

model_card_name: Option<String>

The unique name of the model card.

model_card_version: Option<i32>

The version of the model card.

content: Option<String>

The content of the model card. Content uses the model card JSON schema and provided as a string.

model_card_status: Option<ModelCardStatus>

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

• Draft: The model card is a work in progress.

• PendingReview: The model card is pending review.

• Approved: The model card is approved.

• Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

security_config: Option<ModelCardSecurityConfig>

The security configuration used to protect model card data.

creation_time: Option<DateTime>

The date and time that the model card was created.

created_by: Option<UserContext>

Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.

last_modified_time: Option<DateTime>

The date and time that the model card was last modified.

last_modified_by: Option<UserContext>

Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.

tags: Option<Vec<Tag>>

Key-value pairs used to manage metadata for the model card.

model_id: Option<String>

The unique name (ID) of the model.

risk_rating: Option<String>

The risk rating of the model. Different organizations might have different criteria for model card risk ratings. For more information, see Risk ratings.

model_package_group_name: Option<String>

The model package group that contains the model package. Only relevant for model cards created for model packages in the Amazon SageMaker Model Registry.

Implementations

impl ModelCard

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

The Amazon Resource Name (ARN) of the model card.

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

The unique name of the model card.

pub fn model_card_version(&self) -> Option<i32>

The version of the model card.

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

The content of the model card. Content uses the model card JSON schema and provided as a string.

pub fn model_card_status(&self) -> Option<&ModelCardStatus>

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

• Draft: The model card is a work in progress.

• PendingReview: The model card is pending review.

• Approved: The model card is approved.

• Archived: The model card is archived. No more updates should be made to the model card, but it can still be exported.

pub fn security_config(&self) -> Option<&ModelCardSecurityConfig>

The security configuration used to protect model card data.

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

The date and time that the model card was created.

pub fn created_by(&self) -> Option<&UserContext>

Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.

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

The date and time that the model card was last modified.

pub fn last_modified_by(&self) -> Option<&UserContext>

Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.

pub fn tags(&self) -> &[Tag]

Key-value pairs used to manage metadata for the model card.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

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

The unique name (ID) of the model.

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

The risk rating of the model. Different organizations might have different criteria for model card risk ratings. For more information, see Risk ratings.

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

The model package group that contains the model package. Only relevant for model cards created for model packages in the Amazon SageMaker Model Registry.

impl ModelCard

pub fn builder() -> ModelCardBuilder

Creates a new builder-style object to manufacture ModelCard.

Trait Implementations

impl Clone for ModelCard

fn clone(&self) -> ModelCard

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModelCard

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

Formats the value using the given formatter.

impl PartialEq for ModelCard

fn eq(&self, other: &ModelCard) -> 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 ModelCard