stack_set_operation_results

Creates, updates, deletes, gets or lists a stack_set_operation_results resource.

Overview

Name	stack_set_operation_results
Type	Resource
Id	aws.cloudformation.stack_set_operation_results

Fields

The following fields are returned by SELECT queries:

list_stack_set_operation_results

Name	Datatype	Description
account	string	[Self-managed permissions] The name of the Amazon Web Services account for this operation result.
account_gate_result	string	The results of the account gate function CloudFormation invokes, if present, before proceeding with StackSet operations in an account.
organizational_unit_id	string	[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.
region	string	The name of the Amazon Web Services Region for this operation result.
status	string	The result status of the StackSet operation for the given account in the given Region. CANCELLED: The operation in the specified account and Region has been canceled. This is either because a user has stopped the StackSet operation, or because the failure tolerance of the StackSet operation has been exceeded. FAILED: The operation in the specified account and Region failed. If the StackSet operation fails in enough accounts within a Region, the failure tolerance for the StackSet operation as a whole might be exceeded. RUNNING: The operation in the specified account and Region is currently in progress. PENDING: The operation in the specified account and Region has yet to start. SUCCEEDED: The operation in the specified account and Region completed successfully.
status_reason	string	The reason for the assigned result status.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_stack_set_operation_results	select	StackSetName, OperationId, region	NextToken, MaxResults, CallAs, Filters	Returns summary information about the results of a StackSet operation. This API provides eventually consistent reads meaning it may take some time but will eventually return the most up-to-date data.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
OperationId	string	The ID of the StackSet operation.
StackSetName	string	The name or unique ID of the StackSet that you want to get operation results for.
region	string	AWS region (default: us-east-1)
CallAs	string	[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.
Filters	array	The filter to apply to operation results.
MaxResults	integer	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.
NextToken	string	The token for the next set of items to return. (You received this token from a previous call.)

SELECT examples

list_stack_set_operation_results

Returns summary information about the results of a StackSet operation. This API provides eventually consistent reads meaning it may take some time but will eventually return the most up-to-date data.

SELECT
account,
account_gate_result,
organizational_unit_id,
region,
status,
status_reason
FROM aws.cloudformation.stack_set_operation_results
WHERE StackSetName = '{{ StackSetName }}' -- required
AND OperationId = '{{ OperationId }}' -- required
AND region = '{{ region }}' -- required
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
AND CallAs = '{{ CallAs }}'
AND Filters = '{{ Filters }}'
;