start_data_ingestion_job

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

Request Syntax

response = client.start_data_ingestion_job(
    DatasetName='string',
    IngestionInputConfiguration={
        'S3InputConfiguration': {
            'Bucket': 'string',
            'Prefix': 'string',
            'KeyPattern': 'string'
        }
    },
    RoleArn='string',
    ClientToken='string'
)

Parameters

• DatasetName (string) --

  [REQUIRED]

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

• IngestionInputConfiguration (dict) --

  [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) --

      Pattern for matching the Amazon S3 files which will be used for ingestion. If no KeyPattern is provided, we will use the default hierarchy file structure, which is same as KeyPattern {prefix}/{component_name}/*

• RoleArn (string) --

  [REQUIRED]

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

• ClientToken (string) --

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

Return type

dict

Returns

Response Syntax

{
    'JobId': 'string',
    'Status': 'IN_PROGRESS'|'SUCCESS'|'FAILED'
}

Response Structure

• (dict) --

  • JobId (string) --

    Indicates the job ID of the data ingestion job.

  • Status (string) --

    Indicates the status of the StartDataIngestionJob operation.

Exceptions

• LookoutEquipment.Client.exceptions.ValidationException
• LookoutEquipment.Client.exceptions.ResourceNotFoundException
• LookoutEquipment.Client.exceptions.ConflictException
• LookoutEquipment.Client.exceptions.ThrottlingException
• LookoutEquipment.Client.exceptions.ServiceQuotaExceededException
• LookoutEquipment.Client.exceptions.AccessDeniedException
• LookoutEquipment.Client.exceptions.InternalServerException