Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . customer-profiles ]

search-profiles

Description

Searches for profiles within a specific domain name using name, phone number, email address, account number, or a custom defined index.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  search-profiles
[--next-token <value>]
[--max-results <value>]
--domain-name <value>
--key-name <value>
--values <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--next-token (string)

The pagination token from the previous SearchProfiles API call.

--max-results (integer)

The maximum number of objects returned per page.

--domain-name (string)

The unique name of the domain.

--key-name (string)

A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _zendeskUserId, _zendeskExternalId, _serviceNowSystemId.

--values (list)

A list of key values.

(string)

Syntax:

"string" "string" ...

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

Items -> (list)

The list of SearchProfiles instances.

(structure)

The standard profile of a customer.

ProfileId -> (string)

The unique identifier of a customer profile.

AccountNumber -> (string)

A unique account number that you have given to the customer.

AdditionalInformation -> (string)

Any additional information relevant to the customer’s profile.

PartyType -> (string)

The type of profile used to describe the customer.

BusinessName -> (string)

The name of the customer’s business.

FirstName -> (string)

The customer’s first name.

MiddleName -> (string)

The customer’s middle name.

LastName -> (string)

The customer’s last name.

BirthDate -> (string)

The customer’s birth date.

Gender -> (string)

The gender with which the customer identifies.

PhoneNumber -> (string)

The customer's phone number, which has not been specified as a mobile, home, or business number.

MobilePhoneNumber -> (string)

The customer’s mobile phone number.

HomePhoneNumber -> (string)

The customer’s home phone number.

BusinessPhoneNumber -> (string)

The customer’s home phone number.

EmailAddress -> (string)

The customer’s email address, which has not been specified as a personal or business address.

PersonalEmailAddress -> (string)

The customer’s personal email address.

BusinessEmailAddress -> (string)

The customer’s business email address.

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.

Address2 -> (string)

The second line of a customer address.

Address3 -> (string)

The third line of a customer address.

Address4 -> (string)

The fourth line of a customer address.

City -> (string)

The city in which a customer lives.

County -> (string)

The county in which a customer lives.

State -> (string)

The state in which a customer lives.

Province -> (string)

The province in which a customer lives.

Country -> (string)

The country in which a customer lives.

PostalCode -> (string)

The postal code of a customer address.

ShippingAddress -> (structure)

The customer’s shipping address.

Address1 -> (string)

The first line of a customer address.

Address2 -> (string)

The second line of a customer address.

Address3 -> (string)

The third line of a customer address.

Address4 -> (string)

The fourth line of a customer address.

City -> (string)

The city in which a customer lives.

County -> (string)

The county in which a customer lives.

State -> (string)

The state in which a customer lives.

Province -> (string)

The province in which a customer lives.

Country -> (string)

The country in which a customer lives.

PostalCode -> (string)

The postal code of a customer address.

MailingAddress -> (structure)

The customer’s mailing address.

Address1 -> (string)

The first line of a customer address.

Address2 -> (string)

The second line of a customer address.

Address3 -> (string)

The third line of a customer address.

Address4 -> (string)

The fourth line of a customer address.

City -> (string)

The city in which a customer lives.

County -> (string)

The county in which a customer lives.

State -> (string)

The state in which a customer lives.

Province -> (string)

The province in which a customer lives.

Country -> (string)

The country in which a customer lives.

PostalCode -> (string)

The postal code of a customer address.

BillingAddress -> (structure)

The customer’s billing address.

Address1 -> (string)

The first line of a customer address.

Address2 -> (string)

The second line of a customer address.

Address3 -> (string)

The third line of a customer address.

Address4 -> (string)

The fourth line of a customer address.

City -> (string)

The city in which a customer lives.

County -> (string)

The county in which a customer lives.

State -> (string)

The state in which a customer lives.

Province -> (string)

The province in which a customer lives.

Country -> (string)

The country in which a customer lives.

PostalCode -> (string)

The postal code of a customer address.

Attributes -> (map)

A key value pair of attributes of a customer profile.

key -> (string)

value -> (string)

NextToken -> (string)

The pagination token from the previous SearchProfiles API call.