AWS bedrock-agentcore documentation change
Summary
Updated typography (straight apostrophes to curly apostrophes) and formatting (changed some headings from markdown style to bold).
Security assessment
The changes are purely stylistic and typographical. There is no mention of security vulnerabilities, patches, or new security features. The content related to permissions, authentication, and error handling remains unchanged in substance.
Diff
diff --git a/bedrock-agentcore/latest/devguide/runtime-troubleshooting.md b/bedrock-agentcore/latest/devguide/runtime-troubleshooting.md index d92a23f2b..5ebed0b14 100644 --- a//bedrock-agentcore/latest/devguide/runtime-troubleshooting.md +++ b//bedrock-agentcore/latest/devguide/runtime-troubleshooting.md @@ -5 +5 @@ -My agent invocations fail with 504 Gateway Timeout errorsMy Docker build fails with "403 Forbidden" when pulling Python base imagesI get "Unknown service: 'bedrock-agent-core-runtime'" error when using boto3I get "AccessDeniedException" when trying to create an Amazon Bedrock AgentCore RuntimeMy Docker build fails with "exec /bin/sh: exec format error"What are the requirements for Docker containers used with Amazon Bedrock AgentCore Runtime?My long-running tool gets interrupted after 15 minutesHow do I access the runtimeSessionId in my agent code for tagging or grouping resources?I have RuntimeClientError (403) issuesI have missing or empty CloudWatch LogsI have payload format issuesI need help understanding HTTP error codesI need recommendations for testing my agentI need help debugging container issuesI need help troubleshooting MCP protocol agentsI need help troubleshooting bidirectional streaming using WebSocketMy code changes aren't reflected in existing sessionsSpans are missing when my runtime is invoked from a Lambda functionBest practices +My agent invocations fail with 504 Gateway Timeout errorsMy Docker build fails with "403 Forbidden" when pulling Python base imagesI get "Unknown service: 'bedrock-agent-core-runtime'" error when using boto3I get "AccessDeniedException" when trying to create an Amazon Bedrock AgentCore RuntimeMy Docker build fails with "exec /bin/sh: exec format error"What are the requirements for Docker containers used with Amazon Bedrock AgentCore Runtime?My long-running tool gets interrupted after 15 minutesHow do I access the runtimeSessionId in my agent code for tagging or grouping resources?I have RuntimeClientError (403) issuesI have missing or empty CloudWatch LogsI have payload format issuesI need help understanding HTTP error codesI need recommendations for testing my agentI need help debugging container issuesI need help troubleshooting MCP protocol agentsI need help troubleshooting bidirectional streaming using WebSocketMy code changes aren’t reflected in existing sessionsSpans are missing when my runtime is invoked from a Lambda functionBest practices @@ -45 +45 @@ This troubleshooting topic helps you identify and resolve common issues when wor - * My code changes aren't reflected in existing sessions + * My code changes aren’t reflected in existing sessions @@ -95 +94 @@ Several factors can cause this: -**Why this happens:** Outdated boto3 library — common issue as most installations don't have latest SDK +**Why this happens:** Outdated boto3 library — common issue as most installations don’t have latest SDK @@ -109 +107 @@ Several factors can cause this: -**Why this happens:** Either your user lacks permissions, or the execution role isn't properly configured for Amazon Bedrock AgentCore +**Why this happens:** Either your user lacks permissions, or the execution role isn’t properly configured for Amazon Bedrock AgentCore @@ -113 +111 @@ Several factors can cause this: - * **Missing permissions for the caller.** Make sure that the caller's credentials has `bedrock-agentcore:CreateAgentRuntime`. + * **Missing permissions for the caller.** Make sure that the caller’s credentials has `bedrock-agentcore:CreateAgentRuntime`. @@ -161 +159 @@ For information, see [Handle asynchronous and long running agents with Amazon Be - * If you're using the Bedrock Agents SDK, use `context.session_id`. + * If you’re using the Bedrock Agents SDK, use `context.session_id`. @@ -163 +161 @@ For information, see [Handle asynchronous and long running agents with Amazon Be - * If you're building a custom runtime server, extract it from the `X-Amzn-Bedrock-AgentCore-Runtime-Session-Id` HTTP header. + * If you’re building a custom runtime server, extract it from the `X-Amzn-Bedrock-AgentCore-Runtime-Session-Id` HTTP header. @@ -196 +192 @@ The runtime session ID is passed in this HTTP header. Parse it from the incoming -###### Problem +**Problem** @@ -200 +196 @@ You receive a 403 "RuntimeClientError" when attempting to invoke your agent runt -###### Causes +**Causes** @@ -213 +209 @@ This error typically occurs due to: -###### Resolution +**Resolution** @@ -221 +217 @@ Follow these steps to resolve the issue: - 2. **Verify Execution Role** : Ensure your agent's execution role has the necessary permissions. For more information, see [AgentCore Runtime execution role](./runtime-permissions.html#runtime-permissions-execution-role). + 2. **Verify Execution Role** : Ensure your agent’s execution role has the necessary permissions. For more information, see [AgentCore Runtime execution role](./runtime-permissions.html#runtime-permissions-execution-role). @@ -230 +226 @@ Follow these steps to resolve the issue: -###### Problem +**Problem** @@ -232 +228 @@ Follow these steps to resolve the issue: -You encounter errors but don't see any relevant logs in CloudWatch. +You encounter errors but don’t see any relevant logs in CloudWatch. @@ -234 +230 @@ You encounter errors but don't see any relevant logs in CloudWatch. -###### Solution +**Solution** @@ -238 +234 @@ Try these approaches to diagnose the issue: - 1. **Check Correct Log Group** : Ensure you're looking in the right CloudWatch log group. The standard pattern is: + 1. **Check Correct Log Group** : Ensure you’re looking in the right CloudWatch log group. The standard pattern is: @@ -251 +247 @@ Try these approaches to diagnose the issue: -###### Problem +**Problem** @@ -255 +251 @@ Your agent runtime invocation fails even though the container starts successfull -###### Resolution +**Resolution** @@ -282 +278 @@ Follow these steps to resolve payload format issues: -###### Problem +**Problem** @@ -286 +282 @@ Your agent returns HTTP error codes that are difficult to interpret. -###### Example error message +**Example error message** @@ -293 +289 @@ You may see an error like: -###### Resolution +**Resolution** @@ -331 +327 @@ To systematically debug agent runtime issues: -###### Test locally first +**Test locally first** @@ -342 +338 @@ Before deploying to AgentCore Runtime: -###### Compare payloads +**Compare payloads** @@ -357 +353 @@ If you suspect container-related issues: -###### Pull and run locally +**Pull and run locally** @@ -365 +361 @@ Test your container image on your local machine: -###### Test with curl +**Test with curl** @@ -374 +370 @@ Send test requests to your local container: -###### Check container logs +**Check container logs** @@ -376 +372 @@ Send test requests to your local container: -Examine the container's output for errors: +Examine the container’s output for errors: @@ -385 +381 @@ For MCP protocol agents, follow these specific troubleshooting steps: -###### Verify endpoint path +**Verify endpoint path** @@ -389 +385 @@ MCP servers should listen on `0.0.0.0:8000/mcp/` -###### Use MCP Inspector +**Use MCP Inspector** @@ -402 +398 @@ Test with the MCP Inspector tool: -###### Authentication issues +**Authentication issues** @@ -417 +413 @@ For bidirectional streaming using WebSocket agents, follow these specific troubl -###### Verify endpoint configuration +**Verify endpoint configuration** @@ -421 +417 @@ WebSocket agents must run on port 8080 and serve WebSocket connections at `/ws` -###### Test locally with incremental complexity +**Test locally with incremental complexity** @@ -436 +432 @@ Start with simple local testing before deploying: -###### Authentication issues +**Authentication issues** @@ -444 +440 @@ Check authentication configuration for deployed agents: - * Use the correct authentication method that matches your agent's configuration + * Use the correct authentication method that matches your agent’s configuration @@ -449 +445 @@ Check authentication configuration for deployed agents: -###### Common connection issues +**Common connection issues** @@ -460 +456 @@ Address common WebSocket connection problems: -## My code changes aren't reflected in existing sessions +## My code changes aren’t reflected in existing sessions @@ -462 +458 @@ Address common WebSocket connection problems: -###### Problem +**Problem** @@ -464 +460 @@ Address common WebSocket connection problems: -You've updated your agent runtime with new code, but existing sessions continue to use the old version. +You’ve updated your agent runtime with new code, but existing sessions continue to use the old version. @@ -466 +462 @@ You've updated your agent runtime with new code, but existing sessions continue -###### Why this happens +**Why this happens** @@ -470 +466 @@ Each microVM session is created with the code assets (`agentRuntimeArtifact`) th -###### Solution +**Solution** @@ -493 +489 @@ To access your updated code, use a new session ID. -###### Enable comprehensive logging +**Enable comprehensive logging** @@ -504 +500 @@ Implement thorough logging in your agent: -###### Use structured error handling +**Use structured error handling** @@ -515 +511 @@ Implement clear error reporting: -###### Test incremental changes +**Test incremental changes** @@ -526 +522 @@ Follow a methodical testing approach: -###### Monitor performance +**Monitor performance**