CreateAnalysisTemplateInput ¶

class CreateAnalysisTemplateInput(TypedDict, closed=True):
    description: NotRequired[
        "capo_cleanrooms.types.resource_description.ResourceDescription"
    ]
    """<p>The description of the analysis template.</p>"""
    membership_identifier: (
        "capo_cleanrooms.types.membership_identifier.MembershipIdentifier"
    )
    """<p>The identifier for a membership resource.</p>"""
    name: "capo_cleanrooms.types.table_alias.TableAlias"
    """<p>The name of the analysis template.</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 information in the analysis template.</p>"""
    tags: NotRequired["capo_cleanrooms.types.tag_map.TagMap"]
    """<p>An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.</p>"""
    analysis_parameters: NotRequired[
        "capo_cleanrooms.types.analysis_parameter_list.AnalysisParameterList"
    ]
    """<p>The parameters of the analysis template.</p>"""
    schema: NotRequired["capo_cleanrooms.types.analysis_schema.AnalysisSchema"]
    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 for generating synthetic data when running the analysis template.</p>"""