GetCustomModel
Get the properties associated with a Amazon Bedrock custom model that you have created.For more information, see Custom models in the Amazon Bedrock User Guide.
Request Syntax
GET /custom-models/modelIdentifier
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- modelIdentifier
-
Name or Amazon Resource Name (ARN) of the custom model.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)$
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"baseModelArn": "string",
"creationTime": "string",
"customizationConfig": { ... },
"customizationType": "string",
"hyperParameters": {
"string" : "string"
},
"jobArn": "string",
"jobName": "string",
"modelArn": "string",
"modelKmsKeyArn": "string",
"modelName": "string",
"outputDataConfig": {
"s3Uri": "string"
},
"trainingDataConfig": {
"invocationLogsConfig": {
"invocationLogSource": { ... },
"requestMetadataFilters": { ... },
"usePromptResponse": boolean
},
"s3Uri": "string"
},
"trainingMetrics": {
"trainingLoss": number
},
"validationDataConfig": {
"validators": [
{
"s3Uri": "string"
}
]
},
"validationMetrics": [
{
"validationLoss": number
}
]
}
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.
- baseModelArn
-
Amazon Resource Name (ARN) of the base model.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern:
^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))$
- creationTime
-
Creation time of the model.
Type: Timestamp
- customizationConfig
-
The customization configuration for the custom model.
Type: CustomizationConfig object
Note: This object is a Union. Only one member of this object can be specified or returned.
- customizationType
-
The type of model customization.
Type: String
Valid Values:
FINE_TUNING | CONTINUED_PRE_TRAINING | DISTILLATION
- hyperParameters
-
Hyperparameter values associated with this model. For details on the format for different models, see Custom model hyperparameters.
Type: String to string map
- jobArn
-
Job Amazon Resource Name (ARN) associated with this model.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1011.
Pattern:
^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-customization-job/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}/[a-z0-9]{12}$
- jobName
-
Job name associated with this model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9\+\-\.])*$
- modelArn
-
Amazon Resource Name (ARN) associated with this model.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern:
^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))$
- modelKmsKeyArn
-
The custom model is encrypted at rest using this key.
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}$
- modelName
-
Model name associated with this model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^([0-9a-zA-Z][_-]?){1,63}$
- outputDataConfig
-
Output data configuration associated with this custom model.
Type: OutputDataConfig object
- trainingDataConfig
-
Contains information about the training dataset.
Type: TrainingDataConfig object
- trainingMetrics
-
Contains training metrics from the job creation.
Type: TrainingMetrics object
- validationDataConfig
-
Contains information about the validation dataset.
Type: ValidationDataConfig object
- validationMetrics
-
The validation metrics from the job creation.
Type: Array of ValidatorMetric objects
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: