interface AgentActionGroupProperty

Language	Type name
.NET	`Amazon.CDK.aws_bedrock.CfnAgent.AgentActionGroupProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsbedrock#CfnAgent_AgentActionGroupProperty`
Java	`software.amazon.awscdk.services.bedrock.CfnAgent.AgentActionGroupProperty`
Python	`aws_cdk.aws_bedrock.CfnAgent.AgentActionGroupProperty`
TypeScript	`aws-cdk-lib` » `aws_bedrock` » `CfnAgent` » `AgentActionGroupProperty`

Contains details of the inline agent's action group.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_bedrock as bedrock } from 'aws-cdk-lib';
const agentActionGroupProperty: bedrock.CfnAgent.AgentActionGroupProperty = {
  actionGroupName: 'actionGroupName',

  // the properties below are optional
  actionGroupExecutor: {
    customControl: 'customControl',
    lambda: 'lambda',
  },
  actionGroupState: 'actionGroupState',
  apiSchema: {
    payload: 'payload',
    s3: {
      s3BucketName: 's3BucketName',
      s3ObjectKey: 's3ObjectKey',
    },
  },
  description: 'description',
  functionSchema: {
    functions: [{
      name: 'name',

      // the properties below are optional
      description: 'description',
      parameters: {
        parametersKey: {
          type: 'type',

          // the properties below are optional
          description: 'description',
          required: false,
        },
      },
      requireConfirmation: 'requireConfirmation',
    }],
  },
  parentActionGroupSignature: 'parentActionGroupSignature',
  skipResourceInUseCheckOnDelete: false,
};

Properties

Name	Type	Description
actionGroupName	`string`	The name of the action group.
actionGroupExecutor?	`IResolvable` `\|` `ActionGroupExecutorProperty`	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.
actionGroupState?	`string`	Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
apiSchema?	`IResolvable` `\|` `APISchemaProperty`	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.
description?	`string`	A description of the action group.
functionSchema?	`IResolvable` `\|` `FunctionSchemaProperty`	Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
parentActionGroupSignature?	`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.
skipResourceInUseCheckOnDelete?	`boolean \|` `IResolvable`	Specifies whether to delete the resource even if it's in use.

actionGroupName

Type: string

The name of the action group.

actionGroupExecutor?

Type: IResolvable | ActionGroupExecutorProperty (optional)

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.

actionGroupState?

Type: string (optional)

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

apiSchema?

Type: IResolvable | APISchemaProperty (optional)

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?

Type: string (optional)

A description of the action group.

functionSchema?

Type: IResolvable | FunctionSchemaProperty (optional)

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

parentActionGroupSignature?

Type: string (optional)

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.

skipResourceInUseCheckOnDelete?

Type: boolean | IResolvable (optional, default: false)

Specifies whether to delete the resource even if it's in use.

By default, this value is false .