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

Class UpdateAgentRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.bedrockagent.model.BedrockAgentRequest

software.amazon.awssdk.services.bedrockagent.model.UpdateAgentRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateAgentRequest.Builder,UpdateAgentRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateAgentRequest
extends BedrockAgentRequest
implements ToCopyableBuilder<UpdateAgentRequest.Builder,UpdateAgentRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateAgentRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	agentId()	The unique identifier of the agent.
String	agentName()	Specifies a new name for the agent.
String	agentResourceRoleArn()	The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
static UpdateAgentRequest.Builder	builder()
String	customerEncryptionKeyArn()	The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
String	description()	Specifies a new description of the agent.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	foundationModel()	Specifies a new foundation model to be used for orchestration by the agent.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	idleSessionTTLInSeconds()	The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
String	instruction()	Specifies new instructions that tell the agent what it should do and how it should interact with users.
PromptOverrideConfiguration	promptOverrideConfiguration()	Contains configurations to override prompts in different parts of an agent sequence.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateAgentRequest.Builder>	serializableBuilderClass()
UpdateAgentRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

agentId

public final String agentId()

The unique identifier of the agent.

Returns:

The unique identifier of the agent.

agentName

public final String agentName()

Specifies a new name for the agent.

Returns:

Specifies a new name for the agent.

agentResourceRoleArn

public final String agentResourceRoleArn()

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

Returns:

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

customerEncryptionKeyArn

public final String customerEncryptionKeyArn()

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

Returns:

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

description

public final String description()

Specifies a new description of the agent.

Returns:

Specifies a new description of the agent.

foundationModel

public final String foundationModel()

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

Returns:

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

idleSessionTTLInSeconds

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

Returns:

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.

instruction

public final String instruction()

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

Returns:

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

promptOverrideConfiguration

public final PromptOverrideConfiguration promptOverrideConfiguration()

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

Returns:

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

toBuilder

public UpdateAgentRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateAgentRequest.Builder,UpdateAgentRequest>

Specified by:

toBuilder in class BedrockAgentRequest

builder

public static UpdateAgentRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateAgentRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo