ConnectCases / Client / update_template

update_template#

ConnectCases.Client.update_template(**kwargs)#

Updates the attributes of an existing template. The template attributes that can be modified include name, description, layoutConfiguration, requiredFields, and status. At least one of these attributes must not be null. If a null value is provided for a given attribute, that attribute is ignored and its current value is preserved.

See also: AWS API Documentation

Request Syntax

response = client.update_template(
    description='string',
    domainId='string',
    layoutConfiguration={
        'defaultLayout': 'string'
    },
    name='string',
    requiredFields=[
        {
            'fieldId': 'string'
        },
    ],
    status='Active'|'Inactive',
    templateId='string'
)
Parameters:

  • description (string) – A brief description of the template.

  • domainId (string) –

    [REQUIRED]

    The unique identifier of the Cases domain.

  • layoutConfiguration (dict) –

    Configuration of layouts associated to the template.

    • defaultLayout (string) –

      Unique identifier of a layout.

  • name (string) – The name of the template. It must be unique per domain.

  • 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) – [REQUIRED]

        Unique identifier of a field.

  • status (string) – The status of the template.

  • templateId (string) –

    [REQUIRED]

    A unique identifier for the template.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions