:doc:`MailManager <../../mailmanager>` / Paginator / ListAddressListImportJobs

*************************
ListAddressListImportJobs
*************************



.. py:class:: MailManager.Paginator.ListAddressListImportJobs

  ::

    
    paginator = client.get_paginator('list_address_list_import_jobs')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`MailManager.Client.list_address_list_import_jobs`.

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


    **Request Syntax**
    ::

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

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

      

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

      
      ::

        {
            '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'
                },
            ],
            
        }
        
      **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.

              
        
      
    