aws_sdk_cognitoidentityprovider/client/

admin_forget_device.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`AdminForgetDevice`](crate::operation::admin_forget_device::builders::AdminForgetDeviceFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`user_pool_id(impl Into<String>)`](crate::operation::admin_forget_device::builders::AdminForgetDeviceFluentBuilder::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::operation::admin_forget_device::builders::AdminForgetDeviceFluentBuilder::set_user_pool_id):<br>required: **true**<br><p>The ID of the user pool where the device owner is a user.</p><br>
    ///   - [`username(impl Into<String>)`](crate::operation::admin_forget_device::builders::AdminForgetDeviceFluentBuilder::username) / [`set_username(Option<String>)`](crate::operation::admin_forget_device::builders::AdminForgetDeviceFluentBuilder::set_username):<br>required: **true**<br><p>The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If <code>username</code> isn't an alias attribute in your user pool, this value must be the <code>sub</code> of a local user or the username of a user from a third-party IdP.</p><br>
    ///   - [`device_key(impl Into<String>)`](crate::operation::admin_forget_device::builders::AdminForgetDeviceFluentBuilder::device_key) / [`set_device_key(Option<String>)`](crate::operation::admin_forget_device::builders::AdminForgetDeviceFluentBuilder::set_device_key):<br>required: **true**<br><p>The key ID of the device that you want to delete.</p><br>
    /// - On success, responds with [`AdminForgetDeviceOutput`](crate::operation::admin_forget_device::AdminForgetDeviceOutput)
    /// - On failure, responds with [`SdkError<AdminForgetDeviceError>`](crate::operation::admin_forget_device::AdminForgetDeviceError)
    pub fn admin_forget_device(&self) -> crate::operation::admin_forget_device::builders::AdminForgetDeviceFluentBuilder {
        crate::operation::admin_forget_device::builders::AdminForgetDeviceFluentBuilder::new(self.handle.clone())
    }
}