Deploy and integrate an Amazon Bedrock agent into your application - Amazon Bedrock

Deploy and integrate an Amazon Bedrock agent into your application

When you first create an Amazon Bedrock agent, you have a working draft version (DRAFT) and a test alias (TSTALIASID) that points to the working draft version. When you make changes to your agent, the changes apply to the working draft. You iterate on your working draft until you're satisfied with the behavior of your agent. Then, you can set up your agent for deployment and integration into your application by creating aliases of your agent.

To deploy your agent, you must create an alias. During alias creation, Amazon Bedrock creates a version of your agent automatically. The alias points to this newly created version. Alternatively, you can point the alias to a previously created version of your agent. Then, you configure your application to make API calls to that alias.

A version is a snapshot that preserves the resource as it exists at the time it was created. You can continue to modify the working draft and create new aliases (and consequently, versions) of your agent as necessary. In Amazon Bedrock, you create a new version of your agent by creating an alias that points to the new version by default. Amazon Bedrock creates versions in numerical order, starting from 1.

Versions are immutable because they act as a snapshot of your agent at the time you created it. To make updates to an agent in production, you must create a new version and set up your application to make calls to the alias that points to that version.

With aliases, you can switch efficiently between different versions of your agent without requiring the application to keep track of the version. For example, you can change an alias to point to a previous version of your agent if there are changes that you need to revert quickly.

To deploy your agent

  1. Create an alias and version of your agent. Choose the tab for your preferred method, and then follow the steps:

    Console
    To create an alias (and optionally a new version)

    1. Sign in to the AWS Management Console using an IAM role with Amazon Bedrock permissions, and open the Amazon Bedrock console at https://console.aws.amazon.com/bedrock/.

    2. Select Agents from the left navigation pane. Then, choose an agent in the Agents section.

    3. In the Aliases section, choose Create.

    4. Enter a unique Alias name and provide an optional Description.

    5. Under Associate a version, choose one of the following options:

      • To create a new version, choose Create a new version and to associate it to this alias.

      • To use an existing version, choose Use an existing version to associate this alias. From the dropdown menu, choose the version that you want to associate the alias to.

    6. Under Select throughput, select one of the following options:

    7. Select Create alias.

    API

    To create an alias for an agent, send a CreateAgentAlias request with an Agents for Amazon Bedrock build-time endpoint.

    The following fields are required:

    Field Use case
    agentId To specify the ID of the agent for which to create an alias.
    agentName To specify a name for the alias.

    The following fields are optional:

    Field Use case
    description To provide a description of the alias.
    routingConfiguration To specify a version to associate the alias with (leave blank to create a new version) and a Provisioned Throughput to associate with the alias.
    clientToken To ensure the API request completes only once. For more information, see Ensuring idempotency.
    tags To associate tags with the alias.

    See code examples

  2. Deploy your agent by setting up your application to make an InvokeAgent request with an Agents for Amazon Bedrock runtime endpoint. In the agentAliasId field, specify the ID of the alias pointing to the version of the agent that you want to use.

    The InvokeAgent response stream contains multiple events with chunks for each part of the response in order. You can optionally enable streaming by setting the streamFinalResponse to true in streaming configurations.

    • If your agent is configured with a Guardrail, you can also specify the applyGuardrailInterval in the StreamingConfigurations, to control how often an ApplyGuardrail call is made on outgoing response characters (for example, every 50 chars)

    • Response streaming is currently only supported with the Orchestration prompt.

    • Citations are not currently supported with streaming.

    • Ensure the Agent execution role includes the bedrock:InvokeModelWithResponseStream permission for the configured Agent model.