- 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.
ListEvaluationFormVersionsCommand
Lists versions of an evaluation form in the specified Amazon Connect instance.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { ConnectClient, ListEvaluationFormVersionsCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, ListEvaluationFormVersionsCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // ListEvaluationFormVersionsRequest
InstanceId: "STRING_VALUE", // required
EvaluationFormId: "STRING_VALUE", // required
MaxResults: Number("int"),
NextToken: "STRING_VALUE",
};
const command = new ListEvaluationFormVersionsCommand(input);
const response = await client.send(command);
// { // ListEvaluationFormVersionsResponse
// EvaluationFormVersionSummaryList: [ // EvaluationFormVersionSummaryList // required
// { // EvaluationFormVersionSummary
// EvaluationFormArn: "STRING_VALUE", // required
// EvaluationFormId: "STRING_VALUE", // required
// EvaluationFormVersion: Number("int"), // required
// Locked: true || false, // required
// Status: "DRAFT" || "ACTIVE", // required
// CreatedTime: new Date("TIMESTAMP"), // required
// CreatedBy: "STRING_VALUE", // required
// LastModifiedTime: new Date("TIMESTAMP"), // required
// LastModifiedBy: "STRING_VALUE", // required
// },
// ],
// NextToken: "STRING_VALUE",
// };
ListEvaluationFormVersionsCommand Input
Parameter | Type | Description |
---|
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. |
MaxResults | number | undefined | The maximum number of results to return per page. |
NextToken | string | undefined | The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. |
ListEvaluationFormVersionsCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
EvaluationFormVersionSummaryList Required | EvaluationFormVersionSummary[] | undefined | Provides details about a list of evaluation forms belonging to an instance. |
NextToken | string | undefined | If there are additional results, this is the token for the next set of results. |
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. |
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. |