Skip to content

GetTrainedModelResponse

Source code in docs_src/capo_cleanroomsml/types/get_trained_model_response.py
class GetTrainedModelResponse(TypedDict, closed=True):
    membership_identifier: "capo_cleanroomsml.types.uuid.UUID"
    """<p>The membership ID of the member that created the trained model.</p>"""
    collaboration_identifier: "capo_cleanroomsml.types.uuid.UUID"
    """<p>The collaboration ID of the collaboration that contains the trained model.</p>"""
    trained_model_arn: "capo_cleanroomsml.types.trained_model_arn.TrainedModelArn"
    """<p>The Amazon Resource Name (ARN) of the trained model.</p>"""
    version_identifier: NotRequired["capo_cleanroomsml.types.uuid.UUID"]
    """<p>The version identifier of the trained model. This unique identifier distinguishes this version from other versions of the same trained model.</p>"""
    incremental_training_data_channels: NotRequired[
        "capo_cleanroomsml.types.incremental_training_data_channels_output.IncrementalTrainingDataChannelsOutput"
    ]
    """<p>Information about the incremental training data channels used to create this version of the trained model. This includes details about the base model that was used for incremental training and the channel configuration.</p>"""
    name: "capo_cleanroomsml.types.name_string.NameString"
    """<p>The name of the trained model.</p>"""
    description: NotRequired[
        "capo_cleanroomsml.types.resource_description.ResourceDescription"
    ]
    """<p>The description of the trained model.</p>"""
    status: "capo_cleanroomsml.types.trained_model_status.TrainedModelStatus"
    """<p>The status of the trained model.</p>"""
    status_details: NotRequired["capo_cleanroomsml.types.status_details.StatusDetails"]
    configured_model_algorithm_association_arn: "capo_cleanroomsml.types.configured_model_algorithm_association_arn.ConfiguredModelAlgorithmAssociationArn"
    """<p>The Amazon Resource Name (ARN) of the configured model algorithm association that was used to create the trained model.</p>"""
    resource_config: NotRequired[
        "capo_cleanroomsml.types.resource_config.ResourceConfig"
    ]
    """<p>The EC2 resource configuration that was used to create the trained model.</p>"""
    training_input_mode: NotRequired[
        "capo_cleanroomsml.types.training_input_mode.TrainingInputMode"
    ]
    """<p>The input mode that was used for accessing the training data when this trained model was created. This indicates how the training data was made available to the training algorithm.</p>"""
    stopping_condition: NotRequired[
        "capo_cleanroomsml.types.stopping_condition.StoppingCondition"
    ]
    """<p>The stopping condition that was used to terminate model training.</p>"""
    metrics_status: NotRequired["capo_cleanroomsml.types.metrics_status.MetricsStatus"]
    """<p>The status of the model metrics.</p>"""
    metrics_status_details: NotRequired["str"]
    """<p>Details about the metrics status for the trained model.</p>"""
    logs_status: NotRequired["capo_cleanroomsml.types.logs_status.LogsStatus"]
    """<p>The logs status for the trained model.</p>"""
    logs_status_details: NotRequired["str"]
    """<p>Details about the logs status for the trained model.</p>"""
    training_container_image_digest: NotRequired["str"]
    """<p>Information about the training image container.</p>"""
    ml_model_training_payer_account_id: NotRequired[
        "capo_cleanroomsml.types.account_id.AccountId"
    ]
    """<p>The account ID of the member that is responsible for paying for model training costs.</p>"""
    create_time: "datetime.datetime"
    """<p>The time at which the trained model was created.</p>"""
    update_time: "datetime.datetime"
    """<p>The most recent time at which the trained model was updated.</p>"""
    hyperparameters: NotRequired[
        "capo_cleanroomsml.types.hyper_parameters.HyperParameters"
    ]
    """<p>The hyperparameters that were used to create the trained model.</p>"""
    environment: NotRequired["capo_cleanroomsml.types.environment.Environment"]
    """<p>The EC2 environment that was used to create the trained model.</p>"""
    kms_key_arn: NotRequired["capo_cleanroomsml.types.kms_key_arn.KmsKeyArn"]
    """<p>The Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt and decrypt customer-owned data in the trained ML model and associated data.</p>"""
    tags: NotRequired["capo_cleanroomsml.types.tag_map.TagMap"]
    """<p>The optional metadata that you applied to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li> <p>Maximum number of tags per resource - 50.</p> </li> <li> <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p> </li> <li> <p>Maximum key length - 128 Unicode characters in UTF-8.</p> </li> <li> <p>Maximum value length - 256 Unicode characters in UTF-8.</p> </li> <li> <p>If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values are case sensitive.</p> </li> <li> <p>Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.</p> </li> </ul>"""
    data_channels: (
        "capo_cleanroomsml.types.model_training_data_channels.ModelTrainingDataChannels"
    )
    """<p>The data channels that were used for the trained model.</p>"""

