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

************************
ListStackRefactorActions
************************



.. py:class:: CloudFormation.Paginator.ListStackRefactorActions

  ::

    
    paginator = client.get_paginator('list_stack_refactor_actions')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          StackRefactorId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type StackRefactorId: string
    :param StackRefactorId: **[REQUIRED]** 

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

      

    
    :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**

      
      ::

        {
            'StackRefactorActions': [
                {
                    'Action': 'MOVE'|'CREATE',
                    'Entity': 'RESOURCE'|'STACK',
                    'PhysicalResourceId': 'string',
                    'ResourceIdentifier': 'string',
                    'Description': 'string',
                    'Detection': 'AUTO'|'MANUAL',
                    'DetectionReason': 'string',
                    'TagResources': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ],
                    'UntagResources': [
                        'string',
                    ],
                    'ResourceMapping': {
                        'Source': {
                            'StackName': 'string',
                            'LogicalResourceId': 'string'
                        },
                        'Destination': {
                            'StackName': 'string',
                            'LogicalResourceId': 'string'
                        }
                    }
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **StackRefactorActions** *(list) --* 

          The stack refactor actions.

          
          

          - *(dict) --* 

            Describes the stack and the action that CloudFormation will perform on it if you execute the stack refactor.

            
            

            - **Action** *(string) --* 

              The action that CloudFormation takes on the stack.

              
            

            - **Entity** *(string) --* 

              The type that will be evaluated in the ``StackRefactorAction``. The following are potential ``Entity`` types:

               

              
              * ``Stack``
               
              * ``Resource``
              

              
            

            - **PhysicalResourceId** *(string) --* 

              The name or unique identifier associated with the physical instance of the resource.

              
            

            - **ResourceIdentifier** *(string) --* 

              A key-value pair that identifies the target resource. The key is an identifier property (for example, ``BucketName`` for ``AWS::S3::Bucket`` resources) and the value is the actual property value (for example, ``MyS3Bucket``).

              
            

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

              A description to help you identify the refactor.

              
            

            - **Detection** *(string) --* 

              The detection type is one of the following:

               

              
              * Auto: CloudFormation figured out the mapping on its own.
               
              * Manual: The customer provided the mapping in the ``ResourceMapping`` parameter.
              

              
            

            - **DetectionReason** *(string) --* 

              The description of the detection type.

              
            

            - **TagResources** *(list) --* 

              Assigns one or more tags to specified resources.

              
              

              - *(dict) --* 

                The Tag type enables you to specify a key-value pair that can be used to store information about an CloudFormation stack.

                
                

                - **Key** *(string) --* 

                  A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services have the reserved prefix: ``aws:``.

                  
                

                - **Value** *(string) --* 

                  A string that contains the value for this tag. You can specify a maximum of 256 characters for a tag value.

                  
            
          
            

            - **UntagResources** *(list) --* 

              Removes one or more tags to specified resources.

              
              

              - *(string) --* 
          
            

            - **ResourceMapping** *(dict) --* 

              The mapping for the stack resource ``Source`` and stack resource ``Destination``.

              
              

              - **Source** *(dict) --* 

                The source stack ``StackName`` and ``LogicalResourceId`` for the resource being refactored.

                
                

                - **StackName** *(string) --* 

                  The name associated with the stack.

                  
                

                - **LogicalResourceId** *(string) --* 

                  The logical name of the resource specified in the template.

                  
            
              

              - **Destination** *(dict) --* 

                The destination stack ``StackName`` and ``LogicalResourceId`` for the resource being refactored.

                
                

                - **StackName** *(string) --* 

                  The name associated with the stack.

                  
                

                - **LogicalResourceId** *(string) --* 

                  The logical name of the resource specified in the template.

                  
            
          
        
      
    