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

Inherits:

Struct

Object
Struct
Aws::CleanRooms::Types::Membership

show all

Includes:: Structure

Defined in:: lib/aws-sdk-cleanrooms/types.rb

Overview

The membership object.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#arn ⇒ String

The unique ARN for the membership.
#collaboration_arn ⇒ String

The unique ARN for the membership’s associated collaboration.
#collaboration_creator_account_id ⇒ String

The identifier used to reference members of the collaboration.
#collaboration_creator_display_name ⇒ String

The display name of the collaboration creator.
#collaboration_id ⇒ String

The unique ID for the membership’s collaboration.
#collaboration_name ⇒ String

The name of the membership’s collaboration.
#create_time ⇒ Time

The time when the membership was created.
#default_job_result_configuration ⇒ Types::MembershipProtectedJobResultConfiguration

The default job result configuration for the membership.
#default_result_configuration ⇒ Types::MembershipProtectedQueryResultConfiguration

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

The unique ID of the membership.
#is_metrics_enabled ⇒ Boolean

An indicator as to whether Amazon CloudWatch metrics are enabled for the membership.
#job_log_status ⇒ String

An indicator as to whether job logging has been enabled or disabled for the collaboration.
#member_abilities ⇒ Array<String>

The abilities granted to the collaboration member.
#ml_member_abilities ⇒ Types::MLMemberAbilities

Specifies the ML member abilities that are granted to a collaboration member.
#payment_configuration ⇒ Types::MembershipPaymentConfiguration

The payment responsibilities accepted by the collaboration member.
#query_log_status ⇒ String

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

The status of the membership.
#update_time ⇒ Time

The time the membership metadata was last updated.

Instance Attribute Details

#arn ⇒ `String`

The unique ARN for the membership.

Returns:

(String)

# File 'lib/aws-sdk-cleanrooms/types.rb', line 6988

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)

# File 'lib/aws-sdk-cleanrooms/types.rb', line 6988

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)

# File 'lib/aws-sdk-cleanrooms/types.rb', line 6988

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)

# File 'lib/aws-sdk-cleanrooms/types.rb', line 6988

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)

# File 'lib/aws-sdk-cleanrooms/types.rb', line 6988

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)

# File 'lib/aws-sdk-cleanrooms/types.rb', line 6988

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)

# File 'lib/aws-sdk-cleanrooms/types.rb', line 6988

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:

(Types::MembershipProtectedJobResultConfiguration)

# File 'lib/aws-sdk-cleanrooms/types.rb', line 6988

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:

(Types::MembershipProtectedQueryResultConfiguration)

# File 'lib/aws-sdk-cleanrooms/types.rb', line 6988

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)

# File 'lib/aws-sdk-cleanrooms/types.rb', line 6988

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)

# File 'lib/aws-sdk-cleanrooms/types.rb', line 6988

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)

# File 'lib/aws-sdk-cleanrooms/types.rb', line 6988

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>)

# File 'lib/aws-sdk-cleanrooms/types.rb', line 6988

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:

(Types::MLMemberAbilities)

# File 'lib/aws-sdk-cleanrooms/types.rb', line 6988

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:

(Types::MembershipPaymentConfiguration)

# File 'lib/aws-sdk-cleanrooms/types.rb', line 6988

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)

# File 'lib/aws-sdk-cleanrooms/types.rb', line 6988

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)

# File 'lib/aws-sdk-cleanrooms/types.rb', line 6988

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)

# File 'lib/aws-sdk-cleanrooms/types.rb', line 6988

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

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

#collaboration_arn ⇒ String

#collaboration_creator_account_id ⇒ String

#collaboration_creator_display_name ⇒ String

#collaboration_id ⇒ String

#collaboration_name ⇒ String

#create_time ⇒ Time

#default_job_result_configuration ⇒ Types::MembershipProtectedJobResultConfiguration

#default_result_configuration ⇒ Types::MembershipProtectedQueryResultConfiguration

#id ⇒ String

#is_metrics_enabled ⇒ Boolean

#job_log_status ⇒ String

#member_abilities ⇒ Array<String>

#ml_member_abilities ⇒ Types::MLMemberAbilities

#payment_configuration ⇒ Types::MembershipPaymentConfiguration

#query_log_status ⇒ String

#status ⇒ String

#update_time ⇒ Time

#arn ⇒ `String`

#collaboration_arn ⇒ `String`

#collaboration_creator_account_id ⇒ `String`

#collaboration_creator_display_name ⇒ `String`

#collaboration_id ⇒ `String`

#collaboration_name ⇒ `String`

#create_time ⇒ `Time`

#default_job_result_configuration ⇒ `Types::MembershipProtectedJobResultConfiguration`

#default_result_configuration ⇒ `Types::MembershipProtectedQueryResultConfiguration`

#id ⇒ `String`

#is_metrics_enabled ⇒ `Boolean`

#job_log_status ⇒ `String`

#member_abilities ⇒ `Array<String>`

#ml_member_abilities ⇒ `Types::MLMemberAbilities`

#payment_configuration ⇒ `Types::MembershipPaymentConfiguration`

#query_log_status ⇒ `String`

#status ⇒ `String`

#update_time ⇒ `Time`