Struct Collaboration 

#[non_exhaustive]
pub struct Collaboration {

    pub id: String,
    pub arn: String,
    pub name: String,
    pub description: Option<String>,
    pub creator_account_id: String,
    pub creator_display_name: String,
    pub create_time: DateTime,
    pub update_time: DateTime,
    pub member_status: MemberStatus,
    pub membership_id: Option<String>,
    pub membership_arn: Option<String>,
    pub data_encryption_metadata: Option<DataEncryptionMetadata>,
    pub query_log_status: CollaborationQueryLogStatus,
    pub job_log_status: Option<CollaborationJobLogStatus>,
    pub analytics_engine: Option<AnalyticsEngine>,
    pub auto_approved_change_types: Option<Vec<AutoApprovedChangeType>>,
    pub allowed_result_regions: Option<Vec<SupportedS3Region>>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: String

The unique ID for the collaboration.

arn: String

The unique ARN for the collaboration.

name: String

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

description: Option<String>

A description of the collaboration provided by the collaboration owner.

creator_account_id: String

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

creator_display_name: String

A display name of the collaboration creator.

create_time: DateTime

The time when the collaboration was created.

update_time: DateTime

The time the collaboration metadata was last updated.

member_status: MemberStatus

The status of a member in a collaboration.

membership_id: Option<String>

The unique ID for your membership within the collaboration.

membership_arn: Option<String>

The unique ARN for your membership within the collaboration.

data_encryption_metadata: Option<DataEncryptionMetadata>

The settings for client-side encryption for cryptographic computing.

query_log_status: CollaborationQueryLogStatus

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.

job_log_status: Option<CollaborationJobLogStatus>

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.

analytics_engine: Option<AnalyticsEngine>

The analytics engine for the collaboration.

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

auto_approved_change_types: Option<Vec<AutoApprovedChangeType>>

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

allowed_result_regions: Option<Vec<SupportedS3Region>>

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.

Implementations

impl Collaboration

pub fn id(&self) -> &str

The unique ID for the collaboration.

pub fn arn(&self) -> &str

The unique ARN for the collaboration.

pub fn name(&self) -> &str

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

pub fn description(&self) -> Option<&str>

A description of the collaboration provided by the collaboration owner.

pub fn creator_account_id(&self) -> &str

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

pub fn creator_display_name(&self) -> &str

A display name of the collaboration creator.

pub fn create_time(&self) -> &DateTime

The time when the collaboration was created.

pub fn update_time(&self) -> &DateTime

The time the collaboration metadata was last updated.

pub fn member_status(&self) -> &MemberStatus

The status of a member in a collaboration.

pub fn membership_id(&self) -> Option<&str>

The unique ID for your membership within the collaboration.

pub fn membership_arn(&self) -> Option<&str>

The unique ARN for your membership within the collaboration.

pub fn data_encryption_metadata(&self) -> Option<&DataEncryptionMetadata>

The settings for client-side encryption for cryptographic computing.

pub fn query_log_status(&self) -> &CollaborationQueryLogStatus

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.

pub fn job_log_status(&self) -> Option<&CollaborationJobLogStatus>

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.

pub fn analytics_engine(&self) -> Option<&AnalyticsEngine>

The analytics engine for the collaboration.

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

pub fn auto_approved_change_types(&self) -> &[AutoApprovedChangeType]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .auto_approved_change_types.is_none().

pub fn allowed_result_regions(&self) -> &[SupportedS3Region]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .allowed_result_regions.is_none().

impl Collaboration

pub fn builder() -> CollaborationBuilder

Creates a new builder-style object to manufacture Collaboration.

Trait Implementations

impl Clone for Collaboration

fn clone(&self) -> Collaboration

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Collaboration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Collaboration

fn eq(&self, other: &Collaboration) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Collaboration