SearchProfilesRequest (p.awso.0.9.0.doc.awso.customer-profiles.Awso_customer

Sourcetype nonrec t = {

nextToken : Token.t option;
(*
The pagination token from the previous SearchProfiles API call.
*)
maxResults : MaxSize100.t option;
(*
The maximum number of objects returned per page. The default is 20 if this parameter is not included in the request.
*)
domainName : Name.t;
(*
The unique name of the domain.
*)
keyName : Name.t;
(*
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.
*)
values : RequestValueList.t;
(*
A list of key values.
*)
additionalSearchKeys : AdditionalSearchKeysList.t option;
(*
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.
*)
logicalOperator : LogicalOperator.t option;
(*
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.
*)

}

Sourceval context_ : string

val make : 
  ?nextToken:??? ->
  ?maxResults:??? ->
  ?additionalSearchKeys:??? ->
  ?logicalOperator:??? ->
  domainName:Name.t ->
  keyName:Name.t ->
  values:RequestValueList.t ->
  unit ->
  t

Source

val to_value : 
  t ->
  [> `Structure of
       (string
        * [> `Enum of string
          | `Integer of MaxSize100.t
          | `List of
            [> `String of String1To255.t
            | `Structure of
              (string
               * [> `List of [> `String of String1To255.t ] list
                 | `String of Name.t ])
                list ]
              list
          | `String of Token.t ])
         list ]

Sourceval to_query : t -> Awso.Client.Query.t

Sourceval of_xml : Awso.Xml.t -> t

Sourceval of_string : string -> t

Sourceval of_json : Yojson.Safe.t -> t

Sourceval to_json : t -> Yojson.Safe.t