Class: Aws::CleanRooms::Types::Collaboration

Inherits:

Struct

• Object
• Struct
• Aws::CleanRooms::Types::Collaboration

Defined in:

gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb

Overview

The multi-party data share environment. The collaboration contains metadata about its purpose and participants.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #allowed_result_regions ⇒ Array<String>

  The Amazon Web Services Regions where collaboration query results can be stored.

• #analytics_engine ⇒ String

  The analytics engine for the collaboration.

• #arn ⇒ String

  The unique ARN for the collaboration.

• #auto_approved_change_types ⇒ Array<String>

  The types of change requests that are automatically approved for this collaboration.

• #create_time ⇒ Time

  The time when the collaboration was created.

• #creator_account_id ⇒ String

  The identifier used to reference members of the collaboration.

• #creator_display_name ⇒ String

  A display name of the collaboration creator.

• #data_encryption_metadata ⇒ Types::DataEncryptionMetadata

  The settings for client-side encryption for cryptographic computing.

• #description ⇒ String

  A description of the collaboration provided by the collaboration owner.

• #id ⇒ String

  The unique ID for the collaboration.

• #is_metrics_enabled ⇒ Boolean

  An indicator as to whether metrics are enabled for the collaboration.

• #job_log_status ⇒ String

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

• #member_status ⇒ String

  The status of a member in a collaboration.

• #membership_arn ⇒ String

  The unique ARN for your membership within the collaboration.

• #membership_id ⇒ String

  The unique ID for your membership within the collaboration.

• #name ⇒ String

  A human-readable identifier provided by the collaboration owner.

• #query_log_status ⇒ String

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

• #update_time ⇒ Time

  The time the collaboration metadata was last updated.

Instance Attribute Details

#allowed_result_regions ⇒ Array<String>

The Amazon Web Services Regions where collaboration query results can be stored. Returns the list of Region identifiers that were specified when the collaboration was created. This list is used to enforce regional storage policies and compliance requirements.

Returns:

• (Array<String>)

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

class Collaboration < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :creator_account_id,
  :creator_display_name,
  :create_time,
  :update_time,
  :member_status,
  :membership_id,
  :membership_arn,
  :data_encryption_metadata,
  :query_log_status,
  :job_log_status,
  :analytics_engine,
  :auto_approved_change_types,
  :allowed_result_regions,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#analytics_engine ⇒ String

The analytics engine for the collaboration.

After July 16, 2025, the CLEAN_ROOMS_SQL parameter will no longer be available.

Returns:

• (String)

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

class Collaboration < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :creator_account_id,
  :creator_display_name,
  :create_time,
  :update_time,
  :member_status,
  :membership_id,
  :membership_arn,
  :data_encryption_metadata,
  :query_log_status,
  :job_log_status,
  :analytics_engine,
  :auto_approved_change_types,
  :allowed_result_regions,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#arn ⇒ String

The unique ARN for the collaboration.

Returns:

• (String)

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

class Collaboration < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :creator_account_id,
  :creator_display_name,
  :create_time,
  :update_time,
  :member_status,
  :membership_id,
  :membership_arn,
  :data_encryption_metadata,
  :query_log_status,
  :job_log_status,
  :analytics_engine,
  :auto_approved_change_types,
  :allowed_result_regions,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#auto_approved_change_types ⇒ Array<String>

The types of change requests that are automatically approved for this collaboration.

Returns:

• (Array<String>)

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

class Collaboration < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :creator_account_id,
  :creator_display_name,
  :create_time,
  :update_time,
  :member_status,
  :membership_id,
  :membership_arn,
  :data_encryption_metadata,
  :query_log_status,
  :job_log_status,
  :analytics_engine,
  :auto_approved_change_types,
  :allowed_result_regions,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#create_time ⇒ Time

The time when the collaboration was created.

Returns:

• (Time)

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

class Collaboration < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :creator_account_id,
  :creator_display_name,
  :create_time,
  :update_time,
  :member_status,
  :membership_id,
  :membership_arn,
  :data_encryption_metadata,
  :query_log_status,
  :job_log_status,
  :analytics_engine,
  :auto_approved_change_types,
  :allowed_result_regions,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#creator_account_id ⇒ String

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

Returns:

• (String)

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

class Collaboration < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :creator_account_id,
  :creator_display_name,
  :create_time,
  :update_time,
  :member_status,
  :membership_id,
  :membership_arn,
  :data_encryption_metadata,
  :query_log_status,
  :job_log_status,
  :analytics_engine,
  :auto_approved_change_types,
  :allowed_result_regions,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#creator_display_name ⇒ String

A display name of the collaboration creator.

Returns:

• (String)

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

class Collaboration < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :creator_account_id,
  :creator_display_name,
  :create_time,
  :update_time,
  :member_status,
  :membership_id,
  :membership_arn,
  :data_encryption_metadata,
  :query_log_status,
  :job_log_status,
  :analytics_engine,
  :auto_approved_change_types,
  :allowed_result_regions,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#data_encryption_metadata ⇒ Types::DataEncryptionMetadata

