AWS bedrock-agentcore documentation change
Summary
Updated documentation to replace references from 'Amazon Bedrock AgentCore starter toolkit' to 'AgentCore CLI', including changes to installation commands, configuration file structure, deployment commands, and troubleshooting links.
Security assessment
The changes are focused on tooling migration from a starter toolkit to a new CLI tool. There is no mention of security vulnerabilities, patches, or incidents. The update includes standard configuration changes (e.g., moving from .yaml to .json, changing command names) and workflow adjustments. While the configuration file now mentions OAuth authorizer settings and execution roles, these are existing security features being documented as part of the standard configuration, not new security documentation. No evidence of addressing a specific security issue.
Diff
diff --git a/bedrock-agentcore/latest/devguide/runtime-get-started-code-deploy.md b/bedrock-agentcore/latest/devguide/runtime-get-started-code-deploy.md index 2c36477e6..f9f03a5fd 100644 --- a//bedrock-agentcore/latest/devguide/runtime-get-started-code-deploy.md +++ b//bedrock-agentcore/latest/devguide/runtime-get-started-code-deploy.md @@ -11 +11 @@ Direct code deployment enables you to bring your Python-based agent to Amazon Be -To create your deployment package as .zip file archive, you can use [Amazon Bedrock AgentCore starter toolkit](https://github.com/aws/bedrock-agentcore-starter-toolkit) or follow the steps in the _Custom zip + boto3_ tab below, or any other .zip file utility such as [7zip](https://www.7-zip.org/download.html). The examples shown in the following sections assume you're using a command-line `zip` tool in a Linux or MacOS environment. To use the same commands in Windows, you can [install the Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10) to get a Windows-integrated version of Ubuntu and Bash. +To create your deployment package as .zip file archive, you can use [AgentCore CLI](https://github.com/aws/agentcore-cli) or follow the steps in the _Custom zip + boto3_ tab below, or any other .zip file utility such as [7zip](https://www.7-zip.org/download.html). The examples shown in the following sections assume you're using a command-line `zip` tool in a Linux or MacOS environment. To use the same commands in Windows, you can [install the Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10) to get a Windows-integrated version of Ubuntu and Bash. @@ -46 +46 @@ Before you start, make sure you have: - * **AWS Permissions** : To create and deploy an agent with the starter toolkit, you must have appropriate permissions. For information, see [Use the starter toolkit](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/runtime-permissions.html#runtime-permissions-starter-toolkit). + * **AWS Permissions** : To create and deploy an agent with the AgentCore CLI, you must have appropriate permissions. For information, see [Use the AgentCore CLI](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/runtime-permissions.html#runtime-permissions-cli). @@ -66 +66 @@ Add core packages: -Add optional packages: +Install the AgentCore CLI (required for the steps that follow): @@ -69 +69 @@ Add optional packages: - uv add --dev bedrock-agentcore-starter-toolkit + npm install -g @aws/agentcore @@ -77 +77 @@ Package descriptions: - * **bedrock-agentcore-starter-toolkit** \- The Amazon Bedrock AgentCore starter toolkit + * **@aws/agentcore** \- The AgentCore CLI @@ -82 +82 @@ Package descriptions: -Optional, `uv add aws-opentelemetry-distro`, to enable [Amazon Bedrock AgentCore observability traces](https://docs.aws.amazon.com/xray/latest/devguide/xray-services-adot.html). +Optionally, run `uv add aws-opentelemetry-distro` to enable [Amazon Bedrock AgentCore observability traces](https://docs.aws.amazon.com/xray/latest/devguide/xray-services-adot.html). @@ -110 +110 @@ This command generates: - * A `requirements.txt` file with necessary dependencies + * A `pyproject.toml` file with necessary dependencies @@ -112 +112 @@ This command generates: - * A `.bedrock_agentcore.yaml` configuration file + * An `agentcore/agentcore.json` configuration file @@ -121 +121 @@ This command generates: -Make sure port 8080 is free before starting. See _Port 8080 in use (local only)_ in [Common issues and solutions](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/runtime-get-started-toolkit.html#common-issues). +Make sure port 8080 is free before starting. See _Port 8080 in use (local only)_ in [Common issues and solutions](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/runtime-get-started-cli.html#common-issues). @@ -145 +145 @@ Deploy your agent using one of the following methods: -starter toolkit +AgentCore CLI @@ -148 +148 @@ starter toolkit -The following steps will be required to deploy an agent to AgentCore Runtime, refer to [Get started with the Amazon Bedrock AgentCore starter toolkit](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/runtime-get-started-toolkit.html), for detailed steps. If Uv is available, the starter toolkit will recommend direct code deployment. Otherwise it will default to container deployment type. +The following steps will be required to deploy an agent to AgentCore Runtime, refer to [Get started with the AgentCore CLI](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/runtime-get-started-cli.html), for detailed steps. If Uv is available, the AgentCore CLI will recommend direct code deployment. Otherwise it will default to container deployment type. @@ -150 +150 @@ The following steps will be required to deploy an agent to AgentCore Runtime, re -Once you have your agent set up using `agentcore create`, use the `launch` command to create a zip deployment package, upload it to the specified bucket, and deploy the agent. +Once you have your agent set up using `agentcore create`, use the `deploy` command to create a zip deployment package, upload it to the specified bucket, and deploy the agent. @@ -153 +153 @@ Once you have your agent set up using `agentcore create`, use the `launch` comma - agentcore launch + agentcore deploy @@ -158 +158 @@ Let's prompt the agent to tell a joke! - agentcore invoke '{"prompt":"Tell me a joke"}' + agentcore invoke "Tell me a joke" @@ -164 +164 @@ The first deployment takes time to install dependencies but subsequent updates t -You can modify your agent configuration at any time using the `configure` command: +You can modify your agent configuration at any time using the `agentcore add` commands or by editing the `agentcore/agentcore.json` configuration file directly. @@ -165,0 +166 @@ You can modify your agent configuration at any time using the `configure` comman +The configuration file allows you to update deployment parameters such as your VPC configuration, execution roles, session timeouts, and OAuth authorizer settings. @@ -167 +168 @@ You can modify your agent configuration at any time using the `configure` comman - agentcore configure -e src/main.py +Interactive @@ -169 +170,6 @@ You can modify your agent configuration at any time using the `configure` comman -The command allows you to update deployment parameters such as your VPC configuration, execution roles, session timeouts, and OAuth authorizer settings. + +Run `agentcore` to open the TUI, then select **deploy**. The deploy screen shows real-time progress as it validates your project, synthesizes CloudFormation, and provisions AWS resources: + + + +After deployment completes, use `agentcore invoke` to test your agent. @@ -196 +202 @@ Add the `main.py` file and other files in your package to the root of the .zip f -After you have created your .zip deployment package, you can use it to create a new AgentCore Runtime or update an existing one. You can deploy your .zip package using AgentCore Runtime API, AgentCore Runtime console and AWS Command Line Interface. Amazon Bedrock AgentCore starter toolkit will take care of above steps to create .zip. +After you have created your .zip deployment package, you can use it to create a new AgentCore Runtime or update an existing one. You can deploy your .zip package using AgentCore Runtime API, AgentCore Runtime console and AWS Command Line Interface. The AgentCore CLI will take care of above steps to create .zip. @@ -256 +262 @@ A ZIP archive containing Linux **arm64** dependencies needs to be uploaded to S3 -To invoke an agent on Amazon Bedrock AgentCore runtime using boto3, refer: <https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/runtime-get-started-toolkit.html#invoke-programmatically> +To invoke an agent on Amazon Bedrock AgentCore runtime using boto3, refer: <https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/runtime-get-started-cli.html#invoke-programmatically> @@ -310 +316 @@ Stop your runtime session, update, or cleanup your agent using one of the follow -starter toolkit +AgentCore CLI @@ -316,4 +322 @@ To update previously deployed AgentCore Runtime, execute: - agentcore launch - -To stop the running session before the configurable `IdleRuntimeSessionTimeout` (defaulted at 15 minutes) and save on any potential runaway costs, execute: - + agentcore deploy @@ -321 +324 @@ To stop the running session before the configurable `IdleRuntimeSessionTimeout` - agentcore stop-session +To stop a running session before the configurable `IdleRuntimeSessionTimeout` (defaulted at 15 minutes) and save on any potential runaway costs, use the [StopRuntimeSession](https://docs.aws.amazon.com/bedrock-agentcore/latest/APIReference/API_StopRuntimeSession.html) API operation. The AgentCore CLI does not currently support stopping sessions directly. @@ -323 +326 @@ To stop the running session before the configurable `IdleRuntimeSessionTimeout` -To delete all resources related to a AgentCore Runtime, execute: +To delete all resources related to a AgentCore Runtime, first remove all resources and then deploy to tear down AWS resources: @@ -326 +329,2 @@ To delete all resources related to a AgentCore Runtime, execute: - agentcore destroy + agentcore remove all + agentcore deploy @@ -406 +410 @@ Following boto3 code will delete Amazon Bedrock AgentCore runtime and .zip archi - ExtraArgs={'ExpectedBucketOwner': account_id} + ExpectedBucketOwner=account_id @@ -560 +564 @@ To learn how to launch and connect to an Amazon EC2 Linux instance, see [Get sta -Common issues and solutions when getting started with the Amazon Bedrock AgentCore starter toolkit. For more troubleshooting information, see [Troubleshoot Amazon Bedrock AgentCore AgentCore Runtime](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/runtime-troubleshooting.html). +Common issues and solutions when getting started with Amazon Bedrock AgentCore direct code deployment. For more troubleshooting information, see [Troubleshoot Amazon Bedrock AgentCore AgentCore Runtime](https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/runtime-troubleshooting.html). @@ -644 +648 @@ To use the Amazon Web Services Documentation, Javascript must be enabled. Please -Get started without the starter toolkit +Get started without the AgentCore CLI