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 |
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' {}
- 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' {}
- 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.
CreateDomain' | |
|
Instances
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.
CreateDomainResponse' | |
|
Instances
newCreateDomainResponse Source #
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.