Type annotations for boto3 Cost and Usage Report (CUR)

1.42.3 · active · verified Sat Apr 11

mypy-boto3-cur provides type annotations for the boto3 Cost and Usage Report (CUR) service, ensuring static type checking compatibility for your AWS Python applications. It aligns with the boto3 version 1.42.3 and is generated using mypy-boto3-builder 8.12.0. The library helps catch potential type-related errors at development time.

Warnings

breaking Starting with `mypy-boto3-builder` version 8.12.0 (which generated this package), support for Python 3.8 was removed across all `mypy-boto3` packages. Ensure your project targets Python 3.9 or newer.
Fix: Upgrade your Python environment to 3.9 or later. The `requires_python` metadata for the package is `>=3.9`.
breaking Major version `8.9.0` of `mypy-boto3-builder` introduced breaking changes to `TypeDef` naming conventions for method arguments (e.g., `CreateDistributionRequestRequestTypeDef` was shortened to `CreateDistributionRequestTypeDef`) and postfix ordering (`Extra` moved to end). While not specific to CUR, such changes apply generally to generated services.
Fix: Review and update `TypeDef` imports and usage in your codebase to match the new, streamlined naming conventions, especially if upgrading from older `mypy-boto3` versions.
gotcha For optimal autocompletion and type inference in some IDEs (e.g., VSCode), it is recommended to explicitly type annotate `boto3.Session().client('service_name')` calls with the `Client` type from the specific `mypy-boto3-<service>` package (e.g., `client: CURClient = session.client('cur')`).
Fix: Add explicit type hints for your boto3 clients and resources: `client: CURClient = session.client("cur")`.
gotcha This library provides type stubs for `boto3`. You must have `boto3` itself installed in your environment for the runtime functionality. This `mypy-boto3-cur` package is purely for static type checking.
Fix: Ensure `boto3` is installed: `pip install boto3`.

Install

pip install mypy-boto3-cur Standalone installation
pip install 'boto3-stubs[cur]' As part of boto3-stubs (recommended if using multiple services)

Imports

CURClient

from mypy_boto3_cur.client import CURClient

For the typed CUR client.

CostandUsageReportServicePaginatorTypeDef
```
from mypy_boto3_cur.paginators import CostandUsageReportServicePaginatorTypeDef
```
For paginator type definitions. Specific paginator types will vary by method.
ReportLimitExceededExceptionTypeDef
```
from mypy_boto3_cur.type_defs import ReportLimitExceededExceptionTypeDef
```
For service-specific exception type definitions.
ReportDefinitionTypeDef
```
from mypy_boto3_cur.type_defs import ReportDefinitionTypeDef
```
For service-specific data structure type definitions (TypedDicts).
ReportFormatType
```
from mypy_boto3_cur.literals import ReportFormatType
```
For service-specific literal string types.

Quickstart

This quickstart demonstrates how to obtain a type-hinted CUR client and use it to list report definitions. Explicit type annotations on the client and response objects leverage the type stubs for improved autocompletion and static analysis.

import boto3
from mypy_boto3_cur.client import CURClient
from mypy_boto3_cur.type_defs import DescribeReportDefinitionsResponseTypeDef
import os

def get_cur_client() -> CURClient:
    """Returns a typed CUR client."""
    session = boto3.Session(region_name=os.environ.get('AWS_REGION', 'us-east-1'))
    client: CURClient = session.client("cur")
    return client

def list_cur_definitions():
    """Lists Cost and Usage Report definitions with type hints."""
    cur_client = get_cur_client()
    response: DescribeReportDefinitionsResponseTypeDef = cur_client.describe_report_definitions()
    print("Report Definitions:")
    for report in response.get("ReportDefinitions", []):
        print(f"  - {report['ReportName']} (Status: {report['ReportStatus']})")

if __name__ == "__main__":
    # Ensure AWS credentials/region are configured in environment or ~/.aws/credentials
    # For example: export AWS_REGION='us-east-1'
    # To run this, you would typically need 'boto3' installed alongside 'mypy-boto3-cur'
    list_cur_definitions()

view raw JSON →