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.ListProfileObjects

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of objects associated with a profile of a given ProfileObjectType.

Synopsis

data ListProfileObjects = ListProfileObjects' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- objectFilter :: Maybe ObjectFilter
- domainName :: Text
- objectTypeName :: Text
- profileId :: Text
}
newListProfileObjects :: Text -> Text -> Text -> ListProfileObjects
listProfileObjects_maxResults :: Lens' ListProfileObjects (Maybe Natural)
listProfileObjects_nextToken :: Lens' ListProfileObjects (Maybe Text)
listProfileObjects_objectFilter :: Lens' ListProfileObjects (Maybe ObjectFilter)
listProfileObjects_domainName :: Lens' ListProfileObjects Text
listProfileObjects_objectTypeName :: Lens' ListProfileObjects Text
listProfileObjects_profileId :: Lens' ListProfileObjects Text
data ListProfileObjectsResponse = ListProfileObjectsResponse' {
- items :: Maybe [ListProfileObjectsItem]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListProfileObjectsResponse :: Int -> ListProfileObjectsResponse
listProfileObjectsResponse_items :: Lens' ListProfileObjectsResponse (Maybe [ListProfileObjectsItem])
listProfileObjectsResponse_nextToken :: Lens' ListProfileObjectsResponse (Maybe Text)
listProfileObjectsResponse_httpStatus :: Lens' ListProfileObjectsResponse Int

Creating a Request

data ListProfileObjects Source #

See: newListProfileObjects smart constructor.

Constructors

ListProfileObjects'

Fields

maxResults :: Maybe Natural
The maximum number of objects returned per page.
nextToken :: Maybe Text
The pagination token from the previous call to ListProfileObjects.
objectFilter :: Maybe ObjectFilter
Applies a filter to the response to include profile objects with the specified index values. This filter is only supported for ObjectTypeName _asset, _case and _order.
domainName :: Text
The unique name of the domain.
objectTypeName :: Text
The name of the profile object type.
profileId :: Text
The unique identifier of a customer profile.

Instances

Instances details

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

newListProfileObjects Source #

Arguments

:: Text	`ListProfileObjects`
-> Text	`ListProfileObjects`
-> Text	`ListProfileObjects`
-> ListProfileObjects

Create a value of ListProfileObjects 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:maxResults:ListProfileObjects', listProfileObjects_maxResults - The maximum number of objects returned per page.

ListProfileObjects, listProfileObjects_nextToken - The pagination token from the previous call to ListProfileObjects.

$sel:objectFilter:ListProfileObjects', listProfileObjects_objectFilter - Applies a filter to the response to include profile objects with the specified index values. This filter is only supported for ObjectTypeName _asset, _case and _order.

ListProfileObjects, listProfileObjects_domainName - The unique name of the domain.

ListProfileObjects, listProfileObjects_objectTypeName - The name of the profile object type.

ListProfileObjects, listProfileObjects_profileId - The unique identifier of a customer profile.

Request Lenses

listProfileObjects_maxResults :: Lens' ListProfileObjects (Maybe Natural) Source #

The maximum number of objects returned per page.

listProfileObjects_nextToken :: Lens' ListProfileObjects (Maybe Text) Source #

The pagination token from the previous call to ListProfileObjects.

listProfileObjects_objectFilter :: Lens' ListProfileObjects (Maybe ObjectFilter) Source #

Applies a filter to the response to include profile objects with the specified index values. This filter is only supported for ObjectTypeName _asset, _case and _order.

listProfileObjects_domainName :: Lens' ListProfileObjects Text Source #

The unique name of the domain.

listProfileObjects_objectTypeName :: Lens' ListProfileObjects Text Source #

The name of the profile object type.

listProfileObjects_profileId :: Lens' ListProfileObjects Text Source #

The unique identifier of a customer profile.

Destructuring the Response

data ListProfileObjectsResponse Source #

See: newListProfileObjectsResponse smart constructor.

Constructors

ListProfileObjectsResponse'
Fields items :: Maybe [ListProfileObjectsItem] The list of ListProfileObject instances. nextToken :: Maybe Text The pagination token from the previous call to ListProfileObjects. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListProfileObjectsResponse Source #

Arguments

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

Create a value of ListProfileObjectsResponse 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:ListProfileObjectsResponse', listProfileObjectsResponse_items - The list of ListProfileObject instances.

ListProfileObjects, listProfileObjectsResponse_nextToken - The pagination token from the previous call to ListProfileObjects.

$sel:httpStatus:ListProfileObjectsResponse', listProfileObjectsResponse_httpStatus - The response's http status code.

Response Lenses

listProfileObjectsResponse_items :: Lens' ListProfileObjectsResponse (Maybe [ListProfileObjectsItem]) Source #

The list of ListProfileObject instances.

listProfileObjectsResponse_nextToken :: Lens' ListProfileObjectsResponse (Maybe Text) Source #

The pagination token from the previous call to ListProfileObjects.

listProfileObjectsResponse_httpStatus :: Lens' ListProfileObjectsResponse Int Source #

The response's http status code.