DeleteEvaluationFormCommand

Deletes an evaluation form in the specified Amazon Connect instance.

  • If the version property is provided, only the specified version of the evaluation form is deleted.

  • If no version is provided, then the full form (all versions) is deleted.

Example Syntax

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

import { ConnectClient, DeleteEvaluationFormCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, DeleteEvaluationFormCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // DeleteEvaluationFormRequest
  InstanceId: "STRING_VALUE", // required
  EvaluationFormId: "STRING_VALUE", // required
  EvaluationFormVersion: Number("int"),
};
const command = new DeleteEvaluationFormCommand(input);
const response = await client.send(command);
// {};

DeleteEvaluationFormCommand Input

Parameter
Type
Description
EvaluationFormId
Required
string | undefined

The unique identifier for the evaluation form.

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.

EvaluationFormVersion
number | undefined

The unique identifier for the evaluation form.

DeleteEvaluationFormCommand Output

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

Throws

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.