Class: Aws::CleanRooms::Types::Membership

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb

Overview

The membership object.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The unique ARN for the membership.

Returns:

  • (String) 


8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 8238

class Membership < Struct.new(
  :id,
  :arn,
  :collaboration_arn,
  :collaboration_id,
  :collaboration_creator_account_id,
  :collaboration_creator_display_name,
  :collaboration_name,
  :create_time,
  :update_time,
  :status,
  :member_abilities,
  :ml_member_abilities,
  :query_log_status,
  :job_log_status,
  :default_result_configuration,
  :default_job_result_configuration,
  :payment_configuration,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#collaboration_arn ⇒ String

The unique ARN for the membership's associated collaboration.

Returns:

  • (String) 


8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 8238

class Membership < Struct.new(
  :id,
  :arn,
  :collaboration_arn,
  :collaboration_id,
  :collaboration_creator_account_id,
  :collaboration_creator_display_name,
  :collaboration_name,
  :create_time,
  :update_time,
  :status,
  :member_abilities,
  :ml_member_abilities,
  :query_log_status,
  :job_log_status,
  :default_result_configuration,
  :default_job_result_configuration,
  :payment_configuration,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#collaboration_creator_account_id ⇒ String

The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.

Returns:

  • (String) 


8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 8238

class Membership < Struct.new(
  :id,
  :arn,
  :collaboration_arn,
  :collaboration_id,
  :collaboration_creator_account_id,
  :collaboration_creator_display_name,
  :collaboration_name,
  :create_time,
  :update_time,
  :status,
  :member_abilities,
  :ml_member_abilities,
  :query_log_status,
  :job_log_status,
  :default_result_configuration,
  :default_job_result_configuration,
  :payment_configuration,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#collaboration_creator_display_name ⇒ String

The display name of the collaboration creator.

Returns:

  • (String) 


8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 8238

class Membership < Struct.new(
  :id,
  :arn,
  :collaboration_arn,
  :collaboration_id,
  :collaboration_creator_account_id,
  :collaboration_creator_display_name,
  :collaboration_name,
  :create_time,
  :update_time,
  :status,
  :member_abilities,
  :ml_member_abilities,
  :query_log_status,
  :job_log_status,
  :default_result_configuration,
  :default_job_result_configuration,
  :payment_configuration,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#collaboration_id ⇒ String

The unique ID for the membership's collaboration.

Returns:

  • (String) 


8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 8238

class Membership < Struct.new(
  :id,
  :arn,
  :collaboration_arn,
  :collaboration_id,
  :collaboration_creator_account_id,
  :collaboration_creator_display_name,
  :collaboration_name,
  :create_time,
  :update_time,
  :status,
  :member_abilities,
  :ml_member_abilities,
  :query_log_status,
  :job_log_status,
  :default_result_configuration,
  :default_job_result_configuration,
  :payment_configuration,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#collaboration_name ⇒ String

The name of the membership's collaboration.

Returns:

  • (String) 


8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 8238

class Membership < Struct.new(
  :id,
  :arn,
  :collaboration_arn,
  :collaboration_id,
  :collaboration_creator_account_id,
  :collaboration_creator_display_name,
  :collaboration_name,
  :create_time,
  :update_time,
  :status,
  :member_abilities,
  :ml_member_abilities,
  :query_log_status,
  :job_log_status,
  :default_result_configuration,
  :default_job_result_configuration,
  :payment_configuration,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#create_time ⇒ Time

The time when the membership was created.

Returns:

  • (Time) 


8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 8238

class Membership < Struct.new(
  :id,
  :arn,
  :collaboration_arn,
  :collaboration_id,
  :collaboration_creator_account_id,
  :collaboration_creator_display_name,
  :collaboration_name,
  :create_time,
  :update_time,
  :status,
  :member_abilities,
  :ml_member_abilities,
  :query_log_status,
  :job_log_status,
  :default_result_configuration,
  :default_job_result_configuration,
  :payment_configuration,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#default_job_result_configuration ⇒ Types::MembershipProtectedJobResultConfiguration

The default job result configuration for the membership.

Returns:



8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 8238

class Membership < Struct.new(
  :id,
  :arn,
  :collaboration_arn,
  :collaboration_id,
  :collaboration_creator_account_id,
  :collaboration_creator_display_name,
  :collaboration_name,
  :create_time,
  :update_time,
  :status,
  :member_abilities,
  :ml_member_abilities,
  :query_log_status,
  :job_log_status,
  :default_result_configuration,
  :default_job_result_configuration,
  :payment_configuration,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#default_result_configuration ⇒ Types::MembershipProtectedQueryResultConfiguration

The default protected query result configuration as specified by the member who can receive results.

Returns:



8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 8238

class Membership < Struct.new(
  :id,
  :arn,
  :collaboration_arn,
  :collaboration_id,
  :collaboration_creator_account_id,
  :collaboration_creator_display_name,
  :collaboration_name,
  :create_time,
  :update_time,
  :status,
  :member_abilities,
  :ml_member_abilities,
  :query_log_status,
  :job_log_status,
  :default_result_configuration,
  :default_job_result_configuration,
  :payment_configuration,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The unique ID of the membership.

Returns:

  • (String) 


8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 8238

class Membership < Struct.new(
  :id,
  :arn,
  :collaboration_arn,
  :collaboration_id,
  :collaboration_creator_account_id,
  :collaboration_creator_display_name,
  :collaboration_name,
  :create_time,
  :update_time,
  :status,
  :member_abilities,
  :ml_member_abilities,
  :query_log_status,
  :job_log_status,
  :default_result_configuration,
  :default_job_result_configuration,
  :payment_configuration,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#is_metrics_enabled ⇒ Boolean

An indicator as to whether Amazon CloudWatch metrics are enabled for the membership.

When true, metrics about query execution are collected in Amazon CloudWatch.

Returns:

  • (Boolean) 


8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 8238

class Membership < Struct.new(
  :id,
  :arn,
  :collaboration_arn,
  :collaboration_id,
  :collaboration_creator_account_id,
  :collaboration_creator_display_name,
  :collaboration_name,
  :create_time,
  :update_time,
  :status,
  :member_abilities,
  :ml_member_abilities,
  :query_log_status,
  :job_log_status,
  :default_result_configuration,
  :default_job_result_configuration,
  :payment_configuration,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#job_log_status ⇒ String

An indicator as to whether job logging has been enabled or disabled for the collaboration.

When ENABLED, Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.

Returns:

  • (String) 


8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 8238

class Membership < Struct.new(
  :id,
  :arn,
  :collaboration_arn,
  :collaboration_id,
  :collaboration_creator_account_id,
  :collaboration_creator_display_name,
  :collaboration_name,
  :create_time,
  :update_time,
  :status,
  :member_abilities,
  :ml_member_abilities,
  :query_log_status,
  :job_log_status,
  :default_result_configuration,
  :default_job_result_configuration,
  :payment_configuration,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#member_abilities ⇒ Array<String>

The abilities granted to the collaboration member.

Returns:

  • (Array<String>) 


8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 8238

class Membership < Struct.new(
  :id,
  :arn,
  :collaboration_arn,
  :collaboration_id,
  :collaboration_creator_account_id,
  :collaboration_creator_display_name,
  :collaboration_name,
  :create_time,
  :update_time,
  :status,
  :member_abilities,
  :ml_member_abilities,
  :query_log_status,
  :job_log_status,
  :default_result_configuration,
  :default_job_result_configuration,
  :payment_configuration,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#ml_member_abilities ⇒ Types::MLMemberAbilities

Specifies the ML member abilities that are granted to a collaboration member.

Returns:



8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 8238

class Membership < Struct.new(
  :id,
  :arn,
  :collaboration_arn,
  :collaboration_id,
  :collaboration_creator_account_id,
  :collaboration_creator_display_name,
  :collaboration_name,
  :create_time,
  :update_time,
  :status,
  :member_abilities,
  :ml_member_abilities,
  :query_log_status,
  :job_log_status,
  :default_result_configuration,
  :default_job_result_configuration,
  :payment_configuration,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#payment_configuration ⇒ Types::MembershipPaymentConfiguration

The payment responsibilities accepted by the collaboration member.

Returns:



8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 8238

class Membership < Struct.new(
  :id,
  :arn,
  :collaboration_arn,
  :collaboration_id,
  :collaboration_creator_account_id,
  :collaboration_creator_display_name,
  :collaboration_name,
  :create_time,
  :update_time,
  :status,
  :member_abilities,
  :ml_member_abilities,
  :query_log_status,
  :job_log_status,
  :default_result_configuration,
  :default_job_result_configuration,
  :payment_configuration,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#query_log_status ⇒ String

An indicator as to whether query logging has been enabled or disabled for the membership.

When ENABLED, Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.

Returns:

  • (String) 


8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 8238

class Membership < Struct.new(
  :id,
  :arn,
  :collaboration_arn,
  :collaboration_id,
  :collaboration_creator_account_id,
  :collaboration_creator_display_name,
  :collaboration_name,
  :create_time,
  :update_time,
  :status,
  :member_abilities,
  :ml_member_abilities,
  :query_log_status,
  :job_log_status,
  :default_result_configuration,
  :default_job_result_configuration,
  :payment_configuration,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the membership.

Returns:

  • (String) 


8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 8238

class Membership < Struct.new(
  :id,
  :arn,
  :collaboration_arn,
  :collaboration_id,
  :collaboration_creator_account_id,
  :collaboration_creator_display_name,
  :collaboration_name,
  :create_time,
  :update_time,
  :status,
  :member_abilities,
  :ml_member_abilities,
  :query_log_status,
  :job_log_status,
  :default_result_configuration,
  :default_job_result_configuration,
  :payment_configuration,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#update_time ⇒ Time

The time the membership metadata was last updated.

Returns:

  • (Time) 


8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 8238

class Membership < Struct.new(
  :id,
  :arn,
  :collaboration_arn,
  :collaboration_id,
  :collaboration_creator_account_id,
  :collaboration_creator_display_name,
  :collaboration_name,
  :create_time,
  :update_time,
  :status,
  :member_abilities,
  :ml_member_abilities,
  :query_log_status,
  :job_log_status,
  :default_result_configuration,
  :default_job_result_configuration,
  :payment_configuration,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end