AgentsforBedrockRuntime module#
Index > AgentsforBedrockRuntime
Auto-generated documentation for AgentsforBedrockRuntime type annotations stubs module mypy-boto3-bedrock-agent-runtime.
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 AgentsforBedrockRuntime
.
From PyPI with pip#
Install boto3-stubs
for AgentsforBedrockRuntime
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[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 'boto3-stubs-lite[bedrock-agent-runtime]'
# standalone installation
python -m pip install mypy-boto3-bedrock-agent-runtime
How to uninstall#
python -m pip uninstall -y mypy-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 mypy_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 mypy_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.
# ActionInvocationTypeType usage example
from mypy_boto3_bedrock_agent_runtime.literals import ActionInvocationTypeType
def get_value() -> ActionInvocationTypeType:
return "RESULT"
- ActionInvocationTypeType
- ConfirmationStateType
- CreationModeType
- ExecutionTypeType
- ExternalSourceTypeType
- FileSourceTypeType
- FileUseCaseType
- FlowCompletionReasonType
- GetAgentMemoryPaginatorName
- GuadrailActionType
- GuardrailActionType
- GuardrailContentFilterConfidenceType
- GuardrailContentFilterTypeType
- GuardrailContentPolicyActionType
- GuardrailManagedWordTypeType
- GuardrailPiiEntityTypeType
- GuardrailSensitiveInformationPolicyActionType
- GuardrailTopicPolicyActionType
- GuardrailTopicTypeType
- GuardrailWordPolicyActionType
- InvocationTypeType
- MemoryTypeType
- NodeTypeType
- PromptTypeType
- QueryTransformationTypeType
- ResponseStateType
- RetrievalResultLocationTypeType
- RetrieveAndGenerateTypeType
- RetrievePaginatorName
- SearchTypeType
- SourceType
- TypeType
- AgentsforBedrockRuntimeServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AccessDeniedExceptionTypeDef
- ParameterTypeDef
- ActionGroupInvocationOutputTypeDef
- AnalyzePromptEventTypeDef
- ApiParameterTypeDef
- ContentBodyTypeDef
- BadGatewayExceptionTypeDef
- BlobTypeDef
- CodeInterpreterInvocationInputTypeDef
- CodeInterpreterInvocationOutputTypeDef
- ConflictExceptionTypeDef
- DeleteAgentMemoryRequestRequestTypeDef
- DependencyFailedExceptionTypeDef
- S3ObjectDocTypeDef
- GuardrailConfigurationTypeDef
- PromptTemplateTypeDef
- FailureTraceTypeDef
- OutputFileTypeDef
- S3ObjectFileTypeDef
- FilterAttributeTypeDef
- FinalResponseTypeDef
- FlowCompletionEventTypeDef
- FlowInputContentTypeDef
- FlowOutputContentTypeDef
- InternalServerExceptionTypeDef
- ResourceNotFoundExceptionTypeDef
- ServiceQuotaExceededExceptionTypeDef
- ThrottlingExceptionTypeDef
- ValidationExceptionTypeDef
- FlowTraceConditionTypeDef
- FlowTraceNodeInputContentTypeDef
- FlowTraceNodeOutputContentTypeDef
- FunctionParameterTypeDef
- PaginatorConfigTypeDef
- GetAgentMemoryRequestRequestTypeDef
- ResponseMetadataTypeDef
- GuardrailContentFilterTypeDef
- GuardrailCustomWordTypeDef
- GuardrailManagedWordTypeDef
- GuardrailPiiEntityFilterTypeDef
- GuardrailRegexFilterTypeDef
- GuardrailTopicTypeDef
- TextInferenceConfigTypeDef
- InferenceConfigurationTypeDef
- TextPromptTypeDef
- KnowledgeBaseLookupInputTypeDef
- KnowledgeBaseQueryTypeDef
- RetrievalResultContentTypeDef
- MemorySessionSummaryTypeDef
- UsageTypeDef
- RepromptResponseTypeDef
- QueryTransformationConfigurationTypeDef
- RawResponseTypeDef
- RationaleTypeDef
- PostProcessingParsedResponseTypeDef
- PreProcessingParsedResponseTypeDef
- RetrievalResultConfluenceLocationTypeDef
- RetrievalResultS3LocationTypeDef
- RetrievalResultSalesforceLocationTypeDef
- RetrievalResultSharePointLocationTypeDef
- RetrievalResultWebLocationTypeDef
- RetrieveAndGenerateInputTypeDef
- RetrieveAndGenerateOutputTypeDef
- RetrieveAndGenerateSessionConfigurationTypeDef
- SpanTypeDef
- PropertyParametersTypeDef
- RequestBodyTypeDef
- ApiResultTypeDef
- FunctionResultTypeDef
- ByteContentDocTypeDef
- ByteContentFileTypeDef
- FilePartTypeDef
- RetrievalFilterPaginatorTypeDef
- RetrievalFilterTypeDef
- FlowInputTypeDef
- FlowOutputEventTypeDef
- FlowTraceConditionNodeResultEventTypeDef
- FlowTraceNodeInputFieldTypeDef
- FlowTraceNodeOutputFieldTypeDef
- FunctionInvocationInputTypeDef
- GetAgentMemoryRequestGetAgentMemoryPaginateTypeDef
- GuardrailContentPolicyAssessmentTypeDef
- GuardrailWordPolicyAssessmentTypeDef
- GuardrailSensitiveInformationPolicyAssessmentTypeDef
- GuardrailTopicPolicyAssessmentTypeDef
- InferenceConfigTypeDef
- ModelInvocationInputTypeDef
- InputPromptTypeDef
- OptimizedPromptTypeDef
- MemoryTypeDef
- MetadataTypeDef
- RetrievalResultLocationTypeDef
- TextResponsePartTypeDef
- ApiRequestBodyTypeDef
- ActionGroupInvocationInputTypeDef
- InvocationResultMemberTypeDef
- ExternalSourceTypeDef
- FileSourceTypeDef
- KnowledgeBaseVectorSearchConfigurationPaginatorTypeDef
- KnowledgeBaseVectorSearchConfigurationTypeDef
- InvokeFlowRequestRequestTypeDef
- FlowTraceNodeInputEventTypeDef
- FlowTraceNodeOutputEventTypeDef
- GuardrailAssessmentTypeDef
- ExternalSourcesGenerationConfigurationTypeDef
- GenerationConfigurationTypeDef
- OrchestrationConfigurationTypeDef
- OptimizePromptRequestRequestTypeDef
- OptimizedPromptEventTypeDef
- GetAgentMemoryResponseTypeDef
- OrchestrationModelInvocationOutputTypeDef
- PostProcessingModelInvocationOutputTypeDef
- PreProcessingModelInvocationOutputTypeDef
- KnowledgeBaseRetrievalResultTypeDef
- RetrievedReferenceTypeDef
- GeneratedResponsePartTypeDef
- ApiInvocationInputTypeDef
- InvocationInputTypeDef
- InputFileTypeDef
- KnowledgeBaseRetrievalConfigurationPaginatorTypeDef
- KnowledgeBaseRetrievalConfigurationTypeDef
- FlowTraceTypeDef
- GuardrailTraceTypeDef
- ExternalSourcesRetrieveAndGenerateConfigurationTypeDef
- OptimizedPromptStreamTypeDef
- PostProcessingTraceTypeDef
- PreProcessingTraceTypeDef
- RetrieveResponseTypeDef
- KnowledgeBaseLookupOutputTypeDef
- CitationTypeDef
- InvocationInputMemberTypeDef
- RetrieveRequestRetrievePaginateTypeDef
- KnowledgeBaseConfigurationTypeDef
- KnowledgeBaseRetrieveAndGenerateConfigurationTypeDef
- RetrieveRequestRequestTypeDef
- FlowTraceEventTypeDef
- OptimizePromptResponseTypeDef
- ObservationTypeDef
- AttributionTypeDef
- RetrieveAndGenerateResponseTypeDef
- ReturnControlPayloadTypeDef
- SessionStateTypeDef
- RetrieveAndGenerateConfigurationTypeDef
- FlowResponseStreamTypeDef
- OrchestrationTraceTypeDef
- PayloadPartTypeDef
- InvokeAgentRequestRequestTypeDef
- RetrieveAndGenerateRequestRequestTypeDef
- InvokeFlowResponseTypeDef
- TraceTypeDef
- TracePartTypeDef
- ResponseStreamTypeDef
- InvokeAgentResponseTypeDef