aws_sdk_cleanroomsml/client/get_configured_model_algorithm.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`GetConfiguredModelAlgorithm`](crate::operation::get_configured_model_algorithm::builders::GetConfiguredModelAlgorithmFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`configured_model_algorithm_arn(impl Into<String>)`](crate::operation::get_configured_model_algorithm::builders::GetConfiguredModelAlgorithmFluentBuilder::configured_model_algorithm_arn) / [`set_configured_model_algorithm_arn(Option<String>)`](crate::operation::get_configured_model_algorithm::builders::GetConfiguredModelAlgorithmFluentBuilder::set_configured_model_algorithm_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the configured model algorithm that you want to return information about.</p><br>
7 /// - On success, responds with [`GetConfiguredModelAlgorithmOutput`](crate::operation::get_configured_model_algorithm::GetConfiguredModelAlgorithmOutput) with field(s):
8 /// - [`create_time(DateTime)`](crate::operation::get_configured_model_algorithm::GetConfiguredModelAlgorithmOutput::create_time): <p>The time at which the configured model algorithm was created.</p>
9 /// - [`update_time(DateTime)`](crate::operation::get_configured_model_algorithm::GetConfiguredModelAlgorithmOutput::update_time): <p>The most recent time at which the configured model algorithm was updated.</p>
10 /// - [`configured_model_algorithm_arn(String)`](crate::operation::get_configured_model_algorithm::GetConfiguredModelAlgorithmOutput::configured_model_algorithm_arn): <p>The Amazon Resource Name (ARN) of the configured model algorithm.</p>
11 /// - [`name(String)`](crate::operation::get_configured_model_algorithm::GetConfiguredModelAlgorithmOutput::name): <p>The name of the configured model algorithm.</p>
12 /// - [`training_container_config(Option<ContainerConfig>)`](crate::operation::get_configured_model_algorithm::GetConfiguredModelAlgorithmOutput::training_container_config): <p>The configuration information of the training container for the configured model algorithm.</p>
13 /// - [`inference_container_config(Option<InferenceContainerConfig>)`](crate::operation::get_configured_model_algorithm::GetConfiguredModelAlgorithmOutput::inference_container_config): <p>Configuration information for the inference container.</p>
14 /// - [`role_arn(String)`](crate::operation::get_configured_model_algorithm::GetConfiguredModelAlgorithmOutput::role_arn): <p>The Amazon Resource Name (ARN) of the service role that was used to create the configured model algorithm.</p>
15 /// - [`description(Option<String>)`](crate::operation::get_configured_model_algorithm::GetConfiguredModelAlgorithmOutput::description): <p>The description of the configured model algorithm.</p>
16 /// - [`tags(Option<HashMap::<String, String>>)`](crate::operation::get_configured_model_algorithm::GetConfiguredModelAlgorithmOutput::tags): <p>The optional metadata that you applied 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>
17 /// - [`kms_key_arn(Option<String>)`](crate::operation::get_configured_model_algorithm::GetConfiguredModelAlgorithmOutput::kms_key_arn): <p>The Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt and decrypt customer-owned data in the configured ML model and associated data.</p>
18 /// - On failure, responds with [`SdkError<GetConfiguredModelAlgorithmError>`](crate::operation::get_configured_model_algorithm::GetConfiguredModelAlgorithmError)
19 pub fn get_configured_model_algorithm(
20 &self,
21 ) -> crate::operation::get_configured_model_algorithm::builders::GetConfiguredModelAlgorithmFluentBuilder {
22 crate::operation::get_configured_model_algorithm::builders::GetConfiguredModelAlgorithmFluentBuilder::new(self.handle.clone())
23 }
24}