java.lang.Object
- software.amazon.awssdk.services.bedrockagent.model.Agent

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Agent.Builder,Agent>

@Generated("software.amazon.awssdk:codegen")
public final class Agent
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Agent.Builder,Agent>

Contains details about an agent.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Agent.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`agentArn()`	The Amazon Resource Name (ARN) of the agent.
`String`	`agentId()`	The unique identifier of the agent.
`String`	`agentName()`	The name of the agent.
`String`	`agentResourceRoleArn()`	The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
`AgentStatus`	`agentStatus()`	The status of the agent and whether it is ready for use.
`String`	`agentStatusAsString()`	The status of the agent and whether it is ready for use.
`String`	`agentVersion()`	The version of the agent.
`static Agent.Builder`	`builder()`
`String`	`clientToken()`	A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
`Instant`	`createdAt()`	The time at which the agent was created.
`String`	`customerEncryptionKeyArn()`	The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
`String`	`description()`	The description of the agent.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<String>`	`failureReasons()`	Contains reasons that the agent-related API that you invoked failed.
`String`	`foundationModel()`	The foundation model used for orchestration by the agent.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`GuardrailConfiguration`	`guardrailConfiguration()`	Details about the guardrail associated with the agent.
`boolean`	`hasFailureReasons()`	For responses, this returns true if the service returned a value for the FailureReasons property.
`int`	`hashCode()`
`boolean`	`hasRecommendedActions()`	For responses, this returns true if the service returned a value for the RecommendedActions property.
`Integer`	`idleSessionTTLInSeconds()`	The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
`String`	`instruction()`	Instructions that tell the agent what it should do and how it should interact with users.
`MemoryConfiguration`	`memoryConfiguration()`	Contains memory configuration for the agent.
`Instant`	`preparedAt()`	The time at which the agent was last prepared.
`PromptOverrideConfiguration`	`promptOverrideConfiguration()`	Contains configurations to override prompt templates in different parts of an agent sequence.
`List<String>`	`recommendedActions()`	Contains recommended actions to take for the agent-related API that you invoked to succeed.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Agent.Builder>`	`serializableBuilderClass()`
`Agent.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Instant`	`updatedAt()`	The time at which the agent was last updated.

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
  - agentArn
```
public final String agentArn()
```
    The Amazon Resource Name (ARN) of the agent.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the agent.
  - agentId
```
public final String agentId()
```
    The unique identifier of the agent.
    
    Returns:
    
    The unique identifier of the agent.
  - agentName
```
public final String agentName()
```
    The name of the agent.
    
    Returns:
    
    The name of 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.
  - agentStatus
```
public final AgentStatus 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 return AgentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from agentStatusAsString().
    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:
    
    AgentStatus
  - agentStatusAsString
```
public final String 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 return AgentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from agentStatusAsString().
    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:
    
    AgentStatus
  - agentVersion
```
public final String agentVersion()
```
    The version of the agent.
    
    Returns:
    
    The version of the agent.
  - clientToken
```
public final String 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
```
public final Instant createdAt()
```
    The time at which the agent was created.
    
    Returns:
    
    The time at which the agent was created.
  - customerEncryptionKeyArn
```
public final String 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
```
public final String 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 the isEmpty() 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
```
public final List<String> 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
```
public final String foundationModel()
```
    The foundation model used for orchestration by the agent.
    
    Returns:
    
    The foundation model used for orchestration by the agent.
  - guardrailConfiguration
```
public final GuardrailConfiguration guardrailConfiguration()
```
    Details about the guardrail associated with the agent.
    
    Returns:
    
    Details about the guardrail associated with 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()
```
    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.
  - memoryConfiguration
```
public final MemoryConfiguration memoryConfiguration()
```
    Contains memory configuration for the agent.
    
    Returns:
    
    Contains memory configuration for the agent.
  - preparedAt
```
public final Instant preparedAt()
```
    The time at which the agent was last prepared.
    
    Returns:
    
    The time at which the agent was last prepared.
  - promptOverrideConfiguration
```
public final PromptOverrideConfiguration 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 the isEmpty() 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
```
public final List<String> 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
```
public final Instant updatedAt()
```
    The time at which the agent was last updated.
    
    Returns:
    
    The time at which the agent was last updated.
  - toBuilder
```
public Agent.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Agent.Builder,Agent>
  - builder
```
public static Agent.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Agent.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Agent

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

agentArn

agentId

agentName

agentResourceRoleArn

agentStatus

agentStatusAsString

agentVersion

clientToken

createdAt

customerEncryptionKeyArn

description

hasFailureReasons

failureReasons

foundationModel

guardrailConfiguration

idleSessionTTLInSeconds

instruction

memoryConfiguration

preparedAt

promptOverrideConfiguration

hasRecommendedActions

recommendedActions

updatedAt

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields