:doc:`CloudFormation <../../cloudformation>` / Paginator / ListStackRefactors

******************
ListStackRefactors
******************



.. py:class:: CloudFormation.Paginator.ListStackRefactors

  ::

    
    paginator = client.get_paginator('list_stack_refactors')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`CloudFormation.Client.list_stack_refactors`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListStackRefactors>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          ExecutionStatusFilter=[
              'UNAVAILABLE'|'AVAILABLE'|'OBSOLETE'|'EXECUTE_IN_PROGRESS'|'EXECUTE_COMPLETE'|'EXECUTE_FAILED'|'ROLLBACK_IN_PROGRESS'|'ROLLBACK_COMPLETE'|'ROLLBACK_FAILED',
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type ExecutionStatusFilter: list
    :param ExecutionStatusFilter: 

      Execution status to use as a filter. Specify one or more execution status codes to list only stack refactors with the specified execution status codes.

      

    
      - *(string) --* 

      
  
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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 ``NextToken`` will 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 ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'StackRefactorSummaries': [
                {
                    'StackRefactorId': 'string',
                    'Description': 'string',
                    'ExecutionStatus': 'UNAVAILABLE'|'AVAILABLE'|'OBSOLETE'|'EXECUTE_IN_PROGRESS'|'EXECUTE_COMPLETE'|'EXECUTE_FAILED'|'ROLLBACK_IN_PROGRESS'|'ROLLBACK_COMPLETE'|'ROLLBACK_FAILED',
                    'ExecutionStatusReason': 'string',
                    'Status': 'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'CREATE_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_COMPLETE'|'DELETE_FAILED',
                    'StatusReason': 'string'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **StackRefactorSummaries** *(list) --* 

          Provides a summary of a stack refactor, including the following:

           

          
          * ``StackRefactorId``
           
          * ``Status``
           
          * ``StatusReason``
           
          * ``ExecutionStatus``
           
          * ``ExecutionStatusReason``
           
          * ``Description``
          

          
          

          - *(dict) --* 

            The summary of a stack refactor operation.

            
            

            - **StackRefactorId** *(string) --* 

              The ID associated with the stack refactor created from the  CreateStackRefactor action.

              
            

            - **Description** *(string) --* 

              A description to help you identify the refactor.

              
            

            - **ExecutionStatus** *(string) --* 

              The operation status that's provided after calling the  ExecuteStackRefactor action.

              
            

            - **ExecutionStatusReason** *(string) --* 

              A detailed explanation for the stack refactor ``ExecutionStatus``.

              
            

            - **Status** *(string) --* 

              The stack refactor operation status that's provided after calling the  CreateStackRefactor action.

              
            

            - **StatusReason** *(string) --* 

              A detailed explanation for the stack refactor ``Status``.

              
        
      
    