ListPrompts
Returns either information about the working draft (DRAFT version) of each prompt in an account, or information about of all versions of a prompt, depending on whether you include the promptIdentifier field or not. For more information, see View information about prompts using Prompt management in the Amazon Bedrock User Guide.
Request Syntax
GET /prompts/?maxResults=maxResults&nextToken=nextToken&promptIdentifier=promptIdentifier HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- maxResults
-
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextTokenfield when making another request to return the next batch of results.Valid Range: Minimum value of 1. Maximum value of 1000.
- nextToken
-
If the total number of results is greater than the
maxResultsvalue provided in the request, enter the token returned in thenextTokenfield in the response in this field to return the next batch of results.Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^\S*$ - promptIdentifier
-
The unique identifier of the prompt for whose versions you want to return information. Omit this field to list information about all prompts in an account.
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})?$
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"promptSummaries": [
{
"arn": "string",
"createdAt": "string",
"description": "string",
"id": "string",
"name": "string",
"updatedAt": "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.
- nextToken
-
If the total number of results is greater than the
maxResultsvalue provided in the request, use this token when making another request in thenextTokenfield to return the next batch of results.Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^\S*$ - promptSummaries
-
A list, each member of which contains information about a prompt using Prompt management.
Type: Array of PromptSummary objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
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
List information about all prompts in an account
The following request returns information about the working draft of each prompt in the account:
GET /prompts/ HTTP/1.1List information about all the versions of a prompt
The following request returns information about all versions of the prompt in the account with the identifier PROMPT12345:
GET /prompts?promptIdentifier=PROMPT12345 HTTP/1.1See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
