Interface UpdateAgentRequest.Builder

All Superinterfaces:

AwsRequest.Builder, BedrockAgentRequest.Builder, Buildable, CopyableBuilder<UpdateAgentRequest.Builder,UpdateAgentRequest>, SdkBuilder<UpdateAgentRequest.Builder,UpdateAgentRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateAgentRequest

@Mutable
@NotThreadSafe
public static interface UpdateAgentRequest.Builder
extends BedrockAgentRequest.Builder, SdkPojo, CopyableBuilder<UpdateAgentRequest.Builder,UpdateAgentRequest>

Method Summary

Modifier and Type	Method	Description
UpdateAgentRequest.Builder	agentCollaboration(String agentCollaboration)	The agent's collaboration role.
UpdateAgentRequest.Builder	agentCollaboration(AgentCollaboration agentCollaboration)	The agent's collaboration role.
UpdateAgentRequest.Builder	agentId(String agentId)	The unique identifier of the agent.
UpdateAgentRequest.Builder	agentName(String agentName)	Specifies a new name for the agent.
UpdateAgentRequest.Builder	agentResourceRoleArn(String agentResourceRoleArn)	The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
UpdateAgentRequest.Builder	customerEncryptionKeyArn(String customerEncryptionKeyArn)	The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
default UpdateAgentRequest.Builder	customOrchestration(Consumer<CustomOrchestration.Builder> customOrchestration)	Contains details of the custom orchestration configured for the agent.
UpdateAgentRequest.Builder	customOrchestration(CustomOrchestration customOrchestration)	Contains details of the custom orchestration configured for the agent.
UpdateAgentRequest.Builder	description(String description)	Specifies a new description of the agent.
UpdateAgentRequest.Builder	foundationModel(String foundationModel)	The identifier for the model that you want to be used for orchestration by the agent you create.
default UpdateAgentRequest.Builder	guardrailConfiguration(Consumer<GuardrailConfiguration.Builder> guardrailConfiguration)	The unique Guardrail configuration assigned to the agent when it is updated.
UpdateAgentRequest.Builder	guardrailConfiguration(GuardrailConfiguration guardrailConfiguration)	The unique Guardrail configuration assigned to the agent when it is updated.
UpdateAgentRequest.Builder	idleSessionTTLInSeconds(Integer idleSessionTTLInSeconds)	The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
UpdateAgentRequest.Builder	instruction(String instruction)	Specifies new instructions that tell the agent what it should do and how it should interact with users.
default UpdateAgentRequest.Builder	memoryConfiguration(Consumer<MemoryConfiguration.Builder> memoryConfiguration)	Specifies the new memory configuration for the agent.
UpdateAgentRequest.Builder	memoryConfiguration(MemoryConfiguration memoryConfiguration)	Specifies the new memory configuration for the agent.
UpdateAgentRequest.Builder	orchestrationType(String orchestrationType)	Specifies the type of orchestration strategy for the agent.
UpdateAgentRequest.Builder	orchestrationType(OrchestrationType orchestrationType)	Specifies the type of orchestration strategy for the agent.
UpdateAgentRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
UpdateAgentRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default UpdateAgentRequest.Builder	promptOverrideConfiguration(Consumer<PromptOverrideConfiguration.Builder> promptOverrideConfiguration)	Contains configurations to override prompts in different parts of an agent sequence.
UpdateAgentRequest.Builder	promptOverrideConfiguration(PromptOverrideConfiguration promptOverrideConfiguration)	Contains configurations to override prompts in different parts of an agent sequence.

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 Details

agentCollaboration

UpdateAgentRequest.Builder agentCollaboration(String agentCollaboration)

The agent's collaboration role.

Parameters:

agentCollaboration - The agent's collaboration role.

Returns:

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

See Also:

• AgentCollaboration
• AgentCollaboration

agentCollaboration

UpdateAgentRequest.Builder agentCollaboration(AgentCollaboration agentCollaboration)

The agent's collaboration role.

Parameters:

agentCollaboration - The agent's collaboration role.

Returns:

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

See Also:

• AgentCollaboration
• AgentCollaboration

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.

customOrchestration

UpdateAgentRequest.Builder customOrchestration(CustomOrchestration customOrchestration)

Contains details of the custom orchestration configured for the agent.

Parameters:

customOrchestration - Contains details of the custom orchestration configured for the agent.

Returns:

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

customOrchestration

default UpdateAgentRequest.Builder customOrchestration(Consumer<CustomOrchestration.Builder> customOrchestration)

Contains details of the custom orchestration configured for the agent.

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

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

Parameters:

customOrchestration - a consumer that will call methods on CustomOrchestration.Builder

Returns:

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

See Also:

• customOrchestration(CustomOrchestration)

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)

The identifier for the model that you want to be used for orchestration by the agent you create.

The modelId to provide depends on the type of model or throughput that you use:

• If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see Amazon Bedrock base model IDs (on-demand throughput) in the Amazon Bedrock User Guide.

• If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see Supported Regions and models for cross-region inference in the Amazon Bedrock User Guide.

• If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see Run inference using a Provisioned Throughput in the Amazon Bedrock User Guide.

• If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see Use a custom model in Amazon Bedrock in the Amazon Bedrock User Guide.

• If you use an imported model, specify the ARN of the imported model. You can get the model ARN from a successful call to CreateModelImportJob or from the Imported models page in the Amazon Bedrock console.

Parameters:

foundationModel - The identifier for the model that you want to be used for orchestration by the agent you create.

The modelId to provide depends on the type of model or throughput that you use:

• If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see Amazon Bedrock base model IDs (on-demand throughput) in the Amazon Bedrock User Guide.

• If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see Supported Regions and models for cross-region inference in the Amazon Bedrock User Guide.

• If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see Run inference using a Provisioned Throughput in the Amazon Bedrock User Guide.

• If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see Use a custom model in Amazon Bedrock in the Amazon Bedrock User Guide.

• If you use an imported model, specify the ARN of the imported model. You can get the model ARN from a successful call to CreateModelImportJob or from the Imported models page in the Amazon Bedrock console.

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:

• guardrailConfiguration(GuardrailConfiguration)

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.

memoryConfiguration

UpdateAgentRequest.Builder memoryConfiguration(MemoryConfiguration memoryConfiguration)

Specifies the new memory configuration for the agent.

Parameters:

memoryConfiguration - Specifies the new memory configuration for the agent.

Returns:

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

memoryConfiguration

default UpdateAgentRequest.Builder memoryConfiguration(Consumer<MemoryConfiguration.Builder> memoryConfiguration)

Specifies the new memory configuration for the agent.

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

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

Parameters:

memoryConfiguration - a consumer that will call methods on MemoryConfiguration.Builder

Returns:

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

See Also:

• memoryConfiguration(MemoryConfiguration)

orchestrationType

UpdateAgentRequest.Builder orchestrationType(String orchestrationType)

Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.

Parameters:

orchestrationType - Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.

Returns:

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

See Also:

• OrchestrationType
• OrchestrationType

orchestrationType

UpdateAgentRequest.Builder orchestrationType(OrchestrationType orchestrationType)

Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.

Parameters:

orchestrationType - Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.

Returns:

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

See Also:

• OrchestrationType
• OrchestrationType

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:

• promptOverrideConfiguration(PromptOverrideConfiguration)

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.