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

Interface UpdateAgentRequest.Builder

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

  • Method Details

    • agentId

      UpdateAgentRequest.Builder agentId(String agentId)

      The unique identifier of the agent.

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

    • agentName

      UpdateAgentRequest.Builder agentName(String agentName)

      Specifies a new name for the agent.

      Parameters:
      agentName - Specifies a new name for the agent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • agentResourceRoleArn

      UpdateAgentRequest.Builder agentResourceRoleArn(String agentResourceRoleArn)

      The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.

      Parameters:
      agentResourceRoleArn - The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customerEncryptionKeyArn

      UpdateAgentRequest.Builder customerEncryptionKeyArn(String customerEncryptionKeyArn)

      The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.

      Parameters:
      customerEncryptionKeyArn - The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      UpdateAgentRequest.Builder description(String description)

      Specifies a new description of the agent.

      Parameters:
      description - Specifies a new description of the agent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • foundationModel

      UpdateAgentRequest.Builder foundationModel(String foundationModel)

      Specifies a new foundation model to be used for orchestration by the agent.

      Parameters:
      foundationModel - Specifies a new foundation model to be used for orchestration by the agent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • guardrailConfiguration

      UpdateAgentRequest.Builder guardrailConfiguration(GuardrailConfiguration guardrailConfiguration)

      The unique Guardrail configuration assigned to the agent when it is updated.

      Parameters:
      guardrailConfiguration - The unique Guardrail configuration assigned to the agent when it is updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • guardrailConfiguration

      default UpdateAgentRequest.Builder guardrailConfiguration(Consumer<GuardrailConfiguration.Builder> guardrailConfiguration)

      The unique Guardrail configuration assigned to the agent when it is updated.

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

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

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

    • idleSessionTTLInSeconds

      UpdateAgentRequest.Builder idleSessionTTLInSeconds(Integer idleSessionTTLInSeconds)

      The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.

      A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.

      Parameters:
      idleSessionTTLInSeconds - The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.

      A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.

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

    • instruction

      UpdateAgentRequest.Builder instruction(String instruction)

      Specifies new instructions that tell the agent what it should do and how it should interact with users.

      Parameters:
      instruction - Specifies new instructions that tell the agent what it should do and how it should interact with users.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • promptOverrideConfiguration

      UpdateAgentRequest.Builder promptOverrideConfiguration(PromptOverrideConfiguration promptOverrideConfiguration)

      Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

      Parameters:
      promptOverrideConfiguration - Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • promptOverrideConfiguration

      default UpdateAgentRequest.Builder promptOverrideConfiguration(Consumer<PromptOverrideConfiguration.Builder> promptOverrideConfiguration)

      Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

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

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

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

    • overrideConfiguration

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

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