delete_guardrail¶
Operation¶
delete_guardrail
async
¶
delete_guardrail(input: DeleteGuardrailInput, plugins: list[Plugin] | None = None) -> DeleteGuardrailOutput
Deletes a guardrail.
-
To delete a guardrail, only specify the ARN of the guardrail in the
guardrailIdentifierfield. If you delete a guardrail, all of its versions will be deleted. -
To delete a version of a guardrail, specify the ARN of the guardrail in the
guardrailIdentifierfield and the version in theguardrailVersionfield.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
DeleteGuardrailInput
|
An instance of |
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 |
|---|---|
DeleteGuardrailOutput
|
An instance of |
Input¶
DeleteGuardrailInput
dataclass
¶
Dataclass for DeleteGuardrailInput structure.
Attributes¶
guardrail_identifier
class-attribute
instance-attribute
¶
guardrail_identifier: str | None = None
The unique identifier of the guardrail. This can be an ID or the ARN.
guardrail_version
class-attribute
instance-attribute
¶
guardrail_version: str | None = None
The version of the guardrail.
Output¶
DeleteGuardrailOutput
dataclass
¶
Dataclass for DeleteGuardrailOutput structure.