describe_stack_instance ¶

def describe_stack_instance(
    self,
    *,
    config_overrides: Optional[CloudFormationClientConfig] = None,
    stack_set_name: Optional[
        "capo_cloudformation.types.stack_set_name.StackSetName"
    ] = None,
    stack_instance_account: Optional[
        "capo_cloudformation.types.account.Account"
    ] = None,
    stack_instance_region: Optional[
        "capo_cloudformation.types.region.Region"
    ] = None,
    call_as: Optional["capo_cloudformation.types.call_as.CallAs"] = None,
) -> "capo_cloudformation.types.describe_stack_instance_output.DescribeStackInstanceOutput":
    """<p>Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and Amazon Web Services Region.</p> <p>For a list of stack instances that are associated with a specific StackSet, use <a>ListStackInstances</a>.</p>

    Args:
        stack_set_name: <p>The name or the unique stack ID of the StackSet that you want to get stack instance information for.</p>
        stack_instance_account: <p>The ID of an Amazon Web Services account that's associated with this stack instance.</p>
        stack_instance_region: <p>The name of a Region that's associated with this stack instance.</p>
        call_as: <p>[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.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for StackSets with self-managed permissions.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p> </li> </ul>

    Raises:
        capo_cloudformation.errors.stack_instance_not_found_exception.StackInstanceNotFoundException: <p>The specified stack instance doesn't exist.</p>
        capo_cloudformation.errors.stack_set_not_found_exception.StackSetNotFoundException: <p>The specified StackSet doesn't exist.</p>
        capo_cloudformation.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_cloudformation.types.describe_stack_instance_input.DescribeStackInstanceInput]",
    ) -> OperationResponse[
        "capo_cloudformation.types.describe_stack_instance_output.DescribeStackInstanceOutput"
    ]:
        import capo_cloudformation._operations.cloud_formation.describe_stack_instance

        output, http_response = (
            capo_cloudformation._operations.cloud_formation.describe_stack_instance.describe_stack_instance(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeStackInstance")
    )
    input_: capo_cloudformation.types.describe_stack_instance_input.DescribeStackInstanceInput = {}
    if stack_set_name is not None:
        input_["stack_set_name"] = stack_set_name
    if stack_instance_account is not None:
        input_["stack_instance_account"] = stack_instance_account
    if stack_instance_region is not None:
        input_["stack_instance_region"] = stack_instance_region
    if call_as is not None:
        input_["call_as"] = call_as

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output