aws-sdk-sagemaker 1.198.0

AWS SDK for Amazon SageMaker Service
Documentation
// 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 DescribeMlflowAppOutput {
    /// <p>The ARN of the MLflow App.</p>
    pub arn: ::std::option::Option<::std::string::String>,
    /// <p>The name of the MLflow App.</p>
    pub name: ::std::option::Option<::std::string::String>,
    /// <p>The S3 URI of the general purpose bucket used as the MLflow App artifact store.</p>
    pub artifact_store_uri: ::std::option::Option<::std::string::String>,
    /// <p>The MLflow version used.</p>
    pub mlflow_version: ::std::option::Option<::std::string::String>,
    /// <p>The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow App uses to access the artifact store in Amazon S3.</p>
    pub role_arn: ::std::option::Option<::std::string::String>,
    /// <p>The current creation status of the described MLflow App.</p>
    pub status: ::std::option::Option<crate::types::MlflowAppStatus>,
    /// <p>Whether automatic registration of new MLflow models to the SageMaker Model Registry is enabled.</p>
    pub model_registration_mode: ::std::option::Option<crate::types::ModelRegistrationMode>,
    /// <p>Indicates whether this MLflow app is the default for the entire account.</p>
    pub account_default_status: ::std::option::Option<crate::types::AccountDefaultStatus>,
    /// <p>List of SageMaker Domain IDs for which this MLflow App is the default.</p>
    pub default_domain_id_list: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    /// <p>The timestamp when the MLflow App was created.</p>
    pub creation_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>Information about the user who created or modified a SageMaker resource.</p>
    pub created_by: ::std::option::Option<crate::types::UserContext>,
    /// <p>The timestamp when the MLflow App was last 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>The day and time of the week when weekly maintenance occurs.</p>
    pub weekly_maintenance_window_start: ::std::option::Option<::std::string::String>,
    /// <p>Current maintenance status of the MLflow App.</p>
    pub maintenance_status: ::std::option::Option<crate::types::MaintenanceStatus>,
    _request_id: Option<String>,
}
impl DescribeMlflowAppOutput {
    /// <p>The ARN of the MLflow App.</p>
    pub fn arn(&self) -> ::std::option::Option<&str> {
        self.arn.as_deref()
    }
    /// <p>The name of the MLflow App.</p>
    pub fn name(&self) -> ::std::option::Option<&str> {
        self.name.as_deref()
    }
    /// <p>The S3 URI of the general purpose bucket used as the MLflow App artifact store.</p>
    pub fn artifact_store_uri(&self) -> ::std::option::Option<&str> {
        self.artifact_store_uri.as_deref()
    }
    /// <p>The MLflow version used.</p>
    pub fn mlflow_version(&self) -> ::std::option::Option<&str> {
        self.mlflow_version.as_deref()
    }
    /// <p>The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow App uses to access the artifact store in Amazon S3.</p>
    pub fn role_arn(&self) -> ::std::option::Option<&str> {
        self.role_arn.as_deref()
    }
    /// <p>The current creation status of the described MLflow App.</p>
    pub fn status(&self) -> ::std::option::Option<&crate::types::MlflowAppStatus> {
        self.status.as_ref()
    }
    /// <p>Whether automatic registration of new MLflow models to the SageMaker Model Registry is enabled.</p>
    pub fn model_registration_mode(&self) -> ::std::option::Option<&crate::types::ModelRegistrationMode> {
        self.model_registration_mode.as_ref()
    }
    /// <p>Indicates whether this MLflow app is the default for the entire account.</p>
    pub fn account_default_status(&self) -> ::std::option::Option<&crate::types::AccountDefaultStatus> {
        self.account_default_status.as_ref()
    }
    /// <p>List of SageMaker Domain IDs for which this MLflow App is the default.</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 `.default_domain_id_list.is_none()`.
    pub fn default_domain_id_list(&self) -> &[::std::string::String] {
        self.default_domain_id_list.as_deref().unwrap_or_default()
    }
    /// <p>The timestamp when the MLflow App was created.</p>
    pub fn creation_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.creation_time.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>The timestamp when the MLflow App was last 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>The day and time of the week when weekly maintenance occurs.</p>
    pub fn weekly_maintenance_window_start(&self) -> ::std::option::Option<&str> {
        self.weekly_maintenance_window_start.as_deref()
    }
    /// <p>Current maintenance status of the MLflow App.</p>
    pub fn maintenance_status(&self) -> ::std::option::Option<&crate::types::MaintenanceStatus> {
        self.maintenance_status.as_ref()
    }
}
impl ::aws_types::request_id::RequestId for DescribeMlflowAppOutput {
    fn request_id(&self) -> Option<&str> {
        self._request_id.as_deref()
    }
}
impl DescribeMlflowAppOutput {
    /// Creates a new builder-style object to manufacture [`DescribeMlflowAppOutput`](crate::operation::describe_mlflow_app::DescribeMlflowAppOutput).
    pub fn builder() -> crate::operation::describe_mlflow_app::builders::DescribeMlflowAppOutputBuilder {
        crate::operation::describe_mlflow_app::builders::DescribeMlflowAppOutputBuilder::default()
    }
}

