Amazon Bedrock Register Tools activity

Introduction

An Amazon Bedrock Register Tools activity, using its Amazon Bedrock connection, registers tools for use with Amazon Bedrock's supported models. The activity supports Amazon, Anthropic, Cohere, and Meta models only and is intended to be used as a target to consume data in an operation.

Prerequisites

To successfully use this activity, you must have the following AWS IAM account permissions:

bedrock:ListFoundationModels
bedrock:GetFoundationModel
bedrock:InvokeModel

Create an Amazon Bedrock Register Tools activity

An instance of an Amazon Bedrock Register Tools activity is created from an Amazon Bedrock connection using its Register Tools activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Creating an activity instance in Component reuse.

An existing Amazon Bedrock Register Tools activity can be edited from these locations:

The design canvas (see Component actions menu in Design canvas).
The project pane's Components tab (see Component actions menu in Project pane Components tab).

Configure an Amazon Bedrock Register Tools activity

Follow these steps to configure an Amazon Bedrock Register Tools activity:

Step 1: Enter a name and specify settings
Provide a name for the activity, select a model, and specify optional settings.
Step 2: Review the data schemas
Any request or response schemas are displayed.

Step 1: Enter a name and specify settings

In this step, provide a name for the activity, select a model, and specify optional settings. Each user interface element of this step is described below.

Amazon Bedrock Register Tools activity configuration step 1

Name: Enter a name to identify the activity. The name must be unique for each Amazon Bedrock Register Tools activity and must not contain forward slashes / or colons :.
List all models: Select this option to choose from a list of models retrieved from Amazon Bedrock:
- Select a model: This section displays supported Amazon, Anthropic, Cohere, and Meta models available in Amazon Bedrock.
  
  Note
  
  Only models that support tool use are displayed.
  - Selected model: After a model is selected, it is listed here.
  - Search: Enter any column's value into the search box to filter the list of models. The search is not case-sensitive. If models are already displayed within the table, the table results are filtered in real time with each keystroke. To reload models from the endpoint when searching, enter search criteria and then refresh, as described below.
  - Refresh: Click the refresh icon or the word Refresh to reload models from the Amazon Bedrock endpoint. This may be useful if models have been added to Amazon Bedrock. This action refreshes all metadata used to build the table of models displayed in the configuration.
  - Selecting a model: Within the table, click anywhere on a row to select a model. Only one model can be selected. The information available for each model is fetched from the Amazon Bedrock endpoint:
    - Model Identifier: The model ID.
    - Model Provider: The provider of the model.
    - Model Name: The name of the model.
  Tip
  
  If the table does not populate with available models, the Amazon Bedrock connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.
  
  Alternatively, the model can be specified in the Model identifier field or provided in the request transformation. If a model is specified in multiple places, this order of precedence is followed:
  1. A model provided in the request transformation overrides all fields below.
  2. A model specified in the Model identifier field overrides the remaining field below, even if List all models is selected.
  3. A model selected in the Select a model list has the least precedence.
  4. Prompt: Enter an initial prompt for the model. The prompt should set the foundational context and guidelines for the model's responses.
Enter model identifier: Select this option to manually enter the identifier of a supported Amazon, Anthropic, Cohere, or Meta model in Amazon Bedrock:
- Model identifier: Enter the model ID, for example amazon.nova-lite-v1:0.
- Prompt: Enter an initial prompt for the model. The prompt should set the foundational context and guidelines for the model's responses.
Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.
Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.
Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Review the data schemas

Any request or response schemas are displayed. Each user interface element of this step is described below.

Amazon Bedrock Register Tools activity configuration step 2

Data schema: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.

The Amazon Bedrock connector uses the Amazon Bedrock API. Refer to the API documentation for information on the schema nodes and fields.
Refresh: Click the refresh icon or the word Refresh to regenerate schemas from the Amazon Bedrock endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.
Back: Click to temporarily store the configuration for this step and return to the previous step.
Finished: Click to save the configuration for all steps and close the activity configuration.
Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Troubleshooting

You might encounter the following error when executing activities:

Invocation of model ID <model-name> with on-demand throughput isn't supported. Retry your request with the ID or ARN of an inference profile that contains this model.

This error occurs because some models are only supported in specific regions, which requires adding the region prefix to the model ID For example, anthropic.claude-3-5-haiku-20241022-v1:0 becomes us-anthropic.claude-3-5-haiku-20241022-v1:0. To enter the region prefix, you must use the Enter model identifier option in step 1.

Next steps

After configuring an Amazon Bedrock Register Tools activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity actions menu in Connector basics.

Amazon Bedrock Register Tools activities can be used as a target with these operation patterns:

Transformation pattern
Two-transformation pattern (as the first or second target)

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.