Skip to content

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


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

Class: ListJobSchedulersCommand

Lists all evaluation job schedules.

Example

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

import { GenAiEvaluationToolkitClient, ListJobSchedulersCommand } from "@awssolutions/gen-ai-evaluation-toolkit-ts-client"; // ES Modules import
// const { GenAiEvaluationToolkitClient, ListJobSchedulersCommand } = 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 = { // ListJobSchedulersInput
  maxResults: Number("int"),
  nextToken: "STRING_VALUE",
};
const command = new ListJobSchedulersCommand(input);
const response = await client.send(command);
// { // ListJobSchedulersOutput
//   nextToken: "STRING_VALUE",
//   jobSchedulers: [ // JobSchedulerSummaryList // required
//     { // JobSchedulerSummary
//       name: "STRING_VALUE", // required
//       createdAt: new Date("TIMESTAMP"), // required
//     },
//   ],
// };

Param

ListJobSchedulersCommandInput

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 ListJobSchedulersCommand(input): ListJobSchedulersCommand

Parameters

input

ListJobSchedulersCommandInput

Returns

ListJobSchedulersCommand

Inherited from

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

Constructor

new ListJobSchedulersCommand(...__namedParameters): ListJobSchedulersCommand

Parameters

__namedParameters

[] | [ListJobSchedulersCommandInput]

Returns

ListJobSchedulersCommand

Inherited from

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