Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetEvaluationJob

Retrieves the properties associated with a model evaluation job, including the status of the job. For more information, see Model evaluations.

Request Syntax


GET /evaluation-jobs/jobIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

jobIdentifier

The Amazon Resource Name (ARN) of the model evaluation job.

Length Constraints: Minimum length of 0. Maximum length of 1011.

Pattern: ^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:evaluation-job/[a-z0-9]{12})$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "creationTime": "string",
   "customerEncryptionKeyId": "string",
   "evaluationConfig": { ... },
   "failureMessages": [ "string" ],
   "inferenceConfig": { ... },
   "jobArn": "string",
   "jobDescription": "string",
   "jobName": "string",
   "jobType": "string",
   "lastModifiedTime": "string",
   "outputDataConfig": { 
      "s3Uri": "string"
   },
   "roleArn": "string",
   "status": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

creationTime

When the model evaluation job was created.

Type: Timestamp

customerEncryptionKeyId

The Amazon Resource Name (ARN) of the customer managed key specified when the model evaluation job was created.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:((key/[a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+))$

evaluationConfig

Contains details about the type of model evaluation job, the metrics used, the task type selected, the datasets used, and any custom metrics you defined.

Type: EvaluationConfig object

Note: This object is a Union. Only one member of this object can be specified or returned.

failureMessages

An array of strings the specify why the model evaluation job has failed.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 20 items.

Length Constraints: Minimum length of 0. Maximum length of 2048.

inferenceConfig

Details about the models you specified in your model evaluation job.

Type: EvaluationInferenceConfig object

Note: This object is a Union. Only one member of this object can be specified or returned.

jobArn

The Amazon Resource Name (ARN) of the model evaluation job.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1011.

Pattern: ^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:evaluation-job/[a-z0-9]{12}$

jobDescription

The description of the model evaluation job.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: ^.+$

jobName

The name of the model evaluation job.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-z0-9](-*[a-z0-9]){0,62}$

jobType

The type of model evaluation job.

Type: String

Valid Values: Human | Automated

lastModifiedTime

When the model evaluation job was last modified.

Type: Timestamp

outputDataConfig

Amazon S3 location for where output data is saved.

Type: EvaluationOutputDataConfig object

roleArn

The Amazon Resource Name (ARN) of the IAM service role used in the model evaluation job.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: ^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$

status

The status of the model evaluation job.

Type: String

Valid Values: InProgress | Completed | Failed | Stopping | Stopped

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The request is denied because of missing access permissions.

HTTP Status Code: 403

InternalServerException

An internal server error occurred. Retry your request.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

HTTP Status Code: 404

ThrottlingException

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

HTTP Status Code: 429

ValidationException

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

HTTP Status Code: 400