Lists all of the templates in a Cases domain. Each list item is a condensed summary object of the template.
Other template APIs are:
Parameters:
-
domain_id
(DomainId)
–
The unique identifier of the Cases domain.
-
max_results
(Optional[MaxResults], default:
None
)
–
The maximum number of results to return per page.
-
next_token
(Optional[NextToken], default:
None
)
–
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
(Optional[TemplateStatusFilters], default:
None
)
–
A list of status values to filter on.
Raises:
-
AccessDeniedException
–
You do not have sufficient access to perform this action.
-
InternalServerException
–
We couldn't process your request because of an issue with the server. Try again later.
-
ResourceNotFoundException
–
We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.
-
ThrottlingException
–
The rate has been exceeded for this API. Please try again after a few minutes.
-
ValidationException
–
The request isn't valid. Check the syntax and try again.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_connectcases/_services/connect_cases.py
| def list_templates(
self,
domain_id: "capo_connectcases.types.domain_id.DomainId",
*,
config_overrides: Optional[ConnectCasesClientConfig] = None,
max_results: Optional["capo_connectcases.types.max_results.MaxResults"] = None,
next_token: Optional["capo_connectcases.types.next_token.NextToken"] = None,
status: Optional[
"capo_connectcases.types.template_status_filters.TemplateStatusFilters"
] = None,
) -> "capo_connectcases.types.list_templates_response.ListTemplatesResponse":
"""<p>Lists all of the templates in a Cases domain. Each list item is a condensed summary object of the template. </p> <p> Other template APIs are: </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateTemplate.html">CreateTemplate</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_DeleteTemplate.html">DeleteTemplate</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_GetTemplate.html">GetTemplate</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_UpdateTemplate.html">UpdateTemplate</a> </p> </li> </ul>
Args:
domain_id: <p>The unique identifier of the Cases domain. </p>
max_results: <p>The maximum number of results to return per page.</p>
next_token: <p>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.</p>
status: <p>A list of status values to filter on.</p>
Raises:
capo_connectcases.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
capo_connectcases.errors.internal_server_exception.InternalServerException: <p>We couldn't process your request because of an issue with the server. Try again later.</p>
capo_connectcases.errors.resource_not_found_exception.ResourceNotFoundException: <p>We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.</p>
capo_connectcases.errors.throttling_exception.ThrottlingException: <p>The rate has been exceeded for this API. Please try again after a few minutes.</p>
capo_connectcases.errors.validation_exception.ValidationException: <p>The request isn't valid. Check the syntax and try again.</p>
capo_connectcases.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_connectcases.types.list_templates_request.ListTemplatesRequest]",
) -> OperationResponse[
"capo_connectcases.types.list_templates_response.ListTemplatesResponse"
]:
import capo_connectcases._operations.amazon_connect_cases.list_templates
output, http_response = (
capo_connectcases._operations.amazon_connect_cases.list_templates.list_templates(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListTemplates")
)
input_: capo_connectcases.types.list_templates_request.ListTemplatesRequest = {
"domain_id": domain_id
}
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
if status is not None:
input_["status"] = status
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|