aws_sdk_elasticache/client/
delete_user.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 [`DeleteUser`](crate::operation::delete_user::builders::DeleteUserFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`user_id(impl Into<String>)`](crate::operation::delete_user::builders::DeleteUserFluentBuilder::user_id) / [`set_user_id(Option<String>)`](crate::operation::delete_user::builders::DeleteUserFluentBuilder::set_user_id):<br>required: **true**<br><p>The ID of the user.</p><br>
7    /// - On success, responds with [`DeleteUserOutput`](crate::operation::delete_user::DeleteUserOutput) with field(s):
8    ///   - [`user_id(Option<String>)`](crate::operation::delete_user::DeleteUserOutput::user_id): <p>The ID of the user.</p>
9    ///   - [`user_name(Option<String>)`](crate::operation::delete_user::DeleteUserOutput::user_name): <p>The username of the user.</p>
10    ///   - [`status(Option<String>)`](crate::operation::delete_user::DeleteUserOutput::status): <p>Indicates the user status. Can be "active", "modifying" or "deleting".</p>
11    ///   - [`engine(Option<String>)`](crate::operation::delete_user::DeleteUserOutput::engine): <p>The options are valkey or redis.</p>
12    ///   - [`minimum_engine_version(Option<String>)`](crate::operation::delete_user::DeleteUserOutput::minimum_engine_version): <p>The minimum engine version required, which is Redis OSS 6.0</p>
13    ///   - [`access_string(Option<String>)`](crate::operation::delete_user::DeleteUserOutput::access_string): <p>Access permissions string used for this user.</p>
14    ///   - [`user_group_ids(Option<Vec::<String>>)`](crate::operation::delete_user::DeleteUserOutput::user_group_ids): <p>Returns a list of the user group IDs the user belongs to.</p>
15    ///   - [`authentication(Option<Authentication>)`](crate::operation::delete_user::DeleteUserOutput::authentication): <p>Denotes whether the user requires a password to authenticate.</p>
16    ///   - [`arn(Option<String>)`](crate::operation::delete_user::DeleteUserOutput::arn): <p>The Amazon Resource Name (ARN) of the user.</p>
17    /// - On failure, responds with [`SdkError<DeleteUserError>`](crate::operation::delete_user::DeleteUserError)
18    pub fn delete_user(&self) -> crate::operation::delete_user::builders::DeleteUserFluentBuilder {
19        crate::operation::delete_user::builders::DeleteUserFluentBuilder::new(self.handle.clone())
20    }
21}