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: StartGenerationCommand
  • Example
  • Param
  • See
  • Throws
  • Throws
  • Throws
  • Throws
  • Extends
  • Constructors

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

---

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

Class: StartGenerationCommand

Starts generation job with specified steps

Example

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

import { GenAiEvaluationToolkitClient, StartGenerationCommand } from "@awssolutions/gen-ai-evaluation-toolkit-ts-client"; // ES Modules import
// const { GenAiEvaluationToolkitClient, StartGenerationCommand } = 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 = { // StartGenerationInput
  experimentName: "STRING_VALUE",
  configVersion: Number("int"),
  steps: [ // GenerationStepList // required
    { // GenerationStep
      plugin: "STRING_VALUE", // required
      configuration: "DOCUMENT_VALUE", // required
    },
  ],
};
const command = new StartGenerationCommand(input);
const response = await client.send(command);
// { // StartGenerationOutput
//   experimentName: "STRING_VALUE",
//   configVersion: Number("int"),
//   steps: [ // GenerationStepList // required
//     { // GenerationStep
//       plugin: "STRING_VALUE", // required
//       configuration: "DOCUMENT_VALUE", // required
//     },
//   ],
//   cause: "STRING_VALUE",
//   error: "STRING_VALUE",
//   id: "STRING_VALUE", // required
//   status: "RUNNING" || "SUCCEEDED" || "FAILED" || "TIMED_OUT" || "ABORTED" || "PENDING_REDRIVE", // required
//   createdAt: new Date("TIMESTAMP"), // required
//   stoppedAt: new Date("TIMESTAMP"),
//   output: "DOCUMENT_VALUE",
// };

Param

StartGenerationCommandInput

See

• StartGenerationCommandInput for command's input shape.
• StartGenerationCommandOutput 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

ExecutionLimitExceeded (client fault) ExecutionLimitExceededException is thrown when too many concurrent stepfunction executions are running

Throws

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

Throws

GenAiEvaluationToolkitServiceException

Base exception class for all service exceptions from GenAiEvaluationToolkit service.

Extends

• CommandImpl\<StartGenerationCommandInput, StartGenerationCommandOutput, GenAiEvaluationToolkitClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes, this>

Constructors

Constructor

new StartGenerationCommand(input): StartGenerationCommand

Parameters

input

StartGenerationCommandInput

Returns

StartGenerationCommand

Inherited from

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

Constructor

new StartGenerationCommand(...__namedParameters): StartGenerationCommand

Parameters

__namedParameters

...[StartGenerationCommandInput]

Returns

StartGenerationCommand

Inherited from

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