2025/04/30 - Amazon Bedrock - 2 updated api methods
Changes You can now specify a cross region inference profile as a teacher model for the CreateModelCustomizationJob API. Additionally, the GetModelCustomizationJob API has been enhanced to return the sub-task statuses of a customization job within the StatusDetails response field.
{'statusDetails': {'dataProcessingDetails': {'creationTime': 'timestamp',
'lastModifiedTime': 'timestamp',
'status': 'InProgress | Completed '
'| Stopping | Stopped | '
'Failed | NotStarted'},
'trainingDetails': {'creationTime': 'timestamp',
'lastModifiedTime': 'timestamp',
'status': 'InProgress | Completed | '
'Stopping | Stopped | Failed '
'| NotStarted'},
'validationDetails': {'creationTime': 'timestamp',
'lastModifiedTime': 'timestamp',
'status': 'InProgress | Completed | '
'Stopping | Stopped | '
'Failed | NotStarted'}}}
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.
See also: AWS API Documentation
Request Syntax
client.get_model_customization_job(
jobIdentifier='string'
)
string
[REQUIRED]
Identifier for the customization job.
dict
Response Syntax
{
'jobArn': 'string',
'jobName': 'string',
'outputModelName': 'string',
'outputModelArn': 'string',
'clientRequestToken': 'string',
'roleArn': 'string',
'status': 'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped',
'failureMessage': 'string',
'statusDetails': {
'validationDetails': {
'status': 'InProgress'|'Completed'|'Stopping'|'Stopped'|'Failed'|'NotStarted',
'creationTime': datetime(2015, 1, 1),
'lastModifiedTime': datetime(2015, 1, 1)
},
'dataProcessingDetails': {
'status': 'InProgress'|'Completed'|'Stopping'|'Stopped'|'Failed'|'NotStarted',
'creationTime': datetime(2015, 1, 1),
'lastModifiedTime': datetime(2015, 1, 1)
},
'trainingDetails': {
'status': 'InProgress'|'Completed'|'Stopping'|'Stopped'|'Failed'|'NotStarted',
'creationTime': datetime(2015, 1, 1),
'lastModifiedTime': datetime(2015, 1, 1)
}
},
'creationTime': datetime(2015, 1, 1),
'lastModifiedTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'baseModelArn': 'string',
'hyperParameters': {
'string': 'string'
},
'trainingDataConfig': {
's3Uri': 'string',
'invocationLogsConfig': {
'usePromptResponse': True|False,
'invocationLogSource': {
's3Uri': 'string'
},
'requestMetadataFilters': {
'equals': {
'string': 'string'
},
'notEquals': {
'string': 'string'
},
'andAll': [
{
'equals': {
'string': 'string'
},
'notEquals': {
'string': 'string'
}
},
],
'orAll': [
{
'equals': {
'string': 'string'
},
'notEquals': {
'string': 'string'
}
},
]
}
}
},
'validationDataConfig': {
'validators': [
{
's3Uri': 'string'
},
]
},
'outputDataConfig': {
's3Uri': 'string'
},
'customizationType': 'FINE_TUNING'|'CONTINUED_PRE_TRAINING'|'DISTILLATION',
'outputModelKmsKeyArn': 'string',
'trainingMetrics': {
'trainingLoss': ...
},
'validationMetrics': [
{
'validationLoss': ...
},
],
'vpcConfig': {
'subnetIds': [
'string',
],
'securityGroupIds': [
'string',
]
},
'customizationConfig': {
'distillationConfig': {
'teacherModelConfig': {
'teacherModelIdentifier': 'string',
'maxResponseLengthForInference': 123
}
}
}
}
Response Structure
(dict) --
jobArn (string) --
The Amazon Resource Name (ARN) of the customization job.
jobName (string) --
The name of the customization job.
outputModelName (string) --
The name of the output model.
outputModelArn (string) --
The Amazon Resource Name (ARN) of the output model.
clientRequestToken (string) --
The token that you specified in the CreateCustomizationJob request.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role.
status (string) --
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.
failureMessage (string) --
Information about why the job failed.
statusDetails (dict) --
For a Distillation job, the details about the statuses of the sub-tasks of the customization job.
validationDetails (dict) --
The status details for the validation sub-task of the job.
status (string) --
The status of the validation sub-task of the job.
creationTime (datetime) --
The start time of the validation sub-task of the job.
lastModifiedTime (datetime) --
The latest update to the validation sub-task of the job.
dataProcessingDetails (dict) --
The status details for the data processing sub-task of the job.
status (string) --
The status of the data processing sub-task of the job.
creationTime (datetime) --
The start time of the data processing sub-task of the job.
lastModifiedTime (datetime) --
The latest update to the data processing sub-task of the job.
trainingDetails (dict) --
The status details for the training sub-task of the job.
status (string) --
The status of the training sub-task of the job.
creationTime (datetime) --
The start time of the training sub-task of the job.
lastModifiedTime (datetime) --
The latest update to the training sub-task of the job.
creationTime (datetime) --
Time that the resource was created.
lastModifiedTime (datetime) --
Time that the resource was last modified.
endTime (datetime) --
Time that the resource transitioned to terminal state.
baseModelArn (string) --
Amazon Resource Name (ARN) of the base model.
hyperParameters (dict) --
The hyperparameter values for the job. For details on the format for different models, see Custom model hyperparameters.
(string) --
(string) --
trainingDataConfig (dict) --
Contains information about the training dataset.
s3Uri (string) --
The S3 URI where the training data is stored.
invocationLogsConfig (dict) --
Settings for using invocation logs to customize a model.
usePromptResponse (boolean) --
Whether to use the model's response for training, or just the prompt. The default value is False.
invocationLogSource (dict) --
The source of the invocation logs.
s3Uri (string) --
The URI of an invocation log in a bucket.
requestMetadataFilters (dict) --
Rules for filtering invocation logs based on request metadata.
equals (dict) --
Include results where the key equals the value.
(string) --
(string) --
notEquals (dict) --
Include results where the key does not equal the value.
(string) --
(string) --
andAll (list) --
Include results where all of the based filters match.
(dict) --
A mapping of a metadata key to a value that it should or should not equal.
equals (dict) --
Include results where the key equals the value.
(string) --
(string) --
notEquals (dict) --
Include results where the key does not equal the value.
(string) --
(string) --
orAll (list) --
Include results where any of the base filters match.
(dict) --
A mapping of a metadata key to a value that it should or should not equal.
equals (dict) --
Include results where the key equals the value.
(string) --
(string) --
notEquals (dict) --
Include results where the key does not equal the value.
(string) --
(string) --
validationDataConfig (dict) --
Contains information about the validation dataset.
validators (list) --
Information about the validators.
(dict) --
Information about a validator.
s3Uri (string) --
The S3 URI where the validation data is stored.
outputDataConfig (dict) --
Output data configuration
s3Uri (string) --
The S3 URI where the output data is stored.
customizationType (string) --
The type of model customization.
outputModelKmsKeyArn (string) --
The custom model is encrypted at rest using this key.
trainingMetrics (dict) --
Contains training metrics from the job creation.
trainingLoss (float) --
Loss metric associated with the custom job.
validationMetrics (list) --
The loss metric for each validator that you provided in the createjob request.
(dict) --
The metric for the validator.
validationLoss (float) --
The validation loss associated with this validator.
vpcConfig (dict) --
VPC configuration for the custom model job.
subnetIds (list) --
An array of IDs for each subnet in the VPC to use.
(string) --
securityGroupIds (list) --
An array of IDs for each security group in the VPC to use.
(string) --
customizationConfig (dict) --
The customization configuration for the model customization job.
distillationConfig (dict) --
The Distillation configuration for the custom model.
teacherModelConfig (dict) --
The teacher model configuration.
teacherModelIdentifier (string) --
The identifier of the teacher model.
maxResponseLengthForInference (integer) --
The maximum number of tokens requested when the customization job invokes the teacher model.
{'modelCustomizationJobSummaries': {'statusDetails': {'dataProcessingDetails': {'creationTime': 'timestamp',
'lastModifiedTime': 'timestamp',
'status': 'InProgress '
'| '
'Completed '
'| '
'Stopping '
'| '
'Stopped '
'| '
'Failed '
'| '
'NotStarted'},
'trainingDetails': {'creationTime': 'timestamp',
'lastModifiedTime': 'timestamp',
'status': 'InProgress '
'| '
'Completed '
'| '
'Stopping '
'| '
'Stopped '
'| '
'Failed '
'| '
'NotStarted'},
'validationDetails': {'creationTime': 'timestamp',
'lastModifiedTime': 'timestamp',
'status': 'InProgress '
'| '
'Completed '
'| '
'Stopping '
'| '
'Stopped '
'| '
'Failed '
'| '
'NotStarted'}}}}
Returns a list of model customization jobs that you have submitted. You can filter the jobs to return based on one or more criteria.
For more information, see Custom models in the Amazon Bedrock User Guide.
See also: AWS API Documentation
Request Syntax
client.list_model_customization_jobs(
creationTimeAfter=datetime(2015, 1, 1),
creationTimeBefore=datetime(2015, 1, 1),
statusEquals='InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped',
nameContains='string',
maxResults=123,
nextToken='string',
sortBy='CreationTime',
sortOrder='Ascending'|'Descending'
)
datetime
Return customization jobs created after the specified time.
datetime
Return customization jobs created before the specified time.
string
Return customization jobs with the specified status.
string
Return customization jobs only if the job name contains these characters.
integer
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
string
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
string
The field to sort by in the returned list of jobs.
string
The sort order of the results.
dict
Response Syntax
{
'nextToken': 'string',
'modelCustomizationJobSummaries': [
{
'jobArn': 'string',
'baseModelArn': 'string',
'jobName': 'string',
'status': 'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped',
'lastModifiedTime': datetime(2015, 1, 1),
'statusDetails': {
'validationDetails': {
'status': 'InProgress'|'Completed'|'Stopping'|'Stopped'|'Failed'|'NotStarted',
'creationTime': datetime(2015, 1, 1),
'lastModifiedTime': datetime(2015, 1, 1)
},
'dataProcessingDetails': {
'status': 'InProgress'|'Completed'|'Stopping'|'Stopped'|'Failed'|'NotStarted',
'creationTime': datetime(2015, 1, 1),
'lastModifiedTime': datetime(2015, 1, 1)
},
'trainingDetails': {
'status': 'InProgress'|'Completed'|'Stopping'|'Stopped'|'Failed'|'NotStarted',
'creationTime': datetime(2015, 1, 1),
'lastModifiedTime': datetime(2015, 1, 1)
}
},
'creationTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'customModelArn': 'string',
'customModelName': 'string',
'customizationType': 'FINE_TUNING'|'CONTINUED_PRE_TRAINING'|'DISTILLATION'
},
]
}
Response Structure
(dict) --
nextToken (string) --
If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
modelCustomizationJobSummaries (list) --
Job summaries.
(dict) --
Information about one customization job
jobArn (string) --
Amazon Resource Name (ARN) of the customization job.
baseModelArn (string) --
Amazon Resource Name (ARN) of the base model.
jobName (string) --
Name of the customization job.
status (string) --
Status of the customization job.
lastModifiedTime (datetime) --
Time that the customization job was last modified.
statusDetails (dict) --
Details about the status of the data processing sub-task of the job.
validationDetails (dict) --
The status details for the validation sub-task of the job.
status (string) --
The status of the validation sub-task of the job.
creationTime (datetime) --
The start time of the validation sub-task of the job.
lastModifiedTime (datetime) --
The latest update to the validation sub-task of the job.
dataProcessingDetails (dict) --
The status details for the data processing sub-task of the job.
status (string) --
The status of the data processing sub-task of the job.
creationTime (datetime) --
The start time of the data processing sub-task of the job.
lastModifiedTime (datetime) --
The latest update to the data processing sub-task of the job.
trainingDetails (dict) --
The status details for the training sub-task of the job.
status (string) --
The status of the training sub-task of the job.
creationTime (datetime) --
The start time of the training sub-task of the job.
lastModifiedTime (datetime) --
The latest update to the training sub-task of the job.
creationTime (datetime) --
Creation time of the custom model.
endTime (datetime) --
Time that the customization job ended.
customModelArn (string) --
Amazon Resource Name (ARN) of the custom model.
customModelName (string) --
Name of the custom model.
customizationType (string) --
Specifies whether to carry out continued pre-training of a model or whether to fine-tune it. For more information, see Custom models.