The settings for client-side encryption for cryptographic computing.

Returns:

• (Types::DataEncryptionMetadata)

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

class Collaboration < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :creator_account_id,
  :creator_display_name,
  :create_time,
  :update_time,
  :member_status,
  :membership_id,
  :membership_arn,
  :data_encryption_metadata,
  :query_log_status,
  :job_log_status,
  :analytics_engine,
  :auto_approved_change_types,
  :allowed_result_regions,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the collaboration provided by the collaboration owner.

Returns:

• (String)

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

class Collaboration < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :creator_account_id,
  :creator_display_name,
  :create_time,
  :update_time,
  :member_status,
  :membership_id,
  :membership_arn,
  :data_encryption_metadata,
  :query_log_status,
  :job_log_status,
  :analytics_engine,
  :auto_approved_change_types,
  :allowed_result_regions,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The unique ID for the collaboration.

Returns:

• (String)

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

class Collaboration < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :creator_account_id,
  :creator_display_name,
  :create_time,
  :update_time,
  :member_status,
  :membership_id,
  :membership_arn,
  :data_encryption_metadata,
  :query_log_status,
  :job_log_status,
  :analytics_engine,
  :auto_approved_change_types,
  :allowed_result_regions,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#is_metrics_enabled ⇒ Boolean

An indicator as to whether metrics are enabled for the collaboration.

When true, collaboration members can opt in to Amazon CloudWatch metrics for their membership queries.

Returns:

• (Boolean)

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

class Collaboration < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :creator_account_id,
  :creator_display_name,
  :create_time,
  :update_time,
  :member_status,
  :membership_id,
  :membership_arn,
  :data_encryption_metadata,
  :query_log_status,
  :job_log_status,
  :analytics_engine,
  :auto_approved_change_types,
  :allowed_result_regions,
  :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 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 1699

class Collaboration < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :creator_account_id,
  :creator_display_name,
  :create_time,
  :update_time,
  :member_status,
  :membership_id,
  :membership_arn,
  :data_encryption_metadata,
  :query_log_status,
  :job_log_status,
  :analytics_engine,
  :auto_approved_change_types,
  :allowed_result_regions,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#member_status ⇒ String

The status of a member in a collaboration.

Returns:

• (String)

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

class Collaboration < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :creator_account_id,
  :creator_display_name,
  :create_time,
  :update_time,
  :member_status,
  :membership_id,
  :membership_arn,
  :data_encryption_metadata,
  :query_log_status,
  :job_log_status,
  :analytics_engine,
  :auto_approved_change_types,
  :allowed_result_regions,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#membership_arn ⇒ String

The unique ARN for your membership within the collaboration.

Returns:

• (String)

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

class Collaboration < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :creator_account_id,
  :creator_display_name,
  :create_time,
  :update_time,
  :member_status,
  :membership_id,
  :membership_arn,
  :data_encryption_metadata,
  :query_log_status,
  :job_log_status,
  :analytics_engine,
  :auto_approved_change_types,
  :allowed_result_regions,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#membership_id ⇒ String

The unique ID for your membership within the collaboration.

Returns:

• (String)

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

class Collaboration < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :creator_account_id,
  :creator_display_name,
  :create_time,
  :update_time,
  :member_status,
  :membership_id,
  :membership_arn,
  :data_encryption_metadata,
  :query_log_status,
  :job_log_status,
  :analytics_engine,
  :auto_approved_change_types,
  :allowed_result_regions,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

A human-readable identifier provided by the collaboration owner. Display names are not unique.

Returns:

• (String)

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

class Collaboration < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :creator_account_id,
  :creator_display_name,
  :create_time,
  :update_time,
  :member_status,
  :membership_id,
  :membership_arn,
  :data_encryption_metadata,
  :query_log_status,
  :job_log_status,
  :analytics_engine,
  :auto_approved_change_types,
  :allowed_result_regions,
  :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 collaboration.

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 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 1699

class Collaboration < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :creator_account_id,
  :creator_display_name,
  :create_time,
  :update_time,
  :member_status,
  :membership_id,
  :membership_arn,
  :data_encryption_metadata,
  :query_log_status,
  :job_log_status,
  :analytics_engine,
  :auto_approved_change_types,
  :allowed_result_regions,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#update_time ⇒ Time

The time the collaboration metadata was last updated.

Returns:

• (Time)

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

class Collaboration < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :creator_account_id,
  :creator_display_name,
  :create_time,
  :update_time,
  :member_status,
  :membership_id,
  :membership_arn,
  :data_encryption_metadata,
  :query_log_status,
  :job_log_status,
  :analytics_engine,
  :auto_approved_change_types,
  :allowed_result_regions,
  :is_metrics_enabled)
  SENSITIVE = []
  include Aws::Structure
end