Type annotations for aiobotocore BedrockRuntime

Warnings

• breaking Support for Python 3.8 has been removed. Users must upgrade to Python 3.9 or newer.
  Fix: Upgrade your Python environment to version 3.9 or higher.
• breaking TypeDef names for method arguments and conflicting names may have changed to be shorter or use different postfixes (e.g., `RequestRequestTypeDef` -> `RequestTypeDef`, `ExtraRequestTypeDef` -> `RequestExtraTypeDef`). This can break existing explicit type annotations.
  Fix: Update your code to reflect the new `TypeDef` naming conventions as indicated by your type checker.
• gotcha When using PyCharm, slow performance or high CPU usage might occur due to how it handles Literal overloads in type stubs. It's recommended to either use an external type checker like mypy/pyright or consider the '-lite' version of types-aiobotocore if available for less strict type checking in the IDE.
  Fix: Use mypy or pyright as your primary type checker, or consider `types-aiobotocore-lite` if performance is critical within PyCharm.
• gotcha Pylint might report false positives about undefined variables when using type stubs with the `TYPE_CHECKING` flag. To resolve this, you might need to configure Pylint or explicitly set types to `object` in non-`TYPE_CHECKING` mode.
  Fix: Refer to the `types-aiobotocore` documentation for Pylint compatibility or configure Pylint to ignore these specific warnings.
• gotcha This package provides *only* type annotations. The `aiobotocore` library itself (the runtime dependency) must be installed separately for your code to function.
  Fix: Ensure `aiobotocore` is installed in your environment alongside `types-aiobotocore-bedrock-runtime`.

Install

• pip install types-aiobotocore-bedrock-runtime aiobotocore Standalone installation
• pip install 'types-aiobotocore[bedrock-runtime]' aiobotocore Installation via types-aiobotocore extras

Imports

• BedrockRuntimeClient

  from types_aiobotocore_bedrock_runtime.client import BedrockRuntimeClient

• InvokeModelResponseTypeDef

  from types_aiobotocore_bedrock_runtime.type_defs import InvokeModelResponseTypeDef

• AsyncInvokeStatusType

  from types_aiobotocore_bedrock_runtime.literals import AsyncInvokeStatusType

Quickstart

This example demonstrates how to use `aiobotocore` with the `types-aiobotocore-bedrock-runtime` stubs for type-checked asynchronous interaction with the Amazon Bedrock Runtime service. It explicitly types the client and a response, then invokes a model and streams its output. Note that `aiobotocore` itself must be installed alongside the type stubs.

import asyncio
from typing import TYPE_CHECKING

import aiobotocore.session

if TYPE_CHECKING:
    from types_aiobotocore_bedrock_runtime.client import BedrockRuntimeClient
    from types_aiobotocore_bedrock_runtime.type_defs import InvokeModelResponseTypeDef

async def main():
    session = aiobotocore.session.get_session()
    async with session.create_client("bedrock-runtime") as client:
        client: BedrockRuntimeClient  # Explicit type hint (optional, but good practice)

        response: InvokeModelResponseTypeDef = await client.invoke_model(
            modelId="anthropic.claude-3-sonnet-20240229-v1:0",
            contentType="application/json",
            accept="application/json",
            body=b'{"prompt": "Human: Hello, world!\nAssistant:"}'
        )

        async with response["body"] as stream:
            payload = stream.iter_bytes()
            async for chunk in payload:
                print(chunk.decode())

if __name__ == "__main__":
    asyncio.run(main())