Package software.amazon.awssdk.services.bedrockagent.model

Interface UpdateAgentActionGroupRequest.Builder

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

  • Method Details

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

      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.

    • 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

      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:

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

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

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

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

    • parentActionGroupSignature

      UpdateAgentActionGroupRequest.Builder parentActionGroupSignature(String 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.

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

      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:

    • parentActionGroupSignature

      UpdateAgentActionGroupRequest.Builder parentActionGroupSignature(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.

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

      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:

    • overrideConfiguration

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

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