Skip to content

list_stacks

Operation

list_stacks

list_stacks(request: ListStacksInput | ListStacksInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListStacksInputDict]) -> 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
request ListStacksInput | ListStacksInputDict | 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[ListStacksInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListStacksOutput

An instance of ListStacksOutput.

list_stacks async

list_stacks(request: ListStacksInput | ListStacksInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListStacksInputDict]) -> 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
request ListStacksInput | ListStacksInputDict | 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[ListStacksInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListStacksOutput

An instance of ListStacksOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

ListStacksInputDict

Bases: TypedDict

Dictionary form of ListStacksInput.

Attributes

next_token instance-attribute
next_token: str | None

The token for the next set of items to return. (You received this token from a previous call.)

stack_status_filter instance-attribute
stack_status_filter: Sequence[str] | None

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.

ListStacksInput dataclass

Bases: _SerdeShape

The input for ListStacks action.

Attributes

next_token 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.)

stack_status_filter class-attribute instance-attribute
stack_status_filter: list[str] | None = ...

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

ListStacksOutput dataclass

Bases: _SerdeShape

The output for ListStacks action.

Attributes

next_token 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.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.

stack_summaries class-attribute instance-attribute
stack_summaries: list[StackSummary] | None = ...

A list of StackSummary structures that contains information about the specified stacks.