Package software.amazon.awscdk.services.bedrock

Interface CfnAgent.AgentActionGroupProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAgent.AgentActionGroupProperty.Jsii$Proxy

Enclosing class:

CfnAgent

@Stability(Stable)
public static interface CfnAgent.AgentActionGroupProperty
extends software.amazon.jsii.JsiiSerializable

Contains details about an action group.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.bedrock.*;
 AgentActionGroupProperty agentActionGroupProperty = AgentActionGroupProperty.builder()
         .actionGroupName("actionGroupName")
         // the properties below are optional
         .actionGroupExecutor(ActionGroupExecutorProperty.builder()
                 .customControl("customControl")
                 .lambda("lambda")
                 .build())
         .actionGroupState("actionGroupState")
         .apiSchema(APISchemaProperty.builder()
                 .payload("payload")
                 .s3(S3IdentifierProperty.builder()
                         .s3BucketName("s3BucketName")
                         .s3ObjectKey("s3ObjectKey")
                         .build())
                 .build())
         .description("description")
         .functionSchema(FunctionSchemaProperty.builder()
                 .functions(List.of(FunctionProperty.builder()
                         .name("name")
                         // the properties below are optional
                         .description("description")
                         .parameters(Map.of(
                                 "parametersKey", ParameterDetailProperty.builder()
                                         .type("type")
                                         // the properties below are optional
                                         .description("description")
                                         .required(false)
                                         .build()))
                         .build()))
                 .build())
         .parentActionGroupSignature("parentActionGroupSignature")
         .skipResourceInUseCheckOnDelete(false)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAgent.AgentActionGroupProperty.Builder	A builder for CfnAgent.AgentActionGroupProperty
static final class	CfnAgent.AgentActionGroupProperty.Jsii$Proxy	An implementation for CfnAgent.AgentActionGroupProperty

Method Summary

Modifier and Type	Method	Description
static CfnAgent.AgentActionGroupProperty.Builder	builder()
default Object	getActionGroupExecutor()	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.
String	getActionGroupName()	The name of the action group.
default String	getActionGroupState()	Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
default Object	getApiSchema()	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.
default String	getDescription()	The description of the action group.
default Object	getFunctionSchema()	Defines functions that each define parameters that the agent needs to invoke from the user.
default String	getParentActionGroupSignature()	If this field is set as AMAZON.UserInput , the agent can request the user for additional information when trying to complete a task.
default Object	getSkipResourceInUseCheckOnDelete()	Specifies whether to delete the resource even if it's in use.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getActionGroupName

@Stability(Stable)
@NotNull
String getActionGroupName()

The name of the action group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-actiongroupname

getActionGroupExecutor

@Stability(Stable)
@Nullable
default Object getActionGroupExecutor()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-actiongroupexecutor

getActionGroupState

@Stability(Stable)
@Nullable
default String getActionGroupState()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-actiongroupstate

getApiSchema

@Stability(Stable)
@Nullable
default Object getApiSchema()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-apischema

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the action group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-description

getFunctionSchema

@Stability(Stable)
@Nullable
default Object getFunctionSchema()

Defines functions that each define parameters that the agent needs to invoke from the user.

Each function represents an action in an action group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-functionschema

getParentActionGroupSignature

@Stability(Stable)
@Nullable
default String getParentActionGroupSignature()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-parentactiongroupsignature

getSkipResourceInUseCheckOnDelete

@Stability(Stable)
@Nullable
default Object getSkipResourceInUseCheckOnDelete()

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

By default, this value is false .

Default: - false

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-skipresourceinusecheckondelete

builder

@Stability(Stable)
static CfnAgent.AgentActionGroupProperty.Builder builder()

Returns:

a CfnAgent.AgentActionGroupProperty.Builder of CfnAgent.AgentActionGroupProperty