LookoutEquipment

Client

class LookoutEquipment.Client

A low-level client representing Amazon Lookout for Equipment (LookoutEquipment)

Amazon Lookout for Equipment is a machine learning service that uses advanced analytics to identify anomalies in machines from sensor data for use in predictive maintenance.

client = session.create_client('lookoutequipment')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
close()

Closes underlying endpoint connections.

create_dataset(**kwargs)

Creates a container for a collection of data being ingested for analysis. The dataset contains the metadata describing where the data is and what the data actually looks like. In other words, it contains the location of the data source, the data schema, and other information. A dataset also contains any tags associated with the ingested data.

See also: AWS API Documentation

Request Syntax

response = client.create_dataset(
    DatasetName='string',
    DatasetSchema={
        'InlineDataSchema': 'string'
    },
    ServerSideKmsKeyId='string',
    ClientToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • DatasetName (string) --

    [REQUIRED]

    The name of the dataset being created.

  • DatasetSchema (dict) --

    A JSON description of the data that is in each time series dataset, including names, column names, and data types.

    • InlineDataSchema (string) --
  • ServerSideKmsKeyId (string) -- Provides the identifier of the KMS key used to encrypt dataset data by Amazon Lookout for Equipment.
  • 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.

  • Tags (list) --

    Any tags associated with the ingested data described in the dataset.

    • (dict) --

      A tag is a key-value pair that can be added to a resource as metadata.

      • Key (string) -- [REQUIRED]

        The key for the specified tag.

      • Value (string) -- [REQUIRED]

        The value for the specified tag.

Return type

dict

Returns

Response Syntax

{
    'DatasetName': 'string',
    'DatasetArn': 'string',
    'Status': 'CREATED'|'INGESTION_IN_PROGRESS'|'ACTIVE'
}

Response Structure

  • (dict) --

    • DatasetName (string) --

      The name of the dataset being created.

    • DatasetArn (string) --

      The Amazon Resource Name (ARN) of the dataset being created.

    • Status (string) --

      Indicates the status of the CreateDataset operation.

Exceptions

create_inference_scheduler(**kwargs)

Creates a scheduled inference. Scheduling an inference is setting up a continuous real-time inference plan to analyze new measurement data. When setting up the schedule, you provide an S3 bucket location for the input data, assign it a delimiter between separate entries in the data, set an offset delay if desired, and set the frequency of inferencing. You must also provide an S3 bucket location for the output data.

See also: AWS API Documentation

Request Syntax

response = client.create_inference_scheduler(
    ModelName='string',
    InferenceSchedulerName='string',
    DataDelayOffsetInMinutes=123,
    DataUploadFrequency='PT5M'|'PT10M'|'PT15M'|'PT30M'|'PT1H',
    DataInputConfiguration={
        'S3InputConfiguration': {
            'Bucket': 'string',
            'Prefix': 'string'
        },
        'InputTimeZoneOffset': 'string',
        'InferenceInputNameConfiguration': {
            'TimestampFormat': 'string',
            'ComponentTimestampDelimiter': 'string'
        }
    },
    DataOutputConfiguration={
        'S3OutputConfiguration': {
            'Bucket': 'string',
            'Prefix': 'string'
        },
        'KmsKeyId': 'string'
    },
    RoleArn='string',
    ServerSideKmsKeyId='string',
    ClientToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • ModelName (string) --

    [REQUIRED]

    The name of the previously trained ML model being used to create the inference scheduler.

  • InferenceSchedulerName (string) --

    [REQUIRED]

    The name of the inference scheduler being created.

  • DataDelayOffsetInMinutes (integer) --

    The interval (in minutes) of planned delay at the start of each inference segment. For example, if inference is set to run every ten minutes, the delay is set to five minutes and the time is 09:08. The inference scheduler will wake up at the configured interval (which, without a delay configured, would be 09:10) plus the additional five minute delay time (so 09:15) to check your Amazon S3 bucket. The delay provides a buffer for you to upload data at the same frequency, so that you don't have to stop and restart the scheduler when uploading new data.

    For more information, see Understanding the inference process.

  • DataUploadFrequency (string) --

    [REQUIRED]

    How often data is uploaded to the source Amazon S3 bucket for the input data. The value chosen is the length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5 minutes. This frequency also determines how often Amazon Lookout for Equipment runs inference on your data.

    For more information, see Understanding the inference process.

  • DataInputConfiguration (dict) --

    [REQUIRED]

    Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.

    • S3InputConfiguration (dict) --

      Specifies configuration information for the input data for the inference, including Amazon S3 location of input data.

      • Bucket (string) -- [REQUIRED]

        The bucket containing the input dataset for the inference.

      • Prefix (string) --

        The prefix for the S3 bucket used for the input data for the inference.

    • InputTimeZoneOffset (string) --

      Indicates the difference between your time zone and Coordinated Universal Time (UTC).

    • InferenceInputNameConfiguration (dict) --

      Specifies configuration information for the input data for the inference, including timestamp format and delimiter.

      • TimestampFormat (string) --

        The format of the timestamp, whether Epoch time, or standard, with or without hyphens (-).

      • ComponentTimestampDelimiter (string) --

        Indicates the delimiter character used between items in the data.

  • DataOutputConfiguration (dict) --

    [REQUIRED]

    Specifies configuration information for the output results for the inference scheduler, including the S3 location for the output.

    • S3OutputConfiguration (dict) -- [REQUIRED]

      Specifies configuration information for the output results from for the inference, output S3 location.

      • Bucket (string) -- [REQUIRED]

        The bucket containing the output results from the inference

      • Prefix (string) --

        The prefix for the S3 bucket used for the output results from the inference.

    • KmsKeyId (string) --

      The ID number for the AWS KMS key used to encrypt the inference output.

  • RoleArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of a role with permission to access the data source being used for the inference.

  • ServerSideKmsKeyId (string) -- Provides the identifier of the KMS key used to encrypt inference scheduler data by Amazon Lookout for Equipment.
  • 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.

  • Tags (list) --

    Any tags associated with the inference scheduler.

    • (dict) --

      A tag is a key-value pair that can be added to a resource as metadata.

      • Key (string) -- [REQUIRED]

        The key for the specified tag.

      • Value (string) -- [REQUIRED]

        The value for the specified tag.

Return type

dict

Returns

Response Syntax

{
    'InferenceSchedulerArn': 'string',
    'InferenceSchedulerName': 'string',
    'Status': 'PENDING'|'RUNNING'|'STOPPING'|'STOPPED'
}

Response Structure

  • (dict) --

    • InferenceSchedulerArn (string) --

      The Amazon Resource Name (ARN) of the inference scheduler being created.

    • InferenceSchedulerName (string) --

      The name of inference scheduler being created.

    • Status (string) --

      Indicates the status of the CreateInferenceScheduler operation.

Exceptions

create_label(**kwargs)

Creates a label for an event.

See also: AWS API Documentation

Request Syntax

response = client.create_label(
    LabelGroupName='string',
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    Rating='ANOMALY'|'NO_ANOMALY'|'NEUTRAL',
    FaultCode='string',
    Notes='string',
    Equipment='string',
    ClientToken='string'
)
Parameters
  • LabelGroupName (string) --

    [REQUIRED]

    The name of a group of labels.

    Data in this field will be retained for service usage. Follow best practices for the security of your data.

  • StartTime (datetime) --

    [REQUIRED]

    The start time of the labeled event.

  • EndTime (datetime) --

    [REQUIRED]

    The end time of the labeled event.

  • Rating (string) --

    [REQUIRED]

    Indicates whether a labeled event represents an anomaly.

  • FaultCode (string) --

    Provides additional information about the label. The fault code must be defined in the FaultCodes attribute of the label group.

    Data in this field will be retained for service usage. Follow best practices for the security of your data.

  • Notes (string) --

    Metadata providing additional information about the label.

    Data in this field will be retained for service usage. Follow best practices for the security of your data.

  • Equipment (string) --

    Indicates that a label pertains to a particular piece of equipment.

    Data in this field will be retained for service usage. Follow best practices for the security of your data.

  • ClientToken (string) --

    [REQUIRED]

    A unique identifier for the request to create a label. If you do not set the client request token, Lookout for Equipment generates one.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'LabelId': 'string'
}

Response Structure

  • (dict) --

    • LabelId (string) --

      The ID of the label that you have created.

Exceptions

create_label_group(**kwargs)

Creates a group of labels.

See also: AWS API Documentation

Request Syntax

response = client.create_label_group(
    LabelGroupName='string',
    FaultCodes=[
        'string',
    ],
    ClientToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • LabelGroupName (string) --

    [REQUIRED]

    Names a group of labels.

    Data in this field will be retained for service usage. Follow best practices for the security of your data.

  • FaultCodes (list) --

    The acceptable fault codes (indicating the type of anomaly associated with the label) that can be used with this label group.

    Data in this field will be retained for service usage. Follow best practices for the security of your data.

    • (string) --
  • ClientToken (string) --

    [REQUIRED]

    A unique identifier for the request to create a label group. If you do not set the client request token, Lookout for Equipment generates one.

    This field is autopopulated if not provided.

  • Tags (list) --

    Tags that provide metadata about the label group you are creating.

    Data in this field will be retained for service usage. Follow best practices for the security of your data.

    • (dict) --

      A tag is a key-value pair that can be added to a resource as metadata.

      • Key (string) -- [REQUIRED]

        The key for the specified tag.

      • Value (string) -- [REQUIRED]

        The value for the specified tag.

Return type

dict

Returns

Response Syntax

{
    'LabelGroupName': 'string',
    'LabelGroupArn': 'string'
}

Response Structure

  • (dict) --

    • LabelGroupName (string) --

      The name of the label group that you have created. Data in this field will be retained for service usage. Follow best practices for the security of your data.

    • LabelGroupArn (string) --

      The ARN of the label group that you have created.

Exceptions

create_model(**kwargs)

Creates an ML model for data inference.

A machine-learning (ML) model is a mathematical model that finds patterns in your data. In Amazon Lookout for Equipment, the model learns the patterns of normal behavior and detects abnormal behavior that could be potential equipment failure (or maintenance events). The models are made by analyzing normal data and abnormalities in machine behavior that have already occurred.

Your model is trained using a portion of the data from your dataset and uses that data to learn patterns of normal behavior and abnormal patterns that lead to equipment failure. Another portion of the data is used to evaluate the model's accuracy.

See also: AWS API Documentation

Request Syntax

response = client.create_model(
    ModelName='string',
    DatasetName='string',
    DatasetSchema={
        'InlineDataSchema': 'string'
    },
    LabelsInputConfiguration={
        'S3InputConfiguration': {
            'Bucket': 'string',
            'Prefix': 'string'
        },
        'LabelGroupName': 'string'
    },
    ClientToken='string',
    TrainingDataStartTime=datetime(2015, 1, 1),
    TrainingDataEndTime=datetime(2015, 1, 1),
    EvaluationDataStartTime=datetime(2015, 1, 1),
    EvaluationDataEndTime=datetime(2015, 1, 1),
    RoleArn='string',
    DataPreProcessingConfiguration={
        'TargetSamplingRate': 'PT1S'|'PT5S'|'PT10S'|'PT15S'|'PT30S'|'PT1M'|'PT5M'|'PT10M'|'PT15M'|'PT30M'|'PT1H'
    },
    ServerSideKmsKeyId='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    OffCondition='string'
)
Parameters
  • ModelName (string) --

    [REQUIRED]

    The name for the ML model to be created.

  • DatasetName (string) --

    [REQUIRED]

    The name of the dataset for the ML model being created.

  • DatasetSchema (dict) --

    The data schema for the ML model being created.

    • InlineDataSchema (string) --
  • LabelsInputConfiguration (dict) --

    The input configuration for the labels being used for the ML model that's being created.

    • S3InputConfiguration (dict) --

      Contains location information for the S3 location being used for label data.

      • Bucket (string) -- [REQUIRED]

        The name of the S3 bucket holding the label data.

      • Prefix (string) --

        The prefix for the S3 bucket used for the label data.

    • LabelGroupName (string) --

      The name of the label group to be used for label data.

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

  • TrainingDataStartTime (datetime) -- Indicates the time reference in the dataset that should be used to begin the subset of training data for the ML model.
  • TrainingDataEndTime (datetime) -- Indicates the time reference in the dataset that should be used to end the subset of training data for the ML model.
  • EvaluationDataStartTime (datetime) -- Indicates the time reference in the dataset that should be used to begin the subset of evaluation data for the ML model.
  • EvaluationDataEndTime (datetime) -- Indicates the time reference in the dataset that should be used to end the subset of evaluation data for the ML model.
  • RoleArn (string) -- The Amazon Resource Name (ARN) of a role with permission to access the data source being used to create the ML model.
  • DataPreProcessingConfiguration (dict) --

    The configuration is the TargetSamplingRate , which is the sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been collected at a 1 second level and you want the system to resample the data at a 1 minute rate before training, the TargetSamplingRate is 1 minute.

    When providing a value for the TargetSamplingRate , you must attach the prefix "PT" to the rate you want. The value for a 1 second rate is therefore PT1S , the value for a 15 minute rate is PT15M , and the value for a 1 hour rate is PT1H

    • TargetSamplingRate (string) --

      The sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been collected at a 1 second level and you want the system to resample the data at a 1 minute rate before training, the TargetSamplingRate is 1 minute.

      When providing a value for the TargetSamplingRate , you must attach the prefix "PT" to the rate you want. The value for a 1 second rate is therefore PT1S , the value for a 15 minute rate is PT15M , and the value for a 1 hour rate is PT1H

  • ServerSideKmsKeyId (string) -- Provides the identifier of the KMS key used to encrypt model data by Amazon Lookout for Equipment.
  • Tags (list) --

    Any tags associated with the ML model being created.

    • (dict) --

      A tag is a key-value pair that can be added to a resource as metadata.

      • Key (string) -- [REQUIRED]

        The key for the specified tag.

      • Value (string) -- [REQUIRED]

        The value for the specified tag.

  • OffCondition (string) -- Indicates that the asset associated with this sensor has been shut off. As long as this condition is met, Lookout for Equipment will not use data from this asset for training, evaluation, or inference.
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • ModelArn (string) --

      The Amazon Resource Name (ARN) of the model being created.

    • Status (string) --

      Indicates the status of the CreateModel operation.

Exceptions

delete_dataset(**kwargs)

Deletes a dataset and associated artifacts. The operation will check to see if any inference scheduler or data ingestion job is currently using the dataset, and if there isn't, the dataset, its metadata, and any associated data stored in S3 will be deleted. This does not affect any models that used this dataset for training and evaluation, but does prevent it from being used in the future.

See also: AWS API Documentation

Request Syntax

response = client.delete_dataset(
    DatasetName='string'
)
Parameters
DatasetName (string) --

[REQUIRED]

The name of the dataset to be deleted.

Returns
None

Exceptions

delete_inference_scheduler(**kwargs)

Deletes an inference scheduler that has been set up. Already processed output results are not affected.

See also: AWS API Documentation

Request Syntax

response = client.delete_inference_scheduler(
    InferenceSchedulerName='string'
)
Parameters
InferenceSchedulerName (string) --

[REQUIRED]

The name of the inference scheduler to be deleted.

Returns
None

Exceptions

delete_label(**kwargs)

Deletes a label.

See also: AWS API Documentation

Request Syntax

response = client.delete_label(
    LabelGroupName='string',
    LabelId='string'
)
Parameters
  • LabelGroupName (string) --

    [REQUIRED]

    The name of the label group that contains the label that you want to delete. Data in this field will be retained for service usage. Follow best practices for the security of your data.

  • LabelId (string) --

    [REQUIRED]

    The ID of the label that you want to delete.

Returns

None

Exceptions

delete_label_group(**kwargs)

Deletes a group of labels.

See also: AWS API Documentation

Request Syntax

response = client.delete_label_group(
    LabelGroupName='string'
)
Parameters
LabelGroupName (string) --

[REQUIRED]

The name of the label group that you want to delete. Data in this field will be retained for service usage. Follow best practices for the security of your data.

Returns
None

Exceptions

delete_model(**kwargs)

Deletes an ML model currently available for Amazon Lookout for Equipment. This will prevent it from being used with an inference scheduler, even one that is already set up.

See also: AWS API Documentation

Request Syntax

response = client.delete_model(
    ModelName='string'
)
Parameters
ModelName (string) --

[REQUIRED]

The name of the ML model to be deleted.

Returns
None

Exceptions

describe_data_ingestion_job(**kwargs)

Provides information on a specific data ingestion job such as creation time, dataset ARN, and status.

See also: AWS API Documentation

Request Syntax

response = client.describe_data_ingestion_job(
    JobId='string'
)
Parameters
JobId (string) --

[REQUIRED]

The job ID of the data ingestion job.

Return type
dict
Returns
Response Syntax
{
    'JobId': 'string',
    'DatasetArn': 'string',
    'IngestionInputConfiguration': {
        'S3InputConfiguration': {
            'Bucket': 'string',
            'Prefix': 'string',
            'KeyPattern': 'string'
        }
    },
    'RoleArn': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'Status': 'IN_PROGRESS'|'SUCCESS'|'FAILED',
    'FailedReason': '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'
            },
        ]
    },
    'StatusDetail': 'string',
    'IngestedDataSize': 123,
    'DataStartTime': datetime(2015, 1, 1),
    'DataEndTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --
    • JobId (string) --

      Indicates the job ID of the data ingestion job.

    • DatasetArn (string) --

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

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

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

      The Amazon Resource Name (ARN) of an IAM role with permission to access the data source being ingested.

    • CreatedAt (datetime) --

      The time at which the data ingestion job was created.

    • Status (string) --

      Indicates the status of the DataIngestionJob operation.

    • FailedReason (string) --

      Specifies the reason for failure when a data ingestion job has failed.

    • DataQualitySummary (dict) --

      Gives statistics about a completed ingestion job. 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 90 days of data overall.

          • AffectedSensorCount (integer) --

            Indicates the number of sensors that have less than 90 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) --

      Gives statistics about how many files have been ingested, and which files have not been ingested, for a particular ingestion job.

      • 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 AWS Key Management Service (AWS KMS) key being used to encrypt the S3 object. Without this key, data in the bucket is not accessible.

    • StatusDetail (string) --

      Provides details about status of the ingestion job that is currently in progress.

    • IngestedDataSize (integer) --

      Indicates the size of the ingested dataset.

    • DataStartTime (datetime) --

      Indicates the earliest timestamp corresponding to data that was successfully ingested during this specific ingestion job.

    • DataEndTime (datetime) --

      Indicates the latest timestamp corresponding to data that was successfully ingested during this specific ingestion job.

