Type Annotations for Boto3 MediaConnect

Warnings

• breaking Support for Python 3.8 was removed from `mypy-boto3-builder` version 8.12.0, meaning `mypy-boto3-mediaconnect` packages generated by this builder version or newer will not support Python 3.8.
  Fix: Upgrade your Python environment to 3.9 or higher.
• breaking There were breaking changes in `TypeDef` naming conventions in `mypy-boto3-builder` version 8.9.0. Specifically, `TypeDef` names for packed method arguments became shorter (e.g., `CreateDistributionRequestRequestTypeDef` to `CreateDistributionRequestTypeDef`), and conflicting `Extra` postfixes were moved to the end.
  Fix: Review your code for any custom `TypeDef` imports and update their names according to the new conventions.
• gotcha This package provides *only* type stubs. For your code to run, you must also install the `boto3` library, as `mypy-boto3-mediaconnect` does not include the runtime implementation.
  Fix: Ensure `pip install boto3` is part of your project's dependency management.
• gotcha To avoid making `mypy-boto3-mediaconnect` a runtime dependency, which is unnecessary overhead, always wrap your type imports within a `if TYPE_CHECKING:` block.
  Fix: Use `from typing import TYPE_CHECKING; if TYPE_CHECKING: from mypy_boto3_mediaconnect.client import MediaConnectClient` for all type imports.
• gotcha For optimal IDE autocompletion and type checking (especially in VSCode), it is recommended to explicitly annotate the client object when creating it, e.g., `client: MediaConnectClient = boto3.client("mediaconnect")`.
  Fix: Add explicit type annotations to `boto3.client` and `boto3.session.client` calls for better developer experience.

Install

• pip install mypy-boto3-mediaconnect Install service stubs
• pip install boto3 Install runtime dependency

Imports

• MediaConnectClient

  from mypy_boto3_mediaconnect.client import MediaConnectClient

  Imports the typed client for MediaConnect. Typically used within a `TYPE_CHECKING` block.
• FlowSummaryTypeDef

  from mypy_boto3_mediaconnect.type_defs import FlowSummaryTypeDef

  Imports a specific TypedDict for API response structures. Names can vary, consult docs for exact TypedDicts.

Quickstart

This quickstart demonstrates how to use `mypy-boto3-mediaconnect` to add type hints to your boto3 MediaConnect client. It initializes a typed client and lists available MediaConnect flows, leveraging the `TYPE_CHECKING` guard to prevent runtime dependency on the stub package. Remember to have `boto3` installed and AWS credentials configured for actual execution.

from typing import TYPE_CHECKING
import boto3
import os

if TYPE_CHECKING:
    from mypy_boto3_mediaconnect.client import MediaConnectClient
    from mypy_boto3_mediaconnect.type_defs import ListFlowsResponseTypeDef

# Ensure AWS credentials are set up (e.g., via environment variables or ~/.aws/credentials)
# For example, by setting AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY

def list_mediaconnect_flows() -> list[str]:
    try:
        # The type annotation helps your IDE and static checker understand the client's methods
        client: MediaConnectClient = boto3.client(
            "mediaconnect",
            aws_access_key_id=os.environ.get('AWS_ACCESS_KEY_ID', 'DUMMY_KEY'),
            aws_secret_access_key=os.environ.get('AWS_SECRET_ACCESS_KEY', 'DUMMY_SECRET'),
            region_name=os.environ.get('AWS_DEFAULT_REGION', 'us-east-1')
        )
        response: ListFlowsResponseTypeDef = client.list_flows()
        flow_names = [flow['Name'] for flow in response.get('Flows', []) if 'Name' in flow]
        print(f"Found MediaConnect flows: {flow_names}")
        return flow_names
    except Exception as e:
        print(f"Error listing MediaConnect flows: {e}")
        return []

if __name__ == "__main__":
    list_mediaconnect_flows()