list_actors¶
Operation¶
list_actors
¶
list_actors(request: ListActorsInput | ListActorsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListActorsInputDict]) -> ListActorsOutput
Lists all actors in an AgentCore Memory resource. We recommend using pagination to ensure that the operation returns quickly and successfully.
To use this operation, you must have the bedrock-agentcore:ListActors
permission.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListActorsInput | ListActorsInputDict | 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[ListActorsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListActorsOutput
|
An instance of |
list_actors
async
¶
list_actors(request: ListActorsInput | ListActorsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListActorsInputDict]) -> ListActorsOutput
Lists all actors in an AgentCore Memory resource. We recommend using pagination to ensure that the operation returns quickly and successfully.
To use this operation, you must have the bedrock-agentcore:ListActors
permission.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListActorsInput | ListActorsInputDict | 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[ListActorsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListActorsOutput
|
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.
ListActorsInputDict
¶
Bases: TypedDict
Dictionary form of ListActorsInput.
ListActorsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListActorsInput structure.
Attributes¶
max_results
class-attribute
instance-attribute
¶
max_results: int = ...
The maximum number of results to return in a single call. The default value is 20.
Output¶
ListActorsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListActorsOutput structure.
Attributes¶
actor_summaries
instance-attribute
¶
actor_summaries: list[ActorSummary]
The list of actor summaries.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
The token to use in a subsequent request to get the next set of results. This value is null when there are no more results to return.
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.