LookoutEquipment / Client / list_data_ingestion_jobs

list_data_ingestion_jobs#

LookoutEquipment.Client.list_data_ingestion_jobs(**kwargs)#

Provides a list of all data ingestion jobs, including dataset name and ARN, S3 location of the input data, status, and so on.

See also: AWS API Documentation

Request Syntax

response = client.list_data_ingestion_jobs(
    DatasetName='string',
    NextToken='string',
    MaxResults=123,
    Status='IN_PROGRESS'|'SUCCESS'|'FAILED'|'IMPORT_IN_PROGRESS'
)
Parameters:

  • DatasetName (string) – The name of the dataset being used for the data ingestion job.

  • NextToken (string) – An opaque pagination token indicating where to continue the listing of data ingestion jobs.

  • MaxResults (integer) – Specifies the maximum number of data ingestion jobs to list.

  • Status (string) – Indicates the status of the data ingestion job.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'DataIngestionJobSummaries': [
        {
            'JobId': 'string',
            'DatasetName': 'string',
            'DatasetArn': 'string',
            'IngestionInputConfiguration': {
                'S3InputConfiguration': {
                    'Bucket': 'string',
                    'Prefix': 'string',
                    'KeyPattern': 'string'
                }
            },
            'Status': 'IN_PROGRESS'|'SUCCESS'|'FAILED'|'IMPORT_IN_PROGRESS'
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

      An opaque pagination token indicating where to continue the listing of data ingestion jobs.

    • DataIngestionJobSummaries (list) –

      Specifies information about the specific data ingestion job, including dataset name and status.

      • (dict) –

        Provides information about a specified data ingestion job, including dataset information, data ingestion configuration, and status.

        • JobId (string) –

          Indicates the job ID of the data ingestion job.

        • DatasetName (string) –

          The name of the dataset used for the data ingestion job.

        • DatasetArn (string) –

          The Amazon Resource Name (ARN) of the dataset used in the data ingestion job.

        • IngestionInputConfiguration (dict) –

          Specifies information for the input data for the data inference job, including data Amazon S3 location parameters.

          • S3InputConfiguration (dict) –

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

            • Bucket (string) –

              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)

        • Status (string) –

          Indicates the status of the data ingestion job.

Exceptions