UpdateCaseCommand

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ConnectCasesClient, UpdateCaseCommand } from "@aws-sdk/client-connectcases"; // ES Modules import
// const { ConnectCasesClient, UpdateCaseCommand } = require("@aws-sdk/client-connectcases"); // CommonJS import
const client = new ConnectCasesClient(config);
const input = { // UpdateCaseRequest
  domainId: "STRING_VALUE", // required
  caseId: "STRING_VALUE", // required
  fields: [ // FieldValueList // required
    { // FieldValue
      id: "STRING_VALUE", // required
      value: { // FieldValueUnion Union: only one key present
        stringValue: "STRING_VALUE",
        doubleValue: Number("double"),
        booleanValue: true || false,
        emptyValue: {},
        userArnValue: "STRING_VALUE",
      },
    },
  ],
  performedBy: { // UserUnion Union: only one key present
    userArn: "STRING_VALUE",
  },
};
const command = new UpdateCaseCommand(input);
const response = await client.send(command);
// {};

UpdateCaseCommand Input

See UpdateCaseCommandInput for more details

Parameter
Type
Description
caseId
Required
string | undefined

A unique identifier of the case.

domainId
Required
string | undefined

The unique identifier of the Cases domain.

fields
Required
FieldValue[] | undefined

An array of objects with fieldId (matching ListFields/DescribeField) and value union data, structured identical to CreateCase.

performedBy
UserUnion | undefined

Represents the identity of the person who performed the action.

UpdateCaseCommand Output

See UpdateCaseCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

InternalServerException
server

We couldn't process your request because of an issue with the server. Try again later.

ResourceNotFoundException
client

We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.

ThrottlingException
client

The rate has been exceeded for this API. Please try again after a few minutes.

ValidationException
client

The request isn't valid. Check the syntax and try again.

ConnectCasesServiceException
Base exception class for all service exceptions from ConnectCases service.