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.

Other template APIs are:

See also: AWS API Documentation

Request Syntax

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

  • domainId (string) –

    [REQUIRED]

    The unique identifier of the Cases domain.

  • templateId (string) –

    [REQUIRED]

    A unique identifier for the template.

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

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

        Unique identifier of a field.

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

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

        Unique identifier of a case rule.

      • fieldId (string) – [REQUIRED]

        Unique identifier of a field.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • ConnectCases.Client.exceptions.InternalServerException

  • ConnectCases.Client.exceptions.ResourceNotFoundException

  • ConnectCases.Client.exceptions.ValidationException

  • ConnectCases.Client.exceptions.ThrottlingException

  • ConnectCases.Client.exceptions.AccessDeniedException

  • ConnectCases.Client.exceptions.ConflictException