Skip to content

QuickSight module#

Index > QuickSight

Auto-generated documentation for QuickSight type annotations stubs module mypy-boto3-quicksight.

How to install#

You can generate type annotations for boto3 package locally with mypy-boto3-builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.38.3' mypy-boto3-builder
  2. Select boto3-stubs AWS SDK.
  3. Add QuickSight service.
  4. Use provided commands to install generated packages.

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and QuickSight.

From PyPI with pip#

Install boto3-stubs for QuickSight service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[quicksight]'

# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[quicksight]'

# standalone installation
python -m pip install mypy-boto3-quicksight

How to uninstall#

python -m pip uninstall -y mypy-boto3-quicksight

Usage#

Code samples can be found in Examples.

QuickSightClient#

Type annotations and code completion for boto3.client("quicksight") as QuickSightClient boto3 documentation

# QuickSightClient usage example

from boto3.session import Session

from mypy_boto3_quicksight.client import QuickSightClient

def get_client() -> QuickSightClient:
    return Session().client("quicksight")

Paginators#

Type annotations and code completion for paginators from boto3.client("quicksight").get_paginator("...").

# DescribeFolderPermissionsPaginator usage example

from boto3.session import Session

from mypy_boto3_quicksight.paginator import DescribeFolderPermissionsPaginator

def get_describe_folder_permissions_paginator() -> DescribeFolderPermissionsPaginator:
    return Session().client("quicksight").get_paginator("describe_folder_permissions"))

Literals#

Type annotations for literals used in methods and schema.

# AggTypeType usage example

from mypy_boto3_quicksight.literals import AggTypeType

def get_value() -> AggTypeType:
    return "AVERAGE"

Type definitions#

Type annotations for type definitions used in methods and schema.