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 |
Defines a ProfileObjectType.
To add or remove tags on an existing ObjectType, see TagResource/UntagResource.
Synopsis
- data PutProfileObjectType = PutProfileObjectType' {
- allowProfileCreation :: Maybe Bool
- encryptionKey :: Maybe Text
- expirationDays :: Maybe Natural
- fields :: Maybe (HashMap Text ObjectTypeField)
- keys :: Maybe (HashMap Text [ObjectTypeKey])
- sourceLastUpdatedTimestampFormat :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- templateId :: Maybe Text
- domainName :: Text
- objectTypeName :: Text
- description :: Text
- newPutProfileObjectType :: Text -> Text -> Text -> PutProfileObjectType
- putProfileObjectType_allowProfileCreation :: Lens' PutProfileObjectType (Maybe Bool)
- putProfileObjectType_encryptionKey :: Lens' PutProfileObjectType (Maybe Text)
- putProfileObjectType_expirationDays :: Lens' PutProfileObjectType (Maybe Natural)
- putProfileObjectType_fields :: Lens' PutProfileObjectType (Maybe (HashMap Text ObjectTypeField))
- putProfileObjectType_keys :: Lens' PutProfileObjectType (Maybe (HashMap Text [ObjectTypeKey]))
- putProfileObjectType_sourceLastUpdatedTimestampFormat :: Lens' PutProfileObjectType (Maybe Text)
- putProfileObjectType_tags :: Lens' PutProfileObjectType (Maybe (HashMap Text Text))
- putProfileObjectType_templateId :: Lens' PutProfileObjectType (Maybe Text)
- putProfileObjectType_domainName :: Lens' PutProfileObjectType Text
- putProfileObjectType_objectTypeName :: Lens' PutProfileObjectType Text
- putProfileObjectType_description :: Lens' PutProfileObjectType Text
- data PutProfileObjectTypeResponse = PutProfileObjectTypeResponse' {
- 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
- newPutProfileObjectTypeResponse :: Int -> Text -> Text -> PutProfileObjectTypeResponse
- putProfileObjectTypeResponse_allowProfileCreation :: Lens' PutProfileObjectTypeResponse (Maybe Bool)
- putProfileObjectTypeResponse_createdAt :: Lens' PutProfileObjectTypeResponse (Maybe UTCTime)
- putProfileObjectTypeResponse_encryptionKey :: Lens' PutProfileObjectTypeResponse (Maybe Text)
- putProfileObjectTypeResponse_expirationDays :: Lens' PutProfileObjectTypeResponse (Maybe Natural)
- putProfileObjectTypeResponse_fields :: Lens' PutProfileObjectTypeResponse (Maybe (HashMap Text ObjectTypeField))
- putProfileObjectTypeResponse_keys :: Lens' PutProfileObjectTypeResponse (Maybe (HashMap Text [ObjectTypeKey]))
- putProfileObjectTypeResponse_lastUpdatedAt :: Lens' PutProfileObjectTypeResponse (Maybe UTCTime)
- putProfileObjectTypeResponse_sourceLastUpdatedTimestampFormat :: Lens' PutProfileObjectTypeResponse (Maybe Text)
- putProfileObjectTypeResponse_tags :: Lens' PutProfileObjectTypeResponse (Maybe (HashMap Text Text))
- putProfileObjectTypeResponse_templateId :: Lens' PutProfileObjectTypeResponse (Maybe 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.
PutProfileObjectType' | |
|
Instances
newPutProfileObjectType Source #
:: Text | |
-> Text | |
-> Text | |
-> 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:
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.
PutProfileObjectType
, putProfileObjectType_encryptionKey
- The customer-provided key to encrypt the profile object that will be
created in this profile object type.
PutProfileObjectType
, putProfileObjectType_expirationDays
- The number of days until the data in the object expires.
PutProfileObjectType
, putProfileObjectType_fields
- A map of the name and ObjectType field.
PutProfileObjectType
, putProfileObjectType_keys
- A list of unique keys that can be used to map data to the profile.
PutProfileObjectType
, putProfileObjectType_sourceLastUpdatedTimestampFormat
- The format of your sourceLastUpdatedTimestamp
that was previously set
up.
PutProfileObjectType
, putProfileObjectType_tags
- The tags used to organize, track, or control access for this resource.
PutProfileObjectType
, putProfileObjectType_templateId
- A unique identifier for the object template. For some attributes in the
request, the service will use the default value from the object template
when TemplateId is present. If these attributes are present in the
request, the service may return a BadRequestException
. These
attributes include: AllowProfileCreation,
SourceLastUpdatedTimestampFormat, Fields, and Keys. For example, if
AllowProfileCreation is set to true when TemplateId is set, the service
may return a BadRequestException
.
PutProfileObjectType
, putProfileObjectType_domainName
- The unique name of the domain.
PutProfileObjectType
, putProfileObjectType_objectTypeName
- The name of the profile object type.
PutProfileObjectType
, putProfileObjectType_description
- Description of the profile object type.
Request Lenses
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_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_expirationDays :: Lens' PutProfileObjectType (Maybe Natural) Source #
The number of days until the data in the object expires.
putProfileObjectType_fields :: Lens' PutProfileObjectType (Maybe (HashMap Text ObjectTypeField)) Source #
A map of the name and ObjectType field.
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_sourceLastUpdatedTimestampFormat :: Lens' PutProfileObjectType (Maybe Text) Source #
The format of your sourceLastUpdatedTimestamp
that was previously set
up.
putProfileObjectType_tags :: Lens' PutProfileObjectType (Maybe (HashMap Text Text)) Source #
The tags used to organize, track, or control access for this resource.
putProfileObjectType_templateId :: Lens' PutProfileObjectType (Maybe Text) Source #
A unique identifier for the object template. For some attributes in the
request, the service will use the default value from the object template
when TemplateId is present. If these attributes are present in the
request, the service may return a BadRequestException
. These
attributes include: AllowProfileCreation,
SourceLastUpdatedTimestampFormat, Fields, and Keys. For example, if
AllowProfileCreation is set to true when TemplateId is set, the service
may return a BadRequestException
.
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.
PutProfileObjectTypeResponse' | |
|
Instances
newPutProfileObjectTypeResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> 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:
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.
PutProfileObjectTypeResponse
, putProfileObjectTypeResponse_createdAt
- The timestamp of when the domain was created.
PutProfileObjectType
, putProfileObjectTypeResponse_encryptionKey
- The customer-provided key to encrypt the profile object that will be
created in this profile object type.
PutProfileObjectType
, putProfileObjectTypeResponse_expirationDays
- The number of days until the data in the object expires.
PutProfileObjectType
, putProfileObjectTypeResponse_fields
- A map of the name and ObjectType field.
PutProfileObjectType
, putProfileObjectTypeResponse_keys
- A list of unique keys that can be used to map data to the profile.
PutProfileObjectTypeResponse
, putProfileObjectTypeResponse_lastUpdatedAt
- The timestamp of when the domain was most recently edited.
PutProfileObjectType
, putProfileObjectTypeResponse_sourceLastUpdatedTimestampFormat
- The format of your sourceLastUpdatedTimestamp
that was previously set
up in fields that were parsed using
SimpleDateFormat.
If you have sourceLastUpdatedTimestamp
in your field, you must set up
sourceLastUpdatedTimestampFormat
.
PutProfileObjectType
, putProfileObjectTypeResponse_tags
- The tags used to organize, track, or control access for this resource.
PutProfileObjectType
, putProfileObjectTypeResponse_templateId
- A unique identifier for the object template.
$sel:httpStatus:PutProfileObjectTypeResponse'
, putProfileObjectTypeResponse_httpStatus
- The response's http status code.
PutProfileObjectType
, putProfileObjectTypeResponse_objectTypeName
- The name of the profile object type.
PutProfileObjectType
, putProfileObjectTypeResponse_description
- Description of the profile object type.
Response Lenses
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_createdAt :: Lens' PutProfileObjectTypeResponse (Maybe UTCTime) Source #
The timestamp of when the domain was created.
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_expirationDays :: Lens' PutProfileObjectTypeResponse (Maybe Natural) Source #
The number of days until the data in the object expires.
putProfileObjectTypeResponse_fields :: Lens' PutProfileObjectTypeResponse (Maybe (HashMap Text ObjectTypeField)) Source #
A map of the name and ObjectType field.
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_lastUpdatedAt :: Lens' PutProfileObjectTypeResponse (Maybe UTCTime) Source #
The timestamp of when the domain was most recently edited.
putProfileObjectTypeResponse_sourceLastUpdatedTimestampFormat :: Lens' PutProfileObjectTypeResponse (Maybe Text) Source #
The format of your sourceLastUpdatedTimestamp
that was previously set
up in fields that were parsed using
SimpleDateFormat.
If you have sourceLastUpdatedTimestamp
in your field, you must set up
sourceLastUpdatedTimestampFormat
.
putProfileObjectTypeResponse_tags :: Lens' PutProfileObjectTypeResponse (Maybe (HashMap Text Text)) Source #
The tags used to organize, track, or control access for this resource.
putProfileObjectTypeResponse_templateId :: Lens' PutProfileObjectTypeResponse (Maybe Text) Source #
A unique identifier for the object template.
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.