aws_sdk_cleanroomsml/client/

get_collaboration_trained_model.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetCollaborationTrainedModel`](crate::operation::get_collaboration_trained_model::builders::GetCollaborationTrainedModelFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`trained_model_arn(impl Into<String>)`](crate::operation::get_collaboration_trained_model::builders::GetCollaborationTrainedModelFluentBuilder::trained_model_arn) / [`set_trained_model_arn(Option<String>)`](crate::operation::get_collaboration_trained_model::builders::GetCollaborationTrainedModelFluentBuilder::set_trained_model_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the trained model that you want to return information about.</p><br>
    ///   - [`collaboration_identifier(impl Into<String>)`](crate::operation::get_collaboration_trained_model::builders::GetCollaborationTrainedModelFluentBuilder::collaboration_identifier) / [`set_collaboration_identifier(Option<String>)`](crate::operation::get_collaboration_trained_model::builders::GetCollaborationTrainedModelFluentBuilder::set_collaboration_identifier):<br>required: **true**<br><p>The collaboration ID that contains the trained model that you want to return information about.</p><br>
    ///   - [`version_identifier(impl Into<String>)`](crate::operation::get_collaboration_trained_model::builders::GetCollaborationTrainedModelFluentBuilder::version_identifier) / [`set_version_identifier(Option<String>)`](crate::operation::get_collaboration_trained_model::builders::GetCollaborationTrainedModelFluentBuilder::set_version_identifier):<br>required: **false**<br><p>The version identifier of the trained model to retrieve. If not specified, the operation returns information about the latest version of the trained model.</p><br>
    /// - On success, responds with [`GetCollaborationTrainedModelOutput`](crate::operation::get_collaboration_trained_model::GetCollaborationTrainedModelOutput) with field(s):
    ///   - [`membership_identifier(String)`](crate::operation::get_collaboration_trained_model::GetCollaborationTrainedModelOutput::membership_identifier): <p>The membership ID of the member that created the trained model.</p>
    ///   - [`collaboration_identifier(String)`](crate::operation::get_collaboration_trained_model::GetCollaborationTrainedModelOutput::collaboration_identifier): <p>The collaboration ID of the collaboration that contains the trained model.</p>
    ///   - [`trained_model_arn(String)`](crate::operation::get_collaboration_trained_model::GetCollaborationTrainedModelOutput::trained_model_arn): <p>The Amazon Resource Name (ARN) of the trained model.</p>
    ///   - [`version_identifier(Option<String>)`](crate::operation::get_collaboration_trained_model::GetCollaborationTrainedModelOutput::version_identifier): <p>The version identifier of the trained model. This unique identifier distinguishes this version from other versions of the same trained model.</p>
    ///   - [`incremental_training_data_channels(Option<Vec::<IncrementalTrainingDataChannelOutput>>)`](crate::operation::get_collaboration_trained_model::GetCollaborationTrainedModelOutput::incremental_training_data_channels): <p>Information about the incremental training data channels used to create this version of the trained model. This includes details about the base model that was used for incremental training and the channel configuration.</p>
    ///   - [`name(String)`](crate::operation::get_collaboration_trained_model::GetCollaborationTrainedModelOutput::name): <p>The name of the trained model.</p>
    ///   - [`description(Option<String>)`](crate::operation::get_collaboration_trained_model::GetCollaborationTrainedModelOutput::description): <p>The description of the trained model.</p>
    ///   - [`status(TrainedModelStatus)`](crate::operation::get_collaboration_trained_model::GetCollaborationTrainedModelOutput::status): <p>The status of the trained model.</p>
    ///   - [`status_details(Option<StatusDetails>)`](crate::operation::get_collaboration_trained_model::GetCollaborationTrainedModelOutput::status_details): <p>Details about the status of a resource.</p>
    ///   - [`configured_model_algorithm_association_arn(String)`](crate::operation::get_collaboration_trained_model::GetCollaborationTrainedModelOutput::configured_model_algorithm_association_arn): <p>The Amazon Resource Name (ARN) of the configured model algorithm association that was used to create this trained model.</p>
    ///   - [`resource_config(Option<ResourceConfig>)`](crate::operation::get_collaboration_trained_model::GetCollaborationTrainedModelOutput::resource_config): <p>The EC2 resource configuration that was used to train this model.</p>
    ///   - [`training_input_mode(Option<TrainingInputMode>)`](crate::operation::get_collaboration_trained_model::GetCollaborationTrainedModelOutput::training_input_mode): <p>The input mode that was used for accessing the training data when this trained model was created. This indicates how the training data was made available to the training algorithm.</p>
    ///   - [`stopping_condition(Option<StoppingCondition>)`](crate::operation::get_collaboration_trained_model::GetCollaborationTrainedModelOutput::stopping_condition): <p>The stopping condition that determined when model training ended.</p>
    ///   - [`metrics_status(Option<MetricsStatus>)`](crate::operation::get_collaboration_trained_model::GetCollaborationTrainedModelOutput::metrics_status): <p>The status of the model metrics.</p>
    ///   - [`metrics_status_details(Option<String>)`](crate::operation::get_collaboration_trained_model::GetCollaborationTrainedModelOutput::metrics_status_details): <p>Details about the status information for the model metrics.</p>
    ///   - [`logs_status(Option<LogsStatus>)`](crate::operation::get_collaboration_trained_model::GetCollaborationTrainedModelOutput::logs_status): <p>Status information for the logs.</p>
    ///   - [`logs_status_details(Option<String>)`](crate::operation::get_collaboration_trained_model::GetCollaborationTrainedModelOutput::logs_status_details): <p>Details about the status information for the logs.</p>
    ///   - [`training_container_image_digest(Option<String>)`](crate::operation::get_collaboration_trained_model::GetCollaborationTrainedModelOutput::training_container_image_digest): <p>Information about the training container image.</p>
    ///   - [`create_time(DateTime)`](crate::operation::get_collaboration_trained_model::GetCollaborationTrainedModelOutput::create_time): <p>The time at which the trained model was created.</p>
    ///   - [`update_time(DateTime)`](crate::operation::get_collaboration_trained_model::GetCollaborationTrainedModelOutput::update_time): <p>The most recent time at which the trained model was updated.</p>
    ///   - [`creator_account_id(String)`](crate::operation::get_collaboration_trained_model::GetCollaborationTrainedModelOutput::creator_account_id): <p>The account ID of the member that created the trained model.</p>
    /// - On failure, responds with [`SdkError<GetCollaborationTrainedModelError>`](crate::operation::get_collaboration_trained_model::GetCollaborationTrainedModelError)
    pub fn get_collaboration_trained_model(
        &self,
    ) -> crate::operation::get_collaboration_trained_model::builders::GetCollaborationTrainedModelFluentBuilder {
        crate::operation::get_collaboration_trained_model::builders::GetCollaborationTrainedModelFluentBuilder::new(self.handle.clone())
    }
}