DescribeStackSetOperation
Returns the description of the specified StackSet operation.
Reports role provisioning and stack instances deployment progress in StatusDetails.Stages. A breakdown for each AWS Region is available in RegionalStatusDetails.
This API provides strongly consistent reads meaning it will always return the most up-to-date data.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- 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,
SELFis specified. UseSELFfor 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 AWS account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the AWS CloudFormation User Guide.
Type: String
Valid Values:
SELF | DELEGATED_ADMINRequired: No
-
- OperationId
-
The unique ID of the StackSet operation.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9][-a-zA-Z0-9]*Required: Yes
- StackSetName
-
The name or the unique stack ID of the StackSet for the stack operation.
Type: String
Required: Yes
Response Elements
The following element is returned by the service.
- StackSetOperation
-
The specified StackSet operation.
Type: StackSetOperation object
Errors
For information about the errors that are common to all actions, see Common Error Types.
- OperationNotFound
-
The specified ID refers to an operation that doesn't exist.
HTTP Status Code: 404
- StackSetNotFound
-
The specified StackSet doesn't exist.
HTTP Status Code: 404
Examples
Describing an Update StackSet Operation
The following example returns information about a successful update of a StackSet and its associated stack instances.
Sample Request
https://cloudformation.us-east-1.amazonaws.com/
?Action=DescribeStackSetOperation
&Version=2010-05-15
&StackSetName=stack-set-example
&OperationId=61806005-bde9-46f1-949d-6791example
&X-Amz-Algorithm=AWS4-HMAC-SHA256
&X-Amz-Credential=[Access key ID and scope]
&X-Amz-Date=20170810T233349Z
&X-Amz-SignedHeaders=content-type;host
&X-Amz-Signature=[Signature]
Sample Response
<DescribeStackSetOperationResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
<DescribeStackSetOperationResult>
<StackSetOperation>
<StackSetId>stack-set-example:c14cd6d1-cd17-40bd-82ed-ff97example</StackSetId>
<CreationTimestamp>2017-08-04T18:01:29.508Z</CreationTimestamp>
<OperationId>ddf16f54-ad62-4d9b-b0ab-3ed8e9example</OperationId>
<Action>UPDATE</Action>
<OperationPreferences>
<FailureToleranceCount>0</FailureToleranceCount>
<MaxConcurrentCount>1</MaxConcurrentCount>
<RegionOrder/>
</OperationPreferences>
<EndTimestamp>2017-08-04T18:03:43.672Z</EndTimestamp>
<Status>SUCCEEDED</Status>
</StackSetOperation>
</DescribeStackSetOperationResult>
<ResponseMetadata>
<RequestId>20133b62-7e1a-11e7-838a-a182example</RequestId>
</ResponseMetadata>
</DescribeStackSetOperationResponse>
Describing a running service-managed operation with progress details
The following example returns information about a running service-managed CREATE operation in which role provisioning failed for two of the ten target accounts. The stack instances for those accounts are skipped, the remaining stack instances are still deploying, and the response includes both stages, the account and stack instance totals, and the breakdown for each Region.
Sample Request
https://cloudformation.us-east-1.amazonaws.com/
?Action=DescribeStackSetOperation
&StackSetName=my-service-managed-stack-set
&OperationId=a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
&Version=2010-05-15
&X-Amz-Algorithm=AWS4-HMAC-SHA256
&X-Amz-Credential=[Access key ID and scope]
&X-Amz-Date=20260702T154500Z
&X-Amz-SignedHeaders=content-type;host
&X-Amz-Signature=[Signature]
Sample Response
<DescribeStackSetOperationResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
<DescribeStackSetOperationResult>
<StackSetOperation>
<StackSetId>my-service-managed-stack-set:8f3d2b6c-1111-2222-3333-exampleabcd</StackSetId>
<CreationTimestamp>2026-07-02T15:42:11.123Z</CreationTimestamp>
<OperationId>a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</OperationId>
<Action>CREATE</Action>
<OperationPreferences>
<RegionConcurrencyType>PARALLEL</RegionConcurrencyType>
<FailureToleranceCount>5</FailureToleranceCount>
<MaxConcurrentCount>10</MaxConcurrentCount>
<RegionOrder>
<member>us-east-1</member>
<member>us-west-2</member>
</RegionOrder>
</OperationPreferences>
<Status>RUNNING</Status>
<StatusDetails>
<Stages>
<RoleProvisioning>
<Status>PARTIAL_SUCCESS</Status>
<SucceededAccountsCount>8</SucceededAccountsCount>
<FailedAccountsCount>2</FailedAccountsCount>
<CompletedAccountsCount>10</CompletedAccountsCount>
<PendingAccountsCount>0</PendingAccountsCount>
<PercentageCompleted>100.0</PercentageCompleted>
</RoleProvisioning>
<StackInstancesDeployment>
<Status>IN_PROGRESS</Status>
<SucceededStackInstancesCount>6</SucceededStackInstancesCount>
<FailedStackInstancesCount>0</FailedStackInstancesCount>
<CompletedStackInstancesCount>10</CompletedStackInstancesCount>
<PendingStackInstancesCount>10</PendingStackInstancesCount>
<SkippedStackInstancesCount>4</SkippedStackInstancesCount>
<CancelledStackInstancesCount>0</CancelledStackInstancesCount>
<PercentageCompleted>50.0</PercentageCompleted>
</StackInstancesDeployment>
</Stages>
<TotalAccountsCount>10</TotalAccountsCount>
<TotalStackInstancesCount>20</TotalStackInstancesCount>
<FailedStackInstancesCount>0</FailedStackInstancesCount>
</StatusDetails>
<RegionalStatusDetails>
<entry>
<key>us-east-1</key>
<value>
<Stages>
<RegionalStackInstancesDeployment>
<Status>IN_PROGRESS</Status>
<SucceededStackInstancesCount>6</SucceededStackInstancesCount>
<FailedStackInstancesCount>0</FailedStackInstancesCount>
<CompletedStackInstancesCount>8</CompletedStackInstancesCount>
<PendingStackInstancesCount>2</PendingStackInstancesCount>
<SkippedStackInstancesCount>2</SkippedStackInstancesCount>
<CancelledStackInstancesCount>0</CancelledStackInstancesCount>
<TotalStackInstancesCount>10</TotalStackInstancesCount>
<PercentageCompleted>80.0</PercentageCompleted>
</RegionalStackInstancesDeployment>
</Stages>
</value>
</entry>
<entry>
<key>us-west-2</key>
<value>
<Stages>
<RegionalStackInstancesDeployment>
<Status>IN_PROGRESS</Status>
<SucceededStackInstancesCount>0</SucceededStackInstancesCount>
<FailedStackInstancesCount>0</FailedStackInstancesCount>
<CompletedStackInstancesCount>2</CompletedStackInstancesCount>
<PendingStackInstancesCount>8</PendingStackInstancesCount>
<SkippedStackInstancesCount>2</SkippedStackInstancesCount>
<CancelledStackInstancesCount>0</CancelledStackInstancesCount>
<TotalStackInstancesCount>10</TotalStackInstancesCount>
<PercentageCompleted>20.0</PercentageCompleted>
</RegionalStackInstancesDeployment>
</Stages>
</value>
</entry>
</RegionalStatusDetails>
</StackSetOperation>
</DescribeStackSetOperationResult>
<ResponseMetadata>
<RequestId>20133b62-7e1a-11e7-838a-a182example</RequestId>
</ResponseMetadata>
</DescribeStackSetOperationResponse>
Describing a Drift Detection StackSet Operation
The following example returns information about a drift detection operation run on a StackSet.
Sample Request
https://cloudformation.us-east-1.amazonaws.com/
?Action=DescribeStackSetOperation
&Version=2010-05-15
&StackSetName=stack-set-drift-example
&OperationId=9cc082fa-df4c-45cd-b9a8-7e5example
&X-Amz-Algorithm=AWS4-HMAC-SHA256
&X-Amz-Credential=[Access key ID and scope]
&X-Amz-Date=20191203T201942Z
&X-Amz-SignedHeaders=content-type;host
&X-Amz-Signature=[Signature]
Sample Response
<DescribeStackSetOperationResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/">
<DescribeStackSetOperationResult>
<StackSetOperation>
<ExecutionRoleName>AWSCloudFormationStackSetExecutionRole</ExecutionRoleName>
<AdministrationRoleARN>arn:aws:iam::012345678910:role/AWSCloudFormationStackSetAdministrationRole</AdministrationRoleARN>
<StackSetId>stack-set-drift-example:bd1f4017-d4f9-432e-a73f-8c22eb708dd5</StackSetId>
<OperationPreferences>
<RegionOrder/>
</OperationPreferences>
<StackSetDriftDetectionDetails>
<InSyncStackInstancesCount>2</InSyncStackInstancesCount>
<FailedStackInstancesCount>0</FailedStackInstancesCount>
<DriftStatus>DRIFTED</DriftStatus>
<TotalStackInstancesCount>7</TotalStackInstancesCount>
<DriftedStackInstancesCount>1</DriftedStackInstancesCount>
<InProgressStackInstancesCount>4</InProgressStackInstancesCount>
<LastDriftCheckTimestamp>2019-12-04T20:34:28.543Z</LastDriftCheckTimestamp>
</StackSetDriftDetectionDetails>
<CreationTimestamp>2019-12-04T20:33:13.673Z</CreationTimestamp>
<OperationId>9cc082fa-df4c-45cd-b9a8-7e5example</OperationId>
<Action>DETECT_DRIFT</Action>
<Status>RUNNING</Status>
</StackSetOperation>
</DescribeStackSetOperationResult>
<ResponseMetadata>
<RequestId>e81844dc-6121-4b59-923a-e2417example</RequestId>
</ResponseMetadata>
</DescribeStackSetOperationResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: