aws_sdk_sagemaker/client/
describe_model.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 [`DescribeModel`](crate::operation::describe_model::builders::DescribeModelFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`model_name(impl Into<String>)`](crate::operation::describe_model::builders::DescribeModelFluentBuilder::model_name) / [`set_model_name(Option<String>)`](crate::operation::describe_model::builders::DescribeModelFluentBuilder::set_model_name):<br>required: **true**<br><p>The name of the model.</p><br>
7    /// - On success, responds with [`DescribeModelOutput`](crate::operation::describe_model::DescribeModelOutput) with field(s):
8    ///   - [`model_name(Option<String>)`](crate::operation::describe_model::DescribeModelOutput::model_name): <p>Name of the SageMaker model.</p>
9    ///   - [`primary_container(Option<ContainerDefinition>)`](crate::operation::describe_model::DescribeModelOutput::primary_container): <p>The location of the primary inference code, associated artifacts, and custom environment map that the inference code uses when it is deployed in production.</p>
10    ///   - [`containers(Option<Vec::<ContainerDefinition>>)`](crate::operation::describe_model::DescribeModelOutput::containers): <p>The containers in the inference pipeline.</p>
11    ///   - [`inference_execution_config(Option<InferenceExecutionConfig>)`](crate::operation::describe_model::DescribeModelOutput::inference_execution_config): <p>Specifies details of how containers in a multi-container endpoint are called.</p>
12    ///   - [`execution_role_arn(Option<String>)`](crate::operation::describe_model::DescribeModelOutput::execution_role_arn): <p>The Amazon Resource Name (ARN) of the IAM role that you specified for the model.</p>
13    ///   - [`vpc_config(Option<VpcConfig>)`](crate::operation::describe_model::DescribeModelOutput::vpc_config): <p>A <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html">VpcConfig</a> object that specifies the VPC that this model has access to. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html">Protect Endpoints by Using an Amazon Virtual Private Cloud</a></p>
14    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_model::DescribeModelOutput::creation_time): <p>A timestamp that shows when the model was created.</p>
15    ///   - [`model_arn(Option<String>)`](crate::operation::describe_model::DescribeModelOutput::model_arn): <p>The Amazon Resource Name (ARN) of the model.</p>
16    ///   - [`enable_network_isolation(Option<bool>)`](crate::operation::describe_model::DescribeModelOutput::enable_network_isolation): <p>If <code>True</code>, no inbound or outbound network calls can be made to or from the model container.</p>
17    ///   - [`deployment_recommendation(Option<DeploymentRecommendation>)`](crate::operation::describe_model::DescribeModelOutput::deployment_recommendation): <p>A set of recommended deployment configurations for the model.</p>
18    /// - On failure, responds with [`SdkError<DescribeModelError>`](crate::operation::describe_model::DescribeModelError)
19    pub fn describe_model(&self) -> crate::operation::describe_model::builders::DescribeModelFluentBuilder {
20        crate::operation::describe_model::builders::DescribeModelFluentBuilder::new(self.handle.clone())
21    }
22}