:doc:`CustomerProfiles <../../customer-profiles>` / Paginator / ListUploadJobs

**************
ListUploadJobs
**************



.. py:class:: CustomerProfiles.Paginator.ListUploadJobs

  ::

    
    paginator = client.get_paginator('list_upload_jobs')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`CustomerProfiles.Client.list_upload_jobs`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListUploadJobs>`_    


    **Request Syntax**
    ::

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

      The unique name of the domain to list upload jobs for.

      

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

      
      ::

        {
            'Items': [
                {
                    'JobId': 'string',
                    'DisplayName': 'string',
                    'Status': 'CREATED'|'IN_PROGRESS'|'PARTIALLY_SUCCEEDED'|'SUCCEEDED'|'FAILED'|'STOPPED',
                    'StatusReason': 'VALIDATION_FAILURE'|'INTERNAL_FAILURE',
                    'CreatedAt': datetime(2015, 1, 1),
                    'CompletedAt': datetime(2015, 1, 1),
                    'DataExpiry': 123
                },
            ]
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Items** *(list) --* 

          The list of upload jobs for the specified domain.

          
          

          - *(dict) --* 

            The summary information for an individual upload job.

            
            

            - **JobId** *(string) --* 

              The unique identifier of the upload job.

              
            

            - **DisplayName** *(string) --* 

              The name of the upload job.

              
            

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

              The current status of the upload job.

              
            

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

              The reason for the current status of the upload job.

              
            

            - **CreatedAt** *(datetime) --* 

              The timestamp when the upload job was created.

              
            

            - **CompletedAt** *(datetime) --* 

              The timestamp when the upload job was completed.

              
            

            - **DataExpiry** *(integer) --* 

              The expiry duration for the profiles ingested with the upload job.

              
        
      
    