mypy-boto3-discovery Type Annotations

Warnings

• breaking Starting with version 8.12.0, support for Python 3.8 has been removed. Projects using this library must upgrade to Python 3.9 or newer.
  Fix: Upgrade your Python environment to 3.9 or later. Consider using a virtual environment manager like `pyenv` or `conda`.
• breaking Version 8.12.0 migrated all `mypy-boto3-*` packages to PEP 561-compliant distribution. While `pip install` generally works, advanced `mypy` configurations or custom build systems that directly manipulate stub files might require adjustments.
  Fix: Ensure your `mypy` configuration correctly points to installed packages. If experiencing issues, verify the `py.typed` marker file exists in the installed package. Re-evaluate any custom stub file paths or `mypy` plugins.
• gotcha This package provides only type stubs. You must install the `boto3` library separately for your application to function at runtime. Type checkers will use these stubs, but `boto3` is the actual dependency for AWS SDK functionality.
  Fix: Always install `boto3` (e.g., `pip install boto3`) alongside `mypy-boto3-discovery` or `boto3-stubs`.
• gotcha For the most accurate type checking, it is crucial to keep your `boto3` library version and your `mypy-boto3-*` stub versions in sync. Significant version discrepancies can lead to incorrect type hints or missing attributes as AWS services evolve.
  Fix: Regularly update both `boto3` and your `mypy-boto3-discovery` (or `boto3-stubs`) packages. Consider pinning versions in your `requirements.txt` to ensure compatibility across your development team and CI/CD.

Install

• pip install mypy-boto3-discovery Install only stubs for ApplicationDiscoveryService
• pip install 'boto3-stubs[discovery]' Install all boto3 stubs including ApplicationDiscoveryService (recommended)

Imports

• ApplicationDiscoveryServiceClient

  from mypy_boto3_discovery.client import ApplicationDiscoveryServiceClient

• DescribeAgentsResponseTypeDef

  from mypy_boto3_discovery.type_defs import DescribeAgentsResponseTypeDef

• AgentInfoTypeDef

  from mypy_boto3_discovery.type_defs import AgentInfoTypeDef

Quickstart

This example demonstrates how to initialize a type-hinted `ApplicationDiscoveryServiceClient` and call `describe_agents`. It uses `os.environ.get` for region to make it runnable without hardcoding. Remember to configure AWS credentials and ensure the necessary IAM permissions are granted.

import boto3
from mypy_boto3_discovery.client import ApplicationDiscoveryServiceClient
from mypy_boto3_discovery.type_defs import DescribeAgentsResponseTypeDef, AgentInfoTypeDef
import os

def list_discovery_agents() -> None:
    # Using type hints for the boto3 client
    client: ApplicationDiscoveryServiceClient = boto3.client(
        "discovery",
        region_name=os.environ.get('AWS_REGION', 'us-east-1')
    )

    try:
        # The response object is type-hinted
        response: DescribeAgentsResponseTypeDef = client.describe_agents()
        agents: list[AgentInfoTypeDef] = response.get("agents", [])

        if agents:
            print("Discovery Agents:")
            for agent in agents:
                print(f"  Agent ID: {agent.get('agentId')}")
                print(f"    Agent Status: {agent.get('agentStatus')}")
                print(f"    Host Name: {agent.get('hostName')}")
                print(f"    Version: {agent.get('version')}")
                print(f"    IP Address: {agent.get('agentIp')}")
        else:
            print("No discovery agents found.")

    except Exception as e:
        print(f"Error describing agents: {e}")

if __name__ == "__main__":
    # Ensure AWS credentials are configured (e.g., via environment variables or ~/.aws/credentials)
    # and that the IAM user/role has permissions for 'discovery:DescribeAgents'.
    list_discovery_agents()