mypy-boto3-quicksight Type Stubs

Warnings

• breaking Python 3.8 support was removed with `mypy-boto3-builder` version 8.12.0. If you are using Python 3.8, you must upgrade to Python 3.9 or newer to use the latest versions of these type stubs.
  Fix: Upgrade your Python environment to 3.9 or later. If upgrading is not possible, pin an older version of `mypy-boto3-quicksight` that supported Python 3.8.
• gotcha This package provides only type stubs ('.pyi' files) for `boto3`. It does not include the actual `boto3` library or its runtime functionality. You must install `boto3` separately for your code to run.
  Fix: Ensure `boto3` is installed in your environment alongside `mypy-boto3-quicksight`: `pip install boto3`.
• breaking The `mypy-boto3-builder` (version 8.9.0) introduced changes to how `TypeDef` names are generated, specifically shortening verbose names (e.g., `*RequestRequestTypeDef` to `*RequestTypeDef`). If your code directly imports specific `TypeDef`s, their names may have changed.
  Fix: Review your explicit `TypeDef` imports and adjust names according to the updated stub definitions. Typically, redundant suffixes like `RequestRequest` or `Extra` were simplified or repositioned.
• gotcha The builder migrated to PEP 561 compliant packages in version 8.12.0. While this generally improves compatibility with type checkers by making stubs discoverable automatically, ensure your `mypy` configuration (e.g., `pyproject.toml`) is not relying on outdated, non-standard stub discovery mechanisms.
  Fix: Verify that your `mypy` setup is current. Usually, no specific `MYPYPATH` or similar configuration is needed for PEP 561 stubs. If issues arise, consult `mypy` documentation for package discovery and ensure your `mypy` version is also up-to-date.

Install

• pip install mypy-boto3-quicksight Install only QuickSight stubs
• pip install 'boto3-stubs[quicksight]' Install boto3-stubs with QuickSight extra

Imports

• QuickSightClient

  from mypy_boto3_quicksight.client import QuickSightClient

• QuickSightServiceResource

  from mypy_boto3_quicksight.service_resource import QuickSightServiceResource

  Used for resource-level abstractions, though less common for QuickSight.
• ListDashboardsOutputTypeDef

  from mypy_boto3_quicksight.type_defs import ListDashboardsOutputTypeDef

  Commonly used for type-hinting API call responses, e.g., for `list_dashboards`.

Quickstart

Demonstrates how to import and use `QuickSightClient` to type-hint a `boto3` QuickSight client. This enables static analysis tools like MyPy to validate your QuickSight API calls. For the code to execute successfully, ensure your AWS credentials are configured and replace `AWS_ACCOUNT_ID` with a real value from your environment or directly in the code.

import boto3
from mypy_boto3_quicksight.client import QuickSightClient
from typing import TYPE_CHECKING
import os

# Ensure boto3 is installed for runtime functionality
# pip install boto3 mypy-boto3-quicksight

if TYPE_CHECKING:
    # Type-hint the boto3 client for QuickSight
    client: QuickSightClient = boto3.client("quicksight")
else:
    client = boto3.client("quicksight")

# Example: List dashboards (requires AWS credentials configured)
try:
    print("Attempting to list QuickSight dashboards...")
    # Replace '123456789012' with your actual AWS Account ID or set AWS_ACCOUNT_ID env var.
    aws_account_id = os.environ.get('AWS_ACCOUNT_ID', '123456789012')
    
    response = client.list_dashboards(
        AwsAccountId=aws_account_id
    )
    dashboards = response.get("DashboardSummaryList", [])
    if dashboards:
        print(f"Found {len(dashboards)} dashboards. First dashboard name: {dashboards[0].get('Name')}")
    else:
        print(f"No dashboards found for AWS Account ID: {aws_account_id}, or the ID is invalid.")
except Exception as e:
    print(f"An error occurred: {e}")

print("QuickSight client setup with type hints successful.")