aws_sdk_sagemaker/client/
describe_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 [`DescribeAlgorithm`](crate::operation::describe_algorithm::builders::DescribeAlgorithmFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`algorithm_name(impl Into<String>)`](crate::operation::describe_algorithm::builders::DescribeAlgorithmFluentBuilder::algorithm_name) / [`set_algorithm_name(Option<String>)`](crate::operation::describe_algorithm::builders::DescribeAlgorithmFluentBuilder::set_algorithm_name):<br>required: **true**<br><p>The name of the algorithm to describe.</p><br>
7    /// - On success, responds with [`DescribeAlgorithmOutput`](crate::operation::describe_algorithm::DescribeAlgorithmOutput) with field(s):
8    ///   - [`algorithm_name(Option<String>)`](crate::operation::describe_algorithm::DescribeAlgorithmOutput::algorithm_name): <p>The name of the algorithm being described.</p>
9    ///   - [`algorithm_arn(Option<String>)`](crate::operation::describe_algorithm::DescribeAlgorithmOutput::algorithm_arn): <p>The Amazon Resource Name (ARN) of the algorithm.</p>
10    ///   - [`algorithm_description(Option<String>)`](crate::operation::describe_algorithm::DescribeAlgorithmOutput::algorithm_description): <p>A brief summary about the algorithm.</p>
11    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_algorithm::DescribeAlgorithmOutput::creation_time): <p>A timestamp specifying when the algorithm was created.</p>
12    ///   - [`training_specification(Option<TrainingSpecification>)`](crate::operation::describe_algorithm::DescribeAlgorithmOutput::training_specification): <p>Details about training jobs run by this algorithm.</p>
13    ///   - [`inference_specification(Option<InferenceSpecification>)`](crate::operation::describe_algorithm::DescribeAlgorithmOutput::inference_specification): <p>Details about inference jobs that the algorithm runs.</p>
14    ///   - [`validation_specification(Option<AlgorithmValidationSpecification>)`](crate::operation::describe_algorithm::DescribeAlgorithmOutput::validation_specification): <p>Details about configurations for one or more training jobs that SageMaker runs to test the algorithm.</p>
15    ///   - [`algorithm_status(Option<AlgorithmStatus>)`](crate::operation::describe_algorithm::DescribeAlgorithmOutput::algorithm_status): <p>The current status of the algorithm.</p>
16    ///   - [`algorithm_status_details(Option<AlgorithmStatusDetails>)`](crate::operation::describe_algorithm::DescribeAlgorithmOutput::algorithm_status_details): <p>Details about the current status of the algorithm.</p>
17    ///   - [`product_id(Option<String>)`](crate::operation::describe_algorithm::DescribeAlgorithmOutput::product_id): <p>The product identifier of the algorithm.</p>
18    ///   - [`certify_for_marketplace(Option<bool>)`](crate::operation::describe_algorithm::DescribeAlgorithmOutput::certify_for_marketplace): <p>Whether the algorithm is certified to be listed in Amazon Web Services Marketplace.</p>
19    /// - On failure, responds with [`SdkError<DescribeAlgorithmError>`](crate::operation::describe_algorithm::DescribeAlgorithmError)
20    pub fn describe_algorithm(&self) -> crate::operation::describe_algorithm::builders::DescribeAlgorithmFluentBuilder {
21        crate::operation::describe_algorithm::builders::DescribeAlgorithmFluentBuilder::new(self.handle.clone())
22    }
23}
aws_sdk_sagemaker/client/describe_algorithm.rs

aws_sdk_sagemaker/client/
describe_algorithm.rs
