- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
UpdateContactEvaluationCommand
Updates details about a contact evaluation in the specified Amazon Connect instance. A contact evaluation must be in draft state. Answers included in the request are merged with existing answers for the given evaluation. An answer or note can be deleted by passing an empty object ({}
) to the question identifier.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { ConnectClient, UpdateContactEvaluationCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, UpdateContactEvaluationCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // UpdateContactEvaluationRequest
InstanceId: "STRING_VALUE", // required
EvaluationId: "STRING_VALUE", // required
Answers: { // EvaluationAnswersInputMap
"<keys>": { // EvaluationAnswerInput
Value: { // EvaluationAnswerData Union: only one key present
StringValue: "STRING_VALUE",
NumericValue: Number("double"),
NotApplicable: true || false,
},
},
},
Notes: { // EvaluationNotesMap
"<keys>": { // EvaluationNote
Value: "STRING_VALUE",
},
},
};
const command = new UpdateContactEvaluationCommand(input);
const response = await client.send(command);
// { // UpdateContactEvaluationResponse
// EvaluationId: "STRING_VALUE", // required
// EvaluationArn: "STRING_VALUE", // required
// };
UpdateContactEvaluationCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
EvaluationId Required | string | undefined | A unique identifier for the contact evaluation. |
InstanceId Required | string | undefined | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. |
Answers | Record<string, EvaluationAnswerInput> | undefined | A map of question identifiers to answer value. |
Notes | Record<string, EvaluationNote> | undefined | A map of question identifiers to note value. |
UpdateContactEvaluationCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
EvaluationArn Required | string | undefined | The Amazon Resource Name (ARN) for the contact evaluation resource. |
EvaluationId Required | string | undefined | A unique identifier for the contact evaluation. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
InternalServiceException | server | Request processing failed because of an error or failure with the service. |
InvalidParameterException | client | One or more of the specified parameters are not valid. |
ResourceConflictException | client | A resource already has that name. |
ResourceNotFoundException | client | The specified resource was not found. |
ThrottlingException | client | The throttling limit has been exceeded. |
ConnectServiceException | Base exception class for all service exceptions from Connect service. |