Type Annotations for boto3 AppRegistry

1.42.3 · active · verified Sat Apr 11

mypy-boto3-servicecatalog-appregistry provides PEP 561 compliant type annotations for the AWS AppRegistry service client in boto3. It helps developers leverage static type checking with tools like mypy, ensuring correctness and improving autocompletion for boto3 interactions. The current version is 1.42.3, generated by mypy-boto3-builder 8.12.0, with frequent releases synchronised with boto3 updates.

Warnings

breaking Dropped support for Python 3.8. Packages generated with `mypy-boto3-builder` version 8.12.0 and newer (including this package) now require Python 3.9 or higher.
Fix: Upgrade your Python environment to 3.9 or newer.
breaking TypeDef naming conventions changed in builder version 8.9.0. Argument TypeDefs might have shorter names (e.g., `CreateRequestRequestTypeDef` -> `CreateRequestTypeDef`), and `Extra` postfixes were moved (e.g., `CreateExtraRequestTypeDef` -> `CreateRequestExtraTypeDef`).
Fix: Review your TypeDef imports and usages after upgrading, adjusting names as per the new conventions (check generated `.type_defs.pyi` for specific service changes).
gotcha Migration to PEP 561 compliance. While generally an improvement, some older type-checking setups or tools might require updates to correctly discover and utilize the type stubs.
Fix: Ensure your `mypy` configuration and project structure align with standard Python package and type stub discovery mechanisms. No code change is typically required in user applications.
gotcha Legacy `mypy-boto3` packages (pre-8.9.0 builder) were merged into `boto3-stubs`. If you're upgrading from very old `mypy-boto3` versions, ensure you're installing the correct new `mypy-boto3-*` package structure.
Fix: Verify that your `pip install` commands specify the `mypy-boto3-*` package names, which are the current standard for individual service stubs.
gotcha AWS service names can change or be deprecated (e.g., `sms-voice` was replaced by `pinpoint-sms-voice`). This means the corresponding `mypy-boto3` package name will also change, requiring updates to your dependencies and imports.
Fix: Always refer to the official AWS documentation for the latest service names. If a service package is deprecated, follow the recommended migration path to the new service and its corresponding `mypy-boto3` stub package.

Install

pip install mypy-boto3-servicecatalog-appregistry boto3 mypy Install with pip

Imports

AppRegistryClient
```
from mypy_boto3_servicecatalog_appregistry.client import AppRegistryClient
```
Client types are located in the '.client' submodule for clarity and to avoid name clashes.
AppRegistryServiceResource
```
from mypy_boto3_servicecatalog_appregistry.service_resource import AppRegistryServiceResource
```
Service resource types (if available for the service) are in the '.service_resource' submodule.
ApplicationSummaryTypeDef
```
from mypy_boto3_servicecatalog_appregistry.type_defs import ApplicationSummaryTypeDef
```
All core TypeDefs (input/output dictionaries for service operations) are consolidated in the '.type_defs' submodule.

Quickstart

This quickstart demonstrates how to obtain a type-hinted `AppRegistryClient` from `boto3` and use it to call an API operation. It also shows how to import and use response `TypeDef` objects for more granular type checking, typically under a `TYPE_CHECKING` guard.

import boto3
from mypy_boto3_servicecatalog_appregistry.client import AppRegistryClient
from typing import TYPE_CHECKING

# For advanced type checking of response objects
if TYPE_CHECKING:
    from mypy_boto3_servicecatalog_appregistry.type_defs import CreateApplicationResponseTypeDef

def create_example_application(app_name: str, app_description: str):
    # boto3 client is untyped by default
    client = boto3.client(
        "servicecatalog-appregistry",
        aws_access_key_id="AKIATEST", # Using dummy creds for example
        aws_secret_access_key="SECRET",
        region_name="us-east-1"
    )

    # Type hint the client for mypy
    typed_client: AppRegistryClient = client

    # With the typed_client, autocompletion and type checking work
    response = typed_client.create_application(
        name=app_name,
        description=app_description
    )

    # TYPE_CHECKING guard ensures this import is only for static analysis
    if TYPE_CHECKING:
        response_typed: CreateApplicationResponseTypeDef = response
        print(f"Application ID: {response_typed['application']['id']}")
    else:
        print(f"Application ID: {response['application']['id']}")

# To run this example, replace dummy creds and provide a unique application name
# create_example_application("MyUniqueApp", "Managed by mypy-boto3 example")

view raw JSON →