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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a domain, which is a container for all customer data, such as customer profile attributes, object types, profile keys, and encryption keys. You can create multiple domains, and each domain can have multiple third-party integrations.

Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can be associated with one domain.

Use this API or UpdateDomain 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.

Synopsis

data CreateDomain = CreateDomain' {
- deadLetterQueueUrl :: Maybe Text
- defaultEncryptionKey :: Maybe Text
- matching :: Maybe MatchingRequest
- tags :: Maybe (HashMap Text Text)
- domainName :: Text
- defaultExpirationDays :: Natural
}
newCreateDomain :: Text -> Natural -> CreateDomain
createDomain_deadLetterQueueUrl :: Lens' CreateDomain (Maybe Text)
createDomain_defaultEncryptionKey :: Lens' CreateDomain (Maybe Text)
createDomain_matching :: Lens' CreateDomain (Maybe MatchingRequest)
createDomain_tags :: Lens' CreateDomain (Maybe (HashMap Text Text))
createDomain_domainName :: Lens' CreateDomain Text
createDomain_defaultExpirationDays :: Lens' CreateDomain Natural
data CreateDomainResponse = CreateDomainResponse' {
- deadLetterQueueUrl :: Maybe Text
- defaultEncryptionKey :: Maybe Text
- matching :: Maybe MatchingResponse
- tags :: Maybe (HashMap Text Text)
- httpStatus :: Int
- domainName :: Text
- defaultExpirationDays :: Natural
- createdAt :: POSIX
- lastUpdatedAt :: POSIX
}
newCreateDomainResponse :: Int -> Text -> Natural -> UTCTime -> UTCTime -> CreateDomainResponse
createDomainResponse_deadLetterQueueUrl :: Lens' CreateDomainResponse (Maybe Text)
createDomainResponse_defaultEncryptionKey :: Lens' CreateDomainResponse (Maybe Text)
createDomainResponse_matching :: Lens' CreateDomainResponse (Maybe MatchingResponse)
createDomainResponse_tags :: Lens' CreateDomainResponse (Maybe (HashMap Text Text))
createDomainResponse_httpStatus :: Lens' CreateDomainResponse Int
createDomainResponse_domainName :: Lens' CreateDomainResponse Text
createDomainResponse_defaultExpirationDays :: Lens' CreateDomainResponse Natural
createDomainResponse_createdAt :: Lens' CreateDomainResponse UTCTime
createDomainResponse_lastUpdatedAt :: Lens' CreateDomainResponse UTCTime

Creating a Request

data CreateDomain Source #

See: newCreateDomain smart constructor.

Constructors

CreateDomain'

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. 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.
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.
defaultExpirationDays :: Natural
The default number of days until the data within the domain expires.

Instances

Instances details

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

newCreateDomain Source #

Arguments

:: Text	`CreateDomain`
-> Natural	`CreateDomain`
-> CreateDomain

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

CreateDomain, createDomain_deadLetterQueueUrl - The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. 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.

CreateDomain, createDomain_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.

CreateDomain, createDomain_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.

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

CreateDomain, createDomain_domainName - The unique name of the domain.

CreateDomain, createDomain_defaultExpirationDays - The default number of days until the data within the domain expires.

Request Lenses

createDomain_deadLetterQueueUrl :: Lens' CreateDomain (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. 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.

createDomain_defaultEncryptionKey :: Lens' CreateDomain (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.

createDomain_matching :: Lens' CreateDomain (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.

createDomain_tags :: Lens' CreateDomain (Maybe (HashMap Text Text)) Source #

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

createDomain_domainName :: Lens' CreateDomain Text Source #

The unique name of the domain.

createDomain_defaultExpirationDays :: Lens' CreateDomain Natural Source #

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

Destructuring the Response

data CreateDomainResponse Source #

See: newCreateDomainResponse smart constructor.

Constructors

CreateDomainResponse'

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.
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.
defaultExpirationDays :: Natural
The default number of days until the data within the domain expires.
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 CreateDomainResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.CreateDomain Associated Types type Rep CreateDomainResponse :: Type -> Type # Methods from :: CreateDomainResponse -> Rep CreateDomainResponse x # to :: Rep CreateDomainResponse x -> CreateDomainResponse #
Read CreateDomainResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.CreateDomain Methods readsPrec :: Int -> ReadS CreateDomainResponse # readList :: ReadS [CreateDomainResponse] # readPrec :: ReadPrec CreateDomainResponse # readListPrec :: ReadPrec [CreateDomainResponse] #
Show CreateDomainResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.CreateDomain Methods showsPrec :: Int -> CreateDomainResponse -> ShowS # show :: CreateDomainResponse -> String # showList :: [CreateDomainResponse] -> ShowS #
NFData CreateDomainResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.CreateDomain Methods rnf :: CreateDomainResponse -> () #
Eq CreateDomainResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.CreateDomain Methods (==) :: CreateDomainResponse -> CreateDomainResponse -> Bool # (/=) :: CreateDomainResponse -> CreateDomainResponse -> Bool #
type Rep CreateDomainResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.CreateDomain type Rep CreateDomainResponse = D1 ('MetaData "CreateDomainResponse" "Amazonka.CustomerProfiles.CreateDomain" "amazonka-customer-profiles-2.0-7iC4NjyJEW8JuQGNtDiJ1f" 'False) (C1 ('MetaCons "CreateDomainResponse'" '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 "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 "defaultExpirationDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :: (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :: S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))))))

newCreateDomainResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateDomainResponse'`
-> Text	`CreateDomain`
-> Natural	`CreateDomain`
-> UTCTime	`CreateDomainResponse`
-> UTCTime	`CreateDomainResponse`
-> CreateDomainResponse

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

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

CreateDomain, createDomainResponse_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.

CreateDomain, createDomainResponse_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.

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

$sel:httpStatus:CreateDomainResponse', createDomainResponse_httpStatus - The response's http status code.

CreateDomain, createDomainResponse_domainName - The unique name of the domain.

CreateDomain, createDomainResponse_defaultExpirationDays - The default number of days until the data within the domain expires.

CreateDomainResponse, createDomainResponse_createdAt - The timestamp of when the domain was created.

CreateDomainResponse, createDomainResponse_lastUpdatedAt - The timestamp of when the domain was most recently edited.

Response Lenses

createDomainResponse_deadLetterQueueUrl :: Lens' CreateDomainResponse (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.

createDomainResponse_defaultEncryptionKey :: Lens' CreateDomainResponse (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.

createDomainResponse_matching :: Lens' CreateDomainResponse (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.

createDomainResponse_tags :: Lens' CreateDomainResponse (Maybe (HashMap Text Text)) Source #

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

createDomainResponse_httpStatus :: Lens' CreateDomainResponse Int Source #

The response's http status code.

createDomainResponse_domainName :: Lens' CreateDomainResponse Text Source #

The unique name of the domain.

createDomainResponse_defaultExpirationDays :: Lens' CreateDomainResponse Natural Source #

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

createDomainResponse_createdAt :: Lens' CreateDomainResponse UTCTime Source #

The timestamp of when the domain was created.

createDomainResponse_lastUpdatedAt :: Lens' CreateDomainResponse UTCTime Source #

The timestamp of when the domain was most recently edited.