aws_sdk_sagemaker/operation/create_model_card/

_create_model_card_input.rs

// 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)]
pub struct CreateModelCardInput {
    /// <p>The unique name of the model card.</p>
    pub model_card_name: ::std::option::Option<::std::string::String>,
    /// <p>An optional Key Management Service key to encrypt, decrypt, and re-encrypt model card content for regulated workloads with highly sensitive data.</p>
    pub security_config: ::std::option::Option<crate::types::ModelCardSecurityConfig>,
    /// <p>The content of the model card. Content must be in <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema">model card JSON schema</a> and provided as a string.</p>
    pub content: ::std::option::Option<::std::string::String>,
    /// <p>The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.</p>
    /// <ul>
    /// <li>
    /// <p><code>Draft</code>: The model card is a work in progress.</p></li>
    /// <li>
    /// <p><code>PendingReview</code>: The model card is pending review.</p></li>
    /// <li>
    /// <p><code>Approved</code>: The model card is approved.</p></li>
    /// <li>
    /// <p><code>Archived</code>: The model card is archived. No more updates should be made to the model card, but it can still be exported.</p></li>
    /// </ul>
    pub model_card_status: ::std::option::Option<crate::types::ModelCardStatus>,
    /// <p>Key-value pairs used to manage metadata for model cards.</p>
    pub tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
}
impl CreateModelCardInput {
    /// <p>The unique name of the model card.</p>
    pub fn model_card_name(&self) -> ::std::option::Option<&str> {
        self.model_card_name.as_deref()
    }
    /// <p>An optional Key Management Service key to encrypt, decrypt, and re-encrypt model card content for regulated workloads with highly sensitive data.</p>
    pub fn security_config(&self) -> ::std::option::Option<&crate::types::ModelCardSecurityConfig> {
        self.security_config.as_ref()
    }
    /// <p>The content of the model card. Content must be in <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema">model card JSON schema</a> and provided as a string.</p>
    pub fn content(&self) -> ::std::option::Option<&str> {
        self.content.as_deref()
    }
    /// <p>The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.</p>
    /// <ul>
    /// <li>
    /// <p><code>Draft</code>: The model card is a work in progress.</p></li>
    /// <li>
    /// <p><code>PendingReview</code>: The model card is pending review.</p></li>
    /// <li>
    /// <p><code>Approved</code>: The model card is approved.</p></li>
    /// <li>
    /// <p><code>Archived</code>: The model card is archived. No more updates should be made to the model card, but it can still be exported.</p></li>
    /// </ul>
    pub fn model_card_status(&self) -> ::std::option::Option<&crate::types::ModelCardStatus> {
        self.model_card_status.as_ref()
    }
    /// <p>Key-value pairs used to manage metadata for model cards.</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 `.tags.is_none()`.
    pub fn tags(&self) -> &[crate::types::Tag] {
        self.tags.as_deref().unwrap_or_default()
    }
}
impl ::std::fmt::Debug for CreateModelCardInput {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("CreateModelCardInput");
        formatter.field("model_card_name", &self.model_card_name);
        formatter.field("security_config", &self.security_config);
        formatter.field("content", &"*** Sensitive Data Redacted ***");
        formatter.field("model_card_status", &self.model_card_status);
        formatter.field("tags", &self.tags);
        formatter.finish()
    }
}
impl CreateModelCardInput {
    /// Creates a new builder-style object to manufacture [`CreateModelCardInput`](crate::operation::create_model_card::CreateModelCardInput).
    pub fn builder() -> crate::operation::create_model_card::builders::CreateModelCardInputBuilder {
        crate::operation::create_model_card::builders::CreateModelCardInputBuilder::default()
    }
}

