CollaborationAnalysisTemplate

The analysis template within a collaboration.

arn

The Amazon Resource Name (ARN) of the analysis template.

Type: String

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

collaborationArn

The unique ARN for the analysis template’s associated collaboration.

Type: String

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

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

Required: Yes

collaborationId

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

Type: String

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

createTime

The time that the analysis template within a collaboration was created.

Type: Timestamp

Required: Yes

creatorAccountId

The identifier used to reference members of the collaboration. Currently only supports AWS account ID.

Type: String

Length Constraints: Fixed length of 12.

Pattern: \d+

Required: Yes

format

The format of the analysis template in the collaboration.

Type: String

Valid Values: SQL | PYSPARK_1_0

Required: Yes

id

The identifier of the analysis template.

Type: String

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

name

The name of the analysis template.

Type: String

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

Pattern: [a-zA-Z0-9_](([a-zA-Z0-9_ ]+-)*([a-zA-Z0-9_ ]+))?

Required: Yes

schema

The entire schema object.

Type: AnalysisSchema object

Required: Yes

updateTime

The time that the analysis template in the collaboration was last updated.

Type: Timestamp

Required: Yes

analysisParameters

The analysis parameters that have been specified in the analysis template.

Type: Array of AnalysisParameter objects

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Required: No

description

The description of the analysis template.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*

Required: No

errorMessageConfiguration

The configuration that specifies the level of detail in error messages returned by analyses using this template. When set to DETAILED, error messages include more information to help troubleshoot issues with PySpark jobs. Detailed error messages may expose underlying data, including sensitive information. Recommended for faster troubleshooting in development and testing environments.

Type: ErrorMessageConfiguration object

Required: No

source