Update Agent Action Group

bedrockagent_update_agent_action_group

R Documentation

Updates the configuration for an action group for an agent

Description

Updates the configuration for an action group for an agent.

Usage

bedrockagent_update_agent_action_group(actionGroupExecutor,
  actionGroupId, actionGroupName, actionGroupState, agentId, agentVersion,
  apiSchema, description, functionSchema, parentActionGroupSignature)

Arguments

actionGroupExecutor

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

actionGroupId

[required] The unique identifier of the action group.

actionGroupName

[required] Specifies a new name for the action group.

actionGroupState

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

agentId

[required] The unique identifier of the agent for which to update the action group.

agentVersion

[required] The unique identifier of the agent version for which to update the action group.

apiSchema

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.

description

Specifies a new name for the action group.

functionSchema

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

parentActionGroupSignature

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.

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.

Value

A list with the following syntax:

list(
  agentActionGroup = list(
    actionGroupExecutor = list(
      customControl = "RETURN_CONTROL",
      lambda = "string"
    ),
    actionGroupId = "string",
    actionGroupName = "string",
    actionGroupState = "ENABLED"|"DISABLED",
    agentId = "string",
    agentVersion = "string",
    apiSchema = list(
      payload = "string",
      s3 = list(
        s3BucketName = "string",
        s3ObjectKey = "string"
      )
    ),
    clientToken = "string",
    createdAt = as.POSIXct(
      "2015-01-01"
    ),
    description = "string",
    functionSchema = list(
      functions = list(
        list(
          description = "string",
          name = "string",
          parameters = list(
            list(
              description = "string",
              required = TRUE|FALSE,
              type = "string"|"number"|"integer"|"boolean"|"array"
            )
          ),
          requireConfirmation = "ENABLED"|"DISABLED"
        )
      )
    ),
    parentActionSignature = "AMAZON.UserInput"|"AMAZON.CodeInterpreter",
    updatedAt = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax

svc$update_agent_action_group(
  actionGroupExecutor = list(
    customControl = "RETURN_CONTROL",
    lambda = "string"
  ),
  actionGroupId = "string",
  actionGroupName = "string",
  actionGroupState = "ENABLED"|"DISABLED",
  agentId = "string",
  agentVersion = "string",
  apiSchema = list(
    payload = "string",
    s3 = list(
      s3BucketName = "string",
      s3ObjectKey = "string"
    )
  ),
  description = "string",
  functionSchema = list(
    functions = list(
      list(
        description = "string",
        name = "string",
        parameters = list(
          list(
            description = "string",
            required = TRUE|FALSE,
            type = "string"|"number"|"integer"|"boolean"|"array"
          )
        ),
        requireConfirmation = "ENABLED"|"DISABLED"
      )
    )
  ),
  parentActionGroupSignature = "AMAZON.UserInput"|"AMAZON.CodeInterpreter"
)