2026/02/04 - Amazon Connect Cases - 5 updated api methods
Changes Amazon Connect Cases now supports larger, multi-line text fields with up to 4,100 characters. Administrators can use the Admin UI to select the appropriate configuration (single-line or multi-line) on a per-field basis, improving case documentation capabilities.
{'fields': {'attributes': {'text': {'isMultiline': 'boolean'}}}}
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
{
'fields': [
{
'fieldId': 'string',
'name': 'string',
'fieldArn': 'string',
'description': 'string',
'type': 'Text'|'Number'|'Boolean'|'DateTime'|'SingleSelect'|'Url'|'User',
'namespace': 'System'|'Custom',
'tags': {
'string': 'string'
},
'deleted': True|False,
'createdTime': datetime(2015, 1, 1),
'lastModifiedTime': datetime(2015, 1, 1),
'attributes': {
'text': {
'isMultiline': True|False
}
}
},
],
'errors': [
{
'id': 'string',
'errorCode': 'string',
'message': 'string'
},
]
}
Response Structure
(dict) --
fields (list) --
A list of detailed field information.
(dict) --
Object to store detailed field information.
fieldId (string) --
Unique identifier of the field.
name (string) --
Name of the field.
fieldArn (string) --
The Amazon Resource Name (ARN) of the field.
description (string) --
Description of the field.
type (string) --
Type 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) --
deleted (boolean) --
Denotes whether or not the resource has been deleted.
createdTime (datetime) --
Timestamp at which the resource was created.
lastModifiedTime (datetime) --
Timestamp at which the resource was created or last modified.
attributes (dict) --
Union of field attributes.
text (dict) --
Field attributes for Text field type.
isMultiline (boolean) --
Attribute that defines rendering component and validation.
errors (list) --
A list of field errors.
(dict) --
Object for errors on fields.
id (string) --
The field identifier that caused the error.
errorCode (string) --
The error code from getting a field.
message (string) --
The error message from getting a field.
{'attributes': {'text': {'isMultiline': 'boolean'}}}
Creates a field in the Cases domain. This field is used to define the case object model (that is, defines what data can be captured on cases) in a Cases domain.
See also: AWS API Documentation
Request Syntax
client.create_field(
domainId='string',
name='string',
type='Text'|'Number'|'Boolean'|'DateTime'|'SingleSelect'|'Url'|'User',
description='string',
attributes={
'text': {
'isMultiline': True|False
}
}
)
string
[REQUIRED]
The unique identifier of the Cases domain.
string
[REQUIRED]
The name of the field.
string
[REQUIRED]
Defines the data type, some system constraints, and default display of the field.
string
The description of the field.
dict
Union of field attributes.
text (dict) --
Field attributes for Text field type.
isMultiline (boolean) -- [REQUIRED]
Attribute that defines rendering component and validation.
dict
Response Syntax
{
'fieldId': 'string',
'fieldArn': 'string'
}
Response Structure
(dict) --
fieldId (string) --
The unique identifier of a field.
fieldArn (string) --
The Amazon Resource Name (ARN) of the field.
{'fields': {'attributes': {'text': {'isMultiline': 'boolean'}}}}
Lists all fields in a Cases domain.
See also: AWS API Documentation
Request Syntax
client.list_fields(
domainId='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The unique identifier of the Cases domain.
integer
The maximum number of results to return per page.
string
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.
dict
Response Syntax
{
'fields': [
{
'fieldId': 'string',
'fieldArn': 'string',
'name': 'string',
'type': 'Text'|'Number'|'Boolean'|'DateTime'|'SingleSelect'|'Url'|'User',
'namespace': 'System'|'Custom',
'attributes': {
'text': {
'isMultiline': True|False
}
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
fields (list) --
List of detailed field information.
(dict) --
Object for the summarized details of the field.
fieldId (string) --
The unique identifier of a field.
fieldArn (string) --
The Amazon Resource Name (ARN) of the field.
name (string) --
Name of the field.
type (string) --
The type of a field.
namespace (string) --
The namespace of a field.
attributes (dict) --
Union of field attributes.
text (dict) --
Field attributes for Text field type.
isMultiline (boolean) --
Attribute that defines rendering component and validation.
nextToken (string) --
The token for the next set of results. This is null if there are no more results to return.
{'totalCount': 'long'}
Searches for cases within their associated Cases domain. Search results are returned as a paginated list of abridged case documents.
See also: AWS API Documentation
Request Syntax
client.search_cases(
domainId='string',
maxResults=123,
nextToken='string',
searchTerm='string',
filter={
'field': {
'equalTo': {
'id': 'string',
'value': {
'stringValue': 'string',
'doubleValue': 123.0,
'booleanValue': True|False,
'emptyValue': {}
,
'userArnValue': 'string'
}
},
'contains': {
'id': 'string',
'value': {
'stringValue': 'string',
'doubleValue': 123.0,
'booleanValue': True|False,
'emptyValue': {}
,
'userArnValue': 'string'
}
},
'greaterThan': {
'id': 'string',
'value': {
'stringValue': 'string',
'doubleValue': 123.0,
'booleanValue': True|False,
'emptyValue': {}
,
'userArnValue': 'string'
}
},
'greaterThanOrEqualTo': {
'id': 'string',
'value': {
'stringValue': 'string',
'doubleValue': 123.0,
'booleanValue': True|False,
'emptyValue': {}
,
'userArnValue': 'string'
}
},
'lessThan': {
'id': 'string',
'value': {
'stringValue': 'string',
'doubleValue': 123.0,
'booleanValue': True|False,
'emptyValue': {}
,
'userArnValue': 'string'
}
},
'lessThanOrEqualTo': {
'id': 'string',
'value': {
'stringValue': 'string',
'doubleValue': 123.0,
'booleanValue': True|False,
'emptyValue': {}
,
'userArnValue': 'string'
}
}
},
'not': {'... recursive ...'},
'tag': {
'equalTo': {
'key': 'string',
'value': 'string'
}
},
'andAll': [
{'... recursive ...'},
],
'orAll': [
{'... recursive ...'},
]
},
sorts=[
{
'fieldId': 'string',
'sortOrder': 'Asc'|'Desc'
},
],
fields=[
{
'id': 'string'
},
]
)
string
[REQUIRED]
The unique identifier of the Cases domain.
integer
The maximum number of cases to return. When no value is provided, 25 is the default.
string
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.
string
A word or phrase used to perform a quick search.
dict
A list of filter objects.
field (dict) --
A list of fields to filter on.
equalTo (dict) --
Object containing field identifier and value information.
id (string) -- [REQUIRED]
Unique identifier of a field.
value (dict) -- [REQUIRED]
Union of potential field value types.
stringValue (string) --
String value type.
doubleValue (float) --
Can be either null, or have a Double number value type. Only one value can be provided.
booleanValue (boolean) --
Can be either null, or have a Boolean value type. Only one value can be provided.
emptyValue (dict) --
An empty value.
userArnValue (string) --
Represents the user that performed the audit.
contains (dict) --
Object containing field identifier and value information.
id (string) -- [REQUIRED]
Unique identifier of a field.
value (dict) -- [REQUIRED]
Union of potential field value types.
stringValue (string) --
String value type.
doubleValue (float) --
Can be either null, or have a Double number value type. Only one value can be provided.
booleanValue (boolean) --
Can be either null, or have a Boolean value type. Only one value can be provided.
emptyValue (dict) --
An empty value.
userArnValue (string) --
Represents the user that performed the audit.
greaterThan (dict) --
Object containing field identifier and value information.
id (string) -- [REQUIRED]
Unique identifier of a field.
value (dict) -- [REQUIRED]
Union of potential field value types.
stringValue (string) --
String value type.
doubleValue (float) --
Can be either null, or have a Double number value type. Only one value can be provided.
booleanValue (boolean) --
Can be either null, or have a Boolean value type. Only one value can be provided.
emptyValue (dict) --
An empty value.
userArnValue (string) --
Represents the user that performed the audit.
greaterThanOrEqualTo (dict) --
Object containing field identifier and value information.
id (string) -- [REQUIRED]
Unique identifier of a field.
value (dict) -- [REQUIRED]
Union of potential field value types.
stringValue (string) --
String value type.
doubleValue (float) --
Can be either null, or have a Double number value type. Only one value can be provided.
booleanValue (boolean) --
Can be either null, or have a Boolean value type. Only one value can be provided.
emptyValue (dict) --
An empty value.
userArnValue (string) --
Represents the user that performed the audit.
lessThan (dict) --
Object containing field identifier and value information.
id (string) -- [REQUIRED]
Unique identifier of a field.
value (dict) -- [REQUIRED]
Union of potential field value types.
stringValue (string) --
String value type.
doubleValue (float) --
Can be either null, or have a Double number value type. Only one value can be provided.
booleanValue (boolean) --
Can be either null, or have a Boolean value type. Only one value can be provided.
emptyValue (dict) --
An empty value.
userArnValue (string) --
Represents the user that performed the audit.
lessThanOrEqualTo (dict) --
Object containing field identifier and value information.
id (string) -- [REQUIRED]
Unique identifier of a field.
value (dict) -- [REQUIRED]
Union of potential field value types.
stringValue (string) --
String value type.
doubleValue (float) --
Can be either null, or have a Double number value type. Only one value can be provided.
booleanValue (boolean) --
Can be either null, or have a Boolean value type. Only one value can be provided.
emptyValue (dict) --
An empty value.
userArnValue (string) --
Represents the user that performed the audit.
not (dict) --
A filter for cases. Only one value can be provided.
tag (dict) --
A list of tags to filter on.
equalTo (dict) --
Object containing tag key and value information.
key (string) --
The tag key in the tag filter value.
value (string) --
The tag value in the tag filter value.
andAll (list) --
Provides "and all" filtering.
(dict) --
A filter for cases. Only one value can be provided.
orAll (list) --
Provides "or all" filtering.
(dict) --
A filter for cases. Only one value can be provided.
list
A list of sorts where each sort specifies a field and their sort order to be applied to the results.
(dict) --
A structured set of sort terms.
fieldId (string) -- [REQUIRED]
Unique identifier of a field.
sortOrder (string) -- [REQUIRED]
A structured set of sort terms
list
The list of field identifiers to be returned as part of the response.
(dict) --
Object for unique identifier of a field.
id (string) -- [REQUIRED]
Unique identifier of a field.
dict
Response Syntax
{
'nextToken': 'string',
'cases': [
{
'caseId': 'string',
'templateId': 'string',
'fields': [
{
'id': 'string',
'value': {
'stringValue': 'string',
'doubleValue': 123.0,
'booleanValue': True|False,
'emptyValue': {},
'userArnValue': 'string'
}
},
],
'tags': {
'string': 'string'
}
},
],
'totalCount': 123
}
Response Structure
(dict) --
nextToken (string) --
The token for the next set of results. This is null if there are no more results to return.
cases (list) --
A list of case documents where each case contains the properties CaseId and Fields where each field is a complex union structure.
(dict) --
A list of items that represent cases.
caseId (string) --
A unique identifier of the case.
templateId (string) --
A unique identifier of a template.
fields (list) --
List of case field values.
(dict) --
Object for case field values.
id (string) --
Unique identifier of a field.
value (dict) --
Union of potential field value types.
stringValue (string) --
String value type.
doubleValue (float) --
Can be either null, or have a Double number value type. Only one value can be provided.
booleanValue (boolean) --
Can be either null, or have a Boolean value type. Only one value can be provided.
emptyValue (dict) --
An empty value.
userArnValue (string) --
Represents the user that performed the audit.
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) --
totalCount (integer) --
The total number of cases that matched the search criteria.
{'attributes': {'text': {'isMultiline': 'boolean'}}}
Updates the properties of an existing field.
See also: AWS API Documentation
Request Syntax
client.update_field(
domainId='string',
fieldId='string',
name='string',
description='string',
attributes={
'text': {
'isMultiline': True|False
}
}
)
string
[REQUIRED]
The unique identifier of the Cases domain.
string
[REQUIRED]
The unique identifier of a field.
string
The name of the field.
string
The description of a field.
dict
Union of field attributes.
text (dict) --
Field attributes for Text field type.
isMultiline (boolean) -- [REQUIRED]
Attribute that defines rendering component and validation.
dict
Response Syntax
{}
Response Structure
(dict) --