On October 7, 2026, AWS will discontinue support for Amazon Lookout for Equipment. After October 7, 2026, you will no longer be able to access the Lookout for Equipment console or resources. For more information, [see the following](https://aws.amazon.com/blogs/machine-learning/preserve-access-and-explore-alternatives-for-amazon-lookout-for-equipment/). 

# Actions
<a name="API_Operations"></a>

The following actions are supported:
+  [CreateDataset](API_CreateDataset.md) 
+  [CreateInferenceScheduler](API_CreateInferenceScheduler.md) 
+  [CreateLabel](API_CreateLabel.md) 
+  [CreateLabelGroup](API_CreateLabelGroup.md) 
+  [CreateModel](API_CreateModel.md) 
+  [CreateRetrainingScheduler](API_CreateRetrainingScheduler.md) 
+  [DeleteDataset](API_DeleteDataset.md) 
+  [DeleteInferenceScheduler](API_DeleteInferenceScheduler.md) 
+  [DeleteLabel](API_DeleteLabel.md) 
+  [DeleteLabelGroup](API_DeleteLabelGroup.md) 
+  [DeleteModel](API_DeleteModel.md) 
+  [DeleteResourcePolicy](API_DeleteResourcePolicy.md) 
+  [DeleteRetrainingScheduler](API_DeleteRetrainingScheduler.md) 
+  [DescribeDataIngestionJob](API_DescribeDataIngestionJob.md) 
+  [DescribeDataset](API_DescribeDataset.md) 
+  [DescribeInferenceScheduler](API_DescribeInferenceScheduler.md) 
+  [DescribeLabel](API_DescribeLabel.md) 
+  [DescribeLabelGroup](API_DescribeLabelGroup.md) 
+  [DescribeModel](API_DescribeModel.md) 
+  [DescribeModelVersion](API_DescribeModelVersion.md) 
+  [DescribeResourcePolicy](API_DescribeResourcePolicy.md) 
+  [DescribeRetrainingScheduler](API_DescribeRetrainingScheduler.md) 
+  [ImportDataset](API_ImportDataset.md) 
+  [ImportModelVersion](API_ImportModelVersion.md) 
+  [ListDataIngestionJobs](API_ListDataIngestionJobs.md) 
+  [ListDatasets](API_ListDatasets.md) 
+  [ListInferenceEvents](API_ListInferenceEvents.md) 
+  [ListInferenceExecutions](API_ListInferenceExecutions.md) 
+  [ListInferenceSchedulers](API_ListInferenceSchedulers.md) 
+  [ListLabelGroups](API_ListLabelGroups.md) 
+  [ListLabels](API_ListLabels.md) 
+  [ListModels](API_ListModels.md) 
+  [ListModelVersions](API_ListModelVersions.md) 
+  [ListRetrainingSchedulers](API_ListRetrainingSchedulers.md) 
+  [ListSensorStatistics](API_ListSensorStatistics.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [PutResourcePolicy](API_PutResourcePolicy.md) 
+  [StartDataIngestionJob](API_StartDataIngestionJob.md) 
+  [StartInferenceScheduler](API_StartInferenceScheduler.md) 
+  [StartRetrainingScheduler](API_StartRetrainingScheduler.md) 
+  [StopInferenceScheduler](API_StopInferenceScheduler.md) 
+  [StopRetrainingScheduler](API_StopRetrainingScheduler.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateActiveModelVersion](API_UpdateActiveModelVersion.md) 
+  [UpdateInferenceScheduler](API_UpdateInferenceScheduler.md) 
+  [UpdateLabelGroup](API_UpdateLabelGroup.md) 
+  [UpdateModel](API_UpdateModel.md) 
+  [UpdateRetrainingScheduler](API_UpdateRetrainingScheduler.md) 

# CreateDataset
<a name="API_CreateDataset"></a>

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. For example, 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. 

## Request Syntax
<a name="API_CreateDataset_RequestSyntax"></a>

```
{
   "ClientToken": "string",
   "DatasetName": "string",
   "DatasetSchema": { 
      "InlineDataSchema": "string"
   },
   "ServerSideKmsKeyId": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_CreateDataset_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_CreateDataset_RequestSyntax) **   <a name="LookoutForEquipment-CreateDataset-request-ClientToken"></a>
 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

 ** [DatasetName](#API_CreateDataset_RequestSyntax) **   <a name="LookoutForEquipment-CreateDataset-request-DatasetName"></a>
The name of the dataset being created.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: Yes

 ** [DatasetSchema](#API_CreateDataset_RequestSyntax) **   <a name="LookoutForEquipment-CreateDataset-request-DatasetSchema"></a>
A JSON description of the data that is in each time series dataset, including names, column names, and data types.   
Type: [DatasetSchema](API_DatasetSchema.md) object  
Required: No

 ** [ServerSideKmsKeyId](#API_CreateDataset_RequestSyntax) **   <a name="LookoutForEquipment-CreateDataset-request-ServerSideKmsKeyId"></a>
Provides the identifier of the AWS KMS key used to encrypt dataset 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](#API_CreateDataset_RequestSyntax) **   <a name="LookoutForEquipment-CreateDataset-request-Tags"></a>
Any tags associated with the ingested data described in the dataset.   
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: No

## Response Syntax
<a name="API_CreateDataset_ResponseSyntax"></a>

```
{
   "DatasetArn": "string",
   "DatasetName": "string",
   "Status": "string"
}
```

## Response Elements
<a name="API_CreateDataset_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [DatasetArn](#API_CreateDataset_ResponseSyntax) **   <a name="LookoutForEquipment-CreateDataset-response-DatasetArn"></a>
 The Amazon Resource Name (ARN) of the dataset 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}:dataset\/[0-9a-zA-Z_-]{1,200}\/.+` 

 ** [DatasetName](#API_CreateDataset_ResponseSyntax) **   <a name="LookoutForEquipment-CreateDataset-response-DatasetName"></a>
The name of the dataset being created.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$` 

 ** [Status](#API_CreateDataset_ResponseSyntax) **   <a name="LookoutForEquipment-CreateDataset-response-Status"></a>
Indicates the status of the `CreateDataset` operation.   
Type: String  
Valid Values: `CREATED | INGESTION_IN_PROGRESS | ACTIVE | IMPORT_IN_PROGRESS` 

## Errors
<a name="API_CreateDataset_Errors"></a>

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

 ** 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
<a name="API_CreateDataset_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/CreateDataset) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/CreateDataset) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/CreateDataset) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/CreateDataset) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/CreateDataset) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/CreateDataset) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/CreateDataset) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/CreateDataset) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/CreateDataset) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/CreateDataset) 

# CreateInferenceScheduler
<a name="API_CreateInferenceScheduler"></a>

 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
<a name="API_CreateInferenceScheduler_RequestSyntax"></a>

```
{
   "ClientToken": "string",
   "DataDelayOffsetInMinutes": number,
   "DataInputConfiguration": { 
      "InferenceInputNameConfiguration": { 
         "ComponentTimestampDelimiter": "string",
         "TimestampFormat": "string"
      },
      "InputTimeZoneOffset": "string",
      "S3InputConfiguration": { 
         "Bucket": "string",
         "Prefix": "string"
      }
   },
   "DataOutputConfiguration": { 
      "KmsKeyId": "string",
      "S3OutputConfiguration": { 
         "Bucket": "string",
         "Prefix": "string"
      }
   },
   "DataUploadFrequency": "string",
   "InferenceSchedulerName": "string",
   "ModelName": "string",
   "RoleArn": "string",
   "ServerSideKmsKeyId": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_CreateInferenceScheduler_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_CreateInferenceScheduler_RequestSyntax) **   <a name="LookoutForEquipment-CreateInferenceScheduler-request-ClientToken"></a>
 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

 ** [DataDelayOffsetInMinutes](#API_CreateInferenceScheduler_RequestSyntax) **   <a name="LookoutForEquipment-CreateInferenceScheduler-request-DataDelayOffsetInMinutes"></a>
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](https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/understanding-inference-process.html).  
Type: Long  
Valid Range: Minimum value of 0. Maximum value of 60.  
Required: No

 ** [DataInputConfiguration](#API_CreateInferenceScheduler_RequestSyntax) **   <a name="LookoutForEquipment-CreateInferenceScheduler-request-DataInputConfiguration"></a>
Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.   
Type: [InferenceInputConfiguration](API_InferenceInputConfiguration.md) object  
Required: Yes

 ** [DataOutputConfiguration](#API_CreateInferenceScheduler_RequestSyntax) **   <a name="LookoutForEquipment-CreateInferenceScheduler-request-DataOutputConfiguration"></a>
Specifies configuration information for the output results for the inference scheduler, including the S3 location for the output.   
Type: [InferenceOutputConfiguration](API_InferenceOutputConfiguration.md) object  
Required: Yes

 ** [DataUploadFrequency](#API_CreateInferenceScheduler_RequestSyntax) **   <a name="LookoutForEquipment-CreateInferenceScheduler-request-DataUploadFrequency"></a>
 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](https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/understanding-inference-process.html).  
Type: String  
Valid Values: `PT5M | PT10M | PT15M | PT30M | PT1H`   
Required: Yes

 ** [InferenceSchedulerName](#API_CreateInferenceScheduler_RequestSyntax) **   <a name="LookoutForEquipment-CreateInferenceScheduler-request-InferenceSchedulerName"></a>
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](#API_CreateInferenceScheduler_RequestSyntax) **   <a name="LookoutForEquipment-CreateInferenceScheduler-request-ModelName"></a>
The name of the previously trained machine learning model being used to create the inference scheduler.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: Yes

 ** [RoleArn](#API_CreateInferenceScheduler_RequestSyntax) **   <a name="LookoutForEquipment-CreateInferenceScheduler-request-RoleArn"></a>
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](#API_CreateInferenceScheduler_RequestSyntax) **   <a name="LookoutForEquipment-CreateInferenceScheduler-request-ServerSideKmsKeyId"></a>
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](#API_CreateInferenceScheduler_RequestSyntax) **   <a name="LookoutForEquipment-CreateInferenceScheduler-request-Tags"></a>
Any tags associated with the inference scheduler.   
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: No

## Response Syntax
<a name="API_CreateInferenceScheduler_ResponseSyntax"></a>

```
{
   "InferenceSchedulerArn": "string",
   "InferenceSchedulerName": "string",
   "ModelQuality": "string",
   "Status": "string"
}
```

## Response Elements
<a name="API_CreateInferenceScheduler_ResponseElements"></a>

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](#API_CreateInferenceScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-CreateInferenceScheduler-response-InferenceSchedulerArn"></a>
The Amazon Resource Name (ARN) of the inference scheduler 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}:inference-scheduler\/.+` 

 ** [InferenceSchedulerName](#API_CreateInferenceScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-CreateInferenceScheduler-response-InferenceSchedulerName"></a>
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}$` 

 ** [ModelQuality](#API_CreateInferenceScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-CreateInferenceScheduler-response-ModelQuality"></a>
Provides a quality assessment for a model that uses labels. If Lookout for Equipment determines that the model quality is poor based on training metrics, the value is `POOR_QUALITY_DETECTED`. Otherwise, the value is `QUALITY_THRESHOLD_MET`.   
If the model is unlabeled, the model quality can't be assessed and the value of `ModelQuality` is `CANNOT_DETERMINE_QUALITY`. In this situation, you can get a model quality assessment by adding labels to the input dataset and retraining the model.  
For information about using labels with your models, see [Understanding labeling](https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/understanding-labeling.html).  
For information about improving the quality of a model, see [Best practices with Amazon Lookout for Equipment](https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/best-practices.html).  
Type: String  
Valid Values: `QUALITY_THRESHOLD_MET | CANNOT_DETERMINE_QUALITY | POOR_QUALITY_DETECTED` 

 ** [Status](#API_CreateInferenceScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-CreateInferenceScheduler-response-Status"></a>
Indicates the status of the `CreateInferenceScheduler` operation.   
Type: String  
Valid Values: `PENDING | RUNNING | STOPPING | STOPPED` 

## Errors
<a name="API_CreateInferenceScheduler_Errors"></a>

 ** 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.   
HTTP Status Code: 400

## See Also
<a name="API_CreateInferenceScheduler_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/CreateInferenceScheduler) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/CreateInferenceScheduler) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/CreateInferenceScheduler) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/CreateInferenceScheduler) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/CreateInferenceScheduler) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/CreateInferenceScheduler) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/CreateInferenceScheduler) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/CreateInferenceScheduler) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/CreateInferenceScheduler) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/CreateInferenceScheduler) 

# CreateLabel
<a name="API_CreateLabel"></a>

 Creates a label for an event. 

## Request Syntax
<a name="API_CreateLabel_RequestSyntax"></a>

```
{
   "ClientToken": "string",
   "EndTime": number,
   "Equipment": "string",
   "FaultCode": "string",
   "LabelGroupName": "string",
   "Notes": "string",
   "Rating": "string",
   "StartTime": number
}
```

## Request Parameters
<a name="API_CreateLabel_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_CreateLabel_RequestSyntax) **   <a name="LookoutForEquipment-CreateLabel-request-ClientToken"></a>
 A unique identifier for the request to create a label. If you do not set the client request token, Lookout for Equipment generates one.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `\p{ASCII}{1,256}`   
Required: Yes

 ** [EndTime](#API_CreateLabel_RequestSyntax) **   <a name="LookoutForEquipment-CreateLabel-request-EndTime"></a>
 The end time of the labeled event.   
Type: Timestamp  
Required: Yes

 ** [Equipment](#API_CreateLabel_RequestSyntax) **   <a name="LookoutForEquipment-CreateLabel-request-Equipment"></a>
 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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `[\P{M}\p{M}]{1,200}`   
Required: No

 ** [FaultCode](#API_CreateLabel_RequestSyntax) **   <a name="LookoutForEquipment-CreateLabel-request-FaultCode"></a>
 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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[\P{M}\p{M}]{1,100}`   
Required: No

 ** [LabelGroupName](#API_CreateLabel_RequestSyntax) **   <a name="LookoutForEquipment-CreateLabel-request-LabelGroupName"></a>
 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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: Yes

 ** [Notes](#API_CreateLabel_RequestSyntax) **   <a name="LookoutForEquipment-CreateLabel-request-Notes"></a>
 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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2560.  
Pattern: `[\P{M}\p{M}]{1,2560}`   
Required: No

 ** [Rating](#API_CreateLabel_RequestSyntax) **   <a name="LookoutForEquipment-CreateLabel-request-Rating"></a>
 Indicates whether a labeled event represents an anomaly.   
Type: String  
Valid Values: `ANOMALY | NO_ANOMALY | NEUTRAL`   
Required: Yes

 ** [StartTime](#API_CreateLabel_RequestSyntax) **   <a name="LookoutForEquipment-CreateLabel-request-StartTime"></a>
 The start time of the labeled event.   
Type: Timestamp  
Required: Yes

## Response Syntax
<a name="API_CreateLabel_ResponseSyntax"></a>

```
{
   "LabelId": "string"
}
```

## Response Elements
<a name="API_CreateLabel_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [LabelId](#API_CreateLabel_ResponseSyntax) **   <a name="LookoutForEquipment-CreateLabel-response-LabelId"></a>
 The ID of the label that you have created.   
Type: String  
Length Constraints: Maximum length of 32.  
Pattern: `[A-Fa-f0-9]{0,32}` 

## Errors
<a name="API_CreateLabel_Errors"></a>

 ** 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.   
HTTP Status Code: 400

## See Also
<a name="API_CreateLabel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/CreateLabel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/CreateLabel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/CreateLabel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/CreateLabel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/CreateLabel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/CreateLabel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/CreateLabel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/CreateLabel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/CreateLabel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/CreateLabel) 

# CreateLabelGroup
<a name="API_CreateLabelGroup"></a>

 Creates a group of labels. 

## Request Syntax
<a name="API_CreateLabelGroup_RequestSyntax"></a>

```
{
   "ClientToken": "string",
   "FaultCodes": [ "string" ],
   "LabelGroupName": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_CreateLabelGroup_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_CreateLabelGroup_RequestSyntax) **   <a name="LookoutForEquipment-CreateLabelGroup-request-ClientToken"></a>
 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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `\p{ASCII}{1,256}`   
Required: Yes

 ** [FaultCodes](#API_CreateLabelGroup_RequestSyntax) **   <a name="LookoutForEquipment-CreateLabelGroup-request-FaultCodes"></a>
 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.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[\P{M}\p{M}]{1,100}`   
Required: No

 ** [LabelGroupName](#API_CreateLabelGroup_RequestSyntax) **   <a name="LookoutForEquipment-CreateLabelGroup-request-LabelGroupName"></a>
 Names a group of labels.  
Data in this field will be retained for service usage. Follow best practices for the security of your data.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: Yes

 ** [Tags](#API_CreateLabelGroup_RequestSyntax) **   <a name="LookoutForEquipment-CreateLabelGroup-request-Tags"></a>
 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.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: No

## Response Syntax
<a name="API_CreateLabelGroup_ResponseSyntax"></a>

```
{
   "LabelGroupArn": "string",
   "LabelGroupName": "string"
}
```

## Response Elements
<a name="API_CreateLabelGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [LabelGroupArn](#API_CreateLabelGroup_ResponseSyntax) **   <a name="LookoutForEquipment-CreateLabelGroup-response-LabelGroupArn"></a>
 The Amazon Resource Name (ARN) of the label group that you have created.   
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:label-group\/.+` 

 ** [LabelGroupName](#API_CreateLabelGroup_ResponseSyntax) **   <a name="LookoutForEquipment-CreateLabelGroup-response-LabelGroupName"></a>
 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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$` 

## Errors
<a name="API_CreateLabelGroup_Errors"></a>

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

 ** 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
<a name="API_CreateLabelGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/CreateLabelGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/CreateLabelGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/CreateLabelGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/CreateLabelGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/CreateLabelGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/CreateLabelGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/CreateLabelGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/CreateLabelGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/CreateLabelGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/CreateLabelGroup) 

# CreateModel
<a name="API_CreateModel"></a>

Creates a machine learning 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
<a name="API_CreateModel_RequestSyntax"></a>

```
{
   "ClientToken": "string",
   "DataPreProcessingConfiguration": { 
      "TargetSamplingRate": "string"
   },
   "DatasetName": "string",
   "DatasetSchema": { 
      "InlineDataSchema": "string"
   },
   "EvaluationDataEndTime": number,
   "EvaluationDataStartTime": number,
   "LabelsInputConfiguration": { 
      "LabelGroupName": "string",
      "S3InputConfiguration": { 
         "Bucket": "string",
         "Prefix": "string"
      }
   },
   "ModelDiagnosticsOutputConfiguration": { 
      "KmsKeyId": "string",
      "S3OutputConfiguration": { 
         "Bucket": "string",
         "Prefix": "string"
      }
   },
   "ModelName": "string",
   "OffCondition": "string",
   "RoleArn": "string",
   "ServerSideKmsKeyId": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TrainingDataEndTime": number,
   "TrainingDataStartTime": number
}
```

## Request Parameters
<a name="API_CreateModel_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_CreateModel_RequestSyntax) **   <a name="LookoutForEquipment-CreateModel-request-ClientToken"></a>
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

 ** [DataPreProcessingConfiguration](#API_CreateModel_RequestSyntax) **   <a name="LookoutForEquipment-CreateModel-request-DataPreProcessingConfiguration"></a>
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](API_DataPreProcessingConfiguration.md) object  
Required: No

 ** [DatasetName](#API_CreateModel_RequestSyntax) **   <a name="LookoutForEquipment-CreateModel-request-DatasetName"></a>
The name of the dataset for the machine learning 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](#API_CreateModel_RequestSyntax) **   <a name="LookoutForEquipment-CreateModel-request-DatasetSchema"></a>
The data schema for the machine learning model being created.   
Type: [DatasetSchema](API_DatasetSchema.md) object  
Required: No

 ** [EvaluationDataEndTime](#API_CreateModel_RequestSyntax) **   <a name="LookoutForEquipment-CreateModel-request-EvaluationDataEndTime"></a>
 Indicates the time reference in the dataset that should be used to end the subset of evaluation data for the machine learning model.   
Type: Timestamp  
Required: No

 ** [EvaluationDataStartTime](#API_CreateModel_RequestSyntax) **   <a name="LookoutForEquipment-CreateModel-request-EvaluationDataStartTime"></a>
Indicates the time reference in the dataset that should be used to begin the subset of evaluation data for the machine learning model.   
Type: Timestamp  
Required: No

 ** [LabelsInputConfiguration](#API_CreateModel_RequestSyntax) **   <a name="LookoutForEquipment-CreateModel-request-LabelsInputConfiguration"></a>
The input configuration for the labels being used for the machine learning model that's being created.   
Type: [LabelsInputConfiguration](API_LabelsInputConfiguration.md) object  
Required: No

 ** [ModelDiagnosticsOutputConfiguration](#API_CreateModel_RequestSyntax) **   <a name="LookoutForEquipment-CreateModel-request-ModelDiagnosticsOutputConfiguration"></a>
The Amazon S3 location where you want Amazon Lookout for Equipment to save the pointwise model diagnostics. You must also specify the `RoleArn` request parameter.  
Type: [ModelDiagnosticsOutputConfiguration](API_ModelDiagnosticsOutputConfiguration.md) object  
Required: No

 ** [ModelName](#API_CreateModel_RequestSyntax) **   <a name="LookoutForEquipment-CreateModel-request-ModelName"></a>
The name for the machine learning model to be created.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: Yes

 ** [OffCondition](#API_CreateModel_RequestSyntax) **   <a name="LookoutForEquipment-CreateModel-request-OffCondition"></a>
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](#API_CreateModel_RequestSyntax) **   <a name="LookoutForEquipment-CreateModel-request-RoleArn"></a>
 The Amazon Resource Name (ARN) of a role with permission to access the data source being used to create the machine learning model.   
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+`   
Required: No

 ** [ServerSideKmsKeyId](#API_CreateModel_RequestSyntax) **   <a name="LookoutForEquipment-CreateModel-request-ServerSideKmsKeyId"></a>
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](#API_CreateModel_RequestSyntax) **   <a name="LookoutForEquipment-CreateModel-request-Tags"></a>
 Any tags associated with the machine learning model being created.   
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: No

 ** [TrainingDataEndTime](#API_CreateModel_RequestSyntax) **   <a name="LookoutForEquipment-CreateModel-request-TrainingDataEndTime"></a>
Indicates the time reference in the dataset that should be used to end the subset of training data for the machine learning model.   
Type: Timestamp  
Required: No

 ** [TrainingDataStartTime](#API_CreateModel_RequestSyntax) **   <a name="LookoutForEquipment-CreateModel-request-TrainingDataStartTime"></a>
Indicates the time reference in the dataset that should be used to begin the subset of training data for the machine learning model.   
Type: Timestamp  
Required: No

## Response Syntax
<a name="API_CreateModel_ResponseSyntax"></a>

```
{
   "ModelArn": "string",
   "Status": "string"
}
```

## Response Elements
<a name="API_CreateModel_ResponseElements"></a>

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](#API_CreateModel_ResponseSyntax) **   <a name="LookoutForEquipment-CreateModel-response-ModelArn"></a>
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](#API_CreateModel_ResponseSyntax) **   <a name="LookoutForEquipment-CreateModel-response-Status"></a>
Indicates the status of the `CreateModel` operation.   
Type: String  
Valid Values: `IN_PROGRESS | SUCCESS | FAILED | IMPORT_IN_PROGRESS` 

## Errors
<a name="API_CreateModel_Errors"></a>

 ** 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.   
HTTP Status Code: 400

## See Also
<a name="API_CreateModel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/CreateModel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/CreateModel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/CreateModel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/CreateModel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/CreateModel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/CreateModel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/CreateModel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/CreateModel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/CreateModel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/CreateModel) 

# CreateRetrainingScheduler
<a name="API_CreateRetrainingScheduler"></a>

Creates a retraining scheduler on the specified model. 

## Request Syntax
<a name="API_CreateRetrainingScheduler_RequestSyntax"></a>

```
{
   "ClientToken": "string",
   "LookbackWindow": "string",
   "ModelName": "string",
   "PromoteMode": "string",
   "RetrainingFrequency": "string",
   "RetrainingStartDate": number
}
```

## Request Parameters
<a name="API_CreateRetrainingScheduler_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_CreateRetrainingScheduler_RequestSyntax) **   <a name="LookoutForEquipment-CreateRetrainingScheduler-request-ClientToken"></a>
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

 ** [LookbackWindow](#API_CreateRetrainingScheduler_RequestSyntax) **   <a name="LookoutForEquipment-CreateRetrainingScheduler-request-LookbackWindow"></a>
The number of past days of data that will be used for retraining.  
Type: String  
Pattern: `^P180D$|^P360D$|^P540D$|^P720D$`   
Required: Yes

 ** [ModelName](#API_CreateRetrainingScheduler_RequestSyntax) **   <a name="LookoutForEquipment-CreateRetrainingScheduler-request-ModelName"></a>
The name of the model to add the retraining scheduler to.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: Yes

 ** [PromoteMode](#API_CreateRetrainingScheduler_RequestSyntax) **   <a name="LookoutForEquipment-CreateRetrainingScheduler-request-PromoteMode"></a>
Indicates how the service will use new models. In `MANAGED` mode, new models will automatically be used for inference if they have better performance than the current model. In `MANUAL` mode, the new models will not be used [until they are manually activated](https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/versioning-model.html#model-activation).  
Type: String  
Valid Values: `MANAGED | MANUAL`   
Required: No

 ** [RetrainingFrequency](#API_CreateRetrainingScheduler_RequestSyntax) **   <a name="LookoutForEquipment-CreateRetrainingScheduler-request-RetrainingFrequency"></a>
This parameter uses the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) standard to set the frequency at which you want retraining to occur in terms of Years, Months, and/or Days (note: other parameters like Time are not currently supported). The minimum value is 30 days (P30D) and the maximum value is 1 year (P1Y). For example, the following values are valid:  
+ P3M15D – Every 3 months and 15 days
+ P2M – Every 2 months
+ P150D – Every 150 days
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10.  
Pattern: `^P(\dY)?(\d{1,2}M)?(\d{1,3}D)?$`   
Required: Yes

 ** [RetrainingStartDate](#API_CreateRetrainingScheduler_RequestSyntax) **   <a name="LookoutForEquipment-CreateRetrainingScheduler-request-RetrainingStartDate"></a>
The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the nearest UTC day.  
Type: Timestamp  
Required: No

## Response Syntax
<a name="API_CreateRetrainingScheduler_ResponseSyntax"></a>

```
{
   "ModelArn": "string",
   "ModelName": "string",
   "Status": "string"
}
```

## Response Elements
<a name="API_CreateRetrainingScheduler_ResponseElements"></a>

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](#API_CreateRetrainingScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-CreateRetrainingScheduler-response-ModelArn"></a>
The ARN of the model that you added the retraining scheduler to.   
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:model\/.+` 

 ** [ModelName](#API_CreateRetrainingScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-CreateRetrainingScheduler-response-ModelName"></a>
The name of the model that you added the retraining scheduler to.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$` 

 ** [Status](#API_CreateRetrainingScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-CreateRetrainingScheduler-response-Status"></a>
The status of the retraining scheduler.   
Type: String  
Valid Values: `PENDING | RUNNING | STOPPING | STOPPED` 

## Errors
<a name="API_CreateRetrainingScheduler_Errors"></a>

 ** 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.  
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
<a name="API_CreateRetrainingScheduler_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/CreateRetrainingScheduler) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/CreateRetrainingScheduler) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/CreateRetrainingScheduler) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/CreateRetrainingScheduler) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/CreateRetrainingScheduler) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/CreateRetrainingScheduler) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/CreateRetrainingScheduler) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/CreateRetrainingScheduler) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/CreateRetrainingScheduler) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/CreateRetrainingScheduler) 

# DeleteDataset
<a name="API_DeleteDataset"></a>

 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
<a name="API_DeleteDataset_RequestSyntax"></a>

```
{
   "DatasetName": "string"
}
```

## Request Parameters
<a name="API_DeleteDataset_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DatasetName](#API_DeleteDataset_RequestSyntax) **   <a name="LookoutForEquipment-DeleteDataset-request-DatasetName"></a>
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
<a name="API_DeleteDataset_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteDataset_Errors"></a>

 ** 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.  
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
<a name="API_DeleteDataset_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/DeleteDataset) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/DeleteDataset) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/DeleteDataset) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/DeleteDataset) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/DeleteDataset) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/DeleteDataset) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/DeleteDataset) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/DeleteDataset) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/DeleteDataset) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/DeleteDataset) 

# DeleteInferenceScheduler
<a name="API_DeleteInferenceScheduler"></a>

Deletes an inference scheduler that has been set up. Prior inference results will not be deleted.

## Request Syntax
<a name="API_DeleteInferenceScheduler_RequestSyntax"></a>

```
{
   "InferenceSchedulerName": "string"
}
```

## Request Parameters
<a name="API_DeleteInferenceScheduler_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [InferenceSchedulerName](#API_DeleteInferenceScheduler_RequestSyntax) **   <a name="LookoutForEquipment-DeleteInferenceScheduler-request-InferenceSchedulerName"></a>
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
<a name="API_DeleteInferenceScheduler_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteInferenceScheduler_Errors"></a>

 ** 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.  
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
<a name="API_DeleteInferenceScheduler_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/DeleteInferenceScheduler) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/DeleteInferenceScheduler) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/DeleteInferenceScheduler) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/DeleteInferenceScheduler) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/DeleteInferenceScheduler) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/DeleteInferenceScheduler) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/DeleteInferenceScheduler) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/DeleteInferenceScheduler) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/DeleteInferenceScheduler) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/DeleteInferenceScheduler) 

# DeleteLabel
<a name="API_DeleteLabel"></a>

 Deletes a label. 

## Request Syntax
<a name="API_DeleteLabel_RequestSyntax"></a>

```
{
   "LabelGroupName": "string",
   "LabelId": "string"
}
```

## Request Parameters
<a name="API_DeleteLabel_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [LabelGroupName](#API_DeleteLabel_RequestSyntax) **   <a name="LookoutForEquipment-DeleteLabel-request-LabelGroupName"></a>
 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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: Yes

 ** [LabelId](#API_DeleteLabel_RequestSyntax) **   <a name="LookoutForEquipment-DeleteLabel-request-LabelId"></a>
 The ID of the label that you want to delete.   
Type: String  
Length Constraints: Maximum length of 32.  
Pattern: `[A-Fa-f0-9]{0,32}`   
Required: Yes

## Response Elements
<a name="API_DeleteLabel_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteLabel_Errors"></a>

 ** 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.  
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
<a name="API_DeleteLabel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/DeleteLabel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/DeleteLabel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/DeleteLabel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/DeleteLabel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/DeleteLabel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/DeleteLabel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/DeleteLabel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/DeleteLabel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/DeleteLabel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/DeleteLabel) 

# DeleteLabelGroup
<a name="API_DeleteLabelGroup"></a>

 Deletes a group of labels. 

## Request Syntax
<a name="API_DeleteLabelGroup_RequestSyntax"></a>

```
{
   "LabelGroupName": "string"
}
```

## Request Parameters
<a name="API_DeleteLabelGroup_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [LabelGroupName](#API_DeleteLabelGroup_RequestSyntax) **   <a name="LookoutForEquipment-DeleteLabelGroup-request-LabelGroupName"></a>
 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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: Yes

## Response Elements
<a name="API_DeleteLabelGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteLabelGroup_Errors"></a>

 ** 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.  
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
<a name="API_DeleteLabelGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/DeleteLabelGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/DeleteLabelGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/DeleteLabelGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/DeleteLabelGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/DeleteLabelGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/DeleteLabelGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/DeleteLabelGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/DeleteLabelGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/DeleteLabelGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/DeleteLabelGroup) 

# DeleteModel
<a name="API_DeleteModel"></a>

Deletes a machine learning 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
<a name="API_DeleteModel_RequestSyntax"></a>

```
{
   "ModelName": "string"
}
```

## Request Parameters
<a name="API_DeleteModel_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ModelName](#API_DeleteModel_RequestSyntax) **   <a name="LookoutForEquipment-DeleteModel-request-ModelName"></a>
The name of the machine learning 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
<a name="API_DeleteModel_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteModel_Errors"></a>

 ** 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.  
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
<a name="API_DeleteModel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/DeleteModel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/DeleteModel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/DeleteModel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/DeleteModel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/DeleteModel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/DeleteModel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/DeleteModel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/DeleteModel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/DeleteModel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/DeleteModel) 

# DeleteResourcePolicy
<a name="API_DeleteResourcePolicy"></a>

Deletes the resource policy attached to the resource.

## Request Syntax
<a name="API_DeleteResourcePolicy_RequestSyntax"></a>

```
{
   "ResourceArn": "string"
}
```

## Request Parameters
<a name="API_DeleteResourcePolicy_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ResourceArn](#API_DeleteResourcePolicy_RequestSyntax) **   <a name="LookoutForEquipment-DeleteResourcePolicy-request-ResourceArn"></a>
The Amazon Resource Name (ARN) of the resource for which the resource policy should be deleted.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:.+`   
Required: Yes

## Response Elements
<a name="API_DeleteResourcePolicy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteResourcePolicy_Errors"></a>

 ** 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.  
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
<a name="API_DeleteResourcePolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/DeleteResourcePolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/DeleteResourcePolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/DeleteResourcePolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/DeleteResourcePolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/DeleteResourcePolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/DeleteResourcePolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/DeleteResourcePolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/DeleteResourcePolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/DeleteResourcePolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/DeleteResourcePolicy) 

# DeleteRetrainingScheduler
<a name="API_DeleteRetrainingScheduler"></a>

Deletes a retraining scheduler from a model. The retraining scheduler must be in the `STOPPED` status. 

## Request Syntax
<a name="API_DeleteRetrainingScheduler_RequestSyntax"></a>

```
{
   "ModelName": "string"
}
```

## Request Parameters
<a name="API_DeleteRetrainingScheduler_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ModelName](#API_DeleteRetrainingScheduler_RequestSyntax) **   <a name="LookoutForEquipment-DeleteRetrainingScheduler-request-ModelName"></a>
The name of the model whose retraining scheduler you want to delete.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: Yes

## Response Elements
<a name="API_DeleteRetrainingScheduler_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteRetrainingScheduler_Errors"></a>

 ** 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.  
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
<a name="API_DeleteRetrainingScheduler_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/DeleteRetrainingScheduler) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/DeleteRetrainingScheduler) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/DeleteRetrainingScheduler) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/DeleteRetrainingScheduler) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/DeleteRetrainingScheduler) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/DeleteRetrainingScheduler) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/DeleteRetrainingScheduler) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/DeleteRetrainingScheduler) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/DeleteRetrainingScheduler) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/DeleteRetrainingScheduler) 

# DescribeDataIngestionJob
<a name="API_DescribeDataIngestionJob"></a>

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

## Request Syntax
<a name="API_DescribeDataIngestionJob_RequestSyntax"></a>

```
{
   "JobId": "string"
}
```

## Request Parameters
<a name="API_DescribeDataIngestionJob_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [JobId](#API_DescribeDataIngestionJob_RequestSyntax) **   <a name="LookoutForEquipment-DescribeDataIngestionJob-request-JobId"></a>
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
<a name="API_DescribeDataIngestionJob_ResponseSyntax"></a>

```
{
   "CreatedAt": number,
   "DataEndTime": number,
   "DataQualitySummary": { 
      "DuplicateTimestamps": { 
         "TotalNumberOfDuplicateTimestamps": number
      },
      "InsufficientSensorData": { 
         "MissingCompleteSensorData": { 
            "AffectedSensorCount": number
         },
         "SensorsWithShortDateRange": { 
            "AffectedSensorCount": number
         }
      },
      "InvalidSensorData": { 
         "AffectedSensorCount": number,
         "TotalNumberOfInvalidValues": number
      },
      "MissingSensorData": { 
         "AffectedSensorCount": number,
         "TotalNumberOfMissingValues": number
      },
      "UnsupportedTimestamps": { 
         "TotalNumberOfUnsupportedTimestamps": number
      }
   },
   "DatasetArn": "string",
   "DataStartTime": number,
   "FailedReason": "string",
   "IngestedDataSize": number,
   "IngestedFilesSummary": { 
      "DiscardedFiles": [ 
         { 
            "Bucket": "string",
            "Key": "string"
         }
      ],
      "IngestedNumberOfFiles": number,
      "TotalNumberOfFiles": number
   },
   "IngestionInputConfiguration": { 
      "S3InputConfiguration": { 
         "Bucket": "string",
         "KeyPattern": "string",
         "Prefix": "string"
      }
   },
   "JobId": "string",
   "RoleArn": "string",
   "SourceDatasetArn": "string",
   "Status": "string",
   "StatusDetail": "string"
}
```

## Response Elements
<a name="API_DescribeDataIngestionJob_ResponseElements"></a>

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](#API_DescribeDataIngestionJob_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeDataIngestionJob-response-CreatedAt"></a>
The time at which the data ingestion job was created.   
Type: Timestamp

 ** [DataEndTime](#API_DescribeDataIngestionJob_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeDataIngestionJob-response-DataEndTime"></a>
 Indicates the latest timestamp corresponding to data that was successfully ingested during this specific ingestion job.   
Type: Timestamp

 ** [DataQualitySummary](#API_DescribeDataIngestionJob_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeDataIngestionJob-response-DataQualitySummary"></a>
 Gives statistics about a completed ingestion job. These statistics primarily relate to quantifying incorrect data such as MissingCompleteSensorData, MissingSensorData, UnsupportedDateFormats, InsufficientSensorData, and DuplicateTimeStamps.   
Type: [DataQualitySummary](API_DataQualitySummary.md) object

 ** [DatasetArn](#API_DescribeDataIngestionJob_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeDataIngestionJob-response-DatasetArn"></a>
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\/[0-9a-zA-Z_-]{1,200}\/.+` 

 ** [DataStartTime](#API_DescribeDataIngestionJob_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeDataIngestionJob-response-DataStartTime"></a>
 Indicates the earliest timestamp corresponding to data that was successfully ingested during this specific ingestion job.   
Type: Timestamp

 ** [FailedReason](#API_DescribeDataIngestionJob_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeDataIngestionJob-response-FailedReason"></a>
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}` 

 ** [IngestedDataSize](#API_DescribeDataIngestionJob_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeDataIngestionJob-response-IngestedDataSize"></a>
 Indicates the size of the ingested dataset.   
Type: Long  
Valid Range: Minimum value of 0.

 ** [IngestedFilesSummary](#API_DescribeDataIngestionJob_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeDataIngestionJob-response-IngestedFilesSummary"></a>
Gives statistics about how many files have been ingested, and which files have not been ingested, for a particular ingestion job.  
Type: [IngestedFilesSummary](API_IngestedFilesSummary.md) object

 ** [IngestionInputConfiguration](#API_DescribeDataIngestionJob_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeDataIngestionJob-response-IngestionInputConfiguration"></a>
Specifies the S3 location configuration for the data input for the data ingestion job.   
Type: [IngestionInputConfiguration](API_IngestionInputConfiguration.md) object

 ** [JobId](#API_DescribeDataIngestionJob_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeDataIngestionJob-response-JobId"></a>
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](#API_DescribeDataIngestionJob_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeDataIngestionJob-response-RoleArn"></a>
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/.+` 

 ** [SourceDatasetArn](#API_DescribeDataIngestionJob_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeDataIngestionJob-response-SourceDatasetArn"></a>
The Amazon Resource Name (ARN) of the source dataset from which the data used for the data ingestion job was imported from.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:dataset\/[0-9a-zA-Z_-]{1,200}\/.+` 

 ** [Status](#API_DescribeDataIngestionJob_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeDataIngestionJob-response-Status"></a>
Indicates the status of the `DataIngestionJob` operation.   
Type: String  
Valid Values: `IN_PROGRESS | SUCCESS | FAILED | IMPORT_IN_PROGRESS` 

 ** [StatusDetail](#API_DescribeDataIngestionJob_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeDataIngestionJob-response-StatusDetail"></a>
 Provides details about status of the ingestion job that is currently in progress.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 5000.  
Pattern: `[\P{M}\p{M}]{1,5000}` 

## Errors
<a name="API_DescribeDataIngestionJob_Errors"></a>

 ** AccessDeniedException **   
The request could not be completed because you do not have access to the 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.  
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
<a name="API_DescribeDataIngestionJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/DescribeDataIngestionJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/DescribeDataIngestionJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/DescribeDataIngestionJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/DescribeDataIngestionJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/DescribeDataIngestionJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/DescribeDataIngestionJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/DescribeDataIngestionJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/DescribeDataIngestionJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/DescribeDataIngestionJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/DescribeDataIngestionJob) 

# DescribeDataset
<a name="API_DescribeDataset"></a>

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

## Request Syntax
<a name="API_DescribeDataset_RequestSyntax"></a>

```
{
   "DatasetName": "string"
}
```

## Request Parameters
<a name="API_DescribeDataset_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DatasetName](#API_DescribeDataset_RequestSyntax) **   <a name="LookoutForEquipment-DescribeDataset-request-DatasetName"></a>
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
<a name="API_DescribeDataset_ResponseSyntax"></a>

```
{
   "CreatedAt": number,
   "DataEndTime": number,
   "DataQualitySummary": { 
      "DuplicateTimestamps": { 
         "TotalNumberOfDuplicateTimestamps": number
      },
      "InsufficientSensorData": { 
         "MissingCompleteSensorData": { 
            "AffectedSensorCount": number
         },
         "SensorsWithShortDateRange": { 
            "AffectedSensorCount": number
         }
      },
      "InvalidSensorData": { 
         "AffectedSensorCount": number,
         "TotalNumberOfInvalidValues": number
      },
      "MissingSensorData": { 
         "AffectedSensorCount": number,
         "TotalNumberOfMissingValues": number
      },
      "UnsupportedTimestamps": { 
         "TotalNumberOfUnsupportedTimestamps": number
      }
   },
   "DatasetArn": "string",
   "DatasetName": "string",
   "DataStartTime": number,
   "IngestedFilesSummary": { 
      "DiscardedFiles": [ 
         { 
            "Bucket": "string",
            "Key": "string"
         }
      ],
      "IngestedNumberOfFiles": number,
      "TotalNumberOfFiles": number
   },
   "IngestionInputConfiguration": { 
      "S3InputConfiguration": { 
         "Bucket": "string",
         "KeyPattern": "string",
         "Prefix": "string"
      }
   },
   "LastUpdatedAt": number,
   "RoleArn": "string",
   "Schema": "string",
   "ServerSideKmsKeyId": "string",
   "SourceDatasetArn": "string",
   "Status": "string"
}
```

## Response Elements
<a name="API_DescribeDataset_ResponseElements"></a>

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](#API_DescribeDataset_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeDataset-response-CreatedAt"></a>
Specifies the time the dataset was created in Lookout for Equipment.   
Type: Timestamp

 ** [DataEndTime](#API_DescribeDataset_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeDataset-response-DataEndTime"></a>
 Indicates the latest timestamp corresponding to data that was successfully ingested during the most recent ingestion of this particular dataset.   
Type: Timestamp

 ** [DataQualitySummary](#API_DescribeDataset_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeDataset-response-DataQualitySummary"></a>
 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.   
Type: [DataQualitySummary](API_DataQualitySummary.md) object

 ** [DatasetArn](#API_DescribeDataset_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeDataset-response-DatasetArn"></a>
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\/[0-9a-zA-Z_-]{1,200}\/.+` 

 ** [DatasetName](#API_DescribeDataset_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeDataset-response-DatasetName"></a>
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}$` 

 ** [DataStartTime](#API_DescribeDataset_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeDataset-response-DataStartTime"></a>
 Indicates the earliest timestamp corresponding to data that was successfully ingested during the most recent ingestion of this particular dataset.   
Type: Timestamp

 ** [IngestedFilesSummary](#API_DescribeDataset_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeDataset-response-IngestedFilesSummary"></a>
IngestedFilesSummary associated with the given dataset for the latest successful associated ingestion job id.   
Type: [IngestedFilesSummary](API_IngestedFilesSummary.md) object

 ** [IngestionInputConfiguration](#API_DescribeDataset_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeDataset-response-IngestionInputConfiguration"></a>
Specifies the S3 location configuration for the data input for the data ingestion job.   
Type: [IngestionInputConfiguration](API_IngestionInputConfiguration.md) object

 ** [LastUpdatedAt](#API_DescribeDataset_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeDataset-response-LastUpdatedAt"></a>
Specifies the time the dataset was last updated, if it was.   
Type: Timestamp

 ** [RoleArn](#API_DescribeDataset_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeDataset-response-RoleArn"></a>
 The Amazon Resource Name (ARN) of the IAM role that you are using for this the data ingestion job.   
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+` 

 ** [Schema](#API_DescribeDataset_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeDataset-response-Schema"></a>
A JSON description of the data that is in each time series dataset, including names, column names, and data types.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000000.

 ** [ServerSideKmsKeyId](#API_DescribeDataset_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeDataset-response-ServerSideKmsKeyId"></a>
Provides the identifier of the AWS KMS key used to encrypt dataset data by Amazon Lookout for Equipment.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `arn:aws[a-z\-]*:kms:[a-z0-9\-]*:\d{12}:[\w\-\/]+` 

 ** [SourceDatasetArn](#API_DescribeDataset_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeDataset-response-SourceDatasetArn"></a>
The Amazon Resource Name (ARN) of the source dataset from which the current data being described was imported from.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:dataset\/[0-9a-zA-Z_-]{1,200}\/.+` 

 ** [Status](#API_DescribeDataset_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeDataset-response-Status"></a>
Indicates the status of the dataset.   
Type: String  
Valid Values: `CREATED | INGESTION_IN_PROGRESS | ACTIVE | IMPORT_IN_PROGRESS` 

## Errors
<a name="API_DescribeDataset_Errors"></a>

 ** AccessDeniedException **   
The request could not be completed because you do not have access to the 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.  
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
<a name="API_DescribeDataset_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/DescribeDataset) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/DescribeDataset) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/DescribeDataset) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/DescribeDataset) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/DescribeDataset) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/DescribeDataset) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/DescribeDataset) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/DescribeDataset) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/DescribeDataset) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/DescribeDataset) 

# DescribeInferenceScheduler
<a name="API_DescribeInferenceScheduler"></a>

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

## Request Syntax
<a name="API_DescribeInferenceScheduler_RequestSyntax"></a>

```
{
   "InferenceSchedulerName": "string"
}
```

## Request Parameters
<a name="API_DescribeInferenceScheduler_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [InferenceSchedulerName](#API_DescribeInferenceScheduler_RequestSyntax) **   <a name="LookoutForEquipment-DescribeInferenceScheduler-request-InferenceSchedulerName"></a>
The name of the inference scheduler being described.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: Yes

## Response Syntax
<a name="API_DescribeInferenceScheduler_ResponseSyntax"></a>

```
{
   "CreatedAt": number,
   "DataDelayOffsetInMinutes": number,
   "DataInputConfiguration": { 
      "InferenceInputNameConfiguration": { 
         "ComponentTimestampDelimiter": "string",
         "TimestampFormat": "string"
      },
      "InputTimeZoneOffset": "string",
      "S3InputConfiguration": { 
         "Bucket": "string",
         "Prefix": "string"
      }
   },
   "DataOutputConfiguration": { 
      "KmsKeyId": "string",
      "S3OutputConfiguration": { 
         "Bucket": "string",
         "Prefix": "string"
      }
   },
   "DataUploadFrequency": "string",
   "InferenceSchedulerArn": "string",
   "InferenceSchedulerName": "string",
   "LatestInferenceResult": "string",
   "ModelArn": "string",
   "ModelName": "string",
   "RoleArn": "string",
   "ServerSideKmsKeyId": "string",
   "Status": "string",
   "UpdatedAt": number
}
```

## Response Elements
<a name="API_DescribeInferenceScheduler_ResponseElements"></a>

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](#API_DescribeInferenceScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeInferenceScheduler-response-CreatedAt"></a>
Specifies the time at which the inference scheduler was created.   
Type: Timestamp

 ** [DataDelayOffsetInMinutes](#API_DescribeInferenceScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeInferenceScheduler-response-DataDelayOffsetInMinutes"></a>
 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.

 ** [DataInputConfiguration](#API_DescribeInferenceScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeInferenceScheduler-response-DataInputConfiguration"></a>
 Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.   
Type: [InferenceInputConfiguration](API_InferenceInputConfiguration.md) object

 ** [DataOutputConfiguration](#API_DescribeInferenceScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeInferenceScheduler-response-DataOutputConfiguration"></a>
 Specifies information for the output results for the inference scheduler, including the output S3 location.   
Type: [InferenceOutputConfiguration](API_InferenceOutputConfiguration.md) object

 ** [DataUploadFrequency](#API_DescribeInferenceScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeInferenceScheduler-response-DataUploadFrequency"></a>
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.   
Type: String  
Valid Values: `PT5M | PT10M | PT15M | PT30M | PT1H` 

 ** [InferenceSchedulerArn](#API_DescribeInferenceScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeInferenceScheduler-response-InferenceSchedulerArn"></a>
The Amazon Resource Name (ARN) of the inference scheduler 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}:inference-scheduler\/.+` 

 ** [InferenceSchedulerName](#API_DescribeInferenceScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeInferenceScheduler-response-InferenceSchedulerName"></a>
The name of the inference scheduler being described.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$` 

 ** [LatestInferenceResult](#API_DescribeInferenceScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeInferenceScheduler-response-LatestInferenceResult"></a>
Indicates whether the latest execution for the inference scheduler was Anomalous (anomalous events found) or Normal (no anomalous events found).  
Type: String  
Valid Values: `ANOMALOUS | NORMAL` 

 ** [ModelArn](#API_DescribeInferenceScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeInferenceScheduler-response-ModelArn"></a>
The Amazon Resource Name (ARN) of the machine learning model of the inference scheduler 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}:model\/.+` 

 ** [ModelName](#API_DescribeInferenceScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeInferenceScheduler-response-ModelName"></a>
The name of the machine learning model of the inference scheduler being described.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$` 

 ** [RoleArn](#API_DescribeInferenceScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeInferenceScheduler-response-RoleArn"></a>
 The Amazon Resource Name (ARN) of a role with permission to access the data source for the inference scheduler being described.   
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+` 

 ** [ServerSideKmsKeyId](#API_DescribeInferenceScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeInferenceScheduler-response-ServerSideKmsKeyId"></a>
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 1024.  
Pattern: `arn:aws[a-z\-]*:kms:[a-z0-9\-]*:\d{12}:[\w\-\/]+` 

 ** [Status](#API_DescribeInferenceScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeInferenceScheduler-response-Status"></a>
Indicates the status of the inference scheduler.   
Type: String  
Valid Values: `PENDING | RUNNING | STOPPING | STOPPED` 

 ** [UpdatedAt](#API_DescribeInferenceScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeInferenceScheduler-response-UpdatedAt"></a>
Specifies the time at which the inference scheduler was last updated, if it was.   
Type: Timestamp

## Errors
<a name="API_DescribeInferenceScheduler_Errors"></a>

 ** AccessDeniedException **   
The request could not be completed because you do not have access to the 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.  
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
<a name="API_DescribeInferenceScheduler_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/DescribeInferenceScheduler) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/DescribeInferenceScheduler) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/DescribeInferenceScheduler) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/DescribeInferenceScheduler) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/DescribeInferenceScheduler) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/DescribeInferenceScheduler) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/DescribeInferenceScheduler) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/DescribeInferenceScheduler) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/DescribeInferenceScheduler) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/DescribeInferenceScheduler) 

# DescribeLabel
<a name="API_DescribeLabel"></a>

 Returns the name of the label. 

## Request Syntax
<a name="API_DescribeLabel_RequestSyntax"></a>

```
{
   "LabelGroupName": "string",
   "LabelId": "string"
}
```

## Request Parameters
<a name="API_DescribeLabel_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [LabelGroupName](#API_DescribeLabel_RequestSyntax) **   <a name="LookoutForEquipment-DescribeLabel-request-LabelGroupName"></a>
 Returns the name of the group containing the label.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: Yes

 ** [LabelId](#API_DescribeLabel_RequestSyntax) **   <a name="LookoutForEquipment-DescribeLabel-request-LabelId"></a>
 Returns the ID of the label.   
Type: String  
Length Constraints: Maximum length of 32.  
Pattern: `[A-Fa-f0-9]{0,32}`   
Required: Yes

## Response Syntax
<a name="API_DescribeLabel_ResponseSyntax"></a>

```
{
   "CreatedAt": number,
   "EndTime": number,
   "Equipment": "string",
   "FaultCode": "string",
   "LabelGroupArn": "string",
   "LabelGroupName": "string",
   "LabelId": "string",
   "Notes": "string",
   "Rating": "string",
   "StartTime": number
}
```

## Response Elements
<a name="API_DescribeLabel_ResponseElements"></a>

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](#API_DescribeLabel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeLabel-response-CreatedAt"></a>
 The time at which the label was created.   
Type: Timestamp

 ** [EndTime](#API_DescribeLabel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeLabel-response-EndTime"></a>
 The end time of the requested label.   
Type: Timestamp

 ** [Equipment](#API_DescribeLabel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeLabel-response-Equipment"></a>
 Indicates that a label pertains to a particular piece of equipment.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `[\P{M}\p{M}]{1,200}` 

 ** [FaultCode](#API_DescribeLabel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeLabel-response-FaultCode"></a>
 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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[\P{M}\p{M}]{1,100}` 

 ** [LabelGroupArn](#API_DescribeLabel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeLabel-response-LabelGroupArn"></a>
 The Amazon Resource Name (ARN) of the requested label group.   
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:label-group\/.+` 

 ** [LabelGroupName](#API_DescribeLabel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeLabel-response-LabelGroupName"></a>
 The name of the requested label group.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$` 

 ** [LabelId](#API_DescribeLabel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeLabel-response-LabelId"></a>
 The ID of the requested label.   
Type: String  
Length Constraints: Maximum length of 32.  
Pattern: `[A-Fa-f0-9]{0,32}` 

 ** [Notes](#API_DescribeLabel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeLabel-response-Notes"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2560.  
Pattern: `[\P{M}\p{M}]{1,2560}` 

 ** [Rating](#API_DescribeLabel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeLabel-response-Rating"></a>
 Indicates whether a labeled event represents an anomaly.   
Type: String  
Valid Values: `ANOMALY | NO_ANOMALY | NEUTRAL` 

 ** [StartTime](#API_DescribeLabel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeLabel-response-StartTime"></a>
 The start time of the requested label.   
Type: Timestamp

## Errors
<a name="API_DescribeLabel_Errors"></a>

 ** AccessDeniedException **   
The request could not be completed because you do not have access to the 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.  
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
<a name="API_DescribeLabel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/DescribeLabel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/DescribeLabel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/DescribeLabel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/DescribeLabel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/DescribeLabel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/DescribeLabel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/DescribeLabel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/DescribeLabel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/DescribeLabel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/DescribeLabel) 

# DescribeLabelGroup
<a name="API_DescribeLabelGroup"></a>

 Returns information about the label group. 

## Request Syntax
<a name="API_DescribeLabelGroup_RequestSyntax"></a>

```
{
   "LabelGroupName": "string"
}
```

## Request Parameters
<a name="API_DescribeLabelGroup_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [LabelGroupName](#API_DescribeLabelGroup_RequestSyntax) **   <a name="LookoutForEquipment-DescribeLabelGroup-request-LabelGroupName"></a>
 Returns the name of the label group.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: Yes

## Response Syntax
<a name="API_DescribeLabelGroup_ResponseSyntax"></a>

```
{
   "CreatedAt": number,
   "FaultCodes": [ "string" ],
   "LabelGroupArn": "string",
   "LabelGroupName": "string",
   "UpdatedAt": number
}
```

## Response Elements
<a name="API_DescribeLabelGroup_ResponseElements"></a>

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](#API_DescribeLabelGroup_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeLabelGroup-response-CreatedAt"></a>
 The time at which the label group was created.   
Type: Timestamp

 ** [FaultCodes](#API_DescribeLabelGroup_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeLabelGroup-response-FaultCodes"></a>
 Codes indicating the type of anomaly associated with the labels in the lagbel group.   
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[\P{M}\p{M}]{1,100}` 

 ** [LabelGroupArn](#API_DescribeLabelGroup_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeLabelGroup-response-LabelGroupArn"></a>
 The Amazon Resource Name (ARN) of the label group.   
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:label-group\/.+` 

 ** [LabelGroupName](#API_DescribeLabelGroup_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeLabelGroup-response-LabelGroupName"></a>
 The name of the label group.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$` 

 ** [UpdatedAt](#API_DescribeLabelGroup_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeLabelGroup-response-UpdatedAt"></a>
 The time at which the label group was updated.   
Type: Timestamp

## Errors
<a name="API_DescribeLabelGroup_Errors"></a>

 ** AccessDeniedException **   
The request could not be completed because you do not have access to the 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.  
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
<a name="API_DescribeLabelGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/DescribeLabelGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/DescribeLabelGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/DescribeLabelGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/DescribeLabelGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/DescribeLabelGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/DescribeLabelGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/DescribeLabelGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/DescribeLabelGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/DescribeLabelGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/DescribeLabelGroup) 

# DescribeModel
<a name="API_DescribeModel"></a>

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

## Request Syntax
<a name="API_DescribeModel_RequestSyntax"></a>

```
{
   "ModelName": "string"
}
```

## Request Parameters
<a name="API_DescribeModel_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ModelName](#API_DescribeModel_RequestSyntax) **   <a name="LookoutForEquipment-DescribeModel-request-ModelName"></a>
The name of the machine learning model 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
<a name="API_DescribeModel_ResponseSyntax"></a>

```
{
   "AccumulatedInferenceDataEndTime": number,
   "AccumulatedInferenceDataStartTime": number,
   "ActiveModelVersion": number,
   "ActiveModelVersionArn": "string",
   "CreatedAt": number,
   "DataPreProcessingConfiguration": { 
      "TargetSamplingRate": "string"
   },
   "DatasetArn": "string",
   "DatasetName": "string",
   "EvaluationDataEndTime": number,
   "EvaluationDataStartTime": number,
   "FailedReason": "string",
   "ImportJobEndTime": number,
   "ImportJobStartTime": number,
   "LabelsInputConfiguration": { 
      "LabelGroupName": "string",
      "S3InputConfiguration": { 
         "Bucket": "string",
         "Prefix": "string"
      }
   },
   "LastUpdatedTime": number,
   "LatestScheduledRetrainingAvailableDataInDays": number,
   "LatestScheduledRetrainingFailedReason": "string",
   "LatestScheduledRetrainingModelVersion": number,
   "LatestScheduledRetrainingStartTime": number,
   "LatestScheduledRetrainingStatus": "string",
   "ModelArn": "string",
   "ModelDiagnosticsOutputConfiguration": { 
      "KmsKeyId": "string",
      "S3OutputConfiguration": { 
         "Bucket": "string",
         "Prefix": "string"
      }
   },
   "ModelMetrics": "string",
   "ModelName": "string",
   "ModelQuality": "string",
   "ModelVersionActivatedAt": number,
   "NextScheduledRetrainingStartDate": number,
   "OffCondition": "string",
   "PreviousActiveModelVersion": number,
   "PreviousActiveModelVersionArn": "string",
   "PreviousModelVersionActivatedAt": number,
   "PriorModelMetrics": "string",
   "RetrainingSchedulerStatus": "string",
   "RoleArn": "string",
   "Schema": "string",
   "ServerSideKmsKeyId": "string",
   "SourceModelVersionArn": "string",
   "Status": "string",
   "TrainingDataEndTime": number,
   "TrainingDataStartTime": number,
   "TrainingExecutionEndTime": number,
   "TrainingExecutionStartTime": number
}
```

## Response Elements
<a name="API_DescribeModel_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AccumulatedInferenceDataEndTime](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-AccumulatedInferenceDataEndTime"></a>
Indicates the end time of the inference data that has been accumulated.   
Type: Timestamp

 ** [AccumulatedInferenceDataStartTime](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-AccumulatedInferenceDataStartTime"></a>
Indicates the start time of the inference data that has been accumulated.   
Type: Timestamp

 ** [ActiveModelVersion](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-ActiveModelVersion"></a>
The name of the model version used by the inference schedular when running a scheduled inference execution.  
Type: Long  
Valid Range: Minimum value of 1.

 ** [ActiveModelVersionArn](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-ActiveModelVersionArn"></a>
The Amazon Resource Name (ARN) of the model version used by the inference scheduler when running a scheduled inference execution.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:model\/[0-9a-zA-Z_-]{1,200}\/.+\/model-version\/[0-9]{1,}$` 

 ** [CreatedAt](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-CreatedAt"></a>
Indicates the time and date at which the machine learning model was created.   
Type: Timestamp

 ** [DataPreProcessingConfiguration](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-DataPreProcessingConfiguration"></a>
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](API_DataPreProcessingConfiguration.md) object

 ** [DatasetArn](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-DatasetArn"></a>
The Amazon Resouce Name (ARN) of the dataset used to create the machine learning model 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\/[0-9a-zA-Z_-]{1,200}\/.+` 

 ** [DatasetName](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-DatasetName"></a>
The name of the dataset being used by the machine learning being described.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$` 

 ** [EvaluationDataEndTime](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-EvaluationDataEndTime"></a>
 Indicates the time reference in the dataset that was used to end the subset of evaluation data for the machine learning model.   
Type: Timestamp

 ** [EvaluationDataStartTime](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-EvaluationDataStartTime"></a>
 Indicates the time reference in the dataset that was used to begin the subset of evaluation data for the machine learning model.   
Type: Timestamp

 ** [FailedReason](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-FailedReason"></a>
If the training of the machine learning model failed, this indicates the reason for that failure.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 5000.  
Pattern: `[\P{M}\p{M}]{1,5000}` 

 ** [ImportJobEndTime](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-ImportJobEndTime"></a>
The date and time when the import job was completed. This field appears if the active model version was imported.  
Type: Timestamp

 ** [ImportJobStartTime](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-ImportJobStartTime"></a>
The date and time when the import job was started. This field appears if the active model version was imported.  
Type: Timestamp

 ** [LabelsInputConfiguration](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-LabelsInputConfiguration"></a>
Specifies configuration information about the labels input, including its S3 location.   
Type: [LabelsInputConfiguration](API_LabelsInputConfiguration.md) object

 ** [LastUpdatedTime](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-LastUpdatedTime"></a>
Indicates the last time the machine learning model was updated. The type of update is not specified.   
Type: Timestamp

 ** [LatestScheduledRetrainingAvailableDataInDays](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-LatestScheduledRetrainingAvailableDataInDays"></a>
Indicates the number of days of data used in the most recent scheduled retraining run.   
Type: Integer

 ** [LatestScheduledRetrainingFailedReason](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-LatestScheduledRetrainingFailedReason"></a>
If the model version was generated by retraining and the training failed, this indicates the reason for that failure.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 5000.  
Pattern: `[\P{M}\p{M}]{1,5000}` 

 ** [LatestScheduledRetrainingModelVersion](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-LatestScheduledRetrainingModelVersion"></a>
Indicates the most recent model version that was generated by retraining.   
Type: Long  
Valid Range: Minimum value of 1.

 ** [LatestScheduledRetrainingStartTime](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-LatestScheduledRetrainingStartTime"></a>
Indicates the start time of the most recent scheduled retraining run.   
Type: Timestamp

 ** [LatestScheduledRetrainingStatus](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-LatestScheduledRetrainingStatus"></a>
Indicates the status of the most recent scheduled retraining run.   
Type: String  
Valid Values: `IN_PROGRESS | SUCCESS | FAILED | IMPORT_IN_PROGRESS | CANCELED` 

 ** [ModelArn](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-ModelArn"></a>
The Amazon Resource Name (ARN) of the machine learning model 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}:model\/.+` 

 ** [ModelDiagnosticsOutputConfiguration](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-ModelDiagnosticsOutputConfiguration"></a>
Configuration information for the model's pointwise model diagnostics.  
Type: [ModelDiagnosticsOutputConfiguration](API_ModelDiagnosticsOutputConfiguration.md) object

 ** [ModelMetrics](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-ModelMetrics"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50000.

 ** [ModelName](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-ModelName"></a>
The name of the machine learning model being described.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$` 

 ** [ModelQuality](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-ModelQuality"></a>
Provides a quality assessment for a model that uses labels. If Lookout for Equipment determines that the model quality is poor based on training metrics, the value is `POOR_QUALITY_DETECTED`. Otherwise, the value is `QUALITY_THRESHOLD_MET`.  
If the model is unlabeled, the model quality can't be assessed and the value of `ModelQuality` is `CANNOT_DETERMINE_QUALITY`. In this situation, you can get a model quality assessment by adding labels to the input dataset and retraining the model.  
For information about using labels with your models, see [Understanding labeling](https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/understanding-labeling.html).  
For information about improving the quality of a model, see [Best practices with Amazon Lookout for Equipment](https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/best-practices.html).  
Type: String  
Valid Values: `QUALITY_THRESHOLD_MET | CANNOT_DETERMINE_QUALITY | POOR_QUALITY_DETECTED` 

 ** [ModelVersionActivatedAt](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-ModelVersionActivatedAt"></a>
The date the active model version was activated.  
Type: Timestamp

 ** [NextScheduledRetrainingStartDate](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-NextScheduledRetrainingStartDate"></a>
Indicates the date and time that the next scheduled retraining run will start on. Lookout for Equipment truncates the time you provide to the nearest UTC day.  
Type: Timestamp

 ** [OffCondition](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-OffCondition"></a>
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.

 ** [PreviousActiveModelVersion](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-PreviousActiveModelVersion"></a>
The model version that was set as the active model version prior to the current active model version.  
Type: Long  
Valid Range: Minimum value of 1.

 ** [PreviousActiveModelVersionArn](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-PreviousActiveModelVersionArn"></a>
The ARN of the model version that was set as the active model version prior to the current active model version.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:model\/[0-9a-zA-Z_-]{1,200}\/.+\/model-version\/[0-9]{1,}$` 

 ** [PreviousModelVersionActivatedAt](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-PreviousModelVersionActivatedAt"></a>
The date and time when the previous active model version was activated.  
Type: Timestamp

 ** [PriorModelMetrics](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-PriorModelMetrics"></a>
If the model version was retrained, this field shows a summary of the performance of the prior model on the new training range. You can use the information in this JSON-formatted object to compare the new model version and the prior model version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50000.

 ** [RetrainingSchedulerStatus](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-RetrainingSchedulerStatus"></a>
Indicates the status of the retraining scheduler.   
Type: String  
Valid Values: `PENDING | RUNNING | STOPPING | STOPPED` 

 ** [RoleArn](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-RoleArn"></a>
 The Amazon Resource Name (ARN) of a role with permission to access the data source for the machine learning model being described.   
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+` 

 ** [Schema](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-Schema"></a>
A JSON description of the data that is in each time series dataset, including names, column names, and data types.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000000.

 ** [ServerSideKmsKeyId](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-ServerSideKmsKeyId"></a>
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 1024.  
Pattern: `arn:aws[a-z\-]*:kms:[a-z0-9\-]*:\d{12}:[\w\-\/]+` 

 ** [SourceModelVersionArn](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-SourceModelVersionArn"></a>
The Amazon Resource Name (ARN) of the source model version. This field appears if the active model version was imported.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:model\/[0-9a-zA-Z_-]{1,200}\/.+\/model-version\/[0-9]{1,}$` 

 ** [Status](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-Status"></a>
Specifies the current status of the model being described. Status describes the status of the most recent action of the model.   
Type: String  
Valid Values: `IN_PROGRESS | SUCCESS | FAILED | IMPORT_IN_PROGRESS` 

 ** [TrainingDataEndTime](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-TrainingDataEndTime"></a>
 Indicates the time reference in the dataset that was used to end the subset of training data for the machine learning model.   
Type: Timestamp

 ** [TrainingDataStartTime](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-TrainingDataStartTime"></a>
 Indicates the time reference in the dataset that was used to begin the subset of training data for the machine learning model.   
Type: Timestamp

 ** [TrainingExecutionEndTime](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-TrainingExecutionEndTime"></a>
Indicates the time at which the training of the machine learning model was completed.   
Type: Timestamp

 ** [TrainingExecutionStartTime](#API_DescribeModel_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModel-response-TrainingExecutionStartTime"></a>
Indicates the time at which the training of the machine learning model began.   
Type: Timestamp

## Errors
<a name="API_DescribeModel_Errors"></a>

 ** AccessDeniedException **   
The request could not be completed because you do not have access to the 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.  
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
<a name="API_DescribeModel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/DescribeModel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/DescribeModel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/DescribeModel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/DescribeModel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/DescribeModel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/DescribeModel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/DescribeModel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/DescribeModel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/DescribeModel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/DescribeModel) 

# DescribeModelVersion
<a name="API_DescribeModelVersion"></a>

Retrieves information about a specific machine learning model version.

## Request Syntax
<a name="API_DescribeModelVersion_RequestSyntax"></a>

```
{
   "ModelName": "string",
   "ModelVersion": number
}
```

## Request Parameters
<a name="API_DescribeModelVersion_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ModelName](#API_DescribeModelVersion_RequestSyntax) **   <a name="LookoutForEquipment-DescribeModelVersion-request-ModelName"></a>
The name of the machine learning model that this version belongs to.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: Yes

 ** [ModelVersion](#API_DescribeModelVersion_RequestSyntax) **   <a name="LookoutForEquipment-DescribeModelVersion-request-ModelVersion"></a>
The version of the machine learning model.  
Type: Long  
Valid Range: Minimum value of 1.  
Required: Yes

## Response Syntax
<a name="API_DescribeModelVersion_ResponseSyntax"></a>

```
{
   "AutoPromotionResult": "string",
   "AutoPromotionResultReason": "string",
   "CreatedAt": number,
   "DataPreProcessingConfiguration": { 
      "TargetSamplingRate": "string"
   },
   "DatasetArn": "string",
   "DatasetName": "string",
   "EvaluationDataEndTime": number,
   "EvaluationDataStartTime": number,
   "FailedReason": "string",
   "ImportedDataSizeInBytes": number,
   "ImportJobEndTime": number,
   "ImportJobStartTime": number,
   "LabelsInputConfiguration": { 
      "LabelGroupName": "string",
      "S3InputConfiguration": { 
         "Bucket": "string",
         "Prefix": "string"
      }
   },
   "LastUpdatedTime": number,
   "ModelArn": "string",
   "ModelDiagnosticsOutputConfiguration": { 
      "KmsKeyId": "string",
      "S3OutputConfiguration": { 
         "Bucket": "string",
         "Prefix": "string"
      }
   },
   "ModelDiagnosticsResultsObject": { 
      "Bucket": "string",
      "Key": "string"
   },
   "ModelMetrics": "string",
   "ModelName": "string",
   "ModelQuality": "string",
   "ModelVersion": number,
   "ModelVersionArn": "string",
   "OffCondition": "string",
   "PriorModelMetrics": "string",
   "RetrainingAvailableDataInDays": number,
   "RoleArn": "string",
   "Schema": "string",
   "ServerSideKmsKeyId": "string",
   "SourceModelVersionArn": "string",
   "SourceType": "string",
   "Status": "string",
   "TrainingDataEndTime": number,
   "TrainingDataStartTime": number,
   "TrainingExecutionEndTime": number,
   "TrainingExecutionStartTime": number
}
```

## Response Elements
<a name="API_DescribeModelVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AutoPromotionResult](#API_DescribeModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModelVersion-response-AutoPromotionResult"></a>
Indicates whether the model version was promoted to be the active version after retraining or if there was an error with or cancellation of the retraining.   
Type: String  
Valid Values: `MODEL_PROMOTED | MODEL_NOT_PROMOTED | RETRAINING_INTERNAL_ERROR | RETRAINING_CUSTOMER_ERROR | RETRAINING_CANCELLED` 

 ** [AutoPromotionResultReason](#API_DescribeModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModelVersion-response-AutoPromotionResultReason"></a>
Indicates the reason for the `AutoPromotionResult`. For example, a model might not be promoted if its performance was worse than the active version, if there was an error during training, or if the retraining scheduler was using `MANUAL` promote mode. The model will be promoted in `MANAGED` promote mode if the performance is better than the previous model.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [CreatedAt](#API_DescribeModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModelVersion-response-CreatedAt"></a>
Indicates the time and date at which the machine learning model version was created.  
Type: Timestamp

 ** [DataPreProcessingConfiguration](#API_DescribeModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModelVersion-response-DataPreProcessingConfiguration"></a>
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](API_DataPreProcessingConfiguration.md) object

 ** [DatasetArn](#API_DescribeModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModelVersion-response-DatasetArn"></a>
The Amazon Resource Name (ARN) of the dataset used to train the model version.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:dataset\/[0-9a-zA-Z_-]{1,200}\/.+` 

 ** [DatasetName](#API_DescribeModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModelVersion-response-DatasetName"></a>
The name of the dataset used to train the model version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$` 

 ** [EvaluationDataEndTime](#API_DescribeModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModelVersion-response-EvaluationDataEndTime"></a>
The date on which the data in the evaluation set began being gathered. If you imported the version, this is the date that the evaluation set data in the source version finished being gathered.  
Type: Timestamp

 ** [EvaluationDataStartTime](#API_DescribeModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModelVersion-response-EvaluationDataStartTime"></a>
The date on which the data in the evaluation set began being gathered. If you imported the version, this is the date that the evaluation set data in the source version began being gathered.  
Type: Timestamp

 ** [FailedReason](#API_DescribeModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModelVersion-response-FailedReason"></a>
The failure message if the training of the model version failed.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 5000.  
Pattern: `[\P{M}\p{M}]{1,5000}` 

 ** [ImportedDataSizeInBytes](#API_DescribeModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModelVersion-response-ImportedDataSizeInBytes"></a>
The size in bytes of the imported data. This field appears if the model version was imported.  
Type: Long  
Valid Range: Minimum value of 0.

 ** [ImportJobEndTime](#API_DescribeModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModelVersion-response-ImportJobEndTime"></a>
The date and time when the import job completed. This field appears if the model version was imported.  
Type: Timestamp

 ** [ImportJobStartTime](#API_DescribeModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModelVersion-response-ImportJobStartTime"></a>
The date and time when the import job began. This field appears if the model version was imported.  
Type: Timestamp

 ** [LabelsInputConfiguration](#API_DescribeModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModelVersion-response-LabelsInputConfiguration"></a>
Contains the configuration information for the S3 location being used to hold label data.   
Type: [LabelsInputConfiguration](API_LabelsInputConfiguration.md) object

 ** [LastUpdatedTime](#API_DescribeModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModelVersion-response-LastUpdatedTime"></a>
Indicates the last time the machine learning model version was updated.  
Type: Timestamp

 ** [ModelArn](#API_DescribeModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModelVersion-response-ModelArn"></a>
The Amazon Resource Name (ARN) of the parent machine learning model that this version belong to.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:model\/.+` 

 ** [ModelDiagnosticsOutputConfiguration](#API_DescribeModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModelVersion-response-ModelDiagnosticsOutputConfiguration"></a>
The Amazon S3 location where Amazon Lookout for Equipment saves the pointwise model diagnostics for the model version.  
Type: [ModelDiagnosticsOutputConfiguration](API_ModelDiagnosticsOutputConfiguration.md) object

 ** [ModelDiagnosticsResultsObject](#API_DescribeModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModelVersion-response-ModelDiagnosticsResultsObject"></a>
Contains the Amazon S3 object path where Amazon Lookout for Equipment writes the model diagnostics results for the model version. The format is `User_Provided_Prefix/Model_Name/Model_Version/model_diagnostics_results.json.gz`.  
 `User_Provided_Prefix` is the prefix that you specify in the `ModelDiagnosticsOutputConfiguration` request parameter to the `CreateModel` or `UpdateModel` operations.   
Type: [S3Object](API_S3Object.md) object

 ** [ModelMetrics](#API_DescribeModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModelVersion-response-ModelMetrics"></a>
Shows an aggregated summary, in JSON format, of the model's performance within the evaluation time range. These metrics are created when evaluating the model.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50000.

 ** [ModelName](#API_DescribeModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModelVersion-response-ModelName"></a>
The name of the machine learning model that this version belongs to.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$` 

 ** [ModelQuality](#API_DescribeModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModelVersion-response-ModelQuality"></a>
Provides a quality assessment for a model that uses labels. If Lookout for Equipment determines that the model quality is poor based on training metrics, the value is `POOR_QUALITY_DETECTED`. Otherwise, the value is `QUALITY_THRESHOLD_MET`.  
If the model is unlabeled, the model quality can't be assessed and the value of `ModelQuality` is `CANNOT_DETERMINE_QUALITY`. In this situation, you can get a model quality assessment by adding labels to the input dataset and retraining the model.  
For information about using labels with your models, see [Understanding labeling](https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/understanding-labeling.html).  
For information about improving the quality of a model, see [Best practices with Amazon Lookout for Equipment](https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/best-practices.html).  
Type: String  
Valid Values: `QUALITY_THRESHOLD_MET | CANNOT_DETERMINE_QUALITY | POOR_QUALITY_DETECTED` 

 ** [ModelVersion](#API_DescribeModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModelVersion-response-ModelVersion"></a>
The version of the machine learning model.  
Type: Long  
Valid Range: Minimum value of 1.

 ** [ModelVersionArn](#API_DescribeModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModelVersion-response-ModelVersionArn"></a>
The Amazon Resource Name (ARN) of the model version.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:model\/[0-9a-zA-Z_-]{1,200}\/.+\/model-version\/[0-9]{1,}$` 

 ** [OffCondition](#API_DescribeModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModelVersion-response-OffCondition"></a>
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.

 ** [PriorModelMetrics](#API_DescribeModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModelVersion-response-PriorModelMetrics"></a>
If the model version was retrained, this field shows a summary of the performance of the prior model on the new training range. You can use the information in this JSON-formatted object to compare the new model version and the prior model version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50000.

 ** [RetrainingAvailableDataInDays](#API_DescribeModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModelVersion-response-RetrainingAvailableDataInDays"></a>
Indicates the number of days of data used in the most recent scheduled retraining run.   
Type: Integer

 ** [RoleArn](#API_DescribeModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModelVersion-response-RoleArn"></a>
The Amazon Resource Name (ARN) of the role that was used to train the model version.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+` 

 ** [Schema](#API_DescribeModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModelVersion-response-Schema"></a>
The schema of the data used to train the model version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000000.

 ** [ServerSideKmsKeyId](#API_DescribeModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModelVersion-response-ServerSideKmsKeyId"></a>
The identifier of the AWS KMS key key used to encrypt model version data by Amazon Lookout for Equipment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `arn:aws[a-z\-]*:kms:[a-z0-9\-]*:\d{12}:[\w\-\/]+` 

 ** [SourceModelVersionArn](#API_DescribeModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModelVersion-response-SourceModelVersionArn"></a>
If model version was imported, then this field is the arn of the source model version.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:model\/[0-9a-zA-Z_-]{1,200}\/.+\/model-version\/[0-9]{1,}$` 

 ** [SourceType](#API_DescribeModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModelVersion-response-SourceType"></a>
Indicates whether this model version was created by training or by importing.  
Type: String  
Valid Values: `TRAINING | RETRAINING | IMPORT` 

 ** [Status](#API_DescribeModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModelVersion-response-Status"></a>
The current status of the model version.  
Type: String  
Valid Values: `IN_PROGRESS | SUCCESS | FAILED | IMPORT_IN_PROGRESS | CANCELED` 

 ** [TrainingDataEndTime](#API_DescribeModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModelVersion-response-TrainingDataEndTime"></a>
The date on which the training data finished being gathered. If you imported the version, this is the date that the training data in the source version finished being gathered.  
Type: Timestamp

 ** [TrainingDataStartTime](#API_DescribeModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModelVersion-response-TrainingDataStartTime"></a>
The date on which the training data began being gathered. If you imported the version, this is the date that the training data in the source version began being gathered.  
Type: Timestamp

 ** [TrainingExecutionEndTime](#API_DescribeModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModelVersion-response-TrainingExecutionEndTime"></a>
The time when the training of the version completed.  
Type: Timestamp

 ** [TrainingExecutionStartTime](#API_DescribeModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeModelVersion-response-TrainingExecutionStartTime"></a>
The time when the training of the version began.  
Type: Timestamp

## Errors
<a name="API_DescribeModelVersion_Errors"></a>

 ** AccessDeniedException **   
The request could not be completed because you do not have access to the 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.  
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
<a name="API_DescribeModelVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/DescribeModelVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/DescribeModelVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/DescribeModelVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/DescribeModelVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/DescribeModelVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/DescribeModelVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/DescribeModelVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/DescribeModelVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/DescribeModelVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/DescribeModelVersion) 

# DescribeResourcePolicy
<a name="API_DescribeResourcePolicy"></a>

Provides the details of a resource policy attached to a resource.

## Request Syntax
<a name="API_DescribeResourcePolicy_RequestSyntax"></a>

```
{
   "ResourceArn": "string"
}
```

## Request Parameters
<a name="API_DescribeResourcePolicy_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ResourceArn](#API_DescribeResourcePolicy_RequestSyntax) **   <a name="LookoutForEquipment-DescribeResourcePolicy-request-ResourceArn"></a>
The Amazon Resource Name (ARN) of the resource that is associated with the resource policy.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:.+`   
Required: Yes

## Response Syntax
<a name="API_DescribeResourcePolicy_ResponseSyntax"></a>

```
{
   "CreationTime": number,
   "LastModifiedTime": number,
   "PolicyRevisionId": "string",
   "ResourcePolicy": "string"
}
```

## Response Elements
<a name="API_DescribeResourcePolicy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CreationTime](#API_DescribeResourcePolicy_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeResourcePolicy-response-CreationTime"></a>
The time when the resource policy was created.  
Type: Timestamp

 ** [LastModifiedTime](#API_DescribeResourcePolicy_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeResourcePolicy-response-LastModifiedTime"></a>
The time when the resource policy was last modified.  
Type: Timestamp

 ** [PolicyRevisionId](#API_DescribeResourcePolicy_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeResourcePolicy-response-PolicyRevisionId"></a>
A unique identifier for a revision of the resource policy.  
Type: String  
Length Constraints: Maximum length of 50.  
Pattern: `[0-9A-Fa-f]+` 

 ** [ResourcePolicy](#API_DescribeResourcePolicy_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeResourcePolicy-response-ResourcePolicy"></a>
The resource policy in a JSON-formatted string.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20000.  
Pattern: `[\u0009\u000A\u000D\u0020-\u00FF]+` 

## Errors
<a name="API_DescribeResourcePolicy_Errors"></a>

 ** AccessDeniedException **   
The request could not be completed because you do not have access to the 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.  
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
<a name="API_DescribeResourcePolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/DescribeResourcePolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/DescribeResourcePolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/DescribeResourcePolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/DescribeResourcePolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/DescribeResourcePolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/DescribeResourcePolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/DescribeResourcePolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/DescribeResourcePolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/DescribeResourcePolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/DescribeResourcePolicy) 

# DescribeRetrainingScheduler
<a name="API_DescribeRetrainingScheduler"></a>

Provides a description of the retraining scheduler, including information such as the model name and retraining parameters. 

## Request Syntax
<a name="API_DescribeRetrainingScheduler_RequestSyntax"></a>

```
{
   "ModelName": "string"
}
```

## Request Parameters
<a name="API_DescribeRetrainingScheduler_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ModelName](#API_DescribeRetrainingScheduler_RequestSyntax) **   <a name="LookoutForEquipment-DescribeRetrainingScheduler-request-ModelName"></a>
The name of the model that the retraining scheduler is attached to.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: Yes

## Response Syntax
<a name="API_DescribeRetrainingScheduler_ResponseSyntax"></a>

```
{
   "CreatedAt": number,
   "LookbackWindow": "string",
   "ModelArn": "string",
   "ModelName": "string",
   "PromoteMode": "string",
   "RetrainingFrequency": "string",
   "RetrainingStartDate": number,
   "Status": "string",
   "UpdatedAt": number
}
```

## Response Elements
<a name="API_DescribeRetrainingScheduler_ResponseElements"></a>

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](#API_DescribeRetrainingScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeRetrainingScheduler-response-CreatedAt"></a>
Indicates the time and date at which the retraining scheduler was created.   
Type: Timestamp

 ** [LookbackWindow](#API_DescribeRetrainingScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeRetrainingScheduler-response-LookbackWindow"></a>
The number of past days of data used for retraining.  
Type: String  
Pattern: `^P180D$|^P360D$|^P540D$|^P720D$` 

 ** [ModelArn](#API_DescribeRetrainingScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeRetrainingScheduler-response-ModelArn"></a>
The ARN of the model that the retraining scheduler is attached to.   
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:model\/.+` 

 ** [ModelName](#API_DescribeRetrainingScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeRetrainingScheduler-response-ModelName"></a>
The name of the model that the retraining scheduler is attached to.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$` 

 ** [PromoteMode](#API_DescribeRetrainingScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeRetrainingScheduler-response-PromoteMode"></a>
Indicates how the service uses new models. In `MANAGED` mode, new models are used for inference if they have better performance than the current model. In `MANUAL` mode, the new models are not used until they are [manually activated](https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/versioning-model.html#model-activation).  
Type: String  
Valid Values: `MANAGED | MANUAL` 

 ** [RetrainingFrequency](#API_DescribeRetrainingScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeRetrainingScheduler-response-RetrainingFrequency"></a>
The frequency at which the model retraining is set. This follows the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) guidelines.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10.  
Pattern: `^P(\dY)?(\d{1,2}M)?(\d{1,3}D)?$` 

 ** [RetrainingStartDate](#API_DescribeRetrainingScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeRetrainingScheduler-response-RetrainingStartDate"></a>
The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the nearest UTC day.  
Type: Timestamp

 ** [Status](#API_DescribeRetrainingScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeRetrainingScheduler-response-Status"></a>
The status of the retraining scheduler.   
Type: String  
Valid Values: `PENDING | RUNNING | STOPPING | STOPPED` 

 ** [UpdatedAt](#API_DescribeRetrainingScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-DescribeRetrainingScheduler-response-UpdatedAt"></a>
Indicates the time and date at which the retraining scheduler was updated.   
Type: Timestamp

## Errors
<a name="API_DescribeRetrainingScheduler_Errors"></a>

 ** AccessDeniedException **   
The request could not be completed because you do not have access to the 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.  
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
<a name="API_DescribeRetrainingScheduler_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/DescribeRetrainingScheduler) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/DescribeRetrainingScheduler) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/DescribeRetrainingScheduler) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/DescribeRetrainingScheduler) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/DescribeRetrainingScheduler) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/DescribeRetrainingScheduler) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/DescribeRetrainingScheduler) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/DescribeRetrainingScheduler) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/DescribeRetrainingScheduler) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/DescribeRetrainingScheduler) 

# ImportDataset
<a name="API_ImportDataset"></a>

Imports a dataset.

## Request Syntax
<a name="API_ImportDataset_RequestSyntax"></a>

```
{
   "ClientToken": "string",
   "DatasetName": "string",
   "ServerSideKmsKeyId": "string",
   "SourceDatasetArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_ImportDataset_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_ImportDataset_RequestSyntax) **   <a name="LookoutForEquipment-ImportDataset-request-ClientToken"></a>
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

 ** [DatasetName](#API_ImportDataset_RequestSyntax) **   <a name="LookoutForEquipment-ImportDataset-request-DatasetName"></a>
The name of the machine learning dataset to be created. If the dataset already exists, Amazon Lookout for Equipment overwrites the existing dataset. If you don't specify this field, it is filled with the name of the source dataset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: No

 ** [ServerSideKmsKeyId](#API_ImportDataset_RequestSyntax) **   <a name="LookoutForEquipment-ImportDataset-request-ServerSideKmsKeyId"></a>
Provides the identifier of the AWS KMS key 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

 ** [SourceDatasetArn](#API_ImportDataset_RequestSyntax) **   <a name="LookoutForEquipment-ImportDataset-request-SourceDatasetArn"></a>
The Amazon Resource Name (ARN) of the dataset to import.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:dataset\/[0-9a-zA-Z_-]{1,200}\/.+`   
Required: Yes

 ** [Tags](#API_ImportDataset_RequestSyntax) **   <a name="LookoutForEquipment-ImportDataset-request-Tags"></a>
Any tags associated with the dataset to be created.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: No

## Response Syntax
<a name="API_ImportDataset_ResponseSyntax"></a>

```
{
   "DatasetArn": "string",
   "DatasetName": "string",
   "JobId": "string",
   "Status": "string"
}
```

## Response Elements
<a name="API_ImportDataset_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [DatasetArn](#API_ImportDataset_ResponseSyntax) **   <a name="LookoutForEquipment-ImportDataset-response-DatasetArn"></a>
The Amazon Resource Name (ARN) of the dataset that was imported.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:dataset\/[0-9a-zA-Z_-]{1,200}\/.+` 

 ** [DatasetName](#API_ImportDataset_ResponseSyntax) **   <a name="LookoutForEquipment-ImportDataset-response-DatasetName"></a>
The name of the created machine learning dataset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$` 

 ** [JobId](#API_ImportDataset_ResponseSyntax) **   <a name="LookoutForEquipment-ImportDataset-response-JobId"></a>
A unique identifier for the job of importing the dataset.  
Type: String  
Length Constraints: Maximum length of 32.  
Pattern: `[A-Fa-f0-9]{0,32}` 

 ** [Status](#API_ImportDataset_ResponseSyntax) **   <a name="LookoutForEquipment-ImportDataset-response-Status"></a>
The status of the `ImportDataset` operation.  
Type: String  
Valid Values: `CREATED | INGESTION_IN_PROGRESS | ACTIVE | IMPORT_IN_PROGRESS` 

## Errors
<a name="API_ImportDataset_Errors"></a>

 ** 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.   
HTTP Status Code: 400

## See Also
<a name="API_ImportDataset_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/ImportDataset) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/ImportDataset) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/ImportDataset) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/ImportDataset) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/ImportDataset) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/ImportDataset) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/ImportDataset) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/ImportDataset) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/ImportDataset) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/ImportDataset) 

# ImportModelVersion
<a name="API_ImportModelVersion"></a>

Imports a model that has been trained successfully.

## Request Syntax
<a name="API_ImportModelVersion_RequestSyntax"></a>

```
{
   "ClientToken": "string",
   "DatasetName": "string",
   "InferenceDataImportStrategy": "string",
   "LabelsInputConfiguration": { 
      "LabelGroupName": "string",
      "S3InputConfiguration": { 
         "Bucket": "string",
         "Prefix": "string"
      }
   },
   "ModelName": "string",
   "RoleArn": "string",
   "ServerSideKmsKeyId": "string",
   "SourceModelVersionArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_ImportModelVersion_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_ImportModelVersion_RequestSyntax) **   <a name="LookoutForEquipment-ImportModelVersion-request-ClientToken"></a>
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

 ** [DatasetName](#API_ImportModelVersion_RequestSyntax) **   <a name="LookoutForEquipment-ImportModelVersion-request-DatasetName"></a>
The name of the dataset for the machine learning model being imported.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: Yes

 ** [InferenceDataImportStrategy](#API_ImportModelVersion_RequestSyntax) **   <a name="LookoutForEquipment-ImportModelVersion-request-InferenceDataImportStrategy"></a>
Indicates how to import the accumulated inference data when a model version is imported. The possible values are as follows:  
+ NO\$1IMPORT – Don't import the data.
+ ADD\$1WHEN\$1EMPTY – Only import the data from the source model if there is no existing data in the target model.
+ OVERWRITE – Import the data from the source model and overwrite the existing data in the target model.
Type: String  
Valid Values: `NO_IMPORT | ADD_WHEN_EMPTY | OVERWRITE`   
Required: No

 ** [LabelsInputConfiguration](#API_ImportModelVersion_RequestSyntax) **   <a name="LookoutForEquipment-ImportModelVersion-request-LabelsInputConfiguration"></a>
Contains the configuration information for the S3 location being used to hold label data.   
Type: [LabelsInputConfiguration](API_LabelsInputConfiguration.md) object  
Required: No

 ** [ModelName](#API_ImportModelVersion_RequestSyntax) **   <a name="LookoutForEquipment-ImportModelVersion-request-ModelName"></a>
The name for the machine learning model to be created. If the model already exists, Amazon Lookout for Equipment creates a new version. If you do not specify this field, it is filled with the name of the source model.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: No

 ** [RoleArn](#API_ImportModelVersion_RequestSyntax) **   <a name="LookoutForEquipment-ImportModelVersion-request-RoleArn"></a>
The Amazon Resource Name (ARN) of a role with permission to access the data source being used to create the machine learning model.   
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+`   
Required: No

 ** [ServerSideKmsKeyId](#API_ImportModelVersion_RequestSyntax) **   <a name="LookoutForEquipment-ImportModelVersion-request-ServerSideKmsKeyId"></a>
Provides the identifier of the AWS KMS key 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

 ** [SourceModelVersionArn](#API_ImportModelVersion_RequestSyntax) **   <a name="LookoutForEquipment-ImportModelVersion-request-SourceModelVersionArn"></a>
The Amazon Resource Name (ARN) of the model version to import.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:model\/[0-9a-zA-Z_-]{1,200}\/.+\/model-version\/[0-9]{1,}$`   
Required: Yes

 ** [Tags](#API_ImportModelVersion_RequestSyntax) **   <a name="LookoutForEquipment-ImportModelVersion-request-Tags"></a>
The tags associated with the machine learning model to be created.   
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: No

## Response Syntax
<a name="API_ImportModelVersion_ResponseSyntax"></a>

```
{
   "ModelArn": "string",
   "ModelName": "string",
   "ModelVersion": number,
   "ModelVersionArn": "string",
   "Status": "string"
}
```

## Response Elements
<a name="API_ImportModelVersion_ResponseElements"></a>

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](#API_ImportModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-ImportModelVersion-response-ModelArn"></a>
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\/.+` 

 ** [ModelName](#API_ImportModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-ImportModelVersion-response-ModelName"></a>
The name for the machine learning model.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$` 

 ** [ModelVersion](#API_ImportModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-ImportModelVersion-response-ModelVersion"></a>
The version of the model being created.  
Type: Long  
Valid Range: Minimum value of 1.

 ** [ModelVersionArn](#API_ImportModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-ImportModelVersion-response-ModelVersionArn"></a>
The Amazon Resource Name (ARN) of the model version 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\/[0-9a-zA-Z_-]{1,200}\/.+\/model-version\/[0-9]{1,}$` 

 ** [Status](#API_ImportModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-ImportModelVersion-response-Status"></a>
The status of the `ImportModelVersion` operation.   
Type: String  
Valid Values: `IN_PROGRESS | SUCCESS | FAILED | IMPORT_IN_PROGRESS | CANCELED` 

## Errors
<a name="API_ImportModelVersion_Errors"></a>

 ** 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.   
HTTP Status Code: 400

## See Also
<a name="API_ImportModelVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/ImportModelVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/ImportModelVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/ImportModelVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/ImportModelVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/ImportModelVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/ImportModelVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/ImportModelVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/ImportModelVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/ImportModelVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/ImportModelVersion) 

# ListDataIngestionJobs
<a name="API_ListDataIngestionJobs"></a>

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

## Request Syntax
<a name="API_ListDataIngestionJobs_RequestSyntax"></a>

```
{
   "DatasetName": "string",
   "MaxResults": number,
   "NextToken": "string",
   "Status": "string"
}
```

## Request Parameters
<a name="API_ListDataIngestionJobs_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DatasetName](#API_ListDataIngestionJobs_RequestSyntax) **   <a name="LookoutForEquipment-ListDataIngestionJobs-request-DatasetName"></a>
The name of the dataset being used for the data ingestion job.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: No

 ** [MaxResults](#API_ListDataIngestionJobs_RequestSyntax) **   <a name="LookoutForEquipment-ListDataIngestionJobs-request-MaxResults"></a>
 Specifies the maximum number of data ingestion jobs to list.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 500.  
Required: No

 ** [NextToken](#API_ListDataIngestionJobs_RequestSyntax) **   <a name="LookoutForEquipment-ListDataIngestionJobs-request-NextToken"></a>
An opaque pagination token indicating where to continue the listing of data ingestion jobs.   
Type: String  
Length Constraints: Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}`   
Required: No

 ** [Status](#API_ListDataIngestionJobs_RequestSyntax) **   <a name="LookoutForEquipment-ListDataIngestionJobs-request-Status"></a>
Indicates the status of the data ingestion job.   
Type: String  
Valid Values: `IN_PROGRESS | SUCCESS | FAILED | IMPORT_IN_PROGRESS`   
Required: No

## Response Syntax
<a name="API_ListDataIngestionJobs_ResponseSyntax"></a>

```
{
   "DataIngestionJobSummaries": [ 
      { 
         "DatasetArn": "string",
         "DatasetName": "string",
         "IngestionInputConfiguration": { 
            "S3InputConfiguration": { 
               "Bucket": "string",
               "KeyPattern": "string",
               "Prefix": "string"
            }
         },
         "JobId": "string",
         "Status": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListDataIngestionJobs_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [DataIngestionJobSummaries](#API_ListDataIngestionJobs_ResponseSyntax) **   <a name="LookoutForEquipment-ListDataIngestionJobs-response-DataIngestionJobSummaries"></a>
Specifies information about the specific data ingestion job, including dataset name and status.   
Type: Array of [DataIngestionJobSummary](API_DataIngestionJobSummary.md) objects

 ** [NextToken](#API_ListDataIngestionJobs_ResponseSyntax) **   <a name="LookoutForEquipment-ListDataIngestionJobs-response-NextToken"></a>
 An opaque pagination token indicating where to continue the listing of data ingestion jobs.   
Type: String  
Length Constraints: Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}` 

## Errors
<a name="API_ListDataIngestionJobs_Errors"></a>

 ** AccessDeniedException **   
The request could not be completed because you do not have access to the resource.   
HTTP Status Code: 400

 ** InternalServerException **   
 Processing of the request has failed because of an unknown error, exception or failure.   
HTTP Status Code: 500

 ** 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
<a name="API_ListDataIngestionJobs_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/ListDataIngestionJobs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/ListDataIngestionJobs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/ListDataIngestionJobs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/ListDataIngestionJobs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/ListDataIngestionJobs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/ListDataIngestionJobs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/ListDataIngestionJobs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/ListDataIngestionJobs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/ListDataIngestionJobs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/ListDataIngestionJobs) 

# ListDatasets
<a name="API_ListDatasets"></a>

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

## Request Syntax
<a name="API_ListDatasets_RequestSyntax"></a>

```
{
   "DatasetNameBeginsWith": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListDatasets_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DatasetNameBeginsWith](#API_ListDatasets_RequestSyntax) **   <a name="LookoutForEquipment-ListDatasets-request-DatasetNameBeginsWith"></a>
The beginning of the name of the datasets to be listed.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: No

 ** [MaxResults](#API_ListDatasets_RequestSyntax) **   <a name="LookoutForEquipment-ListDatasets-request-MaxResults"></a>
 Specifies the maximum number of datasets to list.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 500.  
Required: No

 ** [NextToken](#API_ListDatasets_RequestSyntax) **   <a name="LookoutForEquipment-ListDatasets-request-NextToken"></a>
 An opaque pagination token indicating where to continue the listing of datasets.   
Type: String  
Length Constraints: Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}`   
Required: No

## Response Syntax
<a name="API_ListDatasets_ResponseSyntax"></a>

```
{
   "DatasetSummaries": [ 
      { 
         "CreatedAt": number,
         "DatasetArn": "string",
         "DatasetName": "string",
         "Status": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListDatasets_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [DatasetSummaries](#API_ListDatasets_ResponseSyntax) **   <a name="LookoutForEquipment-ListDatasets-response-DatasetSummaries"></a>
Provides information about the specified dataset, including creation time, dataset ARN, and status.   
Type: Array of [DatasetSummary](API_DatasetSummary.md) objects

 ** [NextToken](#API_ListDatasets_ResponseSyntax) **   <a name="LookoutForEquipment-ListDatasets-response-NextToken"></a>
 An opaque pagination token indicating where to continue the listing of datasets.   
Type: String  
Length Constraints: Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}` 

## Errors
<a name="API_ListDatasets_Errors"></a>

 ** AccessDeniedException **   
The request could not be completed because you do not have access to the resource.   
HTTP Status Code: 400

 ** InternalServerException **   
 Processing of the request has failed because of an unknown error, exception or failure.   
HTTP Status Code: 500

 ** 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
<a name="API_ListDatasets_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/ListDatasets) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/ListDatasets) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/ListDatasets) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/ListDatasets) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/ListDatasets) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/ListDatasets) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/ListDatasets) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/ListDatasets) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/ListDatasets) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/ListDatasets) 

# ListInferenceEvents
<a name="API_ListInferenceEvents"></a>

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

## Request Syntax
<a name="API_ListInferenceEvents_RequestSyntax"></a>

```
{
   "InferenceSchedulerName": "string",
   "IntervalEndTime": number,
   "IntervalStartTime": number,
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListInferenceEvents_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [InferenceSchedulerName](#API_ListInferenceEvents_RequestSyntax) **   <a name="LookoutForEquipment-ListInferenceEvents-request-InferenceSchedulerName"></a>
The name of the inference scheduler for the inference events listed.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: Yes

 ** [IntervalEndTime](#API_ListInferenceEvents_RequestSyntax) **   <a name="LookoutForEquipment-ListInferenceEvents-request-IntervalEndTime"></a>
Returns all the inference events with an end start time equal to or greater than less than the end time given.  
Type: Timestamp  
Required: Yes

 ** [IntervalStartTime](#API_ListInferenceEvents_RequestSyntax) **   <a name="LookoutForEquipment-ListInferenceEvents-request-IntervalStartTime"></a>
 Lookout for Equipment will return all the inference events with an end time equal to or greater than the start time given.  
Type: Timestamp  
Required: Yes

 ** [MaxResults](#API_ListInferenceEvents_RequestSyntax) **   <a name="LookoutForEquipment-ListInferenceEvents-request-MaxResults"></a>
Specifies the maximum number of inference events to list.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 500.  
Required: No

 ** [NextToken](#API_ListInferenceEvents_RequestSyntax) **   <a name="LookoutForEquipment-ListInferenceEvents-request-NextToken"></a>
An opaque pagination token indicating where to continue the listing of inference events.  
Type: String  
Length Constraints: Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}`   
Required: No

## Response Syntax
<a name="API_ListInferenceEvents_ResponseSyntax"></a>

```
{
   "InferenceEventSummaries": [ 
      { 
         "Diagnostics": "string",
         "EventDurationInSeconds": number,
         "EventEndTime": number,
         "EventStartTime": number,
         "InferenceSchedulerArn": "string",
         "InferenceSchedulerName": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListInferenceEvents_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [InferenceEventSummaries](#API_ListInferenceEvents_ResponseSyntax) **   <a name="LookoutForEquipment-ListInferenceEvents-response-InferenceEventSummaries"></a>
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.   
Type: Array of [InferenceEventSummary](API_InferenceEventSummary.md) objects

 ** [NextToken](#API_ListInferenceEvents_ResponseSyntax) **   <a name="LookoutForEquipment-ListInferenceEvents-response-NextToken"></a>
An opaque pagination token indicating where to continue the listing of inference executions.   
Type: String  
Length Constraints: Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}` 

## Errors
<a name="API_ListInferenceEvents_Errors"></a>

 ** AccessDeniedException **   
The request could not be completed because you do not have access to the 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.  
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
<a name="API_ListInferenceEvents_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/ListInferenceEvents) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/ListInferenceEvents) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/ListInferenceEvents) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/ListInferenceEvents) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/ListInferenceEvents) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/ListInferenceEvents) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/ListInferenceEvents) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/ListInferenceEvents) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/ListInferenceEvents) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/ListInferenceEvents) 

# ListInferenceExecutions
<a name="API_ListInferenceExecutions"></a>

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

## Request Syntax
<a name="API_ListInferenceExecutions_RequestSyntax"></a>

```
{
   "DataEndTimeBefore": number,
   "DataStartTimeAfter": number,
   "InferenceSchedulerName": "string",
   "MaxResults": number,
   "NextToken": "string",
   "Status": "string"
}
```

## Request Parameters
<a name="API_ListInferenceExecutions_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DataEndTimeBefore](#API_ListInferenceExecutions_RequestSyntax) **   <a name="LookoutForEquipment-ListInferenceExecutions-request-DataEndTimeBefore"></a>
The time reference in the inferenced dataset before which Amazon Lookout for Equipment stopped the inference execution.   
Type: Timestamp  
Required: No

 ** [DataStartTimeAfter](#API_ListInferenceExecutions_RequestSyntax) **   <a name="LookoutForEquipment-ListInferenceExecutions-request-DataStartTimeAfter"></a>
The time reference in the inferenced dataset after which Amazon Lookout for Equipment started the inference execution.   
Type: Timestamp  
Required: No

 ** [InferenceSchedulerName](#API_ListInferenceExecutions_RequestSyntax) **   <a name="LookoutForEquipment-ListInferenceExecutions-request-InferenceSchedulerName"></a>
The name of the inference scheduler for the inference execution listed.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: Yes

 ** [MaxResults](#API_ListInferenceExecutions_RequestSyntax) **   <a name="LookoutForEquipment-ListInferenceExecutions-request-MaxResults"></a>
Specifies the maximum number of inference executions to list.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 500.  
Required: No

 ** [NextToken](#API_ListInferenceExecutions_RequestSyntax) **   <a name="LookoutForEquipment-ListInferenceExecutions-request-NextToken"></a>
An opaque pagination token indicating where to continue the listing of inference executions.  
Type: String  
Length Constraints: Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}`   
Required: No

 ** [Status](#API_ListInferenceExecutions_RequestSyntax) **   <a name="LookoutForEquipment-ListInferenceExecutions-request-Status"></a>
The status of the inference execution.   
Type: String  
Valid Values: `IN_PROGRESS | SUCCESS | FAILED`   
Required: No

## Response Syntax
<a name="API_ListInferenceExecutions_ResponseSyntax"></a>

```
{
   "InferenceExecutionSummaries": [ 
      { 
         "CustomerResultObject": { 
            "Bucket": "string",
            "Key": "string"
         },
         "DataEndTime": number,
         "DataInputConfiguration": { 
            "InferenceInputNameConfiguration": { 
               "ComponentTimestampDelimiter": "string",
               "TimestampFormat": "string"
            },
            "InputTimeZoneOffset": "string",
            "S3InputConfiguration": { 
               "Bucket": "string",
               "Prefix": "string"
            }
         },
         "DataOutputConfiguration": { 
            "KmsKeyId": "string",
            "S3OutputConfiguration": { 
               "Bucket": "string",
               "Prefix": "string"
            }
         },
         "DataStartTime": number,
         "FailedReason": "string",
         "InferenceSchedulerArn": "string",
         "InferenceSchedulerName": "string",
         "ModelArn": "string",
         "ModelName": "string",
         "ModelVersion": number,
         "ModelVersionArn": "string",
         "ScheduledStartTime": number,
         "Status": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListInferenceExecutions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [InferenceExecutionSummaries](#API_ListInferenceExecutions_ResponseSyntax) **   <a name="LookoutForEquipment-ListInferenceExecutions-response-InferenceExecutionSummaries"></a>
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.   
If you don't supply the `InferenceSchedulerName` request parameter, or if you supply the name of an inference scheduler that doesn't exist, `ListInferenceExecutions` returns an empty array in `InferenceExecutionSummaries`.
Type: Array of [InferenceExecutionSummary](API_InferenceExecutionSummary.md) objects

 ** [NextToken](#API_ListInferenceExecutions_ResponseSyntax) **   <a name="LookoutForEquipment-ListInferenceExecutions-response-NextToken"></a>
 An opaque pagination token indicating where to continue the listing of inference executions.   
Type: String  
Length Constraints: Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}` 

## Errors
<a name="API_ListInferenceExecutions_Errors"></a>

 ** AccessDeniedException **   
The request could not be completed because you do not have access to the 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.  
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
<a name="API_ListInferenceExecutions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/ListInferenceExecutions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/ListInferenceExecutions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/ListInferenceExecutions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/ListInferenceExecutions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/ListInferenceExecutions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/ListInferenceExecutions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/ListInferenceExecutions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/ListInferenceExecutions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/ListInferenceExecutions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/ListInferenceExecutions) 

# ListInferenceSchedulers
<a name="API_ListInferenceSchedulers"></a>

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

## Request Syntax
<a name="API_ListInferenceSchedulers_RequestSyntax"></a>

```
{
   "InferenceSchedulerNameBeginsWith": "string",
   "MaxResults": number,
   "ModelName": "string",
   "NextToken": "string",
   "Status": "string"
}
```

## Request Parameters
<a name="API_ListInferenceSchedulers_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [InferenceSchedulerNameBeginsWith](#API_ListInferenceSchedulers_RequestSyntax) **   <a name="LookoutForEquipment-ListInferenceSchedulers-request-InferenceSchedulerNameBeginsWith"></a>
The beginning of the name of the inference schedulers to be listed.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: No

 ** [MaxResults](#API_ListInferenceSchedulers_RequestSyntax) **   <a name="LookoutForEquipment-ListInferenceSchedulers-request-MaxResults"></a>
 Specifies the maximum number of inference schedulers to list.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 500.  
Required: No

 ** [ModelName](#API_ListInferenceSchedulers_RequestSyntax) **   <a name="LookoutForEquipment-ListInferenceSchedulers-request-ModelName"></a>
The name of the machine learning model used by the inference scheduler to be listed.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: No

 ** [NextToken](#API_ListInferenceSchedulers_RequestSyntax) **   <a name="LookoutForEquipment-ListInferenceSchedulers-request-NextToken"></a>
 An opaque pagination token indicating where to continue the listing of inference schedulers.   
Type: String  
Length Constraints: Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}`   
Required: No

 ** [Status](#API_ListInferenceSchedulers_RequestSyntax) **   <a name="LookoutForEquipment-ListInferenceSchedulers-request-Status"></a>
Specifies the current status of the inference schedulers.  
Type: String  
Valid Values: `PENDING | RUNNING | STOPPING | STOPPED`   
Required: No

## Response Syntax
<a name="API_ListInferenceSchedulers_ResponseSyntax"></a>

```
{
   "InferenceSchedulerSummaries": [ 
      { 
         "DataDelayOffsetInMinutes": number,
         "DataUploadFrequency": "string",
         "InferenceSchedulerArn": "string",
         "InferenceSchedulerName": "string",
         "LatestInferenceResult": "string",
         "ModelArn": "string",
         "ModelName": "string",
         "Status": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListInferenceSchedulers_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [InferenceSchedulerSummaries](#API_ListInferenceSchedulers_ResponseSyntax) **   <a name="LookoutForEquipment-ListInferenceSchedulers-response-InferenceSchedulerSummaries"></a>
Provides information about the specified inference scheduler, including data upload frequency, model name and ARN, and status.   
Type: Array of [InferenceSchedulerSummary](API_InferenceSchedulerSummary.md) objects

 ** [NextToken](#API_ListInferenceSchedulers_ResponseSyntax) **   <a name="LookoutForEquipment-ListInferenceSchedulers-response-NextToken"></a>
 An opaque pagination token indicating where to continue the listing of inference schedulers.   
Type: String  
Length Constraints: Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}` 

## Errors
<a name="API_ListInferenceSchedulers_Errors"></a>

 ** AccessDeniedException **   
The request could not be completed because you do not have access to the resource.   
HTTP Status Code: 400

 ** InternalServerException **   
 Processing of the request has failed because of an unknown error, exception or failure.   
HTTP Status Code: 500

 ** 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
<a name="API_ListInferenceSchedulers_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/ListInferenceSchedulers) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/ListInferenceSchedulers) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/ListInferenceSchedulers) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/ListInferenceSchedulers) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/ListInferenceSchedulers) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/ListInferenceSchedulers) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/ListInferenceSchedulers) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/ListInferenceSchedulers) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/ListInferenceSchedulers) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/ListInferenceSchedulers) 

# ListLabelGroups
<a name="API_ListLabelGroups"></a>

 Returns a list of the label groups. 

## Request Syntax
<a name="API_ListLabelGroups_RequestSyntax"></a>

```
{
   "LabelGroupNameBeginsWith": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListLabelGroups_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [LabelGroupNameBeginsWith](#API_ListLabelGroups_RequestSyntax) **   <a name="LookoutForEquipment-ListLabelGroups-request-LabelGroupNameBeginsWith"></a>
 The beginning of the name of the label groups to be listed.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: No

 ** [MaxResults](#API_ListLabelGroups_RequestSyntax) **   <a name="LookoutForEquipment-ListLabelGroups-request-MaxResults"></a>
 Specifies the maximum number of label groups to list.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 500.  
Required: No

 ** [NextToken](#API_ListLabelGroups_RequestSyntax) **   <a name="LookoutForEquipment-ListLabelGroups-request-NextToken"></a>
 An opaque pagination token indicating where to continue the listing of label groups.   
Type: String  
Length Constraints: Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}`   
Required: No

## Response Syntax
<a name="API_ListLabelGroups_ResponseSyntax"></a>

```
{
   "LabelGroupSummaries": [ 
      { 
         "CreatedAt": number,
         "LabelGroupArn": "string",
         "LabelGroupName": "string",
         "UpdatedAt": number
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListLabelGroups_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [LabelGroupSummaries](#API_ListLabelGroups_ResponseSyntax) **   <a name="LookoutForEquipment-ListLabelGroups-response-LabelGroupSummaries"></a>
 A summary of the label groups.   
Type: Array of [LabelGroupSummary](API_LabelGroupSummary.md) objects

 ** [NextToken](#API_ListLabelGroups_ResponseSyntax) **   <a name="LookoutForEquipment-ListLabelGroups-response-NextToken"></a>
 An opaque pagination token indicating where to continue the listing of label groups.   
Type: String  
Length Constraints: Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}` 

## Errors
<a name="API_ListLabelGroups_Errors"></a>

 ** AccessDeniedException **   
The request could not be completed because you do not have access to the resource.   
HTTP Status Code: 400

 ** InternalServerException **   
 Processing of the request has failed because of an unknown error, exception or failure.   
HTTP Status Code: 500

 ** 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
<a name="API_ListLabelGroups_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/ListLabelGroups) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/ListLabelGroups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/ListLabelGroups) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/ListLabelGroups) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/ListLabelGroups) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/ListLabelGroups) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/ListLabelGroups) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/ListLabelGroups) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/ListLabelGroups) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/ListLabelGroups) 

# ListLabels
<a name="API_ListLabels"></a>

 Provides a list of labels. 

## Request Syntax
<a name="API_ListLabels_RequestSyntax"></a>

```
{
   "Equipment": "string",
   "FaultCode": "string",
   "IntervalEndTime": number,
   "IntervalStartTime": number,
   "LabelGroupName": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListLabels_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [Equipment](#API_ListLabels_RequestSyntax) **   <a name="LookoutForEquipment-ListLabels-request-Equipment"></a>
 Lists the labels that pertain to a particular piece of equipment.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `[\P{M}\p{M}]{1,200}`   
Required: No

 ** [FaultCode](#API_ListLabels_RequestSyntax) **   <a name="LookoutForEquipment-ListLabels-request-FaultCode"></a>
 Returns labels with a particular fault code.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[\P{M}\p{M}]{1,100}`   
Required: No

 ** [IntervalEndTime](#API_ListLabels_RequestSyntax) **   <a name="LookoutForEquipment-ListLabels-request-IntervalEndTime"></a>
 Returns all labels with a start time earlier than the end time given.   
Type: Timestamp  
Required: No

 ** [IntervalStartTime](#API_ListLabels_RequestSyntax) **   <a name="LookoutForEquipment-ListLabels-request-IntervalStartTime"></a>
 Returns all the labels with a end time equal to or later than the start time given.   
Type: Timestamp  
Required: No

 ** [LabelGroupName](#API_ListLabels_RequestSyntax) **   <a name="LookoutForEquipment-ListLabels-request-LabelGroupName"></a>
 Returns the name of the label group.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: Yes

 ** [MaxResults](#API_ListLabels_RequestSyntax) **   <a name="LookoutForEquipment-ListLabels-request-MaxResults"></a>
 Specifies the maximum number of labels to list.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 500.  
Required: No

 ** [NextToken](#API_ListLabels_RequestSyntax) **   <a name="LookoutForEquipment-ListLabels-request-NextToken"></a>
 An opaque pagination token indicating where to continue the listing of label groups.   
Type: String  
Length Constraints: Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}`   
Required: No

## Response Syntax
<a name="API_ListLabels_ResponseSyntax"></a>

```
{
   "LabelSummaries": [ 
      { 
         "CreatedAt": number,
         "EndTime": number,
         "Equipment": "string",
         "FaultCode": "string",
         "LabelGroupArn": "string",
         "LabelGroupName": "string",
         "LabelId": "string",
         "Rating": "string",
         "StartTime": number
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListLabels_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [LabelSummaries](#API_ListLabels_ResponseSyntax) **   <a name="LookoutForEquipment-ListLabels-response-LabelSummaries"></a>
 A summary of the items in the label group.   
If you don't supply the `LabelGroupName` request parameter, or if you supply the name of a label group that doesn't exist, `ListLabels` returns an empty array in `LabelSummaries`.
Type: Array of [LabelSummary](API_LabelSummary.md) objects

 ** [NextToken](#API_ListLabels_ResponseSyntax) **   <a name="LookoutForEquipment-ListLabels-response-NextToken"></a>
 An opaque pagination token indicating where to continue the listing of datasets.   
Type: String  
Length Constraints: Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}` 

## Errors
<a name="API_ListLabels_Errors"></a>

 ** AccessDeniedException **   
The request could not be completed because you do not have access to the resource.   
HTTP Status Code: 400

 ** InternalServerException **   
 Processing of the request has failed because of an unknown error, exception or failure.   
HTTP Status Code: 500

 ** 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
<a name="API_ListLabels_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/ListLabels) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/ListLabels) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/ListLabels) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/ListLabels) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/ListLabels) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/ListLabels) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/ListLabels) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/ListLabels) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/ListLabels) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/ListLabels) 

# ListModels
<a name="API_ListModels"></a>

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

## Request Syntax
<a name="API_ListModels_RequestSyntax"></a>

```
{
   "DatasetNameBeginsWith": "string",
   "MaxResults": number,
   "ModelNameBeginsWith": "string",
   "NextToken": "string",
   "Status": "string"
}
```

## Request Parameters
<a name="API_ListModels_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DatasetNameBeginsWith](#API_ListModels_RequestSyntax) **   <a name="LookoutForEquipment-ListModels-request-DatasetNameBeginsWith"></a>
The beginning of the name of the dataset of the machine learning models to be listed.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: No

 ** [MaxResults](#API_ListModels_RequestSyntax) **   <a name="LookoutForEquipment-ListModels-request-MaxResults"></a>
 Specifies the maximum number of machine learning models to list.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 500.  
Required: No

 ** [ModelNameBeginsWith](#API_ListModels_RequestSyntax) **   <a name="LookoutForEquipment-ListModels-request-ModelNameBeginsWith"></a>
The beginning of the name of the machine learning models being listed.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: No

 ** [NextToken](#API_ListModels_RequestSyntax) **   <a name="LookoutForEquipment-ListModels-request-NextToken"></a>
 An opaque pagination token indicating where to continue the listing of machine learning models.   
Type: String  
Length Constraints: Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}`   
Required: No

 ** [Status](#API_ListModels_RequestSyntax) **   <a name="LookoutForEquipment-ListModels-request-Status"></a>
The status of the machine learning model.   
Type: String  
Valid Values: `IN_PROGRESS | SUCCESS | FAILED | IMPORT_IN_PROGRESS`   
Required: No

## Response Syntax
<a name="API_ListModels_ResponseSyntax"></a>

```
{
   "ModelSummaries": [ 
      { 
         "ActiveModelVersion": number,
         "ActiveModelVersionArn": "string",
         "CreatedAt": number,
         "DatasetArn": "string",
         "DatasetName": "string",
         "LatestScheduledRetrainingModelVersion": number,
         "LatestScheduledRetrainingStartTime": number,
         "LatestScheduledRetrainingStatus": "string",
         "ModelArn": "string",
         "ModelDiagnosticsOutputConfiguration": { 
            "KmsKeyId": "string",
            "S3OutputConfiguration": { 
               "Bucket": "string",
               "Prefix": "string"
            }
         },
         "ModelName": "string",
         "ModelQuality": "string",
         "NextScheduledRetrainingStartDate": number,
         "RetrainingSchedulerStatus": "string",
         "Status": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListModels_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ModelSummaries](#API_ListModels_ResponseSyntax) **   <a name="LookoutForEquipment-ListModels-response-ModelSummaries"></a>
Provides information on the specified model, including created time, model and dataset ARNs, and status.   
Type: Array of [ModelSummary](API_ModelSummary.md) objects

 ** [NextToken](#API_ListModels_ResponseSyntax) **   <a name="LookoutForEquipment-ListModels-response-NextToken"></a>
 An opaque pagination token indicating where to continue the listing of machine learning models.   
Type: String  
Length Constraints: Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}` 

## Errors
<a name="API_ListModels_Errors"></a>

 ** AccessDeniedException **   
The request could not be completed because you do not have access to the resource.   
HTTP Status Code: 400

 ** InternalServerException **   
 Processing of the request has failed because of an unknown error, exception or failure.   
HTTP Status Code: 500

 ** 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
<a name="API_ListModels_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/ListModels) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/ListModels) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/ListModels) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/ListModels) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/ListModels) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/ListModels) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/ListModels) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/ListModels) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/ListModels) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/ListModels) 

# ListModelVersions
<a name="API_ListModelVersions"></a>

Generates a list of all model versions for a given model, including the model version, model version ARN, and status. To list a subset of versions, use the `MaxModelVersion` and `MinModelVersion` fields.

## Request Syntax
<a name="API_ListModelVersions_RequestSyntax"></a>

```
{
   "CreatedAtEndTime": number,
   "CreatedAtStartTime": number,
   "MaxModelVersion": number,
   "MaxResults": number,
   "MinModelVersion": number,
   "ModelName": "string",
   "NextToken": "string",
   "SourceType": "string",
   "Status": "string"
}
```

## Request Parameters
<a name="API_ListModelVersions_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [CreatedAtEndTime](#API_ListModelVersions_RequestSyntax) **   <a name="LookoutForEquipment-ListModelVersions-request-CreatedAtEndTime"></a>
Filter results to return all the model versions created before this time.  
Type: Timestamp  
Required: No

 ** [CreatedAtStartTime](#API_ListModelVersions_RequestSyntax) **   <a name="LookoutForEquipment-ListModelVersions-request-CreatedAtStartTime"></a>
Filter results to return all the model versions created after this time.  
Type: Timestamp  
Required: No

 ** [MaxModelVersion](#API_ListModelVersions_RequestSyntax) **   <a name="LookoutForEquipment-ListModelVersions-request-MaxModelVersion"></a>
Specifies the highest version of the model to return in the list.  
Type: Long  
Valid Range: Minimum value of 1.  
Required: No

 ** [MaxResults](#API_ListModelVersions_RequestSyntax) **   <a name="LookoutForEquipment-ListModelVersions-request-MaxResults"></a>
Specifies the maximum number of machine learning model versions to list.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 500.  
Required: No

 ** [MinModelVersion](#API_ListModelVersions_RequestSyntax) **   <a name="LookoutForEquipment-ListModelVersions-request-MinModelVersion"></a>
Specifies the lowest version of the model to return in the list.  
Type: Long  
Valid Range: Minimum value of 1.  
Required: No

 ** [ModelName](#API_ListModelVersions_RequestSyntax) **   <a name="LookoutForEquipment-ListModelVersions-request-ModelName"></a>
Then name of the machine learning model for which the model versions are to be listed.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: Yes

 ** [NextToken](#API_ListModelVersions_RequestSyntax) **   <a name="LookoutForEquipment-ListModelVersions-request-NextToken"></a>
If the total number of results exceeds the limit that the response can display, the response returns an opaque pagination token indicating where to continue the listing of machine learning model versions. Use this token in the `NextToken` field in the request to list the next page of results.  
Type: String  
Length Constraints: Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}`   
Required: No

 ** [SourceType](#API_ListModelVersions_RequestSyntax) **   <a name="LookoutForEquipment-ListModelVersions-request-SourceType"></a>
Filter the results based on the way the model version was generated.  
Type: String  
Valid Values: `TRAINING | RETRAINING | IMPORT`   
Required: No

 ** [Status](#API_ListModelVersions_RequestSyntax) **   <a name="LookoutForEquipment-ListModelVersions-request-Status"></a>
Filter the results based on the current status of the model version.  
Type: String  
Valid Values: `IN_PROGRESS | SUCCESS | FAILED | IMPORT_IN_PROGRESS | CANCELED`   
Required: No

## Response Syntax
<a name="API_ListModelVersions_ResponseSyntax"></a>

```
{
   "ModelVersionSummaries": [ 
      { 
         "CreatedAt": number,
         "ModelArn": "string",
         "ModelName": "string",
         "ModelQuality": "string",
         "ModelVersion": number,
         "ModelVersionArn": "string",
         "SourceType": "string",
         "Status": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListModelVersions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ModelVersionSummaries](#API_ListModelVersions_ResponseSyntax) **   <a name="LookoutForEquipment-ListModelVersions-response-ModelVersionSummaries"></a>
Provides information on the specified model version, including the created time, model and dataset ARNs, and status.  
If you don't supply the `ModelName` request parameter, or if you supply the name of a model that doesn't exist, `ListModelVersions` returns an empty array in `ModelVersionSummaries`. 
Type: Array of [ModelVersionSummary](API_ModelVersionSummary.md) objects

 ** [NextToken](#API_ListModelVersions_ResponseSyntax) **   <a name="LookoutForEquipment-ListModelVersions-response-NextToken"></a>
If the total number of results exceeds the limit that the response can display, the response returns an opaque pagination token indicating where to continue the listing of machine learning model versions. Use this token in the `NextToken` field in the request to list the next page of results.  
Type: String  
Length Constraints: Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}` 

## Errors
<a name="API_ListModelVersions_Errors"></a>

 ** AccessDeniedException **   
The request could not be completed because you do not have access to the 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.  
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
<a name="API_ListModelVersions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/ListModelVersions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/ListModelVersions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/ListModelVersions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/ListModelVersions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/ListModelVersions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/ListModelVersions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/ListModelVersions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/ListModelVersions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/ListModelVersions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/ListModelVersions) 

# ListRetrainingSchedulers
<a name="API_ListRetrainingSchedulers"></a>

Lists all retraining schedulers in your account, filtering by model name prefix and status. 

## Request Syntax
<a name="API_ListRetrainingSchedulers_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "ModelNameBeginsWith": "string",
   "NextToken": "string",
   "Status": "string"
}
```

## Request Parameters
<a name="API_ListRetrainingSchedulers_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [MaxResults](#API_ListRetrainingSchedulers_RequestSyntax) **   <a name="LookoutForEquipment-ListRetrainingSchedulers-request-MaxResults"></a>
Specifies the maximum number of retraining schedulers to list.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 500.  
Required: No

 ** [ModelNameBeginsWith](#API_ListRetrainingSchedulers_RequestSyntax) **   <a name="LookoutForEquipment-ListRetrainingSchedulers-request-ModelNameBeginsWith"></a>
Specify this field to only list retraining schedulers whose machine learning models begin with the value you specify.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: No

 ** [NextToken](#API_ListRetrainingSchedulers_RequestSyntax) **   <a name="LookoutForEquipment-ListRetrainingSchedulers-request-NextToken"></a>
If the number of results exceeds the maximum, a pagination token is returned. Use the token in the request to show the next page of retraining schedulers.  
Type: String  
Length Constraints: Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}`   
Required: No

 ** [Status](#API_ListRetrainingSchedulers_RequestSyntax) **   <a name="LookoutForEquipment-ListRetrainingSchedulers-request-Status"></a>
Specify this field to only list retraining schedulers whose status matches the value you specify.   
Type: String  
Valid Values: `PENDING | RUNNING | STOPPING | STOPPED`   
Required: No

## Response Syntax
<a name="API_ListRetrainingSchedulers_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "RetrainingSchedulerSummaries": [ 
      { 
         "LookbackWindow": "string",
         "ModelArn": "string",
         "ModelName": "string",
         "RetrainingFrequency": "string",
         "RetrainingStartDate": number,
         "Status": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListRetrainingSchedulers_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListRetrainingSchedulers_ResponseSyntax) **   <a name="LookoutForEquipment-ListRetrainingSchedulers-response-NextToken"></a>
If the number of results exceeds the maximum, this pagination token is returned. Use this token in the request to show the next page of retraining schedulers.  
Type: String  
Length Constraints: Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}` 

 ** [RetrainingSchedulerSummaries](#API_ListRetrainingSchedulers_ResponseSyntax) **   <a name="LookoutForEquipment-ListRetrainingSchedulers-response-RetrainingSchedulerSummaries"></a>
Provides information on the specified retraining scheduler, including the model name, model ARN, status, and start date.   
Type: Array of [RetrainingSchedulerSummary](API_RetrainingSchedulerSummary.md) objects

## Errors
<a name="API_ListRetrainingSchedulers_Errors"></a>

 ** AccessDeniedException **   
The request could not be completed because you do not have access to the resource.   
HTTP Status Code: 400

 ** InternalServerException **   
 Processing of the request has failed because of an unknown error, exception or failure.   
HTTP Status Code: 500

 ** 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
<a name="API_ListRetrainingSchedulers_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/ListRetrainingSchedulers) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/ListRetrainingSchedulers) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/ListRetrainingSchedulers) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/ListRetrainingSchedulers) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/ListRetrainingSchedulers) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/ListRetrainingSchedulers) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/ListRetrainingSchedulers) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/ListRetrainingSchedulers) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/ListRetrainingSchedulers) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/ListRetrainingSchedulers) 

# ListSensorStatistics
<a name="API_ListSensorStatistics"></a>

 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. 

## Request Syntax
<a name="API_ListSensorStatistics_RequestSyntax"></a>

```
{
   "DatasetName": "string",
   "IngestionJobId": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListSensorStatistics_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DatasetName](#API_ListSensorStatistics_RequestSyntax) **   <a name="LookoutForEquipment-ListSensorStatistics-request-DatasetName"></a>
 The name of the dataset associated with the list of Sensor Statistics.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: Yes

 ** [IngestionJobId](#API_ListSensorStatistics_RequestSyntax) **   <a name="LookoutForEquipment-ListSensorStatistics-request-IngestionJobId"></a>
 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.   
Type: String  
Length Constraints: Maximum length of 32.  
Pattern: `[A-Fa-f0-9]{0,32}`   
Required: No

 ** [MaxResults](#API_ListSensorStatistics_RequestSyntax) **   <a name="LookoutForEquipment-ListSensorStatistics-request-MaxResults"></a>
Specifies the maximum number of sensors for which to retrieve statistics.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 500.  
Required: No

 ** [NextToken](#API_ListSensorStatistics_RequestSyntax) **   <a name="LookoutForEquipment-ListSensorStatistics-request-NextToken"></a>
An opaque pagination token indicating where to continue the listing of sensor statistics.   
Type: String  
Length Constraints: Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}`   
Required: No

## Response Syntax
<a name="API_ListSensorStatistics_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "SensorStatisticsSummaries": [ 
      { 
         "CategoricalValues": { 
            "NumberOfCategory": number,
            "Status": "string"
         },
         "ComponentName": "string",
         "DataEndTime": number,
         "DataExists": boolean,
         "DataStartTime": number,
         "DuplicateTimestamps": { 
            "Count": number,
            "Percentage": number
         },
         "InvalidDateEntries": { 
            "Count": number,
            "Percentage": number
         },
         "InvalidValues": { 
            "Count": number,
            "Percentage": number
         },
         "LargeTimestampGaps": { 
            "MaxTimestampGapInDays": number,
            "NumberOfLargeTimestampGaps": number,
            "Status": "string"
         },
         "MissingValues": { 
            "Count": number,
            "Percentage": number
         },
         "MonotonicValues": { 
            "Monotonicity": "string",
            "Status": "string"
         },
         "MultipleOperatingModes": { 
            "Status": "string"
         },
         "SensorName": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListSensorStatistics_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListSensorStatistics_ResponseSyntax) **   <a name="LookoutForEquipment-ListSensorStatistics-response-NextToken"></a>
An opaque pagination token indicating where to continue the listing of sensor statistics.   
Type: String  
Length Constraints: Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}` 

 ** [SensorStatisticsSummaries](#API_ListSensorStatistics_ResponseSyntax) **   <a name="LookoutForEquipment-ListSensorStatistics-response-SensorStatisticsSummaries"></a>
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.   
Type: Array of [SensorStatisticsSummary](API_SensorStatisticsSummary.md) objects

## Errors
<a name="API_ListSensorStatistics_Errors"></a>

 ** AccessDeniedException **   
The request could not be completed because you do not have access to the 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.  
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
<a name="API_ListSensorStatistics_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/ListSensorStatistics) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/ListSensorStatistics) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/ListSensorStatistics) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/ListSensorStatistics) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/ListSensorStatistics) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/ListSensorStatistics) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/ListSensorStatistics) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/ListSensorStatistics) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/ListSensorStatistics) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/ListSensorStatistics) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

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

## Request Syntax
<a name="API_ListTagsForResource_RequestSyntax"></a>

```
{
   "ResourceArn": "string"
}
```

## Request Parameters
<a name="API_ListTagsForResource_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ResourceArn](#API_ListTagsForResource_RequestSyntax) **   <a name="LookoutForEquipment-ListTagsForResource-request-ResourceArn"></a>
The Amazon Resource Name (ARN) of the resource (such as the dataset or model) that is the focus of the `ListTagsForResource` operation.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Required: Yes

## Response Syntax
<a name="API_ListTagsForResource_ResponseSyntax"></a>

```
{
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListTagsForResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="LookoutForEquipment-ListTagsForResource-response-Tags"></a>
 Any tags associated with the resource.   
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.

## Errors
<a name="API_ListTagsForResource_Errors"></a>

 ** AccessDeniedException **   
The request could not be completed because you do not have access to the 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.  
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
<a name="API_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/ListTagsForResource) 

# PutResourcePolicy
<a name="API_PutResourcePolicy"></a>

Creates a resource control policy for a given resource.

## Request Syntax
<a name="API_PutResourcePolicy_RequestSyntax"></a>

```
{
   "ClientToken": "string",
   "PolicyRevisionId": "string",
   "ResourceArn": "string",
   "ResourcePolicy": "string"
}
```

## Request Parameters
<a name="API_PutResourcePolicy_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_PutResourcePolicy_RequestSyntax) **   <a name="LookoutForEquipment-PutResourcePolicy-request-ClientToken"></a>
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

 ** [PolicyRevisionId](#API_PutResourcePolicy_RequestSyntax) **   <a name="LookoutForEquipment-PutResourcePolicy-request-PolicyRevisionId"></a>
A unique identifier for a revision of the resource policy.  
Type: String  
Length Constraints: Maximum length of 50.  
Pattern: `[0-9A-Fa-f]+`   
Required: No

 ** [ResourceArn](#API_PutResourcePolicy_RequestSyntax) **   <a name="LookoutForEquipment-PutResourcePolicy-request-ResourceArn"></a>
The Amazon Resource Name (ARN) of the resource for which the policy is 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}:.+`   
Required: Yes

 ** [ResourcePolicy](#API_PutResourcePolicy_RequestSyntax) **   <a name="LookoutForEquipment-PutResourcePolicy-request-ResourcePolicy"></a>
The JSON-formatted resource policy to create.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20000.  
Pattern: `[\u0009\u000A\u000D\u0020-\u00FF]+`   
Required: Yes

## Response Syntax
<a name="API_PutResourcePolicy_ResponseSyntax"></a>

```
{
   "PolicyRevisionId": "string",
   "ResourceArn": "string"
}
```

## Response Elements
<a name="API_PutResourcePolicy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [PolicyRevisionId](#API_PutResourcePolicy_ResponseSyntax) **   <a name="LookoutForEquipment-PutResourcePolicy-response-PolicyRevisionId"></a>
A unique identifier for a revision of the resource policy.  
Type: String  
Length Constraints: Maximum length of 50.  
Pattern: `[0-9A-Fa-f]+` 

 ** [ResourceArn](#API_PutResourcePolicy_ResponseSyntax) **   <a name="LookoutForEquipment-PutResourcePolicy-response-ResourceArn"></a>
The Amazon Resource Name (ARN) of the resource for which the policy was created.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:.+` 

## Errors
<a name="API_PutResourcePolicy_Errors"></a>

 ** 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.   
HTTP Status Code: 400

## See Also
<a name="API_PutResourcePolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/PutResourcePolicy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/PutResourcePolicy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/PutResourcePolicy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/PutResourcePolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/PutResourcePolicy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/PutResourcePolicy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/PutResourcePolicy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/PutResourcePolicy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/PutResourcePolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/PutResourcePolicy) 

# StartDataIngestionJob
<a name="API_StartDataIngestionJob"></a>

Starts a data ingestion job. Amazon Lookout for Equipment returns the job status. 

## Request Syntax
<a name="API_StartDataIngestionJob_RequestSyntax"></a>

```
{
   "ClientToken": "string",
   "DatasetName": "string",
   "IngestionInputConfiguration": { 
      "S3InputConfiguration": { 
         "Bucket": "string",
         "KeyPattern": "string",
         "Prefix": "string"
      }
   },
   "RoleArn": "string"
}
```

## Request Parameters
<a name="API_StartDataIngestionJob_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_StartDataIngestionJob_RequestSyntax) **   <a name="LookoutForEquipment-StartDataIngestionJob-request-ClientToken"></a>
 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

 ** [DatasetName](#API_StartDataIngestionJob_RequestSyntax) **   <a name="LookoutForEquipment-StartDataIngestionJob-request-DatasetName"></a>
The name of the dataset being used by the data ingestion job.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: Yes

 ** [IngestionInputConfiguration](#API_StartDataIngestionJob_RequestSyntax) **   <a name="LookoutForEquipment-StartDataIngestionJob-request-IngestionInputConfiguration"></a>
 Specifies information for the input data for the data ingestion job, including dataset S3 location.   
Type: [IngestionInputConfiguration](API_IngestionInputConfiguration.md) object  
Required: Yes

 ** [RoleArn](#API_StartDataIngestionJob_RequestSyntax) **   <a name="LookoutForEquipment-StartDataIngestionJob-request-RoleArn"></a>
 The Amazon Resource Name (ARN) of a role with permission to access the data source for the data ingestion job.   
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+`   
Required: Yes

## Response Syntax
<a name="API_StartDataIngestionJob_ResponseSyntax"></a>

```
{
   "JobId": "string",
   "Status": "string"
}
```

## Response Elements
<a name="API_StartDataIngestionJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [JobId](#API_StartDataIngestionJob_ResponseSyntax) **   <a name="LookoutForEquipment-StartDataIngestionJob-response-JobId"></a>
Indicates the job ID of the data ingestion job.   
Type: String  
Length Constraints: Maximum length of 32.  
Pattern: `[A-Fa-f0-9]{0,32}` 

 ** [Status](#API_StartDataIngestionJob_ResponseSyntax) **   <a name="LookoutForEquipment-StartDataIngestionJob-response-Status"></a>
Indicates the status of the `StartDataIngestionJob` operation.   
Type: String  
Valid Values: `IN_PROGRESS | SUCCESS | FAILED | IMPORT_IN_PROGRESS` 

## Errors
<a name="API_StartDataIngestionJob_Errors"></a>

 ** 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.   
HTTP Status Code: 400

## See Also
<a name="API_StartDataIngestionJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/StartDataIngestionJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/StartDataIngestionJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/StartDataIngestionJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/StartDataIngestionJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/StartDataIngestionJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/StartDataIngestionJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/StartDataIngestionJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/StartDataIngestionJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/StartDataIngestionJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/StartDataIngestionJob) 

# StartInferenceScheduler
<a name="API_StartInferenceScheduler"></a>

Starts an inference scheduler. 

## Request Syntax
<a name="API_StartInferenceScheduler_RequestSyntax"></a>

```
{
   "InferenceSchedulerName": "string"
}
```

## Request Parameters
<a name="API_StartInferenceScheduler_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [InferenceSchedulerName](#API_StartInferenceScheduler_RequestSyntax) **   <a name="LookoutForEquipment-StartInferenceScheduler-request-InferenceSchedulerName"></a>
The name of the inference scheduler to be started.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: Yes

## Response Syntax
<a name="API_StartInferenceScheduler_ResponseSyntax"></a>

```
{
   "InferenceSchedulerArn": "string",
   "InferenceSchedulerName": "string",
   "ModelArn": "string",
   "ModelName": "string",
   "Status": "string"
}
```

## Response Elements
<a name="API_StartInferenceScheduler_ResponseElements"></a>

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](#API_StartInferenceScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-StartInferenceScheduler-response-InferenceSchedulerArn"></a>
The Amazon Resource Name (ARN) of the inference scheduler being started.   
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:inference-scheduler\/.+` 

 ** [InferenceSchedulerName](#API_StartInferenceScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-StartInferenceScheduler-response-InferenceSchedulerName"></a>
The name of the inference scheduler being started.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$` 

 ** [ModelArn](#API_StartInferenceScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-StartInferenceScheduler-response-ModelArn"></a>
The Amazon Resource Name (ARN) of the machine learning model being used by the inference scheduler.   
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:model\/.+` 

 ** [ModelName](#API_StartInferenceScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-StartInferenceScheduler-response-ModelName"></a>
The name of the machine learning model being used by the inference scheduler.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$` 

 ** [Status](#API_StartInferenceScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-StartInferenceScheduler-response-Status"></a>
Indicates the status of the inference scheduler.   
Type: String  
Valid Values: `PENDING | RUNNING | STOPPING | STOPPED` 

## Errors
<a name="API_StartInferenceScheduler_Errors"></a>

 ** 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.  
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
<a name="API_StartInferenceScheduler_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/StartInferenceScheduler) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/StartInferenceScheduler) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/StartInferenceScheduler) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/StartInferenceScheduler) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/StartInferenceScheduler) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/StartInferenceScheduler) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/StartInferenceScheduler) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/StartInferenceScheduler) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/StartInferenceScheduler) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/StartInferenceScheduler) 

# StartRetrainingScheduler
<a name="API_StartRetrainingScheduler"></a>

Starts a retraining scheduler. 

## Request Syntax
<a name="API_StartRetrainingScheduler_RequestSyntax"></a>

```
{
   "ModelName": "string"
}
```

## Request Parameters
<a name="API_StartRetrainingScheduler_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ModelName](#API_StartRetrainingScheduler_RequestSyntax) **   <a name="LookoutForEquipment-StartRetrainingScheduler-request-ModelName"></a>
The name of the model whose retraining scheduler you want to start.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: Yes

## Response Syntax
<a name="API_StartRetrainingScheduler_ResponseSyntax"></a>

```
{
   "ModelArn": "string",
   "ModelName": "string",
   "Status": "string"
}
```

## Response Elements
<a name="API_StartRetrainingScheduler_ResponseElements"></a>

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](#API_StartRetrainingScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-StartRetrainingScheduler-response-ModelArn"></a>
The ARN of the model whose retraining scheduler is being started.   
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:model\/.+` 

 ** [ModelName](#API_StartRetrainingScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-StartRetrainingScheduler-response-ModelName"></a>
The name of the model whose retraining scheduler is being started.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$` 

 ** [Status](#API_StartRetrainingScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-StartRetrainingScheduler-response-Status"></a>
The status of the retraining scheduler.   
Type: String  
Valid Values: `PENDING | RUNNING | STOPPING | STOPPED` 

## Errors
<a name="API_StartRetrainingScheduler_Errors"></a>

 ** 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.  
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
<a name="API_StartRetrainingScheduler_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/StartRetrainingScheduler) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/StartRetrainingScheduler) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/StartRetrainingScheduler) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/StartRetrainingScheduler) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/StartRetrainingScheduler) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/StartRetrainingScheduler) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/StartRetrainingScheduler) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/StartRetrainingScheduler) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/StartRetrainingScheduler) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/StartRetrainingScheduler) 

# StopInferenceScheduler
<a name="API_StopInferenceScheduler"></a>

Stops an inference scheduler. 

## Request Syntax
<a name="API_StopInferenceScheduler_RequestSyntax"></a>

```
{
   "InferenceSchedulerName": "string"
}
```

## Request Parameters
<a name="API_StopInferenceScheduler_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [InferenceSchedulerName](#API_StopInferenceScheduler_RequestSyntax) **   <a name="LookoutForEquipment-StopInferenceScheduler-request-InferenceSchedulerName"></a>
The name of the inference scheduler to be stopped.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: Yes

## Response Syntax
<a name="API_StopInferenceScheduler_ResponseSyntax"></a>

```
{
   "InferenceSchedulerArn": "string",
   "InferenceSchedulerName": "string",
   "ModelArn": "string",
   "ModelName": "string",
   "Status": "string"
}
```

## Response Elements
<a name="API_StopInferenceScheduler_ResponseElements"></a>

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](#API_StopInferenceScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-StopInferenceScheduler-response-InferenceSchedulerArn"></a>
The Amazon Resource Name (ARN) of the inference schedule being stopped.   
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:inference-scheduler\/.+` 

 ** [InferenceSchedulerName](#API_StopInferenceScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-StopInferenceScheduler-response-InferenceSchedulerName"></a>
The name of the inference scheduler being stopped.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$` 

 ** [ModelArn](#API_StopInferenceScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-StopInferenceScheduler-response-ModelArn"></a>
The Amazon Resource Name (ARN) of the machine learning model used by the inference scheduler being stopped.   
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:model\/.+` 

 ** [ModelName](#API_StopInferenceScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-StopInferenceScheduler-response-ModelName"></a>
The name of the machine learning model used by the inference scheduler being stopped.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$` 

 ** [Status](#API_StopInferenceScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-StopInferenceScheduler-response-Status"></a>
Indicates the status of the inference scheduler.   
Type: String  
Valid Values: `PENDING | RUNNING | STOPPING | STOPPED` 

## Errors
<a name="API_StopInferenceScheduler_Errors"></a>

 ** 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.  
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
<a name="API_StopInferenceScheduler_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/StopInferenceScheduler) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/StopInferenceScheduler) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/StopInferenceScheduler) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/StopInferenceScheduler) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/StopInferenceScheduler) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/StopInferenceScheduler) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/StopInferenceScheduler) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/StopInferenceScheduler) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/StopInferenceScheduler) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/StopInferenceScheduler) 

# StopRetrainingScheduler
<a name="API_StopRetrainingScheduler"></a>

Stops a retraining scheduler. 

## Request Syntax
<a name="API_StopRetrainingScheduler_RequestSyntax"></a>

```
{
   "ModelName": "string"
}
```

## Request Parameters
<a name="API_StopRetrainingScheduler_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ModelName](#API_StopRetrainingScheduler_RequestSyntax) **   <a name="LookoutForEquipment-StopRetrainingScheduler-request-ModelName"></a>
The name of the model whose retraining scheduler you want to stop.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: Yes

## Response Syntax
<a name="API_StopRetrainingScheduler_ResponseSyntax"></a>

```
{
   "ModelArn": "string",
   "ModelName": "string",
   "Status": "string"
}
```

## Response Elements
<a name="API_StopRetrainingScheduler_ResponseElements"></a>

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](#API_StopRetrainingScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-StopRetrainingScheduler-response-ModelArn"></a>
The ARN of the model whose retraining scheduler is being stopped.   
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:model\/.+` 

 ** [ModelName](#API_StopRetrainingScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-StopRetrainingScheduler-response-ModelName"></a>
The name of the model whose retraining scheduler is being stopped.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$` 

 ** [Status](#API_StopRetrainingScheduler_ResponseSyntax) **   <a name="LookoutForEquipment-StopRetrainingScheduler-response-Status"></a>
The status of the retraining scheduler.   
Type: String  
Valid Values: `PENDING | RUNNING | STOPPING | STOPPED` 

## Errors
<a name="API_StopRetrainingScheduler_Errors"></a>

 ** 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.  
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
<a name="API_StopRetrainingScheduler_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/StopRetrainingScheduler) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/StopRetrainingScheduler) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/StopRetrainingScheduler) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/StopRetrainingScheduler) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/StopRetrainingScheduler) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/StopRetrainingScheduler) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/StopRetrainingScheduler) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/StopRetrainingScheduler) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/StopRetrainingScheduler) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/StopRetrainingScheduler) 

# TagResource
<a name="API_TagResource"></a>

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. 

## Request Syntax
<a name="API_TagResource_RequestSyntax"></a>

```
{
   "ResourceArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_TagResource_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ResourceArn](#API_TagResource_RequestSyntax) **   <a name="LookoutForEquipment-TagResource-request-ResourceArn"></a>
The Amazon Resource Name (ARN) of the specific resource to which the tag should be associated.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Required: Yes

 ** [Tags](#API_TagResource_RequestSyntax) **   <a name="LookoutForEquipment-TagResource-request-Tags"></a>
The tag or tags to be associated with a specific resource. Both the tag key and value are specified.   
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: Yes

## Response Elements
<a name="API_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_TagResource_Errors"></a>

 ** AccessDeniedException **   
The request could not be completed because you do not have access to the 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.   
HTTP Status Code: 400

## See Also
<a name="API_TagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/TagResource) 

# UntagResource
<a name="API_UntagResource"></a>

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

## Request Syntax
<a name="API_UntagResource_RequestSyntax"></a>

```
{
   "ResourceArn": "string",
   "TagKeys": [ "string" ]
}
```

## Request Parameters
<a name="API_UntagResource_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ResourceArn](#API_UntagResource_RequestSyntax) **   <a name="LookoutForEquipment-UntagResource-request-ResourceArn"></a>
The Amazon Resource Name (ARN) of the resource to which the tag is currently associated.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Required: Yes

 ** [TagKeys](#API_UntagResource_RequestSyntax) **   <a name="LookoutForEquipment-UntagResource-request-TagKeys"></a>
Specifies the key of the tag to be removed from a specified resource.   
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Required: Yes

## Response Elements
<a name="API_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UntagResource_Errors"></a>

 ** AccessDeniedException **   
The request could not be completed because you do not have access to the 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.  
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
<a name="API_UntagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/UntagResource) 

# UpdateActiveModelVersion
<a name="API_UpdateActiveModelVersion"></a>

Sets the active model version for a given machine learning model.

## Request Syntax
<a name="API_UpdateActiveModelVersion_RequestSyntax"></a>

```
{
   "ModelName": "string",
   "ModelVersion": number
}
```

## Request Parameters
<a name="API_UpdateActiveModelVersion_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ModelName](#API_UpdateActiveModelVersion_RequestSyntax) **   <a name="LookoutForEquipment-UpdateActiveModelVersion-request-ModelName"></a>
The name of the machine learning model for which the active model version is being set.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: Yes

 ** [ModelVersion](#API_UpdateActiveModelVersion_RequestSyntax) **   <a name="LookoutForEquipment-UpdateActiveModelVersion-request-ModelVersion"></a>
The version of the machine learning model for which the active model version is being set.  
Type: Long  
Valid Range: Minimum value of 1.  
Required: Yes

## Response Syntax
<a name="API_UpdateActiveModelVersion_ResponseSyntax"></a>

```
{
   "CurrentActiveVersion": number,
   "CurrentActiveVersionArn": "string",
   "ModelArn": "string",
   "ModelName": "string",
   "PreviousActiveVersion": number,
   "PreviousActiveVersionArn": "string"
}
```

## Response Elements
<a name="API_UpdateActiveModelVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CurrentActiveVersion](#API_UpdateActiveModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-UpdateActiveModelVersion-response-CurrentActiveVersion"></a>
The version that is currently active of the machine learning model for which the active model version was set.  
Type: Long  
Valid Range: Minimum value of 1.

 ** [CurrentActiveVersionArn](#API_UpdateActiveModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-UpdateActiveModelVersion-response-CurrentActiveVersionArn"></a>
The Amazon Resource Name (ARN) of the machine learning model version that is the current active model version.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:model\/[0-9a-zA-Z_-]{1,200}\/.+\/model-version\/[0-9]{1,}$` 

 ** [ModelArn](#API_UpdateActiveModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-UpdateActiveModelVersion-response-ModelArn"></a>
The Amazon Resource Name (ARN) of the machine learning model for which the active model version was set.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:model\/.+` 

 ** [ModelName](#API_UpdateActiveModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-UpdateActiveModelVersion-response-ModelName"></a>
The name of the machine learning model for which the active model version was set.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$` 

 ** [PreviousActiveVersion](#API_UpdateActiveModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-UpdateActiveModelVersion-response-PreviousActiveVersion"></a>
The previous version that was active of the machine learning model for which the active model version was set.  
Type: Long  
Valid Range: Minimum value of 1.

 ** [PreviousActiveVersionArn](#API_UpdateActiveModelVersion_ResponseSyntax) **   <a name="LookoutForEquipment-UpdateActiveModelVersion-response-PreviousActiveVersionArn"></a>
The Amazon Resource Name (ARN) of the machine learning model version that was the previous active model version.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:model\/[0-9a-zA-Z_-]{1,200}\/.+\/model-version\/[0-9]{1,}$` 

## Errors
<a name="API_UpdateActiveModelVersion_Errors"></a>

 ** 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.  
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
<a name="API_UpdateActiveModelVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/UpdateActiveModelVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/UpdateActiveModelVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/UpdateActiveModelVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/UpdateActiveModelVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/UpdateActiveModelVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/UpdateActiveModelVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/UpdateActiveModelVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/UpdateActiveModelVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/UpdateActiveModelVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/UpdateActiveModelVersion) 

# UpdateInferenceScheduler
<a name="API_UpdateInferenceScheduler"></a>

Updates an inference scheduler. 

## Request Syntax
<a name="API_UpdateInferenceScheduler_RequestSyntax"></a>

```
{
   "DataDelayOffsetInMinutes": number,
   "DataInputConfiguration": { 
      "InferenceInputNameConfiguration": { 
         "ComponentTimestampDelimiter": "string",
         "TimestampFormat": "string"
      },
      "InputTimeZoneOffset": "string",
      "S3InputConfiguration": { 
         "Bucket": "string",
         "Prefix": "string"
      }
   },
   "DataOutputConfiguration": { 
      "KmsKeyId": "string",
      "S3OutputConfiguration": { 
         "Bucket": "string",
         "Prefix": "string"
      }
   },
   "DataUploadFrequency": "string",
   "InferenceSchedulerName": "string",
   "RoleArn": "string"
}
```

## Request Parameters
<a name="API_UpdateInferenceScheduler_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DataDelayOffsetInMinutes](#API_UpdateInferenceScheduler_RequestSyntax) **   <a name="LookoutForEquipment-UpdateInferenceScheduler-request-DataDelayOffsetInMinutes"></a>
 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](#API_UpdateInferenceScheduler_RequestSyntax) **   <a name="LookoutForEquipment-UpdateInferenceScheduler-request-DataInputConfiguration"></a>
 Specifies information for the input data for the inference scheduler, including delimiter, format, and dataset location.   
Type: [InferenceInputConfiguration](API_InferenceInputConfiguration.md) object  
Required: No

 ** [DataOutputConfiguration](#API_UpdateInferenceScheduler_RequestSyntax) **   <a name="LookoutForEquipment-UpdateInferenceScheduler-request-DataOutputConfiguration"></a>
 Specifies information for the output results from the inference scheduler, including the output S3 location.   
Type: [InferenceOutputConfiguration](API_InferenceOutputConfiguration.md) object  
Required: No

 ** [DataUploadFrequency](#API_UpdateInferenceScheduler_RequestSyntax) **   <a name="LookoutForEquipment-UpdateInferenceScheduler-request-DataUploadFrequency"></a>
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: No

 ** [InferenceSchedulerName](#API_UpdateInferenceScheduler_RequestSyntax) **   <a name="LookoutForEquipment-UpdateInferenceScheduler-request-InferenceSchedulerName"></a>
The name of the inference scheduler to be updated.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: Yes

 ** [RoleArn](#API_UpdateInferenceScheduler_RequestSyntax) **   <a name="LookoutForEquipment-UpdateInferenceScheduler-request-RoleArn"></a>
 The Amazon Resource Name (ARN) of a role with permission to access the data source for the inference scheduler.   
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+`   
Required: No

## Response Elements
<a name="API_UpdateInferenceScheduler_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateInferenceScheduler_Errors"></a>

 ** 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.  
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
<a name="API_UpdateInferenceScheduler_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/UpdateInferenceScheduler) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/UpdateInferenceScheduler) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/UpdateInferenceScheduler) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/UpdateInferenceScheduler) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/UpdateInferenceScheduler) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/UpdateInferenceScheduler) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/UpdateInferenceScheduler) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/UpdateInferenceScheduler) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/UpdateInferenceScheduler) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/UpdateInferenceScheduler) 

# UpdateLabelGroup
<a name="API_UpdateLabelGroup"></a>

 Updates the label group. 

## Request Syntax
<a name="API_UpdateLabelGroup_RequestSyntax"></a>

```
{
   "FaultCodes": [ "string" ],
   "LabelGroupName": "string"
}
```

## Request Parameters
<a name="API_UpdateLabelGroup_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [FaultCodes](#API_UpdateLabelGroup_RequestSyntax) **   <a name="LookoutForEquipment-UpdateLabelGroup-request-FaultCodes"></a>
 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.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[\P{M}\p{M}]{1,100}`   
Required: No

 ** [LabelGroupName](#API_UpdateLabelGroup_RequestSyntax) **   <a name="LookoutForEquipment-UpdateLabelGroup-request-LabelGroupName"></a>
 The name of the label group to be updated.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: Yes

## Response Elements
<a name="API_UpdateLabelGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateLabelGroup_Errors"></a>

 ** 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.  
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
<a name="API_UpdateLabelGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/UpdateLabelGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/UpdateLabelGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/UpdateLabelGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/UpdateLabelGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/UpdateLabelGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/UpdateLabelGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/UpdateLabelGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/UpdateLabelGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/UpdateLabelGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/UpdateLabelGroup) 

# UpdateModel
<a name="API_UpdateModel"></a>

Updates a model in the account.

## Request Syntax
<a name="API_UpdateModel_RequestSyntax"></a>

```
{
   "LabelsInputConfiguration": { 
      "LabelGroupName": "string",
      "S3InputConfiguration": { 
         "Bucket": "string",
         "Prefix": "string"
      }
   },
   "ModelDiagnosticsOutputConfiguration": { 
      "KmsKeyId": "string",
      "S3OutputConfiguration": { 
         "Bucket": "string",
         "Prefix": "string"
      }
   },
   "ModelName": "string",
   "RoleArn": "string"
}
```

## Request Parameters
<a name="API_UpdateModel_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [LabelsInputConfiguration](#API_UpdateModel_RequestSyntax) **   <a name="LookoutForEquipment-UpdateModel-request-LabelsInputConfiguration"></a>
Contains the configuration information for the S3 location being used to hold label data.   
Type: [LabelsInputConfiguration](API_LabelsInputConfiguration.md) object  
Required: No

 ** [ModelDiagnosticsOutputConfiguration](#API_UpdateModel_RequestSyntax) **   <a name="LookoutForEquipment-UpdateModel-request-ModelDiagnosticsOutputConfiguration"></a>
The Amazon S3 location where you want Amazon Lookout for Equipment to save the pointwise model diagnostics for the model. You must also specify the `RoleArn` request parameter.  
Type: [ModelDiagnosticsOutputConfiguration](API_ModelDiagnosticsOutputConfiguration.md) object  
Required: No

 ** [ModelName](#API_UpdateModel_RequestSyntax) **   <a name="LookoutForEquipment-UpdateModel-request-ModelName"></a>
The name of the model to update.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: Yes

 ** [RoleArn](#API_UpdateModel_RequestSyntax) **   <a name="LookoutForEquipment-UpdateModel-request-RoleArn"></a>
The ARN of the model to update.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+`   
Required: No

## Response Elements
<a name="API_UpdateModel_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateModel_Errors"></a>

 ** 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.  
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
<a name="API_UpdateModel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/UpdateModel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/UpdateModel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/UpdateModel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/UpdateModel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/UpdateModel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/UpdateModel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/UpdateModel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/UpdateModel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/UpdateModel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/UpdateModel) 

# UpdateRetrainingScheduler
<a name="API_UpdateRetrainingScheduler"></a>

Updates a retraining scheduler. 

## Request Syntax
<a name="API_UpdateRetrainingScheduler_RequestSyntax"></a>

```
{
   "LookbackWindow": "string",
   "ModelName": "string",
   "PromoteMode": "string",
   "RetrainingFrequency": "string",
   "RetrainingStartDate": number
}
```

## Request Parameters
<a name="API_UpdateRetrainingScheduler_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [LookbackWindow](#API_UpdateRetrainingScheduler_RequestSyntax) **   <a name="LookoutForEquipment-UpdateRetrainingScheduler-request-LookbackWindow"></a>
The number of past days of data that will be used for retraining.  
Type: String  
Pattern: `^P180D$|^P360D$|^P540D$|^P720D$`   
Required: No

 ** [ModelName](#API_UpdateRetrainingScheduler_RequestSyntax) **   <a name="LookoutForEquipment-UpdateRetrainingScheduler-request-ModelName"></a>
The name of the model whose retraining scheduler you want to update.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z_-]{1,200}$`   
Required: Yes

 ** [PromoteMode](#API_UpdateRetrainingScheduler_RequestSyntax) **   <a name="LookoutForEquipment-UpdateRetrainingScheduler-request-PromoteMode"></a>
Indicates how the service will use new models. In `MANAGED` mode, new models will automatically be used for inference if they have better performance than the current model. In `MANUAL` mode, the new models will not be used [until they are manually activated](https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/versioning-model.html#model-activation).  
Type: String  
Valid Values: `MANAGED | MANUAL`   
Required: No

 ** [RetrainingFrequency](#API_UpdateRetrainingScheduler_RequestSyntax) **   <a name="LookoutForEquipment-UpdateRetrainingScheduler-request-RetrainingFrequency"></a>
This parameter uses the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) standard to set the frequency at which you want retraining to occur in terms of Years, Months, and/or Days (note: other parameters like Time are not currently supported). The minimum value is 30 days (P30D) and the maximum value is 1 year (P1Y). For example, the following values are valid:  
+ P3M15D – Every 3 months and 15 days
+ P2M – Every 2 months
+ P150D – Every 150 days
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10.  
Pattern: `^P(\dY)?(\d{1,2}M)?(\d{1,3}D)?$`   
Required: No

 ** [RetrainingStartDate](#API_UpdateRetrainingScheduler_RequestSyntax) **   <a name="LookoutForEquipment-UpdateRetrainingScheduler-request-RetrainingStartDate"></a>
The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the nearest UTC day.  
Type: Timestamp  
Required: No

## Response Elements
<a name="API_UpdateRetrainingScheduler_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateRetrainingScheduler_Errors"></a>

 ** 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.  
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
<a name="API_UpdateRetrainingScheduler_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lookoutequipment-2020-12-15/UpdateRetrainingScheduler) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lookoutequipment-2020-12-15/UpdateRetrainingScheduler) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lookoutequipment-2020-12-15/UpdateRetrainingScheduler) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lookoutequipment-2020-12-15/UpdateRetrainingScheduler) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lookoutequipment-2020-12-15/UpdateRetrainingScheduler) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lookoutequipment-2020-12-15/UpdateRetrainingScheduler) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lookoutequipment-2020-12-15/UpdateRetrainingScheduler) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lookoutequipment-2020-12-15/UpdateRetrainingScheduler) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lookoutequipment-2020-12-15/UpdateRetrainingScheduler) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lookoutequipment-2020-12-15/UpdateRetrainingScheduler)