Skip to content

GetCustomModelResponse

Source code in docs_src/capo_bedrock/types/get_custom_model_response.py
class GetCustomModelResponse(TypedDict, closed=True):
    model_arn: "capo_bedrock.types.model_arn.ModelArn"
    """<p>Amazon Resource Name (ARN) associated with this model.</p>"""
    model_name: "capo_bedrock.types.custom_model_name.CustomModelName"
    """<p>Model name associated with this model.</p>"""
    job_name: NotRequired["capo_bedrock.types.job_name.JobName"]
    """<p>Job name associated with this model.</p>"""
    job_arn: NotRequired[
        "capo_bedrock.types.model_customization_job_arn.ModelCustomizationJobArn"
    ]
    """<p>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>.</p>"""
    base_model_arn: NotRequired["capo_bedrock.types.model_arn.ModelArn"]
    """<p>Amazon Resource Name (ARN) of the base model.</p>"""
    customization_type: NotRequired[
        "capo_bedrock.types.customization_type.CustomizationType"
    ]
    """<p>The type of model customization.</p>"""
    model_kms_key_arn: NotRequired["capo_bedrock.types.kms_key_arn.KmsKeyArn"]
    """<p>The custom model is encrypted at rest using this key.</p>"""
    hyper_parameters: NotRequired[
        "capo_bedrock.types.model_customization_hyper_parameters.ModelCustomizationHyperParameters"
    ]
    """<p>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>.</p>"""
    training_data_config: NotRequired[
        "capo_bedrock.types.training_data_config.TrainingDataConfig"
    ]
    """<p>Contains information about the training dataset.</p>"""
    validation_data_config: NotRequired[
        "capo_bedrock.types.validation_data_config.ValidationDataConfig"
    ]
    """<p>Contains information about the validation dataset.</p>"""
    output_data_config: NotRequired[
        "capo_bedrock.types.output_data_config.OutputDataConfig"
    ]
    """<p>Output data configuration associated with this custom model.</p>"""
    training_metrics: NotRequired["capo_bedrock.types.training_metrics.TrainingMetrics"]
    """<p>Contains training metrics from the job creation.</p>"""
    validation_metrics: NotRequired[
        "capo_bedrock.types.validation_metrics.ValidationMetrics"
    ]
    """<p>The validation metrics from the job creation.</p>"""
    creation_time: "capo_bedrock.types.timestamp.Timestamp"
    """<p>Creation time of the model.</p>"""
    customization_config: NotRequired[
        "capo_bedrock.types.customization_config.CustomizationConfig"
    ]
    """<p>The customization configuration for the custom model.</p>"""
    model_status: NotRequired["capo_bedrock.types.model_status.ModelStatus"]
    """<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>"""
    failure_message: NotRequired["capo_bedrock.types.error_message.ErrorMessage"]
    """<p>A failure message for any issues that occurred when creating the custom model. This is included for only a failed CreateCustomModel operation.</p>"""

base_model_arn instance-attribute

base_model_arn: NotRequired[ModelArn]

Amazon Resource Name (ARN) of the base model.

creation_time instance-attribute

creation_time: Timestamp

Creation time of the model.

customization_config instance-attribute

customization_config: NotRequired[CustomizationConfig]

The customization configuration for the custom model.

customization_type instance-attribute

customization_type: NotRequired[CustomizationType]

The type of model customization.

failure_message instance-attribute

failure_message: NotRequired[ErrorMessage]

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

hyper_parameters instance-attribute

hyper_parameters: NotRequired[ModelCustomizationHyperParameters]

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

job_arn instance-attribute

job_arn: NotRequired[ModelCustomizationJobArn]

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

job_name instance-attribute

job_name: NotRequired[JobName]

Job name associated with this model.

model_arn instance-attribute

model_arn: ModelArn

Amazon Resource Name (ARN) associated with this model.

model_kms_key_arn instance-attribute

model_kms_key_arn: NotRequired[KmsKeyArn]

The custom model is encrypted at rest using this key.

model_name instance-attribute

model_name: CustomModelName

Model name associated with this model.

model_status instance-attribute

model_status: NotRequired[ModelStatus]

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 instance-attribute

output_data_config: NotRequired[OutputDataConfig]

Output data configuration associated with this custom model.

training_data_config instance-attribute

training_data_config: NotRequired[TrainingDataConfig]

Contains information about the training dataset.

training_metrics instance-attribute

training_metrics: NotRequired[TrainingMetrics]

Contains training metrics from the job creation.

validation_data_config instance-attribute

validation_data_config: NotRequired[ValidationDataConfig]

Contains information about the validation dataset.

validation_metrics instance-attribute

validation_metrics: NotRequired[ValidationMetrics]

The validation metrics from the job creation.