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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the template information for a specific object type.

A template is a predefined ProfileObjectType, such as “Salesforce-Account” or “Salesforce-Contact.” When a user sends a ProfileObject, using the PutProfileObject API, with an ObjectTypeName that matches one of the TemplateIds, it uses the mappings from the template.

Synopsis

Creating a Request

data GetProfileObjectTypeTemplate Source #

See: newGetProfileObjectTypeTemplate smart constructor.

Constructors

GetProfileObjectTypeTemplate'
Fields templateId :: Text A unique identifier for the object template.

Instances

Instances details

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

newGetProfileObjectTypeTemplate Source #

Arguments

:: Text	`GetProfileObjectTypeTemplate`
-> GetProfileObjectTypeTemplate

Create a value of GetProfileObjectTypeTemplate 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:

GetProfileObjectTypeTemplate, getProfileObjectTypeTemplate_templateId - A unique identifier for the object template.

Request Lenses

getProfileObjectTypeTemplate_templateId :: Lens' GetProfileObjectTypeTemplate Text Source #

A unique identifier for the object template.

Destructuring the Response

data GetProfileObjectTypeTemplateResponse Source #

See: newGetProfileObjectTypeTemplateResponse smart constructor.

Constructors

GetProfileObjectTypeTemplateResponse'

Fields

allowProfileCreation :: Maybe Bool
Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is FALSE. If the AllowProfileCreation flag is set to FALSE, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE, and if no match is found, then the service creates a new standard profile.
fields :: Maybe (HashMap Text ObjectTypeField)
A map of the name and ObjectType field.
keys :: Maybe (HashMap Text [ObjectTypeKey])
A list of unique keys that can be used to map data to the profile.
sourceLastUpdatedTimestampFormat :: Maybe Text
The format of your sourceLastUpdatedTimestamp that was previously set up.
sourceName :: Maybe Text
The name of the source of the object template.
sourceObject :: Maybe Text
The source of the object template.
templateId :: Maybe Text
A unique identifier for the object template.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetProfileObjectTypeTemplateResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.GetProfileObjectTypeTemplate Associated Types type Rep GetProfileObjectTypeTemplateResponse :: Type -> Type # Methods from :: GetProfileObjectTypeTemplateResponse -> Rep GetProfileObjectTypeTemplateResponse x # to :: Rep GetProfileObjectTypeTemplateResponse x -> GetProfileObjectTypeTemplateResponse #
Read GetProfileObjectTypeTemplateResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.GetProfileObjectTypeTemplate Methods readsPrec :: Int -> ReadS GetProfileObjectTypeTemplateResponse # readList :: ReadS [GetProfileObjectTypeTemplateResponse] # readPrec :: ReadPrec GetProfileObjectTypeTemplateResponse # readListPrec :: ReadPrec [GetProfileObjectTypeTemplateResponse] #
Show GetProfileObjectTypeTemplateResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.GetProfileObjectTypeTemplate Methods showsPrec :: Int -> GetProfileObjectTypeTemplateResponse -> ShowS # show :: GetProfileObjectTypeTemplateResponse -> String # showList :: [GetProfileObjectTypeTemplateResponse] -> ShowS #
NFData GetProfileObjectTypeTemplateResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.GetProfileObjectTypeTemplate Methods rnf :: GetProfileObjectTypeTemplateResponse -> () #
Eq GetProfileObjectTypeTemplateResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.GetProfileObjectTypeTemplate Methods (==) :: GetProfileObjectTypeTemplateResponse -> GetProfileObjectTypeTemplateResponse -> Bool # (/=) :: GetProfileObjectTypeTemplateResponse -> GetProfileObjectTypeTemplateResponse -> Bool #
type Rep GetProfileObjectTypeTemplateResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.GetProfileObjectTypeTemplate type Rep GetProfileObjectTypeTemplateResponse = D1 ('MetaData "GetProfileObjectTypeTemplateResponse" "Amazonka.CustomerProfiles.GetProfileObjectTypeTemplate" "amazonka-customer-profiles-2.0-7iC4NjyJEW8JuQGNtDiJ1f" 'False) (C1 ('MetaCons "GetProfileObjectTypeTemplateResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "allowProfileCreation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "fields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text ObjectTypeField)))) :: (S1 ('MetaSel ('Just "keys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [ObjectTypeKey]))) :: S1 ('MetaSel ('Just "sourceLastUpdatedTimestampFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "sourceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "sourceObject") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "templateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetProfileObjectTypeTemplateResponse Source #

Arguments

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

Create a value of GetProfileObjectTypeTemplateResponse 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:allowProfileCreation:GetProfileObjectTypeTemplateResponse', getProfileObjectTypeTemplateResponse_allowProfileCreation - Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is FALSE. If the AllowProfileCreation flag is set to FALSE, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE, and if no match is found, then the service creates a new standard profile.

$sel:fields:GetProfileObjectTypeTemplateResponse', getProfileObjectTypeTemplateResponse_fields - A map of the name and ObjectType field.

$sel:keys:GetProfileObjectTypeTemplateResponse', getProfileObjectTypeTemplateResponse_keys - A list of unique keys that can be used to map data to the profile.

$sel:sourceLastUpdatedTimestampFormat:GetProfileObjectTypeTemplateResponse', getProfileObjectTypeTemplateResponse_sourceLastUpdatedTimestampFormat - The format of your sourceLastUpdatedTimestamp that was previously set up.

GetProfileObjectTypeTemplateResponse, getProfileObjectTypeTemplateResponse_sourceName - The name of the source of the object template.

GetProfileObjectTypeTemplateResponse, getProfileObjectTypeTemplateResponse_sourceObject - The source of the object template.

GetProfileObjectTypeTemplate, getProfileObjectTypeTemplateResponse_templateId - A unique identifier for the object template.

$sel:httpStatus:GetProfileObjectTypeTemplateResponse', getProfileObjectTypeTemplateResponse_httpStatus - The response's http status code.

Response Lenses

getProfileObjectTypeTemplateResponse_allowProfileCreation :: Lens' GetProfileObjectTypeTemplateResponse (Maybe Bool) Source #

Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is FALSE. If the AllowProfileCreation flag is set to FALSE, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE, and if no match is found, then the service creates a new standard profile.

getProfileObjectTypeTemplateResponse_fields :: Lens' GetProfileObjectTypeTemplateResponse (Maybe (HashMap Text ObjectTypeField)) Source #

A map of the name and ObjectType field.

getProfileObjectTypeTemplateResponse_keys :: Lens' GetProfileObjectTypeTemplateResponse (Maybe (HashMap Text [ObjectTypeKey])) Source #

A list of unique keys that can be used to map data to the profile.

getProfileObjectTypeTemplateResponse_sourceLastUpdatedTimestampFormat :: Lens' GetProfileObjectTypeTemplateResponse (Maybe Text) Source #

The format of your sourceLastUpdatedTimestamp that was previously set up.

getProfileObjectTypeTemplateResponse_sourceName :: Lens' GetProfileObjectTypeTemplateResponse (Maybe Text) Source #

The name of the source of the object template.

getProfileObjectTypeTemplateResponse_sourceObject :: Lens' GetProfileObjectTypeTemplateResponse (Maybe Text) Source #

The source of the object template.

getProfileObjectTypeTemplateResponse_templateId :: Lens' GetProfileObjectTypeTemplateResponse (Maybe Text) Source #

A unique identifier for the object template.

getProfileObjectTypeTemplateResponse_httpStatus :: Lens' GetProfileObjectTypeTemplateResponse Int Source #

The response's http status code.