ConnectCases ************ Client ====== class ConnectCases.Client A low-level client representing Amazon Connect Cases (ConnectCases) * Cases actions * Cases data types With Amazon Connect Cases, your agents can track and manage customer issues that require multiple interactions, follow-up tasks, and teams in your contact center. A case represents a customer issue. It records the issue, the steps and interactions taken to resolve the issue, and the outcome. For more information, see Amazon Connect Cases in the *Amazon Connect Administrator Guide*. import boto3 client = boto3.client('connectcases') These are the available methods: * batch_get_case_rule * batch_get_field * batch_put_field_options * can_paginate * close * create_case * create_case_rule * create_domain * create_field * create_layout * create_related_item * create_template * delete_case * delete_case_rule * delete_domain * delete_field * delete_layout * delete_related_item * delete_template * get_case * get_case_audit_events * get_case_event_configuration * get_domain * get_layout * get_paginator * get_template * get_waiter * list_case_rules * list_cases_for_contact * list_domains * list_field_options * list_fields * list_layouts * list_tags_for_resource * list_templates * put_case_event_configuration * search_cases * search_related_items * tag_resource * untag_resource * update_case * update_case_rule * update_field * update_layout * update_template Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListCaseRules * SearchCases * SearchRelatedItems ConnectCases / Paginator / ListCaseRules ListCaseRules ************* class ConnectCases.Paginator.ListCaseRules paginator = client.get_paginator('list_case_rules') paginate(**kwargs) Creates an iterator that will paginate through responses from "ConnectCases.Client.list_case_rules()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( domainId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **domainId** (*string*) -- **[REQUIRED]** Unique identifier of a Cases domain. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'caseRules': [ { 'caseRuleArn': 'string', 'caseRuleId': 'string', 'description': 'string', 'name': 'string', 'ruleType': 'Required' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **caseRules** *(list) --* A list of field summary objects. * *(dict) --* Summary information of this case rule. 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. * **caseRuleArn** *(string) --* The Amazon Resource Name (ARN) of the case rule. * **caseRuleId** *(string) --* Unique identifier of a case rule. * **description** *(string) --* Description of a case rule. * **name** *(string) --* Name of the case rule. * **ruleType** *(string) --* Possible types for a rule. * **NextToken** *(string) --* A token to resume pagination. ConnectCases / Paginator / SearchCases SearchCases *********** class ConnectCases.Paginator.SearchCases paginator = client.get_paginator('search_cases') paginate(**kwargs) Creates an iterator that will paginate through responses from "ConnectCases.Client.search_cases()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( domainId='string', fields=[ { 'id': 'string' }, ], filter={ 'andAll': [ {'... recursive ...'}, ], 'field': { 'contains': { 'id': 'string', 'value': { 'booleanValue': True|False, 'doubleValue': 123.0, 'emptyValue': {} , 'stringValue': 'string', 'userArnValue': 'string' } }, 'equalTo': { 'id': 'string', 'value': { 'booleanValue': True|False, 'doubleValue': 123.0, 'emptyValue': {} , 'stringValue': 'string', 'userArnValue': 'string' } }, 'greaterThan': { 'id': 'string', 'value': { 'booleanValue': True|False, 'doubleValue': 123.0, 'emptyValue': {} , 'stringValue': 'string', 'userArnValue': 'string' } }, 'greaterThanOrEqualTo': { 'id': 'string', 'value': { 'booleanValue': True|False, 'doubleValue': 123.0, 'emptyValue': {} , 'stringValue': 'string', 'userArnValue': 'string' } }, 'lessThan': { 'id': 'string', 'value': { 'booleanValue': True|False, 'doubleValue': 123.0, 'emptyValue': {} , 'stringValue': 'string', 'userArnValue': 'string' } }, 'lessThanOrEqualTo': { 'id': 'string', 'value': { 'booleanValue': True|False, 'doubleValue': 123.0, 'emptyValue': {} , 'stringValue': 'string', 'userArnValue': 'string' } } }, 'not': {'... recursive ...'}, 'orAll': [ {'... recursive ...'}, ] }, searchTerm='string', sorts=[ { 'fieldId': 'string', 'sortOrder': 'Asc'|'Desc' }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **domainId** (*string*) -- **[REQUIRED]** The unique identifier of the Cases domain. * **fields** (*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. * **filter** (*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", "orAll". * **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", "orAll". * **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", "emptyValue", "stringValue", "userArnValue". * **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. * **emptyValue** *(dict) --* An empty value. * **stringValue** *(string) --* String value type. * **userArnValue** *(string) --* Represents the user that performed the audit. * **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", "emptyValue", "stringValue", "userArnValue". * **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. * **emptyValue** *(dict) --* An empty value. * **stringValue** *(string) --* String value type. * **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. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "booleanValue", "doubleValue", "emptyValue", "stringValue", "userArnValue". * **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. * **emptyValue** *(dict) --* An empty value. * **stringValue** *(string) --* String value type. * **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. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "booleanValue", "doubleValue", "emptyValue", "stringValue", "userArnValue". * **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. * **emptyValue** *(dict) --* An empty value. * **stringValue** *(string) --* String value type. * **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. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "booleanValue", "doubleValue", "emptyValue", "stringValue", "userArnValue". * **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. * **emptyValue** *(dict) --* An empty value. * **stringValue** *(string) --* String value type. * **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. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "booleanValue", "doubleValue", "emptyValue", "stringValue", "userArnValue". * **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. * **emptyValue** *(dict) --* An empty value. * **stringValue** *(string) --* String value type. * **userArnValue** *(string) --* Represents the user that performed the audit. * **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", "orAll". * **orAll** *(list) --* Provides "or 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", "orAll". * **searchTerm** (*string*) -- A word or phrase used to perform a quick search. * **sorts** (*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 * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'cases': [ { 'caseId': 'string', 'fields': [ { 'id': 'string', 'value': { 'booleanValue': True|False, 'doubleValue': 123.0, 'emptyValue': {}, 'stringValue': 'string', 'userArnValue': '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", "emptyValue", "stringValue", "userArnValue". 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. * **emptyValue** *(dict) --* An empty value. * **stringValue** *(string) --* String value type. * **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) --* * **templateId** *(string) --* A unique identifier of a template. * **NextToken** *(string) --* A token to resume pagination. ConnectCases / Paginator / SearchRelatedItems SearchRelatedItems ****************** class ConnectCases.Paginator.SearchRelatedItems paginator = client.get_paginator('search_related_items') paginate(**kwargs) Creates an iterator that will paginate through responses from "ConnectCases.Client.search_related_items()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( caseId='string', domainId='string', filters=[ { 'comment': {} , 'contact': { 'channel': [ 'string', ], 'contactArn': 'string' }, 'file': { 'fileArn': 'string' }, 'sla': { 'name': 'string', 'status': 'Active'|'Overdue'|'Met'|'NotMet' } }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **caseId** (*string*) -- **[REQUIRED]** A unique identifier of the case. * **domainId** (*string*) -- **[REQUIRED]** The unique identifier of the Cases domain. * **filters** (*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", "file", "sla". * **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. * **file** *(dict) --* A filter for related items of this type of "File". * **fileArn** *(string) --* The Amazon Resource Name (ARN) of the file. * **sla** *(dict) --* Filter for related items of type "SLA". * **name** *(string) --* Name of an SLA. * **status** *(string) --* Status of an SLA. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'relatedItems': [ { 'associationTime': datetime(2015, 1, 1), 'content': { 'comment': { 'body': 'string', 'contentType': 'Text/Plain' }, 'contact': { 'channel': 'string', 'connectedToSystemTime': datetime(2015, 1, 1), 'contactArn': 'string' }, 'file': { 'fileArn': 'string' }, 'sla': { 'slaConfiguration': { 'completionTime': datetime(2015, 1, 1), 'fieldId': 'string', 'name': 'string', 'status': 'Active'|'Overdue'|'Met'|'NotMet', 'targetFieldValues': [ { 'booleanValue': True|False, 'doubleValue': 123.0, 'emptyValue': {}, 'stringValue': 'string', 'userArnValue': 'string' }, ], 'targetTime': datetime(2015, 1, 1), 'type': 'CaseField' } } }, 'performedBy': { 'customEntity': 'string', 'userArn': 'string' }, 'relatedItemId': 'string', 'tags': { 'string': 'string' }, 'type': 'Contact'|'Comment'|'File'|'Sla' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **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", "file", "sla". 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. * **file** *(dict) --* Represents the content of a File to be returned to agents. * **fileArn** *(string) --* The Amazon Resource Name (ARN) of a File in Amazon Connect. * **sla** *(dict) --* Represents the content of an SLA to be returned to agents. * **slaConfiguration** *(dict) --* Represents an SLA configuration. * **completionTime** *(datetime) --* Time at which an SLA was completed. * **fieldId** *(string) --* Unique identifier of a field. * **name** *(string) --* Name of an SLA. * **status** *(string) --* Status of an SLA. * **targetFieldValues** *(list) --* Represents a list of target field values for the fieldId specified in SlaConfiguration. * *(dict) --* Object to store union of Field values. Note: The "Summary" system field accepts 3000 characters while all other fields accept 500 characters. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "booleanValue", "doubleValue", "emptyValue", "stringValue", "userArnValue". 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. * **emptyValue** *(dict) --* An empty value. * **stringValue** *(string) --* String value type. * **userArnValue** *(string) --* Represents the user that performed the audit. * **targetTime** *(datetime) --* Target time by which an SLA should be completed. * **type** *(string) --* Type of SLA. * **performedBy** *(dict) --* Represents the creator of the related item. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "customEntity", "userArn". 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'} * **customEntity** *(string) --* Any provided entity. * **userArn** *(string) --* Represents the Amazon Connect ARN of the user. * **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. * **NextToken** *(string) --* A token to resume pagination. ConnectCases / Client / get_paginator get_paginator ************* ConnectCases.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. ConnectCases / Client / delete_field delete_field ************ ConnectCases.Client.delete_field(**kwargs) 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** response = client.delete_field( domainId='string', fieldId='string' ) Parameters: * **domainId** (*string*) -- **[REQUIRED]** The unique identifier of the Cases domain. * **fieldId** (*string*) -- **[REQUIRED]** Unique identifier of the 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" * "ConnectCases.Client.exceptions.ServiceQuotaExceededException" ConnectCases / Client / delete_template delete_template *************** ConnectCases.Client.delete_template(**kwargs) Deletes a cases template. You can delete up to 100 templates per domain. After a cases template is deleted: * You can still retrieve the template by calling "GetTemplate". * You cannot update the template. * You cannot create a case by using the deleted template. * Deleted templates are not included in the "ListTemplates" response. See also: AWS API Documentation **Request Syntax** response = client.delete_template( domainId='string', templateId='string' ) Parameters: * **domainId** (*string*) -- **[REQUIRED]** The unique identifier of the Cases domain. * **templateId** (*string*) -- **[REQUIRED]** A unique identifier of a template. 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" ConnectCases / Client / list_domains list_domains ************ ConnectCases.Client.list_domains(**kwargs) 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** response = client.list_domains( maxResults=123, nextToken='string' ) Parameters: * **maxResults** (*integer*) -- The maximum number of results to return per page. * **nextToken** (*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. Return type: dict Returns: **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. **Exceptions** * "ConnectCases.Client.exceptions.InternalServerException" * "ConnectCases.Client.exceptions.ValidationException" * "ConnectCases.Client.exceptions.ThrottlingException" * "ConnectCases.Client.exceptions.AccessDeniedException" ConnectCases / Client / create_case create_case *********** ConnectCases.Client.create_case(**kwargs) Note: If you provide a value for "PerformedBy.UserArn" you must also have connect:DescribeUser permission on the User ARN resource that you provide 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. The following fields are required when creating a case: * "customer_id" - You must provide the full customer profile ARN in this format: "arn:aws:profile:your_AWS_Region:your_AWS_account ID:domains/your_profiles_domain_name/profiles/profile_ID" * "title" See also: AWS API Documentation **Request Syntax** response = client.create_case( clientToken='string', domainId='string', fields=[ { 'id': 'string', 'value': { 'booleanValue': True|False, 'doubleValue': 123.0, 'emptyValue': {} , 'stringValue': 'string', 'userArnValue': 'string' } }, ], performedBy={ 'customEntity': 'string', 'userArn': 'string' }, templateId='string' ) Parameters: * **clientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. * **domainId** (*string*) -- **[REQUIRED]** The unique identifier of the Cases domain. * **fields** (*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", "emptyValue", "stringValue", "userArnValue". * **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. * **emptyValue** *(dict) --* An empty value. * **stringValue** *(string) --* String value type. * **userArnValue** *(string) --* Represents the user that performed the audit. * **performedBy** (*dict*) -- Represents the entity that performed the action. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "customEntity", "userArn". * **customEntity** *(string) --* Any provided entity. * **userArn** *(string) --* Represents the Amazon Connect ARN of the user. * **templateId** (*string*) -- **[REQUIRED]** A unique identifier of a template. Return type: dict Returns: **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. **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" ConnectCases / Client / can_paginate can_paginate ************ ConnectCases.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. ConnectCases / Client / delete_case delete_case *********** ConnectCases.Client.delete_case(**kwargs) The DeleteCase API permanently deletes a case and all its associated resources from the cases data store. After a successful deletion, you cannot: * Retrieve related items * Access audit history * Perform any operations that require the CaseID Warning: This action is irreversible. Once you delete a case, you cannot recover its data. See also: AWS API Documentation **Request Syntax** response = client.delete_case( caseId='string', domainId='string' ) Parameters: * **caseId** (*string*) -- **[REQUIRED]** A unique identifier of the case. * **domainId** (*string*) -- **[REQUIRED]** A unique identifier of the Cases domain. 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 / search_related_items search_related_items ******************** ConnectCases.Client.search_related_items(**kwargs) 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** response = client.search_related_items( caseId='string', domainId='string', filters=[ { 'comment': {} , 'contact': { 'channel': [ 'string', ], 'contactArn': 'string' }, 'file': { 'fileArn': 'string' }, 'sla': { 'name': 'string', 'status': 'Active'|'Overdue'|'Met'|'NotMet' } }, ], maxResults=123, nextToken='string' ) Parameters: * **caseId** (*string*) -- **[REQUIRED]** A unique identifier of the case. * **domainId** (*string*) -- **[REQUIRED]** The unique identifier of the Cases domain. * **filters** (*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", "file", "sla". * **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. * **file** *(dict) --* A filter for related items of this type of "File". * **fileArn** *(string) --* The Amazon Resource Name (ARN) of the file. * **sla** *(dict) --* Filter for related items of type "SLA". * **name** *(string) --* Name of an SLA. * **status** *(string) --* Status of an SLA. * **maxResults** (*integer*) -- The maximum number of results to return per page. * **nextToken** (*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. Return type: dict Returns: **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' }, 'file': { 'fileArn': 'string' }, 'sla': { 'slaConfiguration': { 'completionTime': datetime(2015, 1, 1), 'fieldId': 'string', 'name': 'string', 'status': 'Active'|'Overdue'|'Met'|'NotMet', 'targetFieldValues': [ { 'booleanValue': True|False, 'doubleValue': 123.0, 'emptyValue': {}, 'stringValue': 'string', 'userArnValue': 'string' }, ], 'targetTime': datetime(2015, 1, 1), 'type': 'CaseField' } } }, 'performedBy': { 'customEntity': 'string', 'userArn': 'string' }, 'relatedItemId': 'string', 'tags': { 'string': 'string' }, 'type': 'Contact'|'Comment'|'File'|'Sla' }, ] } **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", "file", "sla". 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. * **file** *(dict) --* Represents the content of a File to be returned to agents. * **fileArn** *(string) --* The Amazon Resource Name (ARN) of a File in Amazon Connect. * **sla** *(dict) --* Represents the content of an SLA to be returned to agents. * **slaConfiguration** *(dict) --* Represents an SLA configuration. * **completionTime** *(datetime) --* Time at which an SLA was completed. * **fieldId** *(string) --* Unique identifier of a field. * **name** *(string) --* Name of an SLA. * **status** *(string) --* Status of an SLA. * **targetFieldValues** *(list) --* Represents a list of target field values for the fieldId specified in SlaConfiguration. * *(dict) --* Object to store union of Field values. Note: The "Summary" system field accepts 3000 characters while all other fields accept 500 characters. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "booleanValue", "doubleValue", "emptyValue", "stringValue", "userArnValue". 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. * **emptyValue** *(dict) --* An empty value. * **stringValue** *(string) --* String value type. * **userArnValue** *(string) --* Represents the user that performed the audit. * **targetTime** *(datetime) --* Target time by which an SLA should be completed. * **type** *(string) --* Type of SLA. * **performedBy** *(dict) --* Represents the creator of the related item. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "customEntity", "userArn". 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'} * **customEntity** *(string) --* Any provided entity. * **userArn** *(string) --* Represents the Amazon Connect ARN of the user. * **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. **Exceptions** * "ConnectCases.Client.exceptions.InternalServerException" * "ConnectCases.Client.exceptions.ResourceNotFoundException" * "ConnectCases.Client.exceptions.ValidationException" * "ConnectCases.Client.exceptions.ThrottlingException" * "ConnectCases.Client.exceptions.AccessDeniedException" ConnectCases / Client / delete_related_item delete_related_item ******************* ConnectCases.Client.delete_related_item(**kwargs) Deletes the related item resource under a case. Note: This API cannot be used on a FILE type related attachment. To delete this type of file, use the DeleteAttachedFile API See also: AWS API Documentation **Request Syntax** response = client.delete_related_item( caseId='string', domainId='string', relatedItemId='string' ) Parameters: * **caseId** (*string*) -- **[REQUIRED]** A unique identifier of the case. * **domainId** (*string*) -- **[REQUIRED]** A unique identifier of the Cases domain. * **relatedItemId** (*string*) -- **[REQUIRED]** A unique identifier of a related item. 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 / batch_get_case_rule batch_get_case_rule ******************* ConnectCases.Client.batch_get_case_rule(**kwargs) Gets a batch of case rules. 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. See also: AWS API Documentation **Request Syntax** response = client.batch_get_case_rule( caseRules=[ { 'id': 'string' }, ], domainId='string' ) Parameters: * **caseRules** (*list*) -- **[REQUIRED]** List of case rule identifiers. * *(dict) --* Object containing case rule identifier information. * **id** *(string) --* **[REQUIRED]** Unique identifier of a case rule. * **domainId** (*string*) -- **[REQUIRED]** Unique identifier of a Cases domain. Return type: dict Returns: **Response Syntax** { 'caseRules': [ { 'caseRuleArn': 'string', 'caseRuleId': 'string', 'createdTime': datetime(2015, 1, 1), 'deleted': True|False, 'description': 'string', 'lastModifiedTime': datetime(2015, 1, 1), 'name': 'string', 'rule': { 'required': { 'conditions': [ { 'equalTo': { 'operandOne': { 'fieldId': 'string' }, 'operandTwo': { 'booleanValue': True|False, 'doubleValue': 123.0, 'emptyValue': {}, 'stringValue': 'string' }, 'result': True|False }, 'notEqualTo': { 'operandOne': { 'fieldId': 'string' }, 'operandTwo': { 'booleanValue': True|False, 'doubleValue': 123.0, 'emptyValue': {}, 'stringValue': 'string' }, 'result': True|False } }, ], 'defaultValue': True|False } }, 'tags': { 'string': 'string' } }, ], 'errors': [ { 'errorCode': 'string', 'id': 'string', 'message': 'string' }, ] } **Response Structure** * *(dict) --* * **caseRules** *(list) --* List of detailed case rule information. * *(dict) --* Detailed case rule information. 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. * **caseRuleArn** *(string) --* The Amazon Resource Name (ARN) of the case rule. * **caseRuleId** *(string) --* Unique identifier of a case rule. * **createdTime** *(datetime) --* Timestamp when the resource was created. * **deleted** *(boolean) --* Indicates whether the resource has been deleted. * **description** *(string) --* Description of a case rule. * **lastModifiedTime** *(datetime) --* Timestamp when the resource was created or last modified. * **name** *(string) --* Name of the case rule. * **rule** *(dict) --* Represents what rule type should take place, under what conditions. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "required". 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'} * **required** *(dict) --* Required rule type, used to indicate whether a field is required. * **conditions** *(list) --* List of conditions for the required rule; the first condition to evaluate to true dictates the value of the rule. * *(dict) --* Boolean condition for a rule. 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. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "equalTo", "notEqualTo". 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'} * **equalTo** *(dict) --* Tests that operandOne is equal to operandTwo. * **operandOne** *(dict) --* Represents the left hand operand in the condition. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "fieldId". 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'} * **fieldId** *(string) --* The field ID that this operand should take the value of. * **operandTwo** *(dict) --* Represents the right hand operand in the condition. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "booleanValue", "doubleValue", "emptyValue", "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) --* Boolean value type. * **doubleValue** *(float) --* Double value type. * **emptyValue** *(dict) --* Empty value type. * **stringValue** *(string) --* String value type. * **result** *(boolean) --* The value of the outer rule if the condition evaluates to true. * **notEqualTo** *(dict) --* Tests that operandOne is not equal to operandTwo. * **operandOne** *(dict) --* Represents the left hand operand in the condition. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "fieldId". 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'} * **fieldId** *(string) --* The field ID that this operand should take the value of. * **operandTwo** *(dict) --* Represents the right hand operand in the condition. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "booleanValue", "doubleValue", "emptyValue", "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) --* Boolean value type. * **doubleValue** *(float) --* Double value type. * **emptyValue** *(dict) --* Empty value type. * **stringValue** *(string) --* String value type. * **result** *(boolean) --* The value of the outer rule if the condition evaluates to true. * **defaultValue** *(boolean) --* The value of the rule (that is, whether the field is required) should none of the conditions evaluate to true. * **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) --* * **errors** *(list) --* List of case rule errors. * *(dict) --* Error for batch describe case rules API failure. 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. * **errorCode** *(string) --* Error code from getting a case rule. * **id** *(string) --* The case rule identifier that caused the error. * **message** *(string) --* Error message from getting a case rule. **Exceptions** * "ConnectCases.Client.exceptions.InternalServerException" * "ConnectCases.Client.exceptions.ResourceNotFoundException" * "ConnectCases.Client.exceptions.ValidationException" * "ConnectCases.Client.exceptions.ThrottlingException" * "ConnectCases.Client.exceptions.AccessDeniedException" ConnectCases / Client / list_fields list_fields *********** ConnectCases.Client.list_fields(**kwargs) Lists all fields in a Cases domain. See also: AWS API Documentation **Request Syntax** response = client.list_fields( domainId='string', maxResults=123, nextToken='string' ) Parameters: * **domainId** (*string*) -- **[REQUIRED]** The unique identifier of the Cases domain. * **maxResults** (*integer*) -- The maximum number of results to return per page. * **nextToken** (*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. Return type: dict Returns: **Response Syntax** { 'fields': [ { 'fieldArn': 'string', 'fieldId': 'string', 'name': 'string', 'namespace': 'System'|'Custom', 'type': 'Text'|'Number'|'Boolean'|'DateTime'|'SingleSelect'|'Url'|'User' }, ], '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. **Exceptions** * "ConnectCases.Client.exceptions.InternalServerException" * "ConnectCases.Client.exceptions.ResourceNotFoundException" * "ConnectCases.Client.exceptions.ValidationException" * "ConnectCases.Client.exceptions.ThrottlingException" * "ConnectCases.Client.exceptions.AccessDeniedException" ConnectCases / Client / list_tags_for_resource list_tags_for_resource ********************** ConnectCases.Client.list_tags_for_resource(**kwargs) Lists tags for a resource. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( arn='string' ) Parameters: **arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) Return type: dict Returns: **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) --* **Exceptions** * "ConnectCases.Client.exceptions.InternalServerException" * "ConnectCases.Client.exceptions.ResourceNotFoundException" * "ConnectCases.Client.exceptions.ValidationException" * "ConnectCases.Client.exceptions.ThrottlingException" * "ConnectCases.Client.exceptions.AccessDeniedException" ConnectCases / Client / create_domain create_domain ************* ConnectCases.Client.create_domain(**kwargs) 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. You need specific IAM permissions to successfully associate the Cases domain. For more information, see Onboard to Cases. See also: AWS API Documentation **Request Syntax** response = client.create_domain( name='string' ) Parameters: **name** (*string*) -- **[REQUIRED]** The name for your Cases domain. It must be unique for your Amazon Web Services account. Return type: dict Returns: **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. **Exceptions** * "ConnectCases.Client.exceptions.InternalServerException" * "ConnectCases.Client.exceptions.ValidationException" * "ConnectCases.Client.exceptions.ThrottlingException" * "ConnectCases.Client.exceptions.AccessDeniedException" * "ConnectCases.Client.exceptions.ConflictException" * "ConnectCases.Client.exceptions.ServiceQuotaExceededException" ConnectCases / Client / get_case get_case ******** ConnectCases.Client.get_case(**kwargs) Returns information about a specific case if it exists. See also: AWS API Documentation **Request Syntax** response = client.get_case( caseId='string', domainId='string', fields=[ { 'id': 'string' }, ], nextToken='string' ) Parameters: * **caseId** (*string*) -- **[REQUIRED]** A unique identifier of the case. * **domainId** (*string*) -- **[REQUIRED]** The unique identifier of the Cases domain. * **fields** (*list*) -- **[REQUIRED]** A list of unique field identifiers. * *(dict) --* Object for unique identifier of a field. * **id** *(string) --* **[REQUIRED]** Unique identifier of a field. * **nextToken** (*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. Return type: dict Returns: **Response Syntax** { 'fields': [ { 'id': 'string', 'value': { 'booleanValue': True|False, 'doubleValue': 123.0, 'emptyValue': {}, 'stringValue': 'string', 'userArnValue': '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", "emptyValue", "stringValue", "userArnValue". 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. * **emptyValue** *(dict) --* An empty value. * **stringValue** *(string) --* String value type. * **userArnValue** *(string) --* Represents the user that performed the audit. * **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. **Exceptions** * "ConnectCases.Client.exceptions.InternalServerException" * "ConnectCases.Client.exceptions.ResourceNotFoundException" * "ConnectCases.Client.exceptions.ValidationException" * "ConnectCases.Client.exceptions.ThrottlingException" * "ConnectCases.Client.exceptions.AccessDeniedException" ConnectCases / Client / untag_resource untag_resource ************** ConnectCases.Client.untag_resource(**kwargs) Untags a resource. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( arn='string', tagKeys=[ 'string', ] ) Parameters: * **arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) * **tagKeys** (*list*) -- **[REQUIRED]** List of tag keys. * *(string) --* Returns: None **Exceptions** * "ConnectCases.Client.exceptions.InternalServerException" * "ConnectCases.Client.exceptions.ResourceNotFoundException" * "ConnectCases.Client.exceptions.ValidationException" * "ConnectCases.Client.exceptions.ThrottlingException" * "ConnectCases.Client.exceptions.AccessDeniedException" ConnectCases / Client / delete_domain delete_domain ************* ConnectCases.Client.delete_domain(**kwargs) Deletes a Cases domain. Note: After deleting your domain you must disassociate the deleted domain from your Amazon Connect instance with another API call before being able to use Cases again with this Amazon Connect instance. See DeleteIntegrationAssociation. See also: AWS API Documentation **Request Syntax** response = client.delete_domain( domainId='string' ) Parameters: **domainId** (*string*) -- **[REQUIRED]** The unique identifier of the Cases domain. 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" ConnectCases / Client / list_field_options list_field_options ****************** ConnectCases.Client.list_field_options(**kwargs) Lists all of the field options for a field identifier in the domain. See also: AWS API Documentation **Request Syntax** response = client.list_field_options( domainId='string', fieldId='string', maxResults=123, nextToken='string', values=[ 'string', ] ) Parameters: * **domainId** (*string*) -- **[REQUIRED]** The unique identifier of the Cases domain. * **fieldId** (*string*) -- **[REQUIRED]** The unique identifier of a field. * **maxResults** (*integer*) -- The maximum number of results to return per page. * **nextToken** (*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. * **values** (*list*) -- A list of "FieldOption" values to filter on for "ListFieldOptions". * *(string) --* Return type: dict Returns: **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. **Exceptions** * "ConnectCases.Client.exceptions.InternalServerException" * "ConnectCases.Client.exceptions.ResourceNotFoundException" * "ConnectCases.Client.exceptions.ValidationException" * "ConnectCases.Client.exceptions.ThrottlingException" * "ConnectCases.Client.exceptions.AccessDeniedException" ConnectCases / Client / update_case update_case *********** ConnectCases.Client.update_case(**kwargs) Note: If you provide a value for "PerformedBy.UserArn" you must also have connect:DescribeUser permission on the User ARN resource that you provide 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** response = client.update_case( caseId='string', domainId='string', fields=[ { 'id': 'string', 'value': { 'booleanValue': True|False, 'doubleValue': 123.0, 'emptyValue': {} , 'stringValue': 'string', 'userArnValue': 'string' } }, ], performedBy={ 'customEntity': 'string', 'userArn': 'string' } ) Parameters: * **caseId** (*string*) -- **[REQUIRED]** A unique identifier of the case. * **domainId** (*string*) -- **[REQUIRED]** The unique identifier of the Cases domain. * **fields** (*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", "emptyValue", "stringValue", "userArnValue". * **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. * **emptyValue** *(dict) --* An empty value. * **stringValue** *(string) --* String value type. * **userArnValue** *(string) --* Represents the user that performed the audit. * **performedBy** (*dict*) -- Represents the entity that performed the action. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "customEntity", "userArn". * **customEntity** *(string) --* Any provided entity. * **userArn** *(string) --* Represents the Amazon Connect ARN of the user. 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 / get_layout get_layout ********** ConnectCases.Client.get_layout(**kwargs) Returns the details for the requested layout. See also: AWS API Documentation **Request Syntax** response = client.get_layout( domainId='string', layoutId='string' ) Parameters: * **domainId** (*string*) -- **[REQUIRED]** The unique identifier of the Cases domain. * **layoutId** (*string*) -- **[REQUIRED]** The unique identifier of the layout. Return type: dict Returns: **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) --* Timestamp at which the resource was created. * **deleted** *(boolean) --* Denotes whether or not the resource has been deleted. * **lastModifiedTime** *(datetime) --* Timestamp at which 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) --* **Exceptions** * "ConnectCases.Client.exceptions.InternalServerException" * "ConnectCases.Client.exceptions.ResourceNotFoundException" * "ConnectCases.Client.exceptions.ValidationException" * "ConnectCases.Client.exceptions.ThrottlingException" * "ConnectCases.Client.exceptions.AccessDeniedException" ConnectCases / Client / get_waiter get_waiter ********** ConnectCases.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" ConnectCases / Client / get_case_audit_events get_case_audit_events ********************* ConnectCases.Client.get_case_audit_events(**kwargs) Returns the audit history about a specific case if it exists. See also: AWS API Documentation **Request Syntax** response = client.get_case_audit_events( caseId='string', domainId='string', maxResults=123, nextToken='string' ) Parameters: * **caseId** (*string*) -- **[REQUIRED]** A unique identifier of the case. * **domainId** (*string*) -- **[REQUIRED]** The unique identifier of the Cases domain. * **maxResults** (*integer*) -- The maximum number of audit events to return. The current maximum supported value is 25. This is also the default when no other value is provided. * **nextToken** (*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. Return type: dict Returns: **Response Syntax** { 'auditEvents': [ { 'eventId': 'string', 'fields': [ { 'eventFieldId': 'string', 'newValue': { 'booleanValue': True|False, 'doubleValue': 123.0, 'emptyValue': {}, 'stringValue': 'string', 'userArnValue': 'string' }, 'oldValue': { 'booleanValue': True|False, 'doubleValue': 123.0, 'emptyValue': {}, 'stringValue': 'string', 'userArnValue': 'string' } }, ], 'performedBy': { 'iamPrincipalArn': 'string', 'user': { 'customEntity': 'string', 'userArn': 'string' } }, 'performedTime': datetime(2015, 1, 1), 'relatedItemType': 'Contact'|'Comment'|'File'|'Sla', 'type': 'Case.Created'|'Case.Updated'|'RelatedItem.Created' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **auditEvents** *(list) --* A list of case audits where each represents a particular edit of the case. * *(dict) --* Represents the content of a particular audit event. * **eventId** *(string) --* Unique identifier of a case audit history event. * **fields** *(list) --* A list of Case Audit History event fields. * *(dict) --* Fields for audit event. * **eventFieldId** *(string) --* Unique identifier of field in an Audit History entry. * **newValue** *(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", "emptyValue", "stringValue", "userArnValue". 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 value type. Only one value can be provided. * **emptyValue** *(dict) --* An empty value. You cannot set "EmptyFieldValue" on a field that is required on a case template. This structure will never have any data members. It signifies an empty value on a case field. * **stringValue** *(string) --* Can be either null, or have a String value type. Only one value can be provided. * **userArnValue** *(string) --* Can be either null, or have a String value type formatted as an ARN. Only one value can be provided. * **oldValue** *(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", "emptyValue", "stringValue", "userArnValue". 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 value type. Only one value can be provided. * **emptyValue** *(dict) --* An empty value. You cannot set "EmptyFieldValue" on a field that is required on a case template. This structure will never have any data members. It signifies an empty value on a case field. * **stringValue** *(string) --* Can be either null, or have a String value type. Only one value can be provided. * **userArnValue** *(string) --* Can be either null, or have a String value type formatted as an ARN. Only one value can be provided. * **performedBy** *(dict) --* Information of the user which performed the audit. * **iamPrincipalArn** *(string) --* Unique identifier of an IAM role. * **user** *(dict) --* Represents the entity that performed the action. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "customEntity", "userArn". 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'} * **customEntity** *(string) --* Any provided entity. * **userArn** *(string) --* Represents the Amazon Connect ARN of the user. * **performedTime** *(datetime) --* Time at which an Audit History event took place. * **relatedItemType** *(string) --* The Type of the related item. * **type** *(string) --* The Type of an audit history event. * **nextToken** *(string) --* The token for the next set of results. This is null if there are no more results to return. **Exceptions** * "ConnectCases.Client.exceptions.InternalServerException" * "ConnectCases.Client.exceptions.ResourceNotFoundException" * "ConnectCases.Client.exceptions.ValidationException" * "ConnectCases.Client.exceptions.ThrottlingException" * "ConnectCases.Client.exceptions.AccessDeniedException" ConnectCases / Client / list_cases_for_contact list_cases_for_contact ********************** ConnectCases.Client.list_cases_for_contact(**kwargs) Lists cases for a given contact. See also: AWS API Documentation **Request Syntax** response = client.list_cases_for_contact( contactArn='string', domainId='string', maxResults=123, nextToken='string' ) Parameters: * **contactArn** (*string*) -- **[REQUIRED]** A unique identifier of a contact in Amazon Connect. * **domainId** (*string*) -- **[REQUIRED]** The unique identifier of the Cases domain. * **maxResults** (*integer*) -- The maximum number of results to return per page. * **nextToken** (*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. Return type: dict Returns: **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. **Exceptions** * "ConnectCases.Client.exceptions.InternalServerException" * "ConnectCases.Client.exceptions.ResourceNotFoundException" * "ConnectCases.Client.exceptions.ValidationException" * "ConnectCases.Client.exceptions.ThrottlingException" * "ConnectCases.Client.exceptions.AccessDeniedException" ConnectCases / Client / get_case_event_configuration get_case_event_configuration **************************** ConnectCases.Client.get_case_event_configuration(**kwargs) Returns the case event publishing configuration. See also: AWS API Documentation **Request Syntax** response = client.get_case_event_configuration( domainId='string' ) Parameters: **domainId** (*string*) -- **[REQUIRED]** The unique identifier of the Cases domain. Return type: dict Returns: **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. **Exceptions** * "ConnectCases.Client.exceptions.InternalServerException" * "ConnectCases.Client.exceptions.ResourceNotFoundException" * "ConnectCases.Client.exceptions.ValidationException" * "ConnectCases.Client.exceptions.ThrottlingException" * "ConnectCases.Client.exceptions.AccessDeniedException" ConnectCases / Client / search_cases search_cases ************ ConnectCases.Client.search_cases(**kwargs) Searches for cases within their associated Cases domain. Search results are returned as a paginated list of abridged case documents. Note: For "customer_id" you must provide the full customer profile ARN in this format: "arn:aws:profile:your AWS Region:your AWS account ID:domains/profiles domain name/profiles/profile ID". See also: AWS API Documentation **Request Syntax** response = client.search_cases( domainId='string', fields=[ { 'id': 'string' }, ], filter={ 'andAll': [ {'... recursive ...'}, ], 'field': { 'contains': { 'id': 'string', 'value': { 'booleanValue': True|False, 'doubleValue': 123.0, 'emptyValue': {} , 'stringValue': 'string', 'userArnValue': 'string' } }, 'equalTo': { 'id': 'string', 'value': { 'booleanValue': True|False, 'doubleValue': 123.0, 'emptyValue': {} , 'stringValue': 'string', 'userArnValue': 'string' } }, 'greaterThan': { 'id': 'string', 'value': { 'booleanValue': True|False, 'doubleValue': 123.0, 'emptyValue': {} , 'stringValue': 'string', 'userArnValue': 'string' } }, 'greaterThanOrEqualTo': { 'id': 'string', 'value': { 'booleanValue': True|False, 'doubleValue': 123.0, 'emptyValue': {} , 'stringValue': 'string', 'userArnValue': 'string' } }, 'lessThan': { 'id': 'string', 'value': { 'booleanValue': True|False, 'doubleValue': 123.0, 'emptyValue': {} , 'stringValue': 'string', 'userArnValue': 'string' } }, 'lessThanOrEqualTo': { 'id': 'string', 'value': { 'booleanValue': True|False, 'doubleValue': 123.0, 'emptyValue': {} , 'stringValue': 'string', 'userArnValue': 'string' } } }, 'not': {'... recursive ...'}, 'orAll': [ {'... recursive ...'}, ] }, maxResults=123, nextToken='string', searchTerm='string', sorts=[ { 'fieldId': 'string', 'sortOrder': 'Asc'|'Desc' }, ] ) Parameters: * **domainId** (*string*) -- **[REQUIRED]** The unique identifier of the Cases domain. * **fields** (*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. * **filter** (*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", "orAll". * **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", "orAll". * **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", "emptyValue", "stringValue", "userArnValue". * **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. * **emptyValue** *(dict) --* An empty value. * **stringValue** *(string) --* String value type. * **userArnValue** *(string) --* Represents the user that performed the audit. * **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", "emptyValue", "stringValue", "userArnValue". * **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. * **emptyValue** *(dict) --* An empty value. * **stringValue** *(string) --* String value type. * **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. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "booleanValue", "doubleValue", "emptyValue", "stringValue", "userArnValue". * **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. * **emptyValue** *(dict) --* An empty value. * **stringValue** *(string) --* String value type. * **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. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "booleanValue", "doubleValue", "emptyValue", "stringValue", "userArnValue". * **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. * **emptyValue** *(dict) --* An empty value. * **stringValue** *(string) --* String value type. * **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. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "booleanValue", "doubleValue", "emptyValue", "stringValue", "userArnValue". * **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. * **emptyValue** *(dict) --* An empty value. * **stringValue** *(string) --* String value type. * **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. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "booleanValue", "doubleValue", "emptyValue", "stringValue", "userArnValue". * **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. * **emptyValue** *(dict) --* An empty value. * **stringValue** *(string) --* String value type. * **userArnValue** *(string) --* Represents the user that performed the audit. * **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", "orAll". * **orAll** *(list) --* Provides "or 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", "orAll". * **maxResults** (*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. * **nextToken** (*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. * **searchTerm** (*string*) -- A word or phrase used to perform a quick search. * **sorts** (*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 Return type: dict Returns: **Response Syntax** { 'cases': [ { 'caseId': 'string', 'fields': [ { 'id': 'string', 'value': { 'booleanValue': True|False, 'doubleValue': 123.0, 'emptyValue': {}, 'stringValue': 'string', 'userArnValue': '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", "emptyValue", "stringValue", "userArnValue". 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. * **emptyValue** *(dict) --* An empty value. * **stringValue** *(string) --* String value type. * **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) --* * **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. **Exceptions** * "ConnectCases.Client.exceptions.InternalServerException" * "ConnectCases.Client.exceptions.ResourceNotFoundException" * "ConnectCases.Client.exceptions.ValidationException" * "ConnectCases.Client.exceptions.ThrottlingException" * "ConnectCases.Client.exceptions.AccessDeniedException" ConnectCases / Client / update_case_rule update_case_rule **************** ConnectCases.Client.update_case_rule(**kwargs) Updates a case rule. 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. See also: AWS API Documentation **Request Syntax** response = client.update_case_rule( caseRuleId='string', description='string', domainId='string', name='string', rule={ 'required': { 'conditions': [ { 'equalTo': { 'operandOne': { 'fieldId': 'string' }, 'operandTwo': { 'booleanValue': True|False, 'doubleValue': 123.0, 'emptyValue': {} , 'stringValue': 'string' }, 'result': True|False }, 'notEqualTo': { 'operandOne': { 'fieldId': 'string' }, 'operandTwo': { 'booleanValue': True|False, 'doubleValue': 123.0, 'emptyValue': {} , 'stringValue': 'string' }, 'result': True|False } }, ], 'defaultValue': True|False } } ) Parameters: * **caseRuleId** (*string*) -- **[REQUIRED]** Unique identifier of a case rule. * **description** (*string*) -- Description of a case rule. * **domainId** (*string*) -- **[REQUIRED]** Unique identifier of a Cases domain. * **name** (*string*) -- Name of the case rule. * **rule** (*dict*) -- Represents what rule type should take place, under what conditions. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "required". * **required** *(dict) --* Required rule type, used to indicate whether a field is required. * **conditions** *(list) --* **[REQUIRED]** List of conditions for the required rule; the first condition to evaluate to true dictates the value of the rule. * *(dict) --* Boolean condition for a rule. 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. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "equalTo", "notEqualTo". * **equalTo** *(dict) --* Tests that operandOne is equal to operandTwo. * **operandOne** *(dict) --* **[REQUIRED]** Represents the left hand operand in the condition. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "fieldId". * **fieldId** *(string) --* The field ID that this operand should take the value of. * **operandTwo** *(dict) --* **[REQUIRED]** Represents the right hand operand in the condition. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "booleanValue", "doubleValue", "emptyValue", "stringValue". * **booleanValue** *(boolean) --* Boolean value type. * **doubleValue** *(float) --* Double value type. * **emptyValue** *(dict) --* Empty value type. * **stringValue** *(string) --* String value type. * **result** *(boolean) --* **[REQUIRED]** The value of the outer rule if the condition evaluates to true. * **notEqualTo** *(dict) --* Tests that operandOne is not equal to operandTwo. * **operandOne** *(dict) --* **[REQUIRED]** Represents the left hand operand in the condition. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "fieldId". * **fieldId** *(string) --* The field ID that this operand should take the value of. * **operandTwo** *(dict) --* **[REQUIRED]** Represents the right hand operand in the condition. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "booleanValue", "doubleValue", "emptyValue", "stringValue". * **booleanValue** *(boolean) --* Boolean value type. * **doubleValue** *(float) --* Double value type. * **emptyValue** *(dict) --* Empty value type. * **stringValue** *(string) --* String value type. * **result** *(boolean) --* **[REQUIRED]** The value of the outer rule if the condition evaluates to true. * **defaultValue** *(boolean) --* **[REQUIRED]** The value of the rule (that is, whether the field is required) should none of the conditions evaluate to true. 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" ConnectCases / Client / get_template get_template ************ ConnectCases.Client.get_template(**kwargs) Returns the details for the requested template. Other template APIs are: * CreateTemplate * DeleteTemplate * ListTemplates * UpdateTemplate See also: AWS API Documentation **Request Syntax** response = client.get_template( domainId='string', templateId='string' ) Parameters: * **domainId** (*string*) -- **[REQUIRED]** The unique identifier of the Cases domain. * **templateId** (*string*) -- **[REQUIRED]** A unique identifier of a template. Return type: dict Returns: **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' }, ], 'rules': [ { 'caseRuleId': 'string', 'fieldId': 'string' }, ], 'status': 'Active'|'Inactive', 'tags': { 'string': 'string' }, 'templateArn': 'string', 'templateId': 'string' } **Response Structure** * *(dict) --* * **createdTime** *(datetime) --* Timestamp at which the resource was created. * **deleted** *(boolean) --* Denotes whether or not the resource has been deleted. * **description** *(string) --* A brief description of the template. * **lastModifiedTime** *(datetime) --* Timestamp at which 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. * **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) --* Unique identifier of a case rule. * **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. **Exceptions** * "ConnectCases.Client.exceptions.InternalServerException" * "ConnectCases.Client.exceptions.ResourceNotFoundException" * "ConnectCases.Client.exceptions.ValidationException" * "ConnectCases.Client.exceptions.ThrottlingException" * "ConnectCases.Client.exceptions.AccessDeniedException" ConnectCases / Client / batch_put_field_options batch_put_field_options *********************** ConnectCases.Client.batch_put_field_options(**kwargs) Creates and updates a set of field options for a single select field in a Cases domain. See also: AWS API Documentation **Request Syntax** response = client.batch_put_field_options( domainId='string', fieldId='string', options=[ { 'active': True|False, 'name': 'string', 'value': 'string' }, ] ) Parameters: * **domainId** (*string*) -- **[REQUIRED]** The unique identifier of the Cases domain. * **fieldId** (*string*) -- **[REQUIRED]** The unique identifier of a field. * **options** (*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. Return type: dict Returns: **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. **Exceptions** * "ConnectCases.Client.exceptions.InternalServerException" * "ConnectCases.Client.exceptions.ResourceNotFoundException" * "ConnectCases.Client.exceptions.ValidationException" * "ConnectCases.Client.exceptions.ThrottlingException" * "ConnectCases.Client.exceptions.AccessDeniedException" * "ConnectCases.Client.exceptions.ServiceQuotaExceededException" ConnectCases / Client / update_field update_field ************ ConnectCases.Client.update_field(**kwargs) Updates the properties of an existing field. See also: AWS API Documentation **Request Syntax** response = client.update_field( description='string', domainId='string', fieldId='string', name='string' ) Parameters: * **description** (*string*) -- The description of a field. * **domainId** (*string*) -- **[REQUIRED]** The unique identifier of the Cases domain. * **fieldId** (*string*) -- **[REQUIRED]** The unique identifier of a field. * **name** (*string*) -- The name of the 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" ConnectCases / Client / create_template create_template *************** ConnectCases.Client.create_template(**kwargs) 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. Other template APIs are: * DeleteTemplate * GetTemplate * ListTemplates * UpdateTemplate See also: AWS API Documentation **Request Syntax** response = client.create_template( description='string', domainId='string', layoutConfiguration={ 'defaultLayout': 'string' }, name='string', requiredFields=[ { 'fieldId': 'string' }, ], rules=[ { 'caseRuleId': 'string', 'fieldId': 'string' }, ], status='Active'|'Inactive' ) Parameters: * **description** (*string*) -- A brief description of the template. * **domainId** (*string*) -- **[REQUIRED]** The unique identifier of the Cases domain. * **layoutConfiguration** (*dict*) -- Configuration of layouts associated to the template. * **defaultLayout** *(string) --* Unique identifier of a layout. * **name** (*string*) -- **[REQUIRED]** A name for the template. It must be unique per domain. * **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. * **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. * **status** (*string*) -- The status of the template. Return type: 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. **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" * "ConnectCases.Client.exceptions.ServiceQuotaExceededException" ConnectCases / Client / create_case_rule create_case_rule **************** ConnectCases.Client.create_case_rule(**kwargs) Creates a new case rule. 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. See also: AWS API Documentation **Request Syntax** response = client.create_case_rule( description='string', domainId='string', name='string', rule={ 'required': { 'conditions': [ { 'equalTo': { 'operandOne': { 'fieldId': 'string' }, 'operandTwo': { 'booleanValue': True|False, 'doubleValue': 123.0, 'emptyValue': {} , 'stringValue': 'string' }, 'result': True|False }, 'notEqualTo': { 'operandOne': { 'fieldId': 'string' }, 'operandTwo': { 'booleanValue': True|False, 'doubleValue': 123.0, 'emptyValue': {} , 'stringValue': 'string' }, 'result': True|False } }, ], 'defaultValue': True|False } } ) Parameters: * **description** (*string*) -- The description of a case rule. * **domainId** (*string*) -- **[REQUIRED]** Unique identifier of a Cases domain. * **name** (*string*) -- **[REQUIRED]** Name of the case rule. * **rule** (*dict*) -- **[REQUIRED]** Represents what rule type should take place, under what conditions. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "required". * **required** *(dict) --* Required rule type, used to indicate whether a field is required. * **conditions** *(list) --* **[REQUIRED]** List of conditions for the required rule; the first condition to evaluate to true dictates the value of the rule. * *(dict) --* Boolean condition for a rule. 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. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "equalTo", "notEqualTo". * **equalTo** *(dict) --* Tests that operandOne is equal to operandTwo. * **operandOne** *(dict) --* **[REQUIRED]** Represents the left hand operand in the condition. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "fieldId". * **fieldId** *(string) --* The field ID that this operand should take the value of. * **operandTwo** *(dict) --* **[REQUIRED]** Represents the right hand operand in the condition. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "booleanValue", "doubleValue", "emptyValue", "stringValue". * **booleanValue** *(boolean) --* Boolean value type. * **doubleValue** *(float) --* Double value type. * **emptyValue** *(dict) --* Empty value type. * **stringValue** *(string) --* String value type. * **result** *(boolean) --* **[REQUIRED]** The value of the outer rule if the condition evaluates to true. * **notEqualTo** *(dict) --* Tests that operandOne is not equal to operandTwo. * **operandOne** *(dict) --* **[REQUIRED]** Represents the left hand operand in the condition. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "fieldId". * **fieldId** *(string) --* The field ID that this operand should take the value of. * **operandTwo** *(dict) --* **[REQUIRED]** Represents the right hand operand in the condition. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "booleanValue", "doubleValue", "emptyValue", "stringValue". * **booleanValue** *(boolean) --* Boolean value type. * **doubleValue** *(float) --* Double value type. * **emptyValue** *(dict) --* Empty value type. * **stringValue** *(string) --* String value type. * **result** *(boolean) --* **[REQUIRED]** The value of the outer rule if the condition evaluates to true. * **defaultValue** *(boolean) --* **[REQUIRED]** The value of the rule (that is, whether the field is required) should none of the conditions evaluate to true. Return type: dict Returns: **Response Syntax** { 'caseRuleArn': 'string', 'caseRuleId': 'string' } **Response Structure** * *(dict) --* * **caseRuleArn** *(string) --* The Amazon Resource Name (ARN) of a case rule. * **caseRuleId** *(string) --* Unique identifier of a case rule. **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" * "ConnectCases.Client.exceptions.ServiceQuotaExceededException" ConnectCases / Client / batch_get_field batch_get_field *************** ConnectCases.Client.batch_get_field(**kwargs) Returns the description for the list of fields in the request parameters. See also: AWS API Documentation **Request Syntax** response = client.batch_get_field( domainId='string', fields=[ { 'id': 'string' }, ] ) Parameters: * **domainId** (*string*) -- **[REQUIRED]** The unique identifier of the Cases domain. * **fields** (*list*) -- **[REQUIRED]** A list of unique field identifiers. * *(dict) --* Object for unique identifier of a field. * **id** *(string) --* **[REQUIRED]** Unique identifier of a field. Return type: dict Returns: **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) --* Timestamp at which the resource was created. * **deleted** *(boolean) --* Denotes whether or not 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) --* Timestamp at which 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. **Exceptions** * "ConnectCases.Client.exceptions.InternalServerException" * "ConnectCases.Client.exceptions.ResourceNotFoundException" * "ConnectCases.Client.exceptions.ValidationException" * "ConnectCases.Client.exceptions.ThrottlingException" * "ConnectCases.Client.exceptions.AccessDeniedException" ConnectCases / Client / list_layouts list_layouts ************ ConnectCases.Client.list_layouts(**kwargs) 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** response = client.list_layouts( domainId='string', maxResults=123, nextToken='string' ) Parameters: * **domainId** (*string*) -- **[REQUIRED]** The unique identifier of the Cases domain. * **maxResults** (*integer*) -- The maximum number of results to return per page. * **nextToken** (*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. Return type: dict Returns: **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. **Exceptions** * "ConnectCases.Client.exceptions.InternalServerException" * "ConnectCases.Client.exceptions.ResourceNotFoundException" * "ConnectCases.Client.exceptions.ValidationException" * "ConnectCases.Client.exceptions.ThrottlingException" * "ConnectCases.Client.exceptions.AccessDeniedException" ConnectCases / Client / close close ***** ConnectCases.Client.close() Closes underlying endpoint connections. 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: * CreateTemplate * DeleteTemplate * GetTemplate * ListTemplates See also: AWS API Documentation **Request Syntax** response = client.update_template( description='string', domainId='string', layoutConfiguration={ 'defaultLayout': 'string' }, name='string', requiredFields=[ { 'fieldId': 'string' }, ], rules=[ { 'caseRuleId': 'string', 'fieldId': 'string' }, ], status='Active'|'Inactive', templateId='string' ) Parameters: * **description** (*string*) -- A brief description of the template. * **domainId** (*string*) -- **[REQUIRED]** The unique identifier of the Cases domain. * **layoutConfiguration** (*dict*) -- Configuration of layouts associated to the template. * **defaultLayout** *(string) --* Unique identifier of a layout. * **name** (*string*) -- The name of the template. It must be unique per domain. * **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. * **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. * **status** (*string*) -- The status of the template. * **templateId** (*string*) -- **[REQUIRED]** A unique identifier for the template. 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" ConnectCases / Client / list_case_rules list_case_rules *************** ConnectCases.Client.list_case_rules(**kwargs) Lists all case rules in a Cases domain. 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. See also: AWS API Documentation **Request Syntax** response = client.list_case_rules( domainId='string', maxResults=123, nextToken='string' ) Parameters: * **domainId** (*string*) -- **[REQUIRED]** Unique identifier of a Cases domain. * **maxResults** (*integer*) -- The maximum number of results to return per page. * **nextToken** (*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. Return type: dict Returns: **Response Syntax** { 'caseRules': [ { 'caseRuleArn': 'string', 'caseRuleId': 'string', 'description': 'string', 'name': 'string', 'ruleType': 'Required' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **caseRules** *(list) --* A list of field summary objects. * *(dict) --* Summary information of this case rule. 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. * **caseRuleArn** *(string) --* The Amazon Resource Name (ARN) of the case rule. * **caseRuleId** *(string) --* Unique identifier of a case rule. * **description** *(string) --* Description of a case rule. * **name** *(string) --* Name of the case rule. * **ruleType** *(string) --* Possible types for a rule. * **nextToken** *(string) --* The token for the next set of results. This is null if there are no more results to return. **Exceptions** * "ConnectCases.Client.exceptions.InternalServerException" * "ConnectCases.Client.exceptions.ResourceNotFoundException" * "ConnectCases.Client.exceptions.ValidationException" * "ConnectCases.Client.exceptions.ThrottlingException" * "ConnectCases.Client.exceptions.AccessDeniedException" ConnectCases / Client / delete_layout delete_layout ************* ConnectCases.Client.delete_layout(**kwargs) Deletes a layout from a cases template. You can delete up to 100 layouts per domain. After a layout is deleted: * You can still retrieve the layout by calling "GetLayout". * You cannot update a deleted layout by calling "UpdateLayout"; it throws a "ValidationException". * Deleted layouts are not included in the "ListLayouts" response. See also: AWS API Documentation **Request Syntax** response = client.delete_layout( domainId='string', layoutId='string' ) Parameters: * **domainId** (*string*) -- **[REQUIRED]** The unique identifier of the Cases domain. * **layoutId** (*string*) -- **[REQUIRED]** The unique identifier of the layout. 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" ConnectCases / Client / create_layout create_layout ************* ConnectCases.Client.create_layout(**kwargs) 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** response = 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' ) Parameters: * **content** (*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. * **domainId** (*string*) -- **[REQUIRED]** The unique identifier of the Cases domain. * **name** (*string*) -- **[REQUIRED]** The name of the layout. It must be unique for the Cases domain. Return type: dict Returns: **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. **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" * "ConnectCases.Client.exceptions.ServiceQuotaExceededException" ConnectCases / Client / create_field create_field ************ ConnectCases.Client.create_field(**kwargs) 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** response = client.create_field( description='string', domainId='string', name='string', type='Text'|'Number'|'Boolean'|'DateTime'|'SingleSelect'|'Url'|'User' ) Parameters: * **description** (*string*) -- The description of the field. * **domainId** (*string*) -- **[REQUIRED]** The unique identifier of the Cases domain. * **name** (*string*) -- **[REQUIRED]** The name of the field. * **type** (*string*) -- **[REQUIRED]** Defines the data type, some system constraints, and default display of the field. Return type: dict Returns: **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. **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" * "ConnectCases.Client.exceptions.ServiceQuotaExceededException" ConnectCases / Client / tag_resource tag_resource ************ ConnectCases.Client.tag_resource(**kwargs) Adds tags to a resource. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( arn='string', tags={ 'string': 'string' } ) Parameters: * **arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) * **tags** (*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) --* Returns: None **Exceptions** * "ConnectCases.Client.exceptions.InternalServerException" * "ConnectCases.Client.exceptions.ResourceNotFoundException" * "ConnectCases.Client.exceptions.ValidationException" * "ConnectCases.Client.exceptions.ThrottlingException" * "ConnectCases.Client.exceptions.AccessDeniedException" ConnectCases / Client / delete_case_rule delete_case_rule **************** ConnectCases.Client.delete_case_rule(**kwargs) Deletes a case rule. 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. See also: AWS API Documentation **Request Syntax** response = client.delete_case_rule( caseRuleId='string', domainId='string' ) Parameters: * **caseRuleId** (*string*) -- **[REQUIRED]** Unique identifier of a case rule. * **domainId** (*string*) -- **[REQUIRED]** Unique identifier of a Cases domain. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "ConnectCases.Client.exceptions.InternalServerException" * "ConnectCases.Client.exceptions.ResourceNotFoundException" * "ConnectCases.Client.exceptions.ThrottlingException" * "ConnectCases.Client.exceptions.AccessDeniedException" * "ConnectCases.Client.exceptions.ConflictException" ConnectCases / Client / update_layout update_layout ************* ConnectCases.Client.update_layout(**kwargs) 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** response = 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' ) Parameters: * **content** (*dict*) -- Information about which fields will be present in the layout, 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. * **domainId** (*string*) -- **[REQUIRED]** The unique identifier of the Cases domain. * **layoutId** (*string*) -- **[REQUIRED]** The unique identifier of the layout. * **name** (*string*) -- The name of the layout. It must be unique per domain. 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" * "ConnectCases.Client.exceptions.ServiceQuotaExceededException" ConnectCases / Client / get_domain get_domain ********** ConnectCases.Client.get_domain(**kwargs) Returns information about a specific domain if it exists. See also: AWS API Documentation **Request Syntax** response = client.get_domain( domainId='string' ) Parameters: **domainId** (*string*) -- **[REQUIRED]** The unique identifier of the Cases domain. Return type: dict Returns: **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) --* **Exceptions** * "ConnectCases.Client.exceptions.InternalServerException" * "ConnectCases.Client.exceptions.ResourceNotFoundException" * "ConnectCases.Client.exceptions.ValidationException" * "ConnectCases.Client.exceptions.ThrottlingException" * "ConnectCases.Client.exceptions.AccessDeniedException" ConnectCases / Client / put_case_event_configuration put_case_event_configuration **************************** ConnectCases.Client.put_case_event_configuration(**kwargs) Adds case event publishing configuration. For a complete list of fields you can add to the event message, see Create case fields in the *Amazon Connect Administrator Guide* See also: AWS API Documentation **Request Syntax** response = client.put_case_event_configuration( domainId='string', eventBridge={ 'enabled': True|False, 'includedData': { 'caseData': { 'fields': [ { 'id': 'string' }, ] }, 'relatedItemData': { 'includeContent': True|False } } } ) Parameters: * **domainId** (*string*) -- **[REQUIRED]** The unique identifier of the Cases domain. * **eventBridge** (*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. 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" ConnectCases / Client / list_templates list_templates ************** ConnectCases.Client.list_templates(**kwargs) Lists all of the templates in a Cases domain. Each list item is a condensed summary object of the template. Other template APIs are: * CreateTemplate * DeleteTemplate * GetTemplate * UpdateTemplate See also: AWS API Documentation **Request Syntax** response = client.list_templates( domainId='string', maxResults=123, nextToken='string', status=[ 'Active'|'Inactive', ] ) Parameters: * **domainId** (*string*) -- **[REQUIRED]** The unique identifier of the Cases domain. * **maxResults** (*integer*) -- The maximum number of results to return per page. * **nextToken** (*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. * **status** (*list*) -- A list of status values to filter on. * *(string) --* Return type: 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. **Exceptions** * "ConnectCases.Client.exceptions.InternalServerException" * "ConnectCases.Client.exceptions.ResourceNotFoundException" * "ConnectCases.Client.exceptions.ValidationException" * "ConnectCases.Client.exceptions.ThrottlingException" * "ConnectCases.Client.exceptions.AccessDeniedException" ConnectCases / Client / create_related_item create_related_item ******************* ConnectCases.Client.create_related_item(**kwargs) 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". * If you provide a value for "performedBy.userArn" you must also have DescribeUser permission on the ARN of the user that you provide. * The "type" field is reserved for internal use only. See also: AWS API Documentation **Request Syntax** response = client.create_related_item( caseId='string', content={ 'comment': { 'body': 'string', 'contentType': 'Text/Plain' }, 'contact': { 'contactArn': 'string' }, 'file': { 'fileArn': 'string' }, 'sla': { 'slaInputConfiguration': { 'fieldId': 'string', 'name': 'string', 'targetFieldValues': [ { 'booleanValue': True|False, 'doubleValue': 123.0, 'emptyValue': {} , 'stringValue': 'string', 'userArnValue': 'string' }, ], 'targetSlaMinutes': 123, 'type': 'CaseField' } } }, domainId='string', performedBy={ 'customEntity': 'string', 'userArn': 'string' }, type='Contact'|'Comment'|'File'|'Sla' ) Parameters: * **caseId** (*string*) -- **[REQUIRED]** A unique identifier of the case. * **content** (*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", "file", "sla". * **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. * **file** *(dict) --* A file of related items. * **fileArn** *(string) --* **[REQUIRED]** The Amazon Resource Name (ARN) of a File in Amazon Connect. * **sla** *(dict) --* Represents the content of an SLA to be created. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "slaInputConfiguration". * **slaInputConfiguration** *(dict) --* Represents an input SLA configuration. * **fieldId** *(string) --* Unique identifier of a field. * **name** *(string) --* **[REQUIRED]** Name of an SLA. * **targetFieldValues** *(list) --* Represents a list of target field values for the fieldId specified in SlaInputConfiguration. The SLA is considered met if any one of these target field values matches the actual field value. * *(dict) --* Object to store union of Field values. Note: The "Summary" system field accepts 3000 characters while all other fields accept 500 characters. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "booleanValue", "doubleValue", "emptyValue", "stringValue", "userArnValue". * **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. * **emptyValue** *(dict) --* An empty value. * **stringValue** *(string) --* String value type. * **userArnValue** *(string) --* Represents the user that performed the audit. * **targetSlaMinutes** *(integer) --* **[REQUIRED]** Target duration in minutes within which an SLA should be completed. * **type** *(string) --* **[REQUIRED]** Type of SLA. * **domainId** (*string*) -- **[REQUIRED]** The unique identifier of the Cases domain. * **performedBy** (*dict*) -- Represents the creator of the related item. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "customEntity", "userArn". * **customEntity** *(string) --* Any provided entity. * **userArn** *(string) --* Represents the Amazon Connect ARN of the user. * **type** (*string*) -- **[REQUIRED]** The type of a related item. Return type: dict Returns: **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. **Exceptions** * "ConnectCases.Client.exceptions.InternalServerException" * "ConnectCases.Client.exceptions.ResourceNotFoundException" * "ConnectCases.Client.exceptions.ValidationException" * "ConnectCases.Client.exceptions.ThrottlingException" * "ConnectCases.Client.exceptions.AccessDeniedException" * "ConnectCases.Client.exceptions.ServiceQuotaExceededException"