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

Synopsis

data UpdateDomain = UpdateDomain' {
- defaultExpirationDays :: Maybe Natural
- defaultEncryptionKey :: Maybe Text
- matching :: Maybe MatchingRequest
- deadLetterQueueUrl :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- domainName :: Text
}
newUpdateDomain :: Text -> UpdateDomain
updateDomain_defaultExpirationDays :: Lens' UpdateDomain (Maybe Natural)
updateDomain_defaultEncryptionKey :: Lens' UpdateDomain (Maybe Text)
updateDomain_matching :: Lens' UpdateDomain (Maybe MatchingRequest)
updateDomain_deadLetterQueueUrl :: Lens' UpdateDomain (Maybe Text)
updateDomain_tags :: Lens' UpdateDomain (Maybe (HashMap Text Text))
updateDomain_domainName :: Lens' UpdateDomain Text
data UpdateDomainResponse = UpdateDomainResponse' {
- defaultExpirationDays :: Maybe Natural
- defaultEncryptionKey :: Maybe Text
- matching :: Maybe MatchingResponse
- deadLetterQueueUrl :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- httpStatus :: Int
- domainName :: Text
- createdAt :: POSIX
- lastUpdatedAt :: POSIX
}
newUpdateDomainResponse :: Int -> Text -> UTCTime -> UTCTime -> UpdateDomainResponse
updateDomainResponse_defaultExpirationDays :: Lens' UpdateDomainResponse (Maybe Natural)
updateDomainResponse_defaultEncryptionKey :: Lens' UpdateDomainResponse (Maybe Text)
updateDomainResponse_matching :: Lens' UpdateDomainResponse (Maybe MatchingResponse)
updateDomainResponse_deadLetterQueueUrl :: Lens' UpdateDomainResponse (Maybe Text)
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

defaultExpirationDays :: Maybe Natural
The default number of days until the data within the domain expires.
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.
matching :: Maybe MatchingRequest
The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process every Saturday at 12AM UTC to detect duplicate profiles in your domains. After that batch process completes, use the GetMatches API to return and review the results.
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.
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

Eq UpdateDomain Source #
Instance details Defined in Amazonka.CustomerProfiles.UpdateDomain Methods (==) :: UpdateDomain -> UpdateDomain -> Bool # (/=) :: UpdateDomain -> UpdateDomain -> Bool #
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 #
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 #
NFData UpdateDomain Source #
Instance details Defined in Amazonka.CustomerProfiles.UpdateDomain Methods rnf :: UpdateDomain -> () #
Hashable UpdateDomain Source #
Instance details Defined in Amazonka.CustomerProfiles.UpdateDomain Methods hashWithSalt :: Int -> UpdateDomain -> Int # hash :: UpdateDomain -> Int #
ToJSON UpdateDomain Source #
Instance details Defined in Amazonka.CustomerProfiles.UpdateDomain Methods toJSON :: UpdateDomain -> Value # toEncoding :: UpdateDomain -> Encoding # toJSONList :: [UpdateDomain] -> Value # toEncodingList :: [UpdateDomain] -> Encoding #
AWSRequest UpdateDomain Source #
Instance details Defined in Amazonka.CustomerProfiles.UpdateDomain Associated Types type AWSResponse UpdateDomain # Methods request :: UpdateDomain -> Request UpdateDomain # response :: MonadResource m => Logger -> Service -> Proxy UpdateDomain -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateDomain))) #
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 #
type Rep UpdateDomain Source #
Instance details Defined in Amazonka.CustomerProfiles.UpdateDomain type Rep UpdateDomain = D1 ('MetaData "UpdateDomain" "Amazonka.CustomerProfiles.UpdateDomain" "libZSservicesZSamazonka-customer-profilesZSamazonka-customer-profiles" 'False) (C1 ('MetaCons "UpdateDomain'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "defaultExpirationDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "defaultEncryptionKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "matching") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MatchingRequest)))) :: (S1 ('MetaSel ('Just "deadLetterQueueUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse UpdateDomain Source #
Instance details Defined in Amazonka.CustomerProfiles.UpdateDomain type AWSResponse UpdateDomain = UpdateDomainResponse

newUpdateDomain Source #

Arguments

:: Text	`$sel:domainName: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:

$sel:defaultExpirationDays:UpdateDomain', updateDomain_defaultExpirationDays - The default number of days until the data within the domain expires.

$sel:defaultEncryptionKey: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.

$sel:matching:UpdateDomain', updateDomain_matching - The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process every Saturday at 12AM UTC to detect duplicate profiles in your domains. After that batch process completes, use the GetMatches API to return and review the results.

$sel:deadLetterQueueUrl: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.

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

$sel:domainName:UpdateDomain', updateDomain_domainName - The unique name of the domain.

Request Lenses

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

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

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_matching :: Lens' UpdateDomain (Maybe MatchingRequest) Source #

The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process every Saturday at 12AM UTC to detect duplicate profiles in your domains. After that batch process completes, use the GetMatches API to return and review the results.

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

defaultExpirationDays :: Maybe Natural
The default number of days until the data within the domain expires.
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.
matching :: Maybe MatchingResponse
The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process every Saturday at 12AM UTC to detect duplicate profiles in your domains. After that batch process completes, use the GetMatches API to return and review the results.
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.
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

Eq UpdateDomainResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.UpdateDomain Methods (==) :: UpdateDomainResponse -> UpdateDomainResponse -> Bool # (/=) :: UpdateDomainResponse -> UpdateDomainResponse -> Bool #
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 #
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 #
NFData UpdateDomainResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.UpdateDomain Methods rnf :: UpdateDomainResponse -> () #
type Rep UpdateDomainResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.UpdateDomain type Rep UpdateDomainResponse = D1 ('MetaData "UpdateDomainResponse" "Amazonka.CustomerProfiles.UpdateDomain" "libZSservicesZSamazonka-customer-profilesZSamazonka-customer-profiles" 'False) (C1 ('MetaCons "UpdateDomainResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "defaultExpirationDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "defaultEncryptionKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "matching") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MatchingResponse)) :: S1 ('MetaSel ('Just "deadLetterQueueUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((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	`$sel:domainName:UpdateDomain'`
-> UTCTime	`$sel:createdAt:UpdateDomainResponse'`
-> UTCTime	`$sel:lastUpdatedAt: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:

$sel:defaultExpirationDays:UpdateDomain', updateDomainResponse_defaultExpirationDays - The default number of days until the data within the domain expires.

$sel:defaultEncryptionKey: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.

$sel:matching:UpdateDomain', updateDomainResponse_matching - The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process every Saturday at 12AM UTC to detect duplicate profiles in your domains. After that batch process completes, use the GetMatches API to return and review the results.

$sel:deadLetterQueueUrl: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.

$sel:tags: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.

$sel:domainName:UpdateDomain', updateDomainResponse_domainName - The unique name of the domain.

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

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

Response Lenses

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

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

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_matching :: Lens' UpdateDomainResponse (Maybe MatchingResponse) Source #

The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process every Saturday at 12AM UTC to detect duplicate profiles in your domains. After that batch process completes, use the GetMatches API to return and review the results.

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