aws_sdk_wickr/client/

list_devices_for_user.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListDevicesForUser`](crate::operation::list_devices_for_user::builders::ListDevicesForUserFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_devices_for_user::builders::ListDevicesForUserFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`network_id(impl Into<String>)`](crate::operation::list_devices_for_user::builders::ListDevicesForUserFluentBuilder::network_id) / [`set_network_id(Option<String>)`](crate::operation::list_devices_for_user::builders::ListDevicesForUserFluentBuilder::set_network_id):<br>required: **true**<br><p>The ID of the Wickr network containing the user.</p><br>
    ///   - [`user_id(impl Into<String>)`](crate::operation::list_devices_for_user::builders::ListDevicesForUserFluentBuilder::user_id) / [`set_user_id(Option<String>)`](crate::operation::list_devices_for_user::builders::ListDevicesForUserFluentBuilder::set_user_id):<br>required: **true**<br><p>The unique identifier of the user whose devices will be listed.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_devices_for_user::builders::ListDevicesForUserFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_devices_for_user::builders::ListDevicesForUserFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for retrieving the next page of results. This is returned from a previous request when there are more results available.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_devices_for_user::builders::ListDevicesForUserFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_devices_for_user::builders::ListDevicesForUserFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of devices to return in a single page. Valid range is 1-100. Default is 10.</p><br>
    ///   - [`sort_fields(impl Into<String>)`](crate::operation::list_devices_for_user::builders::ListDevicesForUserFluentBuilder::sort_fields) / [`set_sort_fields(Option<String>)`](crate::operation::list_devices_for_user::builders::ListDevicesForUserFluentBuilder::set_sort_fields):<br>required: **false**<br><p>The fields to sort devices by. Multiple fields can be specified by separating them with '+'. Accepted values include 'lastlogin', 'type', 'suspend', and 'created'.</p><br>
    ///   - [`sort_direction(SortDirection)`](crate::operation::list_devices_for_user::builders::ListDevicesForUserFluentBuilder::sort_direction) / [`set_sort_direction(Option<SortDirection>)`](crate::operation::list_devices_for_user::builders::ListDevicesForUserFluentBuilder::set_sort_direction):<br>required: **false**<br><p>The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.</p><br>
    /// - On success, responds with [`ListDevicesForUserOutput`](crate::operation::list_devices_for_user::ListDevicesForUserOutput) with field(s):
    ///   - [`next_token(Option<String>)`](crate::operation::list_devices_for_user::ListDevicesForUserOutput::next_token): <p>The token to use for retrieving the next page of results. If this is not present, there are no more results.</p>
    ///   - [`devices(Vec::<BasicDeviceObject>)`](crate::operation::list_devices_for_user::ListDevicesForUserOutput::devices): <p>A list of device objects associated with the user within the current page.</p>
    /// - On failure, responds with [`SdkError<ListDevicesForUserError>`](crate::operation::list_devices_for_user::ListDevicesForUserError)
    pub fn list_devices_for_user(&self) -> crate::operation::list_devices_for_user::builders::ListDevicesForUserFluentBuilder {
        crate::operation::list_devices_for_user::builders::ListDevicesForUserFluentBuilder::new(self.handle.clone())
    }
}