:doc:`CustomerProfiles <../../customer-profiles>` / Client / list_upload_jobs

****************
list_upload_jobs
****************



.. py:method:: CustomerProfiles.Client.list_upload_jobs(**kwargs)

  

  This API retrieves a list of upload jobs for the specified domain.

  

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


  **Request Syntax**
  ::

    response = client.list_upload_jobs(
        DomainName='string',
        MaxResults=123,
        NextToken='string'
    )
    
  :type DomainName: string
  :param DomainName: **[REQUIRED]** 

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

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of upload jobs to return per page.

    

  
  :type NextToken: string
  :param NextToken: 

    The pagination token from the previous call to retrieve the next page of results.

    

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

    
    ::

      {
          'NextToken': 'string',
          '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) --* 
      

      - **NextToken** *(string) --* 

        The pagination token to use to retrieve the next page of results.

        
      

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

            
      
    
  
  **Exceptions**
  
  *   :py:class:`CustomerProfiles.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`CustomerProfiles.Client.exceptions.InternalServerException`

  
  *   :py:class:`CustomerProfiles.Client.exceptions.BadRequestException`

  
  *   :py:class:`CustomerProfiles.Client.exceptions.ThrottlingException`

  
  *   :py:class:`CustomerProfiles.Client.exceptions.AccessDeniedException`

  