AnalysisTemplate ¶

class AnalysisTemplate(TypedDict, closed=True):
    id: "capo_cleanrooms.types.analysis_template_identifier.AnalysisTemplateIdentifier"
    """<p>The identifier for 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>The unique ID for the associated collaboration of the analysis template.</p>"""
    collaboration_arn: "capo_cleanrooms.types.collaboration_arn.CollaborationArn"
    """<p>The unique ARN for the analysis template’s associated collaboration.</p>"""
    membership_id: "capo_cleanrooms.types.uuid.UUID"
    """<p>The identifier of a member who created the analysis template.</p>"""
    membership_arn: "capo_cleanrooms.types.membership_arn.MembershipArn"
    """<p>The Amazon Resource Name (ARN) of the member who created the analysis template.</p>"""
    description: NotRequired[
        "capo_cleanrooms.types.resource_description.ResourceDescription"
    ]
    """<p>The description of the analysis template.</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 was created.</p>"""
    update_time: "datetime.datetime"
    """<p>The time that the analysis template 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.</p>"""
    source: "capo_cleanrooms.types.analysis_source.AnalysisSource"
    """<p>The source of the analysis template.</p>"""
    source_metadata: NotRequired[
        "capo_cleanrooms.types.analysis_source_metadata.AnalysisSourceMetadata"
    ]
    """<p> The source metadata for the analysis template.</p>"""
    analysis_parameters: NotRequired[
        "capo_cleanrooms.types.analysis_parameter_list.AnalysisParameterList"
    ]
    """<p>The parameters of the analysis template.</p>"""
    validations: NotRequired[
        "capo_cleanrooms.types.analysis_template_validation_status_detail_list.AnalysisTemplateValidationStatusDetailList"
    ]
    """<p>Information about the validations performed on the analysis template.</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 parameters used to generate synthetic data for this analysis template.</p>"""