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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the details for the requested template.

Synopsis

data GetTemplate = GetTemplate' {
- domainId :: Text
- templateId :: Text
}
newGetTemplate :: Text -> Text -> GetTemplate
getTemplate_domainId :: Lens' GetTemplate Text
getTemplate_templateId :: Lens' GetTemplate Text
data GetTemplateResponse = GetTemplateResponse' {
- description :: Maybe Text
- layoutConfiguration :: Maybe LayoutConfiguration
- requiredFields :: Maybe [RequiredField]
- tags :: Maybe (HashMap Text Text)
- httpStatus :: Int
- name :: Text
- status :: TemplateStatus
- templateArn :: Text
- templateId :: Text
}
newGetTemplateResponse :: Int -> Text -> TemplateStatus -> Text -> Text -> GetTemplateResponse
getTemplateResponse_description :: Lens' GetTemplateResponse (Maybe Text)
getTemplateResponse_layoutConfiguration :: Lens' GetTemplateResponse (Maybe LayoutConfiguration)
getTemplateResponse_requiredFields :: Lens' GetTemplateResponse (Maybe [RequiredField])
getTemplateResponse_tags :: Lens' GetTemplateResponse (Maybe (HashMap Text Text))
getTemplateResponse_httpStatus :: Lens' GetTemplateResponse Int
getTemplateResponse_name :: Lens' GetTemplateResponse Text
getTemplateResponse_status :: Lens' GetTemplateResponse TemplateStatus
getTemplateResponse_templateArn :: Lens' GetTemplateResponse Text
getTemplateResponse_templateId :: Lens' GetTemplateResponse Text

Creating a Request

data GetTemplate Source #

See: newGetTemplate smart constructor.

Constructors

GetTemplate'
Fields domainId :: Text The unique identifier of the Cases domain. templateId :: Text A unique identifier of a template.

Instances

Instances details

