| 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
Description
Lists all of the templates in a Cases domain. Each list item is a condensed summary object of the template.
Synopsis
- data ListTemplates = ListTemplates' {}
- newListTemplates :: Text -> ListTemplates
- listTemplates_maxResults :: Lens' ListTemplates (Maybe Natural)
- listTemplates_nextToken :: Lens' ListTemplates (Maybe Text)
- listTemplates_status :: Lens' ListTemplates (Maybe (NonEmpty TemplateStatus))
- listTemplates_domainId :: Lens' ListTemplates Text
- data ListTemplatesResponse = ListTemplatesResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- templates :: [TemplateSummary]
- newListTemplatesResponse :: Int -> ListTemplatesResponse
- listTemplatesResponse_nextToken :: Lens' ListTemplatesResponse (Maybe Text)
- listTemplatesResponse_httpStatus :: Lens' ListTemplatesResponse Int
- listTemplatesResponse_templates :: Lens' ListTemplatesResponse [TemplateSummary]
Creating a Request
data ListTemplates Source #
See: newListTemplates smart constructor.
Constructors
| ListTemplates' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> 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
| |
Instances
newListTemplatesResponse Source #
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.