Type Annotations for boto3 Route53RecoveryCluster

1.42.3 · active · verified Sat Apr 11

This library provides comprehensive type annotations for the `boto3` AWS SDK's Route53RecoveryCluster service (version 1.42.3), generated by `mypy-boto3-builder` 8.12.0. It enhances development with static type checking, autocompletion, and early error detection for `boto3` calls related to Route53RecoveryCluster. The project is actively maintained, with new versions frequently released, often in sync with `boto3` updates and `mypy-boto3-builder` enhancements.

Warnings

breaking Python 3.8 support was removed with `mypy-boto3-builder` version 8.12.0. Users on Python 3.8 or older must upgrade their Python environment to `3.9` or higher to continue receiving updates for `mypy-boto3` packages.
Fix: Upgrade your Python environment to version 3.9 or newer.
breaking `mypy-boto3-builder` (from which this package is generated) migrated to PEP 561 compliant packages in version 8.12.0. This changes how stub files are distributed and discovered, potentially impacting complex build setups or custom stub path configurations.
Fix: Ensure your type checker (e.g., `mypy`) is configured to correctly discover PEP 561 compliant stub packages. Most standard setups should handle this automatically.
breaking Starting with `mypy-boto3-builder` 8.9.0, `TypeDef` naming conventions changed. This includes shortening names for packed method arguments (e.g., `RequestRequestTypeDef` -> `RequestTypeDef`) and moving `Extra` postfixes. This can lead to `NameError` or incorrect type hints if you directly import or refer to these `TypeDef`s by their old names.
Fix: Review your code for direct imports of `TypeDef`s and update their names according to the new conventions as indicated by your type checker's errors.
gotcha For optimal autocompletion and robust type checking, especially within IDEs like VSCode or PyCharm, it's often recommended to explicitly annotate the type of the `boto3` client (e.g., `client: Route53RecoveryClusterClient = boto3.client(...)`) rather than relying solely on implicit type inference.
Fix: Add explicit type annotations to your `boto3` client and resource objects, importing the specific client/resource type from `mypy_boto3_SERVICE.client` or `mypy_boto3_SERVICE.service_resource`.
gotcha When conditionally importing `mypy-boto3` types using `if TYPE_CHECKING:`, `pylint` might report 'Undefined variable' errors in the `else` branch.
Fix: To resolve this, assign `object` to the type symbols in the `else` branch of your `TYPE_CHECKING` block. Example: `else: Route53RecoveryClusterClient = object`.

Install

pip install mypy-boto3-route53-recovery-cluster Install package

Imports

Route53RecoveryClusterClient

from mypy_boto3_route53_recovery_cluster.client import Route53RecoveryClusterClient

DescribeRecoveryGroupResponseTypeDef
```
from mypy_boto3_route53_recovery_cluster.type_defs import DescribeRecoveryGroupResponseTypeDef
```
Example of importing a TypeDef for request/response bodies.
Route53RecoveryClusterServiceName
```
from mypy_boto3_route53_recovery_cluster.literals import Route53RecoveryClusterServiceName
```
Import literals for service names, paginators, or waiters for improved type safety.

Quickstart

This quickstart demonstrates how to initialize a type-hinted `Route53RecoveryClusterClient` and call a basic operation like `list_clusters`. The `TYPE_CHECKING` block ensures that `mypy` can use the specific client type for robust static analysis, while allowing the code to run without `mypy-boto3` dependencies in production. Remember to replace placeholder credentials with actual AWS configuration or environment variables.

import boto3
from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from mypy_boto3_route53_recovery_cluster.client import Route53RecoveryClusterClient
    from mypy_boto3_route53_recovery_cluster.type_defs import ListClustersResponseTypeDef


def get_recovery_cluster_info() -> ListClustersResponseTypeDef:
    # It's recommended to explicitly type the client for best autocompletion and type checking.
    client: Route53RecoveryClusterClient = boto3.client(
        "route53-recovery-cluster",
        region_name="us-east-1", # Replace with your region
        aws_access_key_id="AKIATEST", # Use os.environ.get('AWS_ACCESS_KEY_ID', '') in real code
        aws_secret_access_key="SECRETLONGKEY", # Use os.environ.get('AWS_SECRET_ACCESS_KEY', '')
        aws_session_token="SESSIONTOKEN" # Use os.environ.get('AWS_SESSION_TOKEN', '') if applicable
    )

    response = client.list_clusters()
    print(f"Clusters: {response.get('Clusters')}")
    return response

if __name__ == "__main__":
    # This part would typically run in a properly configured AWS environment
    # For this example, we'll just print a placeholder as credentials are not live
    print("--- Mocking AWS client call for quickstart ---")
    if TYPE_CHECKING:
        result = get_recovery_cluster_info()
        print(f"Mocked Cluster List (Type-checked): {result.get('Clusters')}")
    else:
        print("Run mypy to check types. Actual execution requires AWS credentials.")

view raw JSON →