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("...")
.
# RetrievePaginator usage example
from boto3.session import Session
from mypy_boto3_bedrock_agent_runtime.paginator import RetrievePaginator
def get_retrieve_paginator() -> RetrievePaginator:
return Session().client("bedrock-agent-runtime").get_paginator("retrieve"))
Literals#
Type annotations for literals used in methods and schema.
# CreationModeType usage example
from mypy_boto3_bedrock_agent_runtime.literals import CreationModeType
def get_value() -> CreationModeType:
return "DEFAULT"
- CreationModeType
- ExternalSourceTypeType
- InvocationTypeType
- PromptTypeType
- 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
- ApiParameterTypeDef
- ContentBodyTypeDef
- BadGatewayExceptionTypeDef
- BlobTypeDef
- ConflictExceptionTypeDef
- DependencyFailedExceptionTypeDef
- S3ObjectDocTypeDef
- PromptTemplateTypeDef
- FailureTraceTypeDef
- FilterAttributeTypeDef
- FinalResponseTypeDef
- FunctionParameterTypeDef
- InferenceConfigurationTypeDef
- InternalServerExceptionTypeDef
- KnowledgeBaseLookupInputTypeDef
- ResponseMetadataTypeDef
- KnowledgeBaseQueryTypeDef
- KnowledgeBaseVectorSearchConfigurationTypeDef
- RetrievalResultContentTypeDef
- RepromptResponseTypeDef
- RationaleTypeDef
- PaginatorConfigTypeDef
- PostProcessingParsedResponseTypeDef
- PreProcessingParsedResponseTypeDef
- ResourceNotFoundExceptionTypeDef
- ServiceQuotaExceededExceptionTypeDef
- ThrottlingExceptionTypeDef
- ValidationExceptionTypeDef
- RetrievalResultS3LocationTypeDef
- RetrieveAndGenerateInputTypeDef
- RetrieveAndGenerateOutputTypeDef
- RetrieveAndGenerateSessionConfigurationTypeDef
- SpanTypeDef
- PropertyParametersTypeDef
- RequestBodyTypeDef
- ApiResultTypeDef
- FunctionResultTypeDef
- ByteContentDocTypeDef
- ExternalSourcesGenerationConfigurationTypeDef
- GenerationConfigurationTypeDef
- RetrievalFilterTypeDef
- FunctionInvocationInputTypeDef
- ModelInvocationInputTypeDef
- KnowledgeBaseRetrievalConfigurationTypeDef
- PostProcessingModelInvocationOutputTypeDef
- PreProcessingModelInvocationOutputTypeDef
- RetrievalResultLocationTypeDef
- TextResponsePartTypeDef
- ApiRequestBodyTypeDef
- ActionGroupInvocationInputTypeDef
- InvocationResultMemberTypeDef
- ExternalSourceTypeDef
- KnowledgeBaseRetrieveAndGenerateConfigurationTypeDef
- RetrieveRequestRequestTypeDef
- RetrieveRequestRetrievePaginateTypeDef
- PostProcessingTraceTypeDef
- PreProcessingTraceTypeDef
- KnowledgeBaseRetrievalResultTypeDef
- RetrievedReferenceTypeDef
- GeneratedResponsePartTypeDef
- ApiInvocationInputTypeDef
- InvocationInputTypeDef
- SessionStateTypeDef
- ExternalSourcesRetrieveAndGenerateConfigurationTypeDef
- RetrieveResponseTypeDef
- KnowledgeBaseLookupOutputTypeDef
- CitationTypeDef
- InvocationInputMemberTypeDef
- InvokeAgentRequestRequestTypeDef
- RetrieveAndGenerateConfigurationTypeDef
- ObservationTypeDef
- AttributionTypeDef
- RetrieveAndGenerateResponseTypeDef
- ReturnControlPayloadTypeDef
- RetrieveAndGenerateRequestRequestTypeDef
- OrchestrationTraceTypeDef
- PayloadPartTypeDef
- TraceTypeDef
- TracePartTypeDef
- ResponseStreamTypeDef
- InvokeAgentResponseTypeDef