SheetDefinition ¶

class SheetDefinition(TypedDict, closed=True):
    sheet_id: (
        "capo_quicksight.types.short_restrictive_resource_id.ShortRestrictiveResourceId"
    )
    """<p>The unique identifier of a sheet.</p>"""
    title: NotRequired["capo_quicksight.types.sheet_title.SheetTitle"]
    """<p>The title of the sheet.</p>"""
    description: NotRequired["capo_quicksight.types.sheet_description.SheetDescription"]
    """<p>A description of the sheet.</p>"""
    name: NotRequired["capo_quicksight.types.sheet_name.SheetName"]
    """<p>The name of the sheet. This name is displayed on the sheet's tab in the Quick console.</p>"""
    parameter_controls: NotRequired[
        "capo_quicksight.types.parameter_control_list.ParameterControlList"
    ]
    """<p>The list of parameter controls that are on a sheet.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/parameters-controls.html">Using a Control with a Parameter in Amazon Quick Sight</a> in the <i>Amazon Quick Suite User Guide</i>.</p>"""
    filter_controls: NotRequired[
        "capo_quicksight.types.filter_control_list.FilterControlList"
    ]
    """<p>The list of filter controls that are on a sheet.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/filter-controls.html">Adding filter controls to analysis sheets</a> in the <i>Amazon Quick Suite User Guide</i>.</p>"""
    visuals: NotRequired["capo_quicksight.types.visual_list.VisualList"]
    """<p>A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.</p>"""
    text_boxes: NotRequired[
        "capo_quicksight.types.sheet_text_box_list.SheetTextBoxList"
    ]
    """<p>The text boxes that are on a sheet.</p>"""
    images: NotRequired["capo_quicksight.types.sheet_image_list.SheetImageList"]
    """<p>A list of images on a sheet.</p>"""
    layouts: NotRequired["capo_quicksight.types.layout_list.LayoutList"]
    """<p>Layouts define how the components of a sheet are arranged.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html">Types of layout</a> in the <i>Amazon Quick Suite User Guide</i>.</p>"""
    sheet_control_layouts: NotRequired[
        "capo_quicksight.types.sheet_control_layout_list.SheetControlLayoutList"
    ]
    """<p>The control layouts of the sheet.</p>"""
    content_type: NotRequired[
        "capo_quicksight.types.sheet_content_type.SheetContentType"
    ]
    """<p>The layout content type of the sheet. Choose one of the following options:</p> <ul> <li> <p> <code>PAGINATED</code>: Creates a sheet for a paginated report.</p> </li> <li> <p> <code>INTERACTIVE</code>: Creates a sheet for an interactive dashboard.</p> </li> </ul>"""
    custom_action_defaults: NotRequired[
        "capo_quicksight.types.visual_custom_action_defaults.VisualCustomActionDefaults"
    ]
    """<p>A list of visual custom actions for the sheet.</p>"""