:doc:`CodeCommit <../../codecommit>` / Paginator / GetDifferences

**************
GetDifferences
**************



.. py:class:: CodeCommit.Paginator.GetDifferences

  ::

    
    paginator = client.get_paginator('get_differences')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`CodeCommit.Client.get_differences`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/codecommit-2015-04-13/GetDifferences>`_    


    **Request Syntax**
    ::

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

      The name of the repository where you want to get differences.

      

    
    :type beforeCommitSpecifier: string
    :param beforeCommitSpecifier: 

      The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, the full commit ID). Optional. If not specified, all changes before the ``afterCommitSpecifier`` value are shown. If you do not use ``beforeCommitSpecifier`` in your request, consider limiting the results with ``maxResults``.

      

    
    :type afterCommitSpecifier: string
    :param afterCommitSpecifier: **[REQUIRED]** 

      The branch, tag, HEAD, or other fully qualified reference used to identify a commit.

      

    
    :type beforePath: string
    :param beforePath: 

      The file path in which to check for differences. Limits the results to this path. Can also be used to specify the previous name of a directory or folder. If ``beforePath`` and ``afterPath`` are not specified, differences are shown for all paths.

      

    
    :type afterPath: string
    :param afterPath: 

      The file path in which to check differences. Limits the results to this path. Can also be used to specify the changed name of a directory or folder, if it has changed. If not specified, differences are shown for all paths.

      

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

      
      ::

        {
            'differences': [
                {
                    'beforeBlob': {
                        'blobId': 'string',
                        'path': 'string',
                        'mode': 'string'
                    },
                    'afterBlob': {
                        'blobId': 'string',
                        'path': 'string',
                        'mode': 'string'
                    },
                    'changeType': 'A'|'M'|'D'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **differences** *(list) --* 

          A data type object that contains information about the differences, including whether the difference is added, modified, or deleted (A, D, M).

          
          

          - *(dict) --* 

            Returns information about a set of differences for a commit specifier.

            
            

            - **beforeBlob** *(dict) --* 

              Information about a ``beforeBlob`` data type object, including the ID, the file mode permission code, and the path.

              
              

              - **blobId** *(string) --* 

                The full ID of the blob.

                
              

              - **path** *(string) --* 

                The path to the blob and associated file name, if any.

                
              

              - **mode** *(string) --* 

                The file mode permissions of the blob. File mode permission codes include:

                 

                
                * ``100644`` indicates read/write
                 
                * ``100755`` indicates read/write/execute
                 
                * ``160000`` indicates a submodule
                 
                * ``120000`` indicates a symlink
                

                
          
            

            - **afterBlob** *(dict) --* 

              Information about an ``afterBlob`` data type object, including the ID, the file mode permission code, and the path.

              
              

              - **blobId** *(string) --* 

                The full ID of the blob.

                
              

              - **path** *(string) --* 

                The path to the blob and associated file name, if any.

                
              

              - **mode** *(string) --* 

                The file mode permissions of the blob. File mode permission codes include:

                 

                
                * ``100644`` indicates read/write
                 
                * ``100755`` indicates read/write/execute
                 
                * ``160000`` indicates a submodule
                 
                * ``120000`` indicates a symlink
                

                
          
            

            - **changeType** *(string) --* 

              Whether the change type of the difference is an addition (A), deletion (D), or modification (M).

              
        
      
    