Skip to content

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


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

Class: ListGenerationsCommand

Lists generation jobs with optional filtering

Example

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

import { GenAiEvaluationToolkitClient, ListGenerationsCommand } from "@awssolutions/gen-ai-evaluation-toolkit-ts-client"; // ES Modules import
// const { GenAiEvaluationToolkitClient, ListGenerationsCommand } = 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 = { // ListGenerationsInput
  maxResults: Number("int"),
  nextToken: "STRING_VALUE",
  statusFilter: "RUNNING" || "SUCCEEDED" || "FAILED" || "TIMED_OUT" || "ABORTED" || "PENDING_REDRIVE",
};
const command = new ListGenerationsCommand(input);
const response = await client.send(command);
// { // ListGenerationsOutput
//   nextToken: "STRING_VALUE",
//   jobs: [ // GenerationJobList // required
//     { // GenerationJobListItem
//       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"),
//     },
//   ],
// };

Param

ListGenerationsCommandInput

See

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

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

Constructors

Constructor

new ListGenerationsCommand(input): ListGenerationsCommand

Parameters

input

ListGenerationsCommandInput

Returns

ListGenerationsCommand

Inherited from

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

Constructor

new ListGenerationsCommand(...__namedParameters): ListGenerationsCommand

Parameters

__namedParameters

[] | [ListGenerationsCommandInput]

Returns

ListGenerationsCommand

Inherited from

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