Struct DescribeModelPackageOutput

#[non_exhaustive]
pub struct DescribeModelPackageOutput {

    pub model_package_name: Option<String>,
    pub model_package_group_name: Option<String>,
    pub model_package_version: Option<i32>,
    pub model_package_arn: Option<String>,
    pub model_package_description: Option<String>,
    pub creation_time: Option<DateTime>,
    pub inference_specification: Option<InferenceSpecification>,
    pub source_algorithm_specification: Option<SourceAlgorithmSpecification>,
    pub validation_specification: Option<ModelPackageValidationSpecification>,
    pub model_package_status: Option<ModelPackageStatus>,
    pub model_package_status_details: Option<ModelPackageStatusDetails>,
    pub certify_for_marketplace: Option<bool>,
    pub model_approval_status: Option<ModelApprovalStatus>,
    pub created_by: Option<UserContext>,
    pub metadata_properties: Option<MetadataProperties>,
    pub model_metrics: Option<ModelMetrics>,
    pub last_modified_time: Option<DateTime>,
    pub last_modified_by: Option<UserContext>,
    pub approval_description: Option<String>,
    pub domain: Option<String>,
    pub task: Option<String>,
    pub sample_payload_url: Option<String>,
    pub customer_metadata_properties: Option<HashMap<String, String>>,
    pub drift_check_baselines: Option<DriftCheckBaselines>,
    pub additional_inference_specifications: Option<Vec<AdditionalInferenceSpecificationDefinition>>,
    pub skip_model_validation: Option<SkipModelValidation>,
    pub source_uri: Option<String>,
    pub security_config: Option<ModelPackageSecurityConfig>,
    pub model_card: Option<ModelPackageModelCard>,
    pub model_life_cycle: Option<ModelLifeCycle>,
    /* private fields */
}

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_package_name: Option<String>

The name of the model package being described.

model_package_group_name: Option<String>

If the model is a versioned model, the name of the model group that the versioned model belongs to.

model_package_version: Option<i32>

The version of the model package.

model_package_arn: Option<String>

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

model_package_description: Option<String>

A brief summary of the model package.

creation_time: Option<DateTime>

A timestamp specifying when the model package was created.

inference_specification: Option<InferenceSpecification>

Details about inference jobs that you can run with models based on this model package.

source_algorithm_specification: Option<SourceAlgorithmSpecification>

Details about the algorithm that was used to create the model package.

validation_specification: Option<ModelPackageValidationSpecification>

Configurations for one or more transform jobs that SageMaker runs to test the model package.

model_package_status: Option<ModelPackageStatus>

The current status of the model package.

model_package_status_details: Option<ModelPackageStatusDetails>

Details about the current status of the model package.

certify_for_marketplace: Option<bool>

Whether the model package is certified for listing on Amazon Web Services Marketplace.

model_approval_status: Option<ModelApprovalStatus>

The approval status of the model package.

created_by: Option<UserContext>

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

metadata_properties: Option<MetadataProperties>

Metadata properties of the tracking entity, trial, or trial component.

model_metrics: Option<ModelMetrics>

Metrics for the model.

last_modified_time: Option<DateTime>

The last time that the model package was 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.

approval_description: Option<String>

A description provided for the model approval.

domain: Option<String>

The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.

task: Option<String>

The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification.

sample_payload_url: Option<String>

The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path points to a single gzip compressed tar archive (.tar.gz suffix).

customer_metadata_properties: Option<HashMap<String, String>>

The metadata properties associated with the model package versions.

drift_check_baselines: Option<DriftCheckBaselines>

Represents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.

additional_inference_specifications: Option<Vec<AdditionalInferenceSpecificationDefinition>>

An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

skip_model_validation: Option<SkipModelValidation>

Indicates if you want to skip model validation.

source_uri: Option<String>

The URI of the source for the model package.

security_config: Option<ModelPackageSecurityConfig>

The KMS Key ID (KMSKeyId) used for encryption of model package information.

model_card: Option<ModelPackageModelCard>

The model card associated with the model package. Since ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.

model_life_cycle: Option<ModelLifeCycle>

A structure describing the current state of the model in its life cycle.

Implementations

impl DescribeModelPackageOutput

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

The name of the model package being described.

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

If the model is a versioned model, the name of the model group that the versioned model belongs to.

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

The version of the model package.

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

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

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

A brief summary of the model package.

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

A timestamp specifying when the model package was created.

pub fn inference_specification(&self) -> Option<&InferenceSpecification>

Details about inference jobs that you can run with models based on this model package.

pub fn source_algorithm_specification( &self, ) -> Option<&SourceAlgorithmSpecification>

Details about the algorithm that was used to create the model package.

pub fn validation_specification( &self, ) -> Option<&ModelPackageValidationSpecification>

Configurations for one or more transform jobs that SageMaker runs to test the model package.

pub fn model_package_status(&self) -> Option<&ModelPackageStatus>

The current status of the model package.

pub fn model_package_status_details(&self) -> Option<&ModelPackageStatusDetails>

Details about the current status of the model package.

pub fn certify_for_marketplace(&self) -> Option<bool>

Whether the model package is certified for listing on Amazon Web Services Marketplace.

pub fn model_approval_status(&self) -> Option<&ModelApprovalStatus>

The approval status of the model package.

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 metadata_properties(&self) -> Option<&MetadataProperties>

Metadata properties of the tracking entity, trial, or trial component.

pub fn model_metrics(&self) -> Option<&ModelMetrics>

Metrics for the model.

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

The last time that the model package was 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 approval_description(&self) -> Option<&str>

A description provided for the model approval.

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

The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.

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

The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification.

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

The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path points to a single gzip compressed tar archive (.tar.gz suffix).

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

The metadata properties associated with the model package versions.

pub fn drift_check_baselines(&self) -> Option<&DriftCheckBaselines>

Represents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.

pub fn additional_inference_specifications( &self, ) -> &[AdditionalInferenceSpecificationDefinition]

An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

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

pub fn skip_model_validation(&self) -> Option<&SkipModelValidation>

Indicates if you want to skip model validation.

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

The URI of the source for the model package.

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

The KMS Key ID (KMSKeyId) used for encryption of model package information.

pub fn model_card(&self) -> Option<&ModelPackageModelCard>

The model card associated with the model package. Since ModelPackageModelCard is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of ModelCard. The ModelPackageModelCard schema does not include model_package_details, and model_overview is composed of the model_creator and model_artifact properties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.

pub fn model_life_cycle(&self) -> Option<&ModelLifeCycle>

A structure describing the current state of the model in its life cycle.

impl DescribeModelPackageOutput

pub fn builder() -> DescribeModelPackageOutputBuilder

Creates a new builder-style object to manufacture DescribeModelPackageOutput.

Trait Implementations

impl Clone for DescribeModelPackageOutput

fn clone(&self) -> DescribeModelPackageOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeModelPackageOutput

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

Formats the value using the given formatter.

impl PartialEq for DescribeModelPackageOutput

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

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for DescribeModelPackageOutput