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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the object types for a specific domain.

Synopsis

data GetProfileObjectType = GetProfileObjectType' {
- domainName :: Text
- objectTypeName :: Text
}
newGetProfileObjectType :: Text -> Text -> GetProfileObjectType
getProfileObjectType_domainName :: Lens' GetProfileObjectType Text
getProfileObjectType_objectTypeName :: Lens' GetProfileObjectType Text
data GetProfileObjectTypeResponse = GetProfileObjectTypeResponse' {
- allowProfileCreation :: Maybe Bool
- createdAt :: Maybe POSIX
- encryptionKey :: Maybe Text
- expirationDays :: Maybe Natural
- fields :: Maybe (HashMap Text ObjectTypeField)
- keys :: Maybe (HashMap Text [ObjectTypeKey])
- lastUpdatedAt :: Maybe POSIX
- sourceLastUpdatedTimestampFormat :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- templateId :: Maybe Text
- httpStatus :: Int
- objectTypeName :: Text
- description :: Text
}
newGetProfileObjectTypeResponse :: Int -> Text -> Text -> GetProfileObjectTypeResponse
getProfileObjectTypeResponse_allowProfileCreation :: Lens' GetProfileObjectTypeResponse (Maybe Bool)
getProfileObjectTypeResponse_createdAt :: Lens' GetProfileObjectTypeResponse (Maybe UTCTime)
getProfileObjectTypeResponse_encryptionKey :: Lens' GetProfileObjectTypeResponse (Maybe Text)
getProfileObjectTypeResponse_expirationDays :: Lens' GetProfileObjectTypeResponse (Maybe Natural)
getProfileObjectTypeResponse_fields :: Lens' GetProfileObjectTypeResponse (Maybe (HashMap Text ObjectTypeField))
getProfileObjectTypeResponse_keys :: Lens' GetProfileObjectTypeResponse (Maybe (HashMap Text [ObjectTypeKey]))
getProfileObjectTypeResponse_lastUpdatedAt :: Lens' GetProfileObjectTypeResponse (Maybe UTCTime)
getProfileObjectTypeResponse_sourceLastUpdatedTimestampFormat :: Lens' GetProfileObjectTypeResponse (Maybe Text)
getProfileObjectTypeResponse_tags :: Lens' GetProfileObjectTypeResponse (Maybe (HashMap Text Text))
getProfileObjectTypeResponse_templateId :: Lens' GetProfileObjectTypeResponse (Maybe Text)
getProfileObjectTypeResponse_httpStatus :: Lens' GetProfileObjectTypeResponse Int
getProfileObjectTypeResponse_objectTypeName :: Lens' GetProfileObjectTypeResponse Text
getProfileObjectTypeResponse_description :: Lens' GetProfileObjectTypeResponse Text

Creating a Request

data GetProfileObjectType Source #

See: newGetProfileObjectType smart constructor.

Constructors

GetProfileObjectType'
Fields domainName :: Text The unique name of the domain. objectTypeName :: Text The name of the profile object type.

Instances

Instances details

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

newGetProfileObjectType Source #

Arguments

:: Text	`GetProfileObjectType`
-> Text	`GetProfileObjectType`
-> GetProfileObjectType

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

GetProfileObjectType, getProfileObjectType_domainName - The unique name of the domain.

GetProfileObjectType, getProfileObjectType_objectTypeName - The name of the profile object type.

Request Lenses

getProfileObjectType_domainName :: Lens' GetProfileObjectType Text Source #

The unique name of the domain.

getProfileObjectType_objectTypeName :: Lens' GetProfileObjectType Text Source #

The name of the profile object type.

Destructuring the Response

data GetProfileObjectTypeResponse Source #

See: newGetProfileObjectTypeResponse smart constructor.

Constructors

GetProfileObjectTypeResponse'

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.
createdAt :: Maybe POSIX
The timestamp of when the domain was created.
encryptionKey :: Maybe Text
The customer-provided key to encrypt the profile object that will be created in this profile object type.
expirationDays :: Maybe Natural
The number of days until the data in the object expires.
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.
lastUpdatedAt :: Maybe POSIX
The timestamp of when the domain was most recently edited.
sourceLastUpdatedTimestampFormat :: Maybe Text
The format of your sourceLastUpdatedTimestamp that was previously set up.
tags :: Maybe (HashMap Text Text)
The tags used to organize, track, or control access for this resource.
templateId :: Maybe Text
A unique identifier for the object template.
httpStatus :: Int
The response's http status code.
objectTypeName :: Text
The name of the profile object type.
description :: Text
The description of the profile object type.

Instances

Instances details

Generic GetProfileObjectTypeResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.GetProfileObjectType Associated Types type Rep GetProfileObjectTypeResponse :: Type -> Type # Methods from :: GetProfileObjectTypeResponse -> Rep GetProfileObjectTypeResponse x # to :: Rep GetProfileObjectTypeResponse x -> GetProfileObjectTypeResponse #
Read GetProfileObjectTypeResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.GetProfileObjectType Methods readsPrec :: Int -> ReadS GetProfileObjectTypeResponse # readList :: ReadS [GetProfileObjectTypeResponse] # readPrec :: ReadPrec GetProfileObjectTypeResponse # readListPrec :: ReadPrec [GetProfileObjectTypeResponse] #
Show GetProfileObjectTypeResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.GetProfileObjectType Methods showsPrec :: Int -> GetProfileObjectTypeResponse -> ShowS # show :: GetProfileObjectTypeResponse -> String # showList :: [GetProfileObjectTypeResponse] -> ShowS #
NFData GetProfileObjectTypeResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.GetProfileObjectType Methods rnf :: GetProfileObjectTypeResponse -> () #
Eq GetProfileObjectTypeResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.GetProfileObjectType Methods (==) :: GetProfileObjectTypeResponse -> GetProfileObjectTypeResponse -> Bool # (/=) :: GetProfileObjectTypeResponse -> GetProfileObjectTypeResponse -> Bool #
type Rep GetProfileObjectTypeResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.GetProfileObjectType type Rep GetProfileObjectTypeResponse = D1 ('MetaData "GetProfileObjectTypeResponse" "Amazonka.CustomerProfiles.GetProfileObjectType" "amazonka-customer-profiles-2.0-7iC4NjyJEW8JuQGNtDiJ1f" 'False) (C1 ('MetaCons "GetProfileObjectTypeResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "allowProfileCreation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "encryptionKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "expirationDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (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 "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "sourceLastUpdatedTimestampFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :: ((S1 ('MetaSel ('Just "templateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :: (S1 ('MetaSel ('Just "objectTypeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newGetProfileObjectTypeResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetProfileObjectTypeResponse'`
-> Text	`GetProfileObjectType`
-> Text	`GetProfileObjectTypeResponse`
-> GetProfileObjectTypeResponse

Create a value of GetProfileObjectTypeResponse 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:GetProfileObjectTypeResponse', getProfileObjectTypeResponse_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.

GetProfileObjectTypeResponse, getProfileObjectTypeResponse_createdAt - The timestamp of when the domain was created.

$sel:encryptionKey:GetProfileObjectTypeResponse', getProfileObjectTypeResponse_encryptionKey - The customer-provided key to encrypt the profile object that will be created in this profile object type.

$sel:expirationDays:GetProfileObjectTypeResponse', getProfileObjectTypeResponse_expirationDays - The number of days until the data in the object expires.

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

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

GetProfileObjectTypeResponse, getProfileObjectTypeResponse_lastUpdatedAt - The timestamp of when the domain was most recently edited.

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

GetProfileObjectTypeResponse, getProfileObjectTypeResponse_tags - The tags used to organize, track, or control access for this resource.

GetProfileObjectTypeResponse, getProfileObjectTypeResponse_templateId - A unique identifier for the object template.

$sel:httpStatus:GetProfileObjectTypeResponse', getProfileObjectTypeResponse_httpStatus - The response's http status code.

GetProfileObjectType, getProfileObjectTypeResponse_objectTypeName - The name of the profile object type.

GetProfileObjectTypeResponse, getProfileObjectTypeResponse_description - The description of the profile object type.

Response Lenses

getProfileObjectTypeResponse_allowProfileCreation :: Lens' GetProfileObjectTypeResponse (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.

getProfileObjectTypeResponse_createdAt :: Lens' GetProfileObjectTypeResponse (Maybe UTCTime) Source #

The timestamp of when the domain was created.

getProfileObjectTypeResponse_encryptionKey :: Lens' GetProfileObjectTypeResponse (Maybe Text) Source #

The customer-provided key to encrypt the profile object that will be created in this profile object type.

getProfileObjectTypeResponse_expirationDays :: Lens' GetProfileObjectTypeResponse (Maybe Natural) Source #

The number of days until the data in the object expires.

getProfileObjectTypeResponse_fields :: Lens' GetProfileObjectTypeResponse (Maybe (HashMap Text ObjectTypeField)) Source #

A map of the name and ObjectType field.

getProfileObjectTypeResponse_keys :: Lens' GetProfileObjectTypeResponse (Maybe (HashMap Text [ObjectTypeKey])) Source #

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

getProfileObjectTypeResponse_lastUpdatedAt :: Lens' GetProfileObjectTypeResponse (Maybe UTCTime) Source #

The timestamp of when the domain was most recently edited.