Class AgentVersion

java.lang.Object
software.amazon.awssdk.services.bedrockagent.model.AgentVersion
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AgentVersion.Builder,AgentVersion>
@Generated("software.amazon.awssdk:codegen") public final class AgentVersion extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AgentVersion.Builder,AgentVersion>

Contains details about a version of an agent.

See Also:

  • Method Details

    • agentArn

      public final String agentArn()

      The Amazon Resource Name (ARN) of the agent that the version belongs to.

      Returns:
      The Amazon Resource Name (ARN) of the agent that the version belongs to.

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

    • agentId

      public final String agentId()

      The unique identifier of the agent that the version belongs to.

      Returns:
      The unique identifier of the agent that the version belongs to.

    • agentName

      public final String agentName()

      The name of the agent that the version belongs to.

      Returns:
      The name of the agent that the version belongs to.

    • 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 that the version belongs to.

      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 that the version belongs to.
      See Also:

    • agentStatusAsString

      public final String agentStatusAsString()

      The status of the agent that the version belongs to.

      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 that the version belongs to.
      See Also:

    • createdAt

      public final Instant createdAt()

      The time at which the version was created.

      Returns:
      The time at which the version 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 version.

      Returns:
      The description of the version.

    • 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()

      A list of reasons that the API operation on the version 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:
      A list of reasons that the API operation on the version failed.

    • foundationModel

      public final String foundationModel()

      The foundation model that the version invokes.

      Returns:
      The foundation model that the version invokes.

    • 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()

      The instructions provided to the agent.

      Returns:
      The instructions provided to the agent.

    • memoryConfiguration

      public final MemoryConfiguration memoryConfiguration()

      Contains details of the memory configuration on the version of the agent.

      Returns:
      Contains details of the memory configuration on the version of the agent.

    • 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()

      A list of recommended actions to take for the failed API operation on the version 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:
      A list of recommended actions to take for the failed API operation on the version to succeed.

    • updatedAt

      public final Instant updatedAt()

      The time at which the version was last updated.

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

    • version

      public final String version()

      The version number.

      Returns:
      The version number.

    • toBuilder

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

    • builder

      public static AgentVersion.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AgentVersion.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.