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
- ListFlowAliasesPaginator
- ListFlowVersionsPaginator
- ListFlowsPaginator
- ListIngestionJobsPaginator
- ListKnowledgeBasesPaginator
- ListPromptsPaginator
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.CodeInterpreter"
- ActionGroupSignatureType
- ActionGroupStateType
- AgentAliasStatusType
- AgentStatusType
- ChunkingStrategyType
- ConfluenceAuthTypeType
- ConfluenceHostTypeType
- ConversationRoleType
- CrawlFilterConfigurationTypeType
- CreationModeType
- CustomControlMethodType
- DataDeletionPolicyType
- DataSourceStatusType
- DataSourceTypeType
- FlowConnectionTypeType
- FlowNodeIODataTypeType
- FlowNodeTypeType
- FlowStatusType
- FlowValidationSeverityType
- FlowValidationTypeType
- IngestionJobFilterAttributeType
- IngestionJobFilterOperatorType
- IngestionJobSortByAttributeType
- IngestionJobStatusType
- KnowledgeBaseStateType
- KnowledgeBaseStatusType
- KnowledgeBaseStorageTypeType
- KnowledgeBaseTypeType
- ListAgentActionGroupsPaginatorName
- ListAgentAliasesPaginatorName
- ListAgentKnowledgeBasesPaginatorName
- ListAgentVersionsPaginatorName
- ListAgentsPaginatorName
- ListDataSourcesPaginatorName
- ListFlowAliasesPaginatorName
- ListFlowVersionsPaginatorName
- ListFlowsPaginatorName
- ListIngestionJobsPaginatorName
- ListKnowledgeBasesPaginatorName
- ListPromptsPaginatorName
- MemoryTypeType
- ParsingStrategyType
- PromptStateType
- PromptTemplateTypeType
- PromptTypeType
- RequireConfirmationType
- SalesforceAuthTypeType
- SharePointAuthTypeType
- SharePointHostTypeType
- SortOrderType
- StepTypeType
- TypeType
- WebScopeTypeType
- AgentsforBedrockServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
Type definitions#
Type annotations for type definitions used in methods and schema.
- S3IdentifierTypeDef
- ActionGroupExecutorTypeDef
- ActionGroupSummaryTypeDef
- AgentAliasRoutingConfigurationListItemTypeDef
- AgentFlowNodeConfigurationTypeDef
- AgentKnowledgeBaseSummaryTypeDef
- AgentKnowledgeBaseTypeDef
- GuardrailConfigurationTypeDef
- MemoryConfigurationOutputTypeDef
- AssociateAgentKnowledgeBaseRequestRequestTypeDef
- ResponseMetadataTypeDef
- BedrockEmbeddingModelConfigurationTypeDef
- ParsingPromptTypeDef
- PromptInputVariableTypeDef
- SystemContentBlockTypeDef
- FixedSizeChunkingConfigurationTypeDef
- SemanticChunkingConfigurationTypeDef
- FlowConditionTypeDef
- ConfluenceSourceConfigurationTypeDef
- ContentBlockTypeDef
- MemoryConfigurationTypeDef
- ServerSideEncryptionConfigurationTypeDef
- FlowAliasRoutingConfigurationListItemTypeDef
- CreateFlowVersionRequestRequestTypeDef
- CreatePromptVersionRequestRequestTypeDef
- CyclicConnectionFlowValidationDetailsTypeDef
- S3DataSourceConfigurationOutputTypeDef
- DataSourceSummaryTypeDef
- DeleteAgentActionGroupRequestRequestTypeDef
- DeleteAgentAliasRequestRequestTypeDef
- DeleteAgentRequestRequestTypeDef
- DeleteAgentVersionRequestRequestTypeDef
- DeleteDataSourceRequestRequestTypeDef
- DeleteFlowAliasRequestRequestTypeDef
- DeleteFlowRequestRequestTypeDef
- DeleteFlowVersionRequestRequestTypeDef
- DeleteKnowledgeBaseRequestRequestTypeDef
- DeletePromptRequestRequestTypeDef
- DisassociateAgentKnowledgeBaseRequestRequestTypeDef
- DuplicateConditionExpressionFlowValidationDetailsTypeDef
- DuplicateConnectionsFlowValidationDetailsTypeDef
- FlowConditionalConnectionConfigurationTypeDef
- FlowDataConnectionConfigurationTypeDef
- LambdaFunctionFlowNodeConfigurationTypeDef
- LexFlowNodeConfigurationTypeDef
- FlowNodeInputTypeDef
- FlowNodeOutputTypeDef
- FlowSummaryTypeDef
- IncompatibleConnectionDataTypeFlowValidationDetailsTypeDef
- MalformedConditionExpressionFlowValidationDetailsTypeDef
- MalformedNodeInputExpressionFlowValidationDetailsTypeDef
- MismatchedNodeInputTypeFlowValidationDetailsTypeDef
- MismatchedNodeOutputTypeFlowValidationDetailsTypeDef
- MissingConnectionConfigurationFlowValidationDetailsTypeDef
- MissingDefaultConditionFlowValidationDetailsTypeDef
- MissingNodeConfigurationFlowValidationDetailsTypeDef
- MissingNodeInputFlowValidationDetailsTypeDef
- MissingNodeOutputFlowValidationDetailsTypeDef
- MultipleNodeInputConnectionsFlowValidationDetailsTypeDef
- UnfulfilledNodeInputFlowValidationDetailsTypeDef
- UnknownConnectionConditionFlowValidationDetailsTypeDef
- UnknownConnectionSourceFlowValidationDetailsTypeDef
- UnknownConnectionSourceOutputFlowValidationDetailsTypeDef
- UnknownConnectionTargetFlowValidationDetailsTypeDef
- UnknownConnectionTargetInputFlowValidationDetailsTypeDef
- UnreachableNodeFlowValidationDetailsTypeDef
- UnsatisfiedConnectionConditionsFlowValidationDetailsTypeDef
- FlowVersionSummaryTypeDef
- ParameterDetailTypeDef
- GetAgentActionGroupRequestRequestTypeDef
- GetAgentAliasRequestRequestTypeDef
- GetAgentKnowledgeBaseRequestRequestTypeDef
- GetAgentRequestRequestTypeDef
- GetAgentVersionRequestRequestTypeDef
- GetDataSourceRequestRequestTypeDef
- GetFlowAliasRequestRequestTypeDef
- GetFlowRequestRequestTypeDef
- GetFlowVersionRequestRequestTypeDef
- GetIngestionJobRequestRequestTypeDef
- GetKnowledgeBaseRequestRequestTypeDef
- GetPromptRequestRequestTypeDef
- HierarchicalChunkingLevelConfigurationTypeDef
- InferenceConfigurationOutputTypeDef
- InferenceConfigurationTypeDef
- IngestionJobFilterTypeDef
- IngestionJobSortByTypeDef
- IngestionJobStatisticsTypeDef
- S3LocationTypeDef
- KnowledgeBaseSummaryTypeDef
- PaginatorConfigTypeDef
- ListAgentActionGroupsRequestRequestTypeDef
- ListAgentAliasesRequestRequestTypeDef
- ListAgentKnowledgeBasesRequestRequestTypeDef
- ListAgentVersionsRequestRequestTypeDef
- ListAgentsRequestRequestTypeDef
- ListDataSourcesRequestRequestTypeDef
- ListFlowAliasesRequestRequestTypeDef
- ListFlowVersionsRequestRequestTypeDef
- ListFlowsRequestRequestTypeDef
- ListKnowledgeBasesRequestRequestTypeDef
- ListPromptsRequestRequestTypeDef
- PromptSummaryTypeDef
- ListTagsForResourceRequestRequestTypeDef
- MongoDbAtlasFieldMappingTypeDef
- OpenSearchServerlessFieldMappingTypeDef
- PatternObjectFilterOutputTypeDef
- PatternObjectFilterTypeDef
- PineconeFieldMappingTypeDef
- PrepareAgentRequestRequestTypeDef
- PrepareFlowRequestRequestTypeDef
- PromptAgentResourceTypeDef
- PromptFlowNodeResourceConfigurationTypeDef
- PromptModelInferenceConfigurationOutputTypeDef
- PromptMetadataEntryTypeDef
- PromptModelInferenceConfigurationTypeDef
- RdsFieldMappingTypeDef
- RedisEnterpriseCloudFieldMappingTypeDef
- RetrievalFlowNodeS3ConfigurationTypeDef
- S3DataSourceConfigurationTypeDef
- SalesforceSourceConfigurationTypeDef
- SeedUrlTypeDef
- SharePointSourceConfigurationOutputTypeDef
- SharePointSourceConfigurationTypeDef
- SpecificToolChoiceTypeDef
- StartIngestionJobRequestRequestTypeDef
- StopIngestionJobRequestRequestTypeDef
- StorageFlowNodeS3ConfigurationTypeDef
- TagResourceRequestRequestTypeDef
- ToolInputSchemaOutputTypeDef
- ToolInputSchemaTypeDef
- TransformationLambdaConfigurationTypeDef
- UntagResourceRequestRequestTypeDef
- UpdateAgentKnowledgeBaseRequestRequestTypeDef
- WebCrawlerLimitsTypeDef
- APISchemaTypeDef
- AgentAliasHistoryEventTypeDef
- AgentAliasSummaryTypeDef
- CreateAgentAliasRequestRequestTypeDef
- UpdateAgentAliasRequestRequestTypeDef
- AgentSummaryTypeDef
- AgentVersionSummaryTypeDef
- KnowledgeBaseFlowNodeConfigurationTypeDef
- AssociateAgentKnowledgeBaseResponseTypeDef
- DeleteAgentAliasResponseTypeDef
- DeleteAgentResponseTypeDef
- DeleteAgentVersionResponseTypeDef
- DeleteDataSourceResponseTypeDef
- DeleteFlowAliasResponseTypeDef
- DeleteFlowResponseTypeDef
- DeleteFlowVersionResponseTypeDef
- DeleteKnowledgeBaseResponseTypeDef
- DeletePromptResponseTypeDef
- GetAgentKnowledgeBaseResponseTypeDef
- ListAgentActionGroupsResponseTypeDef
- ListAgentKnowledgeBasesResponseTypeDef
- ListTagsForResourceResponseTypeDef
- PrepareAgentResponseTypeDef
- PrepareFlowResponseTypeDef
- UpdateAgentKnowledgeBaseResponseTypeDef
- EmbeddingModelConfigurationTypeDef
- BedrockFoundationModelConfigurationTypeDef
- TextPromptTemplateConfigurationOutputTypeDef
- TextPromptTemplateConfigurationTypeDef
- ConditionFlowNodeConfigurationOutputTypeDef
- ConditionFlowNodeConfigurationTypeDef
- MessageOutputTypeDef
- MessageTypeDef
- CreateFlowAliasRequestRequestTypeDef
- CreateFlowAliasResponseTypeDef
- FlowAliasSummaryTypeDef
- GetFlowAliasResponseTypeDef
- UpdateFlowAliasRequestRequestTypeDef
- UpdateFlowAliasResponseTypeDef
- ListDataSourcesResponseTypeDef
- FlowConnectionConfigurationTypeDef
- ListFlowsResponseTypeDef
- FlowValidationDetailsTypeDef
- ListFlowVersionsResponseTypeDef
- FunctionOutputTypeDef
- FunctionTypeDef
- HierarchicalChunkingConfigurationOutputTypeDef
- HierarchicalChunkingConfigurationTypeDef
- PromptConfigurationOutputTypeDef
- InferenceConfigurationUnionTypeDef
- ListIngestionJobsRequestRequestTypeDef
- IngestionJobSummaryTypeDef
- IngestionJobTypeDef
- IntermediateStorageTypeDef
- ListKnowledgeBasesResponseTypeDef
- ListAgentActionGroupsRequestListAgentActionGroupsPaginateTypeDef
- ListAgentAliasesRequestListAgentAliasesPaginateTypeDef
- ListAgentKnowledgeBasesRequestListAgentKnowledgeBasesPaginateTypeDef
- ListAgentVersionsRequestListAgentVersionsPaginateTypeDef
- ListAgentsRequestListAgentsPaginateTypeDef
- ListDataSourcesRequestListDataSourcesPaginateTypeDef
- ListFlowAliasesRequestListFlowAliasesPaginateTypeDef
- ListFlowVersionsRequestListFlowVersionsPaginateTypeDef
- ListFlowsRequestListFlowsPaginateTypeDef
- ListIngestionJobsRequestListIngestionJobsPaginateTypeDef
- ListKnowledgeBasesRequestListKnowledgeBasesPaginateTypeDef
- ListPromptsRequestListPromptsPaginateTypeDef
- ListPromptsResponseTypeDef
- MongoDbAtlasConfigurationTypeDef
- OpenSearchServerlessConfigurationTypeDef
- PatternObjectFilterConfigurationOutputTypeDef
- PatternObjectFilterUnionTypeDef
- PineconeConfigurationTypeDef
- PromptGenAiResourceTypeDef
- PromptInferenceConfigurationOutputTypeDef
- PromptModelInferenceConfigurationUnionTypeDef
- RdsConfigurationTypeDef
- RedisEnterpriseCloudConfigurationTypeDef
- RetrievalFlowNodeServiceConfigurationTypeDef
- S3DataSourceConfigurationUnionTypeDef
- UrlConfigurationOutputTypeDef
- UrlConfigurationTypeDef
- SharePointSourceConfigurationUnionTypeDef
- ToolChoiceOutputTypeDef
- ToolChoiceTypeDef
- StorageFlowNodeServiceConfigurationTypeDef
- ToolSpecificationOutputTypeDef
- ToolInputSchemaUnionTypeDef
- TransformationFunctionTypeDef
- WebCrawlerConfigurationOutputTypeDef
- WebCrawlerConfigurationTypeDef
- AgentAliasTypeDef
- ListAgentAliasesResponseTypeDef
- ListAgentsResponseTypeDef
- ListAgentVersionsResponseTypeDef
- VectorKnowledgeBaseConfigurationTypeDef
- ParsingConfigurationTypeDef
- TextPromptTemplateConfigurationUnionTypeDef
- ConditionFlowNodeConfigurationUnionTypeDef
- MessageUnionTypeDef
- ListFlowAliasesResponseTypeDef
- FlowConnectionTypeDef
- FlowValidationTypeDef
- FunctionSchemaOutputTypeDef
- FunctionUnionTypeDef
- ChunkingConfigurationOutputTypeDef
- HierarchicalChunkingConfigurationUnionTypeDef
- PromptOverrideConfigurationOutputTypeDef
- PromptConfigurationTypeDef
- ListIngestionJobsResponseTypeDef
- GetIngestionJobResponseTypeDef
- StartIngestionJobResponseTypeDef
- StopIngestionJobResponseTypeDef
- CrawlFilterConfigurationOutputTypeDef
- PatternObjectFilterConfigurationTypeDef
- PromptInferenceConfigurationTypeDef
- StorageConfigurationTypeDef
- RetrievalFlowNodeConfigurationTypeDef
- WebSourceConfigurationOutputTypeDef
- UrlConfigurationUnionTypeDef
- ToolChoiceUnionTypeDef
- StorageFlowNodeConfigurationTypeDef
- ToolOutputTypeDef
- ToolSpecificationTypeDef
- TransformationTypeDef
- WebCrawlerConfigurationUnionTypeDef
- CreateAgentAliasResponseTypeDef
- GetAgentAliasResponseTypeDef
- UpdateAgentAliasResponseTypeDef
- KnowledgeBaseConfigurationTypeDef
- ValidateFlowDefinitionResponseTypeDef
- AgentActionGroupTypeDef
- FunctionSchemaTypeDef
- ChunkingConfigurationTypeDef
- AgentTypeDef
- AgentVersionTypeDef
- PromptConfigurationUnionTypeDef
- ConfluenceCrawlerConfigurationOutputTypeDef
- SalesforceCrawlerConfigurationOutputTypeDef
- SharePointCrawlerConfigurationOutputTypeDef
- PatternObjectFilterConfigurationUnionTypeDef
- PromptInferenceConfigurationUnionTypeDef
- WebDataSourceConfigurationOutputTypeDef
- WebSourceConfigurationTypeDef
- ToolConfigurationOutputTypeDef
- ToolSpecificationUnionTypeDef
- CustomTransformationConfigurationOutputTypeDef
- CustomTransformationConfigurationTypeDef
- CreateKnowledgeBaseRequestRequestTypeDef
- KnowledgeBaseTypeDef
- UpdateKnowledgeBaseRequestRequestTypeDef
- CreateAgentActionGroupResponseTypeDef
- GetAgentActionGroupResponseTypeDef
- UpdateAgentActionGroupResponseTypeDef
- CreateAgentActionGroupRequestRequestTypeDef
- UpdateAgentActionGroupRequestRequestTypeDef
- ChunkingConfigurationUnionTypeDef
- CreateAgentResponseTypeDef
- GetAgentResponseTypeDef
- UpdateAgentResponseTypeDef
- GetAgentVersionResponseTypeDef
- PromptOverrideConfigurationTypeDef
- ConfluenceDataSourceConfigurationOutputTypeDef
- SalesforceDataSourceConfigurationOutputTypeDef
- SharePointDataSourceConfigurationOutputTypeDef
- CrawlFilterConfigurationTypeDef
- WebSourceConfigurationUnionTypeDef
- ChatPromptTemplateConfigurationOutputTypeDef
- ToolTypeDef
- VectorIngestionConfigurationOutputTypeDef
- CustomTransformationConfigurationUnionTypeDef
- CreateKnowledgeBaseResponseTypeDef
- GetKnowledgeBaseResponseTypeDef
- UpdateKnowledgeBaseResponseTypeDef
- CreateAgentRequestRequestTypeDef
- UpdateAgentRequestRequestTypeDef
- DataSourceConfigurationOutputTypeDef
- CrawlFilterConfigurationUnionTypeDef
- WebDataSourceConfigurationTypeDef
- PromptTemplateConfigurationOutputTypeDef
- ToolUnionTypeDef
- VectorIngestionConfigurationTypeDef
- DataSourceTypeDef
- ConfluenceCrawlerConfigurationTypeDef
- SalesforceCrawlerConfigurationTypeDef
- SharePointCrawlerConfigurationTypeDef
- WebDataSourceConfigurationUnionTypeDef
- PromptFlowNodeInlineConfigurationOutputTypeDef
- PromptVariantOutputTypeDef
- ToolConfigurationTypeDef
- CreateDataSourceResponseTypeDef
- GetDataSourceResponseTypeDef
- UpdateDataSourceResponseTypeDef
- ConfluenceCrawlerConfigurationUnionTypeDef
- SalesforceCrawlerConfigurationUnionTypeDef
- SharePointCrawlerConfigurationUnionTypeDef
- PromptFlowNodeSourceConfigurationOutputTypeDef
- CreatePromptResponseTypeDef
- CreatePromptVersionResponseTypeDef
- GetPromptResponseTypeDef
- UpdatePromptResponseTypeDef
- ToolConfigurationUnionTypeDef
- ConfluenceDataSourceConfigurationTypeDef
- SalesforceDataSourceConfigurationTypeDef
- SharePointDataSourceConfigurationTypeDef
- PromptFlowNodeConfigurationOutputTypeDef
- ChatPromptTemplateConfigurationTypeDef
- ConfluenceDataSourceConfigurationUnionTypeDef
- SalesforceDataSourceConfigurationUnionTypeDef
- SharePointDataSourceConfigurationUnionTypeDef
- FlowNodeConfigurationOutputTypeDef
- ChatPromptTemplateConfigurationUnionTypeDef
- DataSourceConfigurationTypeDef
- FlowNodeExtraOutputTypeDef
- PromptTemplateConfigurationTypeDef
- CreateDataSourceRequestRequestTypeDef
- UpdateDataSourceRequestRequestTypeDef
- FlowDefinitionOutputTypeDef
- PromptTemplateConfigurationUnionTypeDef
- CreateFlowResponseTypeDef
- CreateFlowVersionResponseTypeDef
- GetFlowResponseTypeDef
- GetFlowVersionResponseTypeDef
- UpdateFlowResponseTypeDef
- PromptFlowNodeInlineConfigurationTypeDef
- PromptVariantTypeDef
- PromptFlowNodeInlineConfigurationUnionTypeDef
- PromptVariantUnionTypeDef
- UpdatePromptRequestRequestTypeDef
- PromptFlowNodeSourceConfigurationTypeDef
- CreatePromptRequestRequestTypeDef
- PromptFlowNodeSourceConfigurationUnionTypeDef
- PromptFlowNodeConfigurationTypeDef
- PromptFlowNodeConfigurationUnionTypeDef
- FlowNodeConfigurationTypeDef
- FlowNodeConfigurationUnionTypeDef
- FlowNodeTypeDef
- FlowNodeUnionTypeDef
- FlowDefinitionTypeDef
- CreateFlowRequestRequestTypeDef
- UpdateFlowRequestRequestTypeDef
- ValidateFlowDefinitionRequestRequestTypeDef