GetCollaborationAnalysisTemplate - AWS Clean Rooms


Retrieves an analysis template within a collaboration.

Request Syntax

GET /collaborations/collaborationIdentifier/analysistemplates/analysisTemplateArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.

Length Constraints: Minimum length of 0. Maximum length of 200.

Pattern: arn:aws:cleanrooms:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+/analysistemplate/[\d\w-]+

Required: Yes


A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.

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 does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "collaborationAnalysisTemplate": { "analysisParameters": [ { "defaultValue": "string", "name": "string", "type": "string" } ], "arn": "string", "collaborationArn": "string", "collaborationId": "string", "createTime": number, "creatorAccountId": "string", "description": "string", "format": "string", "id": "string", "name": "string", "schema": { "referencedTables": [ "string" ] }, "source": { ... }, "updateTime": number, "validations": [ { "reasons": [ { "message": "string" } ], "status": "string", "type": "string" } ] } }

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 analysis template within a collaboration.

Type: CollaborationAnalysisTemplate 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 references a resource which does not exist.

HTTP Status Code: 404


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: