@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class UpdateAgentRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
UpdateAgentRequest() |
Modifier and Type | Method and Description |
---|---|
UpdateAgentRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getAgentId()
The unique identifier of the agent.
|
String |
getAgentName()
Specifies a new name for the agent.
|
String |
getAgentResourceRoleArn()
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
|
String |
getCustomerEncryptionKeyArn()
The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
|
String |
getDescription()
Specifies a new description of the agent.
|
String |
getFoundationModel()
Specifies a new foundation model to be used for orchestration by the agent.
|
GuardrailConfiguration |
getGuardrailConfiguration()
The unique Guardrail configuration assigned to the agent when it is updated.
|
Integer |
getIdleSessionTTLInSeconds()
The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
|
String |
getInstruction()
Specifies new instructions that tell the agent what it should do and how it should interact with users.
|
MemoryConfiguration |
getMemoryConfiguration()
Specifies the new memory configuration for the agent.
|
PromptOverrideConfiguration |
getPromptOverrideConfiguration()
Contains configurations to override prompts in different parts of an agent sequence.
|
int |
hashCode() |
void |
setAgentId(String agentId)
The unique identifier of the agent.
|
void |
setAgentName(String agentName)
Specifies a new name for the agent.
|
void |
setAgentResourceRoleArn(String agentResourceRoleArn)
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
|
void |
setCustomerEncryptionKeyArn(String customerEncryptionKeyArn)
The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
|
void |
setDescription(String description)
Specifies a new description of the agent.
|
void |
setFoundationModel(String foundationModel)
Specifies a new foundation model to be used for orchestration by the agent.
|
void |
setGuardrailConfiguration(GuardrailConfiguration guardrailConfiguration)
The unique Guardrail configuration assigned to the agent when it is updated.
|
void |
setIdleSessionTTLInSeconds(Integer idleSessionTTLInSeconds)
The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
|
void |
setInstruction(String instruction)
Specifies new instructions that tell the agent what it should do and how it should interact with users.
|
void |
setMemoryConfiguration(MemoryConfiguration memoryConfiguration)
Specifies the new memory configuration for the agent.
|
void |
setPromptOverrideConfiguration(PromptOverrideConfiguration promptOverrideConfiguration)
Contains configurations to override prompts in different parts of an agent sequence.
|
String |
toString()
Returns a string representation of this object.
|
UpdateAgentRequest |
withAgentId(String agentId)
The unique identifier of the agent.
|
UpdateAgentRequest |
withAgentName(String agentName)
Specifies a new name for the agent.
|
UpdateAgentRequest |
withAgentResourceRoleArn(String agentResourceRoleArn)
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
|
UpdateAgentRequest |
withCustomerEncryptionKeyArn(String customerEncryptionKeyArn)
The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
|
UpdateAgentRequest |
withDescription(String description)
Specifies a new description of the agent.
|
UpdateAgentRequest |
withFoundationModel(String foundationModel)
Specifies a new foundation model to be used for orchestration by the agent.
|
UpdateAgentRequest |
withGuardrailConfiguration(GuardrailConfiguration guardrailConfiguration)
The unique Guardrail configuration assigned to the agent when it is updated.
|
UpdateAgentRequest |
withIdleSessionTTLInSeconds(Integer idleSessionTTLInSeconds)
The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
|
UpdateAgentRequest |
withInstruction(String instruction)
Specifies new instructions that tell the agent what it should do and how it should interact with users.
|
UpdateAgentRequest |
withMemoryConfiguration(MemoryConfiguration memoryConfiguration)
Specifies the new memory configuration for the agent.
|
UpdateAgentRequest |
withPromptOverrideConfiguration(PromptOverrideConfiguration promptOverrideConfiguration)
Contains configurations to override prompts in different parts of an agent sequence.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setAgentId(String agentId)
The unique identifier of the agent.
agentId
- The unique identifier of the agent.public String getAgentId()
The unique identifier of the agent.
public UpdateAgentRequest withAgentId(String agentId)
The unique identifier of the agent.
agentId
- The unique identifier of the agent.public void setAgentName(String agentName)
Specifies a new name for the agent.
agentName
- Specifies a new name for the agent.public String getAgentName()
Specifies a new name for the agent.
public UpdateAgentRequest withAgentName(String agentName)
Specifies a new name for the agent.
agentName
- Specifies a new name for the agent.public void setAgentResourceRoleArn(String agentResourceRoleArn)
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
agentResourceRoleArn
- The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.public String getAgentResourceRoleArn()
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
public UpdateAgentRequest withAgentResourceRoleArn(String agentResourceRoleArn)
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
agentResourceRoleArn
- The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.public void setCustomerEncryptionKeyArn(String customerEncryptionKeyArn)
The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
customerEncryptionKeyArn
- The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.public String getCustomerEncryptionKeyArn()
The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
public UpdateAgentRequest withCustomerEncryptionKeyArn(String customerEncryptionKeyArn)
The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
customerEncryptionKeyArn
- The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.public void setDescription(String description)
Specifies a new description of the agent.
description
- Specifies a new description of the agent.public String getDescription()
Specifies a new description of the agent.
public UpdateAgentRequest withDescription(String description)
Specifies a new description of the agent.
description
- Specifies a new description of the agent.public void setFoundationModel(String foundationModel)
Specifies a new foundation model to be used for orchestration by the agent.
foundationModel
- Specifies a new foundation model to be used for orchestration by the agent.public String getFoundationModel()
Specifies a new foundation model to be used for orchestration by the agent.
public UpdateAgentRequest withFoundationModel(String foundationModel)
Specifies a new foundation model to be used for orchestration by the agent.
foundationModel
- Specifies a new foundation model to be used for orchestration by the agent.public void setGuardrailConfiguration(GuardrailConfiguration guardrailConfiguration)
The unique Guardrail configuration assigned to the agent when it is updated.
guardrailConfiguration
- The unique Guardrail configuration assigned to the agent when it is updated.public GuardrailConfiguration getGuardrailConfiguration()
The unique Guardrail configuration assigned to the agent when it is updated.
public UpdateAgentRequest withGuardrailConfiguration(GuardrailConfiguration guardrailConfiguration)
The unique Guardrail configuration assigned to the agent when it is updated.
guardrailConfiguration
- The unique Guardrail configuration assigned to the agent when it is updated.public void setIdleSessionTTLInSeconds(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.
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.
public Integer getIdleSessionTTLInSeconds()
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.
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.
public UpdateAgentRequest withIdleSessionTTLInSeconds(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.
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.
public void setInstruction(String instruction)
Specifies new instructions that tell the agent what it should do and how it should interact with users.
instruction
- Specifies new instructions that tell the agent what it should do and how it should interact with users.public String getInstruction()
Specifies new instructions that tell the agent what it should do and how it should interact with users.
public UpdateAgentRequest withInstruction(String instruction)
Specifies new instructions that tell the agent what it should do and how it should interact with users.
instruction
- Specifies new instructions that tell the agent what it should do and how it should interact with users.public void setMemoryConfiguration(MemoryConfiguration memoryConfiguration)
Specifies the new memory configuration for the agent.
memoryConfiguration
- Specifies the new memory configuration for the agent.public MemoryConfiguration getMemoryConfiguration()
Specifies the new memory configuration for the agent.
public UpdateAgentRequest withMemoryConfiguration(MemoryConfiguration memoryConfiguration)
Specifies the new memory configuration for the agent.
memoryConfiguration
- Specifies the new memory configuration for the agent.public void setPromptOverrideConfiguration(PromptOverrideConfiguration promptOverrideConfiguration)
Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
promptOverrideConfiguration
- Contains configurations to override prompts in different parts of an agent sequence. For more information,
see Advanced
prompts.public PromptOverrideConfiguration getPromptOverrideConfiguration()
Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
public UpdateAgentRequest withPromptOverrideConfiguration(PromptOverrideConfiguration promptOverrideConfiguration)
Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
promptOverrideConfiguration
- Contains configurations to override prompts in different parts of an agent sequence. For more information,
see Advanced
prompts.public String toString()
toString
in class Object
Object.toString()
public UpdateAgentRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()