Bedrock AgentCore¶
Installation¶
To install the Bedrock AgentCore client:
Clients¶
The package provides a synchronous client, BedrockAgentCoreClient, and an asynchronous client, AsyncBedrockAgentCoreClient. Both clients use the same models.
Operations that use event streams are available only on AsyncBedrockAgentCoreClient. They are marked Async only under Operations.
BedrockAgentCoreClient
¶
BedrockAgentCoreClient(config: BedrockAgentCoreConfig | None = None, plugins: list[Plugin] | None = None)
Bases: Client[BedrockAgentCoreConfig]
Welcome to the Amazon Bedrock AgentCore Data Plane API reference. Data Plane actions process and handle data or workloads within Amazon Web Services services.
AsyncBedrockAgentCoreClient
¶
AsyncBedrockAgentCoreClient(config: AsyncBedrockAgentCoreConfig | None = None, plugins: list[Plugin] | None = None)
Bases: AsyncClient[AsyncBedrockAgentCoreConfig]
Welcome to the Amazon Bedrock AgentCore Data Plane API reference. Data Plane actions process and handle data or workloads within Amazon Web Services services.
Operations¶
batch_create_memory_recordsbatch_delete_memory_recordsbatch_update_memory_recordscomplete_resource_token_authcreate_ab_testcreate_eventcreate_payment_instrumentcreate_payment_sessiondelete_ab_testdelete_batch_evaluationdelete_capacity_provider_sessiondelete_eventdelete_memory_recorddelete_payment_instrumentdelete_payment_sessiondelete_recommendationevaluateget_ab_testget_agent_cardget_batch_evaluationget_browser_sessionget_code_interpreter_sessionget_eventget_memory_recordget_payment_instrumentget_payment_instrument_balanceget_payment_sessionget_recommendationget_resource_api_keyget_resource_oauth2_tokenget_resource_payment_tokenget_workload_access_tokenget_workload_access_token_for_jwtget_workload_access_token_for_user_idingest_datainvoke_agent_runtimeinvoke_agent_runtime_commandAsync onlyinvoke_browserinvoke_code_interpreterAsync onlyinvoke_harnessAsync onlyinvoke_web_searchlist_ab_testslist_actorslist_batch_evaluationslist_browser_sessionslist_code_interpreter_sessionslist_eventslist_memory_extraction_jobslist_memory_recordslist_payment_instrumentslist_payment_sessionslist_recommendationslist_sessionsprocess_paymentretrieve_memory_recordssave_browser_session_profilesearch_registry_recordsstart_batch_evaluationstart_browser_sessionstart_code_interpreter_sessionstart_memory_extraction_jobstart_recommendationstop_batch_evaluationstop_browser_sessionstop_code_interpreter_sessionstop_runtime_sessionupdate_ab_testupdate_browser_stream
Configuration¶
BedrockAgentCoreConfig
dataclass
¶
Bases: AwsConfig
Bedrock AgentCore 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[_BedrockAgentCoreConfigOverrides]) -> Self
Resolve config from environment, config files, defaults, and explicit overrides.
Plugin
module-attribute
¶
Plugin: TypeAlias = Callable[[BedrockAgentCoreConfig], 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.
AsyncBedrockAgentCoreConfig
dataclass
¶
Bases: AsyncAwsConfig
Bedrock AgentCore 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[_AsyncBedrockAgentCoreConfigOverrides]) -> Self
Resolve config from environment, config files, defaults, and explicit overrides.
Plugin
module-attribute
¶
Plugin: TypeAlias = Callable[[AsyncBedrockAgentCoreConfig], 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¶
A2aDescriptorABTestResultsABTestSummaryActorSummaryAffectedSessionAgentCardDefinitionAgentSkillsDescriptorAmountAutomationStreamAutomationStreamUpdateAvailableLimitsBasicAuthBatchEvaluationSummaryBatchEvaluationTraceConfigBranchBranchFilterBrowserEnterprisePolicyBrowserExtensionBrowserProfileConfigurationBrowserSessionStreamBrowserSessionSummaryCertificateCloudWatchFilterConfigCloudWatchLogsFilterCloudWatchLogsRuleCloudWatchLogsSourceCloudWatchLogsTraceConfigCloudWatchOutputConfigCodeInterpreterResultCodeInterpreterSessionSummaryCoinbaseCdpTokenRequestInputCoinbaseCdpTokenResponseOutputConfidenceIntervalConfigurationBundleRefConfigurationBundleToolEntryContentBlockContentDeltaEventContentStartEventContentStopEventControlStatsConversationalCryptoX402PaymentInputCryptoX402PaymentOutputCustomDescriptorDescriptorsDomainFilterEfsConfigurationEmbeddedCryptoWalletEvaluationExpectedTrajectoryEvaluationJobResultsEvaluationReferenceInputEvaluationResultContentEvaluatorEvaluatorMetricEvaluatorStatisticsEvaluatorSummaryEventEventMetadataFilterExpressionExecutionSummaryAffectedSessionExecutionSummaryClusterExecutionSummaryClusteringResultContentExternalProxyExtractionConfigExtractionJobExtractionJobFilterInputExtractionJobMetadataFailureAnalysisResultContentFailureCategoryClusterFailureSpanDetailFailureSubCategoryClusterFilterInputGatewayFilterGroundTruthTurnHarnessAgentCoreBrowserConfigHarnessAgentCoreCodeInterpreterConfigHarnessAgentCoreGatewayConfigHarnessBedrockModelConfigHarnessContentBlockDeltaEventHarnessContentBlockStartEventHarnessContentBlockStopEventHarnessGeminiModelConfigHarnessHookEventHarnessInlineFunctionConfigHarnessLiteLlmModelConfigHarnessMessageHarnessMessageStartEventHarnessMessageStopEventHarnessMetadataEventHarnessOpenAiModelConfigHarnessReasoningTextBlockHarnessRemoteMcpConfigHarnessSkillAwsSkillsSourceHarnessSkillGitAuthHarnessSkillGitSourceHarnessSkillS3SourceHarnessStreamMetricsHarnessTokenUsageHarnessToolHarnessToolResultBlockHarnessToolResultBlockStartHarnessToolResultMetadataBlockDeltaHarnessToolUseBlockHarnessToolUseBlockDeltaHarnessToolUseBlockStartIamCredentialProviderInlineGroundTruthInlineMemoryContentInputContentBlockInsightInsightResultInsightRootCauseInsightsFailureSignalInvokeAgentRuntimeCommandRequestBodyKeyPressArgumentsKeyPressResultKeyShortcutArgumentsKeyShortcutResultKeyTypeArgumentsKeyTypeResultLinkedAccountDeveloperJwtLinkedAccountEmailLinkedAccountSmsLiveViewStreamMcpDescriptorMemoryJsonDataMemoryMetadataFilterExpressionMemoryRecordMemoryRecordCreateInputMemoryRecordDeleteInputMemoryRecordOutputMemoryRecordSummaryMemoryRecordUpdateInputMessageMetadataMouseClickArgumentsMouseClickResultMouseDragArgumentsMouseDragResultMouseMoveArgumentsMouseMoveResultMouseScrollArgumentsMouseScrollResultMppPaymentInputMppPaymentOutputOAuth2AuthenticationOAuthCredentialProviderOnlineEvaluationConfigSourceOnlineEvaluationTraceConfigPaymentInstrumentPaymentInstrumentSummaryPaymentSessionPaymentSessionSummaryPerVariantOnlineEvaluationConfigProxyBypassProxyConfigurationPublishedDateFilterRecommendationEvaluationConfigRecommendationEvaluatorReferenceRecommendationResultConfigurationBundleRecommendationSummaryRegistryRecordSummaryResourceContentResponseChunkRootCauseClusterS3FilesConfigurationS3LocationSampleSessionScreenshotArgumentsScreenshotResultSearchCriteriaSecretsManagerLocationServerDefinitionSessionFilterSessionFilterConfigSessionFindingSessionLimitsSessionMetadataShapeSessionSummarySessionTraceIdsSkillDefinitionSkillMdDefinitionSpanContextStripePrivyTokenRequestInputStripePrivyTokenResponseOutputSystemPromptConfigurationBundleSystemPromptRecommendationConfigSystemPromptRecommendationResultTargetRefTokenBalanceTokenUsageToolArgumentsToolDescriptionConfigurationBundleToolDescriptionInputToolDescriptionOutputToolDescriptionRecommendationConfigToolDescriptionRecommendationResultToolDescriptionTextInputToolResultStructuredContentToolsDefinitionUnitUserIntentAffectedSessionUserIntentClusterUserIntentClusteringResultContentValidationExceptionFieldVariantVariantConfigurationVariantResultViewPortWebSearchFiltersWebSearchResult
Dictionaries¶
AmountDictAutomationStreamUpdateDictBasicAuthDictBatchEvaluationTraceConfigDictBranchDictBranchFilterDictBrowserEnterprisePolicyDictBrowserExtensionDictBrowserProfileConfigurationDictCertificateDictCloudWatchFilterConfigDictCloudWatchLogsFilterDictCloudWatchLogsRuleDictCloudWatchLogsSourceDictCloudWatchLogsTraceConfigDictCloudWatchOutputConfigDictCoinbaseCdpTokenRequestInputDictConfigurationBundleRefDictConfigurationBundleToolEntryDictConversationalDictCryptoX402PaymentInputDictDomainFilterDictEfsConfigurationDictEmbeddedCryptoWalletDictEvaluationExpectedTrajectoryDictEvaluationReferenceInputDictEvaluatorDictEventMetadataFilterExpressionDictExternalProxyDictExtractionConfigDictExtractionJobDictExtractionJobFilterInputDictFilterInputDictGatewayFilterDictGroundTruthTurnDictHarnessAgentCoreBrowserConfigDictHarnessAgentCoreCodeInterpreterConfigDictHarnessAgentCoreGatewayConfigDictHarnessBedrockModelConfigDictHarnessGeminiModelConfigDictHarnessInlineFunctionConfigDictHarnessLiteLlmModelConfigDictHarnessMessageDictHarnessOpenAiModelConfigDictHarnessReasoningTextBlockDictHarnessRemoteMcpConfigDictHarnessSkillAwsSkillsSourceDictHarnessSkillGitAuthDictHarnessSkillGitSourceDictHarnessSkillS3SourceDictHarnessToolDictHarnessToolResultBlockDictHarnessToolUseBlockDictIamCredentialProviderDictInlineGroundTruthDictInlineMemoryContentDictInputContentBlockDictInsightDictInvokeAgentRuntimeCommandRequestBodyDictKeyPressArgumentsDictKeyShortcutArgumentsDictKeyTypeArgumentsDictLinkedAccountDeveloperJwtDictLinkedAccountEmailDictLinkedAccountSmsDictMemoryJsonDataDictMemoryMetadataFilterExpressionDictMemoryRecordCreateInputDictMemoryRecordDeleteInputDictMemoryRecordUpdateInputDictMouseClickArgumentsDictMouseDragArgumentsDictMouseMoveArgumentsDictMouseScrollArgumentsDictMppPaymentInputDictOAuth2AuthenticationDictOAuthCredentialProviderDictOnlineEvaluationConfigSourceDictOnlineEvaluationTraceConfigDictPerVariantOnlineEvaluationConfigDictProxyBypassDictProxyConfigurationDictPublishedDateFilterDictRecommendationEvaluationConfigDictRecommendationEvaluatorReferenceDictS3FilesConfigurationDictS3LocationDictScreenshotArgumentsDictSearchCriteriaDictSecretsManagerLocationDictSessionFilterConfigDictSessionFilterDictSessionLimitsDictSessionMetadataShapeDictSessionTraceIdsDictSpanContextDictStripePrivyTokenRequestInputDictSystemPromptConfigurationBundleDictSystemPromptRecommendationConfigDictTargetRefDictToolArgumentsDictToolDescriptionConfigurationBundleDictToolDescriptionInputDictToolDescriptionRecommendationConfigDictToolDescriptionTextInputDictUnitDictVariantConfigurationDictVariantDictViewPortDictWebSearchFiltersDict
Errors¶
AccessDeniedExceptionConflictExceptionDuplicateIdExceptionInternalServerExceptionInvalidInputExceptionResourceNotFoundExceptionRetryableConflictExceptionRuntimeClientErrorServiceErrorServiceExceptionServiceQuotaExceededExceptionServiceUnavailableExceptionSubscriptionRequiredExceptionThrottledExceptionThrottlingExceptionUnauthorizedExceptionValidationException
Unions¶
ABTestEvaluationConfigABTestEvaluationConfigDictAgentTracesConfigAgentTracesConfigDictBrowserActionBrowserActionDictBrowserActionResultCertificateLocationCertificateLocationDictCodeInterpreterStreamOutputContentContentDictContentSourceContentSourceDictContextContextDictDataSourceConfigDataSourceConfigDictEvaluationContentEvaluationContentDictEvaluationInputEvaluationInputDictEvaluationMetadataEvaluationMetadataDictEvaluationTargetEvaluationTargetDictExtractionJobMessagesFilterValueFilterValueDictGroundTruthSourceGroundTruthSourceDictGroundTruthTurnInputGroundTruthTurnInputDictHarnessContentBlockHarnessContentBlockDeltaHarnessContentBlockDictHarnessContentBlockStartHarnessGatewayOutboundAuthHarnessGatewayOutboundAuthDictHarnessModelConfigurationHarnessModelConfigurationDictHarnessReasoningContentBlockHarnessReasoningContentBlockDeltaHarnessReasoningContentBlockDictHarnessRemoteMcpOutboundAuthHarnessRemoteMcpOutboundAuthDictHarnessSkillHarnessSkillDictHarnessSystemContentBlockHarnessSystemContentBlockDictHarnessToolConfigurationHarnessToolConfigurationDictHarnessToolResultBlockDeltaHarnessToolResultContentBlockHarnessToolResultContentBlockDictIngestPayloadTypeIngestPayloadTypeDictInvokeAgentRuntimeCommandStreamOutputInvokeHarnessStreamOutputLeftExpressionLeftExpressionDictLinkedAccountLinkedAccountDictLinkedAccountOAuth2LinkedAccountOAuth2DictMemoryContentMemoryContentDictMemoryRecordLeftExpressionMemoryRecordLeftExpressionDictMemoryRecordMetadataValueMemoryRecordMetadataValueDictMemoryRecordRightExpressionMemoryRecordRightExpressionDictMetadataValueMetadataValueDictOutputConfigOutputConfigDictPayloadTypePayloadTypeDictPaymentInputPaymentInputDictPaymentInstrumentDetailsPaymentInstrumentDetailsDictPaymentOutputPaymentTokenRequestInputPaymentTokenRequestInputDictPaymentTokenResponseOutputProxyProxyCredentialsProxyCredentialsDictProxyDictRecommendationConfigRecommendationConfigDictRecommendationResultRecordExpirySpecificationRecordExpirySpecificationDictResourceLocationResourceLocationDictRightExpressionRightExpressionDictStreamUpdateStreamUpdateDictSystemPromptConfigSystemPromptConfigDictToolDescriptionConfigToolDescriptionConfigDictToolDescriptionSourceToolDescriptionSourceDictToolsFileSystemConfigurationToolsFileSystemConfigurationDictUserIdentifierUserIdentifierDict
Enums¶
ABTestExecutionStatusABTestStatusAutomationStreamStatusBatchEvaluationStatusBlockchainChainIdBrowserActionStatusBrowserEnterprisePolicyTypeBrowserSessionStatusCapacityProviderSessionStatusCloudWatchLogsFilterOperatorCodeInterpreterSessionStatusCommandExecutionStatusContentBlockTypeCryptoWalletNetworkCurrencyDescriptorTypeEventFilterConditionExtractionJobStatusExtractionModeFindingTargetTypeHarnessBedrockApiFormatHarnessConversationRoleHarnessHookDecisionHarnessHookEventTypeHarnessOpenAiApiFormatHarnessStopReasonHarnessToolTypeHarnessToolUseStatusHarnessToolUseTypeInsightTypeInsightsFailureCategoryInstrumentBalanceTokenLanguageRuntimeMemoryRecordOperatorTypeMemoryRecordStatusMouseButtonOAuthGrantTypeOauth2FlowTypeOperatorTypePaymentHttpMethodTypePaymentInstrumentStatusPaymentInstrumentTypePaymentSessionStatusPaymentStatusPaymentTypeProgrammingLanguageRecommendationStatusRecommendationTypeRecordExpiryActionRegistryRecordStatusResourceContentTypeResultDestinationRoleScreenshotFormatSessionStatusTaskStatusToolNameValidationExceptionReason