Skip to main content

Type annotations for aiobotocore BedrockRuntime 2.19.0 service generated with mypy-boto3-builder 8.8.0

Project description

types-aiobotocore-bedrock-runtime

PyPI - types-aiobotocore-bedrock-runtime PyPI - Python Version Docs PyPI - Downloads

boto3.typed

Type annotations for aiobotocore BedrockRuntime 2.19.0 compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.

Generated with mypy-boto3-builder 8.8.0.

More information can be found on types-aiobotocore page and in types-aiobotocore-bedrock-runtime docs.

See how it helps you find and fix potential bugs:

types-boto3 demo

How to install

Generate locally (recommended)

You can generate type annotations for aiobotocore package locally with mypy_boto3_builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'aiobotocore==2.19.0' mypy_boto3_builder
  2. Select aiobotocore AWS SDK.
  3. Add BedrockRuntime service.
  4. Use provided commands to install generated packages.

From PyPI with pip

Install types-aiobotocore for BedrockRuntime service.

# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[bedrock-runtime]'

# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-aiobotocore-lite[bedrock-runtime]'

# standalone installation
python -m pip install types-aiobotocore-bedrock-runtime

How to uninstall

python -m pip uninstall -y types-aiobotocore-bedrock-runtime

Usage

VSCode

python -m pip install 'types-aiobotocore[bedrock-runtime]'

Both type checking and code completion should now work. No explicit type annotations required, write your aiobotocore code as usual.

PyCharm

⚠️ Due to slow PyCharm performance on Literal overloads (issue PY-40997), it is recommended to use types-aiobotocore-lite until the issue is resolved.

⚠️ If you experience slow performance and high CPU usage, try to disable PyCharm type checker and use mypy or pyright instead.

⚠️ To continue using PyCharm type checker, you can try to replace types-aiobotocore with types-aiobotocore-lite:

pip uninstall types-aiobotocore
pip install types-aiobotocore-lite

Install types-aiobotocore[bedrock-runtime] in your environment:

python -m pip install 'types-aiobotocore[bedrock-runtime]'

Both type checking and code completion should now work.

Emacs

  • Install types-aiobotocore with services you use in your environment:
