Skip to content

AccountGateResult

Source code in docs_src/capo_cloudformation/types/account_gate_result.py
class AccountGateResult(TypedDict, closed=True):
    status: NotRequired[
        "capo_cloudformation.types.account_gate_status.AccountGateStatus"
    ]
    """<p>The status of the account gate function.</p> <ul> <li> <p> <code>SUCCEEDED</code>: The account gate function has determined that the account and Region passes any requirements for a StackSet operation to occur. CloudFormation proceeds with the stack operation in that account and Region.</p> </li> <li> <p> <code>FAILED</code>: The account gate function has determined that the account and Region doesn't meet the requirements for a StackSet operation to occur. CloudFormation cancels the StackSet operation in that account and Region, and sets the StackSet operation result status for that account and Region to <code>FAILED</code>.</p> </li> <li> <p> <code>SKIPPED</code>: CloudFormation has skipped calling the account gate function for this account and Region, for one of the following reasons:</p> <ul> <li> <p>An account gate function hasn't been specified for the account and Region. CloudFormation proceeds with the StackSet operation in this account and Region.</p> </li> <li> <p>The <code>AWSCloudFormationStackSetExecutionRole</code> of the administration account lacks permissions to invoke the function. CloudFormation proceeds with the StackSet operation in this account and Region.</p> </li> <li> <p>Either no action is necessary, or no action is possible, on the stack. CloudFormation skips the StackSet operation in this account and Region.</p> </li> </ul> </li> </ul>"""
    status_reason: NotRequired[
        "capo_cloudformation.types.account_gate_status_reason.AccountGateStatusReason"
    ]
    """<p>The reason for the account gate status assigned to this account and Region for the StackSet operation.</p>"""

status instance-attribute

status: NotRequired[AccountGateStatus]

The status of the account gate function.

  • SUCCEEDED: The account gate function has determined that the account and Region passes any requirements for a StackSet operation to occur. CloudFormation proceeds with the stack operation in that account and Region.

  • FAILED: The account gate function has determined that the account and Region doesn't meet the requirements for a StackSet operation to occur. CloudFormation cancels the StackSet operation in that account and Region, and sets the StackSet operation result status for that account and Region to FAILED.

  • SKIPPED: CloudFormation has skipped calling the account gate function for this account and Region, for one of the following reasons:

    • An account gate function hasn't been specified for the account and Region. CloudFormation proceeds with the StackSet operation in this account and Region.

    • The AWSCloudFormationStackSetExecutionRole of the administration account lacks permissions to invoke the function. CloudFormation proceeds with the StackSet operation in this account and Region.

    • Either no action is necessary, or no action is possible, on the stack. CloudFormation skips the StackSet operation in this account and Region.

status_reason instance-attribute

status_reason: NotRequired[AccountGateStatusReason]

The reason for the account gate status assigned to this account and Region for the StackSet operation.