Type Annotations for boto3 DRS

Warnings

• breaking Starting with `mypy-boto3-builder` version 8.12.0 (which generated `mypy-boto3-drs 1.42.86`), support for Python 3.8 has been removed across all `mypy-boto3` packages.
  Fix: Upgrade your Python environment to 3.9 or higher. The `requires_python` metadata explicitly states `>=3.9`.
• breaking The `mypy-boto3-builder` (version 8.9.0 and later, which includes 8.12.0 that generated this stub) introduced breaking changes to `TypeDef` naming conventions. Specifically, 'TypeDefs for packed method arguments use shorter names if possible' and 'Conflicting TypeDef Extra postfix moved to the end'.
  Fix: Review your code for any explicit imports or references to `TypeDef` names and update them according to the new naming conventions. Consult the `mypy-boto3` documentation for service-specific `type_defs`.
• gotcha PyCharm users might experience slow performance and high CPU usage due to `Literal` overloads when using `boto3-stubs`. It is recommended to use `boto3-stubs-lite` (if explicit type annotations are acceptable) or disable PyCharm's internal type checker and rely on `mypy` or `pyright`.
  Fix: For PyCharm, consider `pip install boto3-stubs-lite[drs]` or configuring PyCharm to use an external type checker like `mypy` or `pyright`.
• gotcha When using `TYPE_CHECKING` for conditional imports with Pylint, it might report 'undefined variable' errors for the aliased types in the runtime block. This is a known Pylint issue.
  Fix: To fix this, explicitly set the types to `object` in the non-`TYPE_CHECKING` block: `if TYPE_CHECKING: from mypy_boto3_drs import DRSClient else: DRSClient = object`.

Install

• pip install mypy-boto3-drs Install standalone package
• pip install 'boto3-stubs[drs]' --extra-index-url https://pypi.org/simple/ Install via boto3-stubs (recommended)

Imports

• DRSClient

  from mypy_boto3_drs import DRSClient

  While you call `boto3.client('drs')`, the static type for type checking comes from `mypy_boto3_drs`.
• DescribeRecoveryInstancesResponseTypeDef

  from mypy_boto3_drs.type_defs import DescribeRecoveryInstancesResponseTypeDef

  Import type definitions (TypedDicts) for API response structures from the `type_defs` submodule.
• DRSPaginator

  from mypy_boto3_drs.paginator import DescribeRecoveryInstancesPaginator

  Import Paginator types for paginated API calls.

Quickstart

This quickstart demonstrates how to initialize a typed DRS client using `mypy-boto3-drs` and `boto3`, and then perform a basic API call (`describe_recovery_instances`). It includes the recommended `TYPE_CHECKING` guard for conditional import of stubs and explicit type annotation for the client object.

from typing import TYPE_CHECKING
import boto3
import os

if TYPE_CHECKING:
    from mypy_boto3_drs import DRSClient
    from mypy_boto3_drs.type_defs import DescribeRecoveryInstancesResponseTypeDef

# Configure AWS credentials and region, e.g., via environment variables or ~/.aws/credentials
# For quickstart, ensure default session is configured or pass explicit creds/region.

def get_drs_recovery_instances() -> None:
    # Explicitly type the client for mypy/IDE support
    client: DRSClient = boto3.client("drs", region_name=os.environ.get("AWS_REGION", "us-east-1"))
    
    try:
        # Example: Describe recovery instances
        response: DescribeRecoveryInstancesResponseTypeDef = client.describe_recovery_instances()
        
        print(f"Found {len(response['items'])} DRS Recovery Instances:")
        for instance in response['items']:
            print(f"  - Instance ID: {instance.get('recoveryInstanceID')}, Status: {instance.get('lifeCycle', {}).get('status')}")

    except Exception as e:
        print(f"Error describing DRS recovery instances: {e}")

if __name__ == "__main__":
    # Set dummy values for AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_REGION if not configured
    os.environ.setdefault('AWS_ACCESS_KEY_ID', 'testing')
    os.environ.setdefault('AWS_SECRET_ACCESS_KEY', 'testing')
    os.environ.setdefault('AWS_REGION', 'us-east-1')
    get_drs_recovery_instances()