Class CreateAgentActionGroupRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.bedrockagent.model.BedrockAgentRequest
software.amazon.awssdk.services.bedrockagent.model.CreateAgentActionGroupRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateAgentActionGroupRequest.Builder,CreateAgentActionGroupRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateAgentActionGroupRequest extends BedrockAgentRequest implements ToCopyableBuilder<CreateAgentActionGroupRequest.Builder,CreateAgentActionGroupRequest>

  • Method Details

    • 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 to give the action group.

      Returns:
      The name to give 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:

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

    • agentId

      public final String agentId()

      The unique identifier of the agent for which to create the action group.

      Returns:
      The unique identifier of the agent for which to create the action group.

    • agentVersion

      public final String agentVersion()

      The version of the agent for which to create the action group.

      Returns:
      The version of the agent for which to create 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.

    • 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()

      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:

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

    • toBuilder

      public CreateAgentActionGroupRequest.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<CreateAgentActionGroupRequest.Builder,CreateAgentActionGroupRequest>
      Specified by:
      toBuilder in class BedrockAgentRequest
      Returns:
      a builder for type T

    • builder

      public static CreateAgentActionGroupRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateAgentActionGroupRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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