aws_sdk_sagemaker/client/
describe_image.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 [`DescribeImage`](crate::operation::describe_image::builders::DescribeImageFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`image_name(impl Into<String>)`](crate::operation::describe_image::builders::DescribeImageFluentBuilder::image_name) / [`set_image_name(Option<String>)`](crate::operation::describe_image::builders::DescribeImageFluentBuilder::set_image_name):<br>required: **true**<br><p>The name of the image to describe.</p><br>
7    /// - On success, responds with [`DescribeImageOutput`](crate::operation::describe_image::DescribeImageOutput) with field(s):
8    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_image::DescribeImageOutput::creation_time): <p>When the image was created.</p>
9    ///   - [`description(Option<String>)`](crate::operation::describe_image::DescribeImageOutput::description): <p>The description of the image.</p>
10    ///   - [`display_name(Option<String>)`](crate::operation::describe_image::DescribeImageOutput::display_name): <p>The name of the image as displayed.</p>
11    ///   - [`failure_reason(Option<String>)`](crate::operation::describe_image::DescribeImageOutput::failure_reason): <p>When a create, update, or delete operation fails, the reason for the failure.</p>
12    ///   - [`image_arn(Option<String>)`](crate::operation::describe_image::DescribeImageOutput::image_arn): <p>The ARN of the image.</p>
13    ///   - [`image_name(Option<String>)`](crate::operation::describe_image::DescribeImageOutput::image_name): <p>The name of the image.</p>
14    ///   - [`image_status(Option<ImageStatus>)`](crate::operation::describe_image::DescribeImageOutput::image_status): <p>The status of the image.</p>
15    ///   - [`last_modified_time(Option<DateTime>)`](crate::operation::describe_image::DescribeImageOutput::last_modified_time): <p>When the image was last modified.</p>
16    ///   - [`role_arn(Option<String>)`](crate::operation::describe_image::DescribeImageOutput::role_arn): <p>The ARN of the IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.</p>
17    /// - On failure, responds with [`SdkError<DescribeImageError>`](crate::operation::describe_image::DescribeImageError)
18    pub fn describe_image(&self) -> crate::operation::describe_image::builders::DescribeImageFluentBuilder {
19        crate::operation::describe_image::builders::DescribeImageFluentBuilder::new(self.handle.clone())
20    }
21}