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 |
Returns information about a specific domain.
Synopsis
- data GetDomain = GetDomain' {
- domainName :: Text
- newGetDomain :: Text -> GetDomain
- getDomain_domainName :: Lens' GetDomain Text
- data GetDomainResponse = GetDomainResponse' {}
- newGetDomainResponse :: Int -> Text -> UTCTime -> UTCTime -> GetDomainResponse
- getDomainResponse_deadLetterQueueUrl :: Lens' GetDomainResponse (Maybe Text)
- getDomainResponse_defaultEncryptionKey :: Lens' GetDomainResponse (Maybe Text)
- getDomainResponse_defaultExpirationDays :: Lens' GetDomainResponse (Maybe Natural)
- getDomainResponse_matching :: Lens' GetDomainResponse (Maybe MatchingResponse)
- getDomainResponse_stats :: Lens' GetDomainResponse (Maybe DomainStats)
- getDomainResponse_tags :: Lens' GetDomainResponse (Maybe (HashMap Text Text))
- getDomainResponse_httpStatus :: Lens' GetDomainResponse Int
- getDomainResponse_domainName :: Lens' GetDomainResponse Text
- getDomainResponse_createdAt :: Lens' GetDomainResponse UTCTime
- getDomainResponse_lastUpdatedAt :: Lens' GetDomainResponse UTCTime
Creating a Request
See: newGetDomain
smart constructor.
GetDomain' | |
|
Instances
Create a value of GetDomain
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:
GetDomain
, getDomain_domainName
- The unique name of the domain.
Request Lenses
Destructuring the Response
data GetDomainResponse Source #
See: newGetDomainResponse
smart constructor.
GetDomainResponse' | |
|
Instances
:: Int | |
-> Text | |
-> UTCTime | |
-> UTCTime | |
-> GetDomainResponse |
Create a value of GetDomainResponse
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:deadLetterQueueUrl:GetDomainResponse'
, getDomainResponse_deadLetterQueueUrl
- The URL of the SQS dead letter queue, which is used for reporting errors
associated with ingesting data from third party applications.
$sel:defaultEncryptionKey:GetDomainResponse'
, getDomainResponse_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:defaultExpirationDays:GetDomainResponse'
, getDomainResponse_defaultExpirationDays
- The default number of days until the data within the domain expires.
$sel:matching:GetDomainResponse'
, getDomainResponse_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.
$sel:stats:GetDomainResponse'
, getDomainResponse_stats
- Usage-specific statistics about the domain.
GetDomainResponse
, getDomainResponse_tags
- The tags used to organize, track, or control access for this resource.
$sel:httpStatus:GetDomainResponse'
, getDomainResponse_httpStatus
- The response's http status code.
GetDomain
, getDomainResponse_domainName
- The unique name of the domain.
GetDomainResponse
, getDomainResponse_createdAt
- The timestamp of when the domain was created.
GetDomainResponse
, getDomainResponse_lastUpdatedAt
- The timestamp of when the domain was most recently edited.
Response Lenses
getDomainResponse_deadLetterQueueUrl :: Lens' GetDomainResponse (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.
getDomainResponse_defaultEncryptionKey :: Lens' GetDomainResponse (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.
getDomainResponse_defaultExpirationDays :: Lens' GetDomainResponse (Maybe Natural) Source #
The default number of days until the data within the domain expires.
getDomainResponse_matching :: Lens' GetDomainResponse (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.
getDomainResponse_stats :: Lens' GetDomainResponse (Maybe DomainStats) Source #
Usage-specific statistics about the domain.
getDomainResponse_tags :: Lens' GetDomainResponse (Maybe (HashMap Text Text)) Source #
The tags used to organize, track, or control access for this resource.
getDomainResponse_httpStatus :: Lens' GetDomainResponse Int Source #
The response's http status code.
getDomainResponse_domainName :: Lens' GetDomainResponse Text Source #
The unique name of the domain.
getDomainResponse_createdAt :: Lens' GetDomainResponse UTCTime Source #
The timestamp of when the domain was created.
getDomainResponse_lastUpdatedAt :: Lens' GetDomainResponse UTCTime Source #
The timestamp of when the domain was most recently edited.