aws_sdk_cleanroomsml/client/

start_trained_model_inference_job.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`StartTrainedModelInferenceJob`](crate::operation::start_trained_model_inference_job::builders::StartTrainedModelInferenceJobFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`membership_identifier(impl Into<String>)`](crate::operation::start_trained_model_inference_job::builders::StartTrainedModelInferenceJobFluentBuilder::membership_identifier) / [`set_membership_identifier(Option<String>)`](crate::operation::start_trained_model_inference_job::builders::StartTrainedModelInferenceJobFluentBuilder::set_membership_identifier):<br>required: **true**<br><p>The membership ID of the membership that contains the trained model inference job.</p><br>
    ///   - [`name(impl Into<String>)`](crate::operation::start_trained_model_inference_job::builders::StartTrainedModelInferenceJobFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::start_trained_model_inference_job::builders::StartTrainedModelInferenceJobFluentBuilder::set_name):<br>required: **true**<br><p>The name of the trained model inference job.</p><br>
    ///   - [`trained_model_arn(impl Into<String>)`](crate::operation::start_trained_model_inference_job::builders::StartTrainedModelInferenceJobFluentBuilder::trained_model_arn) / [`set_trained_model_arn(Option<String>)`](crate::operation::start_trained_model_inference_job::builders::StartTrainedModelInferenceJobFluentBuilder::set_trained_model_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the trained model that is used for this trained model inference job.</p><br>
    ///   - [`trained_model_version_identifier(impl Into<String>)`](crate::operation::start_trained_model_inference_job::builders::StartTrainedModelInferenceJobFluentBuilder::trained_model_version_identifier) / [`set_trained_model_version_identifier(Option<String>)`](crate::operation::start_trained_model_inference_job::builders::StartTrainedModelInferenceJobFluentBuilder::set_trained_model_version_identifier):<br>required: **false**<br><p>The version identifier of the trained model to use for inference. This specifies which version of the trained model should be used to generate predictions on the input data.</p><br>
    ///   - [`configured_model_algorithm_association_arn(impl Into<String>)`](crate::operation::start_trained_model_inference_job::builders::StartTrainedModelInferenceJobFluentBuilder::configured_model_algorithm_association_arn) / [`set_configured_model_algorithm_association_arn(Option<String>)`](crate::operation::start_trained_model_inference_job::builders::StartTrainedModelInferenceJobFluentBuilder::set_configured_model_algorithm_association_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the configured model algorithm association that is used for this trained model inference job.</p><br>
    ///   - [`resource_config(InferenceResourceConfig)`](crate::operation::start_trained_model_inference_job::builders::StartTrainedModelInferenceJobFluentBuilder::resource_config) / [`set_resource_config(Option<InferenceResourceConfig>)`](crate::operation::start_trained_model_inference_job::builders::StartTrainedModelInferenceJobFluentBuilder::set_resource_config):<br>required: **true**<br><p>Defines the resource configuration for the trained model inference job.</p><br>
    ///   - [`output_configuration(InferenceOutputConfiguration)`](crate::operation::start_trained_model_inference_job::builders::StartTrainedModelInferenceJobFluentBuilder::output_configuration) / [`set_output_configuration(Option<InferenceOutputConfiguration>)`](crate::operation::start_trained_model_inference_job::builders::StartTrainedModelInferenceJobFluentBuilder::set_output_configuration):<br>required: **true**<br><p>Defines the output configuration information for the trained model inference job.</p><br>
    ///   - [`data_source(ModelInferenceDataSource)`](crate::operation::start_trained_model_inference_job::builders::StartTrainedModelInferenceJobFluentBuilder::data_source) / [`set_data_source(Option<ModelInferenceDataSource>)`](crate::operation::start_trained_model_inference_job::builders::StartTrainedModelInferenceJobFluentBuilder::set_data_source):<br>required: **true**<br><p>Defines the data source that is used for the trained model inference job.</p><br>
    ///   - [`description(impl Into<String>)`](crate::operation::start_trained_model_inference_job::builders::StartTrainedModelInferenceJobFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::start_trained_model_inference_job::builders::StartTrainedModelInferenceJobFluentBuilder::set_description):<br>required: **false**<br><p>The description of the trained model inference job.</p><br>
    ///   - [`container_execution_parameters(InferenceContainerExecutionParameters)`](crate::operation::start_trained_model_inference_job::builders::StartTrainedModelInferenceJobFluentBuilder::container_execution_parameters) / [`set_container_execution_parameters(Option<InferenceContainerExecutionParameters>)`](crate::operation::start_trained_model_inference_job::builders::StartTrainedModelInferenceJobFluentBuilder::set_container_execution_parameters):<br>required: **false**<br><p>The execution parameters for the container.</p><br>
    ///   - [`environment(impl Into<String>, impl Into<String>)`](crate::operation::start_trained_model_inference_job::builders::StartTrainedModelInferenceJobFluentBuilder::environment) / [`set_environment(Option<HashMap::<String, String>>)`](crate::operation::start_trained_model_inference_job::builders::StartTrainedModelInferenceJobFluentBuilder::set_environment):<br>required: **false**<br><p>The environment variables to set in the Docker container.</p><br>
    ///   - [`kms_key_arn(impl Into<String>)`](crate::operation::start_trained_model_inference_job::builders::StartTrainedModelInferenceJobFluentBuilder::kms_key_arn) / [`set_kms_key_arn(Option<String>)`](crate::operation::start_trained_model_inference_job::builders::StartTrainedModelInferenceJobFluentBuilder::set_kms_key_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt and decrypt customer-owned data in the ML inference job and associated data.</p><br>
    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::start_trained_model_inference_job::builders::StartTrainedModelInferenceJobFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::start_trained_model_inference_job::builders::StartTrainedModelInferenceJobFluentBuilder::set_tags):<br>required: **false**<br><p>The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.</p> <p>The following basic restrictions apply to tags:</p> <ul>  <li>   <p>Maximum number of tags per resource - 50.</p></li>  <li>   <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p></li>  <li>   <p>Maximum key length - 128 Unicode characters in UTF-8.</p></li>  <li>   <p>Maximum value length - 256 Unicode characters in UTF-8.</p></li>  <li>   <p>If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.</p></li>  <li>   <p>Tag keys and values are case sensitive.</p></li>  <li>   <p>Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.</p></li> </ul><br>
    /// - On success, responds with [`StartTrainedModelInferenceJobOutput`](crate::operation::start_trained_model_inference_job::StartTrainedModelInferenceJobOutput) with field(s):
    ///   - [`trained_model_inference_job_arn(String)`](crate::operation::start_trained_model_inference_job::StartTrainedModelInferenceJobOutput::trained_model_inference_job_arn): <p>The Amazon Resource Name (ARN) of the trained model inference job.</p>
    /// - On failure, responds with [`SdkError<StartTrainedModelInferenceJobError>`](crate::operation::start_trained_model_inference_job::StartTrainedModelInferenceJobError)
    pub fn start_trained_model_inference_job(
        &self,
    ) -> crate::operation::start_trained_model_inference_job::builders::StartTrainedModelInferenceJobFluentBuilder {
        crate::operation::start_trained_model_inference_job::builders::StartTrainedModelInferenceJobFluentBuilder::new(self.handle.clone())
    }
}