GetPrompt
Retrieves information about the working draft (DRAFT version) of a prompt or a version of it, depending on whether you include the promptVersion field or not. For more information, see View information about prompts using Prompt management and View information about a version of your prompt in the Amazon Bedrock User Guide.
Request Syntax
GET /prompts/promptIdentifier/?promptVersion=promptVersion HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- promptIdentifier
-
The unique identifier of the prompt.
Pattern:
^([0-9a-zA-Z]{10})|(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10})(?::[0-9]{1,5})?$Required: Yes
- promptVersion
-
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.
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern:
^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"arn": "string",
"createdAt": "string",
"customerEncryptionKeyArn": "string",
"defaultVariant": "string",
"description": "string",
"id": "string",
"name": "string",
"updatedAt": "string",
"variants": [
{
"additionalModelRequestFields": JSON value,
"genAiResource": { ... },
"inferenceConfiguration": { ... },
"metadata": [
{
"key": "string",
"value": "string"
}
],
"modelId": "string",
"name": "string",
"templateConfiguration": { ... },
"templateType": "string"
}
],
"version": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- arn
-
The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).
Type: String
Pattern:
^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10}(?::[0-9]{1,5})?)$ - createdAt
-
The time at which the prompt was created.
Type: Timestamp
- customerEncryptionKeyArn
-
The Amazon Resource Name (ARN) of the KMS key that the prompt is encrypted with.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$ - defaultVariant
-
The name of the default variant for the prompt. This value must match the
namefield in the relevant PromptVariant object.Type: String
Pattern:
^([0-9a-zA-Z][_-]?){1,100}$ - description
-
The descriptino of the prompt.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
- id
-
The unique identifier of the prompt.
Type: String
Pattern:
^[0-9a-zA-Z]{10}$ - name
-
The name of the prompt.
Type: String
Pattern:
^([0-9a-zA-Z][_-]?){1,100}$ - updatedAt
-
The time at which the prompt was last updated.
Type: Timestamp
- variants
-
A list of objects, each containing details about a variant of the prompt.
Type: Array of PromptVariant objects
Array Members: Minimum number of 0 items. Maximum number of 1 item.
- version
-
The version of the prompt.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern:
^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The request is denied because of missing access permissions.
HTTP Status Code: 403
- InternalServerException
-
An internal server error occurred. Retry your request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
- ThrottlingException
-
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
- ValidationException
-
Input validation failed. Check your request parameters and retry the request.
HTTP Status Code: 400
Examples
Get information about the working draft of a prompt
The following request returns information about the working draft of the prompt in the account with the identifier PROMPT12345:
GET /prompts/PROMPT12345 HTTP/1.1List information about all the versions of a prompt
The following request returns information about version 2 of the prompt in the account with the identifier PROMPT12345:
GET /prompts/PROMPT12345?promptVersion=2 HTTP/1.1See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
