list_stacks¶
Operation¶
async
¶
list_stacks(input: ListStacksInput, plugins: list[Plugin] | None = None) -> ListStacksOutput
Returns the summary information for stacks whose status matches the
specified StackStatusFilter. Summary information for stacks that have
been deleted is kept for 90 days after the stack is deleted. If no
StackStatusFilter is specified, summary information for all stacks is
returned (including existing stacks and stacks that have been deleted).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListStacksInput
|
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 |
|---|---|
ListStacksOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
The input for ListStacks action.
Attributes¶
class-attribute
instance-attribute
¶
next_token: str | None = ...
The token for the next set of items to return. (You received this token from a previous call.)
class-attribute
instance-attribute
¶
Stack status to use as a filter. Specify one or more stack status codes
to list only stacks with the specified status codes. For a complete list
of stack status codes, see the StackStatus parameter of the Stack data
type.
Output¶
dataclass
¶
Bases: _SerdeShape
The output for ListStacks action.
Attributes¶
class-attribute
instance-attribute
¶
next_token: str | None = ...
If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null.
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.