/// A builder for [`DescribeMlflowAppOutput`](crate::operation::describe_mlflow_app::DescribeMlflowAppOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct DescribeMlflowAppOutputBuilder {
    pub(crate) arn: ::std::option::Option<::std::string::String>,
    pub(crate) name: ::std::option::Option<::std::string::String>,
    pub(crate) artifact_store_uri: ::std::option::Option<::std::string::String>,
    pub(crate) mlflow_version: ::std::option::Option<::std::string::String>,
    pub(crate) role_arn: ::std::option::Option<::std::string::String>,
    pub(crate) status: ::std::option::Option<crate::types::MlflowAppStatus>,
    pub(crate) model_registration_mode: ::std::option::Option<crate::types::ModelRegistrationMode>,
    pub(crate) account_default_status: ::std::option::Option<crate::types::AccountDefaultStatus>,
    pub(crate) default_domain_id_list: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    pub(crate) creation_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) created_by: ::std::option::Option<crate::types::UserContext>,
    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) weekly_maintenance_window_start: ::std::option::Option<::std::string::String>,
    pub(crate) maintenance_status: ::std::option::Option<crate::types::MaintenanceStatus>,
    _request_id: Option<String>,
}
impl DescribeMlflowAppOutputBuilder {
    /// <p>The ARN of the MLflow App.</p>
    pub fn arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ARN of the MLflow App.</p>
    pub fn set_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.arn = input;
        self
    }
    /// <p>The ARN of the MLflow App.</p>
    pub fn get_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.arn
    }
    /// <p>The name of the MLflow App.</p>
    pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The name of the MLflow App.</p>
    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.name = input;
        self
    }
    /// <p>The name of the MLflow App.</p>
    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.name
    }
    /// <p>The S3 URI of the general purpose bucket used as the MLflow App artifact store.</p>
    pub fn artifact_store_uri(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.artifact_store_uri = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The S3 URI of the general purpose bucket used as the MLflow App artifact store.</p>
    pub fn set_artifact_store_uri(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.artifact_store_uri = input;
        self
    }
    /// <p>The S3 URI of the general purpose bucket used as the MLflow App artifact store.</p>
    pub fn get_artifact_store_uri(&self) -> &::std::option::Option<::std::string::String> {
        &self.artifact_store_uri
    }
    /// <p>The MLflow version used.</p>
    pub fn mlflow_version(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.mlflow_version = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The MLflow version used.</p>
    pub fn set_mlflow_version(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.mlflow_version = input;
        self
    }
    /// <p>The MLflow version used.</p>
    pub fn get_mlflow_version(&self) -> &::std::option::Option<::std::string::String> {
        &self.mlflow_version
    }
    /// <p>The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow App uses to access the artifact store in Amazon S3.</p>
    pub fn role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.role_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow App uses to access the artifact store in Amazon S3.</p>
    pub fn set_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.role_arn = input;
        self
    }
    /// <p>The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow App uses to access the artifact store in Amazon S3.</p>
    pub fn get_role_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.role_arn
    }
    /// <p>The current creation status of the described MLflow App.</p>
    pub fn status(mut self, input: crate::types::MlflowAppStatus) -> Self {
        self.status = ::std::option::Option::Some(input);
        self
    }
    /// <p>The current creation status of the described MLflow App.</p>
    pub fn set_status(mut self, input: ::std::option::Option<crate::types::MlflowAppStatus>) -> Self {
        self.status = input;
        self
    }
    /// <p>The current creation status of the described MLflow App.</p>
    pub fn get_status(&self) -> &::std::option::Option<crate::types::MlflowAppStatus> {
        &self.status
    }
    /// <p>Whether automatic registration of new MLflow models to the SageMaker Model Registry is enabled.</p>
    pub fn model_registration_mode(mut self, input: crate::types::ModelRegistrationMode) -> Self {
        self.model_registration_mode = ::std::option::Option::Some(input);
        self
    }
    /// <p>Whether automatic registration of new MLflow models to the SageMaker Model Registry is enabled.</p>
    pub fn set_model_registration_mode(mut self, input: ::std::option::Option<crate::types::ModelRegistrationMode>) -> Self {
        self.model_registration_mode = input;
        self
    }
    /// <p>Whether automatic registration of new MLflow models to the SageMaker Model Registry is enabled.</p>
    pub fn get_model_registration_mode(&self) -> &::std::option::Option<crate::types::ModelRegistrationMode> {
        &self.model_registration_mode
    }
    /// <p>Indicates whether this MLflow app is the default for the entire account.</p>
    pub fn account_default_status(mut self, input: crate::types::AccountDefaultStatus) -> Self {
        self.account_default_status = ::std::option::Option::Some(input);
        self
    }
    /// <p>Indicates whether this MLflow app is the default for the entire account.</p>
    pub fn set_account_default_status(mut self, input: ::std::option::Option<crate::types::AccountDefaultStatus>) -> Self {
        self.account_default_status = input;
        self
    }
    /// <p>Indicates whether this MLflow app is the default for the entire account.</p>
    pub fn get_account_default_status(&self) -> &::std::option::Option<crate::types::AccountDefaultStatus> {
        &self.account_default_status
    }
    /// Appends an item to `default_domain_id_list`.
    ///
    /// To override the contents of this collection use [`set_default_domain_id_list`](Self::set_default_domain_id_list).
    ///
    /// <p>List of SageMaker Domain IDs for which this MLflow App is the default.</p>
    pub fn default_domain_id_list(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        let mut v = self.default_domain_id_list.unwrap_or_default();
        v.push(input.into());
        self.default_domain_id_list = ::std::option::Option::Some(v);
        self
    }
    /// <p>List of SageMaker Domain IDs for which this MLflow App is the default.</p>
    pub fn set_default_domain_id_list(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.default_domain_id_list = input;
        self
    }
    /// <p>List of SageMaker Domain IDs for which this MLflow App is the default.</p>
    pub fn get_default_domain_id_list(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        &self.default_domain_id_list
    }
    /// <p>The timestamp when the MLflow App was created.</p>
    pub fn creation_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.creation_time = ::std::option::Option::Some(input);
        self
    }
    /// <p>The timestamp when the MLflow App 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>The timestamp when the MLflow App was created.</p>
    pub fn get_creation_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.creation_time
    }
    /// <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>The timestamp when the MLflow App was last 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 timestamp when the MLflow App was last 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 timestamp when the MLflow App was last 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>The day and time of the week when weekly maintenance occurs.</p>
    pub fn weekly_maintenance_window_start(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.weekly_maintenance_window_start = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The day and time of the week when weekly maintenance occurs.</p>
    pub fn set_weekly_maintenance_window_start(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.weekly_maintenance_window_start = input;
        self
    }
    /// <p>The day and time of the week when weekly maintenance occurs.</p>
    pub fn get_weekly_maintenance_window_start(&self) -> &::std::option::Option<::std::string::String> {
        &self.weekly_maintenance_window_start
    }
    /// <p>Current maintenance status of the MLflow App.</p>
    pub fn maintenance_status(mut self, input: crate::types::MaintenanceStatus) -> Self {
        self.maintenance_status = ::std::option::Option::Some(input);
        self
    }
    /// <p>Current maintenance status of the MLflow App.</p>
    pub fn set_maintenance_status(mut self, input: ::std::option::Option<crate::types::MaintenanceStatus>) -> Self {
        self.maintenance_status = input;
        self
    }
    /// <p>Current maintenance status of the MLflow App.</p>
    pub fn get_maintenance_status(&self) -> &::std::option::Option<crate::types::MaintenanceStatus> {
        &self.maintenance_status
    }
    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 [`DescribeMlflowAppOutput`](crate::operation::describe_mlflow_app::DescribeMlflowAppOutput).
    pub fn build(self) -> crate::operation::describe_mlflow_app::DescribeMlflowAppOutput {
        crate::operation::describe_mlflow_app::DescribeMlflowAppOutput {
            arn: self.arn,
            name: self.name,
            artifact_store_uri: self.artifact_store_uri,
            mlflow_version: self.mlflow_version,
            role_arn: self.role_arn,
            status: self.status,
            model_registration_mode: self.model_registration_mode,
            account_default_status: self.account_default_status,
            default_domain_id_list: self.default_domain_id_list,
            creation_time: self.creation_time,
            created_by: self.created_by,
            last_modified_time: self.last_modified_time,
            last_modified_by: self.last_modified_by,
            weekly_maintenance_window_start: self.weekly_maintenance_window_start,
            maintenance_status: self.maintenance_status,
            _request_id: self._request_id,
        }
    }
}