Interface UpdateAgentActionGroupRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,BedrockAgentRequest.Builder,Buildable,CopyableBuilder<UpdateAgentActionGroupRequest.Builder,UpdateAgentActionGroupRequest>,SdkBuilder<UpdateAgentActionGroupRequest.Builder,UpdateAgentActionGroupRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- UpdateAgentActionGroupRequest
@Mutable @NotThreadSafe public static interface UpdateAgentActionGroupRequest.Builder extends BedrockAgentRequest.Builder, SdkPojo, CopyableBuilder<UpdateAgentActionGroupRequest.Builder,UpdateAgentActionGroupRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default UpdateAgentActionGroupRequest.BuilderactionGroupExecutor(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.UpdateAgentActionGroupRequest.BuilderactionGroupExecutor(ActionGroupExecutor actionGroupExecutor)The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.UpdateAgentActionGroupRequest.BuilderactionGroupId(String actionGroupId)The unique identifier of the action group.UpdateAgentActionGroupRequest.BuilderactionGroupName(String actionGroupName)Specifies a new name for the action group.UpdateAgentActionGroupRequest.BuilderactionGroupState(String actionGroupState)Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.UpdateAgentActionGroupRequest.BuilderactionGroupState(ActionGroupState actionGroupState)Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.UpdateAgentActionGroupRequest.BuilderagentId(String agentId)The unique identifier of the agent for which to update the action group.UpdateAgentActionGroupRequest.BuilderagentVersion(String agentVersion)The unique identifier of the agent version for which to update the action group.default UpdateAgentActionGroupRequest.BuilderapiSchema(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.UpdateAgentActionGroupRequest.BuilderapiSchema(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.UpdateAgentActionGroupRequest.Builderdescription(String description)Specifies a new name for the action group.default UpdateAgentActionGroupRequest.BuilderfunctionSchema(Consumer<FunctionSchema.Builder> functionSchema)Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.UpdateAgentActionGroupRequest.BuilderfunctionSchema(FunctionSchema functionSchema)Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.UpdateAgentActionGroupRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)UpdateAgentActionGroupRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)UpdateAgentActionGroupRequest.BuilderparentActionGroupSignature(String parentActionGroupSignature)Update the built-in or computer use action for this action group.UpdateAgentActionGroupRequest.BuilderparentActionGroupSignature(ActionGroupSignature parentActionGroupSignature)Update the built-in or computer use action for this action group.UpdateAgentActionGroupRequest.BuilderparentActionGroupSignatureParams(Map<String,String> parentActionGroupSignatureParams)The configuration settings for a computer use action.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.services.bedrockagent.model.BedrockAgentRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
agentId
UpdateAgentActionGroupRequest.Builder agentId(String agentId)
The unique identifier of the agent for which to update the action group.
- Parameters:
agentId- The unique identifier of the agent for which to update the action group.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
agentVersion
UpdateAgentActionGroupRequest.Builder agentVersion(String agentVersion)
The unique identifier of the agent version for which to update the action group.
- Parameters:
agentVersion- The unique identifier of the agent version for which to update the action group.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
actionGroupId
UpdateAgentActionGroupRequest.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
UpdateAgentActionGroupRequest.Builder actionGroupName(String actionGroupName)
Specifies a new name for the action group.
- Parameters:
actionGroupName- Specifies a new name for the action group.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
UpdateAgentActionGroupRequest.Builder description(String description)
Specifies a new name for the action group.
- Parameters:
description- Specifies a new name for the action group.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
parentActionGroupSignature
UpdateAgentActionGroupRequest.Builder parentActionGroupSignature(String parentActionGroupSignature)
Update the built-in or computer use action for this action group. If you specify a value, you must leave the
description,apiSchema, andactionGroupExecutorfields 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.
-
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.
- Parameters:
parentActionGroupSignature- Update the built-in or computer use action for this action group. If you specify a value, you must leave thedescription,apiSchema, andactionGroupExecutorfields 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.
-
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ActionGroupSignature,ActionGroupSignature
-
-
parentActionGroupSignature
UpdateAgentActionGroupRequest.Builder parentActionGroupSignature(ActionGroupSignature parentActionGroupSignature)
Update the built-in or computer use action for this action group. If you specify a value, you must leave the
description,apiSchema, andactionGroupExecutorfields 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.
-
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.
- Parameters:
parentActionGroupSignature- Update the built-in or computer use action for this action group. If you specify a value, you must leave thedescription,apiSchema, andactionGroupExecutorfields 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.
-
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ActionGroupSignature,ActionGroupSignature
-
-
parentActionGroupSignatureParams
UpdateAgentActionGroupRequest.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.
-
actionGroupExecutor
UpdateAgentActionGroupRequest.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.
- Parameters:
actionGroupExecutor- The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
actionGroupExecutor
default UpdateAgentActionGroupRequest.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.
This is a convenience method that creates an instance of theActionGroupExecutor.Builderavoiding the need to create one manually viaActionGroupExecutor.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toactionGroupExecutor(ActionGroupExecutor).- Parameters:
actionGroupExecutor- a consumer that will call methods onActionGroupExecutor.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
actionGroupExecutor(ActionGroupExecutor)
-
actionGroupState
UpdateAgentActionGroupRequest.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,ActionGroupState
-
actionGroupState
UpdateAgentActionGroupRequest.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:
ActionGroupState,ActionGroupState
-
apiSchema
UpdateAgentActionGroupRequest.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 UpdateAgentActionGroupRequest.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 theAPISchema.Builderavoiding the need to create one manually viaAPISchema.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toapiSchema(APISchema).- Parameters:
apiSchema- a consumer that will call methods onAPISchema.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
apiSchema(APISchema)
-
functionSchema
UpdateAgentActionGroupRequest.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 UpdateAgentActionGroupRequest.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 theFunctionSchema.Builderavoiding the need to create one manually viaFunctionSchema.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tofunctionSchema(FunctionSchema).- Parameters:
functionSchema- a consumer that will call methods onFunctionSchema.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
functionSchema(FunctionSchema)
-
overrideConfiguration
UpdateAgentActionGroupRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
UpdateAgentActionGroupRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-