:doc:`ForecastService <../../forecast>` / Client / list_dataset_import_jobs

************************
list_dataset_import_jobs
************************



.. py:method:: ForecastService.Client.list_dataset_import_jobs(**kwargs)

  

  Returns a list of dataset import jobs created using the `CreateDatasetImportJob <https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html>`__ operation. For each import job, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the ARN with the `DescribeDatasetImportJob <https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html>`__ operation. You can filter the list by providing an array of `Filter <https://docs.aws.amazon.com/forecast/latest/dg/API_Filter.html>`__ objects.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListDatasetImportJobs>`_  


  **Request Syntax**
  ::

    response = client.list_dataset_import_jobs(
        NextToken='string',
        MaxResults=123,
        Filters=[
            {
                'Key': 'string',
                'Value': 'string',
                'Condition': 'IS'|'IS_NOT'
            },
        ]
    )
    
  :type NextToken: string
  :param NextToken: 

    If the result of the previous request was truncated, the response includes a ``NextToken``. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The number of items to return in the response.

    

  
  :type Filters: list
  :param Filters: 

    An array of filters. For each filter, you provide a condition and a match statement. The condition is either ``IS`` or ``IS_NOT``, which specifies whether to include or exclude the datasets that match the statement from the list, respectively. The match statement consists of a key and a value.

     

    **Filter properties**

     

    
    * ``Condition`` - The condition to apply. Valid values are ``IS`` and ``IS_NOT``. To include the datasets that match the statement, specify ``IS``. To exclude matching datasets, specify ``IS_NOT``.
     
    * ``Key`` - The name of the parameter to filter on. Valid values are ``DatasetArn`` and ``Status``.
     
    * ``Value`` - The value to match.
    

     

    For example, to list all dataset import jobs whose status is ACTIVE, you specify the following filter:

     

    ``"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]``

    

  
    - *(dict) --* 

      Describes a filter for choosing a subset of objects. Each filter consists of a condition and a match statement. The condition is either ``IS`` or ``IS_NOT``, which specifies whether to include or exclude the objects that match the statement, respectively. The match statement consists of a key and a value.

      

    
      - **Key** *(string) --* **[REQUIRED]** 

        The name of the parameter to filter on.

        

      
      - **Value** *(string) --* **[REQUIRED]** 

        The value to match.

        

      
      - **Condition** *(string) --* **[REQUIRED]** 

        The condition to apply. To include the objects that match the statement, specify ``IS``. To exclude matching objects, specify ``IS_NOT``.

        

      
    

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

    
    ::

      {
          'DatasetImportJobs': [
              {
                  'DatasetImportJobArn': 'string',
                  'DatasetImportJobName': 'string',
                  'DataSource': {
                      'S3Config': {
                          'Path': 'string',
                          'RoleArn': 'string',
                          'KMSKeyArn': 'string'
                      }
                  },
                  'Status': 'string',
                  'Message': 'string',
                  'CreationTime': datetime(2015, 1, 1),
                  'LastModificationTime': datetime(2015, 1, 1),
                  'ImportMode': 'FULL'|'INCREMENTAL'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **DatasetImportJobs** *(list) --* 

        An array of objects that summarize each dataset import job's properties.

        
        

        - *(dict) --* 

          Provides a summary of the dataset import job properties used in the `ListDatasetImportJobs <https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetImportJobs.html>`__ operation. To get the complete set of properties, call the `DescribeDatasetImportJob <https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html>`__ operation, and provide the ``DatasetImportJobArn``.

          
          

          - **DatasetImportJobArn** *(string) --* 

            The Amazon Resource Name (ARN) of the dataset import job.

            
          

          - **DatasetImportJobName** *(string) --* 

            The name of the dataset import job.

            
          

          - **DataSource** *(dict) --* 

            The location of the training data to import and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data. The training data must be stored in an Amazon S3 bucket.

             

            If encryption is used, ``DataSource`` includes an Key Management Service (KMS) key.

            
            

            - **S3Config** *(dict) --* 

              The path to the data stored in an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the data.

              
              

              - **Path** *(string) --* 

                The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.

                
              

              - **RoleArn** *(string) --* 

                The ARN of the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the ``KMSKeyArn`` key, the role must allow access to the key.

                 

                Passing a role across Amazon Web Services accounts is not allowed. If you pass a role that isn't in your account, you get an ``InvalidInputException`` error.

                
              

              - **KMSKeyArn** *(string) --* 

                The Amazon Resource Name (ARN) of an Key Management Service (KMS) key.

                
          
        
          

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

            The status of the dataset import job. States include:

             

            
            * ``ACTIVE``
             
            * ``CREATE_PENDING``, ``CREATE_IN_PROGRESS``, ``CREATE_FAILED``
             
            * ``DELETE_PENDING``, ``DELETE_IN_PROGRESS``, ``DELETE_FAILED``
             
            * ``CREATE_STOPPING``, ``CREATE_STOPPED``
            

            
          

          - **Message** *(string) --* 

            If an error occurred, an informational message about the error.

            
          

          - **CreationTime** *(datetime) --* 

            When the dataset import job was created.

            
          

          - **LastModificationTime** *(datetime) --* 

            The last time the resource was modified. The timestamp depends on the status of the job:

             

            
            * ``CREATE_PENDING`` - The ``CreationTime``.
             
            * ``CREATE_IN_PROGRESS`` - The current timestamp.
             
            * ``CREATE_STOPPING`` - The current timestamp.
             
            * ``CREATE_STOPPED`` - When the job stopped.
             
            * ``ACTIVE`` or ``CREATE_FAILED`` - When the job finished or failed.
            

            
          

          - **ImportMode** *(string) --* 

            The import mode of the dataset import job, FULL or INCREMENTAL.

            
      
    
      

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

        If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.

        
  
  **Exceptions**
  
  *   :py:class:`ForecastService.Client.exceptions.InvalidNextTokenException`

  
  *   :py:class:`ForecastService.Client.exceptions.InvalidInputException`

  