AWS Clean Rooms Service

2025/09/03 - AWS Clean Rooms Service - 3 new3 updated api methods

Changes  Added support for adding new data provider members to an existing collaboration.

ListCollaborationChangeRequests (new) Link ¶

Lists all change requests for a collaboration with pagination support. Returns change requests sorted by creation time.

See also: AWS API Documentation

Request Syntax

client.list_collaboration_change_requests(
    collaborationIdentifier='string',
    status='PENDING'|'APPROVED'|'CANCELLED'|'DENIED'|'COMMITTED',
    nextToken='string',
    maxResults=123
)
type collaborationIdentifier:

string

param collaborationIdentifier:

[REQUIRED]

The identifier of the collaboration that the change request is made against.

type status:

string

param status:

A filter to only return change requests with the specified status.

type nextToken:

string

param nextToken:

The pagination token that's used to fetch the next set of results.

type maxResults:

integer

param maxResults:

The maximum number of results that are returned for an API request call.

rtype:

dict

returns:

Response Syntax

{
    'collaborationChangeRequestSummaries': [
        {
            'id': 'string',
            'collaborationId': 'string',
            'createTime': datetime(2015, 1, 1),
            'updateTime': datetime(2015, 1, 1),
            'status': 'PENDING'|'APPROVED'|'CANCELLED'|'DENIED'|'COMMITTED',
            'isAutoApproved': True|False,
            'changes': [
                {
                    'specificationType': 'MEMBER',
                    'specification': {
                        'member': {
                            'accountId': 'string',
                            'memberAbilities': [
                                'CAN_QUERY'|'CAN_RECEIVE_RESULTS'|'CAN_RUN_JOB',
                            ],
                            'displayName': 'string'
                        }
                    },
                    'types': [
                        'ADD_MEMBER',
                    ]
                },
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • collaborationChangeRequestSummaries (list) --

      The list of collaboration change request summaries.

      • (dict) --

        Summary information about a collaboration change request.

        • id (string) --

          The unique identifier for the change request.

        • collaborationId (string) --

          The unique identifier for the collaboration.

        • createTime (datetime) --

          The time when the change request was created.

        • updateTime (datetime) --

          The time when the change request was last updated.

        • status (string) --

          The current status of the change request.

        • isAutoApproved (boolean) --

          Whether the change request was automatically approved.

        • changes (list) --

          Summary of the changes in this change request.

          • (dict) --

            Represents a single change within a collaboration change request, containing the change identifier and specification.

            • specificationType (string) --

              The type of specification for this change.

            • specification (dict) --

              The specification details for this change.

              • member (dict) --

                The member change specification when the change type is MEMBER.

                • accountId (string) --

                  The Amazon Web Services account ID of the member to add to the collaboration.

                • memberAbilities (list) --

                  The abilities granted to the collaboration member. These determine what actions the member can perform within the collaboration.

                  • (string) --

                • displayName (string) --

                  Specifies the display name that will be shown for this member in the collaboration. While this field is required when inviting new members, it becomes optional when modifying abilities of existing collaboration members.

            • types (list) --

              The list of change types that were applied.

              • (string) --

    • nextToken (string) --

      The pagination token that's used to fetch the next set of results.

CreateCollaborationChangeRequest (new) Link ¶

Creates a new change request to modify an existing collaboration. This enables post-creation modifications to collaborations through a structured API-driven approach.

See also: AWS API Documentation

Request Syntax

client.create_collaboration_change_request(
    collaborationIdentifier='string',
    changes=[
        {
            'specificationType': 'MEMBER',
            'specification': {
                'member': {
                    'accountId': 'string',
                    'memberAbilities': [
                        'CAN_QUERY'|'CAN_RECEIVE_RESULTS'|'CAN_RUN_JOB',
                    ],
                    'displayName': 'string'
                }
            }
        },
    ]
)
type collaborationIdentifier:

string

param collaborationIdentifier:

[REQUIRED]

The identifier of the collaboration that the change request is made against.

type changes:

list

param changes:

[REQUIRED]

The list of changes to apply to the collaboration. Each change specifies the type of modification and the details of what should be changed.

  • (dict) --

    Specifies a change to apply to a collaboration.

    • specificationType (string) -- [REQUIRED]

      The type of specification for the change. Currently supports MEMBER for member-related changes.

    • specification (dict) -- [REQUIRED]

      The specification details for the change. The structure depends on the specification type.

      • member (dict) --

        The member change specification when the change type is MEMBER.

        • accountId (string) -- [REQUIRED]

          The Amazon Web Services account ID of the member to add to the collaboration.

        • memberAbilities (list) -- [REQUIRED]

          The abilities granted to the collaboration member. These determine what actions the member can perform within the collaboration.

          • (string) --

        • displayName (string) --

          Specifies the display name that will be shown for this member in the collaboration. While this field is required when inviting new members, it becomes optional when modifying abilities of existing collaboration members.

rtype:

dict

returns:

Response Syntax

{
    'collaborationChangeRequest': {
        'id': 'string',
        'collaborationId': 'string',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1),
        'status': 'PENDING'|'APPROVED'|'CANCELLED'|'DENIED'|'COMMITTED',
        'isAutoApproved': True|False,
        'changes': [
            {
                'specificationType': 'MEMBER',
                'specification': {
                    'member': {
                        'accountId': 'string',
                        'memberAbilities': [
                            'CAN_QUERY'|'CAN_RECEIVE_RESULTS'|'CAN_RUN_JOB',
                        ],
                        'displayName': 'string'
                    }
                },
                'types': [
                    'ADD_MEMBER',
                ]
            },
        ]
    }
}

Response Structure

  • (dict) --

    • collaborationChangeRequest (dict) --

      Represents a request to modify a collaboration. Change requests enable structured modifications to collaborations after they have been created.

      • id (string) --

        The unique identifier for the change request.

      • collaborationId (string) --

        The unique identifier for the collaboration being modified.

      • createTime (datetime) --

        The time when the change request was created.

      • updateTime (datetime) --

        The time when the change request was last updated.

      • status (string) --

        The current status of the change request. Valid values are PENDING, APPROVED, DENIED, COMMITTED, and CANCELLED.

      • isAutoApproved (boolean) --

        Whether the change request was automatically approved based on the collaboration's auto-approval settings.

      • changes (list) --

        The list of changes specified in this change request.

        • (dict) --

          Represents a single change within a collaboration change request, containing the change identifier and specification.

          • specificationType (string) --

            The type of specification for this change.

          • specification (dict) --

            The specification details for this change.

            • member (dict) --

              The member change specification when the change type is MEMBER.

              • accountId (string) --

                The Amazon Web Services account ID of the member to add to the collaboration.

              • memberAbilities (list) --

                The abilities granted to the collaboration member. These determine what actions the member can perform within the collaboration.

                • (string) --

              • displayName (string) --

                Specifies the display name that will be shown for this member in the collaboration. While this field is required when inviting new members, it becomes optional when modifying abilities of existing collaboration members.

          • types (list) --

            The list of change types that were applied.

            • (string) --

GetCollaborationChangeRequest (new) Link ¶

Retrieves detailed information about a specific collaboration change request.

See also: AWS API Documentation

Request Syntax

client.get_collaboration_change_request(
    collaborationIdentifier='string',
    changeRequestIdentifier='string'
)
type collaborationIdentifier:

string

param collaborationIdentifier:

[REQUIRED]

The identifier of the collaboration that the change request is made against.

type changeRequestIdentifier:

string

param changeRequestIdentifier:

[REQUIRED]

A unique identifier for the change request to retrieve.

rtype:

dict

returns:

Response Syntax

{
    'collaborationChangeRequest': {
        'id': 'string',
        'collaborationId': 'string',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1),
        'status': 'PENDING'|'APPROVED'|'CANCELLED'|'DENIED'|'COMMITTED',
        'isAutoApproved': True|False,
        'changes': [
            {
                'specificationType': 'MEMBER',
                'specification': {
                    'member': {
                        'accountId': 'string',
                        'memberAbilities': [
                            'CAN_QUERY'|'CAN_RECEIVE_RESULTS'|'CAN_RUN_JOB',
                        ],
                        'displayName': 'string'
                    }
                },
                'types': [
                    'ADD_MEMBER',
                ]
            },
        ]
    }
}

Response Structure

  • (dict) --

    • collaborationChangeRequest (dict) --

      The collaboration change request that was requested.

      • id (string) --

        The unique identifier for the change request.

      • collaborationId (string) --

        The unique identifier for the collaboration being modified.

      • createTime (datetime) --

        The time when the change request was created.

      • updateTime (datetime) --

        The time when the change request was last updated.

      • status (string) --

        The current status of the change request. Valid values are PENDING, APPROVED, DENIED, COMMITTED, and CANCELLED.

      • isAutoApproved (boolean) --

        Whether the change request was automatically approved based on the collaboration's auto-approval settings.

      • changes (list) --

        The list of changes specified in this change request.

        • (dict) --

          Represents a single change within a collaboration change request, containing the change identifier and specification.

          • specificationType (string) --

            The type of specification for this change.

          • specification (dict) --

            The specification details for this change.

            • member (dict) --

              The member change specification when the change type is MEMBER.

              • accountId (string) --

                The Amazon Web Services account ID of the member to add to the collaboration.

              • memberAbilities (list) --

                The abilities granted to the collaboration member. These determine what actions the member can perform within the collaboration.

                • (string) --

              • displayName (string) --

                Specifies the display name that will be shown for this member in the collaboration. While this field is required when inviting new members, it becomes optional when modifying abilities of existing collaboration members.

          • types (list) --

            The list of change types that were applied.

            • (string) --

CreateCollaboration (updated) Link ¶
Changes (request, response)
Request 
{'autoApprovedChangeRequestTypes': ['ADD_MEMBER']}
Response 
{'collaboration': {'autoApprovedChangeTypes': ['ADD_MEMBER']}}

Creates a new collaboration.

See also: AWS API Documentation

Request Syntax

client.create_collaboration(
    members=[
        {
            'accountId': 'string',
            'memberAbilities': [
                'CAN_QUERY'|'CAN_RECEIVE_RESULTS'|'CAN_RUN_JOB',
            ],
            'mlMemberAbilities': {
                'customMLMemberAbilities': [
                    'CAN_RECEIVE_MODEL_OUTPUT'|'CAN_RECEIVE_INFERENCE_OUTPUT',
                ]
            },
            'displayName': 'string',
            'paymentConfiguration': {
                'queryCompute': {
                    'isResponsible': True|False
                },
                'machineLearning': {
                    'modelTraining': {
                        'isResponsible': True|False
                    },
                    'modelInference': {
                        'isResponsible': True|False
                    }
                },
                'jobCompute': {
                    'isResponsible': True|False
                }
            }
        },
    ],
    name='string',
    description='string',
    creatorMemberAbilities=[
        'CAN_QUERY'|'CAN_RECEIVE_RESULTS'|'CAN_RUN_JOB',
    ],
    creatorMLMemberAbilities={
        'customMLMemberAbilities': [
            'CAN_RECEIVE_MODEL_OUTPUT'|'CAN_RECEIVE_INFERENCE_OUTPUT',
        ]
    },
    creatorDisplayName='string',
    dataEncryptionMetadata={
        'allowCleartext': True|False,
        'allowDuplicates': True|False,
        'allowJoinsOnColumnsWithDifferentNames': True|False,
        'preserveNulls': True|False
    },
    queryLogStatus='ENABLED'|'DISABLED',
    jobLogStatus='ENABLED'|'DISABLED',
    tags={
        'string': 'string'
    },
    creatorPaymentConfiguration={
        'queryCompute': {
            'isResponsible': True|False
        },
        'machineLearning': {
            'modelTraining': {
                'isResponsible': True|False
            },
            'modelInference': {
                'isResponsible': True|False
            }
        },
        'jobCompute': {
            'isResponsible': True|False
        }
    },
    analyticsEngine='SPARK'|'CLEAN_ROOMS_SQL',
    autoApprovedChangeRequestTypes=[
        'ADD_MEMBER',
    ]
)
type members:

list

param members:

[REQUIRED]

A list of initial members, not including the creator. This list is immutable.

  • (dict) --

    Basic metadata used to construct a new member.

    • accountId (string) -- [REQUIRED]

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

    • memberAbilities (list) -- [REQUIRED]

      The abilities granted to the collaboration member.

      • (string) --

    • mlMemberAbilities (dict) --

      The ML abilities granted to the collaboration member.

      • customMLMemberAbilities (list) -- [REQUIRED]

        The custom ML member abilities for a collaboration member.

        • (string) --

    • displayName (string) -- [REQUIRED]

      The member's display name.

    • paymentConfiguration (dict) --

      The collaboration member's payment responsibilities set by the collaboration creator.

      If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer.

      • queryCompute (dict) -- [REQUIRED]

        The collaboration member's payment responsibilities set by the collaboration creator for query compute costs.

        • isResponsible (boolean) -- [REQUIRED]

          Indicates whether the collaboration creator has configured the collaboration member to pay for query compute costs ( TRUE) or has not configured the collaboration member to pay for query compute costs ( FALSE).

          Exactly one member can be configured to pay for query compute costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.

          If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.

      • machineLearning (dict) --

        An object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator.

        • modelTraining (dict) --

          The payment responsibilities accepted by the member for model training.

          • isResponsible (boolean) -- [REQUIRED]

            Indicates whether the collaboration creator has configured the collaboration member to pay for model training costs ( TRUE) or has not configured the collaboration member to pay for model training costs ( FALSE).

            Exactly one member can be configured to pay for model training costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.

            If the collaboration creator hasn't specified anyone as the member paying for model training costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.

        • modelInference (dict) --

          The payment responsibilities accepted by the member for model inference.

          • isResponsible (boolean) -- [REQUIRED]

            Indicates whether the collaboration creator has configured the collaboration member to pay for model inference costs ( TRUE) or has not configured the collaboration member to pay for model inference costs ( FALSE).

            Exactly one member can be configured to pay for model inference costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.

            If the collaboration creator hasn't specified anyone as the member paying for model inference costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.

      • jobCompute (dict) --

        The compute configuration for the job.

        • isResponsible (boolean) -- [REQUIRED]

          Indicates whether the collaboration creator has configured the collaboration member to pay for query and job compute costs ( TRUE) or has not configured the collaboration member to pay for query and job compute costs ( FALSE).

          Exactly one member can be configured to pay for query and job compute costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.

          An error is returned if the collaboration creator sets a FALSE value for the member who can run queries and jobs.

type name:

string

param name:

[REQUIRED]

The display name for a collaboration.

type description:

string

param description:

[REQUIRED]

A description of the collaboration provided by the collaboration owner.

type creatorMemberAbilities:

list

param creatorMemberAbilities:

[REQUIRED]

The abilities granted to the collaboration creator.

  • (string) --

type creatorMLMemberAbilities:

dict

param creatorMLMemberAbilities:

The ML abilities granted to the collaboration creator.

  • customMLMemberAbilities (list) -- [REQUIRED]

    The custom ML member abilities for a collaboration member.

    • (string) --

type creatorDisplayName:

string

param creatorDisplayName:

[REQUIRED]

The display name of the collaboration creator.

type dataEncryptionMetadata:

dict

param dataEncryptionMetadata:

The settings for client-side encryption with Cryptographic Computing for Clean Rooms.

  • allowCleartext (boolean) -- [REQUIRED]

    Indicates whether encrypted tables can contain cleartext data ( TRUE) or are to cryptographically process every column ( FALSE).

  • allowDuplicates (boolean) -- [REQUIRED]

    Indicates whether Fingerprint columns can contain duplicate entries ( TRUE) or are to contain only non-repeated values ( FALSE).

  • allowJoinsOnColumnsWithDifferentNames (boolean) -- [REQUIRED]

    Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name ( TRUE) or can only be joined on Fingerprint columns of the same name ( FALSE).

  • preserveNulls (boolean) -- [REQUIRED]

    Indicates whether NULL values are to be copied as NULL to encrypted tables ( TRUE) or cryptographically processed ( FALSE).

type queryLogStatus:

string

param queryLogStatus:

[REQUIRED]

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.

type jobLogStatus:

string

param jobLogStatus:

Specifies whether job logs are enabled for this collaboration.

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

type tags:

dict

param tags:

An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.

  • (string) --

    • (string) --

type creatorPaymentConfiguration:

dict

param creatorPaymentConfiguration:

The collaboration creator's payment responsibilities set by the collaboration creator.

If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer.

  • queryCompute (dict) -- [REQUIRED]

    The collaboration member's payment responsibilities set by the collaboration creator for query compute costs.

    • isResponsible (boolean) -- [REQUIRED]

      Indicates whether the collaboration creator has configured the collaboration member to pay for query compute costs ( TRUE) or has not configured the collaboration member to pay for query compute costs ( FALSE).

      Exactly one member can be configured to pay for query compute costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.

      If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.

  • machineLearning (dict) --

    An object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator.

    • modelTraining (dict) --

      The payment responsibilities accepted by the member for model training.

      • isResponsible (boolean) -- [REQUIRED]

        Indicates whether the collaboration creator has configured the collaboration member to pay for model training costs ( TRUE) or has not configured the collaboration member to pay for model training costs ( FALSE).

        Exactly one member can be configured to pay for model training costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.

        If the collaboration creator hasn't specified anyone as the member paying for model training costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.

    • modelInference (dict) --

      The payment responsibilities accepted by the member for model inference.

      • isResponsible (boolean) -- [REQUIRED]

        Indicates whether the collaboration creator has configured the collaboration member to pay for model inference costs ( TRUE) or has not configured the collaboration member to pay for model inference costs ( FALSE).

        Exactly one member can be configured to pay for model inference costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.

        If the collaboration creator hasn't specified anyone as the member paying for model inference costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.

  • jobCompute (dict) --

    The compute configuration for the job.

    • isResponsible (boolean) -- [REQUIRED]

      Indicates whether the collaboration creator has configured the collaboration member to pay for query and job compute costs ( TRUE) or has not configured the collaboration member to pay for query and job compute costs ( FALSE).

      Exactly one member can be configured to pay for query and job compute costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.

      An error is returned if the collaboration creator sets a FALSE value for the member who can run queries and jobs.

type analyticsEngine:

string

param analyticsEngine:

The analytics engine.

type autoApprovedChangeRequestTypes:

list

param autoApprovedChangeRequestTypes:

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

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'collaboration': {
        'id': 'string',
        'arn': 'string',
        'name': 'string',
        'description': 'string',
        'creatorAccountId': 'string',
        'creatorDisplayName': 'string',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1),
        'memberStatus': 'INVITED'|'ACTIVE'|'LEFT'|'REMOVED',
        'membershipId': 'string',
        'membershipArn': 'string',
        'dataEncryptionMetadata': {
            'allowCleartext': True|False,
            'allowDuplicates': True|False,
            'allowJoinsOnColumnsWithDifferentNames': True|False,
            'preserveNulls': True|False
        },
        'queryLogStatus': 'ENABLED'|'DISABLED',
        'jobLogStatus': 'ENABLED'|'DISABLED',
        'analyticsEngine': 'SPARK'|'CLEAN_ROOMS_SQL',
        'autoApprovedChangeTypes': [
            'ADD_MEMBER',
        ]
    }
}

