aws_sdk_cognitoidentityprovider/client/

admin_list_devices.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`AdminListDevices`](crate::operation::admin_list_devices::builders::AdminListDevicesFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`user_pool_id(impl Into<String>)`](crate::operation::admin_list_devices::builders::AdminListDevicesFluentBuilder::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::operation::admin_list_devices::builders::AdminListDevicesFluentBuilder::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_list_devices::builders::AdminListDevicesFluentBuilder::username) / [`set_username(Option<String>)`](crate::operation::admin_list_devices::builders::AdminListDevicesFluentBuilder::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>
    ///   - [`limit(i32)`](crate::operation::admin_list_devices::builders::AdminListDevicesFluentBuilder::limit) / [`set_limit(Option<i32>)`](crate::operation::admin_list_devices::builders::AdminListDevicesFluentBuilder::set_limit):<br>required: **false**<br><p>The maximum number of devices that you want Amazon Cognito to return in the response.</p><br>
    ///   - [`pagination_token(impl Into<String>)`](crate::operation::admin_list_devices::builders::AdminListDevicesFluentBuilder::pagination_token) / [`set_pagination_token(Option<String>)`](crate::operation::admin_list_devices::builders::AdminListDevicesFluentBuilder::set_pagination_token):<br>required: **false**<br><p>This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.</p><br>
    /// - On success, responds with [`AdminListDevicesOutput`](crate::operation::admin_list_devices::AdminListDevicesOutput) with field(s):
    ///   - [`devices(Option<Vec::<DeviceType>>)`](crate::operation::admin_list_devices::AdminListDevicesOutput::devices): <p>An array of devices and their information. Each entry that's returned includes device information, last-accessed and created dates, and the device key.</p>
    ///   - [`pagination_token(Option<String>)`](crate::operation::admin_list_devices::AdminListDevicesOutput::pagination_token): <p>The identifier that Amazon Cognito returned with the previous request to this operation. When you include a pagination token in your request, Amazon Cognito returns the next set of items in the list. By use of this token, you can paginate through the full list of items.</p>
    /// - On failure, responds with [`SdkError<AdminListDevicesError>`](crate::operation::admin_list_devices::AdminListDevicesError)
    pub fn admin_list_devices(&self) -> crate::operation::admin_list_devices::builders::AdminListDevicesFluentBuilder {
        crate::operation::admin_list_devices::builders::AdminListDevicesFluentBuilder::new(self.handle.clone())
    }
}