/AWS1/CL_CRMCOLLABORATION

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

CONSTRUCTOR

IMPORTING

Required arguments:

iv_id TYPE /AWS1/CRMUUID /AWS1/CRMUUID

The unique ID for the collaboration.

iv_arn TYPE /AWS1/CRMCOLLABORATIONARN /AWS1/CRMCOLLABORATIONARN

The unique ARN for the collaboration.

iv_name TYPE /AWS1/CRMCOLLABORATIONNAME /AWS1/CRMCOLLABORATIONNAME

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

iv_creatoraccountid TYPE /AWS1/CRMACCOUNTID /AWS1/CRMACCOUNTID

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

iv_creatordisplayname TYPE /AWS1/CRMDISPLAYNAME /AWS1/CRMDISPLAYNAME

A display name of the collaboration creator.

iv_createtime TYPE /AWS1/CRMTIMESTAMP /AWS1/CRMTIMESTAMP

The time when the collaboration was created.

iv_updatetime TYPE /AWS1/CRMTIMESTAMP /AWS1/CRMTIMESTAMP

The time the collaboration metadata was last updated.

iv_memberstatus TYPE /AWS1/CRMMEMBERSTATUS /AWS1/CRMMEMBERSTATUS

The status of a member in a collaboration.

iv_querylogstatus TYPE /AWS1/CRMCOLLABORATIONQUERYL00 /AWS1/CRMCOLLABORATIONQUERYL00

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.

Optional arguments:

iv_description TYPE /AWS1/CRMCOLLABORATIONDESC /AWS1/CRMCOLLABORATIONDESC

A description of the collaboration provided by the collaboration owner.

iv_membershipid TYPE /AWS1/CRMUUID /AWS1/CRMUUID

The unique ID for your membership within the collaboration.

iv_membershiparn TYPE /AWS1/CRMMEMBERSHIPARN /AWS1/CRMMEMBERSHIPARN

The unique ARN for your membership within the collaboration.

io_dataencryptionmetadata TYPE REF TO /AWS1/CL_CRMDATAENCMETADATA /AWS1/CL_CRMDATAENCMETADATA

The settings for client-side encryption for cryptographic computing.

iv_joblogstatus TYPE /AWS1/CRMCOLLABORATIONJOBLOG00 /AWS1/CRMCOLLABORATIONJOBLOG00

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.

iv_analyticsengine TYPE /AWS1/CRMANALYTICSENGINE /AWS1/CRMANALYTICSENGINE

The analytics engine for the collaboration.

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

it_autoapprovedchangetypes TYPE /AWS1/CL_CRMAUTOAPPDCHANGETY00=>TT_AUTOAPPROVEDCHANGETYPELIST TT_AUTOAPPROVEDCHANGETYPELIST

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

it_allowedresultregions TYPE /AWS1/CL_CRMALWDRESULTRGNS_W=>TT_ALLOWEDRESULTREGIONS TT_ALLOWEDRESULTREGIONS

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.

---

Queryable Attributes

id

The unique ID for the collaboration.

Accessible with the following methods

Method	Description
GET_ID()	Getter for ID, with configurable default
ASK_ID()	Getter for ID w/ exceptions if field has no value
HAS_ID()	Determine if ID has a value

arn

The unique ARN for the collaboration.

Accessible with the following methods

Method	Description
GET_ARN()	Getter for ARN, with configurable default
ASK_ARN()	Getter for ARN w/ exceptions if field has no value
HAS_ARN()	Determine if ARN has a value

name

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

Accessible with the following methods

Method	Description
GET_NAME()	Getter for NAME, with configurable default
ASK_NAME()	Getter for NAME w/ exceptions if field has no value
HAS_NAME()	Determine if NAME has a value

description

A description of the collaboration provided by the collaboration owner.

Accessible with the following methods

Method	Description
GET_DESCRIPTION()	Getter for DESCRIPTION, with configurable default
ASK_DESCRIPTION()	Getter for DESCRIPTION w/ exceptions if field has no value
HAS_DESCRIPTION()	Determine if DESCRIPTION has a value

creatorAccountId

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

Accessible with the following methods

Method	Description
GET_CREATORACCOUNTID()	Getter for CREATORACCOUNTID, with configurable default
ASK_CREATORACCOUNTID()	Getter for CREATORACCOUNTID w/ exceptions if field has no va
HAS_CREATORACCOUNTID()	Determine if CREATORACCOUNTID has a value

creatorDisplayName

A display name of the collaboration creator.