Response Structure

  • (dict) --

    • collaboration (dict) --

      The collaboration.

      • 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 (string) --

        A description of the collaboration provided by the collaboration owner.

      • creatorAccountId (string) --

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

      • creatorDisplayName (string) --

        A display name of the collaboration creator.

      • createTime (datetime) --

        The time when the collaboration was created.

      • updateTime (datetime) --

        The time the collaboration metadata was last updated.

      • memberStatus (string) --

        The status of a member in a collaboration.

      • membershipId (string) --

        The unique ID for your membership within the collaboration.

      • membershipArn (string) --

        The unique ARN for your membership within the collaboration.

      • dataEncryptionMetadata (dict) --

        The settings for client-side encryption for cryptographic computing.

        • allowCleartext (boolean) --

          Indicates whether encrypted tables can contain cleartext data ( TRUE) or are to cryptographically process every column ( FALSE).

        • allowDuplicates (boolean) --

          Indicates whether Fingerprint columns can contain duplicate entries ( TRUE) or are to contain only non-repeated values ( FALSE).

        • allowJoinsOnColumnsWithDifferentNames (boolean) --

          Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name ( TRUE) or can only be joined on Fingerprint columns of the same name ( FALSE).

        • preserveNulls (boolean) --

          Indicates whether NULL values are to be copied as NULL to encrypted tables ( TRUE) or cryptographically processed ( FALSE).

      • queryLogStatus (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.

      • jobLogStatus (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.

      • analyticsEngine (string) --

        The analytics engine for the collaboration.

      • autoApprovedChangeTypes (list) --

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

        • (string) --

GetCollaboration (updated) Link ¶
Changes (response) 
{'collaboration': {'autoApprovedChangeTypes': ['ADD_MEMBER']}}

Returns metadata about a collaboration.

See also: AWS API Documentation

Request Syntax

client.get_collaboration(
    collaborationIdentifier='string'
)
type collaborationIdentifier:

string

param collaborationIdentifier:

[REQUIRED]

The identifier for the collaboration.

rtype:

dict

returns:

Response Syntax

{
    'collaboration': {
        'id': 'string',
        'arn': 'string',
        'name': 'string',
        'description': 'string',
        'creatorAccountId': 'string',
        'creatorDisplayName': 'string',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1),
        'memberStatus': 'INVITED'|'ACTIVE'|'LEFT'|'REMOVED',
        'membershipId': 'string',
        'membershipArn': 'string',
        'dataEncryptionMetadata': {
            'allowCleartext': True|False,
            'allowDuplicates': True|False,
            'allowJoinsOnColumnsWithDifferentNames': True|False,
            'preserveNulls': True|False
        },
        'queryLogStatus': 'ENABLED'|'DISABLED',
        'jobLogStatus': 'ENABLED'|'DISABLED',
        'analyticsEngine': 'SPARK'|'CLEAN_ROOMS_SQL',
        'autoApprovedChangeTypes': [
            'ADD_MEMBER',
        ]
    }
}

Response Structure

  • (dict) --

    • collaboration (dict) --

      The entire collaboration for this identifier.

      • 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 (string) --

        A description of the collaboration provided by the collaboration owner.

      • creatorAccountId (string) --

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

      • creatorDisplayName (string) --

        A display name of the collaboration creator.

      • createTime (datetime) --

        The time when the collaboration was created.

      • updateTime (datetime) --

        The time the collaboration metadata was last updated.

      • memberStatus (string) --

        The status of a member in a collaboration.

      • membershipId (string) --

        The unique ID for your membership within the collaboration.

      • membershipArn (string) --

        The unique ARN for your membership within the collaboration.

      • dataEncryptionMetadata (dict) --

        The settings for client-side encryption for cryptographic computing.

        • allowCleartext (boolean) --

          Indicates whether encrypted tables can contain cleartext data ( TRUE) or are to cryptographically process every column ( FALSE).

        • allowDuplicates (boolean) --

          Indicates whether Fingerprint columns can contain duplicate entries ( TRUE) or are to contain only non-repeated values ( FALSE).

        • allowJoinsOnColumnsWithDifferentNames (boolean) --

          Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name ( TRUE) or can only be joined on Fingerprint columns of the same name ( FALSE).

        • preserveNulls (boolean) --

          Indicates whether NULL values are to be copied as NULL to encrypted tables ( TRUE) or cryptographically processed ( FALSE).

      • queryLogStatus (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.

      • jobLogStatus (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.

      • analyticsEngine (string) --

        The analytics engine for the collaboration.

      • autoApprovedChangeTypes (list) --

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

        • (string) --

UpdateCollaboration (updated) Link ¶
Changes (response) 
{'collaboration': {'autoApprovedChangeTypes': ['ADD_MEMBER']}}

Updates collaboration metadata and can only be called by the collaboration owner.

See also: AWS API Documentation

Request Syntax

client.update_collaboration(
    collaborationIdentifier='string',
    name='string',
    description='string',
    analyticsEngine='SPARK'|'CLEAN_ROOMS_SQL'
)
type collaborationIdentifier:

string

param collaborationIdentifier:

[REQUIRED]

The identifier for the collaboration.

type name:

string

param name:

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

type description:

string

param description:

A description of the collaboration.

type analyticsEngine:

string

param analyticsEngine:

The analytics engine.

rtype:

dict

returns:

Response Syntax

{
    'collaboration': {
        'id': 'string',
        'arn': 'string',
        'name': 'string',
        'description': 'string',
        'creatorAccountId': 'string',
        'creatorDisplayName': 'string',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1),
        'memberStatus': 'INVITED'|'ACTIVE'|'LEFT'|'REMOVED',
        'membershipId': 'string',
        'membershipArn': 'string',
        'dataEncryptionMetadata': {
            'allowCleartext': True|False,
            'allowDuplicates': True|False,
            'allowJoinsOnColumnsWithDifferentNames': True|False,
            'preserveNulls': True|False
        },
        'queryLogStatus': 'ENABLED'|'DISABLED',
        'jobLogStatus': 'ENABLED'|'DISABLED',
        'analyticsEngine': 'SPARK'|'CLEAN_ROOMS_SQL',
        'autoApprovedChangeTypes': [
            'ADD_MEMBER',
        ]
    }
}

Response Structure

  • (dict) --

    • collaboration (dict) --

      The entire collaboration that has been updated.

      • 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 (string) --

        A description of the collaboration provided by the collaboration owner.

      • creatorAccountId (string) --

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

      • creatorDisplayName (string) --

        A display name of the collaboration creator.

      • createTime (datetime) --

        The time when the collaboration was created.

      • updateTime (datetime) --

        The time the collaboration metadata was last updated.

      • memberStatus (string) --

        The status of a member in a collaboration.

      • membershipId (string) --

        The unique ID for your membership within the collaboration.

      • membershipArn (string) --

        The unique ARN for your membership within the collaboration.

      • dataEncryptionMetadata (dict) --

        The settings for client-side encryption for cryptographic computing.

        • allowCleartext (boolean) --

          Indicates whether encrypted tables can contain cleartext data ( TRUE) or are to cryptographically process every column ( FALSE).

        • allowDuplicates (boolean) --

          Indicates whether Fingerprint columns can contain duplicate entries ( TRUE) or are to contain only non-repeated values ( FALSE).

        • allowJoinsOnColumnsWithDifferentNames (boolean) --

          Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name ( TRUE) or can only be joined on Fingerprint columns of the same name ( FALSE).

        • preserveNulls (boolean) --

          Indicates whether NULL values are to be copied as NULL to encrypted tables ( TRUE) or cryptographically processed ( FALSE).

      • queryLogStatus (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.

      • jobLogStatus (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.

      • analyticsEngine (string) --

        The analytics engine for the collaboration.

      • autoApprovedChangeTypes (list) --

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

        • (string) --