/// A builder for [`CreateModelCardInput`](crate::operation::create_model_card::CreateModelCardInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default)]
#[non_exhaustive]
pub struct CreateModelCardInputBuilder {
    pub(crate) model_card_name: ::std::option::Option<::std::string::String>,
    pub(crate) security_config: ::std::option::Option<crate::types::ModelCardSecurityConfig>,
    pub(crate) content: ::std::option::Option<::std::string::String>,
    pub(crate) model_card_status: ::std::option::Option<crate::types::ModelCardStatus>,
    pub(crate) tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
}
impl CreateModelCardInputBuilder {
    /// <p>The unique name of the model card.</p>
    /// This field is required.
    pub fn model_card_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.model_card_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The unique name of the model card.</p>
    pub fn set_model_card_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.model_card_name = input;
        self
    }
    /// <p>The unique name of the model card.</p>
    pub fn get_model_card_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.model_card_name
    }
    /// <p>An optional Key Management Service key to encrypt, decrypt, and re-encrypt model card content for regulated workloads with highly sensitive data.</p>
    pub fn security_config(mut self, input: crate::types::ModelCardSecurityConfig) -> Self {
        self.security_config = ::std::option::Option::Some(input);
        self
    }
    /// <p>An optional Key Management Service key to encrypt, decrypt, and re-encrypt model card content for regulated workloads with highly sensitive data.</p>
    pub fn set_security_config(mut self, input: ::std::option::Option<crate::types::ModelCardSecurityConfig>) -> Self {
        self.security_config = input;
        self
    }
    /// <p>An optional Key Management Service key to encrypt, decrypt, and re-encrypt model card content for regulated workloads with highly sensitive data.</p>
    pub fn get_security_config(&self) -> &::std::option::Option<crate::types::ModelCardSecurityConfig> {
        &self.security_config
    }
    /// <p>The content of the model card. Content must be in <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema">model card JSON schema</a> and provided as a string.</p>
    /// This field is required.
    pub fn content(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.content = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The content of the model card. Content must be in <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema">model card JSON schema</a> and provided as a string.</p>
    pub fn set_content(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.content = input;
        self
    }
    /// <p>The content of the model card. Content must be in <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema">model card JSON schema</a> and provided as a string.</p>
    pub fn get_content(&self) -> &::std::option::Option<::std::string::String> {
        &self.content
    }
    /// <p>The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.</p>
    /// <ul>
    /// <li>
    /// <p><code>Draft</code>: The model card is a work in progress.</p></li>
    /// <li>
    /// <p><code>PendingReview</code>: The model card is pending review.</p></li>
    /// <li>
    /// <p><code>Approved</code>: The model card is approved.</p></li>
    /// <li>
    /// <p><code>Archived</code>: The model card is archived. No more updates should be made to the model card, but it can still be exported.</p></li>
    /// </ul>
    /// This field is required.
    pub fn model_card_status(mut self, input: crate::types::ModelCardStatus) -> Self {
        self.model_card_status = ::std::option::Option::Some(input);
        self
    }
    /// <p>The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.</p>
    /// <ul>
    /// <li>
    /// <p><code>Draft</code>: The model card is a work in progress.</p></li>
    /// <li>
    /// <p><code>PendingReview</code>: The model card is pending review.</p></li>
    /// <li>
    /// <p><code>Approved</code>: The model card is approved.</p></li>
    /// <li>
    /// <p><code>Archived</code>: The model card is archived. No more updates should be made to the model card, but it can still be exported.</p></li>
    /// </ul>
    pub fn set_model_card_status(mut self, input: ::std::option::Option<crate::types::ModelCardStatus>) -> Self {
        self.model_card_status = input;
        self
    }
    /// <p>The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.</p>
    /// <ul>
    /// <li>
    /// <p><code>Draft</code>: The model card is a work in progress.</p></li>
    /// <li>
    /// <p><code>PendingReview</code>: The model card is pending review.</p></li>
    /// <li>
    /// <p><code>Approved</code>: The model card is approved.</p></li>
    /// <li>
    /// <p><code>Archived</code>: The model card is archived. No more updates should be made to the model card, but it can still be exported.</p></li>
    /// </ul>
    pub fn get_model_card_status(&self) -> &::std::option::Option<crate::types::ModelCardStatus> {
        &self.model_card_status
    }
    /// Appends an item to `tags`.
    ///
    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
    ///
    /// <p>Key-value pairs used to manage metadata for model cards.</p>
    pub fn tags(mut self, input: crate::types::Tag) -> Self {
        let mut v = self.tags.unwrap_or_default();
        v.push(input);
        self.tags = ::std::option::Option::Some(v);
        self
    }
    /// <p>Key-value pairs used to manage metadata for model cards.</p>
    pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
        self.tags = input;
        self
    }
    /// <p>Key-value pairs used to manage metadata for model cards.</p>
    pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
        &self.tags
    }
    /// Consumes the builder and constructs a [`CreateModelCardInput`](crate::operation::create_model_card::CreateModelCardInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::create_model_card::CreateModelCardInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::create_model_card::CreateModelCardInput {
            model_card_name: self.model_card_name,
            security_config: self.security_config,
            content: self.content,
            model_card_status: self.model_card_status,
            tags: self.tags,
        })
    }
}
impl ::std::fmt::Debug for CreateModelCardInputBuilder {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("CreateModelCardInputBuilder");
        formatter.field("model_card_name", &self.model_card_name);
        formatter.field("security_config", &self.security_config);
        formatter.field("content", &"*** Sensitive Data Redacted ***");
        formatter.field("model_card_status", &self.model_card_status);
        formatter.field("tags", &self.tags);
        formatter.finish()
    }
}