Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CustomerProfiles.SearchProfiles

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

data SearchProfiles = SearchProfiles' {
- additionalSearchKeys :: Maybe (NonEmpty AdditionalSearchKey)
- logicalOperator :: Maybe LogicalOperator
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- domainName :: Text
- keyName :: Text
- values :: [Text]
}
newSearchProfiles :: Text -> Text -> SearchProfiles
searchProfiles_additionalSearchKeys :: Lens' SearchProfiles (Maybe (NonEmpty AdditionalSearchKey))
searchProfiles_logicalOperator :: Lens' SearchProfiles (Maybe LogicalOperator)
searchProfiles_maxResults :: Lens' SearchProfiles (Maybe Natural)
searchProfiles_nextToken :: Lens' SearchProfiles (Maybe Text)
searchProfiles_domainName :: Lens' SearchProfiles Text
searchProfiles_keyName :: Lens' SearchProfiles Text
searchProfiles_values :: Lens' SearchProfiles [Text]
data SearchProfilesResponse = SearchProfilesResponse' {
- items :: Maybe [Profile]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newSearchProfilesResponse :: Int -> SearchProfilesResponse
searchProfilesResponse_items :: Lens' SearchProfilesResponse (Maybe [Profile])
searchProfilesResponse_nextToken :: Lens' SearchProfilesResponse (Maybe Text)
searchProfilesResponse_httpStatus :: Lens' SearchProfilesResponse Int

Creating a Request

data SearchProfiles Source #

See: newSearchProfiles smart constructor.

Constructors

SearchProfiles'

Fields

