com.amazonaws.services.bedrockagent.model

Class UpdateAgentRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.bedrockagent.model.UpdateAgentRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateAgentRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateAgentRequest()

Method Summary

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 ARN of the IAM role with permissions to update the agent.
String	getCustomerEncryptionKeyArn() The 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.
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.
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 ARN of the IAM role with permissions to update the agent.
void	setCustomerEncryptionKeyArn(String customerEncryptionKeyArn) The 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	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	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 ARN of the IAM role with permissions to update the agent.
UpdateAgentRequest	withCustomerEncryptionKeyArn(String customerEncryptionKeyArn) The 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	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	withPromptOverrideConfiguration(PromptOverrideConfiguration promptOverrideConfiguration) Contains configurations to override prompts in different parts of an agent sequence.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateAgentRequest

public UpdateAgentRequest()

Method Detail

setAgentId

public void setAgentId(String agentId)

The unique identifier of the agent.

Parameters:

agentId - The unique identifier of the agent.

getAgentId

public String getAgentId()

The unique identifier of the agent.

Returns:

The unique identifier of the agent.

withAgentId

public UpdateAgentRequest withAgentId(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.

setAgentName

public void setAgentName(String agentName)

Specifies a new name for the agent.

Parameters:

agentName - Specifies a new name for the agent.

getAgentName

public String getAgentName()

Specifies a new name for the agent.

Returns:

Specifies a new name for the agent.

withAgentName

public UpdateAgentRequest withAgentName(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.

setAgentResourceRoleArn

public void setAgentResourceRoleArn(String agentResourceRoleArn)

The ARN of the IAM role with permissions to update the agent. The ARN must begin with AmazonBedrockExecutionRoleForAgents_.

Parameters:

agentResourceRoleArn - The ARN of the IAM role with permissions to update the agent. The ARN must begin with AmazonBedrockExecutionRoleForAgents_.

getAgentResourceRoleArn

public String getAgentResourceRoleArn()

The ARN of the IAM role with permissions to update the agent. The ARN must begin with AmazonBedrockExecutionRoleForAgents_.

Returns:

The ARN of the IAM role with permissions to update the agent. The ARN must begin with AmazonBedrockExecutionRoleForAgents_.

withAgentResourceRoleArn

public UpdateAgentRequest withAgentResourceRoleArn(String agentResourceRoleArn)

The ARN of the IAM role with permissions to update the agent. The ARN must begin with AmazonBedrockExecutionRoleForAgents_.

Parameters:

agentResourceRoleArn - The ARN of the IAM role with permissions to update the agent. The ARN must begin with AmazonBedrockExecutionRoleForAgents_.

Returns:

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

setCustomerEncryptionKeyArn

public void setCustomerEncryptionKeyArn(String customerEncryptionKeyArn)

The ARN of the KMS key with which to encrypt the agent.

Parameters:

customerEncryptionKeyArn - The ARN of the KMS key with which to encrypt the agent.

getCustomerEncryptionKeyArn

public String getCustomerEncryptionKeyArn()

The ARN of the KMS key with which to encrypt the agent.

Returns:

The ARN of the KMS key with which to encrypt the agent.

withCustomerEncryptionKeyArn

public UpdateAgentRequest withCustomerEncryptionKeyArn(String customerEncryptionKeyArn)

The ARN of the KMS key with which to encrypt the agent.

Parameters:

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

setDescription

public void setDescription(String description)

Specifies a new description of the agent.

Parameters:

description - Specifies a new description of the agent.

getDescription

public String getDescription()

Specifies a new description of the agent.

Returns:

Specifies a new description of the agent.

withDescription

public UpdateAgentRequest withDescription(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.

setFoundationModel

public void setFoundationModel(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.

getFoundationModel

public String getFoundationModel()

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.

withFoundationModel

public UpdateAgentRequest withFoundationModel(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.

setIdleSessionTTLInSeconds

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.

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.

getIdleSessionTTLInSeconds

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.

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.

withIdleSessionTTLInSeconds

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.

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.

setInstruction

public void setInstruction(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.

getInstruction

public String getInstruction()

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.

withInstruction

public UpdateAgentRequest withInstruction(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.

setPromptOverrideConfiguration

public void setPromptOverrideConfiguration(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.

getPromptOverrideConfiguration

public PromptOverrideConfiguration getPromptOverrideConfiguration()

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.

withPromptOverrideConfiguration

public UpdateAgentRequest withPromptOverrideConfiguration(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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateAgentRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()