mypy-boto3-iotfleetwise type stubs

Warnings

• breaking Python 3.8 support was removed for all `mypy-boto3` stub packages, including `mypy-boto3-iotfleetwise`, starting with `mypy-boto3-builder` version 8.12.0. Users on Python 3.8 must upgrade to Python 3.9+ or pin an older version of the stub package.
  Fix: Upgrade your Python environment to 3.9 or higher. If upgrading is not possible, explicitly install an older compatible version, e.g., `pip install mypy-boto3-iotfleetwise==1.41.0`.
• breaking `mypy-boto3` packages migrated to PEP 561 compliant distribution in `mypy-boto3-builder` version 8.12.0. While this improves standard compatibility, users with highly customized `mypy` configurations or unusual import patterns might need to adjust their setup.
  Fix: Ensure `mypy` is up-to-date. In most cases, this change is transparent. If issues arise, consult `mypy` and `mypy-boto3` documentation on stub discovery and PEP 561 compliance. [cite: github_release_8.12.0, 18]
• breaking TypeDef naming conventions were changed in `mypy-boto3-builder` version 8.9.0. This includes shortening some TypeDef names (e.g., `CreateDistributionRequestRequestTypeDef` to `CreateDistributionRequestTypeDef`) and moving postfixes (e.g., `CreateDistributionExtraRequestTypeDef` to `CreateDistributionRequestExtraTypeDef`). Code explicitly importing or referencing these `TypedDict` names will break.
  Fix: Update imports and references to TypeDef names to reflect the new conventions. Review the specific service's `type_defs` module documentation for updated names.
• gotcha These packages provide only type stubs for `boto3`; they do not include the `boto3` runtime library itself. `boto3` must be installed separately for your Python code to execute successfully.
  Fix: Always ensure `boto3` is installed alongside `mypy-boto3-iotfleetwise` using `pip install boto3 mypy-boto3-iotfleetwise`.
• gotcha For optimal type inference and auto-completion, especially in certain IDEs (e.g., older VS Code setups) or when using `boto3-stubs-lite`, explicit type annotations for `boto3.client()` and `boto3.session.client()` calls are recommended.
  Fix: Always annotate the client variable with the specific client type from the stub package, e.g., `client: IoTFleetWiseClient = boto3.client("iotfleetwise")`.

Install

• pip install mypy-boto3-iotfleetwise boto3 Install stubs and runtime library

Imports

• IoTFleetWiseClient

  from mypy_boto3_iotfleetwise.client import IoTFleetWiseClient

  The client class for type hinting is imported directly from the stub package, not from boto3 itself, which returns a dynamically typed object.
• CreateFleetRequestTypeDef

  from mypy_boto3_iotfleetwise.type_defs import CreateFleetRequestTypeDef

  Type definitions for request/response bodies are available as TypedDicts.

Quickstart

This quickstart demonstrates how to use `mypy-boto3-iotfleetwise` with a `boto3` client for the IoT FleetWise service. It explicitly types the client and uses a `TypedDict` for the request payload to ensure full static type checking during development.

import boto3
from mypy_boto3_iotfleetwise.client import IoTFleetWiseClient
from mypy_boto3_iotfleetwise.type_defs import CreateFleetRequestTypeDef, CreateFleetResponseTypeDef

def create_iot_fleet(fleet_id: str, fleet_description: str, tags: list[dict]) -> CreateFleetResponseTypeDef:
    client: IoTFleetWiseClient = boto3.client("iotfleetwise")

    request_payload: CreateFleetRequestTypeDef = {
        "fleetId": fleet_id,
        "description": fleet_description,
        "tags": tags,
    }

    try:
        response: CreateFleetResponseTypeDef = client.create_fleet(**request_payload)
        print(f"Successfully created fleet: {response['fleetArn']}")
        return response
    except client.exceptions.ConflictException:
        print(f"Fleet '{fleet_id}' already exists.")
        # Handle the case where the fleet already exists, e.g., get its details
        return client.get_fleet(fleetId=fleet_id)
    except Exception as e:
        print(f"Error creating fleet: {e}")
        raise

# Example usage (requires AWS credentials configured)
# Replace with actual desired values
# try:
#     fleet_response = create_iot_fleet(
#         fleet_id="my-example-fleet",
#         fleet_description="Fleet for testing purposes",
#         tags=[{"key": "Environment", "value": "Dev"}]
#     )
#     print(f"Fleet details: {fleet_response}")
# except Exception as e:
#     print(f"An error occurred: {e}")