Interface CreateAgentActionGroupRequest.Builder

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

  • Method Details

    • agentId

      CreateAgentActionGroupRequest.Builder agentId(String agentId)

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

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

    • agentVersion

      CreateAgentActionGroupRequest.Builder agentVersion(String agentVersion)

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

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

    • actionGroupName

      CreateAgentActionGroupRequest.Builder actionGroupName(String actionGroupName)

      The name to give the action group.

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

    • clientToken

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

    • description

      CreateAgentActionGroupRequest.Builder description(String description)

      A description of the action group.

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

    • parentActionGroupSignature

      CreateAgentActionGroupRequest.Builder parentActionGroupSignature(String parentActionGroupSignature)

      Specify a built-in or computer use action for this action group. If you specify a value, you must leave the description, apiSchema, and actionGroupExecutor fields empty for this action group.

      • To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput.

      • To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter.

      • To allow your agent to use an Anthropic computer use tool, specify one of the following values.

        Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. When operating computer use functionality, we recommend taking additional security precautions, such as executing computer actions in virtual environments with restricted data access and limited internet connectivity. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.

        • ANTHROPIC.Computer - Gives the agent permission to use the mouse and keyboard and take screenshots.

        • ANTHROPIC.TextEditor - Gives the agent permission to view, create and edit files.

        • ANTHROPIC.Bash - Gives the agent permission to run commands in a bash shell.

      Parameters:
      parentActionGroupSignature - Specify a built-in or computer use action for this action group. If you specify a value, you must leave the description, apiSchema, and actionGroupExecutor fields empty for this action group.

      • To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput.

      • To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter.

      • To allow your agent to use an Anthropic computer use tool, specify one of the following values.

        Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. When operating computer use functionality, we recommend taking additional security precautions, such as executing computer actions in virtual environments with restricted data access and limited internet connectivity. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.

        • ANTHROPIC.Computer - Gives the agent permission to use the mouse and keyboard and take screenshots.

        • ANTHROPIC.TextEditor - Gives the agent permission to view, create and edit files.

        • ANTHROPIC.Bash - Gives the agent permission to run commands in a bash shell.

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

    • parentActionGroupSignature

      CreateAgentActionGroupRequest.Builder parentActionGroupSignature(ActionGroupSignature parentActionGroupSignature)

      Specify a built-in or computer use action for this action group. If you specify a value, you must leave the description, apiSchema, and actionGroupExecutor fields empty for this action group.

      • To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput.

      • To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter.

      • To allow your agent to use an Anthropic computer use tool, specify one of the following values.

        Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. When operating computer use functionality, we recommend taking additional security precautions, such as executing computer actions in virtual environments with restricted data access and limited internet connectivity. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.

        • ANTHROPIC.Computer - Gives the agent permission to use the mouse and keyboard and take screenshots.

        • ANTHROPIC.TextEditor - Gives the agent permission to view, create and edit files.

        • ANTHROPIC.Bash - Gives the agent permission to run commands in a bash shell.

      Parameters:
      parentActionGroupSignature - Specify a built-in or computer use action for this action group. If you specify a value, you must leave the description, apiSchema, and actionGroupExecutor fields empty for this action group.

      • To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput.

      • To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter.

      • To allow your agent to use an Anthropic computer use tool, specify one of the following values.

        Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. When operating computer use functionality, we recommend taking additional security precautions, such as executing computer actions in virtual environments with restricted data access and limited internet connectivity. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.

        • ANTHROPIC.Computer - Gives the agent permission to use the mouse and keyboard and take screenshots.

        • ANTHROPIC.TextEditor - Gives the agent permission to view, create and edit files.

        • ANTHROPIC.Bash - Gives the agent permission to run commands in a bash shell.

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

    • parentActionGroupSignatureParams

      CreateAgentActionGroupRequest.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 Anthropic 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 Anthropic 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.

    • actionGroupExecutor

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

    • apiSchema

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

    • actionGroupState

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

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

    • functionSchema

      CreateAgentActionGroupRequest.Builder functionSchema(FunctionSchema functionSchema)

      Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.

      Parameters:
      functionSchema - Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • functionSchema

      default CreateAgentActionGroupRequest.Builder functionSchema(Consumer<FunctionSchema.Builder> functionSchema)

      Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.

      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:

    • overrideConfiguration

      CreateAgentActionGroupRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateAgentActionGroupRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.