AnalysisTemplate
The analysis template.
Contents
- 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
-
The unique ID for the associated collaboration 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
- createTime
-
The time that the analysis template was created.
Type: Timestamp
Required: Yes
- format
-
The format of the analysis template.
Type: String
Valid Values:
SQL | PYSPARK_1_0Required: Yes
- id
-
The identifier for 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
- membershipArn
-
The Amazon Resource Name (ARN) of the member who created the analysis template.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 100.
Pattern:
arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+Required: Yes
- membershipId
-
The identifier of a member who created 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
- source
-
The source of the analysis template.
Type: AnalysisSource object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
- updateTime
-
The time that the analysis template was last updated.
Type: Timestamp
Required: Yes
- analysisParameters
-
The parameters of 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
- sourceMetadata
-
The source metadata for the analysis template.
Type: AnalysisSourceMetadata object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: No
- validations
-
Information about the validations performed on the analysis template.
Type: Array of AnalysisTemplateValidationStatusDetail objects
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
