Skip to content

/AWS1/IF_BDC=>INVOKEAGENTRUNTIME()

About InvokeAgentRuntime

Sends 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 can specify either the AgentCore Runtime ARN or the agent ID with an account ID, and provide a payload containing your request. When you use the agent ID instead of the full ARN, you don't need to URL-encode the identifier. You can optionally specify a qualifier to target a specific 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. If you are making a call to InvokeAgentRuntime on behalf of a user ID with the X-Amzn-Bedrock-AgentCore-Runtime-User-Id header, You require permissions to both actions (bedrock-agentcore:InvokeAgentRuntime and bedrock-agentcore:InvokeAgentRuntimeForUser).

Method Signature

METHODS /AWS1/IF_BDC~INVOKEAGENTRUNTIME
  IMPORTING
    !IV_CONTENTTYPE TYPE /AWS1/BDCMIMETYPE OPTIONAL
    !IV_ACCEPT TYPE /AWS1/BDCMIMETYPE OPTIONAL
    !IV_MCPSESSIONID TYPE /AWS1/BDCSTRINGTYPE OPTIONAL
    !IV_RUNTIMESESSIONID TYPE /AWS1/BDCSESSIONTYPE OPTIONAL
    !IV_MCPPROTOCOLVERSION TYPE /AWS1/BDCSTRINGTYPE OPTIONAL
    !IV_RUNTIMEUSERID TYPE /AWS1/BDCSTRINGTYPE OPTIONAL
    !IV_TRACEID TYPE /AWS1/BDCSTRING OPTIONAL
    !IV_TRACEPARENT TYPE /AWS1/BDCSTRING OPTIONAL
    !IV_TRACESTATE TYPE /AWS1/BDCSTRING OPTIONAL
    !IV_BAGGAGE TYPE /AWS1/BDCSTRING OPTIONAL
    !IV_AGENTRUNTIMEARN TYPE /AWS1/BDCSTRING OPTIONAL
    !IV_QUALIFIER TYPE /AWS1/BDCSTRING OPTIONAL
    !IV_ACCOUNTID TYPE /AWS1/BDCSTRING OPTIONAL
    !IV_PAYLOAD TYPE /AWS1/BDCBODY OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_bdcinvkagentrtimersp
  RAISING
    /AWS1/CX_BDCACCESSDENIEDEX
    /AWS1/CX_BDCINTERNALSERVEREX
    /AWS1/CX_BDCRESOURCENOTFOUNDEX
    /AWS1/CX_BDCRUNTIMECLIENTERROR
    /AWS1/CX_BDCSERVICEQUOTAEXCDEX
    /AWS1/CX_BDCTHROTTLINGEX
    /AWS1/CX_BDCVALIDATIONEX
    /AWS1/CX_BDCCLIENTEXC
    /AWS1/CX_BDCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_agentruntimearn TYPE /AWS1/BDCSTRING /AWS1/BDCSTRING

The identifier of the agent runtime to invoke. You can specify either the full Amazon Web Services Resource Name (ARN) or the agent ID. If you use the agent ID, you must also provide the accountId query parameter.

iv_payload TYPE /AWS1/BDCBODY /AWS1/BDCBODY

The input data to send to the agent runtime. The format of this data depends on the specific agent configuration and must match the specified content type. For most agents, this is a JSON object containing the user's request.

Optional arguments:

iv_contenttype TYPE /AWS1/BDCMIMETYPE /AWS1/BDCMIMETYPE

The MIME type of the input data in the payload. This tells the agent runtime how to interpret the payload data. Common values include application/json for JSON data.

iv_accept TYPE /AWS1/BDCMIMETYPE /AWS1/BDCMIMETYPE

The desired MIME type for the response from the agent runtime. This tells the agent runtime what format to use for the response data. Common values include application/json for JSON data.

iv_mcpsessionid TYPE /AWS1/BDCSTRINGTYPE /AWS1/BDCSTRINGTYPE

The identifier of the MCP session.

iv_runtimesessionid TYPE /AWS1/BDCSESSIONTYPE /AWS1/BDCSESSIONTYPE

The identifier of the runtime session.

iv_mcpprotocolversion TYPE /AWS1/BDCSTRINGTYPE /AWS1/BDCSTRINGTYPE

The version of the MCP protocol being used.

iv_runtimeuserid TYPE /AWS1/BDCSTRINGTYPE /AWS1/BDCSTRINGTYPE

The identifier of the runtime user.

iv_traceid TYPE /AWS1/BDCSTRING /AWS1/BDCSTRING

The trace identifier for request tracking.

iv_traceparent TYPE /AWS1/BDCSTRING /AWS1/BDCSTRING

The parent trace information for distributed tracing.

iv_tracestate TYPE /AWS1/BDCSTRING /AWS1/BDCSTRING

The trace state information for distributed tracing.

iv_baggage TYPE /AWS1/BDCSTRING /AWS1/BDCSTRING

Additional context information for distributed tracing.

iv_qualifier TYPE /AWS1/BDCSTRING /AWS1/BDCSTRING

The qualifier to use for the agent runtime. This is an endpoint name that points to a specific version. If not specified, Amazon Bedrock AgentCore uses the default endpoint of the agent runtime.

iv_accountid TYPE /AWS1/BDCSTRING /AWS1/BDCSTRING

The identifier of the Amazon Web Services account for the agent runtime resource. This parameter is required when you specify an agent ID instead of the full ARN for agentRuntimeArn.

RETURNING

oo_output TYPE REF TO /aws1/cl_bdcinvkagentrtimersp /AWS1/CL_BDCINVKAGENTRTIMERSP

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->invokeagentruntime(
  iv_accept = |string|
  iv_accountid = |string|
  iv_agentruntimearn = |string|
  iv_baggage = |string|
  iv_contenttype = |string|
  iv_mcpprotocolversion = |string|
  iv_mcpsessionid = |string|
  iv_payload = '5347567362473873563239796247513D'
  iv_qualifier = |string|
  iv_runtimesessionid = |string|
  iv_runtimeuserid = |string|
  iv_traceid = |string|
  iv_traceparent = |string|
  iv_tracestate = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_sessionid = lo_result->get_runtimesessionid( ).
  lv_sessionid = lo_result->get_mcpsessionid( ).
  lv_string = lo_result->get_mcpprotocolversion( ).
  lv_string = lo_result->get_traceid( ).
  lv_string = lo_result->get_traceparent( ).
  lv_string = lo_result->get_tracestate( ).
  lv_string = lo_result->get_baggage( ).
  lv_string = lo_result->get_contenttype( ).
  lv_responsestream = lo_result->get_response( ).
  lv_httpresponsecode = lo_result->get_statuscode( ).
ENDIF.