Class: Aws::CleanRoomsML::Types::GetTrainedModelResponse

Inherits:

Struct

• Object
• Struct
• Aws::CleanRoomsML::Types::GetTrainedModelResponse

Includes:

Structure

Defined in:

lib/aws-sdk-cleanroomsml/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #collaboration_identifier ⇒ String

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

• #configured_model_algorithm_association_arn ⇒ String

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

• #create_time ⇒ Time

  The time at which the trained model was created.

• #data_channels ⇒ Array<Types::ModelTrainingDataChannel>

  The data channels that were used for the trained model.

• #description ⇒ String

  The description of the trained model.

• #environment ⇒ Hash<String,String>

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

• #hyperparameters ⇒ Hash<String,String>

  The hyperparameters that were used to create the trained model.

• #kms_key_arn ⇒ String

  The Amazon Resource Name (ARN) of the KMS key.

• #logs_status ⇒ String

  The logs status for the trained model.

• #logs_status_details ⇒ String

  Details about the logs status for the trained model.

• #membership_identifier ⇒ String

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

• #metrics_status ⇒ String

  The status of the model metrics.

• #metrics_status_details ⇒ String

  Details about the metrics status for the trained model.

• #name ⇒ String

  The name of the trained model.

• #resource_config ⇒ Types::ResourceConfig

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

• #status ⇒ String

  The status of the trained model.

• #status_details ⇒ Types::StatusDetails

  Details about the status of a resource.

• #stopping_condition ⇒ Types::StoppingCondition

  The stopping condition that was used to terminate model training.

• #tags ⇒ Hash<String,String>

  The optional metadata that you applied to the resource to help you categorize and organize them.

• #trained_model_arn ⇒ String

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

• #training_container_image_digest ⇒ String

  Information about the training image container.

• #update_time ⇒ Time

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

Instance Attribute Details

#collaboration_identifier ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cleanroomsml/types.rb', line 3198

class GetTrainedModelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :trained_model_arn,
  :name,
  :description,
  :status,
  :status_details,
  :configured_model_algorithm_association_arn,
  :resource_config,
  :stopping_condition,
  :metrics_status,
  :metrics_status_details,
  :logs_status,
  :logs_status_details,
  :training_container_image_digest,
  :create_time,
  :update_time,
  :hyperparameters,
  :environment,
  :kms_key_arn,
  :tags,
  :data_channels)
  SENSITIVE = []
  include Aws::Structure
end

#configured_model_algorithm_association_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cleanroomsml/types.rb', line 3198

class GetTrainedModelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :trained_model_arn,
  :name,
  :description,
  :status,
  :status_details,
  :configured_model_algorithm_association_arn,
  :resource_config,
  :stopping_condition,
  :metrics_status,
  :metrics_status_details,
  :logs_status,
  :logs_status_details,
  :training_container_image_digest,
  :create_time,
  :update_time,
  :hyperparameters,
  :environment,
  :kms_key_arn,
  :tags,
  :data_channels)
  SENSITIVE = []
  include Aws::Structure
end

#create_time ⇒ Time

The time at which the trained model was created.

Returns:

• (Time)

# File 'lib/aws-sdk-cleanroomsml/types.rb', line 3198

class GetTrainedModelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :trained_model_arn,
  :name,
  :description,
  :status,
  :status_details,
  :configured_model_algorithm_association_arn,
  :resource_config,
  :stopping_condition,
  :metrics_status,
  :metrics_status_details,
  :logs_status,
  :logs_status_details,
  :training_container_image_digest,
  :create_time,
  :update_time,
  :hyperparameters,
  :environment,
  :kms_key_arn,
  :tags,
  :data_channels)
  SENSITIVE = []
  include Aws::Structure
end

#data_channels ⇒ Array<Types::ModelTrainingDataChannel>

The data channels that were used for the trained model.

Returns:

• (Array<Types::ModelTrainingDataChannel>)

# File 'lib/aws-sdk-cleanroomsml/types.rb', line 3198

class GetTrainedModelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :trained_model_arn,
  :name,
  :description,
  :status,
  :status_details,
  :configured_model_algorithm_association_arn,
  :resource_config,
  :stopping_condition,
  :metrics_status,
  :metrics_status_details,
  :logs_status,
  :logs_status_details,
  :training_container_image_digest,
  :create_time,
  :update_time,
  :hyperparameters,
  :environment,
  :kms_key_arn,
  :tags,
  :data_channels)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the trained model.

Returns:

• (String)

# File 'lib/aws-sdk-cleanroomsml/types.rb', line 3198

class GetTrainedModelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :trained_model_arn,
  :name,
  :description,
  :status,
  :status_details,
  :configured_model_algorithm_association_arn,
  :resource_config,
  :stopping_condition,
  :metrics_status,
  :metrics_status_details,
  :logs_status,
  :logs_status_details,
  :training_container_image_digest,
  :create_time,
  :update_time,
  :hyperparameters,
  :environment,
  :kms_key_arn,
  :tags,
  :data_channels)
  SENSITIVE = []
  include Aws::Structure
end

#environment ⇒ Hash<String,String>

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

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-cleanroomsml/types.rb', line 3198

class GetTrainedModelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :trained_model_arn,
  :name,
  :description,
  :status,
  :status_details,
  :configured_model_algorithm_association_arn,
  :resource_config,
  :stopping_condition,
  :metrics_status,
  :metrics_status_details,
  :logs_status,
  :logs_status_details,
  :training_container_image_digest,
  :create_time,
  :update_time,
  :hyperparameters,
  :environment,
  :kms_key_arn,
  :tags,
  :data_channels)
  SENSITIVE = []
  include Aws::Structure
end

#hyperparameters ⇒ Hash<String,String>

The hyperparameters that were used to create the trained model.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-cleanroomsml/types.rb', line 3198

class GetTrainedModelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :trained_model_arn,
  :name,
  :description,
  :status,
  :status_details,
  :configured_model_algorithm_association_arn,
  :resource_config,
  :stopping_condition,
  :metrics_status,
  :metrics_status_details,
  :logs_status,
  :logs_status_details,
  :training_container_image_digest,
  :create_time,
  :update_time,
  :hyperparameters,
  :environment,
  :kms_key_arn,
  :tags,
  :data_channels)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_arn ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-cleanroomsml/types.rb', line 3198

class GetTrainedModelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :trained_model_arn,
  :name,
  :description,
  :status,
  :status_details,
  :configured_model_algorithm_association_arn,
  :resource_config,
  :stopping_condition,
  :metrics_status,
  :metrics_status_details,
  :logs_status,
  :logs_status_details,
  :training_container_image_digest,
  :create_time,
  :update_time,
  :hyperparameters,
  :environment,
  :kms_key_arn,
  :tags,
  :data_channels)
  SENSITIVE = []
  include Aws::Structure
end

#logs_status ⇒ String

The logs status for the trained model.

Returns:

• (String)

# File 'lib/aws-sdk-cleanroomsml/types.rb', line 3198

class GetTrainedModelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :trained_model_arn,
  :name,
  :description,
  :status,
  :status_details,
  :configured_model_algorithm_association_arn,
  :resource_config,
  :stopping_condition,
  :metrics_status,
  :metrics_status_details,
  :logs_status,
  :logs_status_details,
  :training_container_image_digest,
  :create_time,
  :update_time,
  :hyperparameters,
  :environment,
  :kms_key_arn,
  :tags,
  :data_channels)
  SENSITIVE = []
  include Aws::Structure
end

#logs_status_details ⇒ String

Details about the logs status for the trained model.

Returns:

• (String)

# File 'lib/aws-sdk-cleanroomsml/types.rb', line 3198

class GetTrainedModelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :trained_model_arn,
  :name,
  :description,
  :status,
  :status_details,
  :configured_model_algorithm_association_arn,
  :resource_config,
  :stopping_condition,
  :metrics_status,
  :metrics_status_details,
  :logs_status,
  :logs_status_details,
  :training_container_image_digest,
  :create_time,
  :update_time,
  :hyperparameters,
  :environment,
  :kms_key_arn,
  :tags,
  :data_channels)
  SENSITIVE = []
  include Aws::Structure
end

#membership_identifier ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cleanroomsml/types.rb', line 3198

class GetTrainedModelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :trained_model_arn,
  :name,
  :description,
  :status,
  :status_details,
  :configured_model_algorithm_association_arn,
  :resource_config,
  :stopping_condition,
  :metrics_status,
  :metrics_status_details,
  :logs_status,
  :logs_status_details,
  :training_container_image_digest,
  :create_time,
  :update_time,
  :hyperparameters,
  :environment,
  :kms_key_arn,
  :tags,
  :data_channels)
  SENSITIVE = []
  include Aws::Structure
end

#metrics_status ⇒ String

The status of the model metrics.

Returns:

• (String)

# File 'lib/aws-sdk-cleanroomsml/types.rb', line 3198

class GetTrainedModelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :trained_model_arn,
  :name,
  :description,
  :status,
  :status_details,
  :configured_model_algorithm_association_arn,
  :resource_config,
  :stopping_condition,
  :metrics_status,
  :metrics_status_details,
  :logs_status,
  :logs_status_details,
  :training_container_image_digest,
  :create_time,
  :update_time,
  :hyperparameters,
  :environment,
  :kms_key_arn,
  :tags,
  :data_channels)
  SENSITIVE = []
  include Aws::Structure
end

#metrics_status_details ⇒ String

Details about the metrics status for the trained model.

Returns:

• (String)

# File 'lib/aws-sdk-cleanroomsml/types.rb', line 3198

class GetTrainedModelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :trained_model_arn,
  :name,
  :description,
  :status,
  :status_details,
  :configured_model_algorithm_association_arn,
  :resource_config,
  :stopping_condition,
  :metrics_status,
  :metrics_status_details,
  :logs_status,
  :logs_status_details,
  :training_container_image_digest,
  :create_time,
  :update_time,
  :hyperparameters,
  :environment,
  :kms_key_arn,
  :tags,
  :data_channels)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the trained model.

Returns:

• (String)

# File 'lib/aws-sdk-cleanroomsml/types.rb', line 3198

class GetTrainedModelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :trained_model_arn,
  :name,
  :description,
  :status,
  :status_details,
  :configured_model_algorithm_association_arn,
  :resource_config,
  :stopping_condition,
  :metrics_status,
  :metrics_status_details,
  :logs_status,
  :logs_status_details,
  :training_container_image_digest,
  :create_time,
  :update_time,
  :hyperparameters,
  :environment,
  :kms_key_arn,
  :tags,
  :data_channels)
  SENSITIVE = []
  include Aws::Structure
end

#resource_config ⇒ Types::ResourceConfig

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

Returns:

• (Types::ResourceConfig)

# File 'lib/aws-sdk-cleanroomsml/types.rb', line 3198

class GetTrainedModelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :trained_model_arn,
  :name,
  :description,
  :status,
  :status_details,
  :configured_model_algorithm_association_arn,
  :resource_config,
  :stopping_condition,
  :metrics_status,
  :metrics_status_details,
  :logs_status,
  :logs_status_details,
  :training_container_image_digest,
  :create_time,
  :update_time,
  :hyperparameters,
  :environment,
  :kms_key_arn,
  :tags,
  :data_channels)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the trained model.

Returns:

• (String)

# File 'lib/aws-sdk-cleanroomsml/types.rb', line 3198

class GetTrainedModelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :trained_model_arn,
  :name,
  :description,
  :status,
  :status_details,
  :configured_model_algorithm_association_arn,
  :resource_config,
  :stopping_condition,
  :metrics_status,
  :metrics_status_details,
  :logs_status,
  :logs_status_details,
  :training_container_image_digest,
  :create_time,
  :update_time,
  :hyperparameters,
  :environment,
  :kms_key_arn,
  :tags,
  :data_channels)
  SENSITIVE = []
  include Aws::Structure
