Gen AI Evaluation Toolkit on AWS

v2.0.0

Copyright © 2026 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon’s trademarks and trade dress may not be used in connection with any product or service that is not Amazon’s, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon.

Table of contents

• Class: ArchiveAnnotationSchemaCommand
  • Example
  • Param
  • See
  • Throws
  • Throws
  • Throws
  • Throws
  • Throws
  • Throws
  • Extends
  • Constructors

@awssolutions/gen-ai-evaluation-toolkit-ts-client

---

@awssolutions/gen-ai-evaluation-toolkit-ts-client / ArchiveAnnotationSchemaCommand

Class: ArchiveAnnotationSchemaCommand

Mark or unmark an annotation schema as archived to prevent or allow further use

Example

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

import { GenAiEvaluationToolkitClient, ArchiveAnnotationSchemaCommand } from "@awssolutions/gen-ai-evaluation-toolkit-ts-client"; // ES Modules import
// const { GenAiEvaluationToolkitClient, ArchiveAnnotationSchemaCommand } = require("@awssolutions/gen-ai-evaluation-toolkit-ts-client"); // CommonJS import
// import type { GenAiEvaluationToolkitClientConfig } from "@awssolutions/gen-ai-evaluation-toolkit-ts-client";
const config = {}; // type is GenAiEvaluationToolkitClientConfig
const client = new GenAiEvaluationToolkitClient(config);
const input = { // ArchiveAnnotationSchemaRequest
  annotationName: "STRING_VALUE", // required
  restore: true || false,
};
const command = new ArchiveAnnotationSchemaCommand(input);
const response = await client.send(command);
// { // AnnotationSchema
//   name: "STRING_VALUE", // required
//   description: "STRING_VALUE",
//   valueType: { // AnnotationValueType Union: only one key present
//     numericType: {},
//     stringType: { // StringConfigurations
//       enum: [ // StringList // required
//         "STRING_VALUE",
//       ],
//     },
//   },
//   isArchived: true || false,
//   createdBy: "STRING_VALUE",
//   createdAt: new Date("TIMESTAMP"),
// };

Param

ArchiveAnnotationSchemaCommandInput

See

• ArchiveAnnotationSchemaCommandInput for command's input shape.
• ArchiveAnnotationSchemaCommandOutput for command's response shape.
• config for GenAiEvaluationToolkitClient's config shape.

Throws

ValidationException (client fault) A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

Throws

UnauthorizedException (client fault) UnauthorizedException is thrown when request is missing or has bad auth

Throws

ThrottlingException (client fault) ThrottlingException is thrown when request was denied due to request throttling

Throws

InternalServerException (server fault) InternalServerException is thrown when unexpected error occurs during processing of request

Throws

ResourceNotFoundException (client fault) ResourceNotFoundException is thrown when request references a resource which does not exist

Throws

GenAiEvaluationToolkitServiceException

Base exception class for all service exceptions from GenAiEvaluationToolkit service.

Extends

• CommandImpl\<ArchiveAnnotationSchemaCommandInput, ArchiveAnnotationSchemaCommandOutput, GenAiEvaluationToolkitClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes, this>

Constructors

Constructor

new ArchiveAnnotationSchemaCommand(input): ArchiveAnnotationSchemaCommand

Parameters

input

ArchiveAnnotationSchemaCommandInput

Returns

ArchiveAnnotationSchemaCommand

Inherited from

$Command .classBuilder< ArchiveAnnotationSchemaCommandInput, ArchiveAnnotationSchemaCommandOutput, GenAiEvaluationToolkitClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes >() .ep(commonParams) .m(function (this: any, Command: any, cs: any, config: GenAiEvaluationToolkitClientResolvedConfig, o: any) { return [getEndpointPlugin(config, Command.getEndpointParameterInstructions())]; }) .s("GenAiEtk", "ArchiveAnnotationSchema", {}) .n("GenAiEvaluationToolkitClient", "ArchiveAnnotationSchemaCommand") .sc(ArchiveAnnotationSchema$) .build().constructor

Constructor

new ArchiveAnnotationSchemaCommand(...__namedParameters): ArchiveAnnotationSchemaCommand

Parameters

__namedParameters

...[ArchiveAnnotationSchemaCommandInput]

Returns

ArchiveAnnotationSchemaCommand

Inherited from

$Command .classBuilder< ArchiveAnnotationSchemaCommandInput, ArchiveAnnotationSchemaCommandOutput, GenAiEvaluationToolkitClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes >() .ep(commonParams) .m(function (this: any, Command: any, cs: any, config: GenAiEvaluationToolkitClientResolvedConfig, o: any) { return [getEndpointPlugin(config, Command.getEndpointParameterInstructions())]; }) .s("GenAiEtk", "ArchiveAnnotationSchema", {}) .n("GenAiEvaluationToolkitClient", "ArchiveAnnotationSchemaCommand") .sc(ArchiveAnnotationSchema$) .build().constructor