list_agent_aliases¶
Operation¶
list_agent_aliases
async
¶
list_agent_aliases(input: ListAgentAliasesInput, plugins: list[Plugin] | None = None) -> ListAgentAliasesOutput
Lists the aliases of an agent and information about each one.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListAgentAliasesInput
|
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 |
|---|---|
ListAgentAliasesOutput
|
An instance of |
Input¶
ListAgentAliasesInput
dataclass
¶
Dataclass for ListAgentAliasesInput structure.
Attributes¶
agent_id
class-attribute
instance-attribute
¶
agent_id: str | None = None
The unique identifier of the agent.
max_results
class-attribute
instance-attribute
¶
max_results: int | None = None
The maximum number of results to return in the response. If the total
number of results is greater than this value, use the token returned in
the response in the nextToken field when making another request to
return the next batch of results.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = None
If the total number of results is greater than the maxResults value
provided in the request, enter the token returned in the nextToken
field in the response in this field to return the next batch of results.
Output¶
ListAgentAliasesOutput
dataclass
¶
Dataclass for ListAgentAliasesOutput structure.
Attributes¶
agent_alias_summaries
instance-attribute
¶
agent_alias_summaries: list[AgentAliasSummary]
A list of objects, each of which contains information about an alias of the agent.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = None
If the total number of results is greater than the maxResults value
provided in the request, use this token when making another request in
the nextToken field to return the next batch of results.