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 |
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.
GetProfileObjectType' | |
|
Instances
newGetProfileObjectType Source #
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.
GetProfileObjectTypeResponse' | |
|
Instances
newGetProfileObjectTypeResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> 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.
getProfileObjectTypeResponse_sourceLastUpdatedTimestampFormat :: Lens' GetProfileObjectTypeResponse (Maybe Text) Source #
The format of your sourceLastUpdatedTimestamp
that was previously set
up.
getProfileObjectTypeResponse_tags :: Lens' GetProfileObjectTypeResponse (Maybe (HashMap Text Text)) Source #
The tags used to organize, track, or control access for this resource.
getProfileObjectTypeResponse_templateId :: Lens' GetProfileObjectTypeResponse (Maybe Text) Source #
A unique identifier for the object template.
getProfileObjectTypeResponse_httpStatus :: Lens' GetProfileObjectTypeResponse Int Source #
The response's http status code.
getProfileObjectTypeResponse_objectTypeName :: Lens' GetProfileObjectTypeResponse Text Source #
The name of the profile object type.
getProfileObjectTypeResponse_description :: Lens' GetProfileObjectTypeResponse Text Source #
The description of the profile object type.