:doc:`LookoutEquipment <../../lookoutequipment>` / Client / start_data_ingestion_job

************************
start_data_ingestion_job
************************



.. py:method:: LookoutEquipment.Client.start_data_ingestion_job(**kwargs)

  

  Starts a data ingestion job. Amazon Lookout for Equipment returns the job status.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/StartDataIngestionJob>`_  


  **Request Syntax**
  ::

    response = client.start_data_ingestion_job(
        DatasetName='string',
        IngestionInputConfiguration={
            'S3InputConfiguration': {
                'Bucket': 'string',
                'Prefix': 'string',
                'KeyPattern': 'string'
            }
        },
        RoleArn='string',
        ClientToken='string'
    )
    
  :type DatasetName: string
  :param DatasetName: **[REQUIRED]** 

    The name of the dataset being used by the data ingestion job.

    

  
  :type IngestionInputConfiguration: dict
  :param IngestionInputConfiguration: **[REQUIRED]** 

    Specifies information for the input data for the data ingestion job, including dataset S3 location.

    

  
    - **S3InputConfiguration** *(dict) --* **[REQUIRED]** 

      The location information for the S3 bucket used for input data for the data ingestion.

      

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

        The name of the S3 bucket used for the input data for the data ingestion.

        

      
      - **Prefix** *(string) --* 

        The prefix for the S3 location being used for the input data for the data ingestion.

        

      
      - **KeyPattern** *(string) --* 

        The pattern for matching the Amazon S3 files that will be used for ingestion. If the schema was created previously without any KeyPattern, then the default KeyPattern {prefix}/{component_name}/* is used to download files from Amazon S3 according to the schema. This field is required when ingestion is being done for the first time.

         

        Valid Values: {prefix}/{component_name}_* | {prefix}/{component_name}/* | {prefix}/{component_name}[DELIMITER]* (Allowed delimiters : space, dot, underscore, hyphen)

        

      
    
  
  :type RoleArn: string
  :param RoleArn: **[REQUIRED]** 

    The Amazon Resource Name (ARN) of a role with permission to access the data source for the data ingestion job.

    

  
  :type ClientToken: string
  :param ClientToken: **[REQUIRED]** 

    A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.

    This field is autopopulated if not provided.

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

    
    ::

      {
          'JobId': 'string',
          'Status': 'IN_PROGRESS'|'SUCCESS'|'FAILED'|'IMPORT_IN_PROGRESS'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        Indicates the job ID of the data ingestion job.

        
      

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

        Indicates the status of the ``StartDataIngestionJob`` operation.

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

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

  
  *   :py:class:`LookoutEquipment.Client.exceptions.ConflictException`

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

  
  *   :py:class:`LookoutEquipment.Client.exceptions.ServiceQuotaExceededException`

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

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

  