View Source AWS.BedrockAgentCore (aws-elixir v1.0.9)
Amazon Bedrock AgentCore is in preview release and is subject to change.
Welcome to the Amazon Bedrock AgentCore Data Plane API reference. Data Plane actions process and handle data or workloads within Amazon Web Services services.
Link to this section Summary
Functions
Creates an event in an AgentCore Memory resource.
Deletes an event from an AgentCore Memory resource.
Deletes a memory record from an AgentCore Memory resource.
Retrieves detailed information about a specific browser session in Amazon Bedrock.
Retrieves detailed information about a specific code interpreter session in Amazon Bedrock.
Retrieves information about a specific event in an AgentCore Memory resource.
Retrieves a specific memory record from an AgentCore Memory resource.
Retrieves an API Key associated with an API Key Credential Provider
Returns the OAuth 2.0 token of the provided resource
Obtains an Workload access token for agentic workloads not acting on behalf of user.
Obtains an Workload access token for agentic workloads acting on behalf of user with JWT token
Obtains an Workload access token for agentic workloads acting on behalf of user with User Id.
Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.
Executes code within an active code interpreter session in Amazon Bedrock.
Lists all actors in an AgentCore Memory resource.
Retrieves a list of browser sessions in Amazon Bedrock that match the specified criteria.
Retrieves a list of code interpreter sessions in Amazon Bedrock that match the specified criteria.
Lists events in an AgentCore Memory resource based on specified criteria.
Lists memory records in an AgentCore Memory resource based on specified criteria.
Lists sessions in an AgentCore Memory resource based on specified criteria.
Searches for and retrieves memory records from an AgentCore Memory resource based on specified search criteria.
Creates and initializes a browser session in Amazon Bedrock.
Creates and initializes a code interpreter session in Amazon Bedrock.
Terminates an active browser session in Amazon Bedrock.
Terminates an active code interpreter session in Amazon Bedrock.
Updates a browser stream.
Link to this section Functions
Creates an event in an AgentCore Memory resource.
Events represent interactions or activities that occur within a session and are associated with specific actors.
To use this operation, you must have the bedrock-agentcore:CreateEvent
permission.
This operation is subject to request rate limiting.
delete_event(client, actor_id, event_id, memory_id, session_id, input, options \\ [])
View SourceDeletes an event from an AgentCore Memory resource.
When you delete an event, it is permanently removed.
To use this operation, you must have the bedrock-agentcore:DeleteEvent
permission.
delete_memory_record(client, memory_id, memory_record_id, input, options \\ [])
View SourceDeletes a memory record from an AgentCore Memory resource.
When you delete a memory record, it is permanently removed.
To use this operation, you must have the bedrock-agentcore:DeleteMemoryRecord
permission.
get_browser_session(client, browser_identifier, session_id, options \\ [])
View SourceRetrieves detailed information about a specific browser session in Amazon Bedrock.
This operation returns the session's configuration, current status, associated streams, and metadata.
To get a browser session, you must specify both the browser identifier and the session ID. The response includes information about the session's viewport configuration, timeout settings, and stream endpoints.
The following operations are related to GetBrowserSession
:
get_code_interpreter_session(client, code_interpreter_identifier, session_id, options \\ [])
View SourceRetrieves detailed information about a specific code interpreter session in Amazon Bedrock.
This operation returns the session's configuration, current status, and metadata.
To get a code interpreter session, you must specify both the code interpreter identifier and the session ID. The response includes information about the session's timeout settings and current status.
The following operations are related to GetCodeInterpreterSession
:
get_event(client, actor_id, event_id, memory_id, session_id, options \\ [])
View SourceRetrieves information about a specific event in an AgentCore Memory resource.
To use this operation, you must have the bedrock-agentcore:GetEvent
permission.
get_memory_record(client, memory_id, memory_record_id, options \\ [])
View SourceRetrieves a specific memory record from an AgentCore Memory resource.
To use this operation, you must have the bedrock-agentcore:GetMemoryRecord
permission.
Retrieves an API Key associated with an API Key Credential Provider
Returns the OAuth 2.0 token of the provided resource
Obtains an Workload access token for agentic workloads not acting on behalf of user.
Obtains an Workload access token for agentic workloads acting on behalf of user with JWT token
get_workload_access_token_for_user_id(client, input, options \\ [])
View SourceObtains an Workload access token for agentic workloads acting on behalf of user with User Id.
invoke_agent_runtime(client, agent_runtime_arn, input, options \\ [])
View SourceSends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.
To invoke an agent you must specify the AgentCore Runtime ARN and provide a payload containing your request. You can optionally specify a qualifier to target a specific version or endpoint of the agent.
This operation supports streaming responses, allowing you to receive partial responses as they become available. We recommend using pagination to ensure that the operation returns quickly and successfully when processing large responses.
For example code, see Invoke an AgentCore Runtime agent.
If you're integrating your agent with OAuth, you can't use the Amazon Web
Services SDK to call InvokeAgentRuntime
. Instead, make a HTTPS request to
InvokeAgentRuntime
. For an example, see Authenticate and authorize with Inbound Auth and Outbound
Auth.
To use this operation, you must have the bedrock-agentcore:InvokeAgentRuntime
permission.
invoke_code_interpreter(client, code_interpreter_identifier, input, options \\ [])
View SourceExecutes code within an active code interpreter session in Amazon Bedrock.
This operation processes the provided code, runs it in a secure environment, and returns the execution results including output, errors, and generated visualizations.
To execute code, you must specify the code interpreter identifier, session ID, and the code to run in the arguments parameter. The operation returns a stream containing the execution results, which can include text output, error messages, and data visualizations.
This operation is subject to request rate limiting based on your account's service quotas.
The following operations are related to InvokeCodeInterpreter
:
Lists all actors in an AgentCore Memory resource.
We recommend using pagination to ensure that the operation returns quickly and successfully.
To use this operation, you must have the bedrock-agentcore:ListActors
permission.
list_browser_sessions(client, browser_identifier, input, options \\ [])
View SourceRetrieves a list of browser sessions in Amazon Bedrock that match the specified criteria.
This operation returns summary information about each session, including identifiers, status, and timestamps.
You can filter the results by browser identifier and session status. The operation supports pagination to handle large result sets efficiently.
We recommend using pagination to ensure that the operation returns quickly and successfully when retrieving large numbers of sessions.
The following operations are related to ListBrowserSessions
:
list_code_interpreter_sessions(client, code_interpreter_identifier, input, options \\ [])
View SourceRetrieves a list of code interpreter sessions in Amazon Bedrock that match the specified criteria.
This operation returns summary information about each session, including identifiers, status, and timestamps.
You can filter the results by code interpreter identifier and session status. The operation supports pagination to handle large result sets efficiently.
We recommend using pagination to ensure that the operation returns quickly and successfully when retrieving large numbers of sessions.
The following operations are related to ListCodeInterpreterSessions
:
list_events(client, actor_id, memory_id, session_id, input, options \\ [])
View SourceLists events in an AgentCore Memory resource based on specified criteria.
We recommend using pagination to ensure that the operation returns quickly and successfully.
To use this operation, you must have the bedrock-agentcore:ListEvents
permission.
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.
To use this operation, you must have the bedrock-agentcore:ListMemoryRecords
permission.
Lists sessions in an AgentCore Memory resource based on specified criteria.
We recommend using pagination to ensure that the operation returns quickly and successfully.
To use this operation, you must have the bedrock-agentcore:ListSessions
permission.
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.
To use this operation, you must have the
bedrock-agentcore:RetrieveMemoryRecords
permission.
start_browser_session(client, browser_identifier, input, options \\ [])
View SourceCreates and initializes a browser session in Amazon Bedrock.
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.
To create a session, you must specify a browser identifier and a name. You can
also configure the viewport dimensions to control the visible area of web
content. The session remains active until it times out or you explicitly stop it
using the StopBrowserSession
operation.
The following operations are related to StartBrowserSession
:
start_code_interpreter_session(client, code_interpreter_identifier, input, options \\ [])
View SourceCreates and initializes a code interpreter session in Amazon Bedrock.
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.
To create a session, you must specify a code interpreter identifier and a name.
The session remains active until it times out or you explicitly stop it using
the StopCodeInterpreterSession
operation.
The following operations are related to StartCodeInterpreterSession
:
stop_browser_session(client, browser_identifier, input, options \\ [])
View SourceTerminates an active browser session in Amazon Bedrock.
This operation stops the session, releases associated resources, and makes the session unavailable for further use.
To stop a browser session, you must specify both the browser identifier and the
session ID. Once stopped, a session cannot be restarted; you must create a new
session using StartBrowserSession
.
The following operations are related to StopBrowserSession
:
stop_code_interpreter_session(client, code_interpreter_identifier, input, options \\ [])
View SourceTerminates an active code interpreter session in Amazon Bedrock.
This operation stops the session, releases associated resources, and makes the session unavailable for further use.
To stop a code interpreter session, you must specify both the code interpreter
identifier and the session ID. Once stopped, a session cannot be restarted; you
must create a new session using StartCodeInterpreterSession
.
The following operations are related to StopCodeInterpreterSession
:
update_browser_stream(client, browser_identifier, input, options \\ [])
View SourceUpdates a browser stream.
To use this operation, you must have permissions to perform the bedrock:UpdateBrowserStream action.