aws_sdk_cognitoidentityprovider/client/

admin_update_device_status.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`AdminUpdateDeviceStatus`](crate::operation::admin_update_device_status::builders::AdminUpdateDeviceStatusFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`user_pool_id(impl Into<String>)`](crate::operation::admin_update_device_status::builders::AdminUpdateDeviceStatusFluentBuilder::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::operation::admin_update_device_status::builders::AdminUpdateDeviceStatusFluentBuilder::set_user_pool_id):<br>required: **true**<br><p>The ID of the user pool where you want to change a user's device status.</p><br>
    ///   - [`username(impl Into<String>)`](crate::operation::admin_update_device_status::builders::AdminUpdateDeviceStatusFluentBuilder::username) / [`set_username(Option<String>)`](crate::operation::admin_update_device_status::builders::AdminUpdateDeviceStatusFluentBuilder::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_update_device_status::builders::AdminUpdateDeviceStatusFluentBuilder::device_key) / [`set_device_key(Option<String>)`](crate::operation::admin_update_device_status::builders::AdminUpdateDeviceStatusFluentBuilder::set_device_key):<br>required: **true**<br><p>The unique identifier, or device key, of the device that you want to update the status for.</p><br>
    ///   - [`device_remembered_status(DeviceRememberedStatusType)`](crate::operation::admin_update_device_status::builders::AdminUpdateDeviceStatusFluentBuilder::device_remembered_status) / [`set_device_remembered_status(Option<DeviceRememberedStatusType>)`](crate::operation::admin_update_device_status::builders::AdminUpdateDeviceStatusFluentBuilder::set_device_remembered_status):<br>required: **false**<br><p>To enable device authentication with the specified device, set to <code>remembered</code>.To disable, set to <code>not_remembered</code>.</p><br>
    /// - On success, responds with [`AdminUpdateDeviceStatusOutput`](crate::operation::admin_update_device_status::AdminUpdateDeviceStatusOutput)
    /// - On failure, responds with [`SdkError<AdminUpdateDeviceStatusError>`](crate::operation::admin_update_device_status::AdminUpdateDeviceStatusError)
    pub fn admin_update_device_status(&self) -> crate::operation::admin_update_device_status::builders::AdminUpdateDeviceStatusFluentBuilder {
        crate::operation::admin_update_device_status::builders::AdminUpdateDeviceStatusFluentBuilder::new(self.handle.clone())
    }
}