end

#status_details ⇒ Types::StatusDetails

Details about the status of a resource.

Returns:

• (Types::StatusDetails)

# File 'lib/aws-sdk-cleanroomsml/types.rb', line 3198

class GetTrainedModelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :trained_model_arn,
  :name,
  :description,
  :status,
  :status_details,
  :configured_model_algorithm_association_arn,
  :resource_config,
  :stopping_condition,
  :metrics_status,
  :metrics_status_details,
  :logs_status,
  :logs_status_details,
  :training_container_image_digest,
  :create_time,
  :update_time,
  :hyperparameters,
  :environment,
  :kms_key_arn,
  :tags,
  :data_channels)
  SENSITIVE = []
  include Aws::Structure
end

#stopping_condition ⇒ Types::StoppingCondition

The stopping condition that was used to terminate model training.

Returns:

• (Types::StoppingCondition)

# File 'lib/aws-sdk-cleanroomsml/types.rb', line 3198

class GetTrainedModelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :trained_model_arn,
  :name,
  :description,
  :status,
  :status_details,
  :configured_model_algorithm_association_arn,
  :resource_config,
  :stopping_condition,
  :metrics_status,
  :metrics_status_details,
  :logs_status,
  :logs_status_details,
  :training_container_image_digest,
  :create_time,
  :update_time,
  :hyperparameters,
  :environment,
  :kms_key_arn,
  :tags,
  :data_channels)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

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.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-cleanroomsml/types.rb', line 3198

class GetTrainedModelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :trained_model_arn,
  :name,
  :description,
  :status,
  :status_details,
  :configured_model_algorithm_association_arn,
  :resource_config,
  :stopping_condition,
  :metrics_status,
  :metrics_status_details,
  :logs_status,
  :logs_status_details,
  :training_container_image_digest,
  :create_time,
  :update_time,
  :hyperparameters,
  :environment,
  :kms_key_arn,
  :tags,
  :data_channels)
  SENSITIVE = []
  include Aws::Structure
end

#trained_model_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cleanroomsml/types.rb', line 3198

class GetTrainedModelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :trained_model_arn,
  :name,
  :description,
  :status,
  :status_details,
  :configured_model_algorithm_association_arn,
  :resource_config,
  :stopping_condition,
  :metrics_status,
  :metrics_status_details,
  :logs_status,
  :logs_status_details,
  :training_container_image_digest,
  :create_time,
  :update_time,
  :hyperparameters,
  :environment,
  :kms_key_arn,
  :tags,
  :data_channels)
  SENSITIVE = []
  include Aws::Structure
end

#training_container_image_digest ⇒ String

Information about the training image container.

Returns:

• (String)

# File 'lib/aws-sdk-cleanroomsml/types.rb', line 3198

class GetTrainedModelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :trained_model_arn,
  :name,
  :description,
  :status,
  :status_details,
  :configured_model_algorithm_association_arn,
  :resource_config,
  :stopping_condition,
  :metrics_status,
  :metrics_status_details,
  :logs_status,
  :logs_status_details,
  :training_container_image_digest,
  :create_time,
  :update_time,
  :hyperparameters,
  :environment,
  :kms_key_arn,
  :tags,
  :data_channels)
  SENSITIVE = []
  include Aws::Structure
end

#update_time ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-cleanroomsml/types.rb', line 3198

class GetTrainedModelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :trained_model_arn,
  :name,
  :description,
  :status,
  :status_details,
  :configured_model_algorithm_association_arn,
  :resource_config,
  :stopping_condition,
  :metrics_status,
  :metrics_status_details,
  :logs_status,
  :logs_status_details,
  :training_container_image_digest,
  :create_time,
  :update_time,
  :hyperparameters,
  :environment,
  :kms_key_arn,
  :tags,
  :data_channels)
  SENSITIVE = []
  include Aws::Structure
end