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. When no value is provided, 25 is the default. 
- 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', 'auditEvents': [ { 'eventId': 'string', 'type': 'Case.Created'|'Case.Updated'|'RelatedItem.Created', 'relatedItemType': 'Contact'|'Comment'|'File'|'Sla'|'ConnectCase'|'Custom', 'performedTime': datetime(2015, 1, 1), 'fields': [ { 'eventFieldId': 'string', 'oldValue': { 'stringValue': 'string', 'doubleValue': 123.0, 'booleanValue': True|False, 'emptyValue': {}, 'userArnValue': 'string' }, 'newValue': { 'stringValue': 'string', 'doubleValue': 123.0, 'booleanValue': True|False, 'emptyValue': {}, 'userArnValue': 'string' } }, ], 'performedBy': { 'user': { 'userArn': 'string', 'customEntity': 'string' }, 'iamPrincipalArn': '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. 
- 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. 
- type (string) – - The Type of an audit history event. 
- relatedItemType (string) – - The Type of the related item. 
- performedTime (datetime) – - Time at which an Audit History event took place. 
- 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. 
- 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: - stringValue,- doubleValue,- booleanValue,- emptyValue,- userArnValue. If a client receives an unknown member it will set- SDK_UNKNOWN_MEMBERas the top level key, which maps to the name or tag of the unknown member. The structure of- SDK_UNKNOWN_MEMBERis as follows:- 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} - stringValue (string) – - Can be either null, or have a String 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. 
- booleanValue (boolean) – - Can be either null, or have a Boolean value type. Only one value can be provided. 
- emptyValue (dict) – - An empty value. You cannot set - EmptyFieldValueon 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. 
- userArnValue (string) – - Can be either null, or have a String value type formatted as an ARN. Only one value can be provided. 
 
- 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: - stringValue,- doubleValue,- booleanValue,- emptyValue,- userArnValue. If a client receives an unknown member it will set- SDK_UNKNOWN_MEMBERas the top level key, which maps to the name or tag of the unknown member. The structure of- SDK_UNKNOWN_MEMBERis as follows:- 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} - stringValue (string) – - Can be either null, or have a String 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. 
- booleanValue (boolean) – - Can be either null, or have a Boolean value type. Only one value can be provided. 
- emptyValue (dict) – - An empty value. You cannot set - EmptyFieldValueon 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. 
- 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. - 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: - userArn,- customEntity. If a client receives an unknown member it will set- SDK_UNKNOWN_MEMBERas the top level key, which maps to the name or tag of the unknown member. The structure of- SDK_UNKNOWN_MEMBERis as follows:- 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} - userArn (string) – - Represents the Amazon Connect ARN of the user. 
- customEntity (string) – - Any provided entity. 
 
- iamPrincipalArn (string) – - Unique identifier of an IAM role. 
 
 
 
 
 
 - Exceptions- ConnectCases.Client.exceptions.InternalServerException
- ConnectCases.Client.exceptions.ResourceNotFoundException
- ConnectCases.Client.exceptions.ValidationException
- ConnectCases.Client.exceptions.ThrottlingException
- ConnectCases.Client.exceptions.AccessDeniedException