AgentsforBedrock module#
Index > AgentsforBedrock
Auto-generated documentation for AgentsforBedrock type annotations stubs module mypy-boto3-bedrock-agent.
How to install#
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and AgentsforBedrock
.
From PyPI with pip#
Install boto3-stubs
for AgentsforBedrock
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[bedrock-agent]'
# 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-agent]'
# standalone installation
python -m pip install mypy-boto3-bedrock-agent
How to uninstall#
python -m pip uninstall -y mypy-boto3-bedrock-agent
Usage#
Code samples can be found in Examples.
AgentsforBedrockClient#
Type annotations and code completion for boto3.client("bedrock-agent")
as AgentsforBedrockClient
boto3 documentation
# AgentsforBedrockClient usage example
from boto3.session import Session
from mypy_boto3_bedrock_agent.client import AgentsforBedrockClient
def get_client() -> AgentsforBedrockClient:
return Session().client("bedrock-agent")
Paginators#
Type annotations and code completion for paginators
from boto3.client("bedrock-agent").get_paginator("...")
.
# ListAgentActionGroupsPaginator usage example
from boto3.session import Session
from mypy_boto3_bedrock_agent.paginator import ListAgentActionGroupsPaginator
def get_list_agent_action_groups_paginator() -> ListAgentActionGroupsPaginator:
return Session().client("bedrock-agent").get_paginator("list_agent_action_groups"))
- ListAgentActionGroupsPaginator
- ListAgentAliasesPaginator
- ListAgentKnowledgeBasesPaginator
- ListAgentVersionsPaginator
- ListAgentsPaginator
- ListDataSourcesPaginator
- ListIngestionJobsPaginator
- ListKnowledgeBasesPaginator
Literals#
Type annotations for literals used in methods and schema.
# ActionGroupSignatureType usage example
from mypy_boto3_bedrock_agent.literals import ActionGroupSignatureType
def get_value() -> ActionGroupSignatureType:
return "AMAZON.UserInput"
- ActionGroupSignatureType
- ActionGroupStateType
- AgentAliasStatusType
- AgentStatusType
- ChunkingStrategyType
- CreationModeType
- CustomControlMethodType
- DataDeletionPolicyType
- DataSourceStatusType
- DataSourceTypeType
- IngestionJobFilterAttributeType
- IngestionJobFilterOperatorType
- IngestionJobSortByAttributeType
- IngestionJobStatusType
- KnowledgeBaseStateType
- KnowledgeBaseStatusType
- KnowledgeBaseStorageTypeType
- KnowledgeBaseTypeType
- ListAgentActionGroupsPaginatorName
- ListAgentAliasesPaginatorName
- ListAgentKnowledgeBasesPaginatorName
- ListAgentVersionsPaginatorName
- ListAgentsPaginatorName
- ListDataSourcesPaginatorName
- ListIngestionJobsPaginatorName
- ListKnowledgeBasesPaginatorName
- PromptStateType
- PromptTypeType
- SortOrderType
- TypeType
- AgentsforBedrockServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
Type definitions#
Type annotations for type definitions used in methods and schema.
- S3IdentifierTypeDef
- ActionGroupExecutorTypeDef
- ActionGroupSummaryTypeDef
- AgentAliasRoutingConfigurationListItemTypeDef
- AgentKnowledgeBaseSummaryTypeDef
- AgentKnowledgeBaseTypeDef
- AgentSummaryTypeDef
- AgentVersionSummaryTypeDef
- AssociateAgentKnowledgeBaseRequestRequestTypeDef
- ResponseMetadataTypeDef
- FixedSizeChunkingConfigurationTypeDef
- ServerSideEncryptionConfigurationTypeDef
- S3DataSourceConfigurationOutputTypeDef
- S3DataSourceConfigurationTypeDef
- DataSourceSummaryTypeDef
- DeleteAgentActionGroupRequestRequestTypeDef
- DeleteAgentAliasRequestRequestTypeDef
- DeleteAgentRequestRequestTypeDef
- DeleteAgentVersionRequestRequestTypeDef
- DeleteDataSourceRequestRequestTypeDef
- DeleteKnowledgeBaseRequestRequestTypeDef
- DisassociateAgentKnowledgeBaseRequestRequestTypeDef
- ParameterDetailTypeDef
- GetAgentActionGroupRequestRequestTypeDef
- GetAgentAliasRequestRequestTypeDef
- GetAgentKnowledgeBaseRequestRequestTypeDef
- GetAgentRequestRequestTypeDef
- GetAgentVersionRequestRequestTypeDef
- GetDataSourceRequestRequestTypeDef
- GetIngestionJobRequestRequestTypeDef
- GetKnowledgeBaseRequestRequestTypeDef
- InferenceConfigurationOutputTypeDef
- InferenceConfigurationTypeDef
- IngestionJobFilterTypeDef
- IngestionJobSortByTypeDef
- IngestionJobStatisticsTypeDef
- VectorKnowledgeBaseConfigurationTypeDef
- KnowledgeBaseSummaryTypeDef
- PaginatorConfigTypeDef
- ListAgentActionGroupsRequestRequestTypeDef
- ListAgentAliasesRequestRequestTypeDef
- ListAgentKnowledgeBasesRequestRequestTypeDef
- ListAgentVersionsRequestRequestTypeDef
- ListAgentsRequestRequestTypeDef
- ListDataSourcesRequestRequestTypeDef
- ListKnowledgeBasesRequestRequestTypeDef
- ListTagsForResourceRequestRequestTypeDef
- OpenSearchServerlessFieldMappingTypeDef
- PineconeFieldMappingTypeDef
- PrepareAgentRequestRequestTypeDef
- RdsFieldMappingTypeDef
- RedisEnterpriseCloudFieldMappingTypeDef
- StartIngestionJobRequestRequestTypeDef
- TagResourceRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- UpdateAgentKnowledgeBaseRequestRequestTypeDef
- APISchemaTypeDef
- AgentAliasHistoryEventTypeDef
- AgentAliasSummaryTypeDef
- CreateAgentAliasRequestRequestTypeDef
- UpdateAgentAliasRequestRequestTypeDef
- AssociateAgentKnowledgeBaseResponseTypeDef
- DeleteAgentAliasResponseTypeDef
- DeleteAgentResponseTypeDef
- DeleteAgentVersionResponseTypeDef
- DeleteDataSourceResponseTypeDef
- DeleteKnowledgeBaseResponseTypeDef
- GetAgentKnowledgeBaseResponseTypeDef
- ListAgentActionGroupsResponseTypeDef
- ListAgentKnowledgeBasesResponseTypeDef
- ListAgentVersionsResponseTypeDef
- ListAgentsResponseTypeDef
- ListTagsForResourceResponseTypeDef
- PrepareAgentResponseTypeDef
- UpdateAgentKnowledgeBaseResponseTypeDef
- ChunkingConfigurationTypeDef
- DataSourceConfigurationOutputTypeDef
- DataSourceConfigurationTypeDef
- ListDataSourcesResponseTypeDef
- FunctionOutputTypeDef
- FunctionTypeDef
- PromptConfigurationOutputTypeDef
- PromptConfigurationTypeDef
- ListIngestionJobsRequestRequestTypeDef
- IngestionJobSummaryTypeDef
- IngestionJobTypeDef
- KnowledgeBaseConfigurationTypeDef
- ListKnowledgeBasesResponseTypeDef
- ListAgentActionGroupsRequestListAgentActionGroupsPaginateTypeDef
- ListAgentAliasesRequestListAgentAliasesPaginateTypeDef
- ListAgentKnowledgeBasesRequestListAgentKnowledgeBasesPaginateTypeDef
- ListAgentVersionsRequestListAgentVersionsPaginateTypeDef
- ListAgentsRequestListAgentsPaginateTypeDef
- ListDataSourcesRequestListDataSourcesPaginateTypeDef
- ListIngestionJobsRequestListIngestionJobsPaginateTypeDef
- ListKnowledgeBasesRequestListKnowledgeBasesPaginateTypeDef
- OpenSearchServerlessConfigurationTypeDef
- PineconeConfigurationTypeDef
- RdsConfigurationTypeDef
- RedisEnterpriseCloudConfigurationTypeDef
- AgentAliasTypeDef
- ListAgentAliasesResponseTypeDef
- VectorIngestionConfigurationTypeDef
- DataSourceConfigurationUnionTypeDef
- FunctionSchemaOutputTypeDef
- FunctionSchemaTypeDef
- PromptOverrideConfigurationOutputTypeDef
- PromptOverrideConfigurationTypeDef
- ListIngestionJobsResponseTypeDef
- GetIngestionJobResponseTypeDef
- StartIngestionJobResponseTypeDef
- StorageConfigurationTypeDef
- CreateAgentAliasResponseTypeDef
- GetAgentAliasResponseTypeDef
- UpdateAgentAliasResponseTypeDef
- CreateDataSourceRequestRequestTypeDef
- DataSourceTypeDef
- UpdateDataSourceRequestRequestTypeDef
- AgentActionGroupTypeDef
- CreateAgentActionGroupRequestRequestTypeDef
- FunctionSchemaUnionTypeDef
- UpdateAgentActionGroupRequestRequestTypeDef
- AgentTypeDef
- AgentVersionTypeDef
- CreateAgentRequestRequestTypeDef
- PromptOverrideConfigurationUnionTypeDef
- UpdateAgentRequestRequestTypeDef
- CreateKnowledgeBaseRequestRequestTypeDef
- KnowledgeBaseTypeDef
- UpdateKnowledgeBaseRequestRequestTypeDef
- CreateDataSourceResponseTypeDef
- GetDataSourceResponseTypeDef
- UpdateDataSourceResponseTypeDef
- CreateAgentActionGroupResponseTypeDef
- GetAgentActionGroupResponseTypeDef
- UpdateAgentActionGroupResponseTypeDef
- CreateAgentResponseTypeDef
- GetAgentResponseTypeDef
- UpdateAgentResponseTypeDef
- GetAgentVersionResponseTypeDef
- CreateKnowledgeBaseResponseTypeDef
- GetKnowledgeBaseResponseTypeDef
- UpdateKnowledgeBaseResponseTypeDef