Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1459348326.0 KB

Returns information about a trained model.

get/memberships/{membershipIdentifier}/trained-models/{trainedModelArn}

Path parameters

trainedModelArnstring required

The Amazon Resource Name (ARN) of the trained model that you are interested in.

membershipIdentifierstring required

The membership ID of the member that created the trained model that you are interested in.

Query parameters

versionIdentifierstring

The version identifier of the trained model to retrieve. If not specified, the operation returns information about the latest version of the trained model.

Response

Success

membershipIdentifierstring required

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

collaborationIdentifierstring required

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

trainedModelArnstring required

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

versionIdentifierstring

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

namestring required

The name of the trained model.

descriptionstring

The description of the trained model.

status'CREATE_PENDING' | 'CREATE_IN_PROGRESS' | 'CREATE_FAILED' | 'ACTIVE' | 'DELETE_PENDING' | 'DELETE_IN_PROGRESS' | 'DELETE_FAILED' | 'INACTIVE' | 'CANCEL_PENDING' | 'CANCEL_IN_PROGRESS' | 'CANCEL_FAILED' required

The status of the trained model.

configuredModelAlgorithmAssociationArnstring required

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

trainingInputMode'File' | 'FastFile' | 'Pipe'

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.

metricsStatus'PUBLISH_SUCCEEDED' | 'PUBLISH_FAILED'

The status of the model metrics.

metricsStatusDetailsstring

Details about the metrics status for the trained model.

logsStatus'PUBLISH_SUCCEEDED' | 'PUBLISH_FAILED'

The logs status for the trained model.

logsStatusDetailsstring

Details about the logs status for the trained model.

trainingContainerImageDigeststring

Information about the training image container.

mlModelTrainingPayerAccountIdstring

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

createTimestring date-time required

The time at which the trained model was created.

updateTimestring date-time required

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

hyperparametersobject

The hyperparameters that were used to create the trained model.

environmentobject

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

kmsKeyArnstring

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.

tagsobject
<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>
All 59 operations