Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1494674591.3 KB

Updates an AI Prompt.

post/assistants/{assistantId}/aiprompts/{aiPromptId}

Path parameters

assistantIdstring required

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

aiPromptIdstring required

The identifier of the Amazon Q in Connect AI Prompt.

Request body

clientTokenstring

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 <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>..

visibilityStatus'SAVED' | 'PUBLISHED' required

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

descriptionstring

The description of the Amazon Q in Connect AI Prompt.

modelIdstring
<p>The identifier of the model used for this AI Prompt.</p> <note> <p>For information about which models are supported in each Amazon Web Services Region, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-ai-prompts.html#cli-create-aiprompt">Supported models for system/custom prompts</a>.</p> </note>

Response

Success