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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about a specific domain if it exists.

Synopsis

data GetDomain = GetDomain' {
- domainId :: Text
}
newGetDomain :: Text -> GetDomain
getDomain_domainId :: Lens' GetDomain Text
data GetDomainResponse = GetDomainResponse' {
- tags :: Maybe (HashMap Text Text)
- httpStatus :: Int
- createdTime :: ISO8601
- domainArn :: Text
- domainId :: Text
- domainStatus :: DomainStatus
- name :: Text
}
newGetDomainResponse :: Int -> UTCTime -> Text -> Text -> DomainStatus -> Text -> GetDomainResponse
getDomainResponse_tags :: Lens' GetDomainResponse (Maybe (HashMap Text Text))
getDomainResponse_httpStatus :: Lens' GetDomainResponse Int
getDomainResponse_createdTime :: Lens' GetDomainResponse UTCTime
getDomainResponse_domainArn :: Lens' GetDomainResponse Text
getDomainResponse_domainId :: Lens' GetDomainResponse Text
getDomainResponse_domainStatus :: Lens' GetDomainResponse DomainStatus
getDomainResponse_name :: Lens' GetDomainResponse Text

Creating a Request

data GetDomain Source #

See: newGetDomain smart constructor.

Constructors

GetDomain'
Fields domainId :: Text The unique identifier of the Cases domain.

Instances

Instances details

ToJSON GetDomain Source #
Instance details Defined in Amazonka.ConnectCases.GetDomain Methods toJSON :: GetDomain -> Value # toEncoding :: GetDomain -> Encoding # toJSONList :: [GetDomain] -> Value # toEncodingList :: [GetDomain] -> Encoding #
ToHeaders GetDomain Source #
Instance details Defined in Amazonka.ConnectCases.GetDomain Methods toHeaders :: GetDomain -> [Header] #
ToPath GetDomain Source #
Instance details Defined in Amazonka.ConnectCases.GetDomain Methods toPath :: GetDomain -> ByteString #
ToQuery GetDomain Source #
Instance details Defined in Amazonka.ConnectCases.GetDomain Methods toQuery :: GetDomain -> QueryString #
AWSRequest GetDomain Source #
Instance details Defined in Amazonka.ConnectCases.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.ConnectCases.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.ConnectCases.GetDomain Methods readsPrec :: Int -> ReadS GetDomain # readList :: ReadS [GetDomain] # readPrec :: ReadPrec GetDomain # readListPrec :: ReadPrec [GetDomain] #
Show GetDomain Source #
Instance details Defined in Amazonka.ConnectCases.GetDomain Methods showsPrec :: Int -> GetDomain -> ShowS # show :: GetDomain -> String # showList :: [GetDomain] -> ShowS #
NFData GetDomain Source #
Instance details Defined in Amazonka.ConnectCases.GetDomain Methods rnf :: GetDomain -> () #
Eq GetDomain Source #
Instance details Defined in Amazonka.ConnectCases.GetDomain Methods (==) :: GetDomain -> GetDomain -> Bool # (/=) :: GetDomain -> GetDomain -> Bool #
Hashable GetDomain Source #
Instance details Defined in Amazonka.ConnectCases.GetDomain Methods hashWithSalt :: Int -> GetDomain -> Int # hash :: GetDomain -> Int #
type AWSResponse GetDomain Source #
Instance details Defined in Amazonka.ConnectCases.GetDomain type AWSResponse GetDomain = GetDomainResponse
type Rep GetDomain Source #
Instance details Defined in Amazonka.ConnectCases.GetDomain type Rep GetDomain = D1 ('MetaData "GetDomain" "Amazonka.ConnectCases.GetDomain" "amazonka-connectcases-2.0-9RA5jvVYRVL9KmD8hfMfHn" 'False) (C1 ('MetaCons "GetDomain'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domainId") '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_domainId - The unique identifier of the Cases domain.

Request Lenses

getDomain_domainId :: Lens' GetDomain Text Source #

The unique identifier of the Cases domain.

Destructuring the Response

data GetDomainResponse Source #

See: newGetDomainResponse smart constructor.

Constructors

GetDomainResponse'

Fields

tags :: Maybe (HashMap Text Text)
A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
httpStatus :: Int
The response's http status code.
createdTime :: ISO8601
The timestamp when the Cases domain was created.
domainArn :: Text
The Amazon Resource Name (ARN) for the Cases domain.
domainId :: Text
The unique identifier of the Cases domain.
domainStatus :: DomainStatus
The status of the Cases domain.
name :: Text
The name of the Cases domain.

Instances

Instances details

Generic GetDomainResponse Source #
Instance details Defined in Amazonka.ConnectCases.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.ConnectCases.GetDomain Methods readsPrec :: Int -> ReadS GetDomainResponse # readList :: ReadS [GetDomainResponse] # readPrec :: ReadPrec GetDomainResponse # readListPrec :: ReadPrec [GetDomainResponse] #
Show GetDomainResponse Source #
Instance details Defined in Amazonka.ConnectCases.GetDomain Methods showsPrec :: Int -> GetDomainResponse -> ShowS # show :: GetDomainResponse -> String # showList :: [GetDomainResponse] -> ShowS #
NFData GetDomainResponse Source #
Instance details Defined in Amazonka.ConnectCases.GetDomain Methods rnf :: GetDomainResponse -> () #
Eq GetDomainResponse Source #
Instance details Defined in Amazonka.ConnectCases.GetDomain Methods (==) :: GetDomainResponse -> GetDomainResponse -> Bool # (/=) :: GetDomainResponse -> GetDomainResponse -> Bool #
type Rep GetDomainResponse Source #
Instance details Defined in Amazonka.ConnectCases.GetDomain type Rep GetDomainResponse = D1 ('MetaData "GetDomainResponse" "Amazonka.ConnectCases.GetDomain" "amazonka-connectcases-2.0-9RA5jvVYRVL9KmD8hfMfHn" 'False) (C1 ('MetaCons "GetDomainResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "createdTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601))) :: ((S1 ('MetaSel ('Just "domainArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "domainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "domainStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DomainStatus) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newGetDomainResponse Source #

Arguments

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

GetDomainResponse, getDomainResponse_tags - A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

$sel:httpStatus:GetDomainResponse', getDomainResponse_httpStatus - The response's http status code.

$sel:createdTime:GetDomainResponse', getDomainResponse_createdTime - The timestamp when the Cases domain was created.

GetDomainResponse, getDomainResponse_domainArn - The Amazon Resource Name (ARN) for the Cases domain.

GetDomain, getDomainResponse_domainId - The unique identifier of the Cases domain.

$sel:domainStatus:GetDomainResponse', getDomainResponse_domainStatus - The status of the Cases domain.

GetDomainResponse, getDomainResponse_name - The name of the Cases domain.

Response Lenses

getDomainResponse_tags :: Lens' GetDomainResponse (Maybe (HashMap Text Text)) Source #

A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

getDomainResponse_httpStatus :: Lens' GetDomainResponse Int Source #

The response's http status code.

getDomainResponse_createdTime :: Lens' GetDomainResponse UTCTime Source #

The timestamp when the Cases domain was created.

getDomainResponse_domainArn :: Lens' GetDomainResponse Text Source #

The Amazon Resource Name (ARN) for the Cases domain.

getDomainResponse_domainId :: Lens' GetDomainResponse Text Source #

The unique identifier of the Cases domain.

getDomainResponse_domainStatus :: Lens' GetDomainResponse DomainStatus Source #

The status of the Cases domain.

getDomainResponse_name :: Lens' GetDomainResponse Text Source #

The name of the Cases domain.