UpdateCollaboration - AWS Clean Rooms


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

Request Syntax

PATCH /collaborations/collaborationIdentifier HTTP/1.1 Content-type: application/json { "description": "string", "name": "string" }

URI Request Parameters

The request uses the following URI parameters.


The identifier for the collaboration.

Length Constraints: Fixed length of 36.

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

Request Body

The request accepts the following data in JSON format.


A description of the collaboration.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: (?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*

Required: No


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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: (?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "collaboration": { "arn": "string", "createTime": number, "creatorAccountId": "string", "creatorDisplayName": "string", "dataEncryptionMetadata": { "allowCleartext": boolean, "allowDuplicates": boolean, "allowJoinsOnColumnsWithDifferentNames": boolean, "preserveNulls": boolean }, "description": "string", "id": "string", "membershipArn": "string", "membershipId": "string", "memberStatus": "string", "name": "string", "queryLogStatus": "string", "updateTime": number } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


The entire collaboration that has been updated.

Type: Collaboration object


For information about the errors that are common to all actions, see Common Errors.


Caller does not have sufficient access to perform this action.

HTTP Status Code: 403


Unexpected error during processing of request.

HTTP Status Code: 500


Request was denied due to request throttling.

HTTP Status Code: 429


The input fails to satisfy the specified constraints.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: