AWS bedrock-agentcore documentation change
Summary
Updated documentation with typographical fixes (curly apostrophes), added example headers, renumbered steps in interactive sections, and adjusted formatting of IAM permissions in troubleshooting section
Security assessment
The changes are purely typographical and formatting improvements. No security vulnerabilities, weaknesses, or incidents are mentioned. The documentation continues to mention both 'no inbound auth' and JWT-based authorization options without adding new security guidance or addressing any security issues.
Diff
diff --git a/bedrock-agentcore/latest/devguide/gateway-quick-start.md b/bedrock-agentcore/latest/devguide/gateway-quick-start.md index 424ed5e3c..bfc464a79 100644 --- a//bedrock-agentcore/latest/devguide/gateway-quick-start.md +++ b//bedrock-agentcore/latest/devguide/gateway-quick-start.md @@ -5 +5 @@ -PrerequisitesStep 1: Setup and installStep 2: Create gatewayStep 3: Run the setupStep 4: Use the gateway with an agentWhat you've builtTroubleshootingQuick validationCleanupNext steps +PrerequisitesStep 1: Setup and installStep 2: Create gatewayStep 3: Run the setupStep 4: Use the gateway with an agentWhat you’ve builtTroubleshootingQuick validationCleanupNext steps @@ -9 +9 @@ PrerequisitesStep 1: Setup and installStep 2: Create gatewayStep 3: Run the setu -In this quick start guide you'll learn how to set up a gateway and integrate it into your agents using the AgentCore CLI. For more comprehensive guides and examples, see the [Amazon Bedrock AgentCore Gateway GitHub repository](https://github.com/awslabs/amazon-bedrock-agentcore-samples/tree/main/01-tutorials/02-AgentCore-gateway). +In this quick start guide you’ll learn how to set up a gateway and integrate it into your agents using the AgentCore CLI. For more comprehensive guides and examples, see the [Amazon Bedrock AgentCore Gateway GitHub repository](https://github.com/awslabs/amazon-bedrock-agentcore-samples/tree/main/01-tutorials/02-AgentCore-gateway). @@ -27 +27 @@ The AgentCore CLI provides both commands and an interactive TUI wizard for manag - * What you've built + * What you’ve built @@ -52 +52 @@ Before starting, make sure you have the following: - * **Model Access** – Enable Anthropic's Claude Sonnet 3.7 in the Amazon Bedrock console (or another model for the demo agent) + * **Model Access** – Enable Anthropic’s Claude Sonnet 3.7 in the Amazon Bedrock console (or another model for the demo agent) @@ -66 +66 @@ Create a new AgentCore project with an agent and a gateway: -AgentCore CLI +###### Example @@ -67,0 +68 @@ AgentCore CLI +AgentCore CLI @@ -70 +71 @@ AgentCore CLI - agentcore create --name MyGatewayAgent --defaults + 1. agentcore create --name MyGatewayAgent --defaults @@ -77 +81,4 @@ Interactive -You can also run `agentcore create` without flags to use the interactive wizard. The wizard guides you through selecting a project name, agent framework, model provider, and other options. + 1. You can also run `agentcore create` without flags to use the interactive wizard. The wizard guides you through selecting a project name, agent framework, model provider, and other options. + + + @@ -83 +90 @@ Add a gateway and a target to your project using the AgentCore CLI: -AgentCore CLI +###### Example @@ -84,0 +92 @@ AgentCore CLI +AgentCore CLI @@ -87 +95 @@ AgentCore CLI - # Add a gateway with no inbound auth (simplest for getting started) + 1. # Add a gateway with no inbound auth (simplest for getting started) @@ -99 +110 @@ Interactive -Run `agentcore` to open the TUI, then select **add** and choose **Gateway** : + 1. Run `agentcore` to open the TUI, then select **add** and choose **Gateway** : @@ -101 +112 @@ Run `agentcore` to open the TUI, then select **add** and choose **Gateway** : - 1. Enter the gateway name: + 2. Enter the gateway name: @@ -105 +116 @@ Run `agentcore` to open the TUI, then select **add** and choose **Gateway** : - 2. Select the authorizer type. For this quickstart, choose **NONE** : + 3. Select the authorizer type. For this quickstart, choose **NONE** : @@ -109 +120 @@ Run `agentcore` to open the TUI, then select **add** and choose **Gateway** : - 3. Configure advanced options or accept the defaults: + 4. Configure advanced options or accept the defaults: @@ -113 +124 @@ Run `agentcore` to open the TUI, then select **add** and choose **Gateway** : - 4. Review the configuration and press **Enter** to confirm: + 5. Review the configuration and press **Enter** to confirm: @@ -122 +130 @@ Next, select **add** again and choose **Gateway Target** to add a Lambda functio - 1. Enter the target name. + 6. Enter the target name. @@ -124 +132 @@ Next, select **add** again and choose **Gateway Target** to add a Lambda functio - 2. Select **Lambda function** as the target type: + 7. Select **Lambda function** as the target type: @@ -128 +136 @@ Next, select **add** again and choose **Gateway Target** to add a Lambda functio - 3. Enter the Lambda ARN and tool schema file path, then confirm. + 8. Enter the Lambda ARN and tool schema file path, then confirm. @@ -135 +143 @@ To use JWT-based authorization instead, specify `--authorizer-type CUSTOM_JWT` w -AgentCore CLI +###### Example @@ -136,0 +145 @@ AgentCore CLI +AgentCore CLI @@ -139 +148 @@ AgentCore CLI - agentcore add gateway --name TestGateway \ + 1. agentcore add gateway --name TestGateway \ @@ -148 +160 @@ Interactive -Run `agentcore` to open the TUI, then select **add** and choose **Gateway**. When prompted for the authorizer type, select **Custom JWT** : + 1. Run `agentcore` to open the TUI, then select **add** and choose **Gateway** . When prompted for the authorizer type, select **Custom JWT** : @@ -150 +162 @@ Run `agentcore` to open the TUI, then select **add** and choose **Gateway**. Whe - 1. Enter the gateway name: + 2. Enter the gateway name: @@ -154 +166 @@ Run `agentcore` to open the TUI, then select **add** and choose **Gateway**. Whe - 2. Select **Custom JWT** as the authorizer type: + 3. Select **Custom JWT** as the authorizer type: @@ -158 +170 @@ Run `agentcore` to open the TUI, then select **add** and choose **Gateway**. Whe - 3. Enter the OAuth discovery URL and allowed audience when prompted. + 4. Enter the OAuth discovery URL and allowed audience when prompted. @@ -160 +172 @@ Run `agentcore` to open the TUI, then select **add** and choose **Gateway**. Whe - 4. Configure advanced options or accept the defaults: + 5. Configure advanced options or accept the defaults: @@ -164 +176 @@ Run `agentcore` to open the TUI, then select **add** and choose **Gateway**. Whe - 5. Review the configuration and press **Enter** to confirm: + 6. Review the configuration and press **Enter** to confirm: @@ -278 +290 @@ Test your gateway by running the agent and interacting with the tools. -That's it! The agent will start and you can ask questions like: +That’s it! The agent will start and you can ask questions like: @@ -280 +292 @@ That's it! The agent will start and you can ask questions like: - * "What's the weather in Seattle?" + * "What’s the weather in Seattle?" @@ -287 +299 @@ That's it! The agent will start and you can ask questions like: -## What you've built +## What you’ve built @@ -289 +301 @@ That's it! The agent will start and you can ask questions like: -Through this getting started tutorial, you've created the following resources: +Through this getting started tutorial, you’ve created the following resources: @@ -308 +320 @@ Issue | Solution -"AccessDeniedException" | Check IAM permissions for `bedrock-agentcore:*` +"AccessDeniedException" | Check IAM permissions for bedrock-agentcore:*