ToJSON GetTemplate Source #
Instance details Defined in Amazonka.ConnectCases.GetTemplate Methods toJSON :: GetTemplate -> Value # toEncoding :: GetTemplate -> Encoding # toJSONList :: [GetTemplate] -> Value # toEncodingList :: [GetTemplate] -> Encoding #
ToHeaders GetTemplate Source #
Instance details Defined in Amazonka.ConnectCases.GetTemplate Methods toHeaders :: GetTemplate -> [Header] #
ToPath GetTemplate Source #
Instance details Defined in Amazonka.ConnectCases.GetTemplate Methods toPath :: GetTemplate -> ByteString #
ToQuery GetTemplate Source #
Instance details Defined in Amazonka.ConnectCases.GetTemplate Methods toQuery :: GetTemplate -> QueryString #
AWSRequest GetTemplate Source #
Instance details Defined in Amazonka.ConnectCases.GetTemplate Associated Types type AWSResponse GetTemplate # Methods request :: (Service -> Service) -> GetTemplate -> Request GetTemplate # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetTemplate -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetTemplate))) #
Generic GetTemplate Source #
Instance details Defined in Amazonka.ConnectCases.GetTemplate Associated Types type Rep GetTemplate :: Type -> Type # Methods from :: GetTemplate -> Rep GetTemplate x # to :: Rep GetTemplate x -> GetTemplate #
Read GetTemplate Source #
Instance details Defined in Amazonka.ConnectCases.GetTemplate Methods readsPrec :: Int -> ReadS GetTemplate # readList :: ReadS [GetTemplate] # readPrec :: ReadPrec GetTemplate # readListPrec :: ReadPrec [GetTemplate] #
Show GetTemplate Source #
Instance details Defined in Amazonka.ConnectCases.GetTemplate Methods showsPrec :: Int -> GetTemplate -> ShowS # show :: GetTemplate -> String # showList :: [GetTemplate] -> ShowS #
NFData GetTemplate Source #
Instance details Defined in Amazonka.ConnectCases.GetTemplate Methods rnf :: GetTemplate -> () #
Eq GetTemplate Source #
Instance details Defined in Amazonka.ConnectCases.GetTemplate Methods (==) :: GetTemplate -> GetTemplate -> Bool # (/=) :: GetTemplate -> GetTemplate -> Bool #
Hashable GetTemplate Source #
Instance details Defined in Amazonka.ConnectCases.GetTemplate Methods hashWithSalt :: Int -> GetTemplate -> Int # hash :: GetTemplate -> Int #
type AWSResponse GetTemplate Source #
Instance details Defined in Amazonka.ConnectCases.GetTemplate type AWSResponse GetTemplate = GetTemplateResponse
type Rep GetTemplate Source #
Instance details Defined in Amazonka.ConnectCases.GetTemplate type Rep GetTemplate = D1 ('MetaData "GetTemplate" "Amazonka.ConnectCases.GetTemplate" "amazonka-connectcases-2.0-9RA5jvVYRVL9KmD8hfMfHn" 'False) (C1 ('MetaCons "GetTemplate'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "templateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetTemplate Source #

Arguments

:: Text	`GetTemplate`
-> Text	`GetTemplate`
-> GetTemplate

Create a value of GetTemplate 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:

GetTemplate, getTemplate_domainId - The unique identifier of the Cases domain.

GetTemplate, getTemplate_templateId - A unique identifier of a template.

Request Lenses

getTemplate_domainId :: Lens' GetTemplate Text Source #

The unique identifier of the Cases domain.

getTemplate_templateId :: Lens' GetTemplate Text Source #

A unique identifier of a template.

Destructuring the Response

data GetTemplateResponse Source #

See: newGetTemplateResponse smart constructor.

Constructors

GetTemplateResponse'

Fields

description :: Maybe Text
A brief description of the template.
layoutConfiguration :: Maybe LayoutConfiguration
Configuration of layouts associated to the template.
requiredFields :: Maybe [RequiredField]
A list of fields that must contain a value for a case to be successfully created with this template.
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.
name :: Text
The name of the template.
status :: TemplateStatus
The status of the template.
templateArn :: Text
The Amazon Resource Name (ARN) of the template.
templateId :: Text
A unique identifier of a template.

Instances

Instances details

Generic GetTemplateResponse Source #
Instance details Defined in Amazonka.ConnectCases.GetTemplate Associated Types type Rep GetTemplateResponse :: Type -> Type # Methods from :: GetTemplateResponse -> Rep GetTemplateResponse x # to :: Rep GetTemplateResponse x -> GetTemplateResponse #
Read GetTemplateResponse Source #
Instance details Defined in Amazonka.ConnectCases.GetTemplate Methods readsPrec :: Int -> ReadS GetTemplateResponse # readList :: ReadS [GetTemplateResponse] # readPrec :: ReadPrec GetTemplateResponse # readListPrec :: ReadPrec [GetTemplateResponse] #
Show GetTemplateResponse Source #
Instance details Defined in Amazonka.ConnectCases.GetTemplate Methods showsPrec :: Int -> GetTemplateResponse -> ShowS # show :: GetTemplateResponse -> String # showList :: [GetTemplateResponse] -> ShowS #
NFData GetTemplateResponse Source #
Instance details Defined in Amazonka.ConnectCases.GetTemplate Methods rnf :: GetTemplateResponse -> () #
Eq GetTemplateResponse Source #
Instance details Defined in Amazonka.ConnectCases.GetTemplate Methods (==) :: GetTemplateResponse -> GetTemplateResponse -> Bool # (/=) :: GetTemplateResponse -> GetTemplateResponse -> Bool #
type Rep GetTemplateResponse Source #
Instance details Defined in Amazonka.ConnectCases.GetTemplate type Rep GetTemplateResponse = D1 ('MetaData "GetTemplateResponse" "Amazonka.ConnectCases.GetTemplate" "amazonka-connectcases-2.0-9RA5jvVYRVL9KmD8hfMfHn" 'False) (C1 ('MetaCons "GetTemplateResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "layoutConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LayoutConfiguration))) :: (S1 ('MetaSel ('Just "requiredFields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RequiredField])) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :: ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TemplateStatus) :: (S1 ('MetaSel ('Just "templateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "templateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newGetTemplateResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetTemplateResponse'`
-> Text	`GetTemplateResponse`
-> TemplateStatus	`GetTemplateResponse`
-> Text	`GetTemplateResponse`
-> Text	`GetTemplate`
-> GetTemplateResponse

Create a value of GetTemplateResponse 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:

GetTemplateResponse, getTemplateResponse_description - A brief description of the template.

$sel:layoutConfiguration:GetTemplateResponse', getTemplateResponse_layoutConfiguration - Configuration of layouts associated to the template.

$sel:requiredFields:GetTemplateResponse', getTemplateResponse_requiredFields - A list of fields that must contain a value for a case to be successfully created with this template.

GetTemplateResponse, getTemplateResponse_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:GetTemplateResponse', getTemplateResponse_httpStatus - The response's http status code.

GetTemplateResponse, getTemplateResponse_name - The name of the template.

GetTemplateResponse, getTemplateResponse_status - The status of the template.

GetTemplateResponse, getTemplateResponse_templateArn - The Amazon Resource Name (ARN) of the template.

GetTemplate, getTemplateResponse_templateId - A unique identifier of a template.

Response Lenses

getTemplateResponse_description :: Lens' GetTemplateResponse (Maybe Text) Source #

A brief description of the template.

getTemplateResponse_layoutConfiguration :: Lens' GetTemplateResponse (Maybe LayoutConfiguration) Source #

Configuration of layouts associated to the template.

getTemplateResponse_requiredFields :: Lens' GetTemplateResponse (Maybe [RequiredField]) Source #

A list of fields that must contain a value for a case to be successfully created with this template.

getTemplateResponse_tags :: Lens' GetTemplateResponse (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.

getTemplateResponse_httpStatus :: Lens' GetTemplateResponse Int Source #

The response's http status code.

getTemplateResponse_name :: Lens' GetTemplateResponse Text Source #

The name of the template.

getTemplateResponse_status :: Lens' GetTemplateResponse TemplateStatus Source #

The status of the template.

getTemplateResponse_templateArn :: Lens' GetTemplateResponse Text Source #

The Amazon Resource Name (ARN) of the template.

getTemplateResponse_templateId :: Lens' GetTemplateResponse Text Source #

A unique identifier of a template.