mypy-boto3-groundstation

1.42.35 · active · verified Sat Apr 11

mypy-boto3-groundstation provides type annotations for the `boto3` GroundStation service, generated by `mypy-boto3-builder`. It enhances developer experience by enabling static type checking for `boto3` client calls. The current version is 1.42.35, and it follows the release cadence of `mypy-boto3-builder`, which updates frequently with AWS service changes.

Warnings

breaking `mypy-boto3-builder` (which generates this package) removed support for Python 3.8 starting from builder version 8.12.0. This means `mypy-boto3-groundstation` versions generated by builder 8.12.0 or newer will require Python 3.9+.
Fix: Upgrade your Python environment to 3.9 or higher. If you need Python 3.8 support, pin to an older `mypy-boto3-groundstation` version generated by a builder <8.12.0.
gotcha This package provides *type stubs* for `boto3` and does not include the `boto3` runtime itself. `boto3` must be installed separately for your code to run.
Fix: Always install `boto3` alongside `mypy-boto3-groundstation` (e.g., `pip install boto3 mypy-boto3-groundstation`).
breaking The `mypy-boto3-builder` migrated to PEP 561 compliant packages in version 8.12.0. While this is generally beneficial, it might affect how some build systems or custom tooling discover and consume these type packages.
Fix: Ensure your build and type-checking tools are up-to-date and compatible with PEP 561-compliant type packages. No direct code change is usually required for users.
gotcha TypeDef naming conventions can change with `mypy-boto3-builder` updates. For instance, in builder 8.9.0, verbose names like `CreateDistributionRequestRequestTypeDef` were shortened to `CreateDistributionRequestTypeDef`.
Fix: If you directly import and use specific `TypeDef` names, be aware that they might change with new `mypy-boto3-groundstation` versions. Refer to the generated stub files or the `mypy-boto3-builder` release notes for exact name changes.

Install

pip install boto3 mypy-boto3-groundstation Install boto3 and GroundStation stubs

Imports

GroundStationClient
```
from mypy_boto3_groundstation.client import GroundStationClient
```
While boto3.client is the runtime way to get a client, mypy-boto3 provides the specific type annotation for static checking.
GroundStationServiceResource
```
from mypy_boto3_groundstation.service_resource import GroundStationServiceResource
```
Imports the type for the service resource, if used (less common for GroundStation).
ConfigTypeTypeDef
```
from mypy_boto3_groundstation.type_defs import ConfigTypeTypeDef
```
Imports specific TypeDef structures for stricter type checking of method parameters or responses.

Quickstart

This quickstart demonstrates how to obtain a type-hinted `boto3` GroundStation client and use one of its methods, `list_configs`, with its corresponding response type definition. This allows `mypy` to validate your `boto3` usage statically.

import boto3
from mypy_boto3_groundstation.client import GroundStationClient
from mypy_boto3_groundstation.type_defs import ListConfigsResponseTypeDef

def get_groundstation_config_types() -> List[str]:
    # The 'client' variable is now type-hinted by mypy-boto3-groundstation
    client: GroundStationClient = boto3.client("groundstation")

    # Methods and their return types are type-checked
    response: ListConfigsResponseTypeDef = client.list_configs()
    config_types = [config['configType'] for config in response.get('configList', [])]
    return config_types

if __name__ == "__main__":
    # Example of running the function (requires AWS credentials configured for boto3)
    try:
        print(f"Available GroundStation config types: {get_groundstation_config_types()}")
    except Exception as e:
        print(f"Error fetching config types (ensure AWS config): {e}")

view raw JSON →