[ aws . customer-profiles ]
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.
See also: AWS API Documentation
search-profiles
[--next-token <value>]
[--max-results <value>]
--domain-name <value>
--key-name <value>
--values <value>
[--additional-search-keys <value>]
[--logical-operator <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
--next-token
(string)
The pagination token from the previous SearchProfiles API call.
Constraints:
- min:
1
- max:
1024
--max-results
(integer)
The maximum number of objects returned per page.
The default is 20 if this parameter is not included in the request.
Constraints:
- min:
1
- max:
100
--domain-name
(string) [required]
The unique name of the domain.
Constraints:
- min:
1
- max:
64
- pattern:
^[a-zA-Z0-9_-]+$
--key-name
(string) [required]
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.
Constraints:
- min:
1
- max:
64
- pattern:
^[a-zA-Z0-9_-]+$
--values
(list) [required]
A list of key values.
(string)
Constraints:
- min:
1
- max:
255
Syntax:
"string" "string" ...
--additional-search-keys
(list)
A list of
AdditionalSearchKey
objects that are each searchable identifiers of a profile. EachAdditionalSearchKey
object contains aKeyName
and a list ofValues
associated with that specific key (i.e., a key-value(s) pair). These additional search keys will be used in conjunction with theLogicalOperator
and the requiredKeyName
andValues
parameters to search for profiles that satisfy the search criteria.Constraints:
- min:
1
- max:
4
(structure)
A data type pair that consists of a
KeyName
andValues
list that is used in conjunction with the KeyName and Values parameters to search for profiles using the SearchProfiles API.KeyName -> (string) [required]
A searchable identifier of a customer profile.
Constraints:
- min:
1
- max:
64
- pattern:
^[a-zA-Z0-9_-]+$
Values -> (list) [required]
A list of key values.
(string)
Constraints:
- min:
1
- max:
255
Shorthand Syntax:
KeyName=string,Values=string,string ...
JSON Syntax:
[
{
"KeyName": "string",
"Values": ["string", ...]
}
...
]
--logical-operator
(string)
Relationship between all specified search keys that will be used to search for profiles. This includes the required
KeyName
andValues
parameters as well as any key-value(s) pairs specified in theAdditionalSearchKeys
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.Possible values:
AND
OR
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command’s default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format
(string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb://
will always be treated as binary and use the file contents directly regardless of the cli-binary-format
setting. When using file://
the file contents will need to properly formatted for the configured cli-binary-format
.
--no-cli-pager
(boolean)
Disable cli pager for output.
--cli-auto-prompt
(boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt
(boolean)
Disable automatically prompt for CLI input parameters.
Items -> (list)
The list of Profiles matching the search criteria.
(structure)
The standard profile of a customer.
ProfileId -> (string)
The unique identifier of a customer profile.
Constraints:
- pattern:
[a-f0-9]{32}
AccountNumber -> (string)
An account number that you have assigned to the customer.
Constraints:
- min:
1
- max:
255
AdditionalInformation -> (string)
Any additional information relevant to the customer’s profile.
Constraints:
- min:
1
- max:
1000
PartyType -> (string)
The type of profile used to describe the customer.
Possible values:
INDIVIDUAL
BUSINESS
OTHER
BusinessName -> (string)
The name of the customer’s business.
Constraints:
- min:
1
- max:
255
FirstName -> (string)
The customer’s first name.
Constraints:
- min:
1
- max:
255
MiddleName -> (string)
The customer’s middle name.
Constraints:
- min:
1
- max:
255
LastName -> (string)
The customer’s last name.
Constraints:
- min:
1
- max:
255
BirthDate -> (string)
The customer’s birth date.
Constraints:
- min:
1
- max:
255
Gender -> (string)
The gender with which the customer identifies.
Possible values:
MALE
FEMALE
UNSPECIFIED
PhoneNumber -> (string)
The customer’s phone number, which has not been specified as a mobile, home, or business number.
Constraints:
- min:
1
- max:
255
MobilePhoneNumber -> (string)
The customer’s mobile phone number.
Constraints:
- min:
1
- max:
255
HomePhoneNumber -> (string)
The customer’s home phone number.
Constraints:
- min:
1
- max:
255
BusinessPhoneNumber -> (string)
The customer’s home phone number.
Constraints:
- min:
1
- max:
255
EmailAddress -> (string)
The customer’s email address, which has not been specified as a personal or business address.
Constraints:
- min:
1
- max:
255
PersonalEmailAddress -> (string)
The customer’s personal email address.
Constraints:
- min:
1
- max:
255
BusinessEmailAddress -> (string)
The customer’s business email address.
Constraints:
- min:
1
- max:
255
Address -> (structure)
A generic address associated with the customer that is not mailing, shipping, or billing.
Address1 -> (string)
The first line of a customer address.
Constraints:
- min:
1
- max:
255
Address2 -> (string)
The second line of a customer address.
Constraints:
- min:
1
- max:
255
Address3 -> (string)
The third line of a customer address.
Constraints:
- min:
1
- max:
255
Address4 -> (string)
The fourth line of a customer address.
Constraints:
- min:
1
- max:
255
City -> (string)
The city in which a customer lives.
Constraints:
- min:
1
- max:
255
County -> (string)
The county in which a customer lives.
Constraints:
- min:
1
- max:
255
State -> (string)
The state in which a customer lives.
Constraints:
- min:
1
- max:
255
Province -> (string)
The province in which a customer lives.
Constraints:
- min:
1
- max:
255
Country -> (string)
The country in which a customer lives.
Constraints:
- min:
1
- max:
255
PostalCode -> (string)
The postal code of a customer address.
Constraints:
- min:
1
- max:
255
ShippingAddress -> (structure)
The customer’s shipping address.
Address1 -> (string)
The first line of a customer address.
Constraints:
- min:
1
- max:
255
Address2 -> (string)
The second line of a customer address.
Constraints:
- min:
1
- max:
255
Address3 -> (string)
The third line of a customer address.
Constraints:
- min:
1
- max:
255
Address4 -> (string)
The fourth line of a customer address.
Constraints:
- min:
1
- max:
255
City -> (string)
The city in which a customer lives.
Constraints:
- min:
1
- max:
255
County -> (string)
The county in which a customer lives.
Constraints:
- min:
1
- max:
255
State -> (string)
The state in which a customer lives.
Constraints:
- min:
1
- max:
255
Province -> (string)
The province in which a customer lives.
Constraints:
- min:
1
- max:
255
Country -> (string)
The country in which a customer lives.
Constraints:
- min:
1
- max:
255
PostalCode -> (string)
The postal code of a customer address.
Constraints:
- min:
1
- max:
255
MailingAddress -> (structure)
The customer’s mailing address.
Address1 -> (string)
The first line of a customer address.
Constraints:
- min:
1
- max:
255
Address2 -> (string)
The second line of a customer address.
Constraints:
- min:
1
- max:
255
Address3 -> (string)
The third line of a customer address.
Constraints:
- min:
1
- max:
255
Address4 -> (string)
The fourth line of a customer address.
Constraints:
- min:
1
- max:
255
City -> (string)
The city in which a customer lives.
Constraints:
- min:
1
- max:
255
County -> (string)
The county in which a customer lives.
Constraints:
- min:
1
- max:
255
State -> (string)
The state in which a customer lives.
Constraints:
- min:
1
- max:
255
Province -> (string)
The province in which a customer lives.
Constraints:
- min:
1
- max:
255
Country -> (string)
The country in which a customer lives.
Constraints:
- min:
1
- max:
255
PostalCode -> (string)
The postal code of a customer address.
Constraints:
- min:
1
- max:
255
BillingAddress -> (structure)
The customer’s billing address.
Address1 -> (string)
The first line of a customer address.
Constraints:
- min:
1
- max:
255
Address2 -> (string)
The second line of a customer address.
Constraints:
- min:
1
- max:
255
Address3 -> (string)
The third line of a customer address.
Constraints:
- min:
1
- max:
255
Address4 -> (string)
The fourth line of a customer address.
Constraints:
- min:
1
- max:
255
City -> (string)
The city in which a customer lives.
Constraints:
- min:
1
- max:
255
County -> (string)
The county in which a customer lives.
Constraints:
- min:
1
- max:
255
State -> (string)
The state in which a customer lives.
Constraints:
- min:
1
- max:
255
Province -> (string)
The province in which a customer lives.
Constraints:
- min:
1
- max:
255
Country -> (string)
The country in which a customer lives.
Constraints:
- min:
1
- max:
255
PostalCode -> (string)
The postal code of a customer address.
Constraints:
- min:
1
- max:
255
Attributes -> (map)
A key value pair of attributes of a customer profile.
key -> (string)
Constraints:
- min:
1
- max:
255
value -> (string)
Constraints:
- min:
1
- max:
255
FoundByItems -> (list)
A list of items used to find a profile returned in a SearchProfiles response. An item is a key-value(s) pair that matches an attribute in the profile.
If the optional
AdditionalSearchKeys
parameter was included in the SearchProfiles request, theFoundByItems
list should be interpreted based on theLogicalOperator
used in the request:
AND
- The profile included in the response matched all of the search keys specified in the request. TheFoundByItems
will include all of the key-value(s) pairs that were specified in the request (as this is a requirement ofAND
search logic).OR
- The profile included in the response matched at least one of the search keys specified in the request. TheFoundByItems
will include each of the key-value(s) pairs that the profile was found by.The
OR
relationship is the default behavior if theLogicalOperator
parameter is not included in the SearchProfiles request.Constraints:
- min:
1
- max:
5
(structure)
A data type pair that consists of a
KeyName
andValues
list that were used to find a profile returned in response to a SearchProfiles request.KeyName -> (string)
A searchable identifier of a customer profile.
Constraints:
- min:
1
- max:
64
- pattern:
^[a-zA-Z0-9_-]+$
Values -> (list)
A list of key values.
(string)
Constraints:
- min:
1
- max:
255
PartyTypeString -> (string)
An alternative to PartyType which accepts any string as input.
Constraints:
- min:
1
- max:
255
GenderString -> (string)
An alternative to Gender which accepts any string as input.
Constraints:
- min:
1
- max:
255
ProfileType -> (string)
The type of the profile.
Possible values:
ACCOUNT_PROFILE
PROFILE
EngagementPreferences -> (structure)
The customer or account’s engagement preferences.
Phone -> (list)
A list of phone-related contact preferences
(structure)
Object that defines users contact preference.
KeyName -> (string)
A searchable, unique identifier of a customer profile.
Constraints:
- min:
1
- max:
64
- pattern:
^[a-zA-Z0-9_-]+$
KeyValue -> (string)
The key value used to look up profile based off the keyName.
Constraints:
- min:
1
- max:
255
ProfileId -> (string)
The unique identifier of a customer profile.
Constraints:
- pattern:
[a-f0-9]{32}
ContactType -> (string)
The contact type used for engagement. For example: HomePhoneNumber, PersonalEmailAddress.
Possible values:
PhoneNumber
MobilePhoneNumber
HomePhoneNumber
BusinessPhoneNumber
EmailAddress
PersonalEmailAddress
BusinessEmailAddress
Email -> (list)
A list of email-related contact preferences
(structure)
Object that defines users contact preference.
KeyName -> (string)
A searchable, unique identifier of a customer profile.
Constraints:
- min:
1
- max:
64
- pattern:
^[a-zA-Z0-9_-]+$
KeyValue -> (string)
The key value used to look up profile based off the keyName.
Constraints:
- min:
1
- max:
255
ProfileId -> (string)
The unique identifier of a customer profile.
Constraints:
- pattern:
[a-f0-9]{32}
ContactType -> (string)
The contact type used for engagement. For example: HomePhoneNumber, PersonalEmailAddress.
Possible values:
PhoneNumber
MobilePhoneNumber
HomePhoneNumber
BusinessPhoneNumber
EmailAddress
PersonalEmailAddress
BusinessEmailAddress
NextToken -> (string)
The pagination token from the previous SearchProfiles API call.
Constraints:
- min:
1
- max:
1024