AWS bedrock-agentcore documentation change
Summary
Updated documentation to change 'AGUI' to 'AG-UI' (with hyphen) throughout the file for consistency in naming convention.
Security assessment
The changes are purely cosmetic/terminological, updating the protocol name from 'AGUI' to 'AG-UI'. No security-related content was added, removed, or modified. The technical requirements, endpoints, authentication mechanisms, and error handling remain unchanged.
Diff
diff --git a/bedrock-agentcore/latest/devguide/runtime-agui-protocol-contract.md b/bedrock-agentcore/latest/devguide/runtime-agui-protocol-contract.md index ffec9dd99..b90c40fed 100644 --- a//bedrock-agentcore/latest/devguide/runtime-agui-protocol-contract.md +++ b//bedrock-agentcore/latest/devguide/runtime-agui-protocol-contract.md @@ -9 +9 @@ Protocol implementation requirementsContainer requirementsPath requirementsAuthe -# AGUI protocol contract +# AG-UI protocol contract @@ -11 +11 @@ Protocol implementation requirementsContainer requirementsPath requirementsAuthe -The AGUI protocol contract defines the requirements for implementing agent-to-user interface communication in Amazon Bedrock AgentCore Runtime. This contract specifies the technical requirements, endpoints, and communication patterns that your AGUI agent must implement. +The AG-UI protocol contract defines the requirements for implementing agent-to-user interface communication in Amazon Bedrock AgentCore Runtime. This contract specifies the technical requirements, endpoints, and communication patterns that your AG-UI agent must implement. @@ -13 +13 @@ The AGUI protocol contract defines the requirements for implementing agent-to-us -For example code, see [Deploy AGUI servers in AgentCore Runtime](./runtime-agui.html). +For example code, see [Deploy AG-UI servers in AgentCore Runtime](./runtime-agui.html). @@ -34 +34 @@ For example code, see [Deploy AGUI servers in AgentCore Runtime](./runtime-agui. -Your AGUI agent must implement these specific protocol requirements: +Your AG-UI agent must implement these specific protocol requirements: @@ -45 +45 @@ Your AGUI agent must implement these specific protocol requirements: -Your AGUI agent must be deployed as a containerized application meeting these specifications: +Your AG-UI agent must be deployed as a containerized application meeting these specifications: @@ -49 +49 @@ Your AGUI agent must be deployed as a containerized application meeting these sp - * **Port** : `8080` \- Standard port for AGUI agent communication (same as HTTP protocol) + * **Port** : `8080` \- Standard port for AG-UI agent communication (same as HTTP protocol) @@ -79 +79 @@ The invocations endpoint serves several key purposes: -Amazon Bedrock AgentCore passes request payloads directly to your container without validation. To be AGUI-compliant, your requests should follow the `RunAgentInput` format. Your container implementation determines which fields are required and how validation errors are handled. +Amazon Bedrock AgentCore passes request payloads directly to your container without validation. To be AG-UI-compliant, your requests should follow the `RunAgentInput` format. Your container implementation determines which fields are required and how validation errors are handled. @@ -81 +81 @@ Amazon Bedrock AgentCore passes request payloads directly to your container with -AGUI-compliant agents expect a `RunAgentInput` JSON payload. Example: +AG-UI-compliant agents expect a `RunAgentInput` JSON payload. Example: @@ -94 +94 @@ AGUI-compliant agents expect a `RunAgentInput` JSON payload. Example: -For the complete `RunAgentInput` schema and message format details, see [AGUI Types](https://docs.ag-ui.com/sdk/js/core/types). +For the complete `RunAgentInput` schema and message format details, see [AG-UI Types](https://docs.ag-ui.com/sdk/js/core/types). @@ -98 +98 @@ For the complete `RunAgentInput` schema and message format details, see [AGUI Ty -AGUI agents respond with SSE-formatted event streams: +AG-UI agents respond with SSE-formatted event streams: @@ -140 +140 @@ The WebSocket endpoint serves several key purposes: -Verifies that your AGUI agent is operational and ready to handle requests +Verifies that your AG-UI agent is operational and ready to handle requests @@ -161 +161 @@ Returns a status code indicating your agent’s health: -AGUI agents support multiple authentication mechanisms: +AG-UI agents support multiple authentication mechanisms: @@ -165 +165 @@ AGUI agents support multiple authentication mechanisms: -For AGUI client authentication, include the Bearer token in request headers: +For AG-UI client authentication, include the Bearer token in request headers: @@ -186 +186 @@ Errors are classified into two categories based on when they occur: -AGUI Error Code | HTTP Status | Description +AG-UI Error Code | HTTP Status | Description