Class Agent
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Agent.Builder,
Agent>
Contains details about an agent.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
agentArn()
The Amazon Resource Name (ARN) of the agent.final String
agentId()
The unique identifier of the agent.final String
The name of the agent.final String
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.final AgentStatus
The status of the agent and whether it is ready for use.final String
The status of the agent and whether it is ready for use.final String
The version of the agent.static Agent.Builder
builder()
final String
A unique, case-sensitive identifier to ensure that the API request completes no more than one time.final Instant
The time at which the agent was created.final String
The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.final String
The description of the agent.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.Contains reasons that the agent-related API that you invoked failed.final String
The foundation model used for orchestration by the agent.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the FailureReasons property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the RecommendedActions property.final Integer
The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.final String
Instructions that tell the agent what it should do and how it should interact with users.final Instant
The time at which the agent was last prepared.Contains configurations to override prompt templates in different parts of an agent sequence.Contains recommended actions to take for the agent-related API that you invoked to succeed.static Class
<? extends Agent.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.final Instant
The time at which the agent was last updated.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
agentArn
The Amazon Resource Name (ARN) of the agent.
- Returns:
- The Amazon Resource Name (ARN) of the agent.
-
agentId
The unique identifier of the agent.
- Returns:
- The unique identifier of the agent.
-
agentName
The name of the agent.
- Returns:
- The name of 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.
-
agentStatus
The status of the agent and whether it is ready for use. The following statuses are possible:
-
CREATING – The agent is being created.
-
PREPARING – The agent is being prepared.
-
PREPARED – The agent is prepared and ready to be invoked.
-
NOT_PREPARED – The agent has been created but not yet prepared.
-
FAILED – The agent API operation failed.
-
UPDATING – The agent is being updated.
-
DELETING – The agent is being deleted.
If the service returns an enum value that is not available in the current SDK version,
agentStatus
will returnAgentStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromagentStatusAsString()
.- Returns:
- The status of the agent and whether it is ready for use. The following statuses are possible:
-
CREATING – The agent is being created.
-
PREPARING – The agent is being prepared.
-
PREPARED – The agent is prepared and ready to be invoked.
-
NOT_PREPARED – The agent has been created but not yet prepared.
-
FAILED – The agent API operation failed.
-
UPDATING – The agent is being updated.
-
DELETING – The agent is being deleted.
-
- See Also:
-
-
agentStatusAsString
The status of the agent and whether it is ready for use. The following statuses are possible:
-
CREATING – The agent is being created.
-
PREPARING – The agent is being prepared.
-
PREPARED – The agent is prepared and ready to be invoked.
-
NOT_PREPARED – The agent has been created but not yet prepared.
-
FAILED – The agent API operation failed.
-
UPDATING – The agent is being updated.
-
DELETING – The agent is being deleted.
If the service returns an enum value that is not available in the current SDK version,
agentStatus
will returnAgentStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromagentStatusAsString()
.- Returns:
- The status of the agent and whether it is ready for use. The following statuses are possible:
-
CREATING – The agent is being created.
-
PREPARING – The agent is being prepared.
-
PREPARED – The agent is prepared and ready to be invoked.
-
NOT_PREPARED – The agent has been created but not yet prepared.
-
FAILED – The agent API operation failed.
-
UPDATING – The agent is being updated.
-
DELETING – The agent is being deleted.
-
- See Also:
-
-
agentVersion
The version of the agent.
- Returns:
- The version of the agent.
-
clientToken
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
- Returns:
- A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
-
createdAt
The time at which the agent was created.
- Returns:
- The time at which the agent was created.
-
customerEncryptionKeyArn
The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
- Returns:
- The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
-
description
The description of the agent.
- Returns:
- The description of the agent.
-
hasFailureReasons
public final boolean hasFailureReasons()For responses, this returns true if the service returned a value for the FailureReasons property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
failureReasons
Contains reasons that the agent-related API that you invoked failed.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasFailureReasons()
method.- Returns:
- Contains reasons that the agent-related API that you invoked failed.
-
foundationModel
The foundation model used for orchestration by the agent.
- Returns:
- The foundation model 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
Instructions that tell the agent what it should do and how it should interact with users.
- Returns:
- Instructions that tell the agent what it should do and how it should interact with users.
-
preparedAt
The time at which the agent was last prepared.
- Returns:
- The time at which the agent was last prepared.
-
promptOverrideConfiguration
Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
- Returns:
- Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
-
hasRecommendedActions
public final boolean hasRecommendedActions()For responses, this returns true if the service returned a value for the RecommendedActions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
recommendedActions
Contains recommended actions to take for the agent-related API that you invoked to succeed.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasRecommendedActions()
method.- Returns:
- Contains recommended actions to take for the agent-related API that you invoked to succeed.
-
updatedAt
The time at which the agent was last updated.
- Returns:
- The time at which the agent was last updated.
-
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<Agent.Builder,
Agent> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
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
-
sdkFields
-