ConnectCases / Client / list_templates

list_templates#

ConnectCases.Client.list_templates(**kwargs)#

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

Request Syntax

response = client.list_templates(
    domainId='string',
    maxResults=123,
    nextToken='string',
    status=[
        'Active'|'Inactive',
    ]
)

Parameters:

domainId (string) –
[REQUIRED]

The unique identifier of the Cases domain.
maxResults (integer) – The maximum number of results to return per page.
nextToken (string) – 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 (list) –
A list of status values to filter on.
- (string) –

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'templates': [
        {
            'name': 'string',
            'status': 'Active'|'Inactive',
            'templateArn': 'string',
            'templateId': 'string'
        },
    ]
}

Response Structure

(dict) –
- nextToken (string) –
  
  The token for the next set of results. This is null if there are no more results to return.
- templates (list) –
  
  List of template summary objects.
  - (dict) –
    
    Template summary information.
    - name (string) –
      
      The template name.
    - status (string) –
      
      The status of the template.
    - templateArn (string) –
      
      The Amazon Resource Name (ARN) of the template.
    - templateId (string) –
      
      The unique identifier for the template.

Exceptions

ConnectCases.Client.exceptions.InternalServerException
ConnectCases.Client.exceptions.ResourceNotFoundException
ConnectCases.Client.exceptions.ValidationException
ConnectCases.Client.exceptions.ThrottlingException
ConnectCases.Client.exceptions.AccessDeniedException