AgentsforBedrock / Client / delete_retrieval_instruction

delete_retrieval_instruction

AgentsforBedrock.Client.delete_retrieval_instruction(**kwargs)

Deletes a retrieval instruction or a single version of it. Omit retrievalInstructionVersion to delete the retrieval instruction itself; the service rejects that request with ConflictException while the retrieval instruction has versions or while lastTransitionStatus is CREATING or UPDATING. Specify retrievalInstructionVersion to delete only that version; the retrieval instruction and its other versions are unaffected.

See also: AWS API Documentation

Request Syntax

response = client.delete_retrieval_instruction(
    retrievalInstructionId='string',
    retrievalInstructionVersion='string'
)
Parameters:

  • retrievalInstructionId (string) –

    [REQUIRED]

    The identifier of the retrieval instruction to delete.

  • retrievalInstructionVersion (string) – The version to delete. Omit this field to delete the retrieval instruction itself, which you can do only when it has no versions; while any version exists the service rejects the request with ConflictException. You cannot delete DRAFT on its own; deleting the retrieval instruction removes it.

Return type:

dict

Returns:

Response Syntax

{
    'retrievalInstructionId': 'string',
    'retrievalInstructionArn': 'string',
    'version': 'string'
}

Response Structure

  • (dict) –

    • retrievalInstructionId (string) –

      The identifier of the deleted retrieval instruction.

    • retrievalInstructionArn (string) –

      The ARN of the retrieval instruction.

    • version (string) –

      The version that you deleted. Absent when you deleted the whole retrieval instruction.

Exceptions