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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists all of the templates in a Cases domain. Each list item is a condensed summary object of the template.

Synopsis

Creating a Request

data ListTemplates Source #

See: newListTemplates smart constructor.

Constructors

ListTemplates'
Fields maxResults :: Maybe Natural The maximum number of results to return per page. nextToken :: Maybe Text The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. status :: Maybe (NonEmpty TemplateStatus) A list of status values to filter on. domainId :: Text The unique identifier of the Cases domain.

Instances

Instances details

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

newListTemplates Source #

Arguments

:: Text	`ListTemplates`
-> ListTemplates

Create a value of ListTemplates 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:maxResults:ListTemplates', listTemplates_maxResults - The maximum number of results to return per page.

ListTemplates, listTemplates_nextToken - The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

ListTemplates, listTemplates_status - A list of status values to filter on.

ListTemplates, listTemplates_domainId - The unique identifier of the Cases domain.

Request Lenses

listTemplates_maxResults :: Lens' ListTemplates (Maybe Natural) Source #

The maximum number of results to return per page.

listTemplates_nextToken :: Lens' ListTemplates (Maybe Text) Source #

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

listTemplates_status :: Lens' ListTemplates (Maybe (NonEmpty TemplateStatus)) Source #

A list of status values to filter on.

listTemplates_domainId :: Lens' ListTemplates Text Source #

The unique identifier of the Cases domain.

Destructuring the Response

data ListTemplatesResponse Source #

See: newListTemplatesResponse smart constructor.

Constructors

ListTemplatesResponse'
Fields nextToken :: Maybe Text The token for the next set of results. This is null if there are no more results to return. httpStatus :: Int The response's http status code. templates :: [TemplateSummary] List of template summary objects.

Instances

Instances details

Generic ListTemplatesResponse Source #
Instance details Defined in Amazonka.ConnectCases.ListTemplates Associated Types type Rep ListTemplatesResponse :: Type -> Type # Methods from :: ListTemplatesResponse -> Rep ListTemplatesResponse x # to :: Rep ListTemplatesResponse x -> ListTemplatesResponse #
Read ListTemplatesResponse Source #
Instance details Defined in Amazonka.ConnectCases.ListTemplates Methods readsPrec :: Int -> ReadS ListTemplatesResponse # readList :: ReadS [ListTemplatesResponse] # readPrec :: ReadPrec ListTemplatesResponse # readListPrec :: ReadPrec [ListTemplatesResponse] #
Show ListTemplatesResponse Source #
Instance details Defined in Amazonka.ConnectCases.ListTemplates Methods showsPrec :: Int -> ListTemplatesResponse -> ShowS # show :: ListTemplatesResponse -> String # showList :: [ListTemplatesResponse] -> ShowS #
NFData ListTemplatesResponse Source #
Instance details Defined in Amazonka.ConnectCases.ListTemplates Methods rnf :: ListTemplatesResponse -> () #
Eq ListTemplatesResponse Source #
Instance details Defined in Amazonka.ConnectCases.ListTemplates Methods (==) :: ListTemplatesResponse -> ListTemplatesResponse -> Bool # (/=) :: ListTemplatesResponse -> ListTemplatesResponse -> Bool #
type Rep ListTemplatesResponse Source #
Instance details Defined in Amazonka.ConnectCases.ListTemplates type Rep ListTemplatesResponse = D1 ('MetaData "ListTemplatesResponse" "Amazonka.ConnectCases.ListTemplates" "amazonka-connectcases-2.0-9RA5jvVYRVL9KmD8hfMfHn" 'False) (C1 ('MetaCons "ListTemplatesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "templates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [TemplateSummary]))))

newListTemplatesResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListTemplatesResponse'`
-> ListTemplatesResponse

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

ListTemplates, listTemplatesResponse_nextToken - The token for the next set of results. This is null if there are no more results to return.

$sel:httpStatus:ListTemplatesResponse', listTemplatesResponse_httpStatus - The response's http status code.

$sel:templates:ListTemplatesResponse', listTemplatesResponse_templates - List of template summary objects.

Response Lenses

listTemplatesResponse_nextToken :: Lens' ListTemplatesResponse (Maybe Text) Source #

The token for the next set of results. This is null if there are no more results to return.

listTemplatesResponse_httpStatus :: Lens' ListTemplatesResponse Int Source #

The response's http status code.

listTemplatesResponse_templates :: Lens' ListTemplatesResponse [TemplateSummary] Source #

List of template summary objects.