AWS API Changes

2022/11/09 - Amazon Connect Cases - 4 updated api methods

Changes This release adds the ability to disable templates through the UpdateTemplate API. Disabling templates prevents customers from creating cases using the template. For more information see https://docs.aws.amazon.com/cases/latest/APIReference/Welcome.html

CreateTemplate (updated)

Link ¶
Changes (request)

{'status': 'Active | Inactive'}

Creates a template in the Cases domain. This template is used to define the case object model (that is, to define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed within the same Template. A template can be either Active or Inactive, as indicated by its status. Inactive templates cannot be used to create cases.

See also: AWS API Documentation

Request Syntax

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

type description

string

param description

A brief description of the template.

type domainId

string

param domainId

[REQUIRED]

The unique identifier of the Cases domain.

type layoutConfiguration

dict

param layoutConfiguration

Configuration of layouts associated to the template.

defaultLayout (string) --

Unique identifier of a layout.

type name

string

param name

[REQUIRED]

A name for the template. It must be unique per domain.

type requiredFields

list

param requiredFields

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.

type status

string

param status

The status of the template.

rtype

dict

returns

Response Syntax

{
    'templateArn': 'string',
    'templateId': 'string'
}

Response Structure

(dict) --
- templateArn (string) --
  
  The Amazon Resource Name (ARN) of the newly created template.
- templateId (string) --
  
  A unique identifier of a template.

GetTemplate (updated)

Link ¶
Changes (response)

{'status': 'Active | Inactive'}

Returns the details for the requested template.

See also: AWS API Documentation

Request Syntax

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

type domainId

string

param domainId

[REQUIRED]

The unique identifier of the Cases domain.

type templateId

string

param templateId

[REQUIRED]

A unique identifier of a template.

rtype

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.

ListTemplates (updated)

Link ¶
Changes (request, response)
Request

{'status': ['Active | Inactive']}

Response

{'templates': {'status': 'Active | Inactive'}}

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

See also: AWS API Documentation

Request Syntax

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

type domainId

string

param domainId

[REQUIRED]

The unique identifier of the Cases domain.

type maxResults

integer

param maxResults

The maximum number of results to return per page.

type nextToken

string

param nextToken

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.

type status

list

param status

A list of status values to filter on.

(string) --

Status of a template

rtype

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.

UpdateTemplate (updated)

Link ¶
Changes (request)

{'status': 'Active | Inactive'}

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

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

type description

string

param description

A brief description of the template.

type domainId

string

param domainId

[REQUIRED]

The unique identifier of the Cases domain.

type layoutConfiguration

dict

param layoutConfiguration

Configuration of layouts associated to the template.

defaultLayout (string) --

Unique identifier of a layout.

type name

string

param name

The name of the template. It must be unique per domain.

type requiredFields

list

param requiredFields

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.

type status

string

param status

The status of the template.

type templateId

string

param templateId

[REQUIRED]

A unique identifier for the template.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --