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

`` <p>Updates the values of fields on a case. Fields to be updated are received as an array of id/value pairs identical to the <code>CreateCase</code> input .</p> <p>If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.</p>``

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={
        '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 identity of the person who performed the action.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: userArn.

    • userArn (string) –

      Represents the Amazon Connect ARN of the user.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions