AgentsforBedrockRuntime module#
Index > AgentsforBedrockRuntime
Auto-generated documentation for AgentsforBedrockRuntime type annotations stubs module types-boto3-bedrock-agent-runtime.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy_boto3_builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.35.86' mypy_boto3_builder
- Select
boto3
AWS SDK. - Add
AgentsforBedrockRuntime
service. - 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 AgentsforBedrockRuntime
.
From PyPI with pip#
Install types-boto3
for AgentsforBedrockRuntime
service.
# install with boto3 type annotations
python -m pip install 'types-boto3[bedrock-agent-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-boto3-lite[bedrock-agent-runtime]'
# standalone installation
python -m pip install types-boto3-bedrock-agent-runtime
How to uninstall#
python -m pip uninstall -y types-boto3-bedrock-agent-runtime
Usage#
Code samples can be found in Examples.
AgentsforBedrockRuntimeClient#
Type annotations and code completion for boto3.client("bedrock-agent-runtime")
as AgentsforBedrockRuntimeClient
boto3 documentation
# AgentsforBedrockRuntimeClient usage example
from boto3.session import Session
from types_boto3_bedrock_agent_runtime.client import AgentsforBedrockRuntimeClient
def get_client() -> AgentsforBedrockRuntimeClient:
return Session().client("bedrock-agent-runtime")
Paginators#
Type annotations and code completion for paginators
from boto3.client("bedrock-agent-runtime").get_paginator("...")
.
# GetAgentMemoryPaginator usage example
from boto3.session import Session
from types_boto3_bedrock_agent_runtime.paginator import GetAgentMemoryPaginator
def get_get_agent_memory_paginator() -> GetAgentMemoryPaginator:
return Session().client("bedrock-agent-runtime").get_paginator("get_agent_memory"))
Literals#
Type annotations for literals used in methods and schema.
# ActionGroupSignatureType usage example
from types_boto3_bedrock_agent_runtime.literals import ActionGroupSignatureType
def get_value() -> ActionGroupSignatureType:
return "AMAZON.CodeInterpreter"
- ActionGroupSignatureType
- ActionInvocationTypeType
- AttributeTypeType
- ConfirmationStateType
- ConversationRoleType
- CreationModeType
- CustomControlMethodType
- ExecutionTypeType
- ExternalSourceTypeType
- FileSourceTypeType
- FileUseCaseType
- FlowCompletionReasonType
- GeneratedQueryTypeType
- GetAgentMemoryPaginatorName
- GuadrailActionType
- GuardrailActionType
- GuardrailContentFilterConfidenceType
- GuardrailContentFilterTypeType
- GuardrailContentPolicyActionType
- GuardrailManagedWordTypeType
- GuardrailPiiEntityTypeType
- GuardrailSensitiveInformationPolicyActionType
- GuardrailTopicPolicyActionType
- GuardrailTopicTypeType
- GuardrailWordPolicyActionType
- InputQueryTypeType
- InvocationTypeType
- MemoryTypeType
- NodeTypeType
- ParameterTypeType
- PayloadTypeType
- PerformanceConfigLatencyType
- PromptStateType
- PromptTypeType
- QueryTransformationModeType
- QueryTransformationTypeType
- RequireConfirmationType
- RerankDocumentTypeType
- RerankPaginatorName
- RerankQueryContentTypeType
- RerankSourceTypeType
- RerankingConfigurationTypeType
- RerankingMetadataSelectionModeType
- ResponseStateType
- RetrievalResultContentColumnTypeType
- RetrievalResultContentTypeType
- RetrievalResultLocationTypeType
- RetrieveAndGenerateTypeType
- RetrievePaginatorName
- SearchTypeType
- SourceType
- TextToSqlConfigurationTypeType
- TypeType
- VectorSearchRerankingConfigurationTypeType
- AgentsforBedrockRuntimeServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
Type definitions#
Type annotations for type definitions used in methods and schema.
- S3IdentifierTypeDef
- AccessDeniedExceptionTypeDef
- ActionGroupExecutorTypeDef
- ParameterTypeDef
- ActionGroupInvocationOutputTypeDef
- AnalyzePromptEventTypeDef
- ApiParameterTypeDef
- ContentBodyTypeDef
- BadGatewayExceptionTypeDef
- PerformanceConfigurationTypeDef
- BedrockRerankingModelConfigurationTypeDef
- BlobTypeDef
- CallerTypeDef
- CodeInterpreterInvocationInputTypeDef
- CodeInterpreterInvocationOutputTypeDef
- ConflictExceptionTypeDef
- ContentBlockTypeDef
- CustomOrchestrationTraceEventTypeDef
- DeleteAgentMemoryRequestRequestTypeDef
- DependencyFailedExceptionTypeDef
- S3ObjectDocTypeDef
- GuardrailConfigurationTypeDef
- PromptTemplateTypeDef
- FailureTraceTypeDef
- FieldForRerankingTypeDef
- OutputFileTypeDef
- S3ObjectFileTypeDef
- FilterAttributeTypeDef
- FinalResponseTypeDef
- FlowCompletionEventTypeDef
- FlowInputContentTypeDef
- FlowOutputContentTypeDef
- InternalServerExceptionTypeDef
- ResourceNotFoundExceptionTypeDef
- ServiceQuotaExceededExceptionTypeDef
- ThrottlingExceptionTypeDef
- ValidationExceptionTypeDef
- FlowTraceConditionTypeDef
- FlowTraceNodeInputContentTypeDef
- FlowTraceNodeOutputContentTypeDef
- ParameterDetailTypeDef
- FunctionParameterTypeDef
- QueryGenerationInputTypeDef
- GeneratedQueryTypeDef
- ResponseMetadataTypeDef
- PaginatorConfigTypeDef
- GetAgentMemoryRequestRequestTypeDef
- GuardrailConfigurationWithArnTypeDef
- GuardrailContentFilterTypeDef
- GuardrailCustomWordTypeDef
- GuardrailEventTypeDef
- GuardrailManagedWordTypeDef
- GuardrailPiiEntityFilterTypeDef
- GuardrailRegexFilterTypeDef
- GuardrailTopicTypeDef
- MetadataAttributeSchemaTypeDef
- TextInferenceConfigTypeDef
- InferenceConfigurationOutputTypeDef
- InferenceConfigurationTypeDef
- TextPromptTypeDef
- KnowledgeBaseLookupInputTypeDef
- StreamingConfigurationsTypeDef
- KnowledgeBaseQueryTypeDef
- MemorySessionSummaryTypeDef
- UsageTypeDef
- ModelNotReadyExceptionTypeDef
- RepromptResponseTypeDef
- QueryTransformationConfigurationTypeDef
- RawResponseTypeDef
- RationaleTypeDef
- PostProcessingParsedResponseTypeDef
- PreProcessingParsedResponseTypeDef
- RerankTextDocumentTypeDef
- RetrievalResultConfluenceLocationTypeDef
- RetrievalResultContentColumnTypeDef
- RetrievalResultCustomDocumentLocationTypeDef
- RetrievalResultKendraDocumentLocationTypeDef
- RetrievalResultS3LocationTypeDef
- RetrievalResultSalesforceLocationTypeDef
- RetrievalResultSharePointLocationTypeDef
- RetrievalResultSqlLocationTypeDef
- RetrievalResultWebLocationTypeDef
- RetrieveAndGenerateInputTypeDef
- RetrieveAndGenerateOutputEventTypeDef
- RetrieveAndGenerateOutputTypeDef
- RetrieveAndGenerateSessionConfigurationTypeDef
- SpanTypeDef
- TextToSqlKnowledgeBaseConfigurationTypeDef
- VectorSearchBedrockRerankingModelConfigurationTypeDef
- APISchemaTypeDef
- PropertyParametersTypeDef
- RequestBodyTypeDef
- ApiResultOutputTypeDef
- ApiResultTypeDef
- FunctionResultOutputTypeDef
- FunctionResultTypeDef
- BedrockModelConfigurationsTypeDef
- InlineBedrockModelConfigurationsTypeDef
- ModelPerformanceConfigurationTypeDef
- BedrockRerankingConfigurationTypeDef
- ByteContentDocTypeDef
- ByteContentFileTypeDef
- MessageTypeDef
- CustomOrchestrationTraceTypeDef
- RerankingMetadataSelectiveModeConfigurationTypeDef
- FilePartTypeDef
- InlineAgentFilePartTypeDef
- RetrievalFilterPaginatorTypeDef
- RetrievalFilterTypeDef
- FlowInputTypeDef
- FlowOutputEventTypeDef
- FlowTraceConditionNodeResultEventTypeDef
- FlowTraceNodeInputFieldTypeDef
- FlowTraceNodeOutputFieldTypeDef
- FunctionDefinitionTypeDef
- FunctionInvocationInputTypeDef
- GenerateQueryResponseTypeDef
- GetAgentMemoryRequestPaginateTypeDef
- GuardrailContentPolicyAssessmentTypeDef
- GuardrailWordPolicyAssessmentTypeDef
- GuardrailSensitiveInformationPolicyAssessmentTypeDef
- GuardrailTopicPolicyAssessmentTypeDef
- ImplicitFilterConfigurationTypeDef
- InferenceConfigTypeDef
- ModelInvocationInputTypeDef
- InferenceConfigurationUnionTypeDef
- InputPromptTypeDef
- OptimizedPromptTypeDef
- MemoryTypeDef
- MetadataTypeDef
- RerankDocumentOutputTypeDef
- RerankDocumentTypeDef
- RerankQueryTypeDef
- RetrievalResultContentTypeDef
- RetrievalResultLocationTypeDef
- TextResponsePartTypeDef
- TextToSqlConfigurationTypeDef
- ApiRequestBodyTypeDef
- ActionGroupInvocationInputTypeDef
- ApiResultUnionTypeDef
- InvocationResultMemberOutputTypeDef
- FunctionResultUnionTypeDef
- RerankingConfigurationTypeDef
- ExternalSourceTypeDef
- FileSourceTypeDef
- ConversationHistoryTypeDef
- MetadataConfigurationForRerankingTypeDef
- InvokeFlowRequestRequestTypeDef
- FlowTraceNodeInputEventTypeDef
- FlowTraceNodeOutputEventTypeDef
- FunctionSchemaTypeDef
- GuardrailAssessmentTypeDef
- ExternalSourcesGenerationConfigurationTypeDef
- GenerationConfigurationTypeDef
- OrchestrationConfigurationTypeDef
- PromptConfigurationTypeDef
- OptimizePromptRequestRequestTypeDef
- OptimizedPromptEventTypeDef
- GetAgentMemoryResponseTypeDef
- OrchestrationModelInvocationOutputTypeDef
- PostProcessingModelInvocationOutputTypeDef
- PreProcessingModelInvocationOutputTypeDef
- RoutingClassifierModelInvocationOutputTypeDef
- RerankResultTypeDef
- RerankSourceTypeDef
- KnowledgeBaseRetrievalResultTypeDef
- RetrievedReferenceTypeDef
- GeneratedResponsePartTypeDef
- TransformationConfigurationTypeDef
- ApiInvocationInputTypeDef
- ReturnControlResultsTypeDef
- InvocationResultMemberTypeDef
- InputFileTypeDef
- VectorSearchBedrockRerankingConfigurationTypeDef
- FlowTraceTypeDef
- AgentActionGroupTypeDef
- GuardrailTraceTypeDef
- ExternalSourcesRetrieveAndGenerateConfigurationTypeDef
- PromptOverrideConfigurationTypeDef
- OptimizedPromptStreamTypeDef
- PostProcessingTraceTypeDef
- PreProcessingTraceTypeDef
- RerankResponseTypeDef
- RerankRequestPaginateTypeDef
- RerankRequestRequestTypeDef
- RetrieveResponseTypeDef
- KnowledgeBaseLookupOutputTypeDef
- CitationTypeDef
- GenerateQueryRequestRequestTypeDef
- InvocationInputMemberTypeDef
- AgentCollaboratorInputPayloadTypeDef
- InvocationResultMemberUnionTypeDef
- VectorSearchRerankingConfigurationTypeDef
- FlowTraceEventTypeDef
- OptimizePromptResponseTypeDef
- AttributionTypeDef
- CitationEventTypeDef
- RetrieveAndGenerateResponseTypeDef
- InlineAgentReturnControlPayloadTypeDef
- ReturnControlPayloadTypeDef
- AgentCollaboratorInvocationInputTypeDef
- InlineSessionStateTypeDef
- KnowledgeBaseVectorSearchConfigurationPaginatorTypeDef
- KnowledgeBaseVectorSearchConfigurationTypeDef
- FlowResponseStreamTypeDef
- InlineAgentPayloadPartTypeDef
- PayloadPartTypeDef
- RetrieveAndGenerateStreamResponseOutputTypeDef
- AgentCollaboratorOutputPayloadTypeDef
- InvocationInputTypeDef
- KnowledgeBaseRetrievalConfigurationPaginatorTypeDef
- KnowledgeBaseRetrievalConfigurationTypeDef
- InvokeFlowResponseTypeDef
- RetrieveAndGenerateStreamResponseTypeDef
- AgentCollaboratorInvocationOutputTypeDef
- RetrieveRequestPaginateTypeDef
- KnowledgeBaseConfigurationTypeDef
- KnowledgeBaseRetrieveAndGenerateConfigurationTypeDef
- KnowledgeBaseTypeDef
- RetrieveRequestRequestTypeDef
- ObservationTypeDef
- SessionStateTypeDef
- RetrieveAndGenerateConfigurationTypeDef
- InvokeInlineAgentRequestRequestTypeDef
- OrchestrationTraceTypeDef
- RoutingClassifierTraceTypeDef
- InvokeAgentRequestRequestTypeDef
- RetrieveAndGenerateRequestRequestTypeDef
- RetrieveAndGenerateStreamRequestRequestTypeDef
- TraceTypeDef
- InlineAgentTracePartTypeDef
- TracePartTypeDef
- InlineAgentResponseStreamTypeDef
- ResponseStreamTypeDef
- InvokeInlineAgentResponseTypeDef
- InvokeAgentResponseTypeDef