Struct aws_sdk_customerprofiles::operation::search_profiles::builders::SearchProfilesFluentBuilder

pub struct SearchProfilesFluentBuilder { /* private fields */ }

Fluent builder constructing a request to SearchProfiles.

Searches for profiles within a specific domain using one or more predefined search keys (e.g., _fullName, _phone, _email, _account, etc.) and/or custom-defined search keys. A search key is a data type pair that consists of a KeyName and Values list.

This operation supports searching for profiles with a minimum of 1 key-value(s) pair and up to 5 key-value(s) pairs using either AND or OR logic.

Implementations

impl SearchProfilesFluentBuilder

pub fn as_input(&self) -> &SearchProfilesInputBuilder

Access the SearchProfiles as a reference.

pub async fn send( self ) -> Result<SearchProfilesOutput, SdkError<SearchProfilesError, HttpResponse>>

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 customize( self ) -> CustomizableOperation<SearchProfilesOutput, SearchProfilesError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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

The pagination token from the previous SearchProfiles API call.

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

The pagination token from the previous SearchProfiles API call.

pub fn get_next_token(&self) -> &Option<String>

The pagination token from the previous SearchProfiles API call.

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

The maximum number of objects returned per page.

The default is 20 if this parameter is not included in the request.

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

The maximum number of objects returned per page.

The default is 20 if this parameter is not included in the request.

pub fn get_max_results(&self) -> &Option<i32>

The maximum number of objects returned per page.

The default is 20 if this parameter is not included in the request.

pub fn domain_name(self, input: impl Into<String>) -> Self

The unique name of the domain.

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

The unique name of the domain.

pub fn get_domain_name(&self) -> &Option<String>

The unique name of the domain.

pub fn key_name(self, input: impl Into<String>) -> Self

A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId, _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId, _shopifyOrderId.

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

A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId, _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId, _shopifyOrderId.

pub fn get_key_name(&self) -> &Option<String>

A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId, _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId, _shopifyOrderId.

pub fn values(self, input: impl Into<String>) -> Self

Appends an item to Values.

To override the contents of this collection use set_values.

A list of key values.

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

A list of key values.

pub fn get_values(&self) -> &Option<Vec<String>>

A list of key values.

pub fn additional_search_keys(self, input: AdditionalSearchKey) -> Self

Appends an item to AdditionalSearchKeys.

To override the contents of this collection use set_additional_search_keys.

A list of AdditionalSearchKey objects that are each searchable identifiers of a profile. Each AdditionalSearchKey object contains a KeyName and a list of Values associated with that specific key (i.e., a key-value(s) pair). These additional search keys will be used in conjunction with the LogicalOperator and the required KeyName and Values parameters to search for profiles that satisfy the search criteria.

pub fn set_additional_search_keys( self, input: Option<Vec<AdditionalSearchKey>> ) -> Self

A list of AdditionalSearchKey objects that are each searchable identifiers of a profile. Each AdditionalSearchKey object contains a KeyName and a list of Values associated with that specific key (i.e., a key-value(s) pair). These additional search keys will be used in conjunction with the LogicalOperator and the required KeyName and Values parameters to search for profiles that satisfy the search criteria.

pub fn get_additional_search_keys(&self) -> &Option<Vec<AdditionalSearchKey>>

A list of AdditionalSearchKey objects that are each searchable identifiers of a profile. Each AdditionalSearchKey object contains a KeyName and a list of Values associated with that specific key (i.e., a key-value(s) pair). These additional search keys will be used in conjunction with the LogicalOperator and the required KeyName and Values parameters to search for profiles that satisfy the search criteria.

pub fn logical_operator(self, input: LogicalOperator) -> Self

Relationship between all specified search keys that will be used to search for profiles. This includes the required KeyName and Values parameters as well as any key-value(s) pairs specified in the AdditionalSearchKeys list.

This parameter influences which profiles will be returned in the response in the following manner:

• AND - The response only includes profiles that match all of the search keys.

• OR - The response includes profiles that match at least one of the search keys.

The OR relationship is the default behavior if this parameter is not included in the request.

pub fn set_logical_operator(self, input: Option<LogicalOperator>) -> Self

Relationship between all specified search keys that will be used to search for profiles. This includes the required KeyName and Values parameters as well as any key-value(s) pairs specified in the AdditionalSearchKeys list.

This parameter influences which profiles will be returned in the response in the following manner:

• AND - The response only includes profiles that match all of the search keys.

• OR - The response includes profiles that match at least one of the search keys.

The OR relationship is the default behavior if this parameter is not included in the request.

pub fn get_logical_operator(&self) -> &Option<LogicalOperator>

Relationship between all specified search keys that will be used to search for profiles. This includes the required KeyName and Values parameters as well as any key-value(s) pairs specified in the AdditionalSearchKeys list.

This parameter influences which profiles will be returned in the response in the following manner:

• AND - The response only includes profiles that match all of the search keys.

• OR - The response includes profiles that match at least one of the search keys.

The OR relationship is the default behavior if this parameter is not included in the request.

Trait Implementations

impl Clone for SearchProfilesFluentBuilder

fn clone(&self) -> SearchProfilesFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SearchProfilesFluentBuilder

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

Formats the value using the given formatter.