// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct DescribeModelPackageOutput {
/// <p>The name of the model package being described.</p>
pub model_package_name: ::std::option::Option<::std::string::String>,
/// <p>If the model is a versioned model, the name of the model group that the versioned model belongs to.</p>
pub model_package_group_name: ::std::option::Option<::std::string::String>,
/// <p>The version of the model package.</p>
pub model_package_version: ::std::option::Option<i32>,
/// <p>The package registration type of the model package output.</p>
pub model_package_registration_type: ::std::option::Option<crate::types::ModelPackageRegistrationType>,
/// <p>The Amazon Resource Name (ARN) of the model package.</p>
pub model_package_arn: ::std::option::Option<::std::string::String>,
/// <p>A brief summary of the model package.</p>
pub model_package_description: ::std::option::Option<::std::string::String>,
/// <p>A timestamp specifying when the model package was created.</p>
pub creation_time: ::std::option::Option<::aws_smithy_types::DateTime>,
/// <p>Details about inference jobs that you can run with models based on this model package.</p>
pub inference_specification: ::std::option::Option<crate::types::InferenceSpecification>,
/// <p>Details about the algorithm that was used to create the model package.</p>
pub source_algorithm_specification: ::std::option::Option<crate::types::SourceAlgorithmSpecification>,
/// <p>Configurations for one or more transform jobs that SageMaker runs to test the model package.</p>
pub validation_specification: ::std::option::Option<crate::types::ModelPackageValidationSpecification>,
/// <p>The current status of the model package.</p>
pub model_package_status: ::std::option::Option<crate::types::ModelPackageStatus>,
/// <p>Details about the current status of the model package.</p>
pub model_package_status_details: ::std::option::Option<crate::types::ModelPackageStatusDetails>,
/// <p>Whether the model package is certified for listing on Amazon Web Services Marketplace.</p>
pub certify_for_marketplace: ::std::option::Option<bool>,
/// <p>The approval status of the model package.</p>
pub model_approval_status: ::std::option::Option<crate::types::ModelApprovalStatus>,
/// <p>Information about the user who created or modified a SageMaker resource.</p>
pub created_by: ::std::option::Option<crate::types::UserContext>,
/// <p>Metadata properties of the tracking entity, trial, or trial component.</p>
pub metadata_properties: ::std::option::Option<crate::types::MetadataProperties>,
/// <p>Metrics for the model.</p>
pub model_metrics: ::std::option::Option<crate::types::ModelMetrics>,
/// <p>The last time that the model package was modified.</p>
pub last_modified_time: ::std::option::Option<::aws_smithy_types::DateTime>,
/// <p>Information about the user who created or modified a SageMaker resource.</p>
pub last_modified_by: ::std::option::Option<crate::types::UserContext>,
/// <p>A description provided for the model approval.</p>
pub approval_description: ::std::option::Option<::std::string::String>,
/// <p>The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.</p>
pub domain: ::std::option::Option<::std::string::String>,
/// <p>The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification.</p>
pub task: ::std::option::Option<::std::string::String>,
/// <p>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).</p>
pub sample_payload_url: ::std::option::Option<::std::string::String>,
/// <p>The metadata properties associated with the model package versions.</p>
pub customer_metadata_properties: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
/// <p>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 <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/pipelines-quality-clarify-baseline-lifecycle.html#pipelines-quality-clarify-baseline-drift-detection">Drift Detection against Previous Baselines in SageMaker Pipelines</a> in the <i>Amazon SageMaker Developer Guide</i>.</p>
pub drift_check_baselines: ::std::option::Option<crate::types::DriftCheckBaselines>,
/// <p>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.</p>
pub additional_inference_specifications: ::std::option::Option<::std::vec::Vec<crate::types::AdditionalInferenceSpecificationDefinition>>,
/// <p>Indicates if you want to skip model validation.</p>
pub skip_model_validation: ::std::option::Option<crate::types::SkipModelValidation>,
/// <p>The URI of the source for the model package.</p>
pub source_uri: ::std::option::Option<::std::string::String>,
/// <p>The KMS Key ID (<code>KMSKeyId</code>) used for encryption of model package information.</p>
pub security_config: ::std::option::Option<crate::types::ModelPackageSecurityConfig>,
/// <p>The model card associated with the model package. Since <code>ModelPackageModelCard</code> 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 <code>ModelCard</code>. The <code>ModelPackageModelCard</code> schema does not include <code>model_package_details</code>, and <code>model_overview</code> is composed of the <code>model_creator</code> and <code>model_artifact</code> properties. For more information about the model package model card schema, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-registry-details.html#model-card-schema">Model package model card schema</a>. For more information about the model card associated with the model package, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-registry-details.html">View the Details of a Model Version</a>.</p>
pub model_card: ::std::option::Option<crate::types::ModelPackageModelCard>,
/// <p>A structure describing the current state of the model in its life cycle.</p>
pub model_life_cycle: ::std::option::Option<crate::types::ModelLifeCycle>,
_request_id: Option<String>,
}
impl DescribeModelPackageOutput {
/// <p>The name of the model package being described.</p>
pub fn model_package_name(&self) -> ::std::option::Option<&str> {
self.model_package_name.as_deref()
}
/// <p>If the model is a versioned model, the name of the model group that the versioned model belongs to.</p>
pub fn model_package_group_name(&self) -> ::std::option::Option<&str> {
self.model_package_group_name.as_deref()
}
/// <p>The version of the model package.</p>
pub fn model_package_version(&self) -> ::std::option::Option<i32> {
self.model_package_version
}
/// <p>The package registration type of the model package output.</p>
pub fn model_package_registration_type(&self) -> ::std::option::Option<&crate::types::ModelPackageRegistrationType> {
self.model_package_registration_type.as_ref()
}
/// <p>The Amazon Resource Name (ARN) of the model package.</p>
pub fn model_package_arn(&self) -> ::std::option::Option<&str> {
self.model_package_arn.as_deref()
}
/// <p>A brief summary of the model package.</p>
pub fn model_package_description(&self) -> ::std::option::Option<&str> {
self.model_package_description.as_deref()
}
/// <p>A timestamp specifying when the model package was created.</p>
pub fn creation_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
self.creation_time.as_ref()
}
/// <p>Details about inference jobs that you can run with models based on this model package.</p>
pub fn inference_specification(&self) -> ::std::option::Option<&crate::types::InferenceSpecification> {
self.inference_specification.as_ref()
}
/// <p>Details about the algorithm that was used to create the model package.</p>
pub fn source_algorithm_specification(&self) -> ::std::option::Option<&crate::types::SourceAlgorithmSpecification> {
self.source_algorithm_specification.as_ref()
}
/// <p>Configurations for one or more transform jobs that SageMaker runs to test the model package.</p>
pub fn validation_specification(&self) -> ::std::option::Option<&crate::types::ModelPackageValidationSpecification> {
self.validation_specification.as_ref()
}
/// <p>The current status of the model package.</p>
pub fn model_package_status(&self) -> ::std::option::Option<&crate::types::ModelPackageStatus> {
self.model_package_status.as_ref()
}
/// <p>Details about the current status of the model package.</p>
pub fn model_package_status_details(&self) -> ::std::option::Option<&crate::types::ModelPackageStatusDetails> {
self.model_package_status_details.as_ref()
}
/// <p>Whether the model package is certified for listing on Amazon Web Services Marketplace.</p>
pub fn certify_for_marketplace(&self) -> ::std::option::Option<bool> {
self.certify_for_marketplace
}
/// <p>The approval status of the model package.</p>
pub fn model_approval_status(&self) -> ::std::option::Option<&crate::types::ModelApprovalStatus> {
self.model_approval_status.as_ref()
}
/// <p>Information about the user who created or modified a SageMaker resource.</p>
pub fn created_by(&self) -> ::std::option::Option<&crate::types::UserContext> {
self.created_by.as_ref()
}
/// <p>Metadata properties of the tracking entity, trial, or trial component.</p>
pub fn metadata_properties(&self) -> ::std::option::Option<&crate::types::MetadataProperties> {
self.metadata_properties.as_ref()
}
/// <p>Metrics for the model.</p>
pub fn model_metrics(&self) -> ::std::option::Option<&crate::types::ModelMetrics> {
self.model_metrics.as_ref()
}
/// <p>The last time that the model package was modified.</p>
pub fn last_modified_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
self.last_modified_time.as_ref()
}
/// <p>Information about the user who created or modified a SageMaker resource.</p>
pub fn last_modified_by(&self) -> ::std::option::Option<&crate::types::UserContext> {
self.last_modified_by.as_ref()
}
/// <p>A description provided for the model approval.</p>
pub fn approval_description(&self) -> ::std::option::Option<&str> {
self.approval_description.as_deref()
}
/// <p>The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.</p>
pub fn domain(&self) -> ::std::option::Option<&str> {
self.domain.as_deref()
}
/// <p>The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification.</p>
pub fn task(&self) -> ::std::option::Option<&str> {
self.task.as_deref()
}
/// <p>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).</p>
pub fn sample_payload_url(&self) -> ::std::option::Option<&str> {
self.sample_payload_url.as_deref()
}
/// <p>The metadata properties associated with the model package versions.</p>
pub fn customer_metadata_properties(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
self.customer_metadata_properties.as_ref()
}
/// <p>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 <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/pipelines-quality-clarify-baseline-lifecycle.html#pipelines-quality-clarify-baseline-drift-detection">Drift Detection against Previous Baselines in SageMaker Pipelines</a> in the <i>Amazon SageMaker Developer Guide</i>.</p>
pub fn drift_check_baselines(&self) -> ::std::option::Option<&crate::types::DriftCheckBaselines> {
self.drift_check_baselines.as_ref()
}
/// <p>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.</p>
///
/// 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 additional_inference_specifications(&self) -> &[crate::types::AdditionalInferenceSpecificationDefinition] {
self.additional_inference_specifications.as_deref().unwrap_or_default()
}
/// <p>Indicates if you want to skip model validation.</p>
pub fn skip_model_validation(&self) -> ::std::option::Option<&crate::types::SkipModelValidation> {
self.skip_model_validation.as_ref()
}
/// <p>The URI of the source for the model package.</p>
pub fn source_uri(&self) -> ::std::option::Option<&str> {
self.source_uri.as_deref()
}
/// <p>The KMS Key ID (<code>KMSKeyId</code>) used for encryption of model package information.</p>
pub fn security_config(&self) -> ::std::option::Option<&crate::types::ModelPackageSecurityConfig> {
self.security_config.as_ref()
}
/// <p>The model card associated with the model package. Since <code>ModelPackageModelCard</code> 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 <code>ModelCard</code>. The <code>ModelPackageModelCard</code> schema does not include <code>model_package_details</code>, and <code>model_overview</code> is composed of the <code>model_creator</code> and <code>model_artifact</code> properties. For more information about the model package model card schema, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-registry-details.html#model-card-schema">Model package model card schema</a>. For more information about the model card associated with the model package, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-registry-details.html">View the Details of a Model Version</a>.</p>
pub fn model_card(&self) -> ::std::option::Option<&crate::types::ModelPackageModelCard> {
self.model_card.as_ref()
}
/// <p>A structure describing the current state of the model in its life cycle.</p>
pub fn model_life_cycle(&self) -> ::std::option::Option<&crate::types::ModelLifeCycle> {
self.model_life_cycle.as_ref()
}
}
impl ::aws_types::request_id::RequestId for DescribeModelPackageOutput {
fn request_id(&self) -> Option<&str> {
self._request_id.as_deref()
}
}
impl DescribeModelPackageOutput {
/// Creates a new builder-style object to manufacture [`DescribeModelPackageOutput`](crate::operation::describe_model_package::DescribeModelPackageOutput).
pub fn builder() -> crate::operation::describe_model_package::builders::DescribeModelPackageOutputBuilder {
crate::operation::describe_model_package::builders::DescribeModelPackageOutputBuilder::default()
}
}
/// A builder for [`DescribeModelPackageOutput`](crate::operation::describe_model_package::DescribeModelPackageOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct DescribeModelPackageOutputBuilder {
pub(crate) model_package_name: ::std::option::Option<::std::string::String>,
pub(crate) model_package_group_name: ::std::option::Option<::std::string::String>,
pub(crate) model_package_version: ::std::option::Option<i32>,
pub(crate) model_package_registration_type: ::std::option::Option<crate::types::ModelPackageRegistrationType>,
pub(crate) model_package_arn: ::std::option::Option<::std::string::String>,
pub(crate) model_package_description: ::std::option::Option<::std::string::String>,
pub(crate) creation_time: ::std::option::Option<::aws_smithy_types::DateTime>,
pub(crate) inference_specification: ::std::option::Option<crate::types::InferenceSpecification>,
pub(crate) source_algorithm_specification: ::std::option::Option<crate::types::SourceAlgorithmSpecification>,
pub(crate) validation_specification: ::std::option::Option<crate::types::ModelPackageValidationSpecification>,
pub(crate) model_package_status: ::std::option::Option<crate::types::ModelPackageStatus>,
pub(crate) model_package_status_details: ::std::option::Option<crate::types::ModelPackageStatusDetails>,
pub(crate) certify_for_marketplace: ::std::option::Option<bool>,
pub(crate) model_approval_status: ::std::option::Option<crate::types::ModelApprovalStatus>,
pub(crate) created_by: ::std::option::Option<crate::types::UserContext>,
pub(crate) metadata_properties: ::std::option::Option<crate::types::MetadataProperties>,
pub(crate) model_metrics: ::std::option::Option<crate::types::ModelMetrics>,
pub(crate) last_modified_time: ::std::option::Option<::aws_smithy_types::DateTime>,
pub(crate) last_modified_by: ::std::option::Option<crate::types::UserContext>,
pub(crate) approval_description: ::std::option::Option<::std::string::String>,
pub(crate) domain: ::std::option::Option<::std::string::String>,
pub(crate) task: ::std::option::Option<::std::string::String>,
pub(crate) sample_payload_url: ::std::option::Option<::std::string::String>,
pub(crate) customer_metadata_properties: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
pub(crate) drift_check_baselines: ::std::option::Option<crate::types::DriftCheckBaselines>,
pub(crate) additional_inference_specifications: ::std::option::Option<::std::vec::Vec<crate::types::AdditionalInferenceSpecificationDefinition>>,
pub(crate) skip_model_validation: ::std::option::Option<crate::types::SkipModelValidation>,
pub(crate) source_uri: ::std::option::Option<::std::string::String>,
pub(crate) security_config: ::std::option::Option<crate::types::ModelPackageSecurityConfig>,
pub(crate) model_card: ::std::option::Option<crate::types::ModelPackageModelCard>,
pub(crate) model_life_cycle: ::std::option::Option<crate::types::ModelLifeCycle>,
_request_id: Option<String>,
}
impl DescribeModelPackageOutputBuilder {
/// <p>The name of the model package being described.</p>
/// This field is required.
pub fn model_package_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.model_package_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the model package being described.</p>
pub fn set_model_package_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.model_package_name = input;
self
}
/// <p>The name of the model package being described.</p>
pub fn get_model_package_name(&self) -> &::std::option::Option<::std::string::String> {
&self.model_package_name
}
/// <p>If the model is a versioned model, the name of the model group that the versioned model belongs to.</p>
pub fn model_package_group_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.model_package_group_name = ::std::option::Option::Some(input.into());
self
}
/// <p>If the model is a versioned model, the name of the model group that the versioned model belongs to.</p>
pub fn set_model_package_group_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.model_package_group_name = input;
self
}
/// <p>If the model is a versioned model, the name of the model group that the versioned model belongs to.</p>
pub fn get_model_package_group_name(&self) -> &::std::option::Option<::std::string::String> {
&self.model_package_group_name
}
/// <p>The version of the model package.</p>
pub fn model_package_version(mut self, input: i32) -> Self {
self.model_package_version = ::std::option::Option::Some(input);
self
}
/// <p>The version of the model package.</p>
pub fn set_model_package_version(mut self, input: ::std::option::Option<i32>) -> Self {
self.model_package_version = input;
self
}
/// <p>The version of the model package.</p>
pub fn get_model_package_version(&self) -> &::std::option::Option<i32> {
&self.model_package_version
}
/// <p>The package registration type of the model package output.</p>
pub fn model_package_registration_type(mut self, input: crate::types::ModelPackageRegistrationType) -> Self {
self.model_package_registration_type = ::std::option::Option::Some(input);
self
}
/// <p>The package registration type of the model package output.</p>
pub fn set_model_package_registration_type(mut self, input: ::std::option::Option<crate::types::ModelPackageRegistrationType>) -> Self {
self.model_package_registration_type = input;
self
}
/// <p>The package registration type of the model package output.</p>
pub fn get_model_package_registration_type(&self) -> &::std::option::Option<crate::types::ModelPackageRegistrationType> {
&self.model_package_registration_type
}
/// <p>The Amazon Resource Name (ARN) of the model package.</p>
/// This field is required.
pub fn model_package_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.model_package_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of the model package.</p>
pub fn set_model_package_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.model_package_arn = input;
self
}
/// <p>The Amazon Resource Name (ARN) of the model package.</p>
pub fn get_model_package_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.model_package_arn
}
/// <p>A brief summary of the model package.</p>
pub fn model_package_description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.model_package_description = ::std::option::Option::Some(input.into());
self
}
/// <p>A brief summary of the model package.</p>
pub fn set_model_package_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.model_package_description = input;
self
}
/// <p>A brief summary of the model package.</p>
pub fn get_model_package_description(&self) -> &::std::option::Option<::std::string::String> {
&self.model_package_description
}
/// <p>A timestamp specifying when the model package was created.</p>
/// This field is required.
pub fn creation_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.creation_time = ::std::option::Option::Some(input);
self
}
/// <p>A timestamp specifying when the model package was created.</p>
pub fn set_creation_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.creation_time = input;
self
}
/// <p>A timestamp specifying when the model package was created.</p>
pub fn get_creation_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.creation_time
}
/// <p>Details about inference jobs that you can run with models based on this model package.</p>
pub fn inference_specification(mut self, input: crate::types::InferenceSpecification) -> Self {
self.inference_specification = ::std::option::Option::Some(input);
self
}
/// <p>Details about inference jobs that you can run with models based on this model package.</p>
pub fn set_inference_specification(mut self, input: ::std::option::Option<crate::types::InferenceSpecification>) -> Self {
self.inference_specification = input;
self
}
/// <p>Details about inference jobs that you can run with models based on this model package.</p>
pub fn get_inference_specification(&self) -> &::std::option::Option<crate::types::InferenceSpecification> {
&self.inference_specification
}
/// <p>Details about the algorithm that was used to create the model package.</p>
pub fn source_algorithm_specification(mut self, input: crate::types::SourceAlgorithmSpecification) -> Self {
self.source_algorithm_specification = ::std::option::Option::Some(input);
self
}
/// <p>Details about the algorithm that was used to create the model package.</p>
pub fn set_source_algorithm_specification(mut self, input: ::std::option::Option<crate::types::SourceAlgorithmSpecification>) -> Self {
self.source_algorithm_specification = input;
self
}
/// <p>Details about the algorithm that was used to create the model package.</p>
pub fn get_source_algorithm_specification(&self) -> &::std::option::Option<crate::types::SourceAlgorithmSpecification> {
&self.source_algorithm_specification
}
/// <p>Configurations for one or more transform jobs that SageMaker runs to test the model package.</p>
pub fn validation_specification(mut self, input: crate::types::ModelPackageValidationSpecification) -> Self {
self.validation_specification = ::std::option::Option::Some(input);
self
}
/// <p>Configurations for one or more transform jobs that SageMaker runs to test the model package.</p>
pub fn set_validation_specification(mut self, input: ::std::option::Option<crate::types::ModelPackageValidationSpecification>) -> Self {
self.validation_specification = input;
self
}
/// <p>Configurations for one or more transform jobs that SageMaker runs to test the model package.</p>
pub fn get_validation_specification(&self) -> &::std::option::Option<crate::types::ModelPackageValidationSpecification> {
&self.validation_specification
}
/// <p>The current status of the model package.</p>
/// This field is required.
pub fn model_package_status(mut self, input: crate::types::ModelPackageStatus) -> Self {
self.model_package_status = ::std::option::Option::Some(input);
self
}
/// <p>The current status of the model package.</p>
pub fn set_model_package_status(mut self, input: ::std::option::Option<crate::types::ModelPackageStatus>) -> Self {
self.model_package_status = input;
self
}
/// <p>The current status of the model package.</p>
pub fn get_model_package_status(&self) -> &::std::option::Option<crate::types::ModelPackageStatus> {
&self.model_package_status
}
/// <p>Details about the current status of the model package.</p>
/// This field is required.
pub fn model_package_status_details(mut self, input: crate::types::ModelPackageStatusDetails) -> Self {
self.model_package_status_details = ::std::option::Option::Some(input);
self
}
/// <p>Details about the current status of the model package.</p>
pub fn set_model_package_status_details(mut self, input: ::std::option::Option<crate::types::ModelPackageStatusDetails>) -> Self {
self.model_package_status_details = input;
self
}
/// <p>Details about the current status of the model package.</p>
pub fn get_model_package_status_details(&self) -> &::std::option::Option<crate::types::ModelPackageStatusDetails> {
&self.model_package_status_details
}
/// <p>Whether the model package is certified for listing on Amazon Web Services Marketplace.</p>
pub fn certify_for_marketplace(mut self, input: bool) -> Self {
self.certify_for_marketplace = ::std::option::Option::Some(input);
self
}
/// <p>Whether the model package is certified for listing on Amazon Web Services Marketplace.</p>
pub fn set_certify_for_marketplace(mut self, input: ::std::option::Option<bool>) -> Self {
self.certify_for_marketplace = input;
self
}
/// <p>Whether the model package is certified for listing on Amazon Web Services Marketplace.</p>
pub fn get_certify_for_marketplace(&self) -> &::std::option::Option<bool> {
&self.certify_for_marketplace
}
/// <p>The approval status of the model package.</p>
pub fn model_approval_status(mut self, input: crate::types::ModelApprovalStatus) -> Self {
self.model_approval_status = ::std::option::Option::Some(input);
self
}
/// <p>The approval status of the model package.</p>
pub fn set_model_approval_status(mut self, input: ::std::option::Option<crate::types::ModelApprovalStatus>) -> Self {
self.model_approval_status = input;
self
}
/// <p>The approval status of the model package.</p>
pub fn get_model_approval_status(&self) -> &::std::option::Option<crate::types::ModelApprovalStatus> {
&self.model_approval_status
}
/// <p>Information about the user who created or modified a SageMaker resource.</p>
pub fn created_by(mut self, input: crate::types::UserContext) -> Self {
self.created_by = ::std::option::Option::Some(input);
self
}
/// <p>Information about the user who created or modified a SageMaker resource.</p>
pub fn set_created_by(mut self, input: ::std::option::Option<crate::types::UserContext>) -> Self {
self.created_by = input;
self
}
/// <p>Information about the user who created or modified a SageMaker resource.</p>
pub fn get_created_by(&self) -> &::std::option::Option<crate::types::UserContext> {
&self.created_by
}
/// <p>Metadata properties of the tracking entity, trial, or trial component.</p>
pub fn metadata_properties(mut self, input: crate::types::MetadataProperties) -> Self {
self.metadata_properties = ::std::option::Option::Some(input);
self
}
/// <p>Metadata properties of the tracking entity, trial, or trial component.</p>
pub fn set_metadata_properties(mut self, input: ::std::option::Option<crate::types::MetadataProperties>) -> Self {
self.metadata_properties = input;
self
}
/// <p>Metadata properties of the tracking entity, trial, or trial component.</p>
pub fn get_metadata_properties(&self) -> &::std::option::Option<crate::types::MetadataProperties> {
&self.metadata_properties
}
/// <p>Metrics for the model.</p>
pub fn model_metrics(mut self, input: crate::types::ModelMetrics) -> Self {
self.model_metrics = ::std::option::Option::Some(input);
self
}
/// <p>Metrics for the model.</p>
pub fn set_model_metrics(mut self, input: ::std::option::Option<crate::types::ModelMetrics>) -> Self {
self.model_metrics = input;
self
}
/// <p>Metrics for the model.</p>
pub fn get_model_metrics(&self) -> &::std::option::Option<crate::types::ModelMetrics> {
&self.model_metrics
}
/// <p>The last time that the model package was modified.</p>
pub fn last_modified_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.last_modified_time = ::std::option::Option::Some(input);
self
}
/// <p>The last time that the model package was modified.</p>
pub fn set_last_modified_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.last_modified_time = input;
self
}
/// <p>The last time that the model package was modified.</p>
pub fn get_last_modified_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.last_modified_time
}
/// <p>Information about the user who created or modified a SageMaker resource.</p>
pub fn last_modified_by(mut self, input: crate::types::UserContext) -> Self {
self.last_modified_by = ::std::option::Option::Some(input);
self
}
/// <p>Information about the user who created or modified a SageMaker resource.</p>
pub fn set_last_modified_by(mut self, input: ::std::option::Option<crate::types::UserContext>) -> Self {
self.last_modified_by = input;
self
}
/// <p>Information about the user who created or modified a SageMaker resource.</p>
pub fn get_last_modified_by(&self) -> &::std::option::Option<crate::types::UserContext> {
&self.last_modified_by
}
/// <p>A description provided for the model approval.</p>
pub fn approval_description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.approval_description = ::std::option::Option::Some(input.into());
self
}
/// <p>A description provided for the model approval.</p>
pub fn set_approval_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.approval_description = input;
self
}
/// <p>A description provided for the model approval.</p>
pub fn get_approval_description(&self) -> &::std::option::Option<::std::string::String> {
&self.approval_description
}
/// <p>The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.</p>
pub fn domain(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.domain = ::std::option::Option::Some(input.into());
self
}
/// <p>The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.</p>
pub fn set_domain(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.domain = input;
self
}
/// <p>The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.</p>
pub fn get_domain(&self) -> &::std::option::Option<::std::string::String> {
&self.domain
}
/// <p>The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification.</p>
pub fn task(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.task = ::std::option::Option::Some(input.into());
self
}
/// <p>The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification.</p>
pub fn set_task(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.task = input;
self
}
/// <p>The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification.</p>
pub fn get_task(&self) -> &::std::option::Option<::std::string::String> {
&self.task
}
/// <p>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).</p>
pub fn sample_payload_url(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.sample_payload_url = ::std::option::Option::Some(input.into());
self
}
/// <p>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).</p>
pub fn set_sample_payload_url(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.sample_payload_url = input;
self
}
/// <p>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).</p>
pub fn get_sample_payload_url(&self) -> &::std::option::Option<::std::string::String> {
&self.sample_payload_url
}
/// Adds a key-value pair to `customer_metadata_properties`.
///
/// To override the contents of this collection use [`set_customer_metadata_properties`](Self::set_customer_metadata_properties).
///
/// <p>The metadata properties associated with the model package versions.</p>
pub fn customer_metadata_properties(
mut self,
k: impl ::std::convert::Into<::std::string::String>,
v: impl ::std::convert::Into<::std::string::String>,
) -> Self {
let mut hash_map = self.customer_metadata_properties.unwrap_or_default();
hash_map.insert(k.into(), v.into());
self.customer_metadata_properties = ::std::option::Option::Some(hash_map);
self
}
/// <p>The metadata properties associated with the model package versions.</p>
pub fn set_customer_metadata_properties(
mut self,
input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
) -> Self {
self.customer_metadata_properties = input;
self
}
/// <p>The metadata properties associated with the model package versions.</p>
pub fn get_customer_metadata_properties(
&self,
) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
&self.customer_metadata_properties
}
/// <p>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 <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/pipelines-quality-clarify-baseline-lifecycle.html#pipelines-quality-clarify-baseline-drift-detection">Drift Detection against Previous Baselines in SageMaker Pipelines</a> in the <i>Amazon SageMaker Developer Guide</i>.</p>
pub fn drift_check_baselines(mut self, input: crate::types::DriftCheckBaselines) -> Self {
self.drift_check_baselines = ::std::option::Option::Some(input);
self
}
/// <p>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 <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/pipelines-quality-clarify-baseline-lifecycle.html#pipelines-quality-clarify-baseline-drift-detection">Drift Detection against Previous Baselines in SageMaker Pipelines</a> in the <i>Amazon SageMaker Developer Guide</i>.</p>
pub fn set_drift_check_baselines(mut self, input: ::std::option::Option<crate::types::DriftCheckBaselines>) -> Self {
self.drift_check_baselines = input;
self
}
/// <p>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 <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/pipelines-quality-clarify-baseline-lifecycle.html#pipelines-quality-clarify-baseline-drift-detection">Drift Detection against Previous Baselines in SageMaker Pipelines</a> in the <i>Amazon SageMaker Developer Guide</i>.</p>
pub fn get_drift_check_baselines(&self) -> &::std::option::Option<crate::types::DriftCheckBaselines> {
&self.drift_check_baselines
}
/// Appends an item to `additional_inference_specifications`.
///
/// To override the contents of this collection use [`set_additional_inference_specifications`](Self::set_additional_inference_specifications).
///
/// <p>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.</p>
pub fn additional_inference_specifications(mut self, input: crate::types::AdditionalInferenceSpecificationDefinition) -> Self {
let mut v = self.additional_inference_specifications.unwrap_or_default();
v.push(input);
self.additional_inference_specifications = ::std::option::Option::Some(v);
self
}
/// <p>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.</p>
pub fn set_additional_inference_specifications(
mut self,
input: ::std::option::Option<::std::vec::Vec<crate::types::AdditionalInferenceSpecificationDefinition>>,
) -> Self {
self.additional_inference_specifications = input;
self
}
/// <p>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.</p>
pub fn get_additional_inference_specifications(
&self,
) -> &::std::option::Option<::std::vec::Vec<crate::types::AdditionalInferenceSpecificationDefinition>> {
&self.additional_inference_specifications
}
/// <p>Indicates if you want to skip model validation.</p>
pub fn skip_model_validation(mut self, input: crate::types::SkipModelValidation) -> Self {
self.skip_model_validation = ::std::option::Option::Some(input);
self
}
/// <p>Indicates if you want to skip model validation.</p>
pub fn set_skip_model_validation(mut self, input: ::std::option::Option<crate::types::SkipModelValidation>) -> Self {
self.skip_model_validation = input;
self
}
/// <p>Indicates if you want to skip model validation.</p>
pub fn get_skip_model_validation(&self) -> &::std::option::Option<crate::types::SkipModelValidation> {
&self.skip_model_validation
}
/// <p>The URI of the source for the model package.</p>
pub fn source_uri(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.source_uri = ::std::option::Option::Some(input.into());
self
}
/// <p>The URI of the source for the model package.</p>
pub fn set_source_uri(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.source_uri = input;
self
}
/// <p>The URI of the source for the model package.</p>
pub fn get_source_uri(&self) -> &::std::option::Option<::std::string::String> {
&self.source_uri
}
/// <p>The KMS Key ID (<code>KMSKeyId</code>) used for encryption of model package information.</p>
pub fn security_config(mut self, input: crate::types::ModelPackageSecurityConfig) -> Self {
self.security_config = ::std::option::Option::Some(input);
self
}
/// <p>The KMS Key ID (<code>KMSKeyId</code>) used for encryption of model package information.</p>
pub fn set_security_config(mut self, input: ::std::option::Option<crate::types::ModelPackageSecurityConfig>) -> Self {
self.security_config = input;
self
}
/// <p>The KMS Key ID (<code>KMSKeyId</code>) used for encryption of model package information.</p>
pub fn get_security_config(&self) -> &::std::option::Option<crate::types::ModelPackageSecurityConfig> {
&self.security_config
}
/// <p>The model card associated with the model package. Since <code>ModelPackageModelCard</code> 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 <code>ModelCard</code>. The <code>ModelPackageModelCard</code> schema does not include <code>model_package_details</code>, and <code>model_overview</code> is composed of the <code>model_creator</code> and <code>model_artifact</code> properties. For more information about the model package model card schema, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-registry-details.html#model-card-schema">Model package model card schema</a>. For more information about the model card associated with the model package, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-registry-details.html">View the Details of a Model Version</a>.</p>
pub fn model_card(mut self, input: crate::types::ModelPackageModelCard) -> Self {
self.model_card = ::std::option::Option::Some(input);
self
}
/// <p>The model card associated with the model package. Since <code>ModelPackageModelCard</code> 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 <code>ModelCard</code>. The <code>ModelPackageModelCard</code> schema does not include <code>model_package_details</code>, and <code>model_overview</code> is composed of the <code>model_creator</code> and <code>model_artifact</code> properties. For more information about the model package model card schema, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-registry-details.html#model-card-schema">Model package model card schema</a>. For more information about the model card associated with the model package, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-registry-details.html">View the Details of a Model Version</a>.</p>
pub fn set_model_card(mut self, input: ::std::option::Option<crate::types::ModelPackageModelCard>) -> Self {
self.model_card = input;
self
}
/// <p>The model card associated with the model package. Since <code>ModelPackageModelCard</code> 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 <code>ModelCard</code>. The <code>ModelPackageModelCard</code> schema does not include <code>model_package_details</code>, and <code>model_overview</code> is composed of the <code>model_creator</code> and <code>model_artifact</code> properties. For more information about the model package model card schema, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-registry-details.html#model-card-schema">Model package model card schema</a>. For more information about the model card associated with the model package, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-registry-details.html">View the Details of a Model Version</a>.</p>
pub fn get_model_card(&self) -> &::std::option::Option<crate::types::ModelPackageModelCard> {
&self.model_card
}
/// <p>A structure describing the current state of the model in its life cycle.</p>
pub fn model_life_cycle(mut self, input: crate::types::ModelLifeCycle) -> Self {
self.model_life_cycle = ::std::option::Option::Some(input);
self
}
/// <p>A structure describing the current state of the model in its life cycle.</p>
pub fn set_model_life_cycle(mut self, input: ::std::option::Option<crate::types::ModelLifeCycle>) -> Self {
self.model_life_cycle = input;
self
}
/// <p>A structure describing the current state of the model in its life cycle.</p>
pub fn get_model_life_cycle(&self) -> &::std::option::Option<crate::types::ModelLifeCycle> {
&self.model_life_cycle
}
pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
self._request_id = Some(request_id.into());
self
}
pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
self._request_id = request_id;
self
}
/// Consumes the builder and constructs a [`DescribeModelPackageOutput`](crate::operation::describe_model_package::DescribeModelPackageOutput).
pub fn build(self) -> crate::operation::describe_model_package::DescribeModelPackageOutput {
crate::operation::describe_model_package::DescribeModelPackageOutput {
model_package_name: self.model_package_name,
model_package_group_name: self.model_package_group_name,
model_package_version: self.model_package_version,
model_package_registration_type: self.model_package_registration_type,
model_package_arn: self.model_package_arn,
model_package_description: self.model_package_description,
creation_time: self.creation_time,
inference_specification: self.inference_specification,
source_algorithm_specification: self.source_algorithm_specification,
validation_specification: self.validation_specification,
model_package_status: self.model_package_status,
model_package_status_details: self.model_package_status_details,
certify_for_marketplace: self.certify_for_marketplace,
model_approval_status: self.model_approval_status,
created_by: self.created_by,
metadata_properties: self.metadata_properties,
model_metrics: self.model_metrics,
last_modified_time: self.last_modified_time,
last_modified_by: self.last_modified_by,
approval_description: self.approval_description,
domain: self.domain,
task: self.task,
sample_payload_url: self.sample_payload_url,
customer_metadata_properties: self.customer_metadata_properties,
drift_check_baselines: self.drift_check_baselines,
additional_inference_specifications: self.additional_inference_specifications,
skip_model_validation: self.skip_model_validation,
source_uri: self.source_uri,
security_config: self.security_config,
model_card: self.model_card,
model_life_cycle: self.model_life_cycle,
_request_id: self._request_id,
}
}
}