Bedrock  >  Operations  >  get_custom_model

get_custom_model

Operation

get_custom_model async

get_custom_model(input: GetCustomModelInput, plugins: list[Plugin] | None = None) -> GetCustomModelOutput

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.

Parameters:

Name	Type	Description	Default
input	GetCustomModelInput	An instance of GetCustomModelInput.	required
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

Returns:

Type	Description
GetCustomModelOutput	An instance of GetCustomModelOutput.

Input

GetCustomModelInput dataclass

Dataclass for GetCustomModelInput structure.

Attributes

model_identifier class-attribute instance-attribute

model_identifier: str | None = None

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

Output

GetCustomModelOutput dataclass

Dataclass for GetCustomModelOutput structure.

Attributes

base_model_arn class-attribute instance-attribute

base_model_arn: str | None = None

Amazon Resource Name (ARN) of the base model.

creation_time instance-attribute

creation_time: datetime

Creation time of the model.

customization_config class-attribute instance-attribute

customization_config: CustomizationConfig | None = None

The customization configuration for the custom model.

customization_type class-attribute instance-attribute

customization_type: CustomizationType | None = None

The type of model customization.

failure_message class-attribute instance-attribute

failure_message: str | None = None

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

hyper_parameters class-attribute instance-attribute

hyper_parameters: dict[str, str] | None = None

Hyperparameter values associated with this model. For details on the format for different models, see Custom model hyperparameters.

job_arn class-attribute instance-attribute

job_arn: str | None = None

Job Amazon Resource Name (ARN) associated with this model. For models that you create with the CreateCustomModel API operation, this is NULL.

job_name class-attribute instance-attribute

job_name: str | None = None

Job name associated with this model.

model_arn instance-attribute

model_arn: str

Amazon Resource Name (ARN) associated with this model.

model_kms_key_arn class-attribute instance-attribute

model_kms_key_arn: str | None = None

The custom model is encrypted at rest using this key.

model_name instance-attribute

model_name: str

Model name associated with this model.

model_status class-attribute instance-attribute

model_status: ModelStatus | None = None

The current status of the custom model. Possible values include:

• Creating - The model is being created and validated.

• Active - The model has been successfully created and is ready for use.

• Failed - The model creation process failed. Check the failureMessage field for details.

output_data_config class-attribute instance-attribute

output_data_config: OutputDataConfig | None = None

Output data configuration associated with this custom model.

training_data_config class-attribute instance-attribute

training_data_config: TrainingDataConfig | None = None

Contains information about the training dataset.

training_metrics class-attribute instance-attribute

training_metrics: TrainingMetrics | None = None

Contains training metrics from the job creation.

validation_data_config class-attribute instance-attribute

validation_data_config: ValidationDataConfig | None = None

Contains information about the validation dataset.

validation_metrics class-attribute instance-attribute

validation_metrics: list[ValidatorMetric] | None = None

The validation metrics from the job creation.