python -m pip install 'types-aiobotocore[bedrock-runtime]'
(use-package lsp-pyright
  :ensure t
  :hook (python-mode . (lambda ()
                          (require 'lsp-pyright)
                          (lsp)))  ; or lsp-deferred
  :init (when (executable-find "python3")
          (setq lsp-pyright-python-executable-cmd "python3"))
  )
  • Make sure emacs uses the environment where you have installed types-aiobotocore

Type checking should now work. No explicit type annotations required, write your aiobotocore code as usual.

Sublime Text

  • Install types-aiobotocore[bedrock-runtime] with services you use in your environment:
python -m pip install 'types-aiobotocore[bedrock-runtime]'

Type checking should now work. No explicit type annotations required, write your aiobotocore code as usual.

Other IDEs

Not tested, but as long as your IDE supports mypy or pyright, everything should work.

mypy

  • Install mypy: python -m pip install mypy
  • Install types-aiobotocore[bedrock-runtime] in your environment:
python -m pip install 'types-aiobotocore[bedrock-runtime]'

Type checking should now work. No explicit type annotations required, write your aiobotocore code as usual.

pyright

  • Install pyright: npm i -g pyright
  • Install types-aiobotocore[bedrock-runtime] in your environment:
python -m pip install 'types-aiobotocore[bedrock-runtime]'

Optionally, you can install types-aiobotocore to typings directory.

Type checking should now work. No explicit type annotations required, write your aiobotocore code as usual.

Pylint compatibility

It is totally safe to use TYPE_CHECKING flag in order to avoid types-aiobotocore-bedrock-runtime dependency in production. However, there is an issue in pylint that it complains about undefined variables. To fix it, set all types to object in non-TYPE_CHECKING mode.

from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from types_aiobotocore_ec2 import EC2Client, EC2ServiceResource
    from types_aiobotocore_ec2.waiters import BundleTaskCompleteWaiter
    from types_aiobotocore_ec2.paginators import DescribeVolumesPaginator
else:
    EC2Client = object
    EC2ServiceResource = object
    BundleTaskCompleteWaiter = object
    DescribeVolumesPaginator = object

...

Explicit type annotations

Client annotations

BedrockRuntimeClient provides annotations for session.create_client("bedrock-runtime").

from aiobotocore.session import get_session

from types_aiobotocore_bedrock_runtime import BedrockRuntimeClient

session = get_session()
async with session.create_client("bedrock-runtime") as client:
    client: BedrockRuntimeClient
    # now client usage is checked by mypy and IDE should provide code completion

Paginators annotations

types_aiobotocore_bedrock_runtime.paginator module contains type annotations for all paginators.

from aiobotocore.session import get_session

from types_aiobotocore_bedrock_runtime import BedrockRuntimeClient
from types_aiobotocore_bedrock_runtime.paginator import ListAsyncInvokesPaginator

session = get_session()
async with session.create_client("bedrock-runtime") as client:
    client: BedrockRuntimeClient

    # Explicit type annotations are optional here
    # Types should be correctly discovered by mypy and IDEs
    list_async_invokes_paginator: ListAsyncInvokesPaginator = client.get_paginator(
        "list_async_invokes"
    )

Literals

types_aiobotocore_bedrock_runtime.literals module contains literals extracted from shapes that can be used in user code for type checking.

Full list of BedrockRuntime Literals can be found in docs.

from types_aiobotocore_bedrock_runtime.literals import AsyncInvokeStatusType


def check_value(value: AsyncInvokeStatusType) -> bool: ...

Type definitions

types_aiobotocore_bedrock_runtime.type_defs module contains structures and shapes assembled to typed dictionaries and unions for additional type checking.

Full list of BedrockRuntime TypeDefs can be found in docs.

from types_aiobotocore_bedrock_runtime.type_defs import GuardrailOutputContentTypeDef


def get_value() -> GuardrailOutputContentTypeDef:
    return {...}

How it works

Fully automated mypy-boto3-builder carefully generates type annotations for each service, patiently waiting for aiobotocore updates. It delivers drop-in type annotations for you and makes sure that:

  • All available aiobotocore services are covered.
  • Each public class and method of every aiobotocore service gets valid type annotations extracted from botocore schemas.
  • Type annotations include up-to-date documentation.
  • Link to documentation is provided for every method.
  • Code is processed by ruff for readability.

What's new

Implemented features

  • Fully type annotated boto3, botocore, aiobotocore and aioboto3 libraries
  • mypy, pyright, VSCode, PyCharm, Sublime Text and Emacs compatibility
  • Client, ServiceResource, Resource, Waiter Paginator type annotations for each service
  • Generated TypeDefs for each service
  • Generated Literals for each service
  • Auto discovery of types for boto3.client and boto3.resource calls
  • Auto discovery of types for session.client and session.resource calls
  • Auto discovery of types for client.get_waiter and client.get_paginator calls
  • Auto discovery of types for ServiceResource and Resource collections
  • Auto discovery of types for aiobotocore.Session.create_client calls

Latest changes

Builder changelog can be found in Releases.

Versioning

types-aiobotocore-bedrock-runtime version is the same as related aiobotocore version and follows PEP 440 format.

Thank you

Documentation

All services type annotations can be found in aiobotocore docs

Support and contributing

This package is auto-generated. Please reports any bugs or request new features in mypy-boto3-builder repository.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

File details

Details for the file types_aiobotocore_bedrock_runtime-2.19.0.tar.gz.

File metadata

File hashes

Hashes for types_aiobotocore_bedrock_runtime-2.19.0.tar.gz
Algorithm Hash digest
SHA256 6492d6613bd9297685e1b66c84af18397e1d164a00ef89a5a3912d6a62897d89
MD5 96d7adebaa1b166bdf742da5782401ee
BLAKE2b-256 1ed280536892bab5c2dd38e4b8710b5de57a450e33a14ceb037cc1697a107d8a

See more details on using hashes here.

File details

Details for the file types_aiobotocore_bedrock_runtime-2.19.0-py3-none-any.whl.

File metadata

File hashes

Hashes for types_aiobotocore_bedrock_runtime-2.19.0-py3-none-any.whl
Algorithm Hash digest
SHA256 de2e4c6c93330724e8a8ba2a90954156609d37c7b1ead00756ca655fd679af2d
MD5 1c258392100ec515b36408b4bff97023
BLAKE2b-256 13bf7c99914104aac4b2c471da0278872507baa9d17d40fbd4edccdb66468bdc

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page