collaboration_identifier instance-attribute

collaboration_identifier: UUID

The collaboration ID of the collaboration that contains the trained model.

configured_model_algorithm_association_arn instance-attribute

configured_model_algorithm_association_arn: ConfiguredModelAlgorithmAssociationArn

The Amazon Resource Name (ARN) of the configured model algorithm association that was used to create the trained model.

create_time instance-attribute

create_time: datetime

The time at which the trained model was created.

data_channels instance-attribute

The data channels that were used for the trained model.

description instance-attribute

description: NotRequired[ResourceDescription]

The description of the trained model.

environment instance-attribute

environment: NotRequired[Environment]

The EC2 environment that was used to create the trained model.

hyperparameters instance-attribute

hyperparameters: NotRequired[HyperParameters]

The hyperparameters that were used to create the trained model.

incremental_training_data_channels instance-attribute

incremental_training_data_channels: NotRequired[IncrementalTrainingDataChannelsOutput]

Information about the incremental training data channels used to create this version of the trained model. This includes details about the base model that was used for incremental training and the channel configuration.

kms_key_arn instance-attribute

kms_key_arn: NotRequired[KmsKeyArn]

The Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt and decrypt customer-owned data in the trained ML model and associated data.

logs_status instance-attribute

logs_status: NotRequired[LogsStatus]

The logs status for the trained model.

logs_status_details instance-attribute

logs_status_details: NotRequired[str]

Details about the logs status for the trained model.

membership_identifier instance-attribute

membership_identifier: UUID

The membership ID of the member that created the trained model.

metrics_status instance-attribute

metrics_status: NotRequired[MetricsStatus]

The status of the model metrics.

metrics_status_details instance-attribute

metrics_status_details: NotRequired[str]

Details about the metrics status for the trained model.

ml_model_training_payer_account_id instance-attribute

ml_model_training_payer_account_id: NotRequired[AccountId]

The account ID of the member that is responsible for paying for model training costs.

name instance-attribute

name: NameString

The name of the trained model.

resource_config instance-attribute

resource_config: NotRequired[ResourceConfig]

The EC2 resource configuration that was used to create the trained model.

status instance-attribute

The status of the trained model.

status_details instance-attribute

status_details: NotRequired[StatusDetails]

stopping_condition instance-attribute

stopping_condition: NotRequired[StoppingCondition]

The stopping condition that was used to terminate model training.

tags instance-attribute

tags: NotRequired[TagMap]

The optional metadata that you applied to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50.

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8.

  • Maximum value length - 256 Unicode characters in UTF-8.

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

trained_model_arn instance-attribute

trained_model_arn: TrainedModelArn

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

training_container_image_digest instance-attribute

training_container_image_digest: NotRequired[str]

Information about the training image container.

training_input_mode instance-attribute

training_input_mode: NotRequired[TrainingInputMode]

The input mode that was used for accessing the training data when this trained model was created. This indicates how the training data was made available to the training algorithm.

update_time instance-attribute

update_time: datetime

The most recent time at which the trained model was updated.

version_identifier instance-attribute

version_identifier: NotRequired[UUID]

The version identifier of the trained model. This unique identifier distinguishes this version from other versions of the same trained model.