java.lang.Object
- software.amazon.awssdk.services.bedrockagentruntime.model.AgentActionGroup

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<AgentActionGroup.Builder,AgentActionGroup>

@Generated("software.amazon.awssdk:codegen")
public final class AgentActionGroup
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AgentActionGroup.Builder,AgentActionGroup>

Contains details of the inline agent's action group.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface AgentActionGroup.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ActionGroupExecutor`	`actionGroupExecutor()`	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`	`actionGroupName()`	The name of the action group.
`APISchema`	`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.
`static AgentActionGroup.Builder`	`builder()`
`String`	`description()`	A description of the action group.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`FunctionSchema`	`functionSchema()`	Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`ActionGroupSignature`	`parentActionGroupSignature()`	To allow your agent to request the user for additional information when trying to complete a task, set this field to `AMAZON.UserInput`.
`String`	`parentActionGroupSignatureAsString()`	To allow your agent to request the user for additional information when trying to complete a task, set this field to `AMAZON.UserInput`.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AgentActionGroup.Builder>`	`serializableBuilderClass()`
`AgentActionGroup.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - actionGroupExecutor
```
public final ActionGroupExecutor actionGroupExecutor()
```
    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.
    
    Returns:
    
    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.
  - actionGroupName
```
public final String actionGroupName()
```
    The name of the action group.
    
    Returns:
    
    The name of the action group.
  - apiSchema
```
public final APISchema 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.
    
    Returns:
    
    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
```
public final String description()
```
    A description of the action group.
    
    Returns:
    
    A description of the action group.
  - functionSchema
```
public final FunctionSchema functionSchema()
```
    Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
    
    Returns:
    
    Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
  - parentActionGroupSignature
```
public final ActionGroupSignature 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.
    
    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.
    
    If the service returns an enum value that is not available in the current SDK version, parentActionGroupSignature will return ActionGroupSignature.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from parentActionGroupSignatureAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    ActionGroupSignature
  - parentActionGroupSignatureAsString
```
public final String parentActionGroupSignatureAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, parentActionGroupSignature will return ActionGroupSignature.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from parentActionGroupSignatureAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    ActionGroupSignature
  - toBuilder
```
public AgentActionGroup.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AgentActionGroup.Builder,AgentActionGroup>
  - builder
```
public static AgentActionGroup.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AgentActionGroup.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class AgentActionGroup

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

actionGroupExecutor

actionGroupName

apiSchema

description

functionSchema

parentActionGroupSignature

parentActionGroupSignatureAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField