Skip to content

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


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

Class: ListReportsCommand

List all reports. Default maxResults is 50 if not specified.

Example

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

import { GenAiEvaluationToolkitClient, ListReportsCommand } from "@awssolutions/gen-ai-evaluation-toolkit-ts-client"; // ES Modules import
// const { GenAiEvaluationToolkitClient, ListReportsCommand } = 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 = { // ListReportsInput
  maxResults: Number("int"),
  nextToken: "STRING_VALUE",
};
const command = new ListReportsCommand(input);
const response = await client.send(command);
// { // ListReportsOutput
//   nextToken: "STRING_VALUE",
//   reports: [ // ReportList // required
//     { // Report
//       reportId: "STRING_VALUE", // required
//       name: "STRING_VALUE", // required
//       description: "STRING_VALUE",
//       experimentName: "STRING_VALUE",
//       status: "ACTIVE" || "DELETING", // required
//       jobIds: [ // JobIdList
//         "STRING_VALUE",
//       ],
//       metadata: { // ReportMetadata
//         "<keys>": "DOCUMENT_VALUE",
//       },
//       createdAt: new Date("TIMESTAMP"),
//       updatedAt: new Date("TIMESTAMP"),
//     },
//   ],
// };

Param

ListReportsCommandInput

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

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

GenAiEvaluationToolkitServiceException

Base exception class for all service exceptions from GenAiEvaluationToolkit service.

Extends

Constructors

Constructor

new ListReportsCommand(input): ListReportsCommand

Parameters

input

ListReportsCommandInput

Returns

ListReportsCommand

Inherited from

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

Constructor

new ListReportsCommand(...__namedParameters): ListReportsCommand

Parameters

__namedParameters

[] | [ListReportsCommandInput]

Returns

ListReportsCommand

Inherited from

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