Package software.amazon.awssdk.services.bedrockagent.model

Class UpdateAgentRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.bedrockagent.model.BedrockAgentRequest
software.amazon.awssdk.services.bedrockagent.model.UpdateAgentRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateAgentRequest.Builder,UpdateAgentRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateAgentRequest extends BedrockAgentRequest implements ToCopyableBuilder<UpdateAgentRequest.Builder,UpdateAgentRequest>

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

      Specifies a new name for the agent.

      Returns:
      Specifies a new name for the agent.

    • instruction

      public final String instruction()

      Specifies new instructions that tell the agent what it should do and how it should interact with users.

      Returns:
      Specifies new instructions that tell the agent what it should do and how it should interact with users.

    • foundationModel

      public final String foundationModel()

      The identifier for the model that you want to be used for orchestration by the agent you create.

      The modelId to provide depends on the type of model or throughput that you use:

      Returns:
      The identifier for the model that you want to be used for orchestration by the agent you create.

      The modelId to provide depends on the type of model or throughput that you use:

    • description

      public final String description()

      Specifies a new description of the agent.

      Returns:
      Specifies a new description of the agent.

    • orchestrationType

      public final OrchestrationType orchestrationType()

      Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.

      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 type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.
      See Also:

    • orchestrationTypeAsString

      public final String orchestrationTypeAsString()

      Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.

      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 type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.
      See Also:

    • customOrchestration

      public final CustomOrchestration customOrchestration()

      Contains details of the custom orchestration configured for the agent.

      Returns:
      Contains details of the custom orchestration configured 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 with which to encrypt the agent.

      Returns:
      The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.

    • promptOverrideConfiguration

      public final PromptOverrideConfiguration promptOverrideConfiguration()

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

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

    • guardrailConfiguration

      public final GuardrailConfiguration guardrailConfiguration()

      The unique Guardrail configuration assigned to the agent when it is updated.

      Returns:
      The unique Guardrail configuration assigned to the agent when it is updated.

    • memoryConfiguration

      public final MemoryConfiguration memoryConfiguration()

      Specifies the new memory configuration for the agent.

      Returns:
      Specifies the new memory configuration for the agent.

    • agentCollaboration

      public final AgentCollaboration agentCollaboration()

      The agent's collaboration role.

      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 role.
      See Also:

    • agentCollaborationAsString

      public final String agentCollaborationAsString()

      The agent's collaboration role.

      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 role.
      See Also:

    • toBuilder

      public UpdateAgentRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateAgentRequest.Builder,UpdateAgentRequest>
      Specified by:
      toBuilder in class BedrockAgentRequest

    • builder

      public static UpdateAgentRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateAgentRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo