2024/04/29 - Amazon Connect Cases - 3 new 3 updated api methods
Changes This feature releases DeleteField, DeletedLayout, and DeleteTemplate API's
Deletes a field from a cases template. You can delete up to 100 fields per domain.
After a field is deleted:
You can still retrieve the field by calling BatchGetField .
You cannot update a deleted field by calling UpdateField ; it throws a ValidationException .
Deleted fields are not included in the ListFields response.
Calling CreateCase with a deleted field throws a ValidationException denoting which field IDs in the request have been deleted.
Calling GetCase with a deleted field ID returns the deleted field's value if one exists.
Calling UpdateCase with a deleted field ID throws a ValidationException if the case does not already contain a value for the deleted field. Otherwise it succeeds, allowing you to update or remove (using emptyValue: {} ) the field's value from the case.
GetTemplate does not return field IDs for deleted fields.
GetLayout does not return field IDs for deleted fields.
Calling SearchCases with the deleted field ID as a filter returns any cases that have a value for the deleted field that matches the filter criteria.
Calling SearchCases with a searchTerm value that matches a deleted field's value on a case returns the case in the response.
Calling BatchPutFieldOptions with a deleted field ID throw a ValidationException .
Calling GetCaseEventConfiguration does not return field IDs for deleted fields.
See also: AWS API Documentation
Request Syntax
client.delete_field(
domainId='string',
fieldId='string'
)
string
[REQUIRED]
The unique identifier of the Cases domain.
string
[REQUIRED]
The unique identifier of a field.
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes a cases template. You can delete up to 100 templates per domain.
<p>After a cases template is deleted:</p> <ul> <li> <p>You can still retrieve the template by calling <code>GetTemplate</code>.</p> </li> <li> <p>You cannot update the template. </p> </li> <li> <p>You cannot create a case by using the deleted template.</p> </li> <li> <p>Deleted templates are not included in the <code>ListTemplates</code> response.</p> </li> </ul>
See also: AWS API Documentation
Request Syntax
client.delete_template(
domainId='string',
templateId='string'
)
string
[REQUIRED]
The unique identifier of the Cases domain.
string
[REQUIRED]
A unique identifier of a template.
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes a layout from a cases template. You can delete up to 100 layouts per domain.
<p>After a layout is deleted:</p> <ul> <li> <p>You can still retrieve the layout by calling <code>GetLayout</code>.</p> </li> <li> <p>You cannot update a deleted layout by calling <code>UpdateLayout</code>; it throws a <code>ValidationException</code>.</p> </li> <li> <p>Deleted layouts are not included in the <code>ListLayouts</code> response.</p> </li> </ul>
See also: AWS API Documentation
Request Syntax
client.delete_layout(
domainId='string',
layoutId='string'
)
string
[REQUIRED]
The unique identifier of the Cases domain.
string
[REQUIRED]
The unique identifier of the layout.
dict
Response Syntax
{}
Response Structure
(dict) --
{'fields': {'createdTime': 'timestamp',
'deleted': 'boolean',
'lastModifiedTime': 'timestamp'}}
Returns the description for the list of fields in the request parameters.
See also: AWS API Documentation
Request Syntax
client.batch_get_field(
domainId='string',
fields=[
{
'id': 'string'
},
]
)
string
[REQUIRED]
The unique identifier of the Cases domain.
list
[REQUIRED]
A list of unique field identifiers.
(dict) --
Object for unique identifier of a field.
id (string) -- [REQUIRED]
Unique identifier of a field.
dict
Response Syntax
{
'errors': [
{
'errorCode': 'string',
'id': 'string',
'message': 'string'
},
],
'fields': [
{
'createdTime': datetime(2015, 1, 1),
'deleted': True|False,
'description': 'string',
'fieldArn': 'string',
'fieldId': 'string',
'lastModifiedTime': datetime(2015, 1, 1),
'name': 'string',
'namespace': 'System'|'Custom',
'tags': {
'string': 'string'
},
'type': 'Text'|'Number'|'Boolean'|'DateTime'|'SingleSelect'|'Url'|'User'
},
]
}
Response Structure
(dict) --
errors (list) --
A list of field errors.
(dict) --
Object for errors on fields.
errorCode (string) --
The error code from getting a field.
id (string) --
The field identifier that caused the error.
message (string) --
The error message from getting a field.
fields (list) --
A list of detailed field information.
(dict) --
Object to store detailed field information.
createdTime (datetime) --
The timestamp for when the resource was created.
deleted (boolean) --
Indicates whether the resource has been deleted.
description (string) --
Description of the field.
fieldArn (string) --
The Amazon Resource Name (ARN) of the field.
fieldId (string) --
Unique identifier of the field.
lastModifiedTime (datetime) --
The timestamp for when the resource was created or last modified.
name (string) --
Name of the field.
namespace (string) --
Namespace of the 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) --
type (string) --
Type of the field.
{'createdTime': 'timestamp',
'deleted': 'boolean',
'lastModifiedTime': 'timestamp'}
Returns the details for the requested layout.
See also: AWS API Documentation
Request Syntax
client.get_layout(
domainId='string',
layoutId='string'
)
string
[REQUIRED]
The unique identifier of the Cases domain.
string
[REQUIRED]
The unique identifier of the layout.
dict
Response Syntax
{
'content': {
'basic': {
'moreInfo': {
'sections': [
{
'fieldGroup': {
'fields': [
{
'id': 'string'
},
],
'name': 'string'
}
},
]
},
'topPanel': {
'sections': [
{
'fieldGroup': {
'fields': [
{
'id': 'string'
},
],
'name': 'string'
}
},
]
}
}
},
'createdTime': datetime(2015, 1, 1),
'deleted': True|False,
'lastModifiedTime': datetime(2015, 1, 1),
'layoutArn': 'string',
'layoutId': 'string',
'name': 'string',
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
content (dict) --
Information about which fields will be present in the layout, the order of the fields, and read-only attribute of the field.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: basic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
basic (dict) --
Content specific to BasicLayout type. It configures fields in the top panel and More Info tab of Cases user interface.
moreInfo (dict) --
This represents sections in a tab of the page layout.
sections (list) --
Ordered list containing different kinds of sections that can be added.
(dict) --
This represents a sections within a panel or tab of the page layout.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: fieldGroup. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
fieldGroup (dict) --
Consists of a group of fields and associated properties.
fields (list) --
Represents an ordered list containing field related information.
(dict) --
Object for field related information.
id (string) --
Unique identifier of a field.
name (string) --
Name of the field group.
topPanel (dict) --
This represents sections in a panel of the page layout.
sections (list) --
Ordered list containing different kinds of sections that can be added.
(dict) --
This represents a sections within a panel or tab of the page layout.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: fieldGroup. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
fieldGroup (dict) --
Consists of a group of fields and associated properties.
fields (list) --
Represents an ordered list containing field related information.
(dict) --
Object for field related information.
id (string) --
Unique identifier of a field.
name (string) --
Name of the field group.
createdTime (datetime) --
The timestamp for when the resource was created.
deleted (boolean) --
Indicates whether the resource has been deleted.
lastModifiedTime (datetime) --
The timestamp for when the resource was created or last modified.
layoutArn (string) --
The Amazon Resource Name (ARN) of the newly created layout.
layoutId (string) --
The unique identifier of the layout.
name (string) --
The name of the layout. It must be unique.
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) --
{'createdTime': 'timestamp',
'deleted': 'boolean',
'lastModifiedTime': 'timestamp'}
Returns the details for the requested template.
See also: AWS API Documentation
Request Syntax
client.get_template(
domainId='string',
templateId='string'
)
string
[REQUIRED]
The unique identifier of the Cases domain.
string
[REQUIRED]
A unique identifier of a template.
dict
Response Syntax
{
'createdTime': datetime(2015, 1, 1),
'deleted': True|False,
'description': 'string',
'lastModifiedTime': datetime(2015, 1, 1),
'layoutConfiguration': {
'defaultLayout': 'string'
},
'name': 'string',
'requiredFields': [
{
'fieldId': 'string'
},
],
'status': 'Active'|'Inactive',
'tags': {
'string': 'string'
},
'templateArn': 'string',
'templateId': 'string'
}
Response Structure
(dict) --
createdTime (datetime) --
The timestamp for when the resource was created.
deleted (boolean) --
Indicates whether the resource has been deleted.
description (string) --
A brief description of the template.
lastModifiedTime (datetime) --
The timestamp for when the resource was created or last modified.
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.