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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Defines a ProfileObjectType.

Synopsis

data PutProfileObjectType = PutProfileObjectType' {
- expirationDays :: Maybe Natural
- templateId :: Maybe Text
- keys :: Maybe (HashMap Text [ObjectTypeKey])
- encryptionKey :: Maybe Text
- allowProfileCreation :: Maybe Bool
- fields :: Maybe (HashMap Text ObjectTypeField)
- tags :: Maybe (HashMap Text Text)
- domainName :: Text
- objectTypeName :: Text
- description :: Text
}
newPutProfileObjectType :: Text -> Text -> Text -> PutProfileObjectType
putProfileObjectType_expirationDays :: Lens' PutProfileObjectType (Maybe Natural)
putProfileObjectType_templateId :: Lens' PutProfileObjectType (Maybe Text)
putProfileObjectType_keys :: Lens' PutProfileObjectType (Maybe (HashMap Text [ObjectTypeKey]))
putProfileObjectType_encryptionKey :: Lens' PutProfileObjectType (Maybe Text)
putProfileObjectType_allowProfileCreation :: Lens' PutProfileObjectType (Maybe Bool)
putProfileObjectType_fields :: Lens' PutProfileObjectType (Maybe (HashMap Text ObjectTypeField))
putProfileObjectType_tags :: Lens' PutProfileObjectType (Maybe (HashMap Text Text))
putProfileObjectType_domainName :: Lens' PutProfileObjectType Text
putProfileObjectType_objectTypeName :: Lens' PutProfileObjectType Text
putProfileObjectType_description :: Lens' PutProfileObjectType Text
data PutProfileObjectTypeResponse = PutProfileObjectTypeResponse' {
- expirationDays :: Maybe Natural
- lastUpdatedAt :: Maybe POSIX
- createdAt :: Maybe POSIX
- templateId :: Maybe Text
- keys :: Maybe (HashMap Text [ObjectTypeKey])
- encryptionKey :: Maybe Text
- allowProfileCreation :: Maybe Bool
- fields :: Maybe (HashMap Text ObjectTypeField)
- tags :: Maybe (HashMap Text Text)
- httpStatus :: Int
- objectTypeName :: Text
- description :: Text
}
newPutProfileObjectTypeResponse :: Int -> Text -> Text -> PutProfileObjectTypeResponse
putProfileObjectTypeResponse_expirationDays :: Lens' PutProfileObjectTypeResponse (Maybe Natural)
putProfileObjectTypeResponse_lastUpdatedAt :: Lens' PutProfileObjectTypeResponse (Maybe UTCTime)
putProfileObjectTypeResponse_createdAt :: Lens' PutProfileObjectTypeResponse (Maybe UTCTime)
putProfileObjectTypeResponse_templateId :: Lens' PutProfileObjectTypeResponse (Maybe Text)
putProfileObjectTypeResponse_keys :: Lens' PutProfileObjectTypeResponse (Maybe (HashMap Text [ObjectTypeKey]))
putProfileObjectTypeResponse_encryptionKey :: Lens' PutProfileObjectTypeResponse (Maybe Text)
putProfileObjectTypeResponse_allowProfileCreation :: Lens' PutProfileObjectTypeResponse (Maybe Bool)
putProfileObjectTypeResponse_fields :: Lens' PutProfileObjectTypeResponse (Maybe (HashMap Text ObjectTypeField))
putProfileObjectTypeResponse_tags :: Lens' PutProfileObjectTypeResponse (Maybe (HashMap Text Text))
putProfileObjectTypeResponse_httpStatus :: Lens' PutProfileObjectTypeResponse Int
putProfileObjectTypeResponse_objectTypeName :: Lens' PutProfileObjectTypeResponse Text
putProfileObjectTypeResponse_description :: Lens' PutProfileObjectTypeResponse Text

Creating a Request

data PutProfileObjectType Source #

See: newPutProfileObjectType smart constructor.

Constructors

PutProfileObjectType'

Fields

expirationDays :: Maybe Natural
The number of days until the data in the object expires.
templateId :: Maybe Text
A unique identifier for the object template.
keys :: Maybe (HashMap Text [ObjectTypeKey])
A list of unique keys that can be used to map data to the profile.
encryptionKey :: Maybe Text
The customer-provided key to encrypt the profile object that will be created in this profile object type.
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.
tags :: Maybe (HashMap Text Text)
The tags used to organize, track, or control access for this resource.
domainName :: Text
The unique name of the domain.
objectTypeName :: Text
The name of the profile object type.
description :: Text
Description of the profile object type.

Instances

Instances details

