Class CreateAgentRequest

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.CreateAgentRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateAgentRequest.Builder,CreateAgentRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateAgentRequest extends BedrockAgentRequest implements ToCopyableBuilder<CreateAgentRequest.Builder,CreateAgentRequest>

  • Method Details

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

    • agentName

      public final String agentName()

      A name for the agent that you create.

      Returns:
      A name for the agent that you create.

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

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

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

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

    • description

      public final String description()

      A description of the agent.

      Returns:
      A description of the agent.

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

    • guardrailConfiguration

      public final GuardrailConfiguration guardrailConfiguration()

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

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

    • 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 the details of the memory configured for the agent.

      Returns:
      Contains the details of the memory configured for 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:

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

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final Map<String,String> tags()

      Any tags that you want to attach to the agent.

      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 hasTags() method.

      Returns:
      Any tags that you want to attach to the agent.

    • toBuilder

      public CreateAgentRequest.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<CreateAgentRequest.Builder,CreateAgentRequest>
      Specified by:
      toBuilder in class BedrockAgentRequest
      Returns:
      a builder for type T

    • builder

      public static CreateAgentRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateAgentRequest.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)
      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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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