delete_ai_guard_rail¶
- ArtificialIntelligenceApi.delete_ai_guard_rail(id, role_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶
Delete an AI guard rail
Deletes the Bedrock guard rail and all DynamoDB versions. Blocked for system-created rails or rails still attached to resources or component configurations. Requires owner access.
- Parameters:
id (str) – GuardRailId of the guard rail to delete. (required)
role_id (str) – Role identifier used for authorization. Missing this header returns AUTH-1001. (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Return type:
- Returns:
Returns the result object.
Request and Response Examples¶
HTTP: DELETE /ai/guard-rails/{id}
Success (HTTP 200)¶
Guard rail deleted successfully.
Errors¶
HTTP 400
Invalid Guard Rail ID or unauthorized to delete.
HTTP 500
Internal server error during guard rail deletion.