aws_sdk_cognitoidentityprovider/client/

admin_get_device.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`AdminGetDevice`](crate::operation::admin_get_device::builders::AdminGetDeviceFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`device_key(impl Into<String>)`](crate::operation::admin_get_device::builders::AdminGetDeviceFluentBuilder::device_key) / [`set_device_key(Option<String>)`](crate::operation::admin_get_device::builders::AdminGetDeviceFluentBuilder::set_device_key):<br>required: **true**<br><p>The key of the device that you want to delete.</p><br>
    ///   - [`user_pool_id(impl Into<String>)`](crate::operation::admin_get_device::builders::AdminGetDeviceFluentBuilder::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::operation::admin_get_device::builders::AdminGetDeviceFluentBuilder::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_get_device::builders::AdminGetDeviceFluentBuilder::username) / [`set_username(Option<String>)`](crate::operation::admin_get_device::builders::AdminGetDeviceFluentBuilder::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>
    /// - On success, responds with [`AdminGetDeviceOutput`](crate::operation::admin_get_device::AdminGetDeviceOutput) with field(s):
    ///   - [`device(Option<DeviceType>)`](crate::operation::admin_get_device::AdminGetDeviceOutput::device): <p>Details of the requested device. Includes device information, last-accessed and created dates, and the device key.</p>
    /// - On failure, responds with [`SdkError<AdminGetDeviceError>`](crate::operation::admin_get_device::AdminGetDeviceError)
    pub fn admin_get_device(&self) -> crate::operation::admin_get_device::builders::AdminGetDeviceFluentBuilder {
        crate::operation::admin_get_device::builders::AdminGetDeviceFluentBuilder::new(self.handle.clone())
    }
}