Interface UpdateAiPromptRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateAiPromptRequest.Builder,UpdateAiPromptRequest>, QConnectRequest.Builder, SdkBuilder<UpdateAiPromptRequest.Builder,UpdateAiPromptRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateAiPromptRequest

@Mutable
@NotThreadSafe
public static interface UpdateAiPromptRequest.Builder
extends QConnectRequest.Builder, SdkPojo, CopyableBuilder<UpdateAiPromptRequest.Builder,UpdateAiPromptRequest>

Method Summary

Modifier and Type	Method	Description
UpdateAiPromptRequest.Builder	aiPromptId(String aiPromptId)	The identifier of the Amazon Q in Connect AI Prompt.
UpdateAiPromptRequest.Builder	assistantId(String assistantId)	The identifier of the Amazon Q in Connect assistant.
UpdateAiPromptRequest.Builder	clientToken(String clientToken)	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
UpdateAiPromptRequest.Builder	description(String description)	The description of the Amazon Q in Connect AI Prompt.
UpdateAiPromptRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
UpdateAiPromptRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default UpdateAiPromptRequest.Builder	templateConfiguration(Consumer<AIPromptTemplateConfiguration.Builder> templateConfiguration)	The configuration of the prompt template for this AI Prompt.
UpdateAiPromptRequest.Builder	templateConfiguration(AIPromptTemplateConfiguration templateConfiguration)	The configuration of the prompt template for this AI Prompt.
UpdateAiPromptRequest.Builder	visibilityStatus(String visibilityStatus)	The visibility status of the Amazon Q in Connect AI prompt.
UpdateAiPromptRequest.Builder	visibilityStatus(VisibilityStatus visibilityStatus)	The visibility status of the Amazon Q in Connect AI prompt.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.qconnect.model.QConnectRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

clientToken

UpdateAiPromptRequest.Builder clientToken(String clientToken)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..

Parameters:

clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..

Returns:

Returns a reference to this object so that method calls can be chained together.

assistantId

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

aiPromptId

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

visibilityStatus

UpdateAiPromptRequest.Builder visibilityStatus(String visibilityStatus)

The visibility status of the Amazon Q in Connect AI prompt.

Parameters:

visibilityStatus - The visibility status of the Amazon Q in Connect AI prompt.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• VisibilityStatus
• VisibilityStatus

visibilityStatus

UpdateAiPromptRequest.Builder visibilityStatus(VisibilityStatus visibilityStatus)

The visibility status of the Amazon Q in Connect AI prompt.

Parameters:

visibilityStatus - The visibility status of the Amazon Q in Connect AI prompt.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• VisibilityStatus
• VisibilityStatus

templateConfiguration

UpdateAiPromptRequest.Builder templateConfiguration(AIPromptTemplateConfiguration templateConfiguration)

The configuration of the prompt template for this AI Prompt.

Parameters:

templateConfiguration - The configuration of the prompt template for this AI Prompt.

Returns:

Returns a reference to this object so that method calls can be chained together.

templateConfiguration

default UpdateAiPromptRequest.Builder templateConfiguration(Consumer<AIPromptTemplateConfiguration.Builder> templateConfiguration)

The configuration of the prompt template for this AI Prompt.

This is a convenience method that creates an instance of the AIPromptTemplateConfiguration.Builder avoiding the need to create one manually via AIPromptTemplateConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to templateConfiguration(AIPromptTemplateConfiguration).

Parameters:

templateConfiguration - a consumer that will call methods on AIPromptTemplateConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• templateConfiguration(AIPromptTemplateConfiguration)

description

UpdateAiPromptRequest.Builder description(String description)

The description of the Amazon Q in Connect AI Prompt.

Parameters:

description - The description of the Amazon Q in Connect AI Prompt.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

UpdateAiPromptRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

UpdateAiPromptRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.