aws_sdk_sagemaker/client/
describe_user_profile.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 [`DescribeUserProfile`](crate::operation::describe_user_profile::builders::DescribeUserProfileFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`domain_id(impl Into<String>)`](crate::operation::describe_user_profile::builders::DescribeUserProfileFluentBuilder::domain_id) / [`set_domain_id(Option<String>)`](crate::operation::describe_user_profile::builders::DescribeUserProfileFluentBuilder::set_domain_id):<br>required: **true**<br><p>The domain ID.</p><br>
7    ///   - [`user_profile_name(impl Into<String>)`](crate::operation::describe_user_profile::builders::DescribeUserProfileFluentBuilder::user_profile_name) / [`set_user_profile_name(Option<String>)`](crate::operation::describe_user_profile::builders::DescribeUserProfileFluentBuilder::set_user_profile_name):<br>required: **true**<br><p>The user profile name. This value is not case sensitive.</p><br>
8    /// - On success, responds with [`DescribeUserProfileOutput`](crate::operation::describe_user_profile::DescribeUserProfileOutput) with field(s):
9    ///   - [`domain_id(Option<String>)`](crate::operation::describe_user_profile::DescribeUserProfileOutput::domain_id): <p>The ID of the domain that contains the profile.</p>
10    ///   - [`user_profile_arn(Option<String>)`](crate::operation::describe_user_profile::DescribeUserProfileOutput::user_profile_arn): <p>The user profile Amazon Resource Name (ARN).</p>
11    ///   - [`user_profile_name(Option<String>)`](crate::operation::describe_user_profile::DescribeUserProfileOutput::user_profile_name): <p>The user profile name.</p>
12    ///   - [`home_efs_file_system_uid(Option<String>)`](crate::operation::describe_user_profile::DescribeUserProfileOutput::home_efs_file_system_uid): <p>The ID of the user's profile in the Amazon Elastic File System volume.</p>
13    ///   - [`status(Option<UserProfileStatus>)`](crate::operation::describe_user_profile::DescribeUserProfileOutput::status): <p>The status.</p>
14    ///   - [`last_modified_time(Option<DateTime>)`](crate::operation::describe_user_profile::DescribeUserProfileOutput::last_modified_time): <p>The last modified time.</p>
15    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_user_profile::DescribeUserProfileOutput::creation_time): <p>The creation time.</p>
16    ///   - [`failure_reason(Option<String>)`](crate::operation::describe_user_profile::DescribeUserProfileOutput::failure_reason): <p>The failure reason.</p>
17    ///   - [`single_sign_on_user_identifier(Option<String>)`](crate::operation::describe_user_profile::DescribeUserProfileOutput::single_sign_on_user_identifier): <p>The IAM Identity Center user identifier.</p>
18    ///   - [`single_sign_on_user_value(Option<String>)`](crate::operation::describe_user_profile::DescribeUserProfileOutput::single_sign_on_user_value): <p>The IAM Identity Center user value.</p>
19    ///   - [`user_settings(Option<UserSettings>)`](crate::operation::describe_user_profile::DescribeUserProfileOutput::user_settings): <p>A collection of settings.</p>
20    /// - On failure, responds with [`SdkError<DescribeUserProfileError>`](crate::operation::describe_user_profile::DescribeUserProfileError)
21    pub fn describe_user_profile(&self) -> crate::operation::describe_user_profile::builders::DescribeUserProfileFluentBuilder {
22        crate::operation::describe_user_profile::builders::DescribeUserProfileFluentBuilder::new(self.handle.clone())
23    }
24}