Package-level declarations

Types

Link copied to clipboard

Welcome to the Amazon Bedrock AgentCore Data Plane API reference. Data Plane actions process and handle data or workloads within Amazon Web Services services.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Inherited functions

Link copied to clipboard

Creates multiple memory records in a single batch operation for the specified memory with custom content.

Link copied to clipboard

Deletes multiple memory records in a single batch operation from the specified memory.

Link copied to clipboard

Updates multiple memory records with custom content in a single batch operation within the specified memory.

Link copied to clipboard

Confirms the user authentication session for obtaining OAuth2.0 tokens for a resource.

Link copied to clipboard

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.

Link copied to clipboard

Creates an event in an AgentCore Memory resource. Events represent interactions or activities that occur within a session and are associated with specific actors.

Link copied to clipboard

Create a new payment instrument for a connector.

Link copied to clipboard

Create a new payment session.

Link copied to clipboard

Deletes an A/B test and its associated gateway rules.

Link copied to clipboard

Deletes a batch evaluation and its associated results.

Link copied to clipboard

Deletes an event from an AgentCore Memory resource. When you delete an event, it is permanently removed.

Link copied to clipboard

Deletes a memory record from an AgentCore Memory resource. When you delete a memory record, it is permanently removed.

Link copied to clipboard

Deletes a payment instrument. This is a soft delete operation that preserves the record for audit and compliance purposes.

Link copied to clipboard

Deletes a payment session. This permanently removes the payment session record.

Link copied to clipboard

Deletes a recommendation and its associated results.

Link copied to clipboard
inline suspend fun BedrockAgentCoreClient.evaluate(crossinline block: EvaluateRequest.Builder.() -> Unit): EvaluateResponse

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.

Link copied to clipboard

Retrieves detailed information about an A/B test, including its configuration, status, and statistical results.

Link copied to clipboard

Retrieves the A2A agent card associated with an AgentCore Runtime agent.

Link copied to clipboard

Retrieves detailed information about a batch evaluation, including its status, configuration, results, and any error details.

Link copied to clipboard

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.

Link copied to clipboard

Retrieves detailed information about a specific code interpreter session in Amazon Bedrock AgentCore. This operation returns the session's configuration, current status, and metadata.

Link copied to clipboard
inline suspend fun BedrockAgentCoreClient.getEvent(crossinline block: GetEventRequest.Builder.() -> Unit): GetEventResponse

Retrieves information about a specific event in an AgentCore Memory resource.

Link copied to clipboard

Retrieves a specific memory record from an AgentCore Memory resource.

Link copied to clipboard

Get a payment instrument by ID.

Link copied to clipboard

Get the balance of a payment instrument.

Link copied to clipboard

Get a payment session.

Link copied to clipboard

Retrieves detailed information about a recommendation, including its configuration, status, and results.

Link copied to clipboard

Retrieves the API key associated with an API key credential provider.

Link copied to clipboard

Returns the OAuth 2.0 token of the provided resource.

Link copied to clipboard

Generates authentication tokens for payment providers that use vendor-specific authentication mechanisms.

Link copied to clipboard

Obtains a workload access token for agentic workloads not acting on behalf of a user.

Link copied to clipboard

Obtains a workload access token for agentic workloads acting on behalf of a user, using a JWT token.

Link copied to clipboard

Obtains a workload access token for agentic workloads acting on behalf of a user, using the user's ID.

Link copied to clipboard

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.

Link copied to clipboard

Lists all A/B tests in the account.

Link copied to clipboard

Lists all actors in an AgentCore Memory resource. We recommend using pagination to ensure that the operation returns quickly and successfully.

Link copied to clipboard

Lists all batch evaluations in the account, providing summary information about each evaluation's status and configuration.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Lists events in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.

Link copied to clipboard

Lists all long-term memory extraction jobs that are eligible to be started with optional filtering.

Link copied to clipboard

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.

Link copied to clipboard

List payment instruments for a manager.

Link copied to clipboard

List payment sessions.

Link copied to clipboard

Lists all recommendations in the account, with optional filtering by status.

Link copied to clipboard

Lists sessions in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.

Link copied to clipboard

Processes a payment using a payment instrument within a payment session.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Searches for registry records using semantic, lexical, or hybrid queries. Returns metadata for matching records ordered by relevance within the specified registry.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Starts a recommendation job that analyzes agent traces and generates optimization suggestions for system prompts or tool descriptions to improve agent performance.

Link copied to clipboard

Stops a running batch evaluation. Sessions that have already been evaluated retain their results.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Stops a session that is running in an running AgentCore Runtime agent.

Link copied to clipboard

Updates an A/B test's configuration, including variants, traffic allocation, evaluation settings, or execution status.

Link copied to clipboard

Updates a browser stream. To use this operation, you must have permissions to perform the bedrock:UpdateBrowserStream action.

Link copied to clipboard

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.