Interface AgentVersion.Builder

    • Method Detail

      • agentArn

        AgentVersion.Builder agentArn​(String agentArn)

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

        Parameters:
        agentArn - The Amazon Resource Name (ARN) of the agent that the version belongs to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • agentId

        AgentVersion.Builder agentId​(String agentId)

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

        Parameters:
        agentId - The unique identifier of the agent that the version belongs to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • agentName

        AgentVersion.Builder agentName​(String agentName)

        The name of the agent that the version belongs to.

        Parameters:
        agentName - The name of the agent that the version belongs to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • agentResourceRoleArn

        AgentVersion.Builder agentResourceRoleArn​(String agentResourceRoleArn)

        The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.

        Parameters:
        agentResourceRoleArn - The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • agentStatus

        AgentVersion.Builder agentStatus​(String agentStatus)

        The status of the agent that the version belongs to.

        Parameters:
        agentStatus - The status of the agent that the version belongs to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AgentStatus, AgentStatus
      • agentStatus

        AgentVersion.Builder agentStatus​(AgentStatus agentStatus)

        The status of the agent that the version belongs to.

        Parameters:
        agentStatus - The status of the agent that the version belongs to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AgentStatus, AgentStatus
      • createdAt

        AgentVersion.Builder createdAt​(Instant createdAt)

        The time at which the version was created.

        Parameters:
        createdAt - The time at which the version was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • customerEncryptionKeyArn

        AgentVersion.Builder customerEncryptionKeyArn​(String customerEncryptionKeyArn)

        The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.

        Parameters:
        customerEncryptionKeyArn - The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • description

        AgentVersion.Builder description​(String description)

        The description of the version.

        Parameters:
        description - The description of the version.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • failureReasons

        AgentVersion.Builder failureReasons​(Collection<String> failureReasons)

        A list of reasons that the API operation on the version failed.

        Parameters:
        failureReasons - A list of reasons that the API operation on the version failed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • failureReasons

        AgentVersion.Builder failureReasons​(String... failureReasons)

        A list of reasons that the API operation on the version failed.

        Parameters:
        failureReasons - A list of reasons that the API operation on the version failed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • foundationModel

        AgentVersion.Builder foundationModel​(String foundationModel)

        The foundation model that the version invokes.

        Parameters:
        foundationModel - The foundation model that the version invokes.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • idleSessionTTLInSeconds

        AgentVersion.Builder idleSessionTTLInSeconds​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.
      • instruction

        AgentVersion.Builder instruction​(String instruction)

        The instructions provided to the agent.

        Parameters:
        instruction - The instructions provided to the agent.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • promptOverrideConfiguration

        AgentVersion.Builder promptOverrideConfiguration​(PromptOverrideConfiguration promptOverrideConfiguration)

        Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.

        Parameters:
        promptOverrideConfiguration - Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • recommendedActions

        AgentVersion.Builder recommendedActions​(Collection<String> recommendedActions)

        A list of recommended actions to take for the failed API operation on the version to succeed.

        Parameters:
        recommendedActions - A list of recommended actions to take for the failed API operation on the version to succeed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • recommendedActions

        AgentVersion.Builder recommendedActions​(String... recommendedActions)

        A list of recommended actions to take for the failed API operation on the version to succeed.

        Parameters:
        recommendedActions - A list of recommended actions to take for the failed API operation on the version to succeed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • updatedAt

        AgentVersion.Builder updatedAt​(Instant updatedAt)

        The time at which the version was last updated.

        Parameters:
        updatedAt - The time at which the version was last updated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • version

        AgentVersion.Builder version​(String version)

        The version number.

        Parameters:
        version - The version number.
        Returns:
        Returns a reference to this object so that method calls can be chained together.