Class UpdateAgentRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateAgentRequest.Builder,
UpdateAgentRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
agentId()
The unique identifier of the agent.final String
Specifies a new name for the agent.final String
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.static UpdateAgentRequest.Builder
builder()
final String
The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.final String
Specifies a new description of the agent.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
Specifies a new foundation model to be used for orchestration by the agent.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final Integer
The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.final String
Specifies new instructions that tell the agent what it should do and how it should interact with users.Contains configurations to override prompts in different parts of an agent sequence.static Class
<? extends UpdateAgentRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
agentId
The unique identifier of the agent.
- Returns:
- The unique identifier of the agent.
-
agentName
Specifies a new name for the agent.
- Returns:
- Specifies a new name for the agent.
-
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
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
Specifies a new description of the agent.
- Returns:
- Specifies a new description of the agent.
-
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
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
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<UpdateAgentRequest.Builder,
UpdateAgentRequest> - Specified by:
toBuilder
in classBedrockAgentRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-