For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateInferenceScheduler
CreateInferenceScheduler
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.
Request Syntax
{ "ClientToken": "string",
"DataDelayOffsetInMinutes": number, "DataInputConfiguration": {
"InferenceInputNameConfiguration": { "ComponentTimestampDelimiter": "string", "TimestampFormat": "string"
},
"InputTimeZoneOffset": "string", "S3InputConfiguration": { "Bucket": "string", "Prefix": "string"
} },
"DataOutputConfiguration": { "KmsKeyId": "string",
"DataUploadFrequency": "string", "InferenceSchedulerName": "string", "ModelName": "string",
"RoleArn": "string",
"ServerSideKmsKeyId": "string", "Tags": [
The request accepts the following data in JSON format.
ClientToken (p. 82)
A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: \p{ASCII}{1,256}
Required: Yes
CreateInferenceScheduler
DataDelayOffsetInMinutes (p. 82)
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.
Type: Long
Valid Range: Minimum value of 0. Maximum value of 60.
Required: No
DataInputConfiguration (p. 82)
Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.
Type: InferenceInputConfiguration (p. 156) object Required: Yes
DataOutputConfiguration (p. 82)
Specifies configuration information for the output results for the inference scheduler, including the S3 location for the output.
Type: InferenceOutputConfiguration (p. 158) object Required: Yes
DataUploadFrequency (p. 82)
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.
Type: String
Valid Values: PT5M | PT10M | PT15M | PT30M | PT1H Required: Yes
InferenceSchedulerName (p. 82)
The name of the inference scheduler being created.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: ^[0-9a-zA-Z_-]{1,200}$
Required: Yes ModelName (p. 82)
The name of the previously trained ML model being used to create the inference scheduler.
Type: String
CreateInferenceScheduler
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: ^[0-9a-zA-Z_-]{1,200}$
Required: Yes RoleArn (p. 82)
The Amazon Resource Name (ARN) of a role with permission to access the data source being used for the inference.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
Required: Yes
ServerSideKmsKeyId (p. 82)
Provides the identifier of the AWS KMS key used to encrypt inference scheduler data by Amazon Lookout for Equipment.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$
Required: No Tags (p. 82)
Any tags associated with the inference scheduler.
Type: Array of Tag (p. 170) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
Response Syntax
{ "InferenceSchedulerArn": "string", "InferenceSchedulerName": "string", "Status": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
InferenceSchedulerArn (p. 84)
The Amazon Resource Name (ARN) of the inference scheduler being created.
Type: String
CreateInferenceScheduler
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:inference-scheduler\/.+
InferenceSchedulerName (p. 84)
The name of inference scheduler being created.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: ^[0-9a-zA-Z_-]{1,200}$
Status (p. 84)
Indicates the status of the CreateInferenceScheduler operation.
Type: String
Valid Values: PENDING | RUNNING | STOPPING | STOPPED
Errors
AccessDeniedException
The request could not be completed because you do not have access to the resource.
HTTP Status Code: 400 ConflictException
The request could not be completed due to a conflict with the current state of the target resource.
HTTP Status Code: 400 InternalServerException
Processing of the request has failed because of an unknown error, exception or failure.
HTTP Status Code: 500 ResourceNotFoundException
The resource requested could not be found. Verify the resource ID and retry your request.
HTTP Status Code: 400 ServiceQuotaExceededException
Resource limitations have been exceeded.
HTTP Status Code: 400 ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 400 ValidationException
The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related AWS service that's being utilized.
CreateInferenceScheduler
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateModel
CreateModel
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.
Request Syntax
{
"ClientToken": "string",
"DataPreProcessingConfiguration": { "TargetSamplingRate": "string"
},
"DatasetName": "string", "DatasetSchema": {
"InlineDataSchema": "string"
},
"EvaluationDataEndTime": number, "EvaluationDataStartTime": number, "LabelsInputConfiguration": { "S3InputConfiguration": { "Bucket": "string", "Prefix": "string"
} },
"ModelName": "string", "OffCondition": "string", "RoleArn": "string",
"ServerSideKmsKeyId": "string", "Tags": [
"TrainingDataEndTime": number, "TrainingDataStartTime": number }
Request Parameters
The request accepts the following data in JSON format.
ClientToken (p. 87)
A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: \p{ASCII}{1,256}
CreateModel
Required: Yes
DataPreProcessingConfiguration (p. 87)
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
Type: DataPreProcessingConfiguration (p. 150) object Required: No
DatasetName (p. 87)
The name of the dataset for the ML model being created.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: ^[0-9a-zA-Z_-]{1,200}$
Required: Yes DatasetSchema (p. 87)
The data schema for the ML model being created.
Type: DatasetSchema (p. 151) object Required: No
EvaluationDataEndTime (p. 87)
Indicates the time reference in the dataset that should be used to end the subset of evaluation data for the ML model.
Type: Timestamp Required: No
EvaluationDataStartTime (p. 87)
Indicates the time reference in the dataset that should be used to begin the subset of evaluation data for the ML model.
Type: Timestamp Required: No
LabelsInputConfiguration (p. 87)
The input configuration for the labels being used for the ML model that's being created.
Type: LabelsInputConfiguration (p. 165) object Required: No
ModelName (p. 87)
The name for the ML model to be created.
Type: String
CreateModel
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: ^[0-9a-zA-Z_-]{1,200}$
Required: Yes OffCondition (p. 87)
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No RoleArn (p. 87)
The Amazon Resource Name (ARN) of a role with permission to access the data source being used to create the ML model.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
Required: No
ServerSideKmsKeyId (p. 87)
Provides the identifier of the AWS KMS key used to encrypt model data by Amazon Lookout for Equipment.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$
Required: No Tags (p. 87)
Any tags associated with the ML model being created.
Type: Array of Tag (p. 170) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
TrainingDataEndTime (p. 87)
Indicates the time reference in the dataset that should be used to end the subset of training data for the ML model.
Type: Timestamp Required: No
TrainingDataStartTime (p. 87)
Indicates the time reference in the dataset that should be used to begin the subset of training data for the ML model.
CreateModel
Type: Timestamp Required: No
Response Syntax
{ "ModelArn": "string", "Status": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
ModelArn (p. 90)
The Amazon Resource Name (ARN) of the model being created.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:model\/.+
Status (p. 90)
Indicates the status of the CreateModel operation.
Type: String
Valid Values: IN_PROGRESS | SUCCESS | FAILED
Errors
AccessDeniedException
The request could not be completed because you do not have access to the resource.
HTTP Status Code: 400 ConflictException
The request could not be completed due to a conflict with the current state of the target resource.
HTTP Status Code: 400 InternalServerException
Processing of the request has failed because of an unknown error, exception or failure.
HTTP Status Code: 500 ResourceNotFoundException
The resource requested could not be found. Verify the resource ID and retry your request.
HTTP Status Code: 400
CreateModel
ServiceQuotaExceededException
Resource limitations have been exceeded.
HTTP Status Code: 400 ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 400 ValidationException
The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related AWS service that's being utilized.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteDataset
DeleteDataset
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.
Request Syntax
{
"DatasetName": "string"
}
Request Parameters
The request accepts the following data in JSON format.
DatasetName (p. 92)
The name of the dataset to be deleted.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: ^[0-9a-zA-Z_-]{1,200}$
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
AccessDeniedException
The request could not be completed because you do not have access to the resource.
HTTP Status Code: 400 ConflictException
The request could not be completed due to a conflict with the current state of the target resource.
HTTP Status Code: 400 InternalServerException
Processing of the request has failed because of an unknown error, exception or failure.
HTTP Status Code: 500 ResourceNotFoundException
The resource requested could not be found. Verify the resource ID and retry your request.
HTTP Status Code: 400
DeleteDataset
ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteInferenceScheduler
DeleteInferenceScheduler
Deletes an inference scheduler that has been set up. Already processed output results are not affected.
Request Syntax
{
"InferenceSchedulerName": "string"
}
Request Parameters
The request accepts the following data in JSON format.
InferenceSchedulerName (p. 94)
The name of the inference scheduler to be deleted.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: ^[0-9a-zA-Z_-]{1,200}$
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
AccessDeniedException
The request could not be completed because you do not have access to the resource.
HTTP Status Code: 400 ConflictException
The request could not be completed due to a conflict with the current state of the target resource.
HTTP Status Code: 400 InternalServerException
Processing of the request has failed because of an unknown error, exception or failure.
HTTP Status Code: 500 ResourceNotFoundException
The resource requested could not be found. Verify the resource ID and retry your request.
HTTP Status Code: 400 ThrottlingException
The request was denied due to request throttling.
DeleteInferenceScheduler
HTTP Status Code: 400 ValidationException
The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related AWS service that's being utilized.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteModel
DeleteModel
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.
Request Syntax
{ "ModelName": "string"
}
Request Parameters
The request accepts the following data in JSON format.
ModelName (p. 96)
The name of the ML model to be deleted.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: ^[0-9a-zA-Z_-]{1,200}$
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
AccessDeniedException
The request could not be completed because you do not have access to the resource.
HTTP Status Code: 400 ConflictException
The request could not be completed due to a conflict with the current state of the target resource.
HTTP Status Code: 400 InternalServerException
Processing of the request has failed because of an unknown error, exception or failure.
HTTP Status Code: 500 ResourceNotFoundException
The resource requested could not be found. Verify the resource ID and retry your request.
HTTP Status Code: 400 ThrottlingException
The request was denied due to request throttling.
DeleteModel
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribeDataIngestionJob
DescribeDataIngestionJob
Provides information on a specific data ingestion job such as creation time, dataset ARN, status, and so on.
Request Syntax
{ "JobId": "string"
}
Request Parameters
The request accepts the following data in JSON format.
JobId (p. 98)
The job ID of the data ingestion job.
Type: String
Length Constraints: Maximum length of 32.
Pattern: [A-Fa-f0-9]{0,32}
Required: Yes
Response Syntax
{ "CreatedAt": number, "DatasetArn": "string", "FailedReason": "string",
"IngestionInputConfiguration": { "S3InputConfiguration": { "Bucket": "string", "Prefix": "string"
} },
"JobId": "string", "RoleArn": "string", "Status": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
CreatedAt (p. 98)
The time at which the data ingestion job was created.
Type: Timestamp
DescribeDataIngestionJob
DatasetArn (p. 98)
The Amazon Resource Name (ARN) of the dataset being used in the data ingestion job.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:dataset\/.
+
FailedReason (p. 98)
Specifies the reason for failure when a data ingestion job has failed.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5000.
Pattern: [\P{M}\p{M}]{1,5000}
IngestionInputConfiguration (p. 98)
Specifies the S3 location configuration for the data input for the data ingestion job.
Type: IngestionInputConfiguration (p. 163) object JobId (p. 98)
Indicates the job ID of the data ingestion job.
Type: String
Length Constraints: Maximum length of 32.
Pattern: [A-Fa-f0-9]{0,32}
RoleArn (p. 98)
The Amazon Resource Name (ARN) of an IAM role with permission to access the data source being ingested.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
Status (p. 98)
Indicates the status of the DataIngestionJob operation.
Type: String
Valid Values: IN_PROGRESS | SUCCESS | FAILED
Errors
AccessDeniedException
The request could not be completed because you do not have access to the resource.
HTTP Status Code: 400
DescribeDataIngestionJob
InternalServerException
Processing of the request has failed because of an unknown error, exception or failure.
HTTP Status Code: 500 ResourceNotFoundException
The resource requested could not be found. Verify the resource ID and retry your request.
HTTP Status Code: 400 ThrottlingException
The request was denied due to request throttling.
HTTP Status Code: 400 ValidationException
The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related AWS service that's being utilized.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribeDataset
DescribeDataset
Provides a JSON description of the data that is in each time series dataset, including names, column names, and data types.
Request Syntax
{
"DatasetName": "string"
}
Request Parameters
The request accepts the following data in JSON format.
DatasetName (p. 101)
The name of the dataset to be described.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: ^[0-9a-zA-Z_-]{1,200}$
Required: Yes
Response Syntax
{ "CreatedAt": number, "DatasetArn": "string", "DatasetName": "string",
"IngestionInputConfiguration": { "S3InputConfiguration": { "Bucket": "string", "Prefix": "string"
} },
"LastUpdatedAt": number, "Schema": "string",
"ServerSideKmsKeyId": "string", "Status": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
CreatedAt (p. 101)
Specifies the time the dataset was created in Amazon Lookout for Equipment.
Type: Timestamp
DescribeDataset
DatasetArn (p. 101)
The Amazon Resource Name (ARN) of the dataset being described.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:dataset\/.
+
DatasetName (p. 101)
The name of the dataset being described.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: ^[0-9a-zA-Z_-]{1,200}$
IngestionInputConfiguration (p. 101)
Specifies the S3 location configuration for the data input for the data ingestion job.
Specifies the S3 location configuration for the data input for the data ingestion job.