Skip to main content

Type annotations for boto3 BedrockAgentCoreControl 1.43.29 service generated with mypy-boto3-builder 8.12.0

Project description

mypy-boto3-bedrock-agentcore-control

PyPI - mypy-boto3-bedrock-agentcore-control PyPI - Python Version Docs PyPI - Downloads

boto3.typed

Type annotations for boto3 BedrockAgentCoreControl 1.43.29 compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.

Generated with mypy-boto3-builder 8.12.0.

More information can be found on boto3-stubs page and in mypy-boto3-bedrock-agentcore-control 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 boto3 package locally with mypy-boto3-builder. Use uv for build isolation.

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

VSCode extension

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and BedrockAgentCoreControl.

From PyPI with pip

Install boto3-stubs for BedrockAgentCoreControl service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[bedrock-agentcore-control]'

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

# standalone installation
python -m pip install mypy-boto3-bedrock-agentcore-control

How to uninstall

python -m pip uninstall -y mypy-boto3-bedrock-agentcore-control

Usage

VSCode

python -m pip install 'boto3-stubs[bedrock-agentcore-control]'

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

PyCharm

⚠️ Due to slow PyCharm performance on Literal overloads (issue PY-40997), it is recommended to use boto3-stubs-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 boto3-stubs with boto3-stubs-lite:

pip uninstall boto3-stubs
pip install boto3-stubs-lite

Install boto3-stubs[bedrock-agentcore-control] in your environment:

python -m pip install 'boto3-stubs[bedrock-agentcore-control]'

Both type checking and code completion should now work.

Emacs

  • Install boto3-stubs with services you use in your environment:
