Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

DeletePrompt

Deletes a prompt or a version of it, depending on whether you include the promptVersion field or not. For more information, see Delete prompts from the Prompt management tool and Delete a version of a prompt from the Prompt management tool in the Amazon Bedrock User Guide.

Request Syntax


DELETE /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 to delete. To delete the prompt, omit this field.

Pattern: ^[0-9]{1,5}$

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "id": "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.

id

The unique identifier of the prompt that was deleted.

Type: String

Pattern: ^[0-9a-zA-Z]{10}$

version

The version of the prompt that was deleted.

Type: String

Pattern: ^[0-9]{1,5}$

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

ConflictException

There was a conflict performing an operation.

HTTP Status Code: 409

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

Delete a prompt

The following request deletes the prompt in the account with the identifier PROMPT12345:


DELETE /prompts/PROMPT12345/ HTTP/1.1

Delete a version of a prompt

The following request deletes version 1 of the prompt in the account with the identifier PROMPT12345:


GET /prompts/PROMPT12345?promptVersion=1 HTTP/1.1