ListEvaluationJobsCommand

Suggest an Edit

Lists all existing evaluation jobs.

Example Syntax

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

import { BedrockClient, ListEvaluationJobsCommand } from "@aws-sdk/client-bedrock"; // ES Modules import
// const { BedrockClient, ListEvaluationJobsCommand } = require("@aws-sdk/client-bedrock"); // CommonJS import
const client = new BedrockClient(config);
const input = { // ListEvaluationJobsRequest
  creationTimeAfter: new Date("TIMESTAMP"),
  creationTimeBefore: new Date("TIMESTAMP"),
  statusEquals: "InProgress" || "Completed" || "Failed" || "Stopping" || "Stopped" || "Deleting",
  applicationTypeEquals: "ModelEvaluation" || "RagEvaluation",
  nameContains: "STRING_VALUE",
  maxResults: Number("int"),
  nextToken: "STRING_VALUE",
  sortBy: "CreationTime",
  sortOrder: "Ascending" || "Descending",
};
const command = new ListEvaluationJobsCommand(input);
const response = await client.send(command);
// { // ListEvaluationJobsResponse
//   nextToken: "STRING_VALUE",
//   jobSummaries: [ // EvaluationSummaries
//     { // EvaluationSummary
//       jobArn: "STRING_VALUE", // required
//       jobName: "STRING_VALUE", // required
//       status: "InProgress" || "Completed" || "Failed" || "Stopping" || "Stopped" || "Deleting", // required
//       creationTime: new Date("TIMESTAMP"), // required
//       jobType: "Human" || "Automated", // required
//       evaluationTaskTypes: [ // EvaluationTaskTypes // required
//         "Summarization" || "Classification" || "QuestionAndAnswer" || "Generation" || "Custom",
//       ],
//       modelIdentifiers: [ // EvaluationBedrockModelIdentifiers
//         "STRING_VALUE",
//       ],
//       ragIdentifiers: [ // EvaluationBedrockKnowledgeBaseIdentifiers
//         "STRING_VALUE",
//       ],
//       evaluatorModelIdentifiers: [ // EvaluatorModelIdentifiers
//         "STRING_VALUE",
//       ],
//       inferenceConfigSummary: { // EvaluationInferenceConfigSummary
//         modelConfigSummary: { // EvaluationModelConfigSummary
//           bedrockModelIdentifiers: [
//             "STRING_VALUE",
//           ],
//           precomputedInferenceSourceIdentifiers: [ // EvaluationPrecomputedInferenceSourceIdentifiers
//             "STRING_VALUE",
//           ],
//         },
//         ragConfigSummary: { // EvaluationRagConfigSummary
//           bedrockKnowledgeBaseIdentifiers: [
//             "STRING_VALUE",
//           ],
//           precomputedRagSourceIdentifiers: [ // EvaluationPrecomputedRagSourceIdentifiers
//             "STRING_VALUE",
//           ],
//         },
//       },
//       applicationType: "ModelEvaluation" || "RagEvaluation",
//     },
//   ],
// };

ListEvaluationJobsCommand Input

See ListEvaluationJobsCommandInput for more details

Parameter
Type
Description
applicationTypeEquals
ApplicationType | undefined

A filter to only list evaluation jobs that are either model evaluations or knowledge base evaluations.

creationTimeAfter
Date | undefined

A filter to only list evaluation jobs created after a specified time.

creationTimeBefore
Date | undefined

A filter to only list evaluation jobs created before a specified time.

maxResults
number | undefined

The maximum number of results to return.

nameContains
string | undefined

A filter to only list evaluation jobs that contain a specified string in the job name.

nextToken
string | undefined

Continuation token from the previous response, for Amazon Bedrock to list the next set of results.

sortBy
SortJobsBy | undefined

Specifies a creation time to sort the list of evaluation jobs by when they were created.

sortOrder
SortOrder | undefined

Specifies whether to sort the list of evaluation jobs by either ascending or descending order.

statusEquals
EvaluationJobStatus | undefined

A filter to only list evaluation jobs that are of a certain status.

ListEvaluationJobsCommand Output

See ListEvaluationJobsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
jobSummaries
EvaluationSummary[] | undefined

A list of summaries of the evaluation jobs.

nextToken
string | undefined

Continuation token from the previous response, for Amazon Bedrock to list the next set of results.

Throws

Name
Fault
Details
AccessDeniedException
client

The request is denied because of missing access permissions.

InternalServerException
server

An internal server error occurred. Retry your request.

ThrottlingException
client

The number of requests exceeds the limit. Resubmit your request later.

ValidationException
client

Input validation failed. Check your request parameters and retry the request.

BedrockServiceException
Base exception class for all service exceptions from Bedrock service.