List Stack Instances
cloudformation_list_stack_instances | R Documentation |
Returns summary information about stack instances that are associated with the specified stack set¶
Description¶
Returns summary information about stack instances that are associated with the specified stack set. 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.
Usage¶
cloudformation_list_stack_instances(StackSetName, NextToken, MaxResults,
Filters, StackInstanceAccount, StackInstanceRegion, CallAs)
Arguments¶
StackSetName
[required] The name or unique ID of the stack set that you want to list stack instances for.
NextToken
If the previous request didn't return all the remaining results, the response's
NextToken
parameter value is set to a token. To retrieve the next set of results, calllist_stack_instances
again and assign that token to the request object'sNextToken
parameter. If there are no remaining results, the previous response object'sNextToken
parameter is set tonull
.MaxResults
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 theNextToken
request parameter to get the next set of results.Filters
The filter to apply to stack instances
StackInstanceAccount
The name of the Amazon Web Services account that you want to list stack instances for.
StackInstanceRegion
The name of the Region where you want to list stack instances.
CallAs
[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. UseSELF
for stack sets 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.
Value¶
A list with the following syntax:
list(
Summaries = list(
list(
StackSetId = "string",
Region = "string",
Account = "string",
StackId = "string",
Status = "CURRENT"|"OUTDATED"|"INOPERABLE",
StatusReason = "string",
StackInstanceStatus = list(
DetailedStatus = "PENDING"|"RUNNING"|"SUCCEEDED"|"FAILED"|"CANCELLED"|"INOPERABLE"|"SKIPPED_SUSPENDED_ACCOUNT"|"FAILED_IMPORT"
),
OrganizationalUnitId = "string",
DriftStatus = "DRIFTED"|"IN_SYNC"|"UNKNOWN"|"NOT_CHECKED",
LastDriftCheckTimestamp = as.POSIXct(
"2015-01-01"
),
LastOperationId = "string"
)
),
NextToken = "string"
)