Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1475719557.8 KB

Retrieves information about the working draft (<code>DRAFT</code> version) of a prompt or a version of it, depending on whether you include the <code>promptVersion</code> field or not. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-manage.html#prompt-management-view.html">View information about prompts using Prompt management</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-deploy.html#prompt-management-versions-view.html">View information about a version of your prompt</a> in the Amazon Bedrock User Guide.

get/prompts/{promptIdentifier}/

Path parameters

promptIdentifierstring required

The unique identifier of the prompt.

Query parameters

promptVersionstring

The version of the prompt about which you want to retrieve information. Omit this field to return information about the working draft of the prompt.

includedData'ALL_DATA' | 'METADATA_ONLY'

Controls the scope of data returned. Set to <code>METADATA_ONLY</code> to return only resource metadata. Set to <code>ALL_DATA</code> or omit this field to return the full response.

Response

Success

namestring required

The name of the prompt.

descriptionstring

The descriptino of the prompt.

customerEncryptionKeyArnstring

The Amazon Resource Name (ARN) of the KMS key that the prompt is encrypted with.

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 or the prompt version (if you specified a version in the request).

versionstring required

The version of the prompt.

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.