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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the properties of a domain, including creating or selecting a dead letter queue or an encryption key.

After a domain is created, the name can’t be changed.

Use this API or CreateDomain to enable identity resolution: set Matching to true.

To prevent cross-service impersonation when you call this API, see Cross-service confused deputy prevention for sample policies that you should apply.

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

Synopsis

data UpdateDomain = UpdateDomain' {
- deadLetterQueueUrl :: Maybe Text
- defaultEncryptionKey :: Maybe Text
- defaultExpirationDays :: Maybe Natural
- matching :: Maybe MatchingRequest
- tags :: Maybe (HashMap Text Text)
- domainName :: Text
}
newUpdateDomain :: Text -> UpdateDomain
updateDomain_deadLetterQueueUrl :: Lens' UpdateDomain (Maybe Text)
updateDomain_defaultEncryptionKey :: Lens' UpdateDomain (Maybe Text)
updateDomain_defaultExpirationDays :: Lens' UpdateDomain (Maybe Natural)
updateDomain_matching :: Lens' UpdateDomain (Maybe MatchingRequest)
updateDomain_tags :: Lens' UpdateDomain (Maybe (HashMap Text Text))
updateDomain_domainName :: Lens' UpdateDomain Text
data UpdateDomainResponse = UpdateDomainResponse' {
- deadLetterQueueUrl :: Maybe Text
- defaultEncryptionKey :: Maybe Text
- defaultExpirationDays :: Maybe Natural
- matching :: Maybe MatchingResponse
- tags :: Maybe (HashMap Text Text)
- httpStatus :: Int
- domainName :: Text
- createdAt :: POSIX
- lastUpdatedAt :: POSIX
}
newUpdateDomainResponse :: Int -> Text -> UTCTime -> UTCTime -> UpdateDomainResponse
updateDomainResponse_deadLetterQueueUrl :: Lens' UpdateDomainResponse (Maybe Text)
updateDomainResponse_defaultEncryptionKey :: Lens' UpdateDomainResponse (Maybe Text)
updateDomainResponse_defaultExpirationDays :: Lens' UpdateDomainResponse (Maybe Natural)
updateDomainResponse_matching :: Lens' UpdateDomainResponse (Maybe MatchingResponse)
updateDomainResponse_tags :: Lens' UpdateDomainResponse (Maybe (HashMap Text Text))
updateDomainResponse_httpStatus :: Lens' UpdateDomainResponse Int
updateDomainResponse_domainName :: Lens' UpdateDomainResponse Text
updateDomainResponse_createdAt :: Lens' UpdateDomainResponse UTCTime
updateDomainResponse_lastUpdatedAt :: Lens' UpdateDomainResponse UTCTime

Creating a Request

data UpdateDomain Source #

See: newUpdateDomain smart constructor.

Constructors

UpdateDomain'

Fields

deadLetterQueueUrl :: Maybe Text
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. If specified as an empty string, it will clear any existing value. You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue.
defaultEncryptionKey :: Maybe Text
The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage. If specified as an empty string, it will clear any existing value.
defaultExpirationDays :: Maybe Natural
The default number of days until the data within the domain expires.
matching :: Maybe MatchingRequest
The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.
After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.
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.

Instances

Instances details

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

newUpdateDomain Source #

Arguments

:: Text	`UpdateDomain`
-> UpdateDomain

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

UpdateDomain, updateDomain_deadLetterQueueUrl - The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. If specified as an empty string, it will clear any existing value. You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue.

UpdateDomain, updateDomain_defaultEncryptionKey - The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage. If specified as an empty string, it will clear any existing value.

UpdateDomain, updateDomain_defaultExpirationDays - The default number of days until the data within the domain expires.

UpdateDomain, updateDomain_matching - The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.

After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.

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

UpdateDomain, updateDomain_domainName - The unique name of the domain.

Request Lenses

updateDomain_deadLetterQueueUrl :: Lens' UpdateDomain (Maybe Text) Source #

The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. If specified as an empty string, it will clear any existing value. You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue.

updateDomain_defaultEncryptionKey :: Lens' UpdateDomain (Maybe Text) Source #

The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage. If specified as an empty string, it will clear any existing value.

updateDomain_defaultExpirationDays :: Lens' UpdateDomain (Maybe Natural) Source #

The default number of days until the data within the domain expires.

updateDomain_matching :: Lens' UpdateDomain (Maybe MatchingRequest) Source #

The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.

After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.

updateDomain_tags :: Lens' UpdateDomain (Maybe (HashMap Text Text)) Source #

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

