java.lang.Object
- software.amazon.awssdk.services.bedrockagent.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 about an 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.
`String`	`actionGroupId()`	The unique identifier of the action group.
`String`	`actionGroupName()`	The name of the action group.
`ActionGroupState`	`actionGroupState()`	Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
`String`	`actionGroupStateAsString()`	Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
`String`	`agentId()`	The unique identifier of the agent to which the action group belongs.
`String`	`agentVersion()`	The version of the agent to which the action group belongs.
`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`	`clientToken()`	A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
`Instant`	`createdAt()`	The time at which the action group was created.
`String`	`description()`	The description of the action group.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`FunctionSchema`	`functionSchema()`	Defines functions that each define parameters that the agent needs to invoke from the user.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`ActionGroupSignature`	`parentActionSignature()`	If this field is set as `AMAZON.UserInput`, the agent can request the user for additional information when trying to complete a task.
`String`	`parentActionSignatureAsString()`	If this field is set as `AMAZON.UserInput`, the agent can request the user for additional information when trying to complete a task.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AgentActionGroup.Builder>`	`serializableBuilderClass()`
`AgentActionGroup.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Instant`	`updatedAt()`	The time at which the action group was last updated.

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.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
  - actionGroupId
```
public final String actionGroupId()
```
    The unique identifier of the action group.
    
    Returns:
    
    The unique identifier of the action group.
  - actionGroupName
```
public final String actionGroupName()
```
    The name of the action group.
    
    Returns:
    
    The name of the action group.
  - actionGroupState
```
public final ActionGroupState actionGroupState()
```
    Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
    
    If the service returns an enum value that is not available in the current SDK version, actionGroupState will return ActionGroupState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionGroupStateAsString().
    
    Returns:
    
    Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
    
    See Also:
    
    ActionGroupState
  - actionGroupStateAsString
```
public final String actionGroupStateAsString()
```
    Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
    
    If the service returns an enum value that is not available in the current SDK version, actionGroupState will return ActionGroupState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionGroupStateAsString().
    
    Returns:
    
    Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
    
    See Also:
    
    ActionGroupState
  - agentId
```
public final String agentId()
```
    The unique identifier of the agent to which the action group belongs.
    
    Returns:
    
    The unique identifier of the agent to which the action group belongs.
  - agentVersion
```
public final String agentVersion()
```
    The version of the agent to which the action group belongs.
    
    Returns:
    
    The version of the agent to which the action group belongs.
  - 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.
  - clientToken
```
public final String clientToken()
```
    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.
    
    Returns:
    
    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
```
public final Instant createdAt()
```
    The time at which the action group was created.
    
    Returns:
    
    The time at which the action group was created.
  - description
```
public final String description()
```
    The description of the action group.
    
    Returns:
    
    The description of the action group.
  - functionSchema
```
public final FunctionSchema functionSchema()
```
    Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
    
    Returns:
    
    Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
  - parentActionSignature
```
public final ActionGroupSignature parentActionSignature()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, parentActionSignature will return ActionGroupSignature.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from parentActionSignatureAsString().
    
    Returns:
    
    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:
    
    ActionGroupSignature
  - parentActionSignatureAsString
```
public final String parentActionSignatureAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, parentActionSignature will return ActionGroupSignature.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from parentActionSignatureAsString().
    
    Returns:
    
    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:
    
    ActionGroupSignature
  - updatedAt
```
public final Instant updatedAt()
```
    The time at which the action group was last updated.
    
    Returns:
    
    The time at which the action group was last updated.
  - 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

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

actionGroupId

actionGroupName

actionGroupState

actionGroupStateAsString

agentId

agentVersion

apiSchema

clientToken

createdAt

description

functionSchema

parentActionSignature

parentActionSignatureAsString

updatedAt

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields