CloudFormation / Paginator / ListStackSetOperations
ListStackSetOperations¶
- class CloudFormation.Paginator.ListStackSetOperations¶
paginator = client.get_paginator('list_stack_set_operations')
- paginate(**kwargs)¶
Creates an iterator that will paginate through responses from
CloudFormation.Client.list_stack_set_operations().See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( StackSetName='string', CallAs='SELF'|'DELEGATED_ADMIN', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
StackSetName (string) –
[REQUIRED]
The name or unique ID of the StackSet that you want to get operation summaries for.
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,
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 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.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextTokenwill be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextTokenfrom a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'Summaries': [ { 'OperationId': 'string', 'Action': 'CREATE'|'UPDATE'|'DELETE'|'DETECT_DRIFT', 'Status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'STOPPING'|'STOPPED'|'QUEUED', 'CreationTimestamp': datetime(2015, 1, 1), 'EndTimestamp': datetime(2015, 1, 1), 'StatusReason': 'string', 'StatusDetails': { 'Stages': { 'RoleProvisioning': { 'Status': 'PENDING'|'NOT_APPLICABLE'|'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'PARTIAL_SUCCESS'|'FAILED', 'SucceededAccountsCount': 123, 'FailedAccountsCount': 123, 'CompletedAccountsCount': 123, 'PendingAccountsCount': 123, 'PercentageCompleted': 123.0 }, 'StackInstancesDeployment': { 'Status': 'PENDING'|'NOT_APPLICABLE'|'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'PARTIAL_SUCCESS'|'FAILED', 'SucceededStackInstancesCount': 123, 'FailedStackInstancesCount': 123, 'CompletedStackInstancesCount': 123, 'PendingStackInstancesCount': 123, 'CancelledStackInstancesCount': 123, 'SkippedStackInstancesCount': 123, 'PercentageCompleted': 123.0 } }, 'TotalAccountsCount': 123, 'TotalStackInstancesCount': 123, 'FailedStackInstancesCount': 123 }, 'OperationPreferences': { 'RegionConcurrencyType': 'SEQUENTIAL'|'PARALLEL', 'RegionOrder': [ 'string', ], 'FailureToleranceCount': 123, 'FailureTolerancePercentage': 123, 'MaxConcurrentCount': 123, 'MaxConcurrentPercentage': 123, 'ConcurrencyMode': 'STRICT_FAILURE_TOLERANCE'|'SOFT_FAILURE_TOLERANCE' } }, ], }
Response Structure
(dict) –
Summaries (list) –
A list of
StackSetOperationSummarystructures that contain summary information about operations for the specified StackSet.(dict) –
The structures that contain summary information about the specified operation.
OperationId (string) –
The unique ID of the StackSet operation.
Action (string) –
The type of operation:
CREATE,UPDATE, orDELETE. Create and delete operations affect only the specified stack instances that are associated with the specified StackSet. Update operations affect both the StackSet itself and all associated StackSet instances.Status (string) –
The overall status of the operation.
FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you’ve set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set toFAILED. This in turn sets the status of the operation as a whole toFAILED, and CloudFormation cancels the operation in any remaining Regions.QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the StackSet status codes in the CloudFormation User Guide.RUNNING: The operation is currently being performed.STOPPED: The user has canceled the operation.STOPPING: The operation is in the process of stopping, at user request.SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.
CreationTimestamp (datetime) –
The time at which the operation was initiated. Note that the creation times for the StackSet operation might differ from the creation time of the individual stacks themselves. This is because CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually creating the first stacks.
EndTimestamp (datetime) –
The time at which the StackSet operation ended, across all accounts and Regions specified. Note that this doesn’t necessarily mean that the StackSet operation was successful, or even attempted, in each account or Region.
StatusReason (string) –
The status of the operation in details.
StatusDetails (dict) –
Detailed information about the StackSet operation.
Stages (dict) –
The detailed progress information for the individual stages of the StackSet operation: the role provisioning stage and the stack instances deployment stage.
RoleProvisioning (dict) –
The progress detail for the role provisioning stage. For operations that do not provision roles, this stage is present with a
StatusofNOT_APPLICABLE.Status (string) –
The status of the role provisioning stage can be one of the following values:
NOT_APPLICABLE: The operation does not provision roles. This includes self-managed operations and service-managed operations whose configuration does not require role provisioning.NOT_STARTED: Role provisioning has not started. The operation has not begun resolving target accounts, or it failed or stopped before the total number of target accounts was resolved.IN_PROGRESS: Role provisioning is actively processing target accounts.SUCCEEDED: Role provisioning finished and succeeded for all target accounts.PARTIAL_SUCCESS: Role provisioning finished, but succeeded for only a subset of target accounts; one or more accounts failed.FAILED: Role provisioning finished and failed for all target accounts.
SucceededAccountsCount (integer) –
The number of accounts for which role provisioning succeeded.
FailedAccountsCount (integer) –
The number of accounts for which role provisioning failed.
CompletedAccountsCount (integer) –
The number of accounts that have finished role provisioning, including both succeeded and failed accounts.
PendingAccountsCount (integer) –
The number of accounts that are still awaiting role provisioning.
PercentageCompleted (float) –
The percentage of accounts that have completed role provisioning.
StackInstancesDeployment (dict) –
The progress detail for the stack instances deployment stage. This stage reports the deployment of stack instances to the target accounts and Amazon Web Services Regions, after any role provisioning has finished.
Status (string) –
The status of the stack instances deployment stage can be one of the following values:
NOT_APPLICABLE: The operation does not deploy stack instances, such as a drift detection operation.NOT_STARTED: Stack instances deployment has not started. The operation is still provisioning roles, has not begun, or failed before this stage was reached.IN_PROGRESS: At least one stack instance has started deploying.SUCCEEDED: Deployment finished and succeeded for all stack instances that were not skipped.PARTIAL_SUCCESS: Deployment finished with a mix of succeeded, failed, and canceled stack instances.FAILED: Deployment finished and every stack instance that was not skipped failed or was canceled.
SucceededStackInstancesCount (integer) –
The number of stack instances that deployed successfully.
FailedStackInstancesCount (integer) –
The number of stack instances that failed to deploy.
CompletedStackInstancesCount (integer) –
The number of stack instances that have reached a final state. This count includes stack instances that succeeded, failed, were skipped, or were canceled.
PendingStackInstancesCount (integer) –
The number of stack instances that have not reached a final state. This is the total number of stack instances minus the completed count.
CancelledStackInstancesCount (integer) –
The number of stack instances that were canceled because the operation exceeded its failure tolerance or was stopped.
SkippedStackInstancesCount (integer) –
The number of stack instances that were skipped because role provisioning failed for their target account.
PercentageCompleted (float) –
The percentage of stack instances that have reached a final state.
TotalAccountsCount (integer) –
The total number of accounts targeted by this StackSet operation. Self-managed operations and service-managed operations that do not provision roles also report this value when it is known. CloudFormation populates this value after it resolves the target accounts. Until then, this field is not present.
TotalStackInstancesCount (integer) –
The total number of stack instances targeted by this StackSet operation. CloudFormation populates this value after it resolves the target stack instances. Until then, this field is not present.
FailedStackInstancesCount (integer) –
The number of stack instances for which the StackSet operation failed.
OperationPreferences (dict) –
The user-specified preferences for how CloudFormation performs a StackSet operation.
For more information about maximum concurrent accounts and failure tolerance, see StackSet operation options.
RegionConcurrencyType (string) –
The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
RegionOrder (list) –
The order of the Regions where you want to perform the stack operation.
(string) –
FailureToleranceCount (integer) –
The number of accounts per Region this operation can fail in before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn’t attempt the operation in any subsequent Regions.
You can specify either
FailureToleranceCountorFailureTolerancePercentage, but not both.By default,
0is specified.FailureTolerancePercentage (integer) –
The percentage of accounts per Region this stack operation can fail in before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn’t attempt the operation in any subsequent Regions.
When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number.
You can specify either
FailureToleranceCountorFailureTolerancePercentage, but not both.By default,
0is specified.MaxConcurrentCount (integer) –
The maximum number of accounts in which to perform this operation at one time. This can depend on the value of
FailureToleranceCountdepending on yourConcurrencyMode.MaxConcurrentCountis at most one more than theFailureToleranceCountif you’re usingSTRICT_FAILURE_TOLERANCE.Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.
You can specify either
MaxConcurrentCountorMaxConcurrentPercentage, but not both.By default,
1is specified.MaxConcurrentPercentage (integer) –
The maximum percentage of accounts in which to perform this operation at one time.
When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.
Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.
You can specify either
MaxConcurrentCountorMaxConcurrentPercentage, but not both.By default,
1is specified.ConcurrencyMode (string) –
Specifies how the concurrency level behaves during the operation execution.
STRICT_FAILURE_TOLERANCE: This option dynamically lowers the concurrency level to ensure the number of failed accounts never exceeds the value ofFailureToleranceCount+1. The initial actual concurrency is set to the lower of either the value of theMaxConcurrentCount, or the value ofFailureToleranceCount+1. The actual concurrency is then reduced proportionally by the number of failures. This is the default behavior. If failure tolerance or Maximum concurrent accounts are set to percentages, the behavior is similar.SOFT_FAILURE_TOLERANCE: This option decouplesFailureToleranceCountfrom the actual concurrency. This allows StackSet operations to run at the concurrency level set by theMaxConcurrentCountvalue, orMaxConcurrentPercentage, regardless of the number of failures.