Type Annotations for Boto3 Bedrock Agent Core Control

1.42.87 · active · verified Sat Apr 11

This library provides PEP 561-compliant type annotations for the `boto3` Bedrock Agent Core Control service, enabling static type checking with tools like `mypy`. It helps developers catch type-related errors early and improves IDE autocompletion for `boto3`. The current version is 1.42.87, and it is updated frequently to align with new `boto3` releases.

Warnings

breaking Python 3.8 support has been removed from `mypy-boto3-builder` versions 8.12.0 and later, which affects generated stub packages. Users on Python 3.8 will encounter issues.
Fix: Upgrade to Python 3.9 or newer to continue receiving updates and full type-checking support. If unable to upgrade, pin to an older `mypy-boto3` version compatible with Python 3.8.
breaking Migration to PEP 561 package structure (`mypy-boto3-builder 8.12.0+`) might require updates to custom `mypy` configurations that rely on older module resolution paths. This primarily affects advanced `mypy` setups.
Fix: Review `mypy` configuration files (e.g., `mypy.ini`, `pyproject.toml`) to ensure `mypy` can correctly locate type stubs under the new PEP 561 structure. Typically, this change is seamless.
breaking TypeDef naming conventions were changed in `mypy-boto3-builder 8.9.0` to resolve conflicts and shorten names (e.g., `CreateDistributionRequestRequestTypeDef` -> `CreateDistributionRequestTypeDef`). If you directly import specific `TypeDef` names, they might have changed.
Fix: Update `TypeDef` import names in your codebase according to the new conventions. Consult the `mypy-boto3` documentation or generated stub files for the correct names.
gotcha This library provides *only* type annotations for `boto3`. You must explicitly install `boto3` (e.g., `pip install boto3`) for your code to run at runtime.
Fix: Always install `boto3` alongside `mypy-boto3-bedrock-agentcore-control` to ensure runtime functionality.
gotcha AWS service APIs (and thus `boto3`'s implementation) are constantly updated. To ensure your type hints are accurate and reflect the latest API, you should periodically update `mypy-boto3-bedrock-agentcore-control`.
Fix: Regularly run `pip install --upgrade mypy-boto3-bedrock-agentcore-control` to keep your stubs synchronized with the latest `boto3` versions.
gotcha When initializing the client, ensure the service name passed to `boto3.client()` exactly matches the service for which the stubs are provided. The correct name is 'bedrock-agent-core-control'.
Fix: Always use `boto3.client("bedrock-agent-core-control")` when creating the client instance that you intend to type-hint with `BedrockAgentCoreControlClient`.

Install

pip install boto3 mypy-boto3-bedrock-agentcore-control Install with boto3

Imports

BedrockAgentCoreControlClient
```
from mypy_boto3_bedrock_agent_core_control.client import BedrockAgentCoreControlClient
```
Boto3 itself does not export specific client types; stubs are needed for type hints.
ListAgentsResponseTypeDef
```
from mypy_boto3_bedrock_agent_core_control.type_defs import ListAgentsResponseTypeDef
```
The generated package name uses underscores for `bedrock_agent_core_control`, not hyphens or direct concatenation.

Quickstart

This quickstart demonstrates how to initialize a `boto3` client with `mypy-boto3` type hints for the Bedrock Agent Core Control service. It shows typical usage of type-hinted request and response dictionaries. Remember to install `boto3` separately.

import boto3
from mypy_boto3_bedrock_agent_core_control.client import BedrockAgentCoreControlClient
from mypy_boto3_bedrock_agent_core_control.type_defs import ListAgentsRequestRequestTypeDef, ListAgentsResponseTypeDef
from typing import TYPE_CHECKING, cast

# Ensure boto3 is configured, e.g., via AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_REGION_NAME env vars
# This example does not use actual credentials, but they would be needed for a real call.

# Use TYPE_CHECKING for type hints that are not needed at runtime
if TYPE_CHECKING:
    # Cast the boto3 client to the specific type stub for better type checking
    client: BedrockAgentCoreControlClient = cast(BedrockAgentCoreControlClient, boto3.client("bedrock-agent-core-control"))
else:
    client = boto3.client("bedrock-agent-core-control")

# Example of using a typed request and response
try:
    request: ListAgentsRequestRequestTypeDef = {
        "maxResults": 10
    }
    response: ListAgentsResponseTypeDef = client.list_agents(**request)

    print(f"Successfully listed agents. Total agents found: {len(response.get('agentSummaries', []))}")
    for agent in response.get('agentSummaries', []):
        print(f"  - Agent ID: {agent['agentId']}, Status: {agent['agentStatus']}")
except Exception as e:
    print(f"Error listing agents: {e}")
    print("Ensure your AWS credentials and region are configured correctly and Bedrock Agent Core Control is available.")

view raw JSON →