Eq PutProfileObjectType Source #
Instance details Defined in Amazonka.CustomerProfiles.PutProfileObjectType Methods (==) :: PutProfileObjectType -> PutProfileObjectType -> Bool # (/=) :: PutProfileObjectType -> PutProfileObjectType -> Bool #
Read PutProfileObjectType Source #
Instance details Defined in Amazonka.CustomerProfiles.PutProfileObjectType Methods readsPrec :: Int -> ReadS PutProfileObjectType # readList :: ReadS [PutProfileObjectType] # readPrec :: ReadPrec PutProfileObjectType # readListPrec :: ReadPrec [PutProfileObjectType] #
Show PutProfileObjectType Source #
Instance details Defined in Amazonka.CustomerProfiles.PutProfileObjectType Methods showsPrec :: Int -> PutProfileObjectType -> ShowS # show :: PutProfileObjectType -> String # showList :: [PutProfileObjectType] -> ShowS #
Generic PutProfileObjectType Source #
Instance details Defined in Amazonka.CustomerProfiles.PutProfileObjectType Associated Types type Rep PutProfileObjectType :: Type -> Type # Methods from :: PutProfileObjectType -> Rep PutProfileObjectType x # to :: Rep PutProfileObjectType x -> PutProfileObjectType #
NFData PutProfileObjectType Source #
Instance details Defined in Amazonka.CustomerProfiles.PutProfileObjectType Methods rnf :: PutProfileObjectType -> () #
Hashable PutProfileObjectType Source #
Instance details Defined in Amazonka.CustomerProfiles.PutProfileObjectType Methods hashWithSalt :: Int -> PutProfileObjectType -> Int # hash :: PutProfileObjectType -> Int #
ToJSON PutProfileObjectType Source #
Instance details Defined in Amazonka.CustomerProfiles.PutProfileObjectType Methods toJSON :: PutProfileObjectType -> Value # toEncoding :: PutProfileObjectType -> Encoding # toJSONList :: [PutProfileObjectType] -> Value # toEncodingList :: [PutProfileObjectType] -> Encoding #
AWSRequest PutProfileObjectType Source #
Instance details Defined in Amazonka.CustomerProfiles.PutProfileObjectType Associated Types type AWSResponse PutProfileObjectType # Methods request :: PutProfileObjectType -> Request PutProfileObjectType # response :: MonadResource m => Logger -> Service -> Proxy PutProfileObjectType -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutProfileObjectType))) #
ToHeaders PutProfileObjectType Source #
Instance details Defined in Amazonka.CustomerProfiles.PutProfileObjectType Methods toHeaders :: PutProfileObjectType -> [Header] #
ToPath PutProfileObjectType Source #
Instance details Defined in Amazonka.CustomerProfiles.PutProfileObjectType Methods toPath :: PutProfileObjectType -> ByteString #
ToQuery PutProfileObjectType Source #
Instance details Defined in Amazonka.CustomerProfiles.PutProfileObjectType Methods toQuery :: PutProfileObjectType -> QueryString #
type Rep PutProfileObjectType Source #
Instance details Defined in Amazonka.CustomerProfiles.PutProfileObjectType type Rep PutProfileObjectType = D1 ('MetaData "PutProfileObjectType" "Amazonka.CustomerProfiles.PutProfileObjectType" "libZSservicesZSamazonka-customer-profilesZSamazonka-customer-profiles" 'False) (C1 ('MetaCons "PutProfileObjectType'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "expirationDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "templateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "keys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [ObjectTypeKey]))) :: (S1 ('MetaSel ('Just "encryptionKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: 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 "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "objectTypeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse PutProfileObjectType Source #
Instance details Defined in Amazonka.CustomerProfiles.PutProfileObjectType type AWSResponse PutProfileObjectType = PutProfileObjectTypeResponse

newPutProfileObjectType Source #

Arguments

:: Text	`$sel:domainName:PutProfileObjectType'`
-> Text	`$sel:objectTypeName:PutProfileObjectType'`
-> Text	`$sel:description:PutProfileObjectType'`
-> PutProfileObjectType

Create a value of PutProfileObjectType 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:expirationDays:PutProfileObjectType', putProfileObjectType_expirationDays - The number of days until the data in the object expires.

$sel:templateId:PutProfileObjectType', putProfileObjectType_templateId - A unique identifier for the object template.

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

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

$sel:allowProfileCreation:PutProfileObjectType', putProfileObjectType_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:PutProfileObjectType', putProfileObjectType_fields - A map of the name and ObjectType field.

$sel:tags:PutProfileObjectType', putProfileObjectType_tags - The tags used to organize, track, or control access for this resource.

$sel:domainName:PutProfileObjectType', putProfileObjectType_domainName - The unique name of the domain.

$sel:objectTypeName:PutProfileObjectType', putProfileObjectType_objectTypeName - The name of the profile object type.

$sel:description:PutProfileObjectType', putProfileObjectType_description - Description of the profile object type.

Request Lenses

putProfileObjectType_expirationDays :: Lens' PutProfileObjectType (Maybe Natural) Source #

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

putProfileObjectType_templateId :: Lens' PutProfileObjectType (Maybe Text) Source #

A unique identifier for the object template.

putProfileObjectType_keys :: Lens' PutProfileObjectType (Maybe (HashMap Text [ObjectTypeKey])) Source #

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

putProfileObjectType_encryptionKey :: Lens' PutProfileObjectType (Maybe Text) Source #

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

putProfileObjectType_allowProfileCreation :: Lens' PutProfileObjectType (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.

putProfileObjectType_fields :: Lens' PutProfileObjectType (Maybe (HashMap Text ObjectTypeField)) Source #

A map of the name and ObjectType field.

putProfileObjectType_tags :: Lens' PutProfileObjectType (Maybe (HashMap Text Text)) Source #

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

putProfileObjectType_domainName :: Lens' PutProfileObjectType Text Source #

The unique name of the domain.

putProfileObjectType_objectTypeName :: Lens' PutProfileObjectType Text Source #

The name of the profile object type.

putProfileObjectType_description :: Lens' PutProfileObjectType Text Source #

Description of the profile object type.

Destructuring the Response

data PutProfileObjectTypeResponse Source #

See: newPutProfileObjectTypeResponse smart constructor.

Constructors

PutProfileObjectTypeResponse'

Fields

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

Instances

Instances details

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

newPutProfileObjectTypeResponse Source #

Arguments

:: Int	`$sel:httpStatus:PutProfileObjectTypeResponse'`
-> Text	`$sel:objectTypeName:PutProfileObjectType'`
-> Text	`$sel:description:PutProfileObjectType'`
-> PutProfileObjectTypeResponse

Create a value of PutProfileObjectTypeResponse 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:expirationDays:PutProfileObjectType', putProfileObjectTypeResponse_expirationDays - The number of days until the data in the object expires.

$sel:lastUpdatedAt:PutProfileObjectTypeResponse', putProfileObjectTypeResponse_lastUpdatedAt - The timestamp of when the domain was most recently edited.

$sel:createdAt:PutProfileObjectTypeResponse', putProfileObjectTypeResponse_createdAt - The timestamp of when the domain was created.

$sel:templateId:PutProfileObjectType', putProfileObjectTypeResponse_templateId - A unique identifier for the object template.

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

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

$sel:allowProfileCreation:PutProfileObjectType', putProfileObjectTypeResponse_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:PutProfileObjectType', putProfileObjectTypeResponse_fields - A map of the name and ObjectType field.

$sel:tags:PutProfileObjectType', putProfileObjectTypeResponse_tags - The tags used to organize, track, or control access for this resource.

$sel:httpStatus:PutProfileObjectTypeResponse', putProfileObjectTypeResponse_httpStatus - The response's http status code.

$sel:objectTypeName:PutProfileObjectType', putProfileObjectTypeResponse_objectTypeName - The name of the profile object type.

$sel:description:PutProfileObjectType', putProfileObjectTypeResponse_description - Description of the profile object type.

Response Lenses

putProfileObjectTypeResponse_expirationDays :: Lens' PutProfileObjectTypeResponse (Maybe Natural) Source #

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

putProfileObjectTypeResponse_lastUpdatedAt :: Lens' PutProfileObjectTypeResponse (Maybe UTCTime) Source #

The timestamp of when the domain was most recently edited.

putProfileObjectTypeResponse_createdAt :: Lens' PutProfileObjectTypeResponse (Maybe UTCTime) Source #

The timestamp of when the domain was created.

putProfileObjectTypeResponse_templateId :: Lens' PutProfileObjectTypeResponse (Maybe Text) Source #

A unique identifier for the object template.

putProfileObjectTypeResponse_keys :: Lens' PutProfileObjectTypeResponse (Maybe (HashMap Text [ObjectTypeKey])) Source #

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

putProfileObjectTypeResponse_encryptionKey :: Lens' PutProfileObjectTypeResponse (Maybe Text) Source #

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

putProfileObjectTypeResponse_allowProfileCreation :: Lens' PutProfileObjectTypeResponse (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.

putProfileObjectTypeResponse_fields :: Lens' PutProfileObjectTypeResponse (Maybe (HashMap Text ObjectTypeField)) Source #

A map of the name and ObjectType field.

putProfileObjectTypeResponse_tags :: Lens' PutProfileObjectTypeResponse (Maybe (HashMap Text Text)) Source #

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

putProfileObjectTypeResponse_httpStatus :: Lens' PutProfileObjectTypeResponse Int Source #

The response's http status code.

putProfileObjectTypeResponse_objectTypeName :: Lens' PutProfileObjectTypeResponse Text Source #

The name of the profile object type.

putProfileObjectTypeResponse_description :: Lens' PutProfileObjectTypeResponse Text Source #

Description of the profile object type.