Struct aws_sdk_alexaforbusiness::client::fluent_builders::SearchDevices

pub struct SearchDevices<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to SearchDevices.

Searches devices and lists the ones that meet a set of filter criteria.

Implementations

impl<C, M, R> SearchDevices<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<SearchDevicesOutput, SdkError<SearchDevicesError>> where
    R::Policy: SmithyRetryPolicy<SearchDevicesInputOperationOutputAlias, SearchDevicesOutput, SearchDevicesError, SearchDevicesInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn next_token(self, inp: impl Into<String>) -> Self

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

pub fn set_next_token(self, input: Option<String>) -> Self

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

pub fn max_results(self, inp: i32) -> Self

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

pub fn set_max_results(self, input: Option<i32>) -> Self

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

pub fn filters(self, inp: impl Into<Filter>) -> Self

Appends an item to Filters.

To override the contents of this collection use set_filters.

The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, ConnectionStatus (ONLINE and OFFLINE), NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

pub fn set_filters(self, input: Option<Vec<Filter>>) -> Self

The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, ConnectionStatus (ONLINE and OFFLINE), NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

pub fn sort_criteria(self, inp: impl Into<Sort>) -> Self

Appends an item to SortCriteria.

To override the contents of this collection use set_sort_criteria.

The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, ConnectionStatus, NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

pub fn set_sort_criteria(self, input: Option<Vec<Sort>>) -> Self

The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, ConnectionStatus, NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for SearchDevices<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.