mypy-boto3-panorama

Warnings

• breaking Python 3.8 support has been removed across all `mypy-boto3` packages, including `mypy-boto3-panorama`. Projects must use Python 3.9 or newer.
  Fix: Upgrade your project's Python version to 3.9 or higher.
• breaking The `mypy-boto3` builder (which generates this package) migrated to PEP 561-compliant stub packages. This may affect some advanced build systems or `mypy` configurations, especially if you were relying on older stub distribution methods.
  Fix: Review your `mypy` configuration and build processes to ensure compatibility with PEP 561 package layouts. Most users should not be directly affected, but if issues arise, consult `mypy` documentation and `mypy-boto3` release notes.
• breaking Generated TypeDef names for service methods were shortened and consolidated in older versions, potentially breaking direct imports of specific `TypeDef` aliases if they were impacted. For example, `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`.
  Fix: If you directly import and reference generated `TypeDef`s, verify their names against the latest stub definitions. Adjust your imports and type annotations as necessary.
• gotcha For `mypy-boto3-panorama` to provide type checking, you *must* install both `boto3` (the runtime library) and `mypy-boto3-panorama` (the type stubs). Installing only one will result in either runtime errors or un-type-checked `boto3` calls.
  Fix: Ensure both `pip install boto3` and `pip install mypy-boto3-panorama` are executed in your environment.

Install

• pip install mypy-boto3-panorama boto3 Install service stubs and boto3 runtime

Imports

• PanoramaClient

  from mypy_boto3_panorama.client import PanoramaClient

• ListApplicationInstancesOutputTypeDef

  from mypy_boto3_panorama.type_defs import ListApplicationInstancesOutputTypeDef

• client

  import boto3
  client: PanoramaClient = boto3.client('panorama')

  While the `boto3.client` call itself doesn't change, the correct usage for type checking requires either an explicit type annotation or installing `boto3-stubs` as a whole for inferred types.

Quickstart

This quickstart demonstrates how to instantiate a Panorama client with type annotations and call a method. Ensure you have `boto3` and `mypy-boto3-panorama` installed, and your AWS credentials configured (e.g., via environment variables or `~/.aws/credentials`).

import os
import boto3
from mypy_boto3_panorama.client import PanoramaClient
from mypy_boto3_panorama.type_defs import ListApplicationInstancesOutputTypeDef

def list_panorama_instances(region: str = "us-east-1") -> ListApplicationInstancesOutputTypeDef:
    """Lists Panorama application instances with type checking."""
    # Ensure boto3 is configured, e.g., via AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY,
    # or ~/.aws/credentials. For demonstration, we'll use environment variables.
    client: PanoramaClient = boto3.client(
        "panorama",
        region_name=region,
        aws_access_key_id=os.environ.get('AWS_ACCESS_KEY_ID', ''),
        aws_secret_access_key=os.environ.get('AWS_SECRET_ACCESS_KEY', '')
    )
    
    response: ListApplicationInstancesOutputTypeDef = client.list_application_instances()
    print(f"Found {len(response.get('ApplicationInstances', []))} Panorama application instances.")
    return response

if __name__ == "__main__":
    try:
        # This call will likely fail without proper AWS credentials/permissions.
        # It demonstrates the type-checked interaction.
        list_panorama_instances()
    except Exception as e:
        print(f"Error listing Panorama instances (expected if credentials/permissions are not set): {e}")