python -m pip install 'boto3-stubs[bedrock-agentcore-control]'
(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 boto3-stubs

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

Sublime Text

  • Install boto3-stubs[bedrock-agentcore-control] with services you use in your environment:
python -m pip install 'boto3-stubs[bedrock-agentcore-control]'

Type checking should now work. No explicit type annotations required, write your boto3 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 boto3-stubs[bedrock-agentcore-control] in your environment:
python -m pip install 'boto3-stubs[bedrock-agentcore-control]'

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

pyright

  • Install pyright: npm i -g pyright
  • Install boto3-stubs[bedrock-agentcore-control] in your environment:
python -m pip install 'boto3-stubs[bedrock-agentcore-control]'

Optionally, you can install boto3-stubs to typings directory.

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

Pylint compatibility

It is totally safe to use TYPE_CHECKING flag in order to avoid mypy-boto3-bedrock-agentcore-control 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 mypy_boto3_ec2 import EC2Client, EC2ServiceResource
    from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
    from mypy_boto3_ec2.paginators import DescribeVolumesPaginator
else:
    EC2Client = object
    EC2ServiceResource = object
    BundleTaskCompleteWaiter = object
    DescribeVolumesPaginator = object

...

Explicit type annotations

Client annotations

BedrockAgentCoreControlClient provides annotations for boto3.client("bedrock-agentcore-control").

from boto3.session import Session

from mypy_boto3_bedrock_agentcore_control import BedrockAgentCoreControlClient

client: BedrockAgentCoreControlClient = Session().client("bedrock-agentcore-control")

# now client usage is checked by mypy and IDE should provide code completion

Paginators annotations

mypy_boto3_bedrock_agentcore_control.paginator module contains type annotations for all paginators.

from boto3.session import Session

from mypy_boto3_bedrock_agentcore_control import BedrockAgentCoreControlClient
from mypy_boto3_bedrock_agentcore_control.paginator import (
    ListAgentRuntimeEndpointsPaginator,
    ListAgentRuntimeVersionsPaginator,
    ListAgentRuntimesPaginator,
    ListApiKeyCredentialProvidersPaginator,
    ListBrowserProfilesPaginator,
    ListBrowsersPaginator,
    ListCodeInterpretersPaginator,
    ListConfigurationBundleVersionsPaginator,
    ListConfigurationBundlesPaginator,
    ListDatasetExamplesPaginator,
    ListDatasetVersionsPaginator,
    ListDatasetsPaginator,
    ListEvaluatorsPaginator,
    ListGatewayRulesPaginator,
    ListGatewayTargetsPaginator,
    ListGatewaysPaginator,
    ListHarnessesPaginator,
    ListMemoriesPaginator,
    ListOauth2CredentialProvidersPaginator,
    ListOnlineEvaluationConfigsPaginator,
    ListPaymentConnectorsPaginator,
    ListPaymentCredentialProvidersPaginator,
    ListPaymentManagersPaginator,
    ListPoliciesPaginator,
    ListPolicyEngineSummariesPaginator,
    ListPolicyEnginesPaginator,
    ListPolicyGenerationAssetsPaginator,
    ListPolicyGenerationSummariesPaginator,
    ListPolicyGenerationsPaginator,
    ListPolicySummariesPaginator,
    ListRegistriesPaginator,
    ListRegistryRecordsPaginator,
    ListWorkloadIdentitiesPaginator,
)

client: BedrockAgentCoreControlClient = Session().client("bedrock-agentcore-control")

# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
list_agent_runtime_endpoints_paginator: ListAgentRuntimeEndpointsPaginator = client.get_paginator(
    "list_agent_runtime_endpoints"
)
list_agent_runtime_versions_paginator: ListAgentRuntimeVersionsPaginator = client.get_paginator(
    "list_agent_runtime_versions"
)
list_agent_runtimes_paginator: ListAgentRuntimesPaginator = client.get_paginator(
    "list_agent_runtimes"
)
list_api_key_credential_providers_paginator: ListApiKeyCredentialProvidersPaginator = (
    client.get_paginator("list_api_key_credential_providers")
)
list_browser_profiles_paginator: ListBrowserProfilesPaginator = client.get_paginator(
    "list_browser_profiles"
)
list_browsers_paginator: ListBrowsersPaginator = client.get_paginator("list_browsers")
list_code_interpreters_paginator: ListCodeInterpretersPaginator = client.get_paginator(
    "list_code_interpreters"
)
list_configuration_bundle_versions_paginator: ListConfigurationBundleVersionsPaginator = (
    client.get_paginator("list_configuration_bundle_versions")
)
list_configuration_bundles_paginator: ListConfigurationBundlesPaginator = client.get_paginator(
    "list_configuration_bundles"
)
list_dataset_examples_paginator: ListDatasetExamplesPaginator = client.get_paginator(
    "list_dataset_examples"
)
list_dataset_versions_paginator: ListDatasetVersionsPaginator = client.get_paginator(
    "list_dataset_versions"
)
list_datasets_paginator: ListDatasetsPaginator = client.get_paginator("list_datasets")
list_evaluators_paginator: ListEvaluatorsPaginator = client.get_paginator("list_evaluators")
list_gateway_rules_paginator: ListGatewayRulesPaginator = client.get_paginator("list_gateway_rules")
list_gateway_targets_paginator: ListGatewayTargetsPaginator = client.get_paginator(
    "list_gateway_targets"
)
list_gateways_paginator: ListGatewaysPaginator = client.get_paginator("list_gateways")
list_harnesses_paginator: ListHarnessesPaginator = client.get_paginator("list_harnesses")
list_memories_paginator: ListMemoriesPaginator = client.get_paginator("list_memories")
list_oauth2_credential_providers_paginator: ListOauth2CredentialProvidersPaginator = (
    client.get_paginator("list_oauth2_credential_providers")
)
list_online_evaluation_configs_paginator: ListOnlineEvaluationConfigsPaginator = (
    client.get_paginator("list_online_evaluation_configs")
)
list_payment_connectors_paginator: ListPaymentConnectorsPaginator = client.get_paginator(
    "list_payment_connectors"
)
list_payment_credential_providers_paginator: ListPaymentCredentialProvidersPaginator = (
    client.get_paginator("list_payment_credential_providers")
)
list_payment_managers_paginator: ListPaymentManagersPaginator = client.get_paginator(
    "list_payment_managers"
)
list_policies_paginator: ListPoliciesPaginator = client.get_paginator("list_policies")
list_policy_engine_summaries_paginator: ListPolicyEngineSummariesPaginator = client.get_paginator(
    "list_policy_engine_summaries"
)
list_policy_engines_paginator: ListPolicyEnginesPaginator = client.get_paginator(
    "list_policy_engines"
)
list_policy_generation_assets_paginator: ListPolicyGenerationAssetsPaginator = client.get_paginator(
    "list_policy_generation_assets"
)
list_policy_generation_summaries_paginator: ListPolicyGenerationSummariesPaginator = (
    client.get_paginator("list_policy_generation_summaries")
)
list_policy_generations_paginator: ListPolicyGenerationsPaginator = client.get_paginator(
    "list_policy_generations"
)
list_policy_summaries_paginator: ListPolicySummariesPaginator = client.get_paginator(
    "list_policy_summaries"
)
list_registries_paginator: ListRegistriesPaginator = client.get_paginator("list_registries")
list_registry_records_paginator: ListRegistryRecordsPaginator = client.get_paginator(
    "list_registry_records"
)
list_workload_identities_paginator: ListWorkloadIdentitiesPaginator = client.get_paginator(
    "list_workload_identities"
)

Waiters annotations

mypy_boto3_bedrock_agentcore_control.waiter module contains type annotations for all waiters.

from boto3.session import Session

from mypy_boto3_bedrock_agentcore_control import BedrockAgentCoreControlClient
from mypy_boto3_bedrock_agentcore_control.waiter import (
    MemoryCreatedWaiter,
    PolicyActiveWaiter,
    PolicyDeletedWaiter,
    PolicyEngineActiveWaiter,
    PolicyEngineDeletedWaiter,
    PolicyGenerationCompletedWaiter,
)

client: BedrockAgentCoreControlClient = Session().client("bedrock-agentcore-control")

# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
memory_created_waiter: MemoryCreatedWaiter = client.get_waiter("memory_created")
policy_active_waiter: PolicyActiveWaiter = client.get_waiter("policy_active")
policy_deleted_waiter: PolicyDeletedWaiter = client.get_waiter("policy_deleted")
policy_engine_active_waiter: PolicyEngineActiveWaiter = client.get_waiter("policy_engine_active")
policy_engine_deleted_waiter: PolicyEngineDeletedWaiter = client.get_waiter("policy_engine_deleted")
policy_generation_completed_waiter: PolicyGenerationCompletedWaiter = client.get_waiter(
    "policy_generation_completed"
)

Literals

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

Full list of BedrockAgentCoreControl Literals can be found in docs.

from mypy_boto3_bedrock_agentcore_control.literals import ActorTokenContentTypeType


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

Type definitions

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

Full list of BedrockAgentCoreControl TypeDefs can be found in docs.

# TypedDict usage example
from mypy_boto3_bedrock_agentcore_control.type_defs import AgentCardDefinitionTypeDef


def get_value() -> AgentCardDefinitionTypeDef:
    return {
        "schemaVersion": ...,
    }

How it works

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

  • All available boto3 services are covered.
  • Each public class and method of every boto3 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

mypy-boto3-bedrock-agentcore-control version is the same as related boto3 version and follows Python Packaging version specifiers.

Thank you

Documentation

All services type annotations can be found in boto3 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

mypy_boto3_bedrock_agentcore_control-1.43.29.tar.gz (85.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file mypy_boto3_bedrock_agentcore_control-1.43.29.tar.gz.

File metadata

File hashes

Hashes for mypy_boto3_bedrock_agentcore_control-1.43.29.tar.gz
Algorithm Hash digest
SHA256 0841e67dbcf0b140720b3536fbeeafa36cfedd5d3db8b792e0750d81ed33de02
MD5 75ccd56fa1e019edb9aede4fad9915b7
BLAKE2b-256 8b2e27213ac6bc0cc71091d3e612d697293cecdb9fcb40f19d4dad1cc128a425

See more details on using hashes here.

File details

Details for the file mypy_boto3_bedrock_agentcore_control-1.43.29-py3-none-any.whl.

File metadata

File hashes

Hashes for mypy_boto3_bedrock_agentcore_control-1.43.29-py3-none-any.whl
Algorithm Hash digest
SHA256 fd0750f945470377031758cb838f28db8097afa58b39448c9acebe1d3efe3b2b
MD5 1f3a270401cd5ca0bc0c5730ac05d6b8
BLAKE2b-256 04eafd37b6b87634ef33f4cce2969e9c0f3e403ed1cc18379fd5a243eaf51243

See more details on using hashes here.

Supported by

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