AWS bedrock-agentcore documentation change
Summary
Updated formatting and structure of the CLI getting started guide, including adding example headers, adjusting step numbering, and fixing a typo in a command example.
Security assessment
The changes are purely cosmetic and structural, focusing on improving readability and organization of the documentation. There is no mention of security vulnerabilities, patches, or new security features. The typo fix for the kill command is a minor correction but does not indicate a security issue was present.
Diff
diff --git a/bedrock-agentcore/latest/devguide/runtime-get-started-cli.md b/bedrock-agentcore/latest/devguide/runtime-get-started-cli.md index 94293ae5d..1fef67098 100644 --- a//bedrock-agentcore/latest/devguide/runtime-get-started-cli.md +++ b//bedrock-agentcore/latest/devguide/runtime-get-started-cli.md @@ -111 +111 @@ Use the `agentcore create` command to scaffold a new agent project: -AgentCore CLI +###### Example @@ -112,0 +113 @@ AgentCore CLI +AgentCore CLI @@ -114 +114,0 @@ AgentCore CLI -Pass flags directly to create a project non-interactively: @@ -115,0 +116 @@ Pass flags directly to create a project non-interactively: + 1. Pass flags directly to create a project non-interactively: @@ -124 +123,0 @@ To accept all defaults (Python, Strands, Bedrock, no memory), use the `--default -Interactive @@ -127 +125,0 @@ Interactive -Run `agentcore create` without flags to launch the interactive wizard: @@ -128,0 +127,4 @@ Run `agentcore create` without flags to launch the interactive wizard: +Interactive + + + 1. Run `agentcore create` without flags to launch the interactive wizard: @@ -132 +134 @@ Run `agentcore create` without flags to launch the interactive wizard: - 1. Enter your project name: + 2. Enter your project name: @@ -136 +138 @@ Run `agentcore create` without flags to launch the interactive wizard: - 2. Choose your agent framework and model provider: + 3. Choose your agent framework and model provider: @@ -140 +142 @@ Run `agentcore create` without flags to launch the interactive wizard: - 3. Review your configuration and confirm: + 4. Review your configuration and confirm: @@ -190,0 +193,2 @@ Start the local development server: +###### Example + @@ -193,0 +198 @@ AgentCore CLI + 1. agentcore dev @@ -195 +199,0 @@ AgentCore CLI - agentcore dev @@ -197 +200,0 @@ AgentCore CLI -Interactive @@ -200 +203,2 @@ Interactive -Run `agentcore` to open the TUI home screen, then navigate to the dev server option: +Interactive + @@ -201,0 +206 @@ Run `agentcore` to open the TUI home screen, then navigate to the dev server opt + 1. Run `agentcore` to open the TUI home screen, then navigate to the dev server option: @@ -241,0 +250,2 @@ Deploy your agent to Amazon Bedrock AgentCore Runtime: +###### Example + @@ -244,0 +255 @@ AgentCore CLI + 1. agentcore deploy @@ -246 +256,0 @@ AgentCore CLI - agentcore deploy @@ -248 +257,0 @@ AgentCore CLI -Interactive @@ -251 +260,2 @@ Interactive -Run `agentcore deploy` to start deployment. The CLI shows the deployment progress as it builds and deploys your project: +Interactive + @@ -252,0 +263 @@ Run `agentcore deploy` to start deployment. The CLI shows the deployment progres + 1. Run `agentcore deploy` to start deployment. The CLI shows the deployment progress as it builds and deploys your project: @@ -284 +298 @@ After deployment completes, invoke your deployed agent: -AgentCore CLI +###### Example @@ -285,0 +300 @@ AgentCore CLI +AgentCore CLI @@ -288 +303 @@ AgentCore CLI - agentcore invoke "Tell me a joke" + 1. agentcore invoke "Tell me a joke" @@ -300 +312,0 @@ To maintain a conversation across multiple invocations, use the `--session-id` f -Interactive @@ -303 +314,0 @@ Interactive -Run `agentcore` to open the TUI home screen, then select the invoke option to chat with your deployed agent: @@ -304,0 +316,4 @@ Run `agentcore` to open the TUI home screen, then select the invoke option to ch +Interactive + + + 1. Run `agentcore` to open the TUI home screen, then select the invoke option to chat with your deployed agent: @@ -314 +332 @@ If you see a joke in the response, your agent is running in Amazon Bedrock Agent -AgentCore CLI +###### Example @@ -315,0 +334 @@ AgentCore CLI +AgentCore CLI @@ -317 +335,0 @@ AgentCore CLI -Invoke your deployed agent with a prompt: @@ -318,0 +337 @@ Invoke your deployed agent with a prompt: + 1. Invoke your deployed agent with a prompt: @@ -329 +346,0 @@ Run `agentcore invoke` without a prompt to open the interactive chat TUI, which -AWS Python SDK (Boto3) @@ -332 +349,2 @@ AWS Python SDK (Boto3) -You can also invoke the agent using the AWS SDK [InvokeAgentRuntime](https://docs.aws.amazon.com/bedrock-agentcore/latest/APIReference/API_InvokeAgentRuntime.html) operation. To get the ARN of your deployed agent, use the `agentcore status` command: + +AWS Python SDK (Boto3) @@ -334,0 +353,2 @@ You can also invoke the agent using the AWS SDK [InvokeAgentRuntime](https://doc + 1. You can also invoke the agent using the AWS SDK [InvokeAgentRuntime](https://docs.aws.amazon.com/bedrock-agentcore/latest/APIReference/API_InvokeAgentRuntime.html) operation. To get the ARN of your deployed agent, use the `agentcore status` command: + @@ -375 +393,4 @@ If successful, you should see a joke in the response. If the call fails, check t -If you plan on integrating your agent with OAuth, you can't use the AWS SDK to call `InvokeAgentRuntime`. Instead, make a HTTPS request to `InvokeAgentRuntime`. For more information, see [Authenticate and authorize with Inbound Auth and Outbound Auth](./runtime-oauth.html). +If you plan on integrating your agent with OAuth, you can’t use the AWS SDK to call `InvokeAgentRuntime` . Instead, make a HTTPS request to `InvokeAgentRuntime` . For more information, see [Authenticate and authorize with Inbound Auth and Outbound Auth](./runtime-oauth.html). + + + @@ -380,0 +402,2 @@ If you no longer want to host the agent in Amazon Bedrock AgentCore Runtime, rem +###### Example + @@ -383,0 +407 @@ AgentCore CLI + 1. agentcore remove all @@ -385 +408,0 @@ AgentCore CLI - agentcore remove all @@ -387 +409,0 @@ AgentCore CLI -Interactive @@ -390 +412,2 @@ Interactive -Run `agentcore` to open the TUI home screen, then select the remove option to choose which resources to remove: +Interactive + @@ -391,0 +415 @@ Run `agentcore` to open the TUI home screen, then select the remove option to ch + 1. Run `agentcore` to open the TUI home screen, then select the remove option to choose which resources to remove: @@ -398,0 +426,2 @@ Then deploy again to tear down the AWS resources: +###### Example + @@ -401,0 +431,3 @@ AgentCore CLI + 1. agentcore deploy + + @@ -403 +434,0 @@ AgentCore CLI - agentcore deploy @@ -408 +439 @@ Interactive -From the AgentCore CLI home screen, select `deploy` to apply the removal and tear down AWS resources: + 1. From the AgentCore CLI home screen, select `deploy` to apply the removal and tear down AWS resources: @@ -417,0 +452,2 @@ After deployment, you can check the status of your resources by using the AgentC +###### Example + @@ -420,0 +457,2 @@ AgentCore CLI + 1. agentcore status + @@ -422 +459,0 @@ AgentCore CLI - agentcore status @@ -424 +460,0 @@ AgentCore CLI -Interactive @@ -425,0 +462 @@ Interactive +Interactive @@ -427 +463,0 @@ Interactive -Run `agentcore` and select `status` to view a live dashboard of all deployed resources: @@ -428,0 +465 @@ Run `agentcore` and select `status` to view a live dashboard of all deployed res + 1. Run `agentcore` and select `status` to view a live dashboard of all deployed resources: @@ -436 +476 @@ You can also view your resources in the AWS Console: -Resource locations Resource | Location +Resource | Location @@ -468 +508 @@ Enable model access in the Bedrock console: - * Make sure you're in the correct AWS Region (us-west-2 by default) + * Make sure you’re in the correct AWS Region (us-west-2 by default) @@ -494 +534 @@ Use `lsof -ti:8080` to get a list of processes using port 8080. -Use `kill -9 `PID`` to stop the process. Replace `PID` with the process ID. +Use `kill -9 PID` to stop the process. Replace `PID` with the process ID.