Interface AgentActionGroup.Builder

All Superinterfaces:
Buildable, CopyableBuilder<AgentActionGroup.Builder,AgentActionGroup>, SdkBuilder<AgentActionGroup.Builder,AgentActionGroup>, SdkPojo
Enclosing class:
AgentActionGroup
@Mutable @NotThreadSafe public static interface AgentActionGroup.Builder extends SdkPojo, CopyableBuilder<AgentActionGroup.Builder,AgentActionGroup>

  • Method Details

    • actionGroupExecutor

      AgentActionGroup.Builder actionGroupExecutor(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • actionGroupExecutor

      default AgentActionGroup.Builder actionGroupExecutor(Consumer<ActionGroupExecutor.Builder> 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.

      This is a convenience method that creates an instance of the ActionGroupExecutor.Builder avoiding the need to create one manually via ActionGroupExecutor.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to actionGroupExecutor(ActionGroupExecutor).

      Parameters:
      actionGroupExecutor - a consumer that will call methods on ActionGroupExecutor.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • actionGroupId

      AgentActionGroup.Builder actionGroupId(String actionGroupId)

      The unique identifier of the action group.

      Parameters:
      actionGroupId - The unique identifier of the action group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • actionGroupName

      AgentActionGroup.Builder actionGroupName(String actionGroupName)

      The name of the action group.

      Parameters:
      actionGroupName - The name of the action group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • actionGroupState

      AgentActionGroup.Builder actionGroupState(String actionGroupState)

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

      Parameters:
      actionGroupState - Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • actionGroupState

      AgentActionGroup.Builder actionGroupState(ActionGroupState actionGroupState)

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

      Parameters:
      actionGroupState - Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • agentId

      AgentActionGroup.Builder agentId(String agentId)

      The unique identifier of the agent to which the action group belongs.

      Parameters:
      agentId - The unique identifier of the agent to which the action group belongs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • agentVersion

      AgentActionGroup.Builder agentVersion(String agentVersion)

      The version of the agent to which the action group belongs.

      Parameters:
      agentVersion - The version of the agent to which the action group belongs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • apiSchema

      AgentActionGroup.Builder apiSchema(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • apiSchema

      default AgentActionGroup.Builder apiSchema(Consumer<APISchema.Builder> 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.

      This is a convenience method that creates an instance of the APISchema.Builder avoiding the need to create one manually via APISchema.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to apiSchema(APISchema).

      Parameters:
      apiSchema - a consumer that will call methods on APISchema.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientToken

      AgentActionGroup.Builder clientToken(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • createdAt

      AgentActionGroup.Builder createdAt(Instant createdAt)

      The time at which the action group was created.

      Parameters:
      createdAt - The time at which the action group was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      AgentActionGroup.Builder description(String description)

      The description of the action group.

      Parameters:
      description - The description of the action group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • functionSchema

      AgentActionGroup.Builder functionSchema(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • functionSchema

      default AgentActionGroup.Builder functionSchema(Consumer<FunctionSchema.Builder> 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.

      This is a convenience method that creates an instance of the FunctionSchema.Builder avoiding the need to create one manually via FunctionSchema.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to functionSchema(FunctionSchema).

      Parameters:
      functionSchema - a consumer that will call methods on FunctionSchema.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • parentActionGroupSignatureParams

      AgentActionGroup.Builder parentActionGroupSignatureParams(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parentActionSignature

      AgentActionGroup.Builder parentActionSignature(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • parentActionSignature

      AgentActionGroup.Builder parentActionSignature(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • updatedAt

      AgentActionGroup.Builder updatedAt(Instant updatedAt)

      The time at which the action group was last updated.

      Parameters:
      updatedAt - The time at which the action group was last updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.