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.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' {
- defaultExpirationDays :: Maybe Natural
- defaultEncryptionKey :: Maybe Text
- matching :: Maybe MatchingResponse
- stats :: Maybe DomainStats
- deadLetterQueueUrl :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- httpStatus :: Int
- domainName :: Text
- createdAt :: POSIX
- lastUpdatedAt :: POSIX
}
newGetDomainResponse :: Int -> Text -> UTCTime -> UTCTime -> GetDomainResponse
getDomainResponse_defaultExpirationDays :: Lens' GetDomainResponse (Maybe Natural)
getDomainResponse_defaultEncryptionKey :: Lens' GetDomainResponse (Maybe Text)
getDomainResponse_matching :: Lens' GetDomainResponse (Maybe MatchingResponse)
getDomainResponse_stats :: Lens' GetDomainResponse (Maybe DomainStats)
getDomainResponse_deadLetterQueueUrl :: Lens' GetDomainResponse (Maybe Text)
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

Eq GetDomain Source #
Instance details Defined in Amazonka.CustomerProfiles.GetDomain Methods (==) :: GetDomain -> GetDomain -> Bool # (/=) :: GetDomain -> GetDomain -> Bool #
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 #
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 #
NFData GetDomain Source #
Instance details Defined in Amazonka.CustomerProfiles.GetDomain Methods rnf :: GetDomain -> () #
Hashable GetDomain Source #
Instance details Defined in Amazonka.CustomerProfiles.GetDomain Methods hashWithSalt :: Int -> GetDomain -> Int # hash :: GetDomain -> Int #
AWSRequest GetDomain Source #
Instance details Defined in Amazonka.CustomerProfiles.GetDomain Associated Types type AWSResponse GetDomain # Methods request :: GetDomain -> Request GetDomain # response :: MonadResource m => Logger -> Service -> Proxy GetDomain -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetDomain))) #
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 #
type Rep GetDomain Source #
Instance details Defined in Amazonka.CustomerProfiles.GetDomain type Rep GetDomain = D1 ('MetaData "GetDomain" "Amazonka.CustomerProfiles.GetDomain" "libZSservicesZSamazonka-customer-profilesZSamazonka-customer-profiles" 'False) (C1 ('MetaCons "GetDomain'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetDomain Source #
Instance details Defined in Amazonka.CustomerProfiles.GetDomain type AWSResponse GetDomain = GetDomainResponse

newGetDomain Source #

Arguments

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

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

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.
stats :: Maybe DomainStats
Usage-specific statistics about the domain.
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 GetDomainResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.GetDomain Methods (==) :: GetDomainResponse -> GetDomainResponse -> Bool # (/=) :: GetDomainResponse -> GetDomainResponse -> Bool #
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 #
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 #
NFData GetDomainResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.GetDomain Methods rnf :: GetDomainResponse -> () #
type Rep GetDomainResponse Source #
Instance details Defined in Amazonka.CustomerProfiles.GetDomain type Rep GetDomainResponse = D1 ('MetaData "GetDomainResponse" "Amazonka.CustomerProfiles.GetDomain" "libZSservicesZSamazonka-customer-profilesZSamazonka-customer-profiles" 'False) (C1 ('MetaCons "GetDomainResponse'" '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 "stats") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DomainStats)) :: 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))))))

newGetDomainResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetDomainResponse'`
-> Text	`$sel:domainName:GetDomain'`
-> UTCTime	`$sel:createdAt:GetDomainResponse'`
-> UTCTime	`$sel:lastUpdatedAt: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:defaultExpirationDays:GetDomainResponse', getDomainResponse_defaultExpirationDays - The default number of days until the data within the domain expires.

$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:matching:GetDomainResponse', getDomainResponse_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:stats:GetDomainResponse', getDomainResponse_stats - Usage-specific statistics about the domain.

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

$sel:domainName:GetDomain', getDomainResponse_domainName - The unique name of the domain.

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

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

Response Lenses

getDomainResponse_defaultExpirationDays :: Lens' GetDomainResponse (Maybe Natural) Source #

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

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_matching :: Lens' GetDomainResponse (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.

getDomainResponse_stats :: Lens' GetDomainResponse (Maybe DomainStats) Source #

Usage-specific statistics about the domain.

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