AgentsforBedrock / Client / delete_prompt

delete_prompt#

AgentsforBedrock.Client.delete_prompt(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_prompt(
    promptIdentifier='string',
    promptVersion='string'
)
Parameters:
  • promptIdentifier (string) –

    [REQUIRED]

    The unique identifier of the prompt.

  • promptVersion (string) – The version of the prompt to delete. To delete the prompt, omit this field.

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'version': 'string'
}

Response Structure

  • (dict) –

    • id (string) –

      The unique identifier of the prompt that was deleted.

    • version (string) –

      The version of the prompt that was deleted.

Exceptions

  • AgentsforBedrock.Client.exceptions.ThrottlingException

  • AgentsforBedrock.Client.exceptions.AccessDeniedException

  • AgentsforBedrock.Client.exceptions.ValidationException

  • AgentsforBedrock.Client.exceptions.InternalServerException

  • AgentsforBedrock.Client.exceptions.ResourceNotFoundException

  • AgentsforBedrock.Client.exceptions.ConflictException