[ aws . bedrock-agentcore ]

invoke-agent-runtime

Description

Sends a request to an agent runtime in Amazon Bedrock and receives responses in real-time. The agent processes the request using the configured foundation model and any associated knowledge bases or action groups.

To invoke an agent runtime, you must specify the agent runtime ARN and provide a payload containing your request. You can optionally specify a qualifier to target a specific version or alias 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.

See also: AWS API Documentation

Synopsis

  invoke-agent-runtime
[--content-type <value>]
[--accept <value>]
[--mcp-session-id <value>]
[--runtime-session-id <value>]
[--mcp-protocol-version <value>]
[--runtime-user-id <value>]
[--trace-id <value>]
[--trace-parent <value>]
[--trace-state <value>]
[--baggage <value>]
--agent-runtime-arn <value>
[--qualifier <value>]
--payload <value>
<outfile>
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--content-type (string)

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.

--accept (string)

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.

--mcp-session-id (string)

The identifier of the MCP session.

--runtime-session-id (string)

The identifier of the runtime session.

--mcp-protocol-version (string)

The version of the MCP protocol being used.

--runtime-user-id (string)

The identifier of the runtime user.

--trace-id (string)

The trace identifier for request tracking.

--trace-parent (string)

The parent trace information for distributed tracing.

--trace-state (string)

The trace state information for distributed tracing.

--baggage (string)

Additional context information for distributed tracing.

--agent-runtime-arn (string)

The Amazon Web Services Resource Name (ARN) of the agent runtime to invoke. The ARN uniquely identifies the agent runtime resource in Amazon Bedrock.

--qualifier (string)

The qualifier to use for the agent runtime. This can be a version number or an alias name that points to a specific version. If not specified, Amazon Bedrock uses the default version of the agent runtime.

--payload (blob)

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.

outfile (string) Filename where the content will be saved

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

runtimeSessionId -> (string)

The identifier of the runtime session.

mcpSessionId -> (string)

The identifier of the MCP session.

mcpProtocolVersion -> (string)

The version of the MCP protocol being used.

traceId -> (string)

The trace identifier for request tracking.

traceParent -> (string)

The parent trace information for distributed tracing.

traceState -> (string)

The trace state information for distributed tracing.

baggage -> (string)

Additional context information for distributed tracing.

contentType -> (string)

The MIME type of the response data. This indicates how to interpret the response data. Common values include application/json for JSON data.

response -> (streaming blob)

The response data from the agent runtime. The format of this data depends on the specific agent configuration and the requested accept type. For most agents, this is a JSON object containing the agent’s response to the user’s request.

statusCode -> (integer)

The HTTP status code of the response. A status code of 200 indicates a successful operation. Other status codes indicate various error conditions.