Skip to content

CollaborationAnalysisTemplate

Source code in docs_src/capo_cleanrooms/types/collaboration_analysis_template.py
class CollaborationAnalysisTemplate(TypedDict, closed=True):
    id: "capo_cleanrooms.types.analysis_template_identifier.AnalysisTemplateIdentifier"
    """<p>The identifier of the analysis template.</p>"""
    arn: "capo_cleanrooms.types.analysis_template_arn.AnalysisTemplateArn"
    """<p>The Amazon Resource Name (ARN) of the analysis template.</p>"""
    collaboration_id: "capo_cleanrooms.types.uuid.UUID"
    """<p>A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.</p>"""
    collaboration_arn: "capo_cleanrooms.types.collaboration_arn.CollaborationArn"
    """<p>The unique ARN for the analysis template’s associated collaboration.</p>"""
    description: NotRequired[
        "capo_cleanrooms.types.resource_description.ResourceDescription"
    ]
    """<p>The description of the analysis template.</p>"""
    creator_account_id: "capo_cleanrooms.types.account_id.AccountId"
    """<p>The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.</p>"""
    name: "capo_cleanrooms.types.resource_alias.ResourceAlias"
    """<p>The name of the analysis template.</p>"""
    create_time: "datetime.datetime"
    """<p>The time that the analysis template within a collaboration was created.</p>"""
    update_time: "datetime.datetime"
    """<p>The time that the analysis template in the collaboration was last updated.</p>"""
    schema: "capo_cleanrooms.types.analysis_schema.AnalysisSchema"
    """<p>The entire schema object.</p>"""
    format: "capo_cleanrooms.types.analysis_format.AnalysisFormat"
    """<p>The format of the analysis template in the collaboration.</p>"""
    source: NotRequired["capo_cleanrooms.types.analysis_source.AnalysisSource"]
    """<p>The source of the analysis template within a collaboration.</p>"""
    source_metadata: NotRequired[
        "capo_cleanrooms.types.analysis_source_metadata.AnalysisSourceMetadata"
    ]
    """<p> The source metadata for the collaboration analysis template.</p>"""
    analysis_parameters: NotRequired[
        "capo_cleanrooms.types.analysis_parameter_list.AnalysisParameterList"
    ]
    """<p>The analysis parameters that have been specified in the analysis template.</p>"""
    validations: NotRequired[
        "capo_cleanrooms.types.analysis_template_validation_status_detail_list.AnalysisTemplateValidationStatusDetailList"
    ]
    """<p>The validations that were performed.</p>"""
    error_message_configuration: NotRequired[
        "capo_cleanrooms.types.error_message_configuration.ErrorMessageConfiguration"
    ]
    """<p>The configuration that specifies the level of detail in error messages returned by analyses using this template. When set to <code>DETAILED</code>, 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.</p>"""
    synthetic_data_parameters: NotRequired[
        "capo_cleanrooms.types.synthetic_data_parameters.SyntheticDataParameters"
    ]
    """<p>The synthetic data generation parameters configured for this collaboration analysis template.</p>"""

analysis_parameters instance-attribute

analysis_parameters: NotRequired[AnalysisParameterList]

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

arn instance-attribute

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

collaboration_arn instance-attribute

collaboration_arn: CollaborationArn

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

collaboration_id instance-attribute

collaboration_id: UUID

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

create_time instance-attribute

create_time: datetime

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

creator_account_id instance-attribute

creator_account_id: AccountId

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

description instance-attribute

description: NotRequired[ResourceDescription]

The description of the analysis template.

error_message_configuration instance-attribute

error_message_configuration: NotRequired[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.

format instance-attribute

The format of the analysis template in the collaboration.

id instance-attribute

The identifier of the analysis template.

name instance-attribute

The name of the analysis template.

schema instance-attribute

The entire schema object.

source instance-attribute

source: NotRequired[AnalysisSource]

The source of the analysis template within a collaboration.

source_metadata instance-attribute

source_metadata: NotRequired[AnalysisSourceMetadata]

The source metadata for the collaboration analysis template.

synthetic_data_parameters instance-attribute

synthetic_data_parameters: NotRequired[SyntheticDataParameters]

The synthetic data generation parameters configured for this collaboration analysis template.

update_time instance-attribute

update_time: datetime

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

validations instance-attribute

The validations that were performed.