list_guardrails¶
Operation¶
list_guardrails
¶
list_guardrails(request: ListGuardrailsInput | ListGuardrailsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListGuardrailsInputDict]) -> 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 |
|---|---|---|---|
request
|
ListGuardrailsInput | ListGuardrailsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[ListGuardrailsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListGuardrailsOutput
|
An instance of |
list_guardrails
async
¶
list_guardrails(request: ListGuardrailsInput | ListGuardrailsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListGuardrailsInputDict]) -> 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 |
|---|---|---|---|
request
|
ListGuardrailsInput | ListGuardrailsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[ListGuardrailsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListGuardrailsOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
ListGuardrailsInputDict
¶
Bases: TypedDict
Dictionary form of ListGuardrailsInput.
ListGuardrailsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListGuardrailsInput structure.
Attributes¶
guardrail_identifier
class-attribute
instance-attribute
¶
guardrail_identifier: str | None = ...
The unique identifier of the guardrail. This can be an ID or the ARN.
Output¶
ListGuardrailsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListGuardrailsOutput structure.
Attributes¶
guardrails
instance-attribute
¶
guardrails: list[GuardrailSummary]
A list of objects, each of which contains details about a guardrail.
next_token
class-attribute
instance-attribute
¶
next_token: str | 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.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.