v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1475719557.8 KB

Modifies a prompt in your prompt library. Include both fields that you want to keep and fields that you want to replace. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management.html">Prompt management in Amazon Bedrock</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-manage.html#prompt-management-edit">Edit prompts in your prompt library</a> in the Amazon Bedrock User Guide.

put/prompts/{promptIdentifier}/

Path parameters

promptIdentifierstring required

The unique identifier of the prompt.

Request body

namestring required

A name for the prompt.

descriptionstring

A description for the prompt.

customerEncryptionKeyArnstring

The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.

defaultVariantstring

The name of the default variant for the prompt. This value must match the <code>name</code> field in the relevant <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptVariant.html">PromptVariant</a> object.

Response

Success

namestring required

The name of the prompt.

descriptionstring

The description of the prompt.

customerEncryptionKeyArnstring

The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.

defaultVariantstring

The name of the default variant for the prompt. This value must match the <code>name</code> field in the relevant <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptVariant.html">PromptVariant</a> object.

idstring required

The unique identifier of the prompt.

arnstring required

The Amazon Resource Name (ARN) of the prompt.

versionstring required

The version of the prompt. When you update a prompt, the version updated is the <code>DRAFT</code> version.

createdAtstring date-time required

The time at which the prompt was created.

updatedAtstring date-time required

The time at which the prompt was last updated.