Exceptions

describe_dataset(**kwargs)

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

See also: AWS API Documentation

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',
    '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)
}

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

          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}/*

    • 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 90 days of data overall.

          • AffectedSensorCount (integer) --

            Indicates the number of sensors that have less than 90 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 AWS Key Management Service (AWS KMS) 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.

Exceptions

describe_inference_scheduler(**kwargs)

Specifies information about the inference scheduler being used, including name, model, status, and associated metadata

See also: AWS API Documentation

Request Syntax

response = client.describe_inference_scheduler(
    InferenceSchedulerName='string'
)
Parameters
InferenceSchedulerName (string) --

[REQUIRED]

The name of the inference scheduler being described.

Return type
dict
Returns
Response Syntax
{
    'ModelArn': 'string',
    'ModelName': 'string',
    'InferenceSchedulerName': 'string',
    'InferenceSchedulerArn': 'string',
    'Status': 'PENDING'|'RUNNING'|'STOPPING'|'STOPPED',
    'DataDelayOffsetInMinutes': 123,
    'DataUploadFrequency': 'PT5M'|'PT10M'|'PT15M'|'PT30M'|'PT1H',
    'CreatedAt': datetime(2015, 1, 1),
    'UpdatedAt': datetime(2015, 1, 1),
    'DataInputConfiguration': {
        'S3InputConfiguration': {
            'Bucket': 'string',
            'Prefix': 'string'
        },
        'InputTimeZoneOffset': 'string',
        'InferenceInputNameConfiguration': {
            'TimestampFormat': 'string',
            'ComponentTimestampDelimiter': 'string'
        }
    },
    'DataOutputConfiguration': {
        'S3OutputConfiguration': {
            'Bucket': 'string',
            'Prefix': 'string'
        },
        'KmsKeyId': 'string'
    },
    'RoleArn': 'string',
    'ServerSideKmsKeyId': 'string',
    'LatestInferenceResult': 'ANOMALOUS'|'NORMAL'
}

Response Structure

  • (dict) --
    • ModelArn (string) --

      The Amazon Resource Name (ARN) of the ML model of the inference scheduler being described.

    • ModelName (string) --

      The name of the ML model of the inference scheduler being described.

    • InferenceSchedulerName (string) --

      The name of the inference scheduler being described.

    • InferenceSchedulerArn (string) --

      The Amazon Resource Name (ARN) of the inference scheduler being described.

    • Status (string) --

      Indicates the status of the inference scheduler.

    • DataDelayOffsetInMinutes (integer) --

      A period of time (in minutes) by which inference on the data is delayed after the data starts. For instance, if you select an offset delay time of five minutes, inference will not begin on the data until the first data measurement after the five minute mark. For example, if five minutes is selected, the inference scheduler will wake up at the configured frequency with the additional five minute delay time to check the customer S3 bucket. The customer can upload data at the same frequency and they don't need to stop and restart the scheduler when uploading new data.

    • DataUploadFrequency (string) --

      Specifies how often data is uploaded to the source S3 bucket for the input data. This value is the length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5 minutes. This frequency also determines how often Amazon Lookout for Equipment starts a scheduled inference on your data. In this example, it starts once every 5 minutes.

    • CreatedAt (datetime) --

      Specifies the time at which the inference scheduler was created.

    • UpdatedAt (datetime) --

      Specifies the time at which the inference scheduler was last updated, if it was.

    • DataInputConfiguration (dict) --

      Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.

      • S3InputConfiguration (dict) --

        Specifies configuration information for the input data for the inference, including Amazon S3 location of input data.

        • Bucket (string) --

          The bucket containing the input dataset for the inference.

        • Prefix (string) --

          The prefix for the S3 bucket used for the input data for the inference.

      • InputTimeZoneOffset (string) --

        Indicates the difference between your time zone and Coordinated Universal Time (UTC).

      • InferenceInputNameConfiguration (dict) --

        Specifies configuration information for the input data for the inference, including timestamp format and delimiter.

        • TimestampFormat (string) --

          The format of the timestamp, whether Epoch time, or standard, with or without hyphens (-).

        • ComponentTimestampDelimiter (string) --

          Indicates the delimiter character used between items in the data.

    • DataOutputConfiguration (dict) --

      Specifies information for the output results for the inference scheduler, including the output S3 location.

      • S3OutputConfiguration (dict) --

        Specifies configuration information for the output results from for the inference, output S3 location.

        • Bucket (string) --

          The bucket containing the output results from the inference

        • Prefix (string) --

          The prefix for the S3 bucket used for the output results from the inference.

      • KmsKeyId (string) --

        The ID number for the AWS KMS key used to encrypt the inference output.

    • RoleArn (string) --

      The Amazon Resource Name (ARN) of a role with permission to access the data source for the inference scheduler being described.

    • ServerSideKmsKeyId (string) --

      Provides the identifier of the KMS key used to encrypt inference scheduler data by Amazon Lookout for Equipment.

    • LatestInferenceResult (string) --

      Indicates whether the latest execution for the inference scheduler was Anomalous (anomalous events found) or Normal (no anomalous events found).

Exceptions

describe_label(**kwargs)

Returns the name of the label.

See also: AWS API Documentation

Request Syntax

response = client.describe_label(
    LabelGroupName='string',
    LabelId='string'
)
Parameters
  • LabelGroupName (string) --

    [REQUIRED]

    Returns the name of the group containing the label.

  • LabelId (string) --

    [REQUIRED]

    Returns the ID of the label.

Return type

dict

Returns

Response Syntax

{
    'LabelGroupName': 'string',
    'LabelGroupArn': 'string',
    'LabelId': 'string',
    'StartTime': datetime(2015, 1, 1),
    'EndTime': datetime(2015, 1, 1),
    'Rating': 'ANOMALY'|'NO_ANOMALY'|'NEUTRAL',
    'FaultCode': 'string',
    'Notes': 'string',
    'Equipment': 'string',
    'CreatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • LabelGroupName (string) --

      The name of the requested label group.

    • LabelGroupArn (string) --

      The ARN of the requested label group.

    • LabelId (string) --

      The ID of the requested label.

    • StartTime (datetime) --

      The start time of the requested label.

    • EndTime (datetime) --

      The end time of the requested label.

    • Rating (string) --

      Indicates whether a labeled event represents an anomaly.

    • FaultCode (string) --

      Indicates the type of anomaly associated with the label.

      Data in this field will be retained for service usage. Follow best practices for the security of your data.

    • Notes (string) --

      Metadata providing additional information about the label.

      Data in this field will be retained for service usage. Follow best practices for the security of your data.

    • Equipment (string) --

      Indicates that a label pertains to a particular piece of equipment.

    • CreatedAt (datetime) --

      The time at which the label was created.

Exceptions

describe_label_group(**kwargs)

Returns information about the label group.

See also: AWS API Documentation

Request Syntax

response = client.describe_label_group(
    LabelGroupName='string'
)
Parameters
LabelGroupName (string) --

[REQUIRED]

Returns the name of the label group.

Return type
dict
Returns
Response Syntax
{
    'LabelGroupName': 'string',
    'LabelGroupArn': 'string',
    'FaultCodes': [
        'string',
    ],
    'CreatedAt': datetime(2015, 1, 1),
    'UpdatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --
    • LabelGroupName (string) --

      The name of the label group.

    • LabelGroupArn (string) --

      The ARN of the label group.

    • FaultCodes (list) --

      Codes indicating the type of anomaly associated with the labels in the lagbel group.

      • (string) --
    • CreatedAt (datetime) --

      The time at which the label group was created.

    • UpdatedAt (datetime) --

      The time at which the label group was updated.

Exceptions

describe_model(**kwargs)

Provides a JSON containing the overall information about a specific ML model, including model name and ARN, dataset, training and evaluation information, status, and so on.

See also: AWS API Documentation

Request Syntax

response = client.describe_model(
    ModelName='string'
)
Parameters
ModelName (string) --

[REQUIRED]

The name of the ML model to be described.

Return type
dict
Returns
Response Syntax
{
    'ModelName': 'string',
    'ModelArn': 'string',
    'DatasetName': 'string',
    'DatasetArn': 'string',
    'Schema': 'string',
    'LabelsInputConfiguration': {
        'S3InputConfiguration': {
            'Bucket': 'string',
            'Prefix': 'string'
        },
        'LabelGroupName': 'string'
    },
    'TrainingDataStartTime': datetime(2015, 1, 1),
    'TrainingDataEndTime': datetime(2015, 1, 1),
    'EvaluationDataStartTime': datetime(2015, 1, 1),
    'EvaluationDataEndTime': datetime(2015, 1, 1),
    'RoleArn': 'string',
    'DataPreProcessingConfiguration': {
        'TargetSamplingRate': 'PT1S'|'PT5S'|'PT10S'|'PT15S'|'PT30S'|'PT1M'|'PT5M'|'PT10M'|'PT15M'|'PT30M'|'PT1H'
    },
    'Status': 'IN_PROGRESS'|'SUCCESS'|'FAILED',
    'TrainingExecutionStartTime': datetime(2015, 1, 1),
    'TrainingExecutionEndTime': datetime(2015, 1, 1),
    'FailedReason': 'string',
    'ModelMetrics': 'string',
    'LastUpdatedTime': datetime(2015, 1, 1),
    'CreatedAt': datetime(2015, 1, 1),
    'ServerSideKmsKeyId': 'string',
    'OffCondition': 'string'
}

Response Structure

  • (dict) --
    • ModelName (string) --

      The name of the ML model being described.

    • ModelArn (string) --

      The Amazon Resource Name (ARN) of the ML model being described.

    • DatasetName (string) --

      The name of the dataset being used by the ML being described.

    • DatasetArn (string) --

      The Amazon Resouce Name (ARN) of the dataset used to create the ML model being described.

    • Schema (string) --

      A JSON description of the data that is in each time series dataset, including names, column names, and data types.

    • LabelsInputConfiguration (dict) --

      Specifies configuration information about the labels input, including its S3 location.

      • S3InputConfiguration (dict) --

        Contains location information for the S3 location being used for label data.

        • Bucket (string) --

          The name of the S3 bucket holding the label data.

        • Prefix (string) --

          The prefix for the S3 bucket used for the label data.

      • LabelGroupName (string) --

        The name of the label group to be used for label data.

    • TrainingDataStartTime (datetime) --

      Indicates the time reference in the dataset that was used to begin the subset of training data for the ML model.

    • TrainingDataEndTime (datetime) --

      Indicates the time reference in the dataset that was used to end the subset of training data for the ML model.

    • EvaluationDataStartTime (datetime) --

      Indicates the time reference in the dataset that was used to begin the subset of evaluation data for the ML model.

    • EvaluationDataEndTime (datetime) --

      Indicates the time reference in the dataset that was used to end the subset of evaluation data for the ML model.

    • RoleArn (string) --

      The Amazon Resource Name (ARN) of a role with permission to access the data source for the ML model being described.

    • DataPreProcessingConfiguration (dict) --

      The configuration is the TargetSamplingRate , which is the sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been collected at a 1 second level and you want the system to resample the data at a 1 minute rate before training, the TargetSamplingRate is 1 minute.

      When providing a value for the TargetSamplingRate , you must attach the prefix "PT" to the rate you want. The value for a 1 second rate is therefore PT1S , the value for a 15 minute rate is PT15M , and the value for a 1 hour rate is PT1H

      • TargetSamplingRate (string) --

        The sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been collected at a 1 second level and you want the system to resample the data at a 1 minute rate before training, the TargetSamplingRate is 1 minute.

        When providing a value for the TargetSamplingRate , you must attach the prefix "PT" to the rate you want. The value for a 1 second rate is therefore PT1S , the value for a 15 minute rate is PT15M , and the value for a 1 hour rate is PT1H

    • Status (string) --

      Specifies the current status of the model being described. Status describes the status of the most recent action of the model.

    • TrainingExecutionStartTime (datetime) --

      Indicates the time at which the training of the ML model began.

    • TrainingExecutionEndTime (datetime) --

      Indicates the time at which the training of the ML model was completed.

    • FailedReason (string) --

      If the training of the ML model failed, this indicates the reason for that failure.

    • ModelMetrics (string) --

      The Model Metrics show an aggregated summary of the model's performance within the evaluation time range. This is the JSON content of the metrics created when evaluating the model.

    • LastUpdatedTime (datetime) --

      Indicates the last time the ML model was updated. The type of update is not specified.

    • CreatedAt (datetime) --

      Indicates the time and date at which the ML model was created.

    • ServerSideKmsKeyId (string) --

      Provides the identifier of the KMS key used to encrypt model data by Amazon Lookout for Equipment.

    • OffCondition (string) --

      Indicates that the asset associated with this sensor has been shut off. As long as this condition is met, Lookout for Equipment will not use data from this asset for training, evaluation, or inference.

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
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'
)
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'
        },
    ]
}

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

              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}/*

        • Status (string) --

          Indicates the status of the data ingestion job.

Exceptions

list_datasets(**kwargs)

Lists all datasets currently available in your account, filtering on the dataset name.

See also: AWS API Documentation

Request Syntax

response = client.list_datasets(
    NextToken='string',
    MaxResults=123,
    DatasetNameBeginsWith='string'
)
Parameters
  • NextToken (string) -- An opaque pagination token indicating where to continue the listing of datasets.
  • MaxResults (integer) -- Specifies the maximum number of datasets to list.
  • DatasetNameBeginsWith (string) -- The beginning of the name of the datasets to be listed.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'DatasetSummaries': [
        {
            'DatasetName': 'string',
            'DatasetArn': 'string',
            'Status': 'CREATED'|'INGESTION_IN_PROGRESS'|'ACTIVE',
            'CreatedAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      An opaque pagination token indicating where to continue the listing of datasets.

    • DatasetSummaries (list) --

      Provides information about the specified dataset, including creation time, dataset ARN, and status.

      • (dict) --

        Contains information about the specific data set, including name, ARN, and status.

        • DatasetName (string) --

          The name of the dataset.

        • DatasetArn (string) --

          The Amazon Resource Name (ARN) of the specified dataset.

        • Status (string) --

          Indicates the status of the dataset.

        • CreatedAt (datetime) --

          The time at which the dataset was created in Amazon Lookout for Equipment.

Exceptions

list_inference_events(**kwargs)

Lists all inference events that have been found for the specified inference scheduler.

See also: AWS API Documentation

Request Syntax

response = client.list_inference_events(
    NextToken='string',
    MaxResults=123,
    InferenceSchedulerName='string',
    IntervalStartTime=datetime(2015, 1, 1),
    IntervalEndTime=datetime(2015, 1, 1)
)
Parameters
  • NextToken (string) -- An opaque pagination token indicating where to continue the listing of inference events.
  • MaxResults (integer) -- Specifies the maximum number of inference events to list.
  • InferenceSchedulerName (string) --

    [REQUIRED]

    The name of the inference scheduler for the inference events listed.

  • IntervalStartTime (datetime) --

    [REQUIRED]

    Lookout for Equipment will return all the inference events with an end time equal to or greater than the start time given.

  • IntervalEndTime (datetime) --

    [REQUIRED]

    Returns all the inference events with an end start time equal to or greater than less than the end time given

Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'InferenceEventSummaries': [
        {
            'InferenceSchedulerArn': 'string',
            'InferenceSchedulerName': 'string',
            'EventStartTime': datetime(2015, 1, 1),
            'EventEndTime': datetime(2015, 1, 1),
            'Diagnostics': 'string',
            'EventDurationInSeconds': 123
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      An opaque pagination token indicating where to continue the listing of inference executions.

    • InferenceEventSummaries (list) --

      Provides an array of information about the individual inference events returned from the ListInferenceEvents operation, including scheduler used, event start time, event end time, diagnostics, and so on.

      • (dict) --

        Contains information about the specific inference event, including start and end time, diagnostics information, event duration and so on.

        • InferenceSchedulerArn (string) --

          The Amazon Resource Name (ARN) of the inference scheduler being used for the inference event.

        • InferenceSchedulerName (string) --

          The name of the inference scheduler being used for the inference events.

        • EventStartTime (datetime) --

          Indicates the starting time of an inference event.

        • EventEndTime (datetime) --

          Indicates the ending time of an inference event.

        • Diagnostics (string) --

          An array which specifies the names and values of all sensors contributing to an inference event.

        • EventDurationInSeconds (integer) --

          Indicates the size of an inference event in seconds.

Exceptions

list_inference_executions(**kwargs)

Lists all inference executions that have been performed by the specified inference scheduler.

See also: AWS API Documentation

Request Syntax

response = client.list_inference_executions(
    NextToken='string',
    MaxResults=123,
    InferenceSchedulerName='string',
    DataStartTimeAfter=datetime(2015, 1, 1),
    DataEndTimeBefore=datetime(2015, 1, 1),
    Status='IN_PROGRESS'|'SUCCESS'|'FAILED'
)
Parameters
  • NextToken (string) -- An opaque pagination token indicating where to continue the listing of inference executions.
  • MaxResults (integer) -- Specifies the maximum number of inference executions to list.
  • InferenceSchedulerName (string) --

    [REQUIRED]

    The name of the inference scheduler for the inference execution listed.

  • DataStartTimeAfter (datetime) -- The time reference in the inferenced dataset after which Amazon Lookout for Equipment started the inference execution.
  • DataEndTimeBefore (datetime) -- The time reference in the inferenced dataset before which Amazon Lookout for Equipment stopped the inference execution.
  • Status (string) -- The status of the inference execution.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'InferenceExecutionSummaries': [
        {
            'ModelName': 'string',
            'ModelArn': 'string',
            'InferenceSchedulerName': 'string',
            'InferenceSchedulerArn': 'string',
            'ScheduledStartTime': datetime(2015, 1, 1),
            'DataStartTime': datetime(2015, 1, 1),
            'DataEndTime': datetime(2015, 1, 1),
            'DataInputConfiguration': {
                'S3InputConfiguration': {
                    'Bucket': 'string',
                    'Prefix': 'string'
                },
                'InputTimeZoneOffset': 'string',
                'InferenceInputNameConfiguration': {
                    'TimestampFormat': 'string',
                    'ComponentTimestampDelimiter': 'string'
                }
            },
            'DataOutputConfiguration': {
                'S3OutputConfiguration': {
                    'Bucket': 'string',
                    'Prefix': 'string'
                },
                'KmsKeyId': 'string'
            },
            'CustomerResultObject': {
                'Bucket': 'string',
                'Key': 'string'
            },
            'Status': 'IN_PROGRESS'|'SUCCESS'|'FAILED',
            'FailedReason': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      An opaque pagination token indicating where to continue the listing of inference executions.

    • InferenceExecutionSummaries (list) --

      Provides an array of information about the individual inference executions returned from the ListInferenceExecutions operation, including model used, inference scheduler, data configuration, and so on.

      • (dict) --

        Contains information about the specific inference execution, including input and output data configuration, inference scheduling information, status, and so on.

        • ModelName (string) --

          The name of the ML model being used for the inference execution.

        • ModelArn (string) --

          The Amazon Resource Name (ARN) of the ML model used for the inference execution.

        • InferenceSchedulerName (string) --

          The name of the inference scheduler being used for the inference execution.

        • InferenceSchedulerArn (string) --

          The Amazon Resource Name (ARN) of the inference scheduler being used for the inference execution.

        • ScheduledStartTime (datetime) --

          Indicates the start time at which the inference scheduler began the specific inference execution.

        • DataStartTime (datetime) --

          Indicates the time reference in the dataset at which the inference execution began.

        • DataEndTime (datetime) --

          Indicates the time reference in the dataset at which the inference execution stopped.

        • DataInputConfiguration (dict) --

          Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.

          • S3InputConfiguration (dict) --

            Specifies configuration information for the input data for the inference, including Amazon S3 location of input data.

            • Bucket (string) --

              The bucket containing the input dataset for the inference.

            • Prefix (string) --

              The prefix for the S3 bucket used for the input data for the inference.

          • InputTimeZoneOffset (string) --

            Indicates the difference between your time zone and Coordinated Universal Time (UTC).

          • InferenceInputNameConfiguration (dict) --

            Specifies configuration information for the input data for the inference, including timestamp format and delimiter.

            • TimestampFormat (string) --

              The format of the timestamp, whether Epoch time, or standard, with or without hyphens (-).

            • ComponentTimestampDelimiter (string) --

              Indicates the delimiter character used between items in the data.

        • DataOutputConfiguration (dict) --

          Specifies configuration information for the output results from for the inference execution, including the output Amazon S3 location.

          • S3OutputConfiguration (dict) --

            Specifies configuration information for the output results from for the inference, output S3 location.

            • Bucket (string) --

              The bucket containing the output results from the inference

            • Prefix (string) --

              The prefix for the S3 bucket used for the output results from the inference.

          • KmsKeyId (string) --

            The ID number for the AWS KMS key used to encrypt the inference output.

        • CustomerResultObject (dict) --

          • Bucket (string) --

            The name of the specific S3 bucket.

          • Key (string) --

            The AWS Key Management Service (AWS KMS) key being used to encrypt the S3 object. Without this key, data in the bucket is not accessible.

        • Status (string) --

          Indicates the status of the inference execution.

        • FailedReason (string) --

          Specifies the reason for failure when an inference execution has failed.

Exceptions

list_inference_schedulers(**kwargs)

Retrieves a list of all inference schedulers currently available for your account.

See also: AWS API Documentation

Request Syntax

response = client.list_inference_schedulers(
    NextToken='string',
    MaxResults=123,
    InferenceSchedulerNameBeginsWith='string',
    ModelName='string'
)
Parameters
  • NextToken (string) -- An opaque pagination token indicating where to continue the listing of inference schedulers.
  • MaxResults (integer) -- Specifies the maximum number of inference schedulers to list.
  • InferenceSchedulerNameBeginsWith (string) -- The beginning of the name of the inference schedulers to be listed.
  • ModelName (string) -- The name of the ML model used by the inference scheduler to be listed.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'InferenceSchedulerSummaries': [
        {
            'ModelName': 'string',
            'ModelArn': 'string',
            'InferenceSchedulerName': 'string',
            'InferenceSchedulerArn': 'string',
            'Status': 'PENDING'|'RUNNING'|'STOPPING'|'STOPPED',
            'DataDelayOffsetInMinutes': 123,
            'DataUploadFrequency': 'PT5M'|'PT10M'|'PT15M'|'PT30M'|'PT1H',
            'LatestInferenceResult': 'ANOMALOUS'|'NORMAL'
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      An opaque pagination token indicating where to continue the listing of inference schedulers.

    • InferenceSchedulerSummaries (list) --

      Provides information about the specified inference scheduler, including data upload frequency, model name and ARN, and status.

      • (dict) --

        Contains information about the specific inference scheduler, including data delay offset, model name and ARN, status, and so on.

        • ModelName (string) --

          The name of the ML model used for the inference scheduler.

        • ModelArn (string) --

          The Amazon Resource Name (ARN) of the ML model used by the inference scheduler.

        • InferenceSchedulerName (string) --

          The name of the inference scheduler.

        • InferenceSchedulerArn (string) --

          The Amazon Resource Name (ARN) of the inference scheduler.

        • Status (string) --

          Indicates the status of the inference scheduler.

        • DataDelayOffsetInMinutes (integer) --

          A period of time (in minutes) by which inference on the data is delayed after the data starts. For instance, if an offset delay time of five minutes was selected, inference will not begin on the data until the first data measurement after the five minute mark. For example, if five minutes is selected, the inference scheduler will wake up at the configured frequency with the additional five minute delay time to check the customer S3 bucket. The customer can upload data at the same frequency and they don't need to stop and restart the scheduler when uploading new data.

        • DataUploadFrequency (string) --

          How often data is uploaded to the source S3 bucket for the input data. This value is the length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5 minutes. This frequency also determines how often Amazon Lookout for Equipment starts a scheduled inference on your data. In this example, it starts once every 5 minutes.

        • LatestInferenceResult (string) --

          Indicates whether the latest execution for the inference scheduler was Anomalous (anomalous events found) or Normal (no anomalous events found).

Exceptions

list_label_groups(**kwargs)

Returns a list of the label groups.

See also: AWS API Documentation

Request Syntax

response = client.list_label_groups(
    LabelGroupNameBeginsWith='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • LabelGroupNameBeginsWith (string) -- The beginning of the name of the label groups to be listed.
  • NextToken (string) -- An opaque pagination token indicating where to continue the listing of label groups.
  • MaxResults (integer) -- Specifies the maximum number of label groups to list.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'LabelGroupSummaries': [
        {
            'LabelGroupName': 'string',
            'LabelGroupArn': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      An opaque pagination token indicating where to continue the listing of label groups.

    • LabelGroupSummaries (list) --

      A summary of the label groups.

      • (dict) --

        Contains information about the label group.

        • LabelGroupName (string) --

          The name of the label group.

        • LabelGroupArn (string) --

          The ARN of the label group.

        • CreatedAt (datetime) --

          The time at which the label group was created.

        • UpdatedAt (datetime) --

          The time at which the label group was updated.

Exceptions

list_labels(**kwargs)

Provides a list of labels.

See also: AWS API Documentation

Request Syntax

response = client.list_labels(
    LabelGroupName='string',
    IntervalStartTime=datetime(2015, 1, 1),
    IntervalEndTime=datetime(2015, 1, 1),
    FaultCode='string',
    Equipment='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • LabelGroupName (string) --

    [REQUIRED]

    Retruns the name of the label group.

  • IntervalStartTime (datetime) -- Returns all the labels with a end time equal to or later than the start time given.
  • IntervalEndTime (datetime) -- Returns all labels with a start time earlier than the end time given.
  • FaultCode (string) -- Returns labels with a particular fault code.
  • Equipment (string) -- Lists the labels that pertain to a particular piece of equipment.
  • NextToken (string) -- An opaque pagination token indicating where to continue the listing of label groups.
  • MaxResults (integer) -- Specifies the maximum number of labels to list.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'LabelSummaries': [
        {
            'LabelGroupName': 'string',
            'LabelId': 'string',
            'LabelGroupArn': 'string',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'Rating': 'ANOMALY'|'NO_ANOMALY'|'NEUTRAL',
            'FaultCode': 'string',
            'Equipment': 'string',
            'CreatedAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      An opaque pagination token indicating where to continue the listing of datasets.

    • LabelSummaries (list) --

      A summary of the items in the label group.

      • (dict) --

        Information about the label.

        • LabelGroupName (string) --

          The name of the label group.

        • LabelId (string) --

          The ID of the label.

        • LabelGroupArn (string) --

          The ARN of the label group.

        • StartTime (datetime) --

          The timestamp indicating the start of the label.

        • EndTime (datetime) --

          The timestamp indicating the end of the label.

        • Rating (string) --

          Indicates whether a labeled event represents an anomaly.

        • FaultCode (string) --

          Indicates the type of anomaly associated with the label.

          Data in this field will be retained for service usage. Follow best practices for the security of your data.

        • Equipment (string) --

          Indicates that a label pertains to a particular piece of equipment.

        • CreatedAt (datetime) --

          The time at which the label was created.

Exceptions

list_models(**kwargs)

Generates a list of all models in the account, including model name and ARN, dataset, and status.

See also: AWS API Documentation

Request Syntax

response = client.list_models(
    NextToken='string',
    MaxResults=123,
    Status='IN_PROGRESS'|'SUCCESS'|'FAILED',
    ModelNameBeginsWith='string',
    DatasetNameBeginsWith='string'
)
Parameters
  • NextToken (string) -- An opaque pagination token indicating where to continue the listing of ML models.
  • MaxResults (integer) -- Specifies the maximum number of ML models to list.
  • Status (string) -- The status of the ML model.
  • ModelNameBeginsWith (string) -- The beginning of the name of the ML models being listed.
  • DatasetNameBeginsWith (string) -- The beginning of the name of the dataset of the ML models to be listed.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'ModelSummaries': [
        {
            'ModelName': 'string',
            'ModelArn': 'string',
            'DatasetName': 'string',
            'DatasetArn': 'string',
            'Status': 'IN_PROGRESS'|'SUCCESS'|'FAILED',
            'CreatedAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      An opaque pagination token indicating where to continue the listing of ML models.

    • ModelSummaries (list) --

      Provides information on the specified model, including created time, model and dataset ARNs, and status.

      • (dict) --

        Provides information about the specified ML model, including dataset and model names and ARNs, as well as status.

        • ModelName (string) --

          The name of the ML model.

        • ModelArn (string) --

          The Amazon Resource Name (ARN) of the ML model.

        • DatasetName (string) --

          The name of the dataset being used for the ML model.

        • DatasetArn (string) --

          The Amazon Resource Name (ARN) of the dataset used to create the model.

        • Status (string) --

          Indicates the status of the ML model.

        • CreatedAt (datetime) --

          The time at which the specific model was created.

Exceptions

list_sensor_statistics(**kwargs)

Lists statistics about the data collected for each of the sensors that have been successfully ingested in the particular dataset. Can also be used to retreive Sensor Statistics for a previous ingestion job.

See also: AWS API Documentation

Request Syntax

response = client.list_sensor_statistics(
    DatasetName='string',
    IngestionJobId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • DatasetName (string) --

    [REQUIRED]

    The name of the dataset associated with the list of Sensor Statistics.

  • IngestionJobId (string) -- The ingestion job id associated with the list of Sensor Statistics. To get sensor statistics for a particular ingestion job id, both dataset name and ingestion job id must be submitted as inputs.
  • MaxResults (integer) -- Specifies the maximum number of sensors for which to retrieve statistics.
  • NextToken (string) -- An opaque pagination token indicating where to continue the listing of sensor statistics.
Return type

dict

Returns

Response Syntax

{
    'SensorStatisticsSummaries': [
        {
            'ComponentName': 'string',
            'SensorName': 'string',
            'DataExists': True|False,
            'MissingValues': {
                'Count': 123,
                'Percentage': ...
            },
            'InvalidValues': {
                'Count': 123,
                'Percentage': ...
            },
            'InvalidDateEntries': {
                'Count': 123,
                'Percentage': ...
            },
            'DuplicateTimestamps': {
                'Count': 123,
                'Percentage': ...
            },
            'CategoricalValues': {
                'Status': 'POTENTIAL_ISSUE_DETECTED'|'NO_ISSUE_DETECTED',
                'NumberOfCategory': 123
            },
            'MultipleOperatingModes': {
                'Status': 'POTENTIAL_ISSUE_DETECTED'|'NO_ISSUE_DETECTED'
            },
            'LargeTimestampGaps': {
                'Status': 'POTENTIAL_ISSUE_DETECTED'|'NO_ISSUE_DETECTED',
                'NumberOfLargeTimestampGaps': 123,
                'MaxTimestampGapInDays': 123
            },
            'MonotonicValues': {
                'Status': 'POTENTIAL_ISSUE_DETECTED'|'NO_ISSUE_DETECTED',
                'Monotonicity': 'DECREASING'|'INCREASING'|'STATIC'
            },
            'DataStartTime': datetime(2015, 1, 1),
            'DataEndTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • SensorStatisticsSummaries (list) --

      Provides ingestion-based statistics regarding the specified sensor with respect to various validation types, such as whether data exists, the number and percentage of missing values, and the number and percentage of duplicate timestamps.

      • (dict) --

        Summary of ingestion statistics like whether data exists, number of missing values, number of invalid values and so on related to the particular sensor.

        • ComponentName (string) --

          Name of the component to which the particular sensor belongs for which the statistics belong to.

        • SensorName (string) --

          Name of the sensor that the statistics belong to.

        • DataExists (boolean) --

          Parameter that indicates whether data exists for the sensor that the statistics belong to.

        • MissingValues (dict) --

          Parameter that describes the total number of, and percentage of, values that are missing for the sensor that the statistics belong to.

          • Count (integer) --

            Indicates the count of occurences of the given statistic.

          • Percentage (float) --

            Indicates the percentage of occurances of the given statistic.

        • InvalidValues (dict) --

          Parameter that describes the total number of, and percentage of, values that are invalid for the sensor that the statistics belong to.

          • Count (integer) --

            Indicates the count of occurences of the given statistic.

          • Percentage (float) --

            Indicates the percentage of occurances of the given statistic.

        • InvalidDateEntries (dict) --

          Parameter that describes the total number of invalid date entries associated with the sensor that the statistics belong to.

          • Count (integer) --

            Indicates the count of occurences of the given statistic.

          • Percentage (float) --

            Indicates the percentage of occurances of the given statistic.

        • DuplicateTimestamps (dict) --

          Parameter that describes the total number of duplicate timestamp records associated with the sensor that the statistics belong to.

          • Count (integer) --

            Indicates the count of occurences of the given statistic.

          • Percentage (float) --

            Indicates the percentage of occurances of the given statistic.

        • CategoricalValues (dict) --

          Parameter that describes potential risk about whether data associated with the sensor is categorical.

          • Status (string) --

            Indicates whether there is a potential data issue related to categorical values.

          • NumberOfCategory (integer) --

            Indicates the number of categories in the data.

        • MultipleOperatingModes (dict) --

          Parameter that describes potential risk about whether data associated with the sensor has more than one operating mode.

          • Status (string) --

            Indicates whether there is a potential data issue related to having multiple operating modes.

        • LargeTimestampGaps (dict) --

          Parameter that describes potential risk about whether data associated with the sensor contains one or more large gaps between consecutive timestamps.

          • Status (string) --

            Indicates whether there is a potential data issue related to large gaps in timestamps.

          • NumberOfLargeTimestampGaps (integer) --

            Indicates the number of large timestamp gaps, if there are any.

          • MaxTimestampGapInDays (integer) --

            Indicates the size of the largest timestamp gap, in days.

        • MonotonicValues (dict) --

          Parameter that describes potential risk about whether data associated with the sensor is mostly monotonic.

          • Status (string) --

            Indicates whether there is a potential data issue related to having monotonic values.

          • Monotonicity (string) --

            Indicates the monotonicity of values. Can be INCREASING, DECREASING, or STATIC.

        • DataStartTime (datetime) --

          Indicates the time reference to indicate the beginning of valid data associated with the sensor that the statistics belong to.

        • DataEndTime (datetime) --

          Indicates the time reference to indicate the end of valid data associated with the sensor that the statistics belong to.

    • NextToken (string) --

      An opaque pagination token indicating where to continue the listing of sensor statistics.

Exceptions

list_tags_for_resource(**kwargs)

Lists all the tags for a specified resource, including key and value.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceArn='string'
)
Parameters
ResourceArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the resource (such as the dataset or model) that is the focus of the ListTagsForResource operation.

Return type
dict
Returns
Response Syntax
{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • Tags (list) --

      Any tags associated with the resource.

      • (dict) --

        A tag is a key-value pair that can be added to a resource as metadata.

        • Key (string) --

          The key for the specified tag.

        • Value (string) --

          The value for the specified tag.

Exceptions

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

start_inference_scheduler(**kwargs)

Starts an inference scheduler.

See also: AWS API Documentation

Request Syntax

response = client.start_inference_scheduler(
    InferenceSchedulerName='string'
)
Parameters
InferenceSchedulerName (string) --

[REQUIRED]

The name of the inference scheduler to be started.

Return type
dict
Returns
Response Syntax
{
    'ModelArn': 'string',
    'ModelName': 'string',
    'InferenceSchedulerName': 'string',
    'InferenceSchedulerArn': 'string',
    'Status': 'PENDING'|'RUNNING'|'STOPPING'|'STOPPED'
}

Response Structure

  • (dict) --
    • ModelArn (string) --

      The Amazon Resource Name (ARN) of the ML model being used by the inference scheduler.

    • ModelName (string) --

      The name of the ML model being used by the inference scheduler.

    • InferenceSchedulerName (string) --

      The name of the inference scheduler being started.

    • InferenceSchedulerArn (string) --

      The Amazon Resource Name (ARN) of the inference scheduler being started.

    • Status (string) --

      Indicates the status of the inference scheduler.

Exceptions

stop_inference_scheduler(**kwargs)

Stops an inference scheduler.

See also: AWS API Documentation

Request Syntax

response = client.stop_inference_scheduler(
    InferenceSchedulerName='string'
)
Parameters
InferenceSchedulerName (string) --

[REQUIRED]

The name of the inference scheduler to be stopped.

Return type
dict
Returns
Response Syntax
{
    'ModelArn': 'string',
    'ModelName': 'string',
    'InferenceSchedulerName': 'string',
    'InferenceSchedulerArn': 'string',
    'Status': 'PENDING'|'RUNNING'|'STOPPING'|'STOPPED'
}

Response Structure

  • (dict) --
    • ModelArn (string) --

      The Amazon Resource Name (ARN) of the ML model used by the inference scheduler being stopped.

    • ModelName (string) --

      The name of the ML model used by the inference scheduler being stopped.

    • InferenceSchedulerName (string) --

      The name of the inference scheduler being stopped.

    • InferenceSchedulerArn (string) --

      The Amazon Resource Name (ARN) of the inference schedule being stopped.

    • Status (string) --

      Indicates the status of the inference scheduler.

Exceptions

tag_resource(**kwargs)

Associates a given tag to a resource in your account. A tag is a key-value pair which can be added to an Amazon Lookout for Equipment resource as metadata. Tags can be used for organizing your resources as well as helping you to search and filter by tag. Multiple tags can be added to a resource, either when you create it, or later. Up to 50 tags can be associated with each resource.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the specific resource to which the tag should be associated.

  • Tags (list) --

    [REQUIRED]

    The tag or tags to be associated with a specific resource. Both the tag key and value are specified.

    • (dict) --

      A tag is a key-value pair that can be added to a resource as metadata.

      • Key (string) -- [REQUIRED]

        The key for the specified tag.

      • Value (string) -- [REQUIRED]

        The value for the specified tag.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

untag_resource(**kwargs)

Removes a specific tag from a given resource. The tag is specified by its key.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource to which the tag is currently associated.

  • TagKeys (list) --

    [REQUIRED]

    Specifies the key of the tag to be removed from a specified resource.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_inference_scheduler(**kwargs)

Updates an inference scheduler.

See also: AWS API Documentation

Request Syntax

response = client.update_inference_scheduler(
    InferenceSchedulerName='string',
    DataDelayOffsetInMinutes=123,
    DataUploadFrequency='PT5M'|'PT10M'|'PT15M'|'PT30M'|'PT1H',
    DataInputConfiguration={
        'S3InputConfiguration': {
            'Bucket': 'string',
            'Prefix': 'string'
        },
        'InputTimeZoneOffset': 'string',
        'InferenceInputNameConfiguration': {
            'TimestampFormat': 'string',
            'ComponentTimestampDelimiter': 'string'
        }
    },
    DataOutputConfiguration={
        'S3OutputConfiguration': {
            'Bucket': 'string',
            'Prefix': 'string'
        },
        'KmsKeyId': 'string'
    },
    RoleArn='string'
)
Parameters
  • InferenceSchedulerName (string) --

    [REQUIRED]

    The name of the inference scheduler to be updated.

  • DataDelayOffsetInMinutes (integer) -- A period of time (in minutes) by which inference on the data is delayed after the data starts. For instance, if you select an offset delay time of five minutes, inference will not begin on the data until the first data measurement after the five minute mark. For example, if five minutes is selected, the inference scheduler will wake up at the configured frequency with the additional five minute delay time to check the customer S3 bucket. The customer can upload data at the same frequency and they don't need to stop and restart the scheduler when uploading new data.
  • DataUploadFrequency (string) -- How often data is uploaded to the source S3 bucket for the input data. The value chosen is the length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5 minutes. This frequency also determines how often Amazon Lookout for Equipment starts a scheduled inference on your data. In this example, it starts once every 5 minutes.
  • DataInputConfiguration (dict) --

    Specifies information for the input data for the inference scheduler, including delimiter, format, and dataset location.

    • S3InputConfiguration (dict) --

      Specifies configuration information for the input data for the inference, including Amazon S3 location of input data.

      • Bucket (string) -- [REQUIRED]

        The bucket containing the input dataset for the inference.

      • Prefix (string) --

        The prefix for the S3 bucket used for the input data for the inference.

    • InputTimeZoneOffset (string) --

      Indicates the difference between your time zone and Coordinated Universal Time (UTC).

    • InferenceInputNameConfiguration (dict) --

      Specifies configuration information for the input data for the inference, including timestamp format and delimiter.

      • TimestampFormat (string) --

        The format of the timestamp, whether Epoch time, or standard, with or without hyphens (-).

      • ComponentTimestampDelimiter (string) --

        Indicates the delimiter character used between items in the data.

  • DataOutputConfiguration (dict) --

    Specifies information for the output results from the inference scheduler, including the output S3 location.

    • S3OutputConfiguration (dict) -- [REQUIRED]

      Specifies configuration information for the output results from for the inference, output S3 location.

      • Bucket (string) -- [REQUIRED]

        The bucket containing the output results from the inference

      • Prefix (string) --

        The prefix for the S3 bucket used for the output results from the inference.

    • KmsKeyId (string) --

      The ID number for the AWS KMS key used to encrypt the inference output.

  • RoleArn (string) -- The Amazon Resource Name (ARN) of a role with permission to access the data source for the inference scheduler.
Returns

None

Exceptions

update_label_group(**kwargs)

Updates the label group.

See also: AWS API Documentation

Request Syntax

response = client.update_label_group(
    LabelGroupName='string',
    FaultCodes=[
        'string',
    ]
)
Parameters
  • LabelGroupName (string) --

    [REQUIRED]

    The name of the label group to be updated.

  • FaultCodes (list) --

    Updates the code indicating the type of anomaly associated with the label.

    Data in this field will be retained for service usage. Follow best practices for the security of your data.

    • (string) --
Returns

None

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class LookoutEquipment.Client.exceptions.AccessDeniedException

The request could not be completed because you do not have access to the resource.

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request could not be completed because you do not have access to the resource.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LookoutEquipment.Client.exceptions.ConflictException

The request could not be completed due to a conflict with the current state of the target resource.

Example

try:
  ...
except client.exceptions.ConflictException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request could not be completed due to a conflict with the current state of the target resource.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LookoutEquipment.Client.exceptions.InternalServerException

Processing of the request has failed because of an unknown error, exception or failure.

Example

try:
  ...
except client.exceptions.InternalServerException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Processing of the request has failed because of an unknown error, exception or failure.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LookoutEquipment.Client.exceptions.ResourceNotFoundException

The resource requested could not be found. Verify the resource ID and retry your request.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The resource requested could not be found. Verify the resource ID and retry your request.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LookoutEquipment.Client.exceptions.ServiceQuotaExceededException

Resource limitations have been exceeded.

Example

try:
  ...
except client.exceptions.ServiceQuotaExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Resource limitations have been exceeded.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LookoutEquipment.Client.exceptions.ThrottlingException

The request was denied due to request throttling.

Example

try:
  ...
except client.exceptions.ThrottlingException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request was denied due to request throttling.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class LookoutEquipment.Client.exceptions.ValidationException

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related AWS service that's being utilized.

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related AWS service that's being utilized.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are: