BedrockAgentCoreClient
Welcome to the Amazon Bedrock AgentCore Data Plane API reference. Data Plane actions process and handle data or workloads within Amazon Web Services services.
Functions
Creates multiple memory records in a single batch operation for the specified memory with custom content.
Deletes multiple memory records in a single batch operation from the specified memory.
Updates multiple memory records with custom content in a single batch operation within the specified memory.
Confirms the user authentication session for obtaining OAuth2.0 tokens for a resource.
Creates an A/B test for comparing agent configurations. A/B tests split traffic between a control variant and a treatment variant through a gateway, then evaluate performance using online evaluation configurations to determine which variant performs better.
Creates an event in an AgentCore Memory resource. Events represent interactions or activities that occur within a session and are associated with specific actors.
Create a new payment instrument for a connector
Create a new payment manager session
Deletes an A/B test and its associated gateway rules.
Deletes a batch evaluation and its associated results.
Deletes an event from an AgentCore Memory resource. When you delete an event, it is permanently removed.
Deletes a memory record from an AgentCore Memory resource. When you delete a memory record, it is permanently removed.
Delete a payment instrument Marks a payment instrument as deleted by updating its status to DELETED. This is a soft delete operation that preserves the record in the database for audit and compliance purposes. The record remains queryable for audit purposes but is excluded from normal list and get operations. Deleting an already-deleted or non-existent instrument returns ResourceNotFoundException (404). Authorization: The caller must own the instrument (accountId, userId, and paymentManagerId must match). If authorization fails, a 403 Forbidden error is returned. Timestamp Management: The updatedAt timestamp is set to the current time, while createdAt is preserved. The version field is incremented for optimistic locking. Errors: - ResourceNotFoundException: The instrument does not exist or is already deleted - AccessDeniedException: The caller is not authorized to delete this instrument - ValidationException: Required fields are missing or invalid - InternalServerException: An unexpected server error occurred
Delete a payment manager session Permanently removes a payment session record from the database. This is a hard delete operation that removes the session completely. Deleting a non-existent or already-deleted session returns ResourceNotFoundException (404). Authorization: The caller must own the session (accountId, userId, and paymentManagerId must match). If authorization fails, a 403 Forbidden error is returned. Errors: - ResourceNotFoundException: The session does not exist or has already been deleted - AccessDeniedException: The caller is not authorized to delete this session - ValidationException: Required fields are missing or invalid - InternalServerException: An unexpected server error occurred
Deletes a recommendation and its associated results.
Performs on-demand evaluation of agent traces using a specified evaluator. This synchronous API accepts traces in OpenTelemetry format and returns immediate scoring results with detailed explanations.
Retrieves detailed information about an A/B test, including its configuration, status, and statistical results.
Retrieves the A2A agent card associated with an AgentCore Runtime agent.
Retrieves detailed information about a batch evaluation, including its status, configuration, results, and any error details.
Retrieves detailed information about a specific browser session in Amazon Bedrock AgentCore. This operation returns the session's configuration, current status, associated streams, and metadata.
Retrieves detailed information about a specific code interpreter session in Amazon Bedrock AgentCore. This operation returns the session's configuration, current status, and metadata.
Retrieves information about a specific event in an AgentCore Memory resource.
Retrieves a specific memory record from an AgentCore Memory resource.
Get a payment instrument by ID
Get the balance of a payment instrument
Get a payment session
Retrieves detailed information about a recommendation, including its configuration, status, and results.
Retrieves the API key associated with an API key credential provider.
Returns the OAuth 2.0 token of the provided resource.
Generates authentication tokens for payment providers that use vendor-specific authentication mechanisms.
Obtains a workload access token for agentic workloads not acting on behalf of a user.
Obtains a workload access token for agentic workloads acting on behalf of a user, using a JWT token.
Obtains a workload access token for agentic workloads acting on behalf of a user, using the user's ID.
Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.
Executes a command in a runtime session container and streams the output back to the caller. This operation allows you to run shell commands within the agent runtime environment and receive real-time streaming responses including standard output and standard error.
Invokes an operating system-level action on a browser session in Amazon Bedrock AgentCore. This operation provides direct OS-level control over browser sessions, enabling mouse actions, keyboard input, and screenshots that the WebSocket-based Chrome DevTools Protocol (CDP) cannot handle — such as interacting with print dialogs, context menus, and JavaScript alerts.
Executes code within an active code interpreter session in Amazon Bedrock AgentCore. This operation processes the provided code, runs it in a secure environment, and returns the execution results including output, errors, and generated visualizations.
Operation to invoke a Harness.
Lists all A/B tests in the account.
Lists all actors in an AgentCore Memory resource. We recommend using pagination to ensure that the operation returns quickly and successfully.
Lists all batch evaluations in the account, providing summary information about each evaluation's status and configuration.
Retrieves a list of browser sessions in Amazon Bedrock AgentCore that match the specified criteria. This operation returns summary information about each session, including identifiers, status, and timestamps.
Retrieves a list of code interpreter sessions in Amazon Bedrock AgentCore that match the specified criteria. This operation returns summary information about each session, including identifiers, status, and timestamps.
Lists events in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.
Lists all long-term memory extraction jobs that are eligible to be started with optional filtering.
Lists memory records in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.
List payment instruments for a manager
List payment manager sessions
Lists all recommendations in the account, with optional filtering by status.
Lists sessions in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.
Process a payment transaction
Searches for and retrieves memory records from an AgentCore Memory resource based on specified search criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.
Saves the current state of a browser session as a reusable profile in Amazon Bedrock AgentCore. A browser profile captures persistent browser data such as cookies and local storage from an active session, enabling you to reuse this data in future browser sessions.
Searches for registry records using semantic, lexical, or hybrid queries. Returns metadata for matching records ordered by relevance within the specified registry.
Starts a batch evaluation job that evaluates agent performance across multiple sessions. Batch evaluations pull agent traces from CloudWatch Logs or an existing online evaluation configuration and run specified evaluators and insights against them.
Creates and initializes a browser session in Amazon Bedrock AgentCore. The session enables agents to navigate and interact with web content, extract information from websites, and perform web-based tasks as part of their response generation.
Creates and initializes a code interpreter session in Amazon Bedrock AgentCore. The session enables agents to execute code as part of their response generation, supporting programming languages such as Python for data analysis, visualization, and computation tasks.
Starts a memory extraction job that processes events that failed extraction previously in an AgentCore Memory resource and produces structured memory records. When earlier extraction attempts have left events unprocessed, this job will pick up and extract those as well.
Starts a recommendation job that analyzes agent traces and generates optimization suggestions for system prompts or tool descriptions to improve agent performance.
Stops a running batch evaluation. Sessions that have already been evaluated retain their results.
Terminates an active browser session in Amazon Bedrock AgentCore. This operation stops the session, releases associated resources, and makes the session unavailable for further use.
Terminates an active code interpreter session in Amazon Bedrock AgentCore. This operation stops the session, releases associated resources, and makes the session unavailable for further use.
Stops a session that is running in an running AgentCore Runtime agent.
Updates an A/B test's configuration, including variants, traffic allocation, evaluation settings, or execution status.
Updates a browser stream. To use this operation, you must have permissions to perform the bedrock:UpdateBrowserStream action.
Inherited functions
Creates multiple memory records in a single batch operation for the specified memory with custom content.
Deletes multiple memory records in a single batch operation from the specified memory.
Updates multiple memory records with custom content in a single batch operation within the specified memory.
Confirms the user authentication session for obtaining OAuth2.0 tokens for a resource.
Creates an A/B test for comparing agent configurations. A/B tests split traffic between a control variant and a treatment variant through a gateway, then evaluate performance using online evaluation configurations to determine which variant performs better.
Creates an event in an AgentCore Memory resource. Events represent interactions or activities that occur within a session and are associated with specific actors.
Create a new payment instrument for a connector
Create a new payment manager session
Deletes an A/B test and its associated gateway rules.
Deletes a batch evaluation and its associated results.
Deletes an event from an AgentCore Memory resource. When you delete an event, it is permanently removed.
Deletes a memory record from an AgentCore Memory resource. When you delete a memory record, it is permanently removed.
Delete a payment instrument Marks a payment instrument as deleted by updating its status to DELETED. This is a soft delete operation that preserves the record in the database for audit and compliance purposes. The record remains queryable for audit purposes but is excluded from normal list and get operations. Deleting an already-deleted or non-existent instrument returns ResourceNotFoundException (404). Authorization: The caller must own the instrument (accountId, userId, and paymentManagerId must match). If authorization fails, a 403 Forbidden error is returned. Timestamp Management: The updatedAt timestamp is set to the current time, while createdAt is preserved. The version field is incremented for optimistic locking. Errors: - ResourceNotFoundException: The instrument does not exist or is already deleted - AccessDeniedException: The caller is not authorized to delete this instrument - ValidationException: Required fields are missing or invalid - InternalServerException: An unexpected server error occurred
Delete a payment manager session Permanently removes a payment session record from the database. This is a hard delete operation that removes the session completely. Deleting a non-existent or already-deleted session returns ResourceNotFoundException (404). Authorization: The caller must own the session (accountId, userId, and paymentManagerId must match). If authorization fails, a 403 Forbidden error is returned. Errors: - ResourceNotFoundException: The session does not exist or has already been deleted - AccessDeniedException: The caller is not authorized to delete this session - ValidationException: Required fields are missing or invalid - InternalServerException: An unexpected server error occurred
Deletes a recommendation and its associated results.
Performs on-demand evaluation of agent traces using a specified evaluator. This synchronous API accepts traces in OpenTelemetry format and returns immediate scoring results with detailed explanations.
Retrieves detailed information about an A/B test, including its configuration, status, and statistical results.
Retrieves the A2A agent card associated with an AgentCore Runtime agent.
Retrieves detailed information about a batch evaluation, including its status, configuration, results, and any error details.
Retrieves detailed information about a specific browser session in Amazon Bedrock AgentCore. This operation returns the session's configuration, current status, associated streams, and metadata.
Retrieves detailed information about a specific code interpreter session in Amazon Bedrock AgentCore. This operation returns the session's configuration, current status, and metadata.
Retrieves information about a specific event in an AgentCore Memory resource.
Retrieves a specific memory record from an AgentCore Memory resource.
Get a payment instrument by ID
Get the balance of a payment instrument
Get a payment session
Retrieves detailed information about a recommendation, including its configuration, status, and results.
Retrieves the API key associated with an API key credential provider.
Returns the OAuth 2.0 token of the provided resource.
Generates authentication tokens for payment providers that use vendor-specific authentication mechanisms.
Obtains a workload access token for agentic workloads not acting on behalf of a user.
Obtains a workload access token for agentic workloads acting on behalf of a user, using a JWT token.
Obtains a workload access token for agentic workloads acting on behalf of a user, using the user's ID.
Invokes an operating system-level action on a browser session in Amazon Bedrock AgentCore. This operation provides direct OS-level control over browser sessions, enabling mouse actions, keyboard input, and screenshots that the WebSocket-based Chrome DevTools Protocol (CDP) cannot handle — such as interacting with print dialogs, context menus, and JavaScript alerts.
Lists all A/B tests in the account.
Paginate over ListAbTestsResponse results.
Lists all actors in an AgentCore Memory resource. We recommend using pagination to ensure that the operation returns quickly and successfully.
Paginate over ListActorsResponse results.
Lists all batch evaluations in the account, providing summary information about each evaluation's status and configuration.
Paginate over ListBatchEvaluationsResponse results.
Retrieves a list of browser sessions in Amazon Bedrock AgentCore that match the specified criteria. This operation returns summary information about each session, including identifiers, status, and timestamps.
Retrieves a list of code interpreter sessions in Amazon Bedrock AgentCore that match the specified criteria. This operation returns summary information about each session, including identifiers, status, and timestamps.
Lists events in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.
Paginate over ListEventsResponse results.
Lists all long-term memory extraction jobs that are eligible to be started with optional filtering.
Paginate over ListMemoryExtractionJobsResponse results.
Lists memory records in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.
Paginate over ListMemoryRecordsResponse results.
List payment instruments for a manager
Paginate over ListPaymentInstrumentsResponse results.
List payment manager sessions
Paginate over ListPaymentSessionsResponse results.
Lists all recommendations in the account, with optional filtering by status.
Paginate over ListRecommendationsResponse results.
Lists sessions in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.
Paginate over ListSessionsResponse results.
Process a payment transaction
Searches for and retrieves memory records from an AgentCore Memory resource based on specified search criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.
Paginate over RetrieveMemoryRecordsResponse results.
Saves the current state of a browser session as a reusable profile in Amazon Bedrock AgentCore. A browser profile captures persistent browser data such as cookies and local storage from an active session, enabling you to reuse this data in future browser sessions.
Searches for registry records using semantic, lexical, or hybrid queries. Returns metadata for matching records ordered by relevance within the specified registry.
Starts a batch evaluation job that evaluates agent performance across multiple sessions. Batch evaluations pull agent traces from CloudWatch Logs or an existing online evaluation configuration and run specified evaluators and insights against them.
Creates and initializes a browser session in Amazon Bedrock AgentCore. The session enables agents to navigate and interact with web content, extract information from websites, and perform web-based tasks as part of their response generation.
Creates and initializes a code interpreter session in Amazon Bedrock AgentCore. The session enables agents to execute code as part of their response generation, supporting programming languages such as Python for data analysis, visualization, and computation tasks.
Starts a memory extraction job that processes events that failed extraction previously in an AgentCore Memory resource and produces structured memory records. When earlier extraction attempts have left events unprocessed, this job will pick up and extract those as well.
Starts a recommendation job that analyzes agent traces and generates optimization suggestions for system prompts or tool descriptions to improve agent performance.
Stops a running batch evaluation. Sessions that have already been evaluated retain their results.
Terminates an active browser session in Amazon Bedrock AgentCore. This operation stops the session, releases associated resources, and makes the session unavailable for further use.
Terminates an active code interpreter session in Amazon Bedrock AgentCore. This operation stops the session, releases associated resources, and makes the session unavailable for further use.
Stops a session that is running in an running AgentCore Runtime agent.
Updates an A/B test's configuration, including variants, traffic allocation, evaluation settings, or execution status.
Updates a browser stream. To use this operation, you must have permissions to perform the bedrock:UpdateBrowserStream action.
Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.