Mypy Boto3 AuditManager Stubs

1.42.3 · active · verified Sat Apr 11

mypy-boto3-auditmanager provides PEP 561 compliant type annotations for the AWS Boto3 AuditManager service, ensuring static type checking for your Boto3 clients. It is currently at version 1.42.3 and is actively maintained, with frequent releases tied to the upstream `boto3` library and `mypy-boto3-builder` updates.

Warnings

breaking Python 3.8 support was removed for all `mypy-boto3` packages, including `mypy-boto3-auditmanager`, starting with `mypy-boto3-builder` version 8.12.0.
Fix: Upgrade your Python environment to 3.9 or newer.
breaking Type Definition Naming Conventions underwent changes in `mypy-boto3-builder 8.9.0`. For example, `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef` and `Extra` postfixes moved to the end.
Fix: Review your code for any custom `TypeDef` imports and adjust names according to the updated conventions. Refer to the `mypy-boto3-builder` release notes for specific services you use.
gotcha It is critical that the version of `mypy-boto3-auditmanager` exactly matches the major and minor version of your installed `boto3` library (e.g., `mypy-boto3-auditmanager==1.x.y` for `boto3==1.x.z`). Mismatched versions can lead to incorrect type checking or runtime errors.
Fix: Always install `mypy-boto3-auditmanager` with the same major.minor version as `boto3` (e.g., `pip install boto3==1.42.3 mypy-boto3-auditmanager==1.42.3`).
gotcha `mypy-boto3` packages migrated to PEP 561 packaging in `mypy-boto3-builder 8.12.0`. While generally transparent, this might affect advanced build systems or tools that rely on specific package discovery mechanisms.
Fix: Ensure your environment (e.g., `mypy` configuration) correctly discovers PEP 561-compliant type packages. No direct code change is typically required, but check your `mypy` setup.

Install

pip install mypy-boto3-auditmanager Install Boto3 AuditManager stubs

Imports

AuditManagerClient
```
from mypy_boto3_auditmanager.client import AuditManagerClient
```
This is the type hint for the Boto3 AuditManager client.
GetChangeLogsRequestRequestTypeDef
```
from mypy_boto3_auditmanager.type_defs import GetChangeLogsRequestRequestTypeDef
```
Type definitions for service-specific request parameters.
GetChangeLogsResponseTypeDef
```
from mypy_boto3_auditmanager.type_defs import GetChangeLogsResponseTypeDef
```
Type definitions for service-specific response objects.

Quickstart

This quickstart demonstrates how to import and use the `AuditManagerClient` type for type-hinting a Boto3 client, and how to use specific type definitions for request and response objects for improved static analysis. Ensure 'your-audit-report-id' is replaced with a valid value for a runnable example.

import boto3
from mypy_boto3_auditmanager.client import AuditManagerClient
from mypy_boto3_auditmanager.type_defs import GetChangeLogsRequestRequestTypeDef, GetChangeLogsResponseTypeDef

# Instantiate a Boto3 client with type hints
client: AuditManagerClient = boto3.client("auditmanager")

# Example of using type definitions for request and response
request_params: GetChangeLogsRequestRequestTypeDef = {
    "auditReportId": "your-audit-report-id", # Replace with actual ID
    "nextToken": "",
    "maxResults": 10
}

try:
    # Call a service method, type checkers will validate arguments and return type
    response: GetChangeLogsResponseTypeDef = client.get_change_logs(**request_params)
    print(f"Successfully retrieved {len(response.get('changeLogs', []))} change logs.")
except Exception as e:
    print(f"Error calling AuditManager: {e}")

view raw JSON →