Skip to content

QuickSight module

Index > QuickSight

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

How to install

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

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("...").

Usage example
from boto3.session import Session

from mypy_boto3_quicksight.paginator import ListAnalysesPaginator

def get_list_analyses_paginator() -> ListAnalysesPaginator:
    return Session().client("quicksight").get_paginator("list_analyses"))

Literals

Type annotations for literals used in methods and schemas.

Usage example
from mypy_boto3_quicksight.literals import AnalysisErrorTypeType

def get_value() -> AnalysisErrorTypeType:
    return "ACCESS_DENIED"

Typed dictionaries

Type annotations for typed dictionaries used in methods and schema.

Usage example
from mypy_boto3_quicksight.type_defs import AccountCustomizationTypeDef

def get_value() -> AccountCustomizationTypeDef:
    return {
        "DefaultTheme": ...,
    }