list_guardrails¶
Operation¶
async
¶
list_guardrails(input: ListGuardrailsInput, plugins: list[Plugin] | None = None) -> ListGuardrailsOutput
Lists details about all the guardrails in an account. To list the
DRAFT version of all your guardrails, don't specify the
guardrailIdentifier field. To list all versions of a guardrail,
specify the ARN of the guardrail in the guardrailIdentifier field.
You can set the maximum number of results to return in a response in the
maxResults field. If there are more results than the number you set,
the response returns a nextToken that you can send in another
ListGuardrails request to see the next batch of results.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListGuardrailsInput
|
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 |
|---|---|
ListGuardrailsOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for ListGuardrailsInput structure.
Attributes¶
class-attribute
instance-attribute
¶
guardrail_identifier: str | None = None
The unique identifier of the guardrail. This can be an ID or the ARN.
class-attribute
instance-attribute
¶
max_results: int | None = None
The maximum number of results to return in the response.
class-attribute
instance-attribute
¶
next_token: str | None = None
If there are more results than were returned in the response, the
response returns a nextToken that you can send in another
ListGuardrails request to see the next batch of results.
Output¶
dataclass
¶
Dataclass for ListGuardrailsOutput structure.
Attributes¶
instance-attribute
¶
guardrails: list[GuardrailSummary]
A list of objects, each of which contains details about a guardrail.
class-attribute
instance-attribute
¶
next_token: str | None = None
If there are more results than were returned in the response, the
response returns a nextToken that you can send in another
ListGuardrails request to see the next batch of results.