amazonka-customer-profiles-2.0: Amazon Connect Customer Profiles SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CustomerProfiles.PutProfileObjectType

Description

Defines a ProfileObjectType.

To add or remove tags on an existing ObjectType, see TagResource/UntagResource.

Synopsis

Creating a Request

data PutProfileObjectType Source #

See: newPutProfileObjectType smart constructor.

Constructors

PutProfileObjectType' 

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.

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

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

  • 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
ToJSON PutProfileObjectType Source # 
Instance details

Defined in Amazonka.CustomerProfiles.PutProfileObjectType

ToHeaders PutProfileObjectType Source # 
Instance details

Defined in Amazonka.CustomerProfiles.PutProfileObjectType

ToPath PutProfileObjectType Source # 
Instance details

Defined in Amazonka.CustomerProfiles.PutProfileObjectType

ToQuery PutProfileObjectType Source # 
Instance details

Defined in Amazonka.CustomerProfiles.PutProfileObjectType

AWSRequest PutProfileObjectType Source # 
Instance details

Defined in Amazonka.CustomerProfiles.PutProfileObjectType

Associated Types

type AWSResponse PutProfileObjectType #

Generic PutProfileObjectType Source # 
Instance details

Defined in Amazonka.CustomerProfiles.PutProfileObjectType

Associated Types

type Rep PutProfileObjectType :: Type -> Type #

Read PutProfileObjectType Source # 
Instance details

Defined in Amazonka.CustomerProfiles.PutProfileObjectType

Show PutProfileObjectType Source # 
Instance details

Defined in Amazonka.CustomerProfiles.PutProfileObjectType

NFData PutProfileObjectType Source # 
Instance details

Defined in Amazonka.CustomerProfiles.PutProfileObjectType

Methods

rnf :: PutProfileObjectType -> () #

Eq PutProfileObjectType Source # 
Instance details

Defined in Amazonka.CustomerProfiles.PutProfileObjectType

Hashable PutProfileObjectType Source # 
Instance details

Defined in Amazonka.CustomerProfiles.PutProfileObjectType

type AWSResponse PutProfileObjectType Source # 
Instance details

Defined in Amazonka.CustomerProfiles.PutProfileObjectType

type Rep PutProfileObjectType Source # 
Instance details

Defined in Amazonka.CustomerProfiles.PutProfileObjectType

type Rep PutProfileObjectType = D1 ('MetaData "PutProfileObjectType" "Amazonka.CustomerProfiles.PutProfileObjectType" "amazonka-customer-profiles-2.0-7iC4NjyJEW8JuQGNtDiJ1f" 'False) (C1 ('MetaCons "PutProfileObjectType'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "allowProfileCreation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: 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 "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 "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "objectTypeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newPutProfileObjectType Source #

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_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_description :: Lens' PutProfileObjectType Text Source #

Description of the profile object type.

Destructuring the Response

data PutProfileObjectTypeResponse Source #

See: newPutProfileObjectTypeResponse smart constructor.

Constructors

PutProfileObjectTypeResponse' 

Fields

Instances

Instances details
Generic PutProfileObjectTypeResponse Source # 
Instance details

Defined in Amazonka.CustomerProfiles.PutProfileObjectType

Associated Types

type Rep PutProfileObjectTypeResponse :: Type -> Type #

Read PutProfileObjectTypeResponse Source # 
Instance details

Defined in Amazonka.CustomerProfiles.PutProfileObjectType

Show PutProfileObjectTypeResponse Source # 
Instance details

Defined in Amazonka.CustomerProfiles.PutProfileObjectType

NFData PutProfileObjectTypeResponse Source # 
Instance details

Defined in Amazonka.CustomerProfiles.PutProfileObjectType

Eq PutProfileObjectTypeResponse Source # 
Instance details

Defined in Amazonka.CustomerProfiles.PutProfileObjectType

type Rep PutProfileObjectTypeResponse Source # 
Instance details

Defined in Amazonka.CustomerProfiles.PutProfileObjectType

type Rep PutProfileObjectTypeResponse = D1 ('MetaData "PutProfileObjectTypeResponse" "Amazonka.CustomerProfiles.PutProfileObjectType" "amazonka-customer-profiles-2.0-7iC4NjyJEW8JuQGNtDiJ1f" 'False) (C1 ('MetaCons "PutProfileObjectTypeResponse'" '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))))))

newPutProfileObjectTypeResponse Source #

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