additionalSearchKeys :: Maybe (NonEmpty 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.
logicalOperator :: Maybe 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.
maxResults :: Maybe Natural
The maximum number of objects returned per page.
The default is 20 if this parameter is not included in the request.
nextToken :: Maybe Text
The pagination token from the previous SearchProfiles API call.
domainName :: Text
The unique name of the domain.
keyName :: Text
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 :: [Text]
A list of key values.

Instances

Instances details

ToJSON SearchProfiles Source #
Instance details Defined in Amazonka.CustomerProfiles.SearchProfiles Methods toJSON :: SearchProfiles -> Value # toEncoding :: SearchProfiles -> Encoding # toJSONList :: [SearchProfiles] -> Value # toEncodingList :: [SearchProfiles] -> Encoding #
ToHeaders SearchProfiles Source #
Instance details Defined in Amazonka.CustomerProfiles.SearchProfiles Methods toHeaders :: SearchProfiles -> [Header] #
ToPath SearchProfiles Source #
Instance details Defined in Amazonka.CustomerProfiles.SearchProfiles Methods toPath :: SearchProfiles -> ByteString #
ToQuery SearchProfiles Source #
Instance details Defined in Amazonka.CustomerProfiles.SearchProfiles Methods toQuery :: SearchProfiles -> QueryString #
AWSRequest SearchProfiles Source #
Instance details Defined in Amazonka.CustomerProfiles.SearchProfiles Associated Types type AWSResponse SearchProfiles # Methods request :: (Service -> Service) -> SearchProfiles -> Request SearchProfiles # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SearchProfiles -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SearchProfiles))) #
Generic SearchProfiles Source #
Instance details Defined in Amazonka.CustomerProfiles.SearchProfiles Associated Types type Rep SearchProfiles :: Type -> Type # Methods from :: SearchProfiles -> Rep SearchProfiles x # to :: Rep SearchProfiles x -> SearchProfiles #
Read SearchProfiles Source #
Instance details Defined in Amazonka.CustomerProfiles.SearchProfiles Methods readsPrec :: Int -> ReadS SearchProfiles # readList :: ReadS [SearchProfiles] # readPrec :: ReadPrec SearchProfiles # readListPrec :: ReadPrec [SearchProfiles] #
Show SearchProfiles Source #
Instance details Defined in Amazonka.CustomerProfiles.SearchProfiles Methods showsPrec :: Int -> SearchProfiles -> ShowS # show :: SearchProfiles -> String # showList :: [SearchProfiles] -> ShowS #
NFData SearchProfiles Source #
Instance details Defined in Amazonka.CustomerProfiles.SearchProfiles Methods rnf :: SearchProfiles -> () #
Eq SearchProfiles Source #
Instance details Defined in Amazonka.CustomerProfiles.SearchProfiles Methods (==) :: SearchProfiles -> SearchProfiles -> Bool # (/=) :: SearchProfiles -> SearchProfiles -> Bool #
Hashable SearchProfiles Source #
Instance details Defined in Amazonka.CustomerProfiles.SearchProfiles Methods hashWithSalt :: Int -> SearchProfiles -> Int # hash :: SearchProfiles -> Int #
type AWSResponse SearchProfiles Source #
Instance details Defined in Amazonka.CustomerProfiles.SearchProfiles type AWSResponse SearchProfiles = SearchProfilesResponse
type Rep SearchProfiles Source #
Instance details Defined in Amazonka.CustomerProfiles.SearchProfiles type Rep SearchProfiles = D1 ('MetaData "SearchProfiles" "Amazonka.CustomerProfiles.SearchProfiles" "amazonka-customer-profiles-2.0-7iC4NjyJEW8JuQGNtDiJ1f" 'False) (C1 ('MetaCons "SearchProfiles'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "additionalSearchKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty AdditionalSearchKey))) :: (S1 ('MetaSel ('Just "logicalOperator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LogicalOperator)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :: ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "keyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))))

newSearchProfiles Source #

Arguments

:: Text	`SearchProfiles`
-> Text	`SearchProfiles`
-> SearchProfiles

Create a value of SearchProfiles with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:additionalSearchKeys:SearchProfiles', searchProfiles_additionalSearchKeys - 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.

$sel:logicalOperator:SearchProfiles', searchProfiles_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.

$sel:maxResults:SearchProfiles', searchProfiles_maxResults - The maximum number of objects returned per page.

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

SearchProfiles, searchProfiles_nextToken - The pagination token from the previous SearchProfiles API call.

SearchProfiles, searchProfiles_domainName - The unique name of the domain.

SearchProfiles, searchProfiles_keyName - 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.

SearchProfiles, searchProfiles_values - A list of key values.

Request Lenses

searchProfiles_additionalSearchKeys :: Lens' SearchProfiles (Maybe (NonEmpty AdditionalSearchKey)) Source #

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.

searchProfiles_logicalOperator :: Lens' SearchProfiles (Maybe LogicalOperator) Source #

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.

searchProfiles_maxResults :: Lens' SearchProfiles (Maybe Natural) Source #

The maximum number of objects returned per page.

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

searchProfiles_nextToken :: Lens' SearchProfiles (Maybe Text) Source #

The pagination token from the previous SearchProfiles API call.

searchProfiles_domainName :: Lens' SearchProfiles Text Source #

The unique name of the domain.

searchProfiles_keyName :: Lens' SearchProfiles Text Source #

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.

searchProfiles_values :: Lens' SearchProfiles [Text] Source #

A list of key values.

Destructuring the Response

data SearchProfilesResponse Source #

See: newSearchProfilesResponse smart constructor.

Constructors

SearchProfilesResponse'
Fields items :: Maybe [Profile] The list of Profiles matching the search criteria. nextToken :: Maybe Text The pagination token from the previous SearchProfiles API call. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic SearchProfilesResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.SearchProfiles Associated Types type Rep SearchProfilesResponse :: Type -> Type # Methods from :: SearchProfilesResponse -> Rep SearchProfilesResponse x # to :: Rep SearchProfilesResponse x -> SearchProfilesResponse #
Read SearchProfilesResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.SearchProfiles Methods readsPrec :: Int -> ReadS SearchProfilesResponse # readList :: ReadS [SearchProfilesResponse] # readPrec :: ReadPrec SearchProfilesResponse # readListPrec :: ReadPrec [SearchProfilesResponse] #
Show SearchProfilesResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.SearchProfiles Methods showsPrec :: Int -> SearchProfilesResponse -> ShowS # show :: SearchProfilesResponse -> String # showList :: [SearchProfilesResponse] -> ShowS #
NFData SearchProfilesResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.SearchProfiles Methods rnf :: SearchProfilesResponse -> () #
Eq SearchProfilesResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.SearchProfiles Methods (==) :: SearchProfilesResponse -> SearchProfilesResponse -> Bool # (/=) :: SearchProfilesResponse -> SearchProfilesResponse -> Bool #
type Rep SearchProfilesResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.SearchProfiles type Rep SearchProfilesResponse = D1 ('MetaData "SearchProfilesResponse" "Amazonka.CustomerProfiles.SearchProfiles" "amazonka-customer-profiles-2.0-7iC4NjyJEW8JuQGNtDiJ1f" 'False) (C1 ('MetaCons "SearchProfilesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Profile])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSearchProfilesResponse Source #

Arguments

:: Int	`$sel:httpStatus:SearchProfilesResponse'`
-> SearchProfilesResponse

Create a value of SearchProfilesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:items:SearchProfilesResponse', searchProfilesResponse_items - The list of Profiles matching the search criteria.

SearchProfiles, searchProfilesResponse_nextToken - The pagination token from the previous SearchProfiles API call.

$sel:httpStatus:SearchProfilesResponse', searchProfilesResponse_httpStatus - The response's http status code.

Response Lenses

searchProfilesResponse_items :: Lens' SearchProfilesResponse (Maybe [Profile]) Source #

The list of Profiles matching the search criteria.

searchProfilesResponse_nextToken :: Lens' SearchProfilesResponse (Maybe Text) Source #

The pagination token from the previous SearchProfiles API call.

searchProfilesResponse_httpStatus :: Lens' SearchProfilesResponse Int Source #

The response's http status code.