list_stack_instances¶
Operation¶
async
¶
list_stack_instances(input: ListStackInstancesInput, plugins: list[Plugin] | None = None) -> ListStackInstancesOutput
Returns summary information about stack instances that are associated with the specified StackSet. You can filter for stack instances that are associated with a specific Amazon Web Services account name or Region, or that have a specific status.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListStackInstancesInput
|
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 |
|---|---|
ListStackInstancesOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ListStackInstancesInput structure.
Attributes¶
class-attribute
instance-attribute
¶
call_as: str | None = ...
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's 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.
class-attribute
instance-attribute
¶
filters: list[StackInstanceFilter] | None = ...
The filter to apply to stack instances
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.
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_instance_account: str | None = ...
The name of the Amazon Web Services account that you want to list stack instances for.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ListStackInstancesOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
next_token: str | None = ...
If the request doesn't return all 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.
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.
class-attribute
instance-attribute
¶
summaries: list[StackInstanceSummary] | None = ...
A list of StackInstanceSummary structures that contain information
about the specified stack instances.