Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14108906717.7 KB

Get the properties associated with a Amazon Bedrock custom model that you have created. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html">Custom models</a> in the <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html">Amazon Bedrock User Guide</a>.

get/custom-models/{modelIdentifier}

Path parameters

modelIdentifierstring required

Name or Amazon Resource Name (ARN) of the custom model.

Response

Success

modelArnstring required

Amazon Resource Name (ARN) associated with this model.

modelNamestring required

Model name associated with this model.

jobNamestring

Job name associated with this model.

jobArnstring

Job Amazon Resource Name (ARN) associated with this model. For models that you create with the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateCustomModel.html">CreateCustomModel</a> API operation, this is <code>NULL</code>.

baseModelArnstring

Amazon Resource Name (ARN) of the base model.

customizationType'FINE_TUNING' | 'CONTINUED_PRE_TRAINING' | 'DISTILLATION' | 'REINFORCEMENT_FINE_TUNING' | 'IMPORTED'

The type of model customization.

modelKmsKeyArnstring

The custom model is encrypted at rest using this key.

hyperParametersobject

Hyperparameter values associated with this model. For details on the format for different models, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models-hp.html">Custom model hyperparameters</a>.

creationTimestring date-time required

Creation time of the model.

modelStatus'Active' | 'Creating' | 'Failed'
<p>The current status of the custom model. Possible values include:</p> <ul> <li> <p> <code>Creating</code> - The model is being created and validated.</p> </li> <li> <p> <code>Active</code> - The model has been successfully created and is ready for use.</p> </li> <li> <p> <code>Failed</code> - The model creation process failed. Check the <code>failureMessage</code> field for details.</p> </li> </ul>
failureMessagestring

A failure message for any issues that occurred when creating the custom model. This is included for only a failed CreateCustomModel operation.