customerprofiles/aws.sdk.kotlin.services.customerprofiles.model/SearchProfilesRequest/Builder

Builder

Properties

var additionalSearchKeys: List<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.

domainName

var domainName: String?

The unique name of the domain.

keyName

var keyName: 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.

logicalOperator

var logicalOperator: 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.

maxResults

var maxResults: Int?

The maximum number of objects returned per page.

nextToken

var nextToken: String?

The pagination token from the previous SearchProfiles API call.

values

var values: List<String>?

A list of key values.