LookoutEquipment / Client / describe_dataset

describe_dataset#

LookoutEquipment.Client.describe_dataset(**kwargs)#

Provides a JSON description of the data in each time series dataset, including names, column names, and data types.

Request Syntax

response = client.describe_dataset(
    DatasetName='string'
)

Parameters:

DatasetName (string) –

[REQUIRED]

The name of the dataset to be described.

Return type:

dict

Returns:

Response Syntax

{
    'DatasetName': 'string',
    'DatasetArn': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'LastUpdatedAt': datetime(2015, 1, 1),
    'Status': 'CREATED'|'INGESTION_IN_PROGRESS'|'ACTIVE'|'IMPORT_IN_PROGRESS',
    'Schema': 'string',
    'ServerSideKmsKeyId': 'string',
    'IngestionInputConfiguration': {
        'S3InputConfiguration': {
            'Bucket': 'string',
            'Prefix': 'string',
            'KeyPattern': 'string'
        }
    },
    'DataQualitySummary': {
        'InsufficientSensorData': {
            'MissingCompleteSensorData': {
                'AffectedSensorCount': 123
            },
            'SensorsWithShortDateRange': {
                'AffectedSensorCount': 123
            }
        },
        'MissingSensorData': {
            'AffectedSensorCount': 123,
            'TotalNumberOfMissingValues': 123
        },
        'InvalidSensorData': {
            'AffectedSensorCount': 123,
            'TotalNumberOfInvalidValues': 123
        },
        'UnsupportedTimestamps': {
            'TotalNumberOfUnsupportedTimestamps': 123
        },
        'DuplicateTimestamps': {
            'TotalNumberOfDuplicateTimestamps': 123
        }
    },
    'IngestedFilesSummary': {
        'TotalNumberOfFiles': 123,
        'IngestedNumberOfFiles': 123,
        'DiscardedFiles': [
            {
                'Bucket': 'string',
                'Key': 'string'
            },
        ]
    },
    'RoleArn': 'string',
    'DataStartTime': datetime(2015, 1, 1),
    'DataEndTime': datetime(2015, 1, 1),
    'SourceDatasetArn': 'string'
}

Response Structure

(dict) –
- DatasetName (string) –
  
  The name of the dataset being described.
- DatasetArn (string) –
  
  The Amazon Resource Name (ARN) of the dataset being described.
- CreatedAt (datetime) –
  
  Specifies the time the dataset was created in Lookout for Equipment.
- LastUpdatedAt (datetime) –
  
  Specifies the time the dataset was last updated, if it was.
- Status (string) –
  
  Indicates the status of the dataset.
- Schema (string) –
  
  A JSON description of the data that is in each time series dataset, including names, column names, and data types.
- ServerSideKmsKeyId (string) –
  
  Provides the identifier of the KMS key used to encrypt dataset data by Amazon Lookout for Equipment.
- IngestionInputConfiguration (dict) –
  
  Specifies the S3 location configuration for the data input for the data ingestion job.
  - 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)
- DataQualitySummary (dict) –
  
  Gives statistics associated with the given dataset for the latest successful associated ingestion job id. These statistics primarily relate to quantifying incorrect data such as MissingCompleteSensorData, MissingSensorData, UnsupportedDateFormats, InsufficientSensorData, and DuplicateTimeStamps.
  - InsufficientSensorData (dict) –
    
    Parameter that gives information about insufficient data for sensors in the dataset. This includes information about those sensors that have complete data missing and those with a short date range.
    - MissingCompleteSensorData (dict) –
      
      Parameter that describes the total number of sensors that have data completely missing for it.
      - AffectedSensorCount (integer) –
        
        Indicates the number of sensors that have data missing completely.
    - SensorsWithShortDateRange (dict) –
      
      Parameter that describes the total number of sensors that have a short date range of less than 14 days of data overall.
      - AffectedSensorCount (integer) –
        
        Indicates the number of sensors that have less than 14 days of data.
  - MissingSensorData (dict) –
    
    Parameter that gives information about data that is missing over all the sensors in the input data.
    - AffectedSensorCount (integer) –
      
      Indicates the number of sensors that have atleast some data missing.
    - TotalNumberOfMissingValues (integer) –
      
      Indicates the total number of missing values across all the sensors.
  - InvalidSensorData (dict) –
    
    Parameter that gives information about data that is invalid over all the sensors in the input data.
    - AffectedSensorCount (integer) –
      
      Indicates the number of sensors that have at least some invalid values.
    - TotalNumberOfInvalidValues (integer) –
      
      Indicates the total number of invalid values across all the sensors.
  - UnsupportedTimestamps (dict) –
    
    Parameter that gives information about unsupported timestamps in the input data.
    - TotalNumberOfUnsupportedTimestamps (integer) –
      
      Indicates the total number of unsupported timestamps across the ingested data.
  - DuplicateTimestamps (dict) –
    
    Parameter that gives information about duplicate timestamps in the input data.
    - TotalNumberOfDuplicateTimestamps (integer) –
      
      Indicates the total number of duplicate timestamps.
- IngestedFilesSummary (dict) –
  
  IngestedFilesSummary associated with the given dataset for the latest successful associated ingestion job id.
  - TotalNumberOfFiles (integer) –
    
    Indicates the total number of files that were submitted for ingestion.
  - IngestedNumberOfFiles (integer) –
    
    Indicates the number of files that were successfully ingested.
  - DiscardedFiles (list) –
    
    Indicates the number of files that were discarded. A file could be discarded because its format is invalid (for example, a jpg or pdf) or not readable.
    - (dict) –
      
      Contains information about an S3 bucket.
      - Bucket (string) –
        
        The name of the specific S3 bucket.
      - Key (string) –
        
        The Amazon Web Services Key Management Service (KMS key) key being used to encrypt the S3 object. Without this key, data in the bucket is not accessible.
- RoleArn (string) –
  
  The Amazon Resource Name (ARN) of the IAM role that you are using for this the data ingestion job.
- DataStartTime (datetime) –
  
  Indicates the earliest timestamp corresponding to data that was successfully ingested during the most recent ingestion of this particular dataset.
- DataEndTime (datetime) –
  
  Indicates the latest timestamp corresponding to data that was successfully ingested during the most recent ingestion of this particular dataset.
- SourceDatasetArn (string) –
  
  The Amazon Resource Name (ARN) of the source dataset from which the current data being described was imported from.

Exceptions

LookoutEquipment.Client.exceptions.ValidationException
LookoutEquipment.Client.exceptions.ResourceNotFoundException
LookoutEquipment.Client.exceptions.ThrottlingException
LookoutEquipment.Client.exceptions.AccessDeniedException
LookoutEquipment.Client.exceptions.InternalServerException