Bedrock Agent Runtime¶
Installation¶
To install the Bedrock Agent Runtime client:
Clients¶
The package provides a synchronous client, BedrockAgentRuntimeClient, and an asynchronous client, AsyncBedrockAgentRuntimeClient. Both clients use the same models.
Operations that use event streams are available only on AsyncBedrockAgentRuntimeClient. They are marked Async only under Operations.
BedrockAgentRuntimeClient
¶
BedrockAgentRuntimeClient(config: BedrockAgentRuntimeConfig | None = None, plugins: list[Plugin] | None = None)
Bases: Client[BedrockAgentRuntimeConfig]
Note
Amazon Bedrock Agents (now Amazon Bedrock Agents Classic) is no longer open to new customers. For capabilities similar to Bedrock Agents Classic, explore Amazon Bedrock AgentCore. Existing customers can continue to use the service as normal. For more information, see Amazon Bedrock Agents Classic availability change.
Contains APIs related to model invocation and querying of knowledge bases.
AsyncBedrockAgentRuntimeClient
¶
AsyncBedrockAgentRuntimeClient(config: AsyncBedrockAgentRuntimeConfig | None = None, plugins: list[Plugin] | None = None)
Bases: AsyncClient[AsyncBedrockAgentRuntimeConfig]
Note
Amazon Bedrock Agents (now Amazon Bedrock Agents Classic) is no longer open to new customers. For capabilities similar to Bedrock Agents Classic, explore Amazon Bedrock AgentCore. Existing customers can continue to use the service as normal. For more information, see Amazon Bedrock Agents Classic availability change.
Contains APIs related to model invocation and querying of knowledge bases.
Operations¶
agentic_retrieve_streamAsync onlycheck_ingested_document_aclcreate_invocationcreate_sessiondelete_agent_memorydelete_sessionend_sessiongenerate_queryget_agent_memoryget_document_contentget_execution_flow_snapshotget_flow_executionget_ingested_document_aclget_invocation_stepget_sessioninvoke_agentAsync onlyinvoke_flowAsync onlyinvoke_inline_agentAsync onlylist_flow_execution_eventslist_flow_executionslist_invocation_stepslist_invocationslist_sessionslist_tags_for_resourceoptimize_promptAsync onlyput_invocation_steprerankretrieveretrieve_and_generateretrieve_and_generate_streamAsync onlystart_flow_executionstop_flow_executiontag_resourceuntag_resourceupdate_session
Configuration¶
BedrockAgentRuntimeConfig
dataclass
¶
Bases: AwsConfig
Bedrock Agent Runtime configuration.
Attributes¶
auth_scheme_resolver
class-attribute
instance-attribute
¶
An auth scheme resolver that determines the auth scheme for each operation.
auth_schemes
class-attribute
instance-attribute
¶
A map of auth scheme ids to auth schemes.
aws_access_key_id
class-attribute
instance-attribute
¶
aws_access_key_id: str | None = None
The identifier for a secret access key.
aws_credentials_identity_resolver
class-attribute
instance-attribute
¶
aws_credentials_identity_resolver: IdentityResolver[AWSCredentialsIdentity, AWSIdentityProperties] | None = None
Resolves AWS Credentials. Required for operations that use Sigv4 Auth.
aws_secret_access_key
class-attribute
instance-attribute
¶
aws_secret_access_key: str | None = None
A secret access key that can be used to sign requests.
aws_session_token
class-attribute
instance-attribute
¶
aws_session_token: str | None = None
The session token used with temporary AWS credentials.
endpoint_resolver
class-attribute
instance-attribute
¶
The endpoint resolver used to resolve the final endpoint per-operation based on the configuration.
interceptors
class-attribute
instance-attribute
¶
The list of interceptors, which are hooks that are called during the execution of a request.
protocol
class-attribute
instance-attribute
¶
Pass a protocol class reference from smithy_aws_core.protocols to select the protocol, e.g. protocol=AwsJson10ClientProtocol. For custom protocols a protocol instance may also be passed.
region
class-attribute
instance-attribute
¶
region: str | None = None
The AWS region to connect to. The configured region is used to determine the service endpoint.
sdk_ua_app_id
class-attribute
instance-attribute
¶
sdk_ua_app_id: str | None = None
A unique and opaque application ID that is appended to the User-Agent header.
use_dualstack_endpoint
class-attribute
instance-attribute
¶
use_dualstack_endpoint: bool | None = None
When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.
use_fips_endpoint
class-attribute
instance-attribute
¶
use_fips_endpoint: bool | None = None
When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.
user_agent_extra
class-attribute
instance-attribute
¶
user_agent_extra: str | None = None
Additional suffix to be added to the User-Agent header.
Methods:¶
resolve
classmethod
¶
resolve(*, profile: str | None = None, fs: FileSystem | None = None, config_file_path: str | None = None, credentials_file_path: str | None = None, **overrides: Unpack[_BedrockAgentRuntimeConfigOverrides]) -> Self
Resolve config from environment, config files, defaults, and explicit overrides.
Plugin
module-attribute
¶
Plugin: TypeAlias = Callable[[BedrockAgentRuntimeConfig], None]
A callable that customizes a client configuration. Service-level plugins are applied once to the base configuration inherited by every operation. Operation-level plugins apply only to a single operation invocation.
AsyncBedrockAgentRuntimeConfig
dataclass
¶
Bases: AsyncAwsConfig
Bedrock Agent Runtime configuration (async-resolved).
Attributes¶
auth_scheme_resolver
class-attribute
instance-attribute
¶
An auth scheme resolver that determines the auth scheme for each operation.
auth_schemes
class-attribute
instance-attribute
¶
A map of auth scheme ids to auth schemes.
aws_access_key_id
class-attribute
instance-attribute
¶
aws_access_key_id: str | None = None
The identifier for a secret access key.
aws_credentials_identity_resolver
class-attribute
instance-attribute
¶
aws_credentials_identity_resolver: AsyncIdentityResolver[AWSCredentialsIdentity, AWSIdentityProperties] | None = None
Resolves AWS Credentials. Required for operations that use Sigv4 Auth.
aws_secret_access_key
class-attribute
instance-attribute
¶
aws_secret_access_key: str | None = None
A secret access key that can be used to sign requests.
aws_session_token
class-attribute
instance-attribute
¶
aws_session_token: str | None = None
The session token used with temporary AWS credentials.
endpoint_resolver
class-attribute
instance-attribute
¶
The endpoint resolver used to resolve the final endpoint per-operation based on the configuration.
interceptors
class-attribute
instance-attribute
¶
The list of interceptors, which are hooks that are called during the execution of a request.
protocol
class-attribute
instance-attribute
¶
Pass a protocol class reference from smithy_aws_core.aio.protocols to select the protocol, e.g. protocol=AsyncAwsJson10ClientProtocol. For custom protocols a protocol instance may also be passed.
region
class-attribute
instance-attribute
¶
region: str | None = None
The AWS region to connect to. The configured region is used to determine the service endpoint.
sdk_ua_app_id
class-attribute
instance-attribute
¶
sdk_ua_app_id: str | None = None
A unique and opaque application ID that is appended to the User-Agent header.
use_dualstack_endpoint
class-attribute
instance-attribute
¶
use_dualstack_endpoint: bool | None = None
When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.
use_fips_endpoint
class-attribute
instance-attribute
¶
use_fips_endpoint: bool | None = None
When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.
user_agent_extra
class-attribute
instance-attribute
¶
user_agent_extra: str | None = None
Additional suffix to be added to the User-Agent header.
Methods:¶
resolve
async
classmethod
¶
resolve(*, profile: str | None = None, fs: AsyncFileSystem | None = None, config_file_path: str | None = None, credentials_file_path: str | None = None, **overrides: Unpack[_AsyncBedrockAgentRuntimeConfigOverrides]) -> Self
Resolve config from environment, config files, defaults, and explicit overrides.
Plugin
module-attribute
¶
Plugin: TypeAlias = Callable[[AsyncBedrockAgentRuntimeConfig], None]
A callable that customizes a client configuration. Service-level plugins are applied once to the base configuration inherited by every operation. Operation-level plugins apply only to a single operation invocation.
Structures¶
ActionGroupInvocationInputActionGroupInvocationOutputAgentActionGroupAgentCollaboratorInputPayloadAgentCollaboratorInvocationInputAgentCollaboratorInvocationOutputAgentCollaboratorOutputPayloadAgenticRetrieveActionAgenticRetrieveActionDetailsAgenticRetrieveAppliedInstructionAgenticRetrieveBedrockGuardrailConfigurationAgenticRetrieveBedrockRerankingConfigurationAgenticRetrieveBedrockRerankingModelConfigurationAgenticRetrieveCitationAgenticRetrieveCitationReferenceAgenticRetrieveCodeExecutionDetailsAgenticRetrieveCodeExecutionDocumentAgenticRetrieveConfigurationAgenticRetrieveFailureAgenticRetrieveFullDocExpansionDetailsAgenticRetrieveGeneratedResponseAgenticRetrieveGuardrailWarningAgenticRetrieveInstructionConfigurationAgenticRetrieveMemoryConfigurationAgenticRetrieveMemoryMetadataFilterAgenticRetrieveMemoryRetrievalConfigAgenticRetrieveMemoryRetrieveDetailsAgenticRetrieveMemorySessionBindingAgenticRetrieveMessageAgenticRetrieveMessageContentAgenticRetrievePolicyConfigurationAgenticRetrieveRerankingConfigurationAgenticRetrieveResponseEventAgenticRetrieveResultEventAgenticRetrieveResultItemAgenticRetrieveSourceMetadataAgenticRetrieveSourceRetrieverAgenticRetrieveTraceEventAgenticRetrieveTraceEventAttributesAgenticRetrieveTraceResultItemAgenticRetrieveWarningMessageAgenticRetrieverAnalyzePromptEventApiInvocationInputApiParameterApiRequestBodyApiResultAttributionAudioSegmentBedrockFoundationModelConfigurationBedrockFoundationModelModelConfigurationBedrockModelConfigurationsBedrockRerankingConfigurationBedrockRerankingModelConfigurationByteContentDocByteContentFileCitationCitationEventCodeInterpreterInvocationInputCodeInterpreterInvocationOutputCollaboratorCollaboratorConfigurationConditionResultEventContentBodyConversationHistoryCustomOrchestrationCustomOrchestrationTraceCustomOrchestrationTraceEventDocumentAclDocumentAclConditionDocumentAclGroupDocumentAclMembershipDocumentAclUserExternalSourceExternalSourcesGenerationConfigurationExternalSourcesRetrieveAndGenerateConfigurationFailureTraceFieldForRerankingFilePartFileSourceFilterAttributeFinalResponseFlowCompletionEventFlowExecutionErrorFlowExecutionInputEventFlowExecutionOutputEventFlowExecutionSummaryFlowFailureEventFlowInputFlowInputFieldFlowMultiTurnInputRequestEventFlowOutputEventFlowOutputFieldFlowTraceConditionFlowTraceConditionNodeResultEventFlowTraceDependencyEventFlowTraceEventFlowTraceNodeActionEventFlowTraceNodeInputEventFlowTraceNodeInputExecutionChainItemFlowTraceNodeInputFieldFlowTraceNodeInputSourceFlowTraceNodeOutputEventFlowTraceNodeOutputFieldFlowTraceNodeOutputNextFoundationModelConfigurationFunctionDefinitionFunctionInvocationInputFunctionParameterFunctionResultGeneratedQueryGeneratedResponsePartGenerationConfigurationGuardrailAssessmentGuardrailConfigurationGuardrailConfigurationWithArnGuardrailContentFilterGuardrailContentPolicyAssessmentGuardrailCustomWordGuardrailEventGuardrailManagedWordGuardrailPiiEntityFilterGuardrailRegexFilterGuardrailSensitiveInformationPolicyAssessmentGuardrailTopicGuardrailTopicPolicyAssessmentGuardrailTraceGuardrailWordPolicyAssessmentImageBlockImageInputImplicitFilterConfigurationInferenceConfigInferenceConfigurationInlineAgentFilePartInlineAgentPayloadPartInlineAgentReturnControlPayloadInlineAgentTracePartInlineBedrockModelConfigurationsInlineSessionStateInputFileInputImageInvocationInputInvocationStepInvocationStepSummaryInvocationSummaryKnowledgeBaseKnowledgeBaseConfigurationKnowledgeBaseLookupInputKnowledgeBaseLookupOutputKnowledgeBaseQueryKnowledgeBaseRetrievalConfigurationKnowledgeBaseRetrievalResultKnowledgeBaseRetrieveAndGenerateConfigurationKnowledgeBaseRetrieverConfigurationKnowledgeBaseVectorSearchConfigurationManagedSearchBedrockRerankingConfigurationManagedSearchBedrockRerankingModelConfigurationManagedSearchConfigurationManagedSearchRerankingConfigurationMantleFoundationModelConfigurationMantleFoundationModelModelConfigurationMemorySessionSummaryMessageMetadataMetadataAttributeSchemaMetadataConfigurationForRerankingModelInvocationInputModelPerformanceConfigurationNodeActionEventNodeDependencyEventNodeFailureEventNodeInputEventNodeInputExecutionChainItemNodeInputFieldNodeInputSourceNodeOutputEventNodeOutputFieldNodeOutputNextObservationOptimizedPromptEventOrchestrationConfigurationOrchestrationModelInvocationOutputOutputFileParameterParameterDetailPayloadPartPerformanceConfigurationPostProcessingModelInvocationOutputPostProcessingParsedResponsePreProcessingModelInvocationOutputPreProcessingParsedResponsePromptConfigurationPromptCreationConfigurationsPromptOverrideConfigurationPromptTemplatePropertyParametersQueryGenerationInputQueryTransformationConfigurationRationaleRawResponseReasoningTextBlockRepromptResponseRequestBodyRerankDocumentRerankQueryRerankResultRerankSourceRerankTextDocumentRerankingConfigurationRetrievalContentRetrievalOverridesRetrievalResultConfluenceLocationRetrievalResultContentRetrievalResultContentColumnRetrievalResultCustomDocumentLocationRetrievalResultGoogleDriveLocationRetrievalResultKendraDocumentLocationRetrievalResultLocationRetrievalResultOneDriveLocationRetrievalResultS3LocationRetrievalResultSalesforceLocationRetrievalResultSharePointLocationRetrievalResultSqlLocationRetrievalResultWebLocationRetrieveAndGenerateConfigurationRetrieveAndGenerateInputRetrieveAndGenerateOutputRetrieveAndGenerateOutputEventRetrieveAndGenerateSessionConfigurationRetrievedReferenceReturnControlPayloadReturnControlResultsRoutingClassifierModelInvocationOutputS3IdentifierS3LocationS3ObjectDocS3ObjectFileSatisfiedConditionSessionStateSessionSummarySpanStreamingConfigurationsTextInferenceConfigTextPromptTextResponsePartTextToSqlConfigurationTextToSqlKnowledgeBaseConfigurationTracePartTransformationConfigurationUsageUserContextVectorSearchBedrockRerankingConfigurationVectorSearchBedrockRerankingModelConfigurationVectorSearchRerankingConfigurationVideoSegment
Dictionaries¶
AgentActionGroupDictAgenticRetrieveBedrockGuardrailConfigurationDictAgenticRetrieveBedrockRerankingConfigurationDictAgenticRetrieveBedrockRerankingModelConfigurationDictAgenticRetrieveConfigurationDictAgenticRetrieveInstructionConfigurationDictAgenticRetrieveMemoryConfigurationDictAgenticRetrieveMemoryMetadataFilterDictAgenticRetrieveMemoryRetrievalConfigDictAgenticRetrieveMemorySessionBindingDictAgenticRetrieveMessageContentDictAgenticRetrieveMessageDictAgenticRetrievePolicyConfigurationDictAgenticRetrieveRerankingConfigurationDictAgenticRetrieverDictApiResultDictBedrockFoundationModelConfigurationDictBedrockFoundationModelModelConfigurationDictBedrockModelConfigurationsDictBedrockRerankingConfigurationDictBedrockRerankingModelConfigurationDictByteContentDocDictByteContentFileDictCollaboratorConfigurationDictCollaboratorDictContentBodyDictConversationHistoryDictCustomOrchestrationDictExternalSourceDictExternalSourcesGenerationConfigurationDictExternalSourcesRetrieveAndGenerateConfigurationDictFieldForRerankingDictFileSourceDictFilterAttributeDictFlowInputDictFoundationModelConfigurationDictFunctionDefinitionDictFunctionResultDictGenerationConfigurationDictGuardrailConfigurationDictGuardrailConfigurationWithArnDictImageBlockDictImageInputDictImplicitFilterConfigurationDictInferenceConfigDictInferenceConfigurationDictInlineBedrockModelConfigurationsDictInlineSessionStateDictInputFileDictInputImageDictKnowledgeBaseConfigurationDictKnowledgeBaseDictKnowledgeBaseQueryDictKnowledgeBaseRetrievalConfigurationDictKnowledgeBaseRetrieveAndGenerateConfigurationDictKnowledgeBaseRetrieverConfigurationDictKnowledgeBaseVectorSearchConfigurationDictManagedSearchBedrockRerankingConfigurationDictManagedSearchBedrockRerankingModelConfigurationDictManagedSearchConfigurationDictManagedSearchRerankingConfigurationDictMantleFoundationModelConfigurationDictMantleFoundationModelModelConfigurationDictMessageDictMetadataAttributeSchemaDictMetadataConfigurationForRerankingDictModelPerformanceConfigurationDictOrchestrationConfigurationDictParameterDetailDictPerformanceConfigurationDictPromptConfigurationDictPromptCreationConfigurationsDictPromptOverrideConfigurationDictPromptTemplateDictQueryGenerationInputDictQueryTransformationConfigurationDictRerankDocumentDictRerankQueryDictRerankSourceDictRerankTextDocumentDictRerankingConfigurationDictRetrievalOverridesDictRetrieveAndGenerateConfigurationDictRetrieveAndGenerateInputDictRetrieveAndGenerateSessionConfigurationDictS3IdentifierDictS3LocationDictS3ObjectDocDictS3ObjectFileDictSessionStateDictStreamingConfigurationsDictTextInferenceConfigDictTextPromptDictTextToSqlConfigurationDictTextToSqlKnowledgeBaseConfigurationDictTransformationConfigurationDictUserContextDictVectorSearchBedrockRerankingConfigurationDictVectorSearchBedrockRerankingModelConfigurationDictVectorSearchRerankingConfigurationDict
Errors¶
AccessDeniedExceptionBadGatewayExceptionConflictExceptionDependencyFailedExceptionInternalServerExceptionModelNotReadyExceptionResourceNotFoundExceptionServiceErrorServiceQuotaExceededExceptionThrottlingExceptionValidationException
Unions¶
APISchemaAPISchemaDictActionGroupExecutorActionGroupExecutorDictAgenticRetrieveMemoryMetadataFilterLeftAgenticRetrieveMemoryMetadataFilterLeftDictAgenticRetrieveMemoryMetadataFilterRightAgenticRetrieveMemoryMetadataFilterRightDictAgenticRetrieveMemoryMetadataValueAgenticRetrieveMemoryMetadataValueDictAgenticRetrieveStreamResponseOutputAgenticRetrieveWarningBedrockSessionContentBlockBedrockSessionContentBlockDictCallerContentBlockContentBlockDictFlowExecutionContentFlowExecutionEventFlowInputContentFlowInputContentDictFlowMultiTurnInputContentFlowOutputContentFlowResponseStreamFlowTraceFlowTraceNodeInputContentFlowTraceNodeOutputContentFunctionSchemaFunctionSchemaDictImageInputSourceImageInputSourceDictImageSourceImageSourceDictInlineAgentResponseStreamInputPromptInputPromptDictInvocationInputMemberInvocationResultMemberInvocationResultMemberDictInvocationStepPayloadInvocationStepPayloadDictMemoryNodeExecutionContentNodeTraceElementsOptimizedPromptOptimizedPromptStreamOrchestrationExecutorOrchestrationExecutorDictOrchestrationTracePostProcessingTracePreProcessingTraceReasoningContentBlockRerankingMetadataSelectiveModeConfigurationRerankingMetadataSelectiveModeConfigurationDictResponseStreamRetrievalFilterRetrievalFilterDictRetrieveAndGenerateStreamResponseOutputRetrieverConfigurationRetrieverConfigurationDictRoutingClassifierTraceTraceTraceElements
Enums¶
ActionGroupSignatureActionInvocationTypeAgentCollaborationAgenticRetrieveMemoryMetadataFilterOperatorAgenticRetrieveMemoryPersistenceModeAgenticRetrieveRerankingConfigurationTypeAgenticRetrieveRerankingModelTypeAgenticRetrieveStatusAgenticRetrieveStepAgenticRetrieveTypeAttributeTypeConfirmationStateConversationRoleCreationModeCustomControlMethodDocumentAclMemberRelationDocumentAclMembershipTypeDocumentOutputFormatExecutionTypeExternalSourceTypeFileSourceTypeFileUseCaseFlowCompletionReasonFlowControlNodeTypeFlowErrorCodeFlowExecutionErrorTypeFlowExecutionEventTypeFlowExecutionStatusFlowNodeIODataTypeFlowNodeInputCategoryFoundationModelConfigurationTypeFoundationModelTypeGeneratedQueryTypeGuadrailActionGuardrailActionGuardrailContentFilterConfidenceGuardrailContentFilterTypeGuardrailContentPolicyActionGuardrailManagedWordTypeGuardrailPiiEntityTypeGuardrailSensitiveInformationPolicyActionGuardrailTopicPolicyActionGuardrailTopicTypeGuardrailWordPolicyActionImageFormatImageInputFormatInputImageFormatInputQueryTypeInvocationTypeKnowledgeBaseQueryTypeManagedSearchRerankingConfigurationTypeMemoryTypeNodeErrorCodeNodeTypeOrchestrationTypeParameterTypePayloadTypePerformanceConfigLatencyPromptStatePromptTypeQueryTransformationModeQueryTransformationTypeRelayConversationHistoryRequireConfirmationRerankDocumentTypeRerankQueryContentTypeRerankSourceTypeRerankingConfigurationTypeRerankingMetadataSelectionModeRerankingModelTypeResponseStateRetrievalResultContentColumnTypeRetrievalResultContentTypeRetrievalResultLocationTypeRetrieveAndGenerateTypeSearchTypeSessionStatusSourceTextToSqlConfigurationTypeTypeVectorSearchRerankingConfigurationType