Skip to content

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


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

Class: ListConfigurationsCommand

Lists workflow configurations

Example

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

import { GenAiEvaluationToolkitClient, ListConfigurationsCommand } from "@awssolutions/gen-ai-evaluation-toolkit-ts-client"; // ES Modules import
// const { GenAiEvaluationToolkitClient, ListConfigurationsCommand } = 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 = { // ListConfigurationsRequest
  maxResults: Number("int"),
  nextToken: "STRING_VALUE",
  filter: { // ConditionExpression Union: only one key present
    condition: { // Condition Union: only one key present
      numericCondition: { // NumericCondition
        name: "STRING_VALUE", // required
        value: Number("float"), // required
        comparator: "=" || "!=" || "<" || "<=" || ">" || ">=", // required
      },
      stringEnumCondition: { // StringEnumCondition
        name: "STRING_VALUE", // required
        value: "STRING_VALUE", // required
        comparator: "=" || "!=", // required
      },
    },
    and: [ // ConditionExpressionList
      {//  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: [
          "<ConditionExpression>",
        ],
        or: [
          "<ConditionExpression>",
        ],
        not: "<ConditionExpression>",
      },
    ],
    or: [
      "<ConditionExpression>",
    ],
    not: "<ConditionExpression>",
  },
  name: "STRING_VALUE",
};
const command = new ListConfigurationsCommand(input);
const response = await client.send(command);
// { // ListConfigurationsResponse
//   nextToken: "STRING_VALUE",
//   configurations: [ // Configurations // required
//     { // ConfigurationReference
//       name: "STRING_VALUE", // required
//       version: Number("int"),
//     },
//   ],
// };

Param

ListConfigurationsCommandInput

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

Parameters

input

ListConfigurationsCommandInput

Returns

ListConfigurationsCommand

Inherited from

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

Constructor

new ListConfigurationsCommand(...__namedParameters): ListConfigurationsCommand

Parameters

__namedParameters

[] | [ListConfigurationsCommandInput]

Returns

ListConfigurationsCommand

Inherited from

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