updateDomain_domainName :: Lens' UpdateDomain Text Source #

The unique name of the domain.

Destructuring the Response

data UpdateDomainResponse Source #

See: newUpdateDomainResponse smart constructor.

Constructors

UpdateDomainResponse'

Fields

deadLetterQueueUrl :: Maybe Text
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
defaultEncryptionKey :: Maybe Text
The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.
defaultExpirationDays :: Maybe Natural
The default number of days until the data within the domain expires.
matching :: Maybe MatchingResponse
The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.
After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.
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.
domainName :: Text
The unique name of the domain.
createdAt :: POSIX
The timestamp of when the domain was created.
lastUpdatedAt :: POSIX
The timestamp of when the domain was most recently edited.

Instances

Instances details

Generic UpdateDomainResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.UpdateDomain Associated Types type Rep UpdateDomainResponse :: Type -> Type # Methods from :: UpdateDomainResponse -> Rep UpdateDomainResponse x # to :: Rep UpdateDomainResponse x -> UpdateDomainResponse #
Read UpdateDomainResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.UpdateDomain Methods readsPrec :: Int -> ReadS UpdateDomainResponse # readList :: ReadS [UpdateDomainResponse] # readPrec :: ReadPrec UpdateDomainResponse # readListPrec :: ReadPrec [UpdateDomainResponse] #
Show UpdateDomainResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.UpdateDomain Methods showsPrec :: Int -> UpdateDomainResponse -> ShowS # show :: UpdateDomainResponse -> String # showList :: [UpdateDomainResponse] -> ShowS #
NFData UpdateDomainResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.UpdateDomain Methods rnf :: UpdateDomainResponse -> () #
Eq UpdateDomainResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.UpdateDomain Methods (==) :: UpdateDomainResponse -> UpdateDomainResponse -> Bool # (/=) :: UpdateDomainResponse -> UpdateDomainResponse -> Bool #
type Rep UpdateDomainResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.UpdateDomain type Rep UpdateDomainResponse = D1 ('MetaData "UpdateDomainResponse" "Amazonka.CustomerProfiles.UpdateDomain" "amazonka-customer-profiles-2.0-7iC4NjyJEW8JuQGNtDiJ1f" 'False) (C1 ('MetaCons "UpdateDomainResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "deadLetterQueueUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "defaultEncryptionKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "defaultExpirationDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "matching") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MatchingResponse)))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :: (S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :: S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))))))

newUpdateDomainResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateDomainResponse'`
-> Text	`UpdateDomain`
-> UTCTime	`UpdateDomainResponse`
-> UTCTime	`UpdateDomainResponse`
-> UpdateDomainResponse

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

UpdateDomain, updateDomainResponse_deadLetterQueueUrl - The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.

UpdateDomain, updateDomainResponse_defaultEncryptionKey - The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.

UpdateDomain, updateDomainResponse_defaultExpirationDays - The default number of days until the data within the domain expires.

UpdateDomain, updateDomainResponse_matching - The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.

After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.

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

$sel:httpStatus:UpdateDomainResponse', updateDomainResponse_httpStatus - The response's http status code.

UpdateDomain, updateDomainResponse_domainName - The unique name of the domain.

UpdateDomainResponse, updateDomainResponse_createdAt - The timestamp of when the domain was created.

UpdateDomainResponse, updateDomainResponse_lastUpdatedAt - The timestamp of when the domain was most recently edited.

Response Lenses

updateDomainResponse_deadLetterQueueUrl :: Lens' UpdateDomainResponse (Maybe Text) Source #

The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.

updateDomainResponse_defaultEncryptionKey :: Lens' UpdateDomainResponse (Maybe Text) Source #

The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.

updateDomainResponse_defaultExpirationDays :: Lens' UpdateDomainResponse (Maybe Natural) Source #

The default number of days until the data within the domain expires.

updateDomainResponse_matching :: Lens' UpdateDomainResponse (Maybe MatchingResponse) Source #

The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.

After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.

updateDomainResponse_tags :: Lens' UpdateDomainResponse (Maybe (HashMap Text Text)) Source #

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

updateDomainResponse_httpStatus :: Lens' UpdateDomainResponse Int Source #

The response's http status code.

updateDomainResponse_domainName :: Lens' UpdateDomainResponse Text Source #

The unique name of the domain.

updateDomainResponse_createdAt :: Lens' UpdateDomainResponse UTCTime Source #

The timestamp of when the domain was created.

updateDomainResponse_lastUpdatedAt :: Lens' UpdateDomainResponse UTCTime Source #

The timestamp of when the domain was most recently edited.