ConnectCases / Client / get_template

get_template¶

ConnectCases.Client.get_template(**kwargs)¶

Returns the details for the requested template. Other template APIs are:

Request Syntax

response = client.get_template(
    domainId='string',
    templateId='string'
)

Parameters:

domainId (string) –
[REQUIRED]

The unique identifier of the Cases domain.
templateId (string) –
[REQUIRED]

A unique identifier of a template.

Return type:

dict

Returns:

Response Syntax

{
    'templateId': 'string',
    'templateArn': 'string',
    'name': 'string',
    'description': 'string',
    'layoutConfiguration': {
        'defaultLayout': 'string'
    },
    'requiredFields': [
        {
            'fieldId': 'string'
        },
    ],
    'tags': {
        'string': 'string'
    },
    'status': 'Active'|'Inactive',
    'deleted': True|False,
    'createdTime': datetime(2015, 1, 1),
    'lastModifiedTime': datetime(2015, 1, 1),
    'rules': [
        {
            'caseRuleId': 'string',
            'fieldId': 'string'
        },
    ]
}

Response Structure

(dict) –
- templateId (string) –
  
  A unique identifier of a template.
- templateArn (string) –
  
  The Amazon Resource Name (ARN) of the template.
- name (string) –
  
  The name of the template.
- description (string) –
  
  A brief description of the template.
- layoutConfiguration (dict) –
  
  Configuration of layouts associated to the template.
  - defaultLayout (string) –
    
    Unique identifier of a layout.
- requiredFields (list) –
  
  A list of fields that must contain a value for a case to be successfully created with this template.
  - (dict) –
    
    List of fields that must have a value provided to create a case.
    - fieldId (string) –
      
      Unique identifier of a field.
- tags (dict) –
  
  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.
  - (string) –
    - (string) –
- status (string) –
  
  The status of the template.
- deleted (boolean) –
  
  Denotes whether or not the resource has been deleted.
- createdTime (datetime) –
  
  Timestamp at which the resource was created.
- lastModifiedTime (datetime) –
  
  Timestamp at which the resource was created or last modified.
- rules (list) –
  
  A list of case rules (also known as case field conditions) on a template.
  - (dict) –
    
    An association representing a case rule acting upon a field. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.
    - caseRuleId (string) –
      
      Unique identifier of a case rule.
    - fieldId (string) –
      
      Unique identifier of a field.

Exceptions

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