mypy-boto3-resourcegroupstaggingapi type stubs

Warnings

• breaking Starting with `mypy-boto3-builder` version 8.12.0, support for Python 3.8 has been removed for all generated packages, including `mypy-boto3-resourcegroupstaggingapi`. Users on Python 3.8 will need to upgrade to Python 3.9 or newer to use versions generated by `builder` 8.12.0+.
  Fix: Upgrade your Python environment to 3.9 or a later version. Alternatively, pin `mypy-boto3-builder` to `<8.12.0` if you need to maintain Python 3.8 compatibility, though this is not recommended.
• breaking Builder version 8.9.0 introduced breaking changes to `TypeDef` naming conventions. Type definitions for packed method arguments now use shorter names (e.g., `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`), and conflicting `Extra` postfixes are moved to the end (e.g., `CreateDistributionExtraRequestTypeDef` became `CreateDistributionRequestExtraTypeDef`). This may require updates to explicit `TypeDef` imports in your codebase.
  Fix: Review your code for direct imports or references to `TypeDef` objects. Adjust their names according to the new conventions, typically by simplifying redundant `Request` suffixes or repositioning `Extra`.
• gotcha This package provides *only* type annotations. You must install the `boto3` library separately for your code to run successfully at runtime. Type checkers will not warn about a missing `boto3` if `mypy-boto3-resourcegroupstaggingapi` is installed.
  Fix: Always ensure you have `boto3` installed alongside `mypy-boto3-resourcegroupstaggingapi` (e.g., `pip install boto3 mypy-boto3-resourcegroupstaggingapi`).
• gotcha Beginning with `mypy-boto3-builder` 8.12.0, packages migrated to follow PEP 561. This change improves compatibility and discovery for type checkers. Ensure your type checker (e.g., mypy, pyright) is configured to correctly find and utilize PEP 561 compliant stub packages.
  Fix: Verify your type checker's configuration. In most cases, if `mypy-boto3-resourcegroupstaggingapi` is installed in the same environment as your code, type checkers should automatically discover it. Refer to your type checker's documentation for specific setup instructions if issues arise.
• gotcha For IDEs like PyCharm, or in scenarios where memory usage is critical, using `boto3-stubs-lite` (e.g., `pip install 'boto3-stubs-lite[resourcegroupstaggingapi]'`) might be recommended over the full `boto3-stubs` or standalone packages. The lite version is more RAM-friendly but requires explicit type annotations for `session.client`/`resource` calls.
  Fix: If experiencing performance issues or high CPU usage in your IDE (especially PyCharm), consider switching to `boto3-stubs-lite` and ensure all your `boto3.client()` or `session.client()` calls have explicit type annotations, as shown in the quickstart example.
• deprecated While not directly affecting `ResourceGroupsTaggingAPI`, a change in `mypy-boto3-builder` 8.11.0 removed support for the `sms-voice` service, advising users to switch to `pinpoint-sms-voice`. This highlights that AWS service deprecations or renaming will propagate to `mypy-boto3` generated stubs, potentially requiring users to update service names in their code.
  Fix: Always consult AWS documentation for current service names. If a service you are using becomes deprecated or renamed, update your `boto3` client initialization and `mypy-boto3` imports accordingly.

Install

• pip install mypy-boto3-resourcegroupstaggingapi boto3 Install standalone stubs and boto3

Imports

• ResourceGroupsTaggingAPIClient

  from mypy_boto3_resourcegroupstaggingapi import ResourceGroupsTaggingAPIClient

• GetResourcesPaginator

  from mypy_boto3_resourcegroupstaggingapi.paginator import GetResourcesPaginator

• ComplianceDetailsTypeDef

  from mypy_boto3_resourcegroupstaggingapi.type_defs import ComplianceDetailsTypeDef

Quickstart

This example demonstrates how to use the ResourceGroupsTaggingAPIClient with type annotations to retrieve AWS resources based on specific tags. It showcases initializing the client and making a basic API call with type-hinted input and output.

import boto3
from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from mypy_boto3_resourcegroupstaggingapi import ResourceGroupsTaggingAPIClient
    from mypy_boto3_resourcegroupstaggingapi.type_defs import TagResourcesOutputTypeDef

def get_resources_with_tags(region_name: str, tags: dict[str, str]) -> TagResourcesOutputTypeDef:
    # Initialize the boto3 client with type annotation for mypy-boto3
    client: ResourceGroupsTaggingAPIClient = boto3.client(
        "resourcegroupstaggingapi",
        region_name=region_name
    )

    # Prepare tag filters for the GetResources operation
    tag_filters = [{
        "Key": k,
        "Values": [v]
    } for k, v in tags.items()]

    # Get resources with specified tags
    response = client.get_resources(
        TagFilters=tag_filters
    )

    print(f"Found {len(response.get('ResourceTagMappingList', []))} resources.")
    for resource_mapping in response.get('ResourceTagMappingList', []):
        print(f"  Resource ARN: {resource_mapping.get('ResourceARN')}")
        print(f"  Tags: {resource_mapping.get('Tags')}")
    return response

# Example usage:
if __name__ == "__main__":
    # Replace 'us-east-1' with your desired AWS region
    # Make sure your AWS credentials are configured (e.g., via AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_REGION_NAME env vars or ~/.aws/credentials)
    try:
        result = get_resources_with_tags(
            region_name="us-east-1",
            tags={
                "Environment": "Production",
                "Project": "MyProject"
            }
        )
    except Exception as e:
        print(f"An error occurred: {e}")