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:
-
prompt_identifier
(PromptIdentifier)
–
The unique identifier of the prompt.
-
prompt_version
(Optional[NumericalVersion], default:
None
)
–
The version of the prompt to delete. To delete the prompt, omit this field.
Raises:
Source code in docs_src/capo_bedrock_agent/_services/async_bedrock_agent.py
| async def delete_prompt(
self,
prompt_identifier: "capo_bedrock_agent.types.prompt_identifier.PromptIdentifier",
*,
config_overrides: Optional[AsyncBedrockAgentClientConfig] = None,
prompt_version: Optional[
"capo_bedrock_agent.types.numerical_version.NumericalVersion"
] = None,
) -> "capo_bedrock_agent.types.delete_prompt_response.DeletePromptResponse":
"""<p>Deletes 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-delete.html">Delete prompts from the Prompt management tool</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-deploy.html#prompt-management-versions-delete.html">Delete a version of a prompt from the Prompt management tool</a> in the Amazon Bedrock User Guide.</p>
Args:
prompt_identifier: <p>The unique identifier of the prompt.</p>
prompt_version: <p>The version of the prompt to delete. To delete the prompt, omit this field.</p>
Raises:
capo_bedrock_agent.errors.access_denied_exception.AccessDeniedException: <p>The request is denied because of missing access permissions.</p>
capo_bedrock_agent.errors.conflict_exception.ConflictException: <p>There was a conflict performing an operation.</p>
capo_bedrock_agent.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred. Retry your request.</p>
capo_bedrock_agent.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
capo_bedrock_agent.errors.throttling_exception.ThrottlingException: <p>The number of requests exceeds the limit. Resubmit your request later.</p>
capo_bedrock_agent.errors.validation_exception.ValidationException: <p>Input validation failed. Check your request parameters and retry the request.</p>
capo_bedrock_agent.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_bedrock_agent.types.delete_prompt_request.DeletePromptRequest]",
) -> AsyncOperationResponse[
"capo_bedrock_agent.types.delete_prompt_response.DeletePromptResponse"
]:
import capo_bedrock_agent._operations.amazon_bedrock_agent_build_time_lambda.delete_prompt
(
output,
http_response,
) = await capo_bedrock_agent._operations.amazon_bedrock_agent_build_time_lambda.delete_prompt.async_delete_prompt(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeletePrompt")
)
input_: capo_bedrock_agent.types.delete_prompt_request.DeletePromptRequest = {
"prompt_identifier": prompt_identifier
}
if prompt_version is not None:
input_["prompt_version"] = prompt_version
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|