2022/10/04 - Amazon Connect Cases - 29 new api methods
Changes This release adds APIs for Amazon Connect Cases. Cases allows your agents to quickly track and manage customer issues that require multiple interactions, follow-up tasks, and teams in your contact center. For more information, see https://docs.aws.amazon.com/cases/latest/APIReference/Welcome.html
Creates and updates a set of field options for a single select field in a Cases domain.
See also: AWS API Documentation
Request Syntax
client.batch_put_field_options(
domainId='string',
fieldId='string',
options=[
{
'active': True|False,
'name': 'string',
'value': 'string'
},
]
)
string
[REQUIRED]
The unique identifier of the Cases domain.
string
[REQUIRED]
The unique identifier of a field.
list
[REQUIRED]
A list of FieldOption objects.
(dict) --
Object for field Options information.
active (boolean) -- [REQUIRED]
Describes whether the FieldOption is active (displayed) or inactive.
name (string) -- [REQUIRED]
FieldOptionName has max length 100 and disallows trailing spaces.
value (string) -- [REQUIRED]
FieldOptionValue has max length 100 and must be alphanumeric with hyphens and underscores.
dict
Response Syntax
{
'errors': [
{
'errorCode': 'string',
'message': 'string',
'value': 'string'
},
]
}
Response Structure
(dict) --
errors (list) --
A list of field errors.
(dict) --
Object for field Options errors.
errorCode (string) --
Error code from creating or updating field option.
message (string) --
Error message from creating or updating field option.
value (string) --
The field option value that caused the error.
Updates the attributes of an existing template. The template attributes that can be modified include name , description , layouts , and requiredFields . 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'
},
],
templateId='string'
)
string
A brief description of the template.
string
[REQUIRED]
The unique identifier of the Cases domain.
dict
Configuration of layouts associated to the template.
defaultLayout (string) --
Unique identifier of a layout.
string
The name of the template. It must be unique per domain.
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.
string
[REQUIRED]
A unique identifier for the template.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates a template in the Cases domain. This template is used to define the case object model (that is, 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.
See also: AWS API Documentation
Request Syntax
client.create_template(
description='string',
domainId='string',
layoutConfiguration={
'defaultLayout': 'string'
},
name='string',
requiredFields=[
{
'fieldId': 'string'
},
]
)
string
A brief description of the template.
string
[REQUIRED]
The unique identifier of the Cases domain.
dict
Configuration of layouts associated to the template.
defaultLayout (string) --
Unique identifier of a layout.
string
[REQUIRED]
A name for the template. It must be unique per domain.
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.
dict
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.
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',
fields=[
{
'id': 'string'
},
],
filter={
'andAll': [
{'... recursive ...'},
],
'field': {
'contains': {
'id': 'string',
'value': {
'booleanValue': True|False,
'doubleValue': 123.0,
'stringValue': 'string'
}
},
'equalTo': {
'id': 'string',
'value': {
'booleanValue': True|False,
'doubleValue': 123.0,
'stringValue': 'string'
}
},
'greaterThan': {
'id': 'string',
'value': {
'booleanValue': True|False,
'doubleValue': 123.0,
'stringValue': 'string'
}
},
'greaterThanOrEqualTo': {
'id': 'string',
'value': {
'booleanValue': True|False,
'doubleValue': 123.0,
'stringValue': 'string'
}
},
'lessThan': {
'id': 'string',
'value': {
'booleanValue': True|False,
'doubleValue': 123.0,
'stringValue': 'string'
}
},
'lessThanOrEqualTo': {
'id': 'string',
'value': {
'booleanValue': True|False,
'doubleValue': 123.0,
'stringValue': 'string'
}
}
},
'not': {'... recursive ...'}
},
maxResults=123,
nextToken='string',
searchTerm='string',
sorts=[
{
'fieldId': 'string',
'sortOrder': 'Asc'|'Desc'
},
]
)
string
[REQUIRED]
The unique identifier of the Cases domain.
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
A list of filter objects.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: andAll, field, not.
andAll (list) --
Provides "and all" filtering.
(dict) --
A filter for cases. Only one value can be provided.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: andAll, field, not.
field (dict) --
A list of fields to filter on.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: contains, equalTo, greaterThan, greaterThanOrEqualTo, lessThan, lessThanOrEqualTo.
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.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: booleanValue, doubleValue, stringValue.
booleanValue (boolean) --
Can be either null, or have a Boolean value type. Only one value can be provided.
doubleValue (float) --
Can be either null, or have a Double number value type. Only one value can be provided.
stringValue (string) --
String value type.
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.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: booleanValue, doubleValue, stringValue.
booleanValue (boolean) --
Can be either null, or have a Boolean value type. Only one value can be provided.
doubleValue (float) --
Can be either null, or have a Double number value type. Only one value can be provided.
stringValue (string) --
String value type.
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.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: booleanValue, doubleValue, stringValue.
booleanValue (boolean) --
Can be either null, or have a Boolean value type. Only one value can be provided.
doubleValue (float) --
Can be either null, or have a Double number value type. Only one value can be provided.
stringValue (string) --
String value type.
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.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: booleanValue, doubleValue, stringValue.
booleanValue (boolean) --
Can be either null, or have a Boolean value type. Only one value can be provided.
doubleValue (float) --
Can be either null, or have a Double number value type. Only one value can be provided.
stringValue (string) --
String value type.
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.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: booleanValue, doubleValue, stringValue.
booleanValue (boolean) --
Can be either null, or have a Boolean value type. Only one value can be provided.
doubleValue (float) --
Can be either null, or have a Double number value type. Only one value can be provided.
stringValue (string) --
String value type.
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.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: booleanValue, doubleValue, stringValue.
booleanValue (boolean) --
Can be either null, or have a Boolean value type. Only one value can be provided.
doubleValue (float) --
Can be either null, or have a Double number value type. Only one value can be provided.
stringValue (string) --
String value type.
not (dict) --
A filter for cases. Only one value can be provided.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: andAll, field, not.
integer
The maximum number of cases to return. The current maximum supported value is 25. This is also the default value when no other value is provided.
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.
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
dict
Response Syntax
{
'cases': [
{
'caseId': 'string',
'fields': [
{
'id': 'string',
'value': {
'booleanValue': True|False,
'doubleValue': 123.0,
'stringValue': 'string'
}
},
],
'tags': {
'string': 'string'
},
'templateId': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
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.
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.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: booleanValue, doubleValue, stringValue. 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'}
booleanValue (boolean) --
Can be either null, or have a Boolean value type. Only one value can be provided.
doubleValue (float) --
Can be either null, or have a Double number value type. Only one value can be provided.
stringValue (string) --
String value type.
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) --
templateId (string) --
A unique identifier of a template.
nextToken (string) --
The token for the next set of results. This is null if there are no more results to return.
Untags a resource.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
arn='string',
tagKeys=[
'string',
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN)
list
[REQUIRED]
List of tag keys.
(string) --
None
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(
description='string',
domainId='string',
name='string',
type='Text'|'Number'|'Boolean'|'DateTime'|'SingleSelect'
)
string
The description of the field.
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.
dict
Response Syntax
{
'fieldArn': 'string',
'fieldId': 'string'
}
Response Structure
(dict) --
fieldArn (string) --
The Amazon Resource Name (ARN) of the field.
fieldId (string) --
The unique identifier of a field.
Returns information about a specific case if it exists.
See also: AWS API Documentation
Request Syntax
client.get_case(
caseId='string',
domainId='string',
fields=[
{
'id': 'string'
},
],
nextToken='string'
)
string
[REQUIRED]
A unique identifier of the case.
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.
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': [
{
'id': 'string',
'value': {
'booleanValue': True|False,
'doubleValue': 123.0,
'stringValue': 'string'
}
},
],
'nextToken': 'string',
'tags': {
'string': 'string'
},
'templateId': 'string'
}
Response Structure
(dict) --
fields (list) --
A list of detailed field information.
(dict) --
Object for case field values.
id (string) --
Unique identifier of a field.
value (dict) --
Union of potential field value types.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: booleanValue, doubleValue, stringValue. 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'}
booleanValue (boolean) --
Can be either null, or have a Boolean value type. Only one value can be provided.
doubleValue (float) --
Can be either null, or have a Double number value type. Only one value can be provided.
stringValue (string) --
String value type.
nextToken (string) --
The token for the next set of results. This is null if there are no more results to return.
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) --
templateId (string) --
A unique identifier of a template.
Lists all cases domains in the Amazon Web Services account. Each list item is a condensed summary object of the domain.
See also: AWS API Documentation
Request Syntax
client.list_domains(
maxResults=123,
nextToken='string'
)
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
{
'domains': [
{
'domainArn': 'string',
'domainId': 'string',
'name': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
domains (list) --
The Cases domain.
(dict) --
Object for the summarized details of the domain.
domainArn (string) --
The Amazon Resource Name (ARN) of the domain.
domainId (string) --
The unique identifier of the domain.
name (string) --
The name of the domain.
nextToken (string) --
The token for the next set of results. This is null if there are no more results to return.
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
{
'description': 'string',
'layoutConfiguration': {
'defaultLayout': 'string'
},
'name': 'string',
'requiredFields': [
{
'fieldId': 'string'
},
],
'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.
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.
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'
)
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
{
'nextToken': 'string',
'templates': [
{
'name': 'string',
'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.
templateArn (string) --
The Amazon Resource Name (ARN) of the template.
templateId (string) --
The unique identifier for the template.
Lists all layouts in the given cases domain. Each list item is a condensed summary object of the layout.
See also: AWS API Documentation
Request Syntax
client.list_layouts(
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
{
'layouts': [
{
'layoutArn': 'string',
'layoutId': 'string',
'name': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
layouts (list) --
The layouts for the domain.
(dict) --
Object for the summarized details of the layout.
layoutArn (string) --
The Amazon Resource Name (ARN) of the layout.
layoutId (string) --
The unique identifier for of the layout.
name (string) --
The name of the layout.
nextToken (string) --
The token for the next set of results. This is null if there are no more results to return.
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': [
{
'fieldArn': 'string',
'fieldId': 'string',
'name': 'string',
'namespace': 'System'|'Custom',
'type': 'Text'|'Number'|'Boolean'|'DateTime'|'SingleSelect'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
fields (list) --
List of detailed field information.
(dict) --
Object for the summarized details of the field.
fieldArn (string) --
The Amazon Resource Name (ARN) of the field.
fieldId (string) --
The unique identifier of a field.
name (string) --
Name of the field.
namespace (string) --
The namespace of a field.
type (string) --
The type of a field.
nextToken (string) --
The token for the next set of results. This is null if there are no more results to return.
Searches for related items that are associated with a case.
Note
If no filters are provided, this returns all related items associated with a case.
See also: AWS API Documentation
Request Syntax
client.search_related_items(
caseId='string',
domainId='string',
filters=[
{
'comment': {}
,
'contact': {
'channel': [
'string',
],
'contactArn': 'string'
}
},
],
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
A unique identifier of the case.
string
[REQUIRED]
The unique identifier of the Cases domain.
list
The list of types of related items and their parameters to use for filtering.
(dict) --
The list of types of related items and their parameters to use for filtering.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: comment, contact.
comment (dict) --
A filter for related items of type Comment .
contact (dict) --
A filter for related items of type Contact .
channel (list) --
A list of channels to filter on for related items of type Contact .
(string) --
contactArn (string) --
A unique identifier of a contact in Amazon Connect.
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
{
'nextToken': 'string',
'relatedItems': [
{
'associationTime': datetime(2015, 1, 1),
'content': {
'comment': {
'body': 'string',
'contentType': 'Text/Plain'
},
'contact': {
'channel': 'string',
'connectedToSystemTime': datetime(2015, 1, 1),
'contactArn': 'string'
}
},
'relatedItemId': 'string',
'tags': {
'string': 'string'
},
'type': 'Contact'|'Comment'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token for the next set of results. This is null if there are no more results to return.
relatedItems (list) --
A list of items related to a case.
(dict) --
A list of items that represent RelatedItems.
associationTime (datetime) --
Time at which a related item was associated with a case.
content (dict) --
Represents the content of a particular type of related item.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: comment, contact. 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'}
comment (dict) --
Represents the content of a comment to be returned to agents.
body (string) --
Text in the body of a Comment on a case.
contentType (string) --
Type of the text in the box of a Comment on a case.
contact (dict) --
Represents the content of a contact to be returned to agents.
channel (string) --
A list of channels to filter on for related items of type Contact .
connectedToSystemTime (datetime) --
The difference between the InitiationTimestamp and the DisconnectTimestamp of the contact.
contactArn (string) --
A unique identifier of a contact in Amazon Connect.
relatedItemId (string) --
Unique identifier of a related item.
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 a related item.
Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts. Each Amazon Connect instance can be associated with only one Cases domain.
Warning
This will not associate your connect instance to Cases domain. Instead, use the Amazon Connect CreateIntegrationAssociation API.
See also: AWS API Documentation
Request Syntax
client.create_domain(
name='string'
)
string
[REQUIRED]
The name for your Cases domain. It must be unique for your Amazon Web Services account.
dict
Response Syntax
{
'domainArn': 'string',
'domainId': 'string',
'domainStatus': 'Active'|'CreationInProgress'|'CreationFailed'
}
Response Structure
(dict) --
domainArn (string) --
The Amazon Resource Name (ARN) for the Cases domain.
domainId (string) --
The unique identifier of the Cases domain.
domainStatus (string) --
The status of the domain.
Updates the properties of an existing field.
See also: AWS API Documentation
Request Syntax
client.update_field(
description='string',
domainId='string',
fieldId='string',
name='string'
)
string
The description of a field.
string
[REQUIRED]
The unique identifier of the Cases domain.
string
[REQUIRED]
The unique identifier of a field.
string
The name of the field.
dict
Response Syntax
{}
Response Structure
(dict) --
Updates the attributes of an existing layout.
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
A ValidationException is returned when you add non-existent fieldIds to a layout.
Note
Title and Status fields cannot be part of layouts because they are not configurable.
See also: AWS API Documentation
Request Syntax
client.update_layout(
content={
'basic': {
'moreInfo': {
'sections': [
{
'fieldGroup': {
'fields': [
{
'id': 'string'
},
],
'name': 'string'
}
},
]
},
'topPanel': {
'sections': [
{
'fieldGroup': {
'fields': [
{
'id': 'string'
},
],
'name': 'string'
}
},
]
}
}
},
domainId='string',
layoutId='string',
name='string'
)
dict
Information about which fields will be present in the layout, the order of the fields, and a read-only attribute of the field.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: basic.
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 can be set: fieldGroup.
fieldGroup (dict) --
Consists of a group of fields and associated properties.
fields (list) -- [REQUIRED]
Represents an ordered list containing field related information.
(dict) --
Object for field related information.
id (string) -- [REQUIRED]
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 can be set: fieldGroup.
fieldGroup (dict) --
Consists of a group of fields and associated properties.
fields (list) -- [REQUIRED]
Represents an ordered list containing field related information.
(dict) --
Object for field related information.
id (string) -- [REQUIRED]
Unique identifier of a field.
name (string) --
Name of the field group.
string
[REQUIRED]
The unique identifier of the Cases domain.
string
[REQUIRED]
The unique identifier of the layout.
string
The name of the layout. It must be unique per domain.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists cases for a given contact.
See also: AWS API Documentation
Request Syntax
client.list_cases_for_contact(
contactArn='string',
domainId='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
A unique identifier of a contact in Amazon Connect.
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
{
'cases': [
{
'caseId': 'string',
'templateId': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
cases (list) --
A list of Case summary information.
(dict) --
Case summary information.
caseId (string) --
A unique identifier of the case.
templateId (string) --
A unique identifier of a template.
nextToken (string) --
The token for the next set of results. This is null if there are no more results to return.
API for adding case event publishing configuration
See also: AWS API Documentation
Request Syntax
client.put_case_event_configuration(
domainId='string',
eventBridge={
'enabled': True|False,
'includedData': {
'caseData': {
'fields': [
{
'id': 'string'
},
]
},
'relatedItemData': {
'includeContent': True|False
}
}
}
)
string
[REQUIRED]
The unique identifier of the Cases domain.
dict
[REQUIRED]
Configuration to enable EventBridge case event delivery and determine what data is delivered.
enabled (boolean) -- [REQUIRED]
Indicates whether the to broadcast case event data to the customer.
includedData (dict) --
Details of what case and related item data is published through the case event stream.
caseData (dict) --
Details of what case data is published through the case event stream.
fields (list) -- [REQUIRED]
List of field identifiers.
(dict) --
Object for unique identifier of a field.
id (string) -- [REQUIRED]
Unique identifier of a field.
relatedItemData (dict) --
Details of what related item data is published through the case event stream.
includeContent (boolean) -- [REQUIRED]
Details of what related item data is published through the case event stream.
dict
Response Syntax
{}
Response Structure
(dict) --
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'
}
},
]
}
}
},
'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.
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) --
Returns the case event publishing configuration.
See also: AWS API Documentation
Request Syntax
client.get_case_event_configuration(
domainId='string'
)
string
[REQUIRED]
The unique identifier of the Cases domain.
dict
Response Syntax
{
'eventBridge': {
'enabled': True|False,
'includedData': {
'caseData': {
'fields': [
{
'id': 'string'
},
]
},
'relatedItemData': {
'includeContent': True|False
}
}
}
}
Response Structure
(dict) --
eventBridge (dict) --
Configuration to enable EventBridge case event delivery and determine what data is delivered.
enabled (boolean) --
Indicates whether the to broadcast case event data to the customer.
includedData (dict) --
Details of what case and related item data is published through the case event stream.
caseData (dict) --
Details of what case data is published through the case event stream.
fields (list) --
List of field identifiers.
(dict) --
Object for unique identifier of a field.
id (string) --
Unique identifier of a field.
relatedItemData (dict) --
Details of what related item data is published through the case event stream.
includeContent (boolean) --
Details of what related item data is published through the case event stream.
Creates a case in the specified Cases domain. Case system and custom fields are taken as an array id/value pairs with a declared data types.
Note
customer_id is a required field when creating a case.
See also: AWS API Documentation
Request Syntax
client.create_case(
clientToken='string',
domainId='string',
fields=[
{
'id': 'string',
'value': {
'booleanValue': True|False,
'doubleValue': 123.0,
'stringValue': 'string'
}
},
],
templateId='string'
)
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
[REQUIRED]
The unique identifier of the Cases domain.
list
[REQUIRED]
An array of objects with field ID (matching ListFields/DescribeField) and value union data.
(dict) --
Object for case field values.
id (string) -- [REQUIRED]
Unique identifier of a field.
value (dict) -- [REQUIRED]
Union of potential field value types.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: booleanValue, doubleValue, stringValue.
booleanValue (boolean) --
Can be either null, or have a Boolean value type. Only one value can be provided.
doubleValue (float) --
Can be either null, or have a Double number value type. Only one value can be provided.
stringValue (string) --
String value type.
string
[REQUIRED]
A unique identifier of a template.
dict
Response Syntax
{
'caseArn': 'string',
'caseId': 'string'
}
Response Structure
(dict) --
caseArn (string) --
The Amazon Resource Name (ARN) of the case.
caseId (string) --
A unique identifier of the case.
Updates the values of fields on a case. Fields to be updated are received as an array of id/value pairs identical to the CreateCase input .
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
See also: AWS API Documentation
Request Syntax
client.update_case(
caseId='string',
domainId='string',
fields=[
{
'id': 'string',
'value': {
'booleanValue': True|False,
'doubleValue': 123.0,
'stringValue': 'string'
}
},
]
)
string
[REQUIRED]
A unique identifier of the case.
string
[REQUIRED]
The unique identifier of the Cases domain.
list
[REQUIRED]
An array of objects with fieldId (matching ListFields/DescribeField) and value union data, structured identical to CreateCase .
(dict) --
Object for case field values.
id (string) -- [REQUIRED]
Unique identifier of a field.
value (dict) -- [REQUIRED]
Union of potential field value types.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: booleanValue, doubleValue, stringValue.
booleanValue (boolean) --
Can be either null, or have a Boolean value type. Only one value can be provided.
doubleValue (float) --
Can be either null, or have a Double number value type. Only one value can be provided.
stringValue (string) --
String value type.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates a layout in the Cases domain. Layouts define the following configuration in the top section and More Info tab of the Cases user interface:
Fields to display to the users
Field ordering
Note
Title and Status fields cannot be part of layouts since they are not configurable.
See also: AWS API Documentation
Request Syntax
client.create_layout(
content={
'basic': {
'moreInfo': {
'sections': [
{
'fieldGroup': {
'fields': [
{
'id': 'string'
},
],
'name': 'string'
}
},
]
},
'topPanel': {
'sections': [
{
'fieldGroup': {
'fields': [
{
'id': 'string'
},
],
'name': 'string'
}
},
]
}
}
},
domainId='string',
name='string'
)
dict
[REQUIRED]
Information about which fields will be present in the layout, and information about the order of the fields.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: basic.
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 can be set: fieldGroup.
fieldGroup (dict) --
Consists of a group of fields and associated properties.
fields (list) -- [REQUIRED]
Represents an ordered list containing field related information.
(dict) --
Object for field related information.
id (string) -- [REQUIRED]
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 can be set: fieldGroup.
fieldGroup (dict) --
Consists of a group of fields and associated properties.
fields (list) -- [REQUIRED]
Represents an ordered list containing field related information.
(dict) --
Object for field related information.
id (string) -- [REQUIRED]
Unique identifier of a field.
name (string) --
Name of the field group.
string
[REQUIRED]
The unique identifier of the Cases domain.
string
[REQUIRED]
The name of the layout. It must be unique for the Cases domain.
dict
Response Syntax
{
'layoutArn': 'string',
'layoutId': 'string'
}
Response Structure
(dict) --
layoutArn (string) --
The Amazon Resource Name (ARN) of the newly created layout.
layoutId (string) --
The unique identifier of the layout.
Adds tags to a resource.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
arn='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN)
dict
[REQUIRED]
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) --
None
Creates a related item (comments, tasks, and contacts) and associates it with a case.
Note
A Related Item is a resource that is associated with a case. It may or may not have an external identifier linking it to an external resource (for example, a contactArn ). All Related Items have their own internal identifier, the relatedItemArn . Examples of related items include comments and contacts .
See also: AWS API Documentation
Request Syntax
client.create_related_item(
caseId='string',
content={
'comment': {
'body': 'string',
'contentType': 'Text/Plain'
},
'contact': {
'contactArn': 'string'
}
},
domainId='string',
type='Contact'|'Comment'
)
string
[REQUIRED]
A unique identifier of the case.
dict
[REQUIRED]
The content of a related item to be created.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: comment, contact.
comment (dict) --
Represents the content of a comment to be returned to agents.
body (string) -- [REQUIRED]
Text in the body of a Comment on a case.
contentType (string) -- [REQUIRED]
Type of the text in the box of a Comment on a case.
contact (dict) --
Object representing a contact in Amazon Connect as an API request field.
contactArn (string) -- [REQUIRED]
A unique identifier of a contact in Amazon Connect.
string
[REQUIRED]
The unique identifier of the Cases domain.
string
[REQUIRED]
The type of a related item.
dict
Response Syntax
{
'relatedItemArn': 'string',
'relatedItemId': 'string'
}
Response Structure
(dict) --
relatedItemArn (string) --
The Amazon Resource Name (ARN) of the related item.
relatedItemId (string) --
The unique identifier of the related item.
Returns information about a specific domain if it exists.
See also: AWS API Documentation
Request Syntax
client.get_domain(
domainId='string'
)
string
[REQUIRED]
The unique identifier of the Cases domain.
dict
Response Syntax
{
'createdTime': datetime(2015, 1, 1),
'domainArn': 'string',
'domainId': 'string',
'domainStatus': 'Active'|'CreationInProgress'|'CreationFailed',
'name': 'string',
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
createdTime (datetime) --
The timestamp when the Cases domain was created.
domainArn (string) --
The Amazon Resource Name (ARN) for the Cases domain.
domainId (string) --
The unique identifier of the Cases domain.
domainStatus (string) --
The status of the Cases domain.
name (string) --
The name of the Cases domain.
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) --
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': [
{
'description': 'string',
'fieldArn': 'string',
'fieldId': 'string',
'name': 'string',
'namespace': 'System'|'Custom',
'tags': {
'string': 'string'
},
'type': 'Text'|'Number'|'Boolean'|'DateTime'|'SingleSelect'
},
]
}
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.
description (string) --
Description of the field.
fieldArn (string) --
The Amazon Resource Name (ARN) of the field.
fieldId (string) --
Unique identifier of the field.
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.
Lists all of the field options for a field identifier in the domain.
See also: AWS API Documentation
Request Syntax
client.list_field_options(
domainId='string',
fieldId='string',
maxResults=123,
nextToken='string',
values=[
'string',
]
)
string
[REQUIRED]
The unique identifier of the Cases domain.
string
[REQUIRED]
The unique identifier of a field.
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.
list
A list of FieldOption values to filter on for ListFieldOptions .
(string) --
dict
Response Syntax
{
'nextToken': 'string',
'options': [
{
'active': True|False,
'name': 'string',
'value': '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.
options (list) --
A list of FieldOption objects.
(dict) --
Object for field Options information.
active (boolean) --
Describes whether the FieldOption is active (displayed) or inactive.
name (string) --
FieldOptionName has max length 100 and disallows trailing spaces.
value (string) --
FieldOptionValue has max length 100 and must be alphanumeric with hyphens and underscores.
Lists tags for a resource.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN)
dict
Response Syntax
{
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
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) --