ListStackSetOperationResults
Returns summary information about the results of a stack set operation.
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,
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 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_ADMIN
Required: No
-
- Filters.member.N
-
The filter to apply to operation results.
Type: Array of OperationResultFilter objects
Array Members: Maximum number of 1 item.
Required: No
- 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.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
If the previous request didn't return all the remaining results, the response object's
NextToken
parameter value is set to a token. To retrieve the next set of results, callListStackSetOperationResults
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
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- OperationId
-
The ID of the stack set 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 unique ID of the stack set that you want to get operation results for.
Type: String
Required: Yes
Response Elements
The following elements are returned by the service.
- NextToken
-
If the request doesn't return all results,
NextToken
is set to a token. To retrieve the next set of results, callListOperationResults
again and assign that token to the request object'sNextToken
parameter. If there are no remaining results,NextToken
is set tonull
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
- Summaries.member.N
-
A list of
StackSetOperationResultSummary
structures that contain information about the specified operation results, for accounts and AWS Regions that are included in the operation.Type: Array of StackSetOperationResultSummary objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- OperationNotFound
-
The specified ID refers to an operation that doesn't exist.
HTTP Status Code: 404
- StackSetNotFound
-
The specified stack set doesn't exist.
HTTP Status Code: 404
Examples
ListStackSetOperationResults
This example illustrates one usage of ListStackSetOperationResults.
Sample Request
https://cloudformation.us-east-1.amazonaws.com/
?Action=ListStackSetOperationResults
&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
<ListStackSetOperationResultsResponse xmlns="http://internal.amazon.com/coral/com.amazonaws.maestro.service.v20160713/">
<ListStackSetOperationResultsResult>
<Summaries>
<member>
<StatusReason>Cancelled since failure tolerance has exceeded</StatusReason>
<Region>us-west-2</Region>
<Account>[account]</Account>
<Status>CANCELLED</Status>
</member>
<member>
<AccountGateResult>
<StatusReason>Account [account] should have 'AWSCloudFormationStackSetAdministrationRole' role with trust relationship to CloudFormation service.</StatusReason>
<Status>FAILED</Status>
</AccountGateResult>
<StatusReason>Account [account] should have 'AWSCloudFormationStackSetAdministrationRole' role with trust relationship to CloudFormation service.</StatusReason>
<Region>us-east-1</Region>
<Account>[account]</Account>
<Status>FAILED</Status>
</member>
</Summaries>
</ListStackSetOperationResultsResult>
<ResponseMetadata>
<RequestId>bf662a8d-7e1b-11e7-98fb-db38example</RequestId>
</ResponseMetadata>
</ListStackSetOperationResultsResponse>
ListStackSetOperationResults
This example illustrates one usage of ListStackSetOperationResults.
Sample Request
https://cloudformation.us-east-1.amazonaws.com/
?Action=ListStackSetOperationResults
&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
<ListStackSetOperationResultsResponse xmlns="http://internal.amazon.com/coral/com.amazonaws.maestro.service.v20160713/">
<ListStackSetOperationResultsResult>
<Summaries>
<member>
<AccountGateResult>
<StatusReason>AWSCloudFormationStackSetAccountGate function not found</StatusReason>
<Status>SKIPPED</Status>
</AccountGateResult>
<Region>us-west-2</Region>
<Account>[account]</Account>
<Status>SUCCEEDED</Status>
</member>
<member>
<AccountGateResult>
<StatusReason>AWSCloudFormationStackSetAccountGate function not found</StatusReason>
<Status>SKIPPED</Status>
</AccountGateResult>
<Region>us-east-1</Region>
<Account>[account]</Account>
<Status>SUCCEEDED</Status>
</member>
</Summaries>
</ListStackSetOperationResultsResult>
<ResponseMetadata>
<RequestId>ee444e6b-7e1b-11e7-8bb3-1f65example</RequestId>
</ResponseMetadata>
</ListStackSetOperationResultsResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: