Class AgentActionGroup

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:

  • Method Details

    • 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.

    • 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.

    • 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.

    • description

      public final String description()

      The description of the action group.

      Returns:
      The description of the action group.

    • createdAt

      public final Instant createdAt()

      The time at which the action group was created.

      Returns:
      The time at which the action group was created.

    • 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.

    • 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:

    • 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:

    • hasParentActionGroupSignatureParams

      public final boolean hasParentActionGroupSignatureParams()
      For responses, this returns true if the service returned a value for the ParentActionGroupSignatureParams property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • parentActionGroupSignatureParams

      public final Map<String,String> parentActionGroupSignatureParams()

      The configuration settings for a computer use action.

      Computer use is a new Anthropic Claude model capability (in beta) available with Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasParentActionGroupSignatureParams() method.

      Returns:
      The configuration settings for a computer use action.

      Computer use is a new Anthropic Claude model capability (in beta) available with Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.

    • 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.

    • 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.

    • 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.

    • 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:

    • 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:

    • toBuilder

      public AgentActionGroup.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<AgentActionGroup.Builder,AgentActionGroup>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.