:doc:`MailManager <../../mailmanager>` / Client / list_address_list_import_jobs

*****************************
list_address_list_import_jobs
*****************************



.. py:method:: MailManager.Client.list_address_list_import_jobs(**kwargs)

  

  Lists jobs for an address list.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ListAddressListImportJobs>`_  


  **Request Syntax**
  ::

    response = client.list_address_list_import_jobs(
        AddressListId='string',
        NextToken='string',
        PageSize=123
    )
    
  :type AddressListId: string
  :param AddressListId: **[REQUIRED]** 

    The unique identifier of the address list for listing import jobs.

    

  
  :type NextToken: string
  :param NextToken: 

    If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.

    

  
  :type PageSize: integer
  :param PageSize: 

    The maximum number of import jobs that are returned per call. You can use NextToken to retrieve the next page of jobs.

    

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

    
    ::

      {
          'ImportJobs': [
              {
                  'JobId': 'string',
                  'Name': 'string',
                  'Status': 'CREATED'|'PROCESSING'|'COMPLETED'|'FAILED'|'STOPPED',
                  'PreSignedUrl': 'string',
                  'ImportedItemsCount': 123,
                  'FailedItemsCount': 123,
                  'ImportDataFormat': {
                      'ImportDataType': 'CSV'|'JSON'
                  },
                  'AddressListId': 'string',
                  'CreatedTimestamp': datetime(2015, 1, 1),
                  'StartTimestamp': datetime(2015, 1, 1),
                  'CompletedTimestamp': datetime(2015, 1, 1),
                  'Error': 'string'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ImportJobs** *(list) --* 

        The list of import jobs.

        
        

        - *(dict) --* 

          Details about an import job.

          
          

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

            The identifier of the import job.

            
          

          - **Name** *(string) --* 

            A user-friendly name for the import job.

            
          

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

            The status of the import job.

            
          

          - **PreSignedUrl** *(string) --* 

            The pre-signed URL target for uploading the input file.

            
          

          - **ImportedItemsCount** *(integer) --* 

            The number of addresses in the input that were successfully imported into the address list.

            
          

          - **FailedItemsCount** *(integer) --* 

            The number of addresses in the input that failed to get imported into address list.

            
          

          - **ImportDataFormat** *(dict) --* 

            The format of the input for the import job.

            
            

            - **ImportDataType** *(string) --* 

              The type of file that would be passed as an input for the address list import job.

              
        
          

          - **AddressListId** *(string) --* 

            The unique identifier of the address list the import job was created for.

            
          

          - **CreatedTimestamp** *(datetime) --* 

            The timestamp of when the import job was created.

            
          

          - **StartTimestamp** *(datetime) --* 

            The timestamp of when the import job was started.

            
          

          - **CompletedTimestamp** *(datetime) --* 

            The timestamp of when the import job was completed.

            
          

          - **Error** *(string) --* 

            The reason for failure of an import job.

            
      
    
      

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

        If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

        
  
  **Exceptions**
  
  *   :py:class:`MailManager.Client.exceptions.ValidationException`

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

  
  *   :py:class:`MailManager.Client.exceptions.ResourceNotFoundException`

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

  