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

Interface CreateAgentRequest.Builder

    • Method Detail

      • agentName

        CreateAgentRequest.Builder agentName​(String agentName)

        A name for the agent that you create.

        Parameters:
        agentName - A name for the agent that you create.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • agentResourceRoleArn

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

      • clientToken

        CreateAgentRequest.Builder clientToken​(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.

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

      • customerEncryptionKeyArn

        CreateAgentRequest.Builder customerEncryptionKeyArn​(String customerEncryptionKeyArn)

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

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

      • description

        CreateAgentRequest.Builder description​(String description)

        A description of the agent.

        Parameters:
        description - A description of the agent.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • foundationModel

        CreateAgentRequest.Builder foundationModel​(String foundationModel)

        The Amazon Resource Name (ARN) of the foundation model to be used for orchestration by the agent you create.

        Parameters:
        foundationModel - The Amazon Resource Name (ARN) of the foundation model to be used for orchestration by the agent you create.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • guardrailConfiguration

        CreateAgentRequest.Builder guardrailConfiguration​(GuardrailConfiguration guardrailConfiguration)

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

        Parameters:
        guardrailConfiguration - The unique Guardrail configuration assigned to the agent when it is created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • idleSessionTTLInSeconds

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

        CreateAgentRequest.Builder instruction​(String instruction)

        Instructions that tell the agent what it should do and how it should interact with users.

        Parameters:
        instruction - Instructions that tell the agent what it should do and how it should interact with users.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • memoryConfiguration

        CreateAgentRequest.Builder memoryConfiguration​(MemoryConfiguration memoryConfiguration)

        Contains the details of the memory configured for the agent.

        Parameters:
        memoryConfiguration - Contains the details of the memory configured for the agent.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • promptOverrideConfiguration

        CreateAgentRequest.Builder promptOverrideConfiguration​(PromptOverrideConfiguration promptOverrideConfiguration)

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

        Parameters:
        promptOverrideConfiguration - Contains configurations to override prompts 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.

      • tags

        CreateAgentRequest.Builder tags​(Map<String,​String> tags)

        Any tags that you want to attach to the agent.

        Parameters:
        tags - Any tags that you want to attach to the agent.
        Returns:
        Returns a reference to this object so that method calls can be chained together.