Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CustomerProfiles.SearchProfiles

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

data SearchProfiles = SearchProfiles' {
- nextToken :: Maybe Text
- maxResults :: Maybe Natural
- domainName :: Text
- keyName :: Text
- values :: [Text]
}
newSearchProfiles :: Text -> Text -> SearchProfiles
searchProfiles_nextToken :: Lens' SearchProfiles (Maybe Text)
searchProfiles_maxResults :: Lens' SearchProfiles (Maybe Natural)
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

nextToken :: Maybe Text
The pagination token from the previous SearchProfiles API call.
maxResults :: Maybe Natural
The maximum number of objects returned per page.
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, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _zendeskUserId, _zendeskExternalId, _serviceNowSystemId.
values :: [Text]
A list of key values.

Instances

Instances details

Eq SearchProfiles Source #
Instance details Defined in Amazonka.CustomerProfiles.SearchProfiles Methods (==) :: SearchProfiles -> SearchProfiles -> Bool # (/=) :: SearchProfiles -> SearchProfiles -> Bool #
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 #
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 #
NFData SearchProfiles Source #
Instance details Defined in Amazonka.CustomerProfiles.SearchProfiles Methods rnf :: SearchProfiles -> () #
Hashable SearchProfiles Source #
Instance details Defined in Amazonka.CustomerProfiles.SearchProfiles Methods hashWithSalt :: Int -> SearchProfiles -> Int # hash :: SearchProfiles -> Int #
ToJSON SearchProfiles Source #
Instance details Defined in Amazonka.CustomerProfiles.SearchProfiles Methods toJSON :: SearchProfiles -> Value # toEncoding :: SearchProfiles -> Encoding # toJSONList :: [SearchProfiles] -> Value # toEncodingList :: [SearchProfiles] -> Encoding #
AWSRequest SearchProfiles Source #
Instance details Defined in Amazonka.CustomerProfiles.SearchProfiles Associated Types type AWSResponse SearchProfiles # Methods request :: SearchProfiles -> Request SearchProfiles # response :: MonadResource m => Logger -> Service -> Proxy SearchProfiles -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SearchProfiles))) #
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 #
type Rep SearchProfiles Source #
Instance details Defined in Amazonka.CustomerProfiles.SearchProfiles type Rep SearchProfiles = D1 ('MetaData "SearchProfiles" "Amazonka.CustomerProfiles.SearchProfiles" "libZSservicesZSamazonka-customer-profilesZSamazonka-customer-profiles" 'False) (C1 ('MetaCons "SearchProfiles'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (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])))))
type AWSResponse SearchProfiles Source #
Instance details Defined in Amazonka.CustomerProfiles.SearchProfiles type AWSResponse SearchProfiles = SearchProfilesResponse

newSearchProfiles Source #

Arguments

:: Text	`$sel:domainName:SearchProfiles'`
-> Text	`$sel:keyName: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:nextToken:SearchProfiles', searchProfiles_nextToken - The pagination token from the previous SearchProfiles API call.

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

$sel:domainName:SearchProfiles', searchProfiles_domainName - The unique name of the domain.

$sel:keyName:SearchProfiles', searchProfiles_keyName - 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.

$sel:values:SearchProfiles', searchProfiles_values - A list of key values.

Request Lenses

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

The pagination token from the previous SearchProfiles API call.

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

The maximum number of objects returned per page.

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, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _zendeskUserId, _zendeskExternalId, _serviceNowSystemId.

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 SearchProfiles instances. nextToken :: Maybe Text The pagination token from the previous SearchProfiles API call. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq SearchProfilesResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.SearchProfiles Methods (==) :: SearchProfilesResponse -> SearchProfilesResponse -> Bool # (/=) :: SearchProfilesResponse -> SearchProfilesResponse -> Bool #
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 #
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 #
NFData SearchProfilesResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.SearchProfiles Methods rnf :: SearchProfilesResponse -> () #
type Rep SearchProfilesResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.SearchProfiles type Rep SearchProfilesResponse = D1 ('MetaData "SearchProfilesResponse" "Amazonka.CustomerProfiles.SearchProfiles" "libZSservicesZSamazonka-customer-profilesZSamazonka-customer-profiles" '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 SearchProfiles instances.

$sel:nextToken: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 SearchProfiles instances.

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.