Skip to content

CloudFormation  >  Operations  >  list_stack_sets

list_stack_sets

Operation

list_stack_sets async 

list_stack_sets(input: ListStackSetsInput, plugins: list[Plugin] | None = None) -> ListStackSetsOutput

Returns summary information about StackSets that are associated with the user.

Note

This API provides strongly consistent reads meaning it will always return the most up-to-date data.

  • [Self-managed permissions] If you set the CallAs parameter to SELF while signed in to your Amazon Web Services account, ListStackSets returns all self-managed StackSets in your Amazon Web Services account.

  • [Service-managed permissions] If you set the CallAs parameter to SELF while signed in to the organization's management account, ListStackSets returns all StackSets in the management account.

  • [Service-managed permissions] If you set the CallAs parameter to DELEGATED_ADMIN while signed in to your member account, ListStackSets returns all StackSets with service-managed permissions in the management account.

Parameters:

Name Type Description Default
input ListStackSetsInput

An instance of ListStackSetsInput.

 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
ListStackSetsOutput

An instance of ListStackSetsOutput.

Input

ListStackSetsInput dataclass

Bases: _SerdeShape

Dataclass for ListStackSetsInput structure.

Attributes

call_as class-attribute instance-attribute 
call_as: str | None = ...

[Service-managed permissions] Specifies whether you are acting as an account administrator in the management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for StackSets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

max_results class-attribute instance-attribute 
max_results: int | None = ...

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

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

status class-attribute instance-attribute 
status: str | None = ...

The status of the StackSets that you want to get summary information about.

Output

ListStackSetsOutput dataclass

Bases: _SerdeShape

Dataclass for ListStackSetsOutput structure.

Attributes

next_token class-attribute instance-attribute 
next_token: str | None = ...

If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to 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.

summaries class-attribute instance-attribute 
summaries: list[StackSetSummary] | None = ...

A list of StackSetSummary structures that contain information about the user's StackSets.