list_flow_aliases¶
Operation¶
list_flow_aliases
async
¶
list_flow_aliases(input: ListFlowAliasesInput, plugins: list[Plugin] | None = None) -> ListFlowAliasesOutput
Returns a list of aliases for a flow.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListFlowAliasesInput
|
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 |
|---|---|
ListFlowAliasesOutput
|
An instance of |
Input¶
ListFlowAliasesInput
dataclass
¶
Dataclass for ListFlowAliasesInput structure.
Attributes¶
flow_identifier
class-attribute
instance-attribute
¶
flow_identifier: str | None = None
The unique identifier of the flow for which aliases are being returned.
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¶
ListFlowAliasesOutput
dataclass
¶
Dataclass for ListFlowAliasesOutput structure.
Attributes¶
flow_alias_summaries
instance-attribute
¶
flow_alias_summaries: list[FlowAliasSummary]
A list, each member of which contains information about an alias.
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.