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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about a specific domain.

Synopsis

data GetDomain = GetDomain' {
- domainName :: Text
}
newGetDomain :: Text -> GetDomain
getDomain_domainName :: Lens' GetDomain Text
data GetDomainResponse = GetDomainResponse' {
- deadLetterQueueUrl :: Maybe Text
- defaultEncryptionKey :: Maybe Text
- defaultExpirationDays :: Maybe Natural
- matching :: Maybe MatchingResponse
- stats :: Maybe DomainStats
- tags :: Maybe (HashMap Text Text)
- httpStatus :: Int
- domainName :: Text
- createdAt :: POSIX
- lastUpdatedAt :: POSIX
}
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

data GetDomain Source #

See: newGetDomain smart constructor.

Constructors

GetDomain'
Fields domainName :: Text The unique name of the domain.

Instances

Instances details

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

newGetDomain Source #

Arguments

:: Text	`GetDomain`
-> GetDomain

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

getDomain_domainName :: Lens' GetDomain Text Source #

The unique name of the domain.

Destructuring the Response

data GetDomainResponse Source #

See: newGetDomainResponse smart constructor.

Constructors

GetDomainResponse'

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.
stats :: Maybe DomainStats
Usage-specific statistics about the domain.
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 GetDomainResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.GetDomain Associated Types type Rep GetDomainResponse :: Type -> Type # Methods from :: GetDomainResponse -> Rep GetDomainResponse x # to :: Rep GetDomainResponse x -> GetDomainResponse #
Read GetDomainResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.GetDomain Methods readsPrec :: Int -> ReadS GetDomainResponse # readList :: ReadS [GetDomainResponse] # readPrec :: ReadPrec GetDomainResponse # readListPrec :: ReadPrec [GetDomainResponse] #
Show GetDomainResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.GetDomain Methods showsPrec :: Int -> GetDomainResponse -> ShowS # show :: GetDomainResponse -> String # showList :: [GetDomainResponse] -> ShowS #
NFData GetDomainResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.GetDomain Methods rnf :: GetDomainResponse -> () #
Eq GetDomainResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.GetDomain Methods (==) :: GetDomainResponse -> GetDomainResponse -> Bool # (/=) :: GetDomainResponse -> GetDomainResponse -> Bool #
type Rep GetDomainResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.GetDomain type Rep GetDomainResponse = D1 ('MetaData "GetDomainResponse" "Amazonka.CustomerProfiles.GetDomain" "amazonka-customer-profiles-2.0-7iC4NjyJEW8JuQGNtDiJ1f" 'False) (C1 ('MetaCons "GetDomainResponse'" '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 "stats") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DomainStats))))) :: ((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))))))

newGetDomainResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetDomainResponse'`
-> Text	`GetDomain`
-> UTCTime	`GetDomainResponse`
-> UTCTime	`GetDomainResponse`
-> 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.