Interface AIPromptSummary.Builder

All Superinterfaces:
Buildable, CopyableBuilder<AIPromptSummary.Builder,AIPromptSummary>, SdkBuilder<AIPromptSummary.Builder,AIPromptSummary>, SdkPojo
Enclosing class:
AIPromptSummary
@Mutable @NotThreadSafe public static interface AIPromptSummary.Builder extends SdkPojo, CopyableBuilder<AIPromptSummary.Builder,AIPromptSummary>

  • Method Details

    • name

      AIPromptSummary.Builder name(String name)

      The name of the AI Prompt.

      Parameters:
      name - The name of the AI Prompt.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • assistantId

      AIPromptSummary.Builder assistantId(String assistantId)

      The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

      Parameters:
      assistantId - The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • assistantArn

      AIPromptSummary.Builder assistantArn(String assistantArn)

      The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

      Parameters:
      assistantArn - The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • aiPromptId

      AIPromptSummary.Builder aiPromptId(String aiPromptId)

      The identifier of the Amazon Q in Connect AI prompt.

      Parameters:
      aiPromptId - The identifier of the Amazon Q in Connect AI prompt.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      AIPromptSummary.Builder type(String type)

      The type of this AI Prompt.

      Parameters:
      type - The type of this AI Prompt.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      AIPromptSummary.Builder type(AIPromptType type)

      The type of this AI Prompt.

      Parameters:
      type - The type of this AI Prompt.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • aiPromptArn

      AIPromptSummary.Builder aiPromptArn(String aiPromptArn)

      The Amazon Resource Name (ARN) of the AI Prompt.

      Parameters:
      aiPromptArn - The Amazon Resource Name (ARN) of the AI Prompt.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • modifiedTime

      AIPromptSummary.Builder modifiedTime(Instant modifiedTime)

      The time the AI Prompt was last modified.

      Parameters:
      modifiedTime - The time the AI Prompt was last modified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • templateType

      AIPromptSummary.Builder templateType(String templateType)

      The type of the prompt template for this AI Prompt.

      Parameters:
      templateType - The type of the prompt template for this AI Prompt.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • templateType

      AIPromptSummary.Builder templateType(AIPromptTemplateType templateType)

      The type of the prompt template for this AI Prompt.

      Parameters:
      templateType - The type of the prompt template for this AI Prompt.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • modelId

      AIPromptSummary.Builder modelId(String modelId)

      The identifier of the model used for this AI Prompt. Model Ids supported are: anthropic.claude-3-haiku-20240307-v1:0.

      Parameters:
      modelId - The identifier of the model used for this AI Prompt. Model Ids supported are: anthropic.claude-3-haiku-20240307-v1:0.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • apiFormat

      AIPromptSummary.Builder apiFormat(String apiFormat)

      The API format used for this AI Prompt.

      Parameters:
      apiFormat - The API format used for this AI Prompt.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • apiFormat

      AIPromptSummary.Builder apiFormat(AIPromptAPIFormat apiFormat)

      The API format used for this AI Prompt.

      Parameters:
      apiFormat - The API format used for this AI Prompt.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • visibilityStatus

      AIPromptSummary.Builder visibilityStatus(String visibilityStatus)

      The visibility status of the AI Prompt.

      Parameters:
      visibilityStatus - The visibility status of the AI Prompt.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • visibilityStatus

      AIPromptSummary.Builder visibilityStatus(VisibilityStatus visibilityStatus)

      The visibility status of the AI Prompt.

      Parameters:
      visibilityStatus - The visibility status of the AI Prompt.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • origin

      AIPromptSummary.Builder origin(String origin)

      The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.

      Parameters:
      origin - The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • origin

      AIPromptSummary.Builder origin(Origin origin)

      The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.

      Parameters:
      origin - The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • description

      AIPromptSummary.Builder description(String description)

      The description of the AI Prompt.

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

    • status

      AIPromptSummary.Builder status(String status)

      The status of the AI Prompt.

      Parameters:
      status - The status of the AI Prompt.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      AIPromptSummary.Builder status(Status status)

      The status of the AI Prompt.

      Parameters:
      status - The status of the AI Prompt.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      AIPromptSummary.Builder tags(Map<String,String> tags)

      The tags used to organize, track, or control access for this resource.

      Parameters:
      tags - The tags used to organize, track, or control access for this resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.