ConnectCases / Client / get_template

get_template#

ConnectCases.Client.get_template(**kwargs)#

Returns the details for the requested template.

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

{
    'description': 'string',
    'layoutConfiguration': {
        'defaultLayout': 'string'
    },
    'name': 'string',
    'requiredFields': [
        {
            'fieldId': 'string'
        },
    ],
    'status': 'Active'|'Inactive',
    'tags': {
        'string': 'string'
    },
    'templateArn': 'string',
    'templateId': 'string'
}

Response Structure

(dict) –
- description (string) –
  
  A brief description of the template.
- layoutConfiguration (dict) –
  
  Configuration of layouts associated to the template.
  - defaultLayout (string) –
    
    Unique identifier of a layout.
- name (string) –
  
  The name of the template.
- 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.
- status (string) –
  
  The status of the template.
- 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) –
- templateArn (string) –
  
  The Amazon Resource Name (ARN) of the template.
- templateId (string) –
  
  A unique identifier of a template.

Exceptions

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