GetModelCustomizationJobCommand

Suggest an Edit

Retrieves the properties associated with a model-customization job, including the status of the job. For more information, see Custom models  in the Amazon Bedrock User Guide .

Example Syntax

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

import { BedrockClient, GetModelCustomizationJobCommand } from "@aws-sdk/client-bedrock"; // ES Modules import
// const { BedrockClient, GetModelCustomizationJobCommand } = require("@aws-sdk/client-bedrock"); // CommonJS import
const client = new BedrockClient(config);
const input = { // GetModelCustomizationJobRequest
  jobIdentifier: "STRING_VALUE", // required
};
const command = new GetModelCustomizationJobCommand(input);
const response = await client.send(command);
// { // GetModelCustomizationJobResponse
//   jobArn: "STRING_VALUE", // required
//   jobName: "STRING_VALUE", // required
//   outputModelName: "STRING_VALUE", // required
//   outputModelArn: "STRING_VALUE",
//   clientRequestToken: "STRING_VALUE",
//   roleArn: "STRING_VALUE", // required
//   status: "InProgress" || "Completed" || "Failed" || "Stopping" || "Stopped",
//   failureMessage: "STRING_VALUE",
//   creationTime: new Date("TIMESTAMP"), // required
//   lastModifiedTime: new Date("TIMESTAMP"),
//   endTime: new Date("TIMESTAMP"),
//   baseModelArn: "STRING_VALUE", // required
//   hyperParameters: { // ModelCustomizationHyperParameters
//     "<keys>": "STRING_VALUE",
//   },
//   trainingDataConfig: { // TrainingDataConfig
//     s3Uri: "STRING_VALUE",
//     invocationLogsConfig: { // InvocationLogsConfig
//       usePromptResponse: true || false,
//       invocationLogSource: { // InvocationLogSource Union: only one key present
//         s3Uri: "STRING_VALUE",
//       },
//       requestMetadataFilters: { // RequestMetadataFilters Union: only one key present
//         equals: { // RequestMetadataMap
//           "<keys>": "STRING_VALUE",
//         },
//         notEquals: {
//           "<keys>": "STRING_VALUE",
//         },
//         andAll: [ // RequestMetadataFiltersList
//           { // RequestMetadataBaseFilters
//             equals: {
//               "<keys>": "STRING_VALUE",
//             },
//             notEquals: {
//               "<keys>": "STRING_VALUE",
//             },
//           },
//         ],
//         orAll: [
//           {
//             equals: {
//               "<keys>": "STRING_VALUE",
//             },
//             notEquals: "<RequestMetadataMap>",
//           },
//         ],
//       },
//     },
//   },
//   validationDataConfig: { // ValidationDataConfig
//     validators: [ // Validators // required
//       { // Validator
//         s3Uri: "STRING_VALUE", // required
//       },
//     ],
//   },
//   outputDataConfig: { // OutputDataConfig
//     s3Uri: "STRING_VALUE", // required
//   },
//   customizationType: "FINE_TUNING" || "CONTINUED_PRE_TRAINING" || "DISTILLATION",
//   outputModelKmsKeyArn: "STRING_VALUE",
//   trainingMetrics: { // TrainingMetrics
//     trainingLoss: Number("float"),
//   },
//   validationMetrics: [ // ValidationMetrics
//     { // ValidatorMetric
//       validationLoss: Number("float"),
//     },
//   ],
//   vpcConfig: { // VpcConfig
//     subnetIds: [ // SubnetIds // required
//       "STRING_VALUE",
//     ],
//     securityGroupIds: [ // SecurityGroupIds // required
//       "STRING_VALUE",
//     ],
//   },
//   customizationConfig: { // CustomizationConfig Union: only one key present
//     distillationConfig: { // DistillationConfig
//       teacherModelConfig: { // TeacherModelConfig
//         teacherModelIdentifier: "STRING_VALUE", // required
//         maxResponseLengthForInference: Number("int"),
//       },
//     },
//   },
// };

GetModelCustomizationJobCommand Input

See GetModelCustomizationJobCommandInput for more details

Parameter
Type
Description
jobIdentifier
Required
string | undefined

Identifier for the customization job.

GetModelCustomizationJobCommand Output

See GetModelCustomizationJobCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
baseModelArn
Required
string | undefined

Amazon Resource Name (ARN) of the base model.

creationTime
Required
Date | undefined

Time that the resource was created.

jobArn
Required
string | undefined

The Amazon Resource Name (ARN) of the customization job.

jobName
Required
string | undefined

The name of the customization job.

outputDataConfig
Required
OutputDataConfig | undefined

Output data configuration

outputModelName
Required
string | undefined

The name of the output model.

roleArn
Required
string | undefined

The Amazon Resource Name (ARN) of the IAM role.

trainingDataConfig
Required
TrainingDataConfig | undefined

Contains information about the training dataset.

validationDataConfig
Required
ValidationDataConfig | undefined

Contains information about the validation dataset.

clientRequestToken
string | undefined

The token that you specified in the CreateCustomizationJob request.

customizationConfig
CustomizationConfig | undefined

The customization configuration for the model customization job.

customizationType
CustomizationType | undefined

The type of model customization.

endTime
Date | undefined

Time that the resource transitioned to terminal state.

failureMessage
string | undefined

Information about why the job failed.

hyperParameters
Record<string, string> | undefined

The hyperparameter values for the job. For details on the format for different models, see Custom model hyperparameters .

lastModifiedTime
Date | undefined

Time that the resource was last modified.

outputModelArn
string | undefined

The Amazon Resource Name (ARN) of the output model.

outputModelKmsKeyArn
string | undefined

The custom model is encrypted at rest using this key.

status
ModelCustomizationJobStatus | undefined

The status of the job. A successful job transitions from in-progress to completed when the output model is ready to use. If the job failed, the failure message contains information about why the job failed.

trainingMetrics
TrainingMetrics | undefined

Contains training metrics from the job creation.

validationMetrics
ValidatorMetric[] | undefined

The loss metric for each validator that you provided in the createjob request.

vpcConfig
VpcConfig | undefined

VPC configuration for the custom model job.

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.

ResourceNotFoundException
client

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

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.