Skip to content

get_model_customization_job

Operation

get_model_customization_job

get_model_customization_job(request: GetModelCustomizationJobInput | GetModelCustomizationJobInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetModelCustomizationJobInputDict]) -> GetModelCustomizationJobOutput

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.

Parameters:

Name Type Description Default
request GetModelCustomizationJobInput | GetModelCustomizationJobInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetModelCustomizationJobInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetModelCustomizationJobOutput

An instance of GetModelCustomizationJobOutput.

get_model_customization_job async

get_model_customization_job(request: GetModelCustomizationJobInput | GetModelCustomizationJobInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetModelCustomizationJobInputDict]) -> GetModelCustomizationJobOutput

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.

Parameters:

Name Type Description Default
request GetModelCustomizationJobInput | GetModelCustomizationJobInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetModelCustomizationJobInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetModelCustomizationJobOutput

An instance of GetModelCustomizationJobOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetModelCustomizationJobInputDict

Bases: TypedDict

Dictionary form of GetModelCustomizationJobInput.

Attributes

job_identifier instance-attribute
job_identifier: Required[str]

Identifier for the customization job.

GetModelCustomizationJobInput dataclass

Bases: _SerdeShape

Dataclass for GetModelCustomizationJobInput structure.

Attributes

job_identifier class-attribute instance-attribute
job_identifier: str | None = ...

Identifier for the customization job.

Output

GetModelCustomizationJobOutput dataclass

Bases: _SerdeShape

Dataclass for GetModelCustomizationJobOutput structure.

Attributes

base_model_arn instance-attribute
base_model_arn: str

Amazon Resource Name (ARN) of the base model.

client_request_token class-attribute instance-attribute
client_request_token: str | None = ...

The token that you specified in the CreateCustomizationJob request.

creation_time instance-attribute
creation_time: datetime

Time that the resource was created.

customization_config class-attribute instance-attribute
customization_config: CustomizationConfig | None = ...

The customization configuration for the model customization job.

customization_type class-attribute instance-attribute
customization_type: str | None = ...

The type of model customization.

end_time class-attribute instance-attribute
end_time: datetime | None = ...

Time that the resource transitioned to terminal state.

failure_message class-attribute instance-attribute
failure_message: str | None = ...

Information about why the job failed.

hyper_parameters class-attribute instance-attribute
hyper_parameters: dict[str, str] | None = ...

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

job_arn instance-attribute
job_arn: str

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

job_name instance-attribute
job_name: str

The name of the customization job.

last_modified_time class-attribute instance-attribute
last_modified_time: datetime | None = ...

Time that the resource was last modified.

output_data_config instance-attribute
output_data_config: OutputDataConfig

Output data configuration

output_model_arn class-attribute instance-attribute
output_model_arn: str | None = ...

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

output_model_kms_key_arn class-attribute instance-attribute
output_model_kms_key_arn: str | None = ...

The custom model is encrypted at rest using this key.

output_model_name instance-attribute
output_model_name: str

The name of the output model.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

role_arn instance-attribute
role_arn: str

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

status class-attribute instance-attribute
status: str | None = ...

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.

status_details class-attribute instance-attribute
status_details: StatusDetails | None = ...

For a Distillation job, the details about the statuses of the sub-tasks of the customization job.

training_data_config instance-attribute
training_data_config: TrainingDataConfig

Contains information about the training dataset.

training_metrics class-attribute instance-attribute
training_metrics: TrainingMetrics | None = ...

Contains training metrics from the job creation.

validation_data_config instance-attribute
validation_data_config: ValidationDataConfig

Contains information about the validation dataset.

validation_metrics class-attribute instance-attribute
validation_metrics: list[ValidatorMetric] | None = ...

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

vpc_config class-attribute instance-attribute
vpc_config: VpcConfig | None = ...

VPC configuration for the custom model job.