Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . bedrock-agent ]

create-agent-action-group¶

Description¶

Creates an action group for an agent. An action group represents the actions that an agent can carry out for the customer by defining the APIs that an agent can call and the logic for calling them.

To allow your agent to request the user for additional information when trying to complete a task, add an action group with the parentActionGroupSignature field set to AMAZON.UserInput .

To allow your agent to generate, run, and troubleshoot code when trying to complete a task, add an action group with the parentActionGroupSignature field set to AMAZON.CodeInterpreter .

You must leave the description , apiSchema , and actionGroupExecutor fields blank for this action group. During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.

Synopsis¶

  create-agent-action-group
[--action-group-executor <value>]
--action-group-name <value>
[--action-group-state <value>]
--agent-id <value>
--agent-version <value>
[--api-schema <value>]
[--client-token <value>]
[--description <value>]
[--function-schema <value>]
[--parent-action-group-signature <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options¶

--action-group-executor (tagged union structure)

The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: customControl, lambda.

customControl -> (string)

To return the action group invocation results directly in the InvokeAgent response, specify RETURN_CONTROL .

lambda -> (string)

The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.

Shorthand Syntax:

customControl=string,lambda=string

JSON Syntax:

{
  "customControl": "RETURN_CONTROL",
  "lambda": "string"
}

--action-group-name (string)

The name to give the action group.

--action-group-state (string)

Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.

Possible values:

ENABLED

DISABLED

--agent-id (string)

The unique identifier of the agent for which to create the action group.

--agent-version (string)

The version of the agent for which to create the action group.

--api-schema (tagged union structure)

Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas .

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: payload, s3.

payload -> (string)

The JSON or YAML-formatted payload defining the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas .

s3 -> (structure)

Contains details about the S3 object containing the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas .

s3BucketName -> (string)

The name of the S3 bucket.

s3ObjectKey -> (string)

The S3 object key for the S3 resource.

Shorthand Syntax:

payload=string,s3={s3BucketName=string,s3ObjectKey=string}

JSON Syntax:

{
  "payload": "string",
  "s3": {
    "s3BucketName": "string",
    "s3ObjectKey": "string"
  }
}

--client-token (string)

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency .

--description (string)

A description of the action group.

--function-schema (tagged union structure)

Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: functions.

functions -> (list)

A list of functions that each define an action in the action group.

(structure)

Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.

This data type is used in the following API operations:

CreateAgentActionGroup request

CreateAgentActionGroup response

UpdateAgentActionGroup request

UpdateAgentActionGroup response

GetAgentActionGroup response

description -> (string)

A description of the function and its purpose.

name -> (string)

A name for the function.

parameters -> (map)

The parameters that the agent elicits from the user to fulfill the function.

key -> (string)

value -> (structure)

Contains details about a parameter in a function for an action group.

This data type is used in the following API operations:

CreateAgentActionGroup request

CreateAgentActionGroup response

UpdateAgentActionGroup request

UpdateAgentActionGroup response

GetAgentActionGroup response

description -> (string)

A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.

required -> (boolean)

Whether the parameter is required for the agent to complete the function for action group invocation.

type -> (string)

The data type of the parameter.

requireConfirmation -> (string)

Contains information if user confirmation is required to invoke the function.

JSON Syntax:

{
  "functions": [
    {
      "description": "string",
      "name": "string",
      "parameters": {"string": {
            "description": "string",
            "required": true|false,
            "type": "string"|"number"|"integer"|"boolean"|"array"
          }
        ...},
      "requireConfirmation": "ENABLED"|"DISABLED"
    }
    ...
  ]
}

--parent-action-group-signature (string)

To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput . You must leave the description , apiSchema , and actionGroupExecutor fields blank for this action group.

To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter . You must leave the description , apiSchema , and actionGroupExecutor fields blank for this action group.

During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.

Possible values:

AMAZON.UserInput

AMAZON.CodeInterpreter

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output¶

agentActionGroup -> (structure)

Contains details about the action group that was created.

actionGroupExecutor -> (tagged union structure)

The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: customControl, lambda.

customControl -> (string)

To return the action group invocation results directly in the InvokeAgent response, specify RETURN_CONTROL .

lambda -> (string)

The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.

actionGroupId -> (string)

The unique identifier of the action group.

actionGroupName -> (string)

The name of the action group.

actionGroupState -> (string)

Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.

agentId -> (string)

The unique identifier of the agent to which the action group belongs.

agentVersion -> (string)

The version of the agent to which the action group belongs.

apiSchema -> (tagged union structure)

Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas .

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: payload, s3.

payload -> (string)

The JSON or YAML-formatted payload defining the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas .

s3 -> (structure)

Contains details about the S3 object containing the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas .

s3BucketName -> (string)

The name of the S3 bucket.

s3ObjectKey -> (string)

The S3 object key for the S3 resource.

clientToken -> (string)

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency .

createdAt -> (timestamp)

The time at which the action group was created.

description -> (string)

The description of the action group.

functionSchema -> (tagged union structure)

Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: functions.

functions -> (list)

A list of functions that each define an action in the action group.

(structure)

Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.

This data type is used in the following API operations:

CreateAgentActionGroup request

CreateAgentActionGroup response

UpdateAgentActionGroup request

UpdateAgentActionGroup response

GetAgentActionGroup response

description -> (string)

A description of the function and its purpose.

name -> (string)

A name for the function.

parameters -> (map)

The parameters that the agent elicits from the user to fulfill the function.

key -> (string)

value -> (structure)

Contains details about a parameter in a function for an action group.

This data type is used in the following API operations:

CreateAgentActionGroup request

CreateAgentActionGroup response

UpdateAgentActionGroup request

UpdateAgentActionGroup response

GetAgentActionGroup response

description -> (string)

A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.

required -> (boolean)

Whether the parameter is required for the agent to complete the function for action group invocation.

type -> (string)

The data type of the parameter.

requireConfirmation -> (string)

Contains information if user confirmation is required to invoke the function.

parentActionSignature -> (string)

If this field is set as AMAZON.UserInput , the agent can request the user for additional information when trying to complete a task. The description , apiSchema , and actionGroupExecutor fields must be blank for this action group.

During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.

updatedAt -> (timestamp)

The time at which the action group was last updated.

Table Of Contents

Feedback

User Guide

Note:

create-agent-action-group¶

Description¶

Synopsis¶

Options¶

Note

Note

Note

Global Options¶

Output¶

Note

Note

Note