Accessible with the following methods

Method	Description
GET_CREATORDISPLAYNAME()	Getter for CREATORDISPLAYNAME, with configurable default
ASK_CREATORDISPLAYNAME()	Getter for CREATORDISPLAYNAME w/ exceptions if field has no
HAS_CREATORDISPLAYNAME()	Determine if CREATORDISPLAYNAME has a value

createTime

The time when the collaboration was created.

Accessible with the following methods

Method	Description
GET_CREATETIME()	Getter for CREATETIME, with configurable default
ASK_CREATETIME()	Getter for CREATETIME w/ exceptions if field has no value
HAS_CREATETIME()	Determine if CREATETIME has a value

updateTime

The time the collaboration metadata was last updated.

Accessible with the following methods

Method	Description
GET_UPDATETIME()	Getter for UPDATETIME, with configurable default
ASK_UPDATETIME()	Getter for UPDATETIME w/ exceptions if field has no value
HAS_UPDATETIME()	Determine if UPDATETIME has a value

memberStatus

The status of a member in a collaboration.

Accessible with the following methods

Method	Description
GET_MEMBERSTATUS()	Getter for MEMBERSTATUS, with configurable default
ASK_MEMBERSTATUS()	Getter for MEMBERSTATUS w/ exceptions if field has no value
HAS_MEMBERSTATUS()	Determine if MEMBERSTATUS has a value

membershipId

The unique ID for your membership within the collaboration.

Accessible with the following methods

Method	Description
GET_MEMBERSHIPID()	Getter for MEMBERSHIPID, with configurable default
ASK_MEMBERSHIPID()	Getter for MEMBERSHIPID w/ exceptions if field has no value
HAS_MEMBERSHIPID()	Determine if MEMBERSHIPID has a value

membershipArn

The unique ARN for your membership within the collaboration.

Accessible with the following methods

Method	Description
GET_MEMBERSHIPARN()	Getter for MEMBERSHIPARN, with configurable default
ASK_MEMBERSHIPARN()	Getter for MEMBERSHIPARN w/ exceptions if field has no value
HAS_MEMBERSHIPARN()	Determine if MEMBERSHIPARN has a value

dataEncryptionMetadata

The settings for client-side encryption for cryptographic computing.

Accessible with the following methods

Method	Description
GET_DATAENCRYPTIONMETADATA()	Getter for DATAENCRYPTIONMETADATA

queryLogStatus

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.

Accessible with the following methods

Method	Description
GET_QUERYLOGSTATUS()	Getter for QUERYLOGSTATUS, with configurable default
ASK_QUERYLOGSTATUS()	Getter for QUERYLOGSTATUS w/ exceptions if field has no valu
HAS_QUERYLOGSTATUS()	Determine if QUERYLOGSTATUS has a value

jobLogStatus

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.

Accessible with the following methods

Method	Description
GET_JOBLOGSTATUS()	Getter for JOBLOGSTATUS, with configurable default
ASK_JOBLOGSTATUS()	Getter for JOBLOGSTATUS w/ exceptions if field has no value
HAS_JOBLOGSTATUS()	Determine if JOBLOGSTATUS has a value

analyticsEngine

The analytics engine for the collaboration.

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

Accessible with the following methods

Method	Description
GET_ANALYTICSENGINE()	Getter for ANALYTICSENGINE, with configurable default
ASK_ANALYTICSENGINE()	Getter for ANALYTICSENGINE w/ exceptions if field has no val
HAS_ANALYTICSENGINE()	Determine if ANALYTICSENGINE has a value

autoApprovedChangeTypes

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

Accessible with the following methods

Method	Description
GET_AUTOAPPROVEDCHANGETYPES()	Getter for AUTOAPPROVEDCHANGETYPES, with configurable defaul
ASK_AUTOAPPROVEDCHANGETYPES()	Getter for AUTOAPPROVEDCHANGETYPES w/ exceptions if field ha
HAS_AUTOAPPROVEDCHANGETYPES()	Determine if AUTOAPPROVEDCHANGETYPES has a value

allowedResultRegions

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.

Accessible with the following methods

Method	Description
GET_ALLOWEDRESULTREGIONS()	Getter for ALLOWEDRESULTREGIONS, with configurable default
ASK_ALLOWEDRESULTREGIONS()	Getter for ALLOWEDRESULTREGIONS w/ exceptions if field has n
HAS_ALLOWEDRESULTREGIONS()	Determine if ALLOWEDRESULTREGIONS has a value