Class: Aws::CleanRoomsML::Types::GetMLInputChannelResponse

Inherits:

Struct

Object
Struct
Aws::CleanRoomsML::Types::GetMLInputChannelResponse

show all

Defined in:: gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#collaboration_identifier ⇒ String
The collaboration ID of the collaboration that contains the ML input channel.
#configured_model_algorithm_associations ⇒ Array<String>
The configured model algorithm associations that were used to create the ML input channel.
#create_time ⇒ Time
The time at which the ML input channel was created.
#description ⇒ String
The description of the ML input channel.
#input_channel ⇒ Types::InputChannel
The input channel that was used to create the ML input channel.
#kms_key_arn ⇒ String
The Amazon Resource Name (ARN) of the KMS key that was used to create the ML input channel.
#membership_identifier ⇒ String
The membership ID of the membership that contains the ML input channel.
#ml_input_channel_arn ⇒ String
The Amazon Resource Name (ARN) of the ML input channel.
#name ⇒ String
The name of the ML input channel.
#number_of_files ⇒ Float
The number of files in the ML input channel.
#number_of_records ⇒ Integer
The number of records in the ML input channel.
#privacy_budgets ⇒ Types::PrivacyBudgets
Returns the privacy budgets that control access to this Clean Rooms ML input channel.
#protected_query_identifier ⇒ String
The ID of the protected query that was used to create the ML input channel.
#retention_in_days ⇒ Integer
The number of days to keep the data in the ML input channel.
#size_in_gb ⇒ Float
The size, in GB, of the ML input channel.
#status ⇒ String
The status of the ML input channel.
#status_details ⇒ Types::StatusDetails
Details about the status of a resource.
#synthetic_data_configuration ⇒ Types::SyntheticDataConfiguration
The synthetic data configuration for this ML input channel, including parameters for generating privacy-preserving synthetic data and evaluation scores for measuring the privacy of the generated data.
#tags ⇒ Hash<String,String>
The optional metadata that you applied to the resource to help you categorize and organize them.
#update_time ⇒ Time
The most recent time at which the ML input channel was updated.

Instance Attribute Details

#collaboration_identifier ⇒ `String`

The collaboration ID of the collaboration that contains the ML input channel.

Returns:

(String)

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

class GetMLInputChannelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :ml_input_channel_arn,
  :name,
  :configured_model_algorithm_associations,
  :status,
  :status_details,
  :retention_in_days,
  :number_of_records,
  :privacy_budgets,
  :description,
  :synthetic_data_configuration,
  :create_time,
  :update_time,
  :input_channel,
  :protected_query_identifier,
  :number_of_files,
  :size_in_gb,
  :kms_key_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#configured_model_algorithm_associations ⇒ `Array<String>`

The configured model algorithm associations that were used to create the ML input channel.

Returns:

(Array<String>)

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

class GetMLInputChannelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :ml_input_channel_arn,
  :name,
  :configured_model_algorithm_associations,
  :status,
  :status_details,
  :retention_in_days,
  :number_of_records,
  :privacy_budgets,
  :description,
  :synthetic_data_configuration,
  :create_time,
  :update_time,
  :input_channel,
  :protected_query_identifier,
  :number_of_files,
  :size_in_gb,
  :kms_key_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#create_time ⇒ `Time`

The time at which the ML input channel was created.

Returns:

(Time)

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

class GetMLInputChannelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :ml_input_channel_arn,
  :name,
  :configured_model_algorithm_associations,
  :status,
  :status_details,
  :retention_in_days,
  :number_of_records,
  :privacy_budgets,
  :description,
  :synthetic_data_configuration,
  :create_time,
  :update_time,
  :input_channel,
  :protected_query_identifier,
  :number_of_files,
  :size_in_gb,
  :kms_key_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

The description of the ML input channel.

Returns:

(String)

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

class GetMLInputChannelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :ml_input_channel_arn,
  :name,
  :configured_model_algorithm_associations,
  :status,
  :status_details,
  :retention_in_days,
  :number_of_records,
  :privacy_budgets,
  :description,
  :synthetic_data_configuration,
  :create_time,
  :update_time,
  :input_channel,
  :protected_query_identifier,
  :number_of_files,
  :size_in_gb,
  :kms_key_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#input_channel ⇒ `Types::InputChannel`

The input channel that was used to create the ML input channel.

Returns:

(Types::InputChannel)

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

class GetMLInputChannelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :ml_input_channel_arn,
  :name,
  :configured_model_algorithm_associations,
  :status,
  :status_details,
  :retention_in_days,
  :number_of_records,
  :privacy_budgets,
  :description,
  :synthetic_data_configuration,
  :create_time,
  :update_time,
  :input_channel,
  :protected_query_identifier,
  :number_of_files,
  :size_in_gb,
  :kms_key_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_arn ⇒ `String`

The Amazon Resource Name (ARN) of the KMS key that was used to create the ML input channel.

Returns:

(String)

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

class GetMLInputChannelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :ml_input_channel_arn,
  :name,
  :configured_model_algorithm_associations,
  :status,
  :status_details,
  :retention_in_days,
  :number_of_records,
  :privacy_budgets,
  :description,
  :synthetic_data_configuration,
  :create_time,
  :update_time,
  :input_channel,
  :protected_query_identifier,
  :number_of_files,
  :size_in_gb,
  :kms_key_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#membership_identifier ⇒ `String`

The membership ID of the membership that contains the ML input channel.

Returns:

(String)

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

class GetMLInputChannelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :ml_input_channel_arn,
  :name,
  :configured_model_algorithm_associations,
  :status,
  :status_details,
  :retention_in_days,
  :number_of_records,
  :privacy_budgets,
  :description,
  :synthetic_data_configuration,
  :create_time,
  :update_time,
  :input_channel,
  :protected_query_identifier,
  :number_of_files,
  :size_in_gb,
  :kms_key_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#ml_input_channel_arn ⇒ `String`

The Amazon Resource Name (ARN) of the ML input channel.

Returns:

(String)

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

class GetMLInputChannelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :ml_input_channel_arn,
  :name,
  :configured_model_algorithm_associations,
  :status,
  :status_details,
  :retention_in_days,
  :number_of_records,
  :privacy_budgets,
  :description,
  :synthetic_data_configuration,
  :create_time,
  :update_time,
  :input_channel,
  :protected_query_identifier,
  :number_of_files,
  :size_in_gb,
  :kms_key_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `String`

The name of the ML input channel.

Returns:

(String)

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

class GetMLInputChannelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :ml_input_channel_arn,
  :name,
  :configured_model_algorithm_associations,
  :status,
  :status_details,
  :retention_in_days,
  :number_of_records,
  :privacy_budgets,
  :description,
  :synthetic_data_configuration,
  :create_time,
  :update_time,
  :input_channel,
  :protected_query_identifier,
  :number_of_files,
  :size_in_gb,
  :kms_key_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#number_of_files ⇒ `Float`

The number of files in the ML input channel.

Returns:

(Float)

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

class GetMLInputChannelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :ml_input_channel_arn,
  :name,
  :configured_model_algorithm_associations,
  :status,
  :status_details,
  :retention_in_days,
  :number_of_records,
  :privacy_budgets,
  :description,
  :synthetic_data_configuration,
  :create_time,
  :update_time,
  :input_channel,
  :protected_query_identifier,
  :number_of_files,
  :size_in_gb,
  :kms_key_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#number_of_records ⇒ `Integer`

The number of records in the ML input channel.

Returns:

(Integer)

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

class GetMLInputChannelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :ml_input_channel_arn,
  :name,
  :configured_model_algorithm_associations,
  :status,
  :status_details,
  :retention_in_days,
  :number_of_records,
  :privacy_budgets,
  :description,
  :synthetic_data_configuration,
  :create_time,
  :update_time,
  :input_channel,
  :protected_query_identifier,
  :number_of_files,
  :size_in_gb,
  :kms_key_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#privacy_budgets ⇒ `Types::PrivacyBudgets`

Returns the privacy budgets that control access to this Clean Rooms ML input channel. Use these budgets to monitor and limit resource consumption over specified time periods.

Returns:

(Types::PrivacyBudgets)

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

class GetMLInputChannelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :ml_input_channel_arn,
  :name,
  :configured_model_algorithm_associations,
  :status,
  :status_details,
  :retention_in_days,
  :number_of_records,
  :privacy_budgets,
  :description,
  :synthetic_data_configuration,
  :create_time,
  :update_time,
  :input_channel,
  :protected_query_identifier,
  :number_of_files,
  :size_in_gb,
  :kms_key_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#protected_query_identifier ⇒ `String`

The ID of the protected query that was used to create the ML input channel.

Returns:

(String)

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

class GetMLInputChannelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :ml_input_channel_arn,
  :name,
  :configured_model_algorithm_associations,
  :status,
  :status_details,
  :retention_in_days,
  :number_of_records,
  :privacy_budgets,
  :description,
  :synthetic_data_configuration,
  :create_time,
  :update_time,
  :input_channel,
  :protected_query_identifier,
  :number_of_files,
  :size_in_gb,
  :kms_key_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#retention_in_days ⇒ `Integer`

The number of days to keep the data in the ML input channel.

Returns:

(Integer)

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

class GetMLInputChannelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :ml_input_channel_arn,
  :name,
  :configured_model_algorithm_associations,
  :status,
  :status_details,
  :retention_in_days,
  :number_of_records,
  :privacy_budgets,
  :description,
  :synthetic_data_configuration,
  :create_time,
  :update_time,
  :input_channel,
  :protected_query_identifier,
  :number_of_files,
  :size_in_gb,
  :kms_key_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#size_in_gb ⇒ `Float`

The size, in GB, of the ML input channel.

Returns:

(Float)

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

class GetMLInputChannelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :ml_input_channel_arn,
  :name,
  :configured_model_algorithm_associations,
  :status,
  :status_details,
  :retention_in_days,
  :number_of_records,
  :privacy_budgets,
  :description,
  :synthetic_data_configuration,
  :create_time,
  :update_time,
  :input_channel,
  :protected_query_identifier,
  :number_of_files,
  :size_in_gb,
  :kms_key_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `String`

The status of the ML input channel.

Returns:

(String)

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

class GetMLInputChannelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :ml_input_channel_arn,
  :name,
  :configured_model_algorithm_associations,
  :status,
  :status_details,
  :retention_in_days,
  :number_of_records,
  :privacy_budgets,
  :description,
  :synthetic_data_configuration,
  :create_time,
  :update_time,
  :input_channel,
  :protected_query_identifier,
  :number_of_files,
  :size_in_gb,
  :kms_key_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#status_details ⇒ `Types::StatusDetails`

Details about the status of a resource.

Returns:

(Types::StatusDetails)

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

class GetMLInputChannelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :ml_input_channel_arn,
  :name,
  :configured_model_algorithm_associations,
  :status,
  :status_details,
  :retention_in_days,
  :number_of_records,
  :privacy_budgets,
  :description,
  :synthetic_data_configuration,
  :create_time,
  :update_time,
  :input_channel,
  :protected_query_identifier,
  :number_of_files,
  :size_in_gb,
  :kms_key_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#synthetic_data_configuration ⇒ `Types::SyntheticDataConfiguration`

The synthetic data configuration for this ML input channel, including parameters for generating privacy-preserving synthetic data and evaluation scores for measuring the privacy of the generated data.

Returns:

(Types::SyntheticDataConfiguration)

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

class GetMLInputChannelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :ml_input_channel_arn,
  :name,
  :configured_model_algorithm_associations,
  :status,
  :status_details,
  :retention_in_days,
  :number_of_records,
  :privacy_budgets,
  :description,
  :synthetic_data_configuration,
  :create_time,
  :update_time,
  :input_channel,
  :protected_query_identifier,
  :number_of_files,
  :size_in_gb,
  :kms_key_arn,
  :tags)
  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 'gems/aws-sdk-cleanroomsml/lib/aws-sdk-cleanroomsml/types.rb', line 3126

class GetMLInputChannelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :ml_input_channel_arn,
  :name,
  :configured_model_algorithm_associations,
  :status,
  :status_details,
  :retention_in_days,
  :number_of_records,
  :privacy_budgets,
  :description,
  :synthetic_data_configuration,
  :create_time,
  :update_time,
  :input_channel,
  :protected_query_identifier,
  :number_of_files,
  :size_in_gb,
  :kms_key_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#update_time ⇒ `Time`

The most recent time at which the ML input channel was updated.

Returns:

(Time)

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

class GetMLInputChannelResponse < Struct.new(
  :membership_identifier,
  :collaboration_identifier,
  :ml_input_channel_arn,
  :name,
  :configured_model_algorithm_associations,
  :status,
  :status_details,
  :retention_in_days,
  :number_of_records,
  :privacy_budgets,
  :description,
  :synthetic_data_configuration,
  :create_time,
  :update_time,
  :input_channel,
  :protected_query_identifier,
  :number_of_files,
  :size_in_gb,
  :kms_key_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::CleanRoomsML::Types::GetMLInputChannelResponse

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#collaboration_identifier ⇒ String

#configured_model_algorithm_associations ⇒ Array<String>

#create_time ⇒ Time

#description ⇒ String

#input_channel ⇒ Types::InputChannel

#kms_key_arn ⇒ String

#membership_identifier ⇒ String

#ml_input_channel_arn ⇒ String

#name ⇒ String

#number_of_files ⇒ Float

#number_of_records ⇒ Integer

#privacy_budgets ⇒ Types::PrivacyBudgets

#protected_query_identifier ⇒ String

#retention_in_days ⇒ Integer

#size_in_gb ⇒ Float

#status ⇒ String

#status_details ⇒ Types::StatusDetails

#synthetic_data_configuration ⇒ Types::SyntheticDataConfiguration

#tags ⇒ Hash<String,String>

#update_time ⇒ Time

#collaboration_identifier ⇒ `String`

#configured_model_algorithm_associations ⇒ `Array<String>`

#create_time ⇒ `Time`

#description ⇒ `String`

#input_channel ⇒ `Types::InputChannel`

#kms_key_arn ⇒ `String`

#membership_identifier ⇒ `String`

#ml_input_channel_arn ⇒ `String`

#name ⇒ `String`

#number_of_files ⇒ `Float`

#number_of_records ⇒ `Integer`

#privacy_budgets ⇒ `Types::PrivacyBudgets`

#protected_query_identifier ⇒ `String`

#retention_in_days ⇒ `Integer`

#size_in_gb ⇒ `Float`

#status ⇒ `String`

#status_details ⇒ `Types::StatusDetails`

#synthetic_data_configuration ⇒ `Types::SyntheticDataConfiguration`

#tags ⇒ `Hash<String,String>`

#update_time ⇒ `Time`