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.

Request Syntax

response = client.update_case(
    domainId='string',
    caseId='string',
    fields=[
        {
            'id': 'string',
            'value': {
                'stringValue': 'string',
                'doubleValue': 123.0,
                'booleanValue': True|False,
                'emptyValue': {}
                ,
                'userArnValue': 'string'
            }
        },
    ],
    performedBy={
        'userArn': 'string',
        'customEntity': 'string'
    }
)

Parameters:

domainId (string) –
[REQUIRED]

The unique identifier of the Cases domain.
caseId (string) –
[REQUIRED]

A unique identifier of the case.
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: stringValue, doubleValue, booleanValue, emptyValue, userArnValue.
    - stringValue (string) –
      
      String value type.
    - doubleValue (float) –
      
      Can be either null, or have a Double number value type. Only one value can be provided.
    - booleanValue (boolean) –
      
      Can be either null, or have a Boolean value type. Only one value can be provided.
    - emptyValue (dict) –
      
      An empty value.
    - userArnValue (string) –
      
      Represents the user that performed the audit.
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: userArn, customEntity.
- userArn (string) –
  
  Represents the Amazon Connect ARN of the user.
- customEntity (string) –
  
  Any provided entity.

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