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

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

---

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

Class: CreateJobSchedulerCommand

Creates an evaluation job schedule using the supplied job template. The schedule will immediately become active and create new jobs on the supplied cron expression.

Example

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

import { GenAiEvaluationToolkitClient, CreateJobSchedulerCommand } from "@awssolutions/gen-ai-evaluation-toolkit-ts-client"; // ES Modules import
// const { GenAiEvaluationToolkitClient, CreateJobSchedulerCommand } = 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 = { // CreateJobSchedulerInput
  cron: "STRING_VALUE", // required
  jobType: "FULL" || "SCORE" || "APP_INVOKE", // required
  evaluatorName: "STRING_VALUE", // required
  testCases: { // TestDataSource Union: only one key present
    dataset: { // DatasetReference
      datasetId: "STRING_VALUE", // required
      datasetVersion: "STRING_VALUE",
      filter: { // AnnotationConditionExpression Union: only one key present
        condition: { // AnnotationCondition Union: only one key present
          numericCondition: { // NumericAnnotationCondition
            name: "STRING_VALUE", // required
            value: Number("float"), // required
            comparator: "=" || "!=" || "<" || "<=" || ">" || ">=", // required
          },
          stringEnumCondition: { // StringEnumAnnotationCondition
            name: "STRING_VALUE", // required
            value: "STRING_VALUE", // required
            comparator: "=" || "!=", // required
          },
        },
        and: [ // AnnotationConditionExpressionList
          {//  Union: only one key present
            condition: {//  Union: only one key present
              numericCondition: {
                name: "STRING_VALUE", // required
                value: Number("float"), // required
                comparator: "=" || "!=" || "<" || "<=" || ">" || ">=", // required
              },
              stringEnumCondition: {
                name: "STRING_VALUE", // required
                value: "STRING_VALUE", // required
                comparator: "=" || "!=", // required
              },
            },
            and: [
              "<AnnotationConditionExpression>",
            ],
            or: [
              "<AnnotationConditionExpression>",
            ],
            not: "<AnnotationConditionExpression>",
          },
        ],
        or: [
          "<AnnotationConditionExpression>",
        ],
        not: "<AnnotationConditionExpression>",
      },
    },
    inline: [ // InlineTestCaseList
      { // InlineTestCase
        input: "DOCUMENT_VALUE",
        expected: "DOCUMENT_VALUE",
        context: "DOCUMENT_VALUE",
        metadata: "DOCUMENT_VALUE",
      },
    ],
  },
  scorers: { // ScorerMap
    "<keys>": { // ScorerConfig
      params: "DOCUMENT_VALUE",
      scores: { // SubScoreMap
        "<keys>": "DOCUMENT_VALUE",
      },
      evaluatorName: "STRING_VALUE",
    },
  },
  app: { // AppConfig
    name: "STRING_VALUE",
    params: "DOCUMENT_VALUE",
    evaluatorName: "STRING_VALUE",
  },
  sourceReportId: "STRING_VALUE",
  testResults: [ // InlineTestResultList
    { // InlineTestResult
      input: "DOCUMENT_VALUE",
      expected: "DOCUMENT_VALUE",
      context: "DOCUMENT_VALUE",
      metadata: "DOCUMENT_VALUE",
      output: "DOCUMENT_VALUE",
    },
  ],
  experimentName: "STRING_VALUE",
};
const command = new CreateJobSchedulerCommand(input);
const response = await client.send(command);
// { // CreateJobSchedulerOutput
//   name: "STRING_VALUE", // required
//   cron: "STRING_VALUE", // required
//   jobType: "FULL" || "SCORE" || "APP_INVOKE", // required
//   evaluatorName: "STRING_VALUE", // required
//   testCases: { // TestDataSource Union: only one key present
//     dataset: { // DatasetReference
//       datasetId: "STRING_VALUE", // required
//       datasetVersion: "STRING_VALUE",
//       filter: { // AnnotationConditionExpression Union: only one key present
//         condition: { // AnnotationCondition Union: only one key present
//           numericCondition: { // NumericAnnotationCondition
//             name: "STRING_VALUE", // required
//             value: Number("float"), // required
//             comparator: "=" || "!=" || "<" || "<=" || ">" || ">=", // required
//           },
//           stringEnumCondition: { // StringEnumAnnotationCondition
//             name: "STRING_VALUE", // required
//             value: "STRING_VALUE", // required
//             comparator: "=" || "!=", // required
//           },
//         },
//         and: [ // AnnotationConditionExpressionList
//           {//  Union: only one key present
//             condition: {//  Union: only one key present
//               numericCondition: {
//                 name: "STRING_VALUE", // required
//                 value: Number("float"), // required
//                 comparator: "=" || "!=" || "<" || "<=" || ">" || ">=", // required
//               },
//               stringEnumCondition: {
//                 name: "STRING_VALUE", // required
//                 value: "STRING_VALUE", // required
//                 comparator: "=" || "!=", // required
//               },
//             },
//             and: [
//               "<AnnotationConditionExpression>",
//             ],
//             or: [
//               "<AnnotationConditionExpression>",
//             ],
//             not: "<AnnotationConditionExpression>",
//           },
//         ],
//         or: [
//           "<AnnotationConditionExpression>",
//         ],
//         not: "<AnnotationConditionExpression>",
//       },
//     },
//     inline: [ // InlineTestCaseList
//       { // InlineTestCase
//         input: "DOCUMENT_VALUE",
//         expected: "DOCUMENT_VALUE",
//         context: "DOCUMENT_VALUE",
//         metadata: "DOCUMENT_VALUE",
//       },
//     ],
//   },
//   scorers: { // ScorerMap
//     "<keys>": { // ScorerConfig
//       params: "DOCUMENT_VALUE",
//       scores: { // SubScoreMap
//         "<keys>": "DOCUMENT_VALUE",
//       },
//       evaluatorName: "STRING_VALUE",
//     },
//   },
//   app: { // AppConfig
//     name: "STRING_VALUE",
//     params: "DOCUMENT_VALUE",
//     evaluatorName: "STRING_VALUE",
//   },
//   sourceReportId: "STRING_VALUE",
//   testResults: [ // InlineTestResultList
//     { // InlineTestResult
//       input: "DOCUMENT_VALUE",
//       expected: "DOCUMENT_VALUE",
//       context: "DOCUMENT_VALUE",
//       metadata: "DOCUMENT_VALUE",
//       output: "DOCUMENT_VALUE",
//     },
//   ],
//   experimentName: "STRING_VALUE",
//   createdAt: new Date("TIMESTAMP"), // required
// };

Param

CreateJobSchedulerCommandInput

See

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

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\<CreateJobSchedulerCommandInput, CreateJobSchedulerCommandOutput, GenAiEvaluationToolkitClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes, this>

Constructors

Constructor

new CreateJobSchedulerCommand(input): CreateJobSchedulerCommand

Parameters

input

CreateJobSchedulerCommandInput

Returns

CreateJobSchedulerCommand

Inherited from

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

Constructor

new CreateJobSchedulerCommand(...__namedParameters): CreateJobSchedulerCommand

Parameters

__namedParameters

...[CreateJobSchedulerCommandInput]

Returns

CreateJobSchedulerCommand

Inherited from

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