Skip to content

Bedrock Agent  >  Operations  >  delete_prompt

delete_prompt

Operation

delete_prompt async 

delete_prompt(input: DeletePromptInput, plugins: list[Plugin] | None = None) -> DeletePromptOutput

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.

Parameters:

Name Type Description Default
input DeletePromptInput

An instance of DeletePromptInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
DeletePromptOutput

An instance of DeletePromptOutput.

Input

DeletePromptInput dataclass

Dataclass for DeletePromptInput structure.

Attributes

prompt_identifier class-attribute instance-attribute 
prompt_identifier: str | None = None

The unique identifier of the prompt.

prompt_version class-attribute instance-attribute 
prompt_version: str | None = None

The version of the prompt to delete. To delete the prompt, omit this field.

Output

DeletePromptOutput dataclass

Dataclass for DeletePromptOutput structure.

Attributes

id instance-attribute 
id: str

The unique identifier of the prompt that was deleted.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

version class-attribute instance-attribute 
version: str | None = None

The version of the prompt that was deleted.