Struct aws_sdk_alexaforbusiness::client::fluent_builders::SearchContacts

pub struct SearchContacts { /* private fields */ }

Fluent builder constructing a request to SearchContacts.

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

Implementations

impl SearchContacts

pub async fn send(
    self
) -> Result<SearchContactsOutput, SdkError<SearchContactsError>>

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 into_paginator(self) -> SearchContactsPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

pub fn filters(self, input: 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 address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.

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

The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.

pub fn sort_criteria(self, input: 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 contacts. The supported sort keys are DisplayName, FirstName, and LastName.

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

The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.

pub fn next_token(self, input: 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 only includes 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 only includes results beyond the token, up to the value specified by MaxResults.

pub fn max_results(self, input: 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.

Trait Implementations

impl Clone for SearchContacts

fn clone(&self) -> SearchContacts

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SearchContacts

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

Formats the value using the given formatter.