Class Agent

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:

  • Method Details

    • 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.

    • agentArn

      public final String agentArn()

      The Amazon Resource Name (ARN) of the agent.

      Returns:
      The Amazon Resource Name (ARN) of the agent.

    • 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.

    • 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.

    • 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:

    • 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:

    • foundationModel

      public final String foundationModel()

      The foundation model used for orchestration by the agent.

      Returns:
      The foundation model used for orchestration by the agent.

    • description

      public final String description()

      The description of the agent.

      Returns:
      The description of the agent.

    • orchestrationType

      public final OrchestrationType orchestrationType()

      Specifies the orchestration strategy for the agent.

      If the service returns an enum value that is not available in the current SDK version, orchestrationType will return OrchestrationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from orchestrationTypeAsString().

      Returns:
      Specifies the orchestration strategy for the agent.
      See Also:

    • orchestrationTypeAsString

      public final String orchestrationTypeAsString()

      Specifies the orchestration strategy for the agent.

      If the service returns an enum value that is not available in the current SDK version, orchestrationType will return OrchestrationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from orchestrationTypeAsString().

      Returns:
      Specifies the orchestration strategy for the agent.
      See Also:

    • customOrchestration

      public final CustomOrchestration customOrchestration()

      Contains custom orchestration configurations for the agent.

      Returns:
      Contains custom orchestration configurations for 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.

    • 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.

    • 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.

    • createdAt

      public final Instant createdAt()

      The time at which the agent was created.

      Returns:
      The time at which the agent was created.

    • updatedAt

      public final Instant updatedAt()

      The time at which the agent was last updated.

      Returns:
      The time at which the agent was last updated.

    • preparedAt

      public final Instant preparedAt()

      The time at which the agent was last prepared.

      Returns:
      The time at which the agent was last prepared.

    • 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.

    • 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.

    • 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.

    • guardrailConfiguration

      public final GuardrailConfiguration guardrailConfiguration()

      Details about the guardrail associated with the agent.

      Returns:
      Details about the guardrail associated with the agent.

    • memoryConfiguration

      public final MemoryConfiguration memoryConfiguration()

      Contains memory configuration for the agent.

      Returns:
      Contains memory configuration for the agent.

    • agentCollaboration

      public final AgentCollaboration agentCollaboration()

      The agent's collaboration settings.

      If the service returns an enum value that is not available in the current SDK version, agentCollaboration will return AgentCollaboration.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from agentCollaborationAsString().

      Returns:
      The agent's collaboration settings.
      See Also:

    • agentCollaborationAsString

      public final String agentCollaborationAsString()

      The agent's collaboration settings.

      If the service returns an enum value that is not available in the current SDK version, agentCollaboration will return AgentCollaboration.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from agentCollaborationAsString().

      Returns:
      The agent's collaboration settings.
      See Also:

    • toBuilder

      public Agent.Builder 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 interface ToCopyableBuilder<Agent.Builder,Agent>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.