@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Amazon Lookout for Equipment
@version 2020-12-15
@auth AWS SigV4
@endpoints 49
@hint download_for_search
@toc root(49)

@endpoint POST /
@required {DatasetName: str, ClientToken: str}
@optional {DatasetSchema: DatasetSchema, ServerSideKmsKeyId: str, Tags: [Tag]}
@returns(200) {DatasetName: str?, DatasetArn: str?, Status: str?}

@endpoint POST /
@required {ModelName: str, InferenceSchedulerName: str, DataUploadFrequency: str, DataInputConfiguration: InferenceInputConfiguration, DataOutputConfiguration: InferenceOutputConfiguration, RoleArn: str, ClientToken: str}
@optional {DataDelayOffsetInMinutes: int(i64), ServerSideKmsKeyId: str, Tags: [Tag]}
@returns(200) {InferenceSchedulerArn: str?, InferenceSchedulerName: str?, Status: str?, ModelQuality: str?}

@endpoint POST /
@required {LabelGroupName: str, StartTime: str(timestamp), EndTime: str(timestamp), Rating: str, ClientToken: str}
@optional {FaultCode: str, Notes: str, Equipment: str}
@returns(200) {LabelId: str?}

@endpoint POST /
@required {LabelGroupName: str, ClientToken: str}
@optional {FaultCodes: [str], Tags: [Tag]}
@returns(200) {LabelGroupName: str?, LabelGroupArn: str?}

@endpoint POST /
@required {ModelName: str, DatasetName: str, ClientToken: str}
@optional {DatasetSchema: DatasetSchema, LabelsInputConfiguration: LabelsInputConfiguration, TrainingDataStartTime: str(timestamp), TrainingDataEndTime: str(timestamp), EvaluationDataStartTime: str(timestamp), EvaluationDataEndTime: str(timestamp), RoleArn: str, DataPreProcessingConfiguration: DataPreProcessingConfiguration, ServerSideKmsKeyId: str, Tags: [Tag], OffCondition: str, ModelDiagnosticsOutputConfiguration: ModelDiagnosticsOutputConfiguration}
@returns(200) {ModelArn: str?, Status: str?}

@endpoint POST /
@required {ModelName: str, RetrainingFrequency: str, LookbackWindow: str, ClientToken: str}
@optional {RetrainingStartDate: str(timestamp), PromoteMode: str}
@returns(200) {ModelName: str?, ModelArn: str?, Status: str?}

@endpoint POST /
@required {DatasetName: str}

@endpoint POST /
@required {InferenceSchedulerName: str}

@endpoint POST /
@required {LabelGroupName: str, LabelId: str}

@endpoint POST /
@required {LabelGroupName: str}

@endpoint POST /
@required {ModelName: str}

@endpoint POST /
@required {ResourceArn: str}

@endpoint POST /
@required {ModelName: str}

@endpoint POST /
@required {JobId: str}
@returns(200) {JobId: str?, DatasetArn: str?, IngestionInputConfiguration: IngestionInputConfiguration?{S3InputConfiguration: IngestionS3InputConfiguration{Bucket: str, Prefix: str?, KeyPattern: str?}}, RoleArn: str?, CreatedAt: str(timestamp)?, Status: str?, FailedReason: str?, DataQualitySummary: DataQualitySummary?{InsufficientSensorData: InsufficientSensorData{MissingCompleteSensorData: MissingCompleteSensorData{AffectedSensorCount: int}, SensorsWithShortDateRange: SensorsWithShortDateRange{AffectedSensorCount: int}}, MissingSensorData: MissingSensorData{AffectedSensorCount: int, TotalNumberOfMissingValues: int}, InvalidSensorData: InvalidSensorData{AffectedSensorCount: int, TotalNumberOfInvalidValues: int}, UnsupportedTimestamps: UnsupportedTimestamps{TotalNumberOfUnsupportedTimestamps: int}, DuplicateTimestamps: DuplicateTimestamps{TotalNumberOfDuplicateTimestamps: int}}, IngestedFilesSummary: IngestedFilesSummary?{TotalNumberOfFiles: int, IngestedNumberOfFiles: int, DiscardedFiles: [S3Object]?}, StatusDetail: str?, IngestedDataSize: int(i64)?, DataStartTime: str(timestamp)?, DataEndTime: str(timestamp)?, SourceDatasetArn: str?}

@endpoint POST /
@required {DatasetName: str}
@returns(200) {DatasetName: str?, DatasetArn: str?, CreatedAt: str(timestamp)?, LastUpdatedAt: str(timestamp)?, Status: str?, Schema: str?, ServerSideKmsKeyId: str?, IngestionInputConfiguration: IngestionInputConfiguration?{S3InputConfiguration: IngestionS3InputConfiguration{Bucket: str, Prefix: str?, KeyPattern: str?}}, DataQualitySummary: DataQualitySummary?{InsufficientSensorData: InsufficientSensorData{MissingCompleteSensorData: MissingCompleteSensorData{AffectedSensorCount: int}, SensorsWithShortDateRange: SensorsWithShortDateRange{AffectedSensorCount: int}}, MissingSensorData: MissingSensorData{AffectedSensorCount: int, TotalNumberOfMissingValues: int}, InvalidSensorData: InvalidSensorData{AffectedSensorCount: int, TotalNumberOfInvalidValues: int}, UnsupportedTimestamps: UnsupportedTimestamps{TotalNumberOfUnsupportedTimestamps: int}, DuplicateTimestamps: DuplicateTimestamps{TotalNumberOfDuplicateTimestamps: int}}, IngestedFilesSummary: IngestedFilesSummary?{TotalNumberOfFiles: int, IngestedNumberOfFiles: int, DiscardedFiles: [S3Object]?}, RoleArn: str?, DataStartTime: str(timestamp)?, DataEndTime: str(timestamp)?, SourceDatasetArn: str?}

@endpoint POST /
@required {InferenceSchedulerName: str}
@returns(200) {ModelArn: str?, ModelName: str?, InferenceSchedulerName: str?, InferenceSchedulerArn: str?, Status: str?, DataDelayOffsetInMinutes: int(i64)?, DataUploadFrequency: str?, CreatedAt: str(timestamp)?, UpdatedAt: str(timestamp)?, DataInputConfiguration: InferenceInputConfiguration?{S3InputConfiguration: InferenceS3InputConfiguration?{Bucket: str, Prefix: str?}, InputTimeZoneOffset: str?, InferenceInputNameConfiguration: InferenceInputNameConfiguration?{TimestampFormat: str?, ComponentTimestampDelimiter: str?}}, DataOutputConfiguration: InferenceOutputConfiguration?{S3OutputConfiguration: InferenceS3OutputConfiguration{Bucket: str, Prefix: str?}, KmsKeyId: str?}, RoleArn: str?, ServerSideKmsKeyId: str?, LatestInferenceResult: str?}

@endpoint POST /
@required {LabelGroupName: str, LabelId: str}
@returns(200) {LabelGroupName: str?, LabelGroupArn: str?, LabelId: str?, StartTime: str(timestamp)?, EndTime: str(timestamp)?, Rating: str?, FaultCode: str?, Notes: str?, Equipment: str?, CreatedAt: str(timestamp)?}

@endpoint POST /
@required {LabelGroupName: str}
@returns(200) {LabelGroupName: str?, LabelGroupArn: str?, FaultCodes: [str]?, CreatedAt: str(timestamp)?, UpdatedAt: str(timestamp)?}

@endpoint POST /
@required {ModelName: str}
@returns(200) {ModelName: str?, ModelArn: str?, DatasetName: str?, DatasetArn: str?, Schema: str?, LabelsInputConfiguration: LabelsInputConfiguration?{S3InputConfiguration: LabelsS3InputConfiguration?{Bucket: str, Prefix: str?}, LabelGroupName: str?}, TrainingDataStartTime: str(timestamp)?, TrainingDataEndTime: str(timestamp)?, EvaluationDataStartTime: str(timestamp)?, EvaluationDataEndTime: str(timestamp)?, RoleArn: str?, DataPreProcessingConfiguration: DataPreProcessingConfiguration?{TargetSamplingRate: str?}, Status: str?, TrainingExecutionStartTime: str(timestamp)?, TrainingExecutionEndTime: str(timestamp)?, FailedReason: str?, ModelMetrics: str?, LastUpdatedTime: str(timestamp)?, CreatedAt: str(timestamp)?, ServerSideKmsKeyId: str?, OffCondition: str?, SourceModelVersionArn: str?, ImportJobStartTime: str(timestamp)?, ImportJobEndTime: str(timestamp)?, ActiveModelVersion: int(i64)?, ActiveModelVersionArn: str?, ModelVersionActivatedAt: str(timestamp)?, PreviousActiveModelVersion: int(i64)?, PreviousActiveModelVersionArn: str?, PreviousModelVersionActivatedAt: str(timestamp)?, PriorModelMetrics: str?, LatestScheduledRetrainingFailedReason: str?, LatestScheduledRetrainingStatus: str?, LatestScheduledRetrainingModelVersion: int(i64)?, LatestScheduledRetrainingStartTime: str(timestamp)?, LatestScheduledRetrainingAvailableDataInDays: int?, NextScheduledRetrainingStartDate: str(timestamp)?, AccumulatedInferenceDataStartTime: str(timestamp)?, AccumulatedInferenceDataEndTime: str(timestamp)?, RetrainingSchedulerStatus: str?, ModelDiagnosticsOutputConfiguration: ModelDiagnosticsOutputConfiguration?{S3OutputConfiguration: ModelDiagnosticsS3OutputConfiguration{Bucket: str, Prefix: str?}, KmsKeyId: str?}, ModelQuality: str?}

@endpoint POST /
@required {ModelName: str, ModelVersion: int(i64)}
@returns(200) {ModelName: str?, ModelArn: str?, ModelVersion: int(i64)?, ModelVersionArn: str?, Status: str?, SourceType: str?, DatasetName: str?, DatasetArn: str?, Schema: str?, LabelsInputConfiguration: LabelsInputConfiguration?{S3InputConfiguration: LabelsS3InputConfiguration?{Bucket: str, Prefix: str?}, LabelGroupName: str?}, TrainingDataStartTime: str(timestamp)?, TrainingDataEndTime: str(timestamp)?, EvaluationDataStartTime: str(timestamp)?, EvaluationDataEndTime: str(timestamp)?, RoleArn: str?, DataPreProcessingConfiguration: DataPreProcessingConfiguration?{TargetSamplingRate: str?}, TrainingExecutionStartTime: str(timestamp)?, TrainingExecutionEndTime: str(timestamp)?, FailedReason: str?, ModelMetrics: str?, LastUpdatedTime: str(timestamp)?, CreatedAt: str(timestamp)?, ServerSideKmsKeyId: str?, OffCondition: str?, SourceModelVersionArn: str?, ImportJobStartTime: str(timestamp)?, ImportJobEndTime: str(timestamp)?, ImportedDataSizeInBytes: int(i64)?, PriorModelMetrics: str?, RetrainingAvailableDataInDays: int?, AutoPromotionResult: str?, AutoPromotionResultReason: str?, ModelDiagnosticsOutputConfiguration: ModelDiagnosticsOutputConfiguration?{S3OutputConfiguration: ModelDiagnosticsS3OutputConfiguration{Bucket: str, Prefix: str?}, KmsKeyId: str?}, ModelDiagnosticsResultsObject: S3Object?{Bucket: str, Key: str}, ModelQuality: str?}

@endpoint POST /
@required {ResourceArn: str}
@returns(200) {PolicyRevisionId: str?, ResourcePolicy: str?, CreationTime: str(timestamp)?, LastModifiedTime: str(timestamp)?}

@endpoint POST /
@required {ModelName: str}
@returns(200) {ModelName: str?, ModelArn: str?, RetrainingStartDate: str(timestamp)?, RetrainingFrequency: str?, LookbackWindow: str?, Status: str?, PromoteMode: str?, CreatedAt: str(timestamp)?, UpdatedAt: str(timestamp)?}

@endpoint POST /
@required {SourceDatasetArn: str, ClientToken: str}
@optional {DatasetName: str, ServerSideKmsKeyId: str, Tags: [Tag]}
@returns(200) {DatasetName: str?, DatasetArn: str?, Status: str?, JobId: str?}

@endpoint POST /
@required {SourceModelVersionArn: str, DatasetName: str, ClientToken: str}
@optional {ModelName: str, LabelsInputConfiguration: LabelsInputConfiguration, RoleArn: str, ServerSideKmsKeyId: str, Tags: [Tag], InferenceDataImportStrategy: str}
@returns(200) {ModelName: str?, ModelArn: str?, ModelVersionArn: str?, ModelVersion: int(i64)?, Status: str?}

@endpoint POST /
@optional {DatasetName: str, NextToken: str, MaxResults: int, Status: str}
@returns(200) {NextToken: str?, DataIngestionJobSummaries: [DataIngestionJobSummary]?}

@endpoint POST /
@optional {NextToken: str, MaxResults: int, DatasetNameBeginsWith: str}
@returns(200) {NextToken: str?, DatasetSummaries: [DatasetSummary]?}

@endpoint POST /
@required {InferenceSchedulerName: str, IntervalStartTime: str(timestamp), IntervalEndTime: str(timestamp)}
@optional {NextToken: str, MaxResults: int}
@returns(200) {NextToken: str?, InferenceEventSummaries: [InferenceEventSummary]?}

@endpoint POST /
@required {InferenceSchedulerName: str}
@optional {NextToken: str, MaxResults: int, DataStartTimeAfter: str(timestamp), DataEndTimeBefore: str(timestamp), Status: str}
@returns(200) {NextToken: str?, InferenceExecutionSummaries: [InferenceExecutionSummary]?}

@endpoint POST /
@optional {NextToken: str, MaxResults: int, InferenceSchedulerNameBeginsWith: str, ModelName: str, Status: str}
@returns(200) {NextToken: str?, InferenceSchedulerSummaries: [InferenceSchedulerSummary]?}

@endpoint POST /
@optional {LabelGroupNameBeginsWith: str, NextToken: str, MaxResults: int}
@returns(200) {NextToken: str?, LabelGroupSummaries: [LabelGroupSummary]?}

@endpoint POST /
@required {LabelGroupName: str}
@optional {IntervalStartTime: str(timestamp), IntervalEndTime: str(timestamp), FaultCode: str, Equipment: str, NextToken: str, MaxResults: int}
@returns(200) {NextToken: str?, LabelSummaries: [LabelSummary]?}

@endpoint POST /
@required {ModelName: str}
@optional {NextToken: str, MaxResults: int, Status: str, SourceType: str, CreatedAtEndTime: str(timestamp), CreatedAtStartTime: str(timestamp), MaxModelVersion: int(i64), MinModelVersion: int(i64)}
@returns(200) {NextToken: str?, ModelVersionSummaries: [ModelVersionSummary]?}

@endpoint POST /
@optional {NextToken: str, MaxResults: int, Status: str, ModelNameBeginsWith: str, DatasetNameBeginsWith: str}
@returns(200) {NextToken: str?, ModelSummaries: [ModelSummary]?}

@endpoint POST /
@optional {ModelNameBeginsWith: str, Status: str, NextToken: str, MaxResults: int}
@returns(200) {RetrainingSchedulerSummaries: [RetrainingSchedulerSummary]?, NextToken: str?}

@endpoint POST /
@required {DatasetName: str}
@optional {IngestionJobId: str, MaxResults: int, NextToken: str}
@returns(200) {SensorStatisticsSummaries: [SensorStatisticsSummary]?, NextToken: str?}

@endpoint POST /
@required {ResourceArn: str}
@returns(200) {Tags: [Tag]?}

@endpoint POST /
@required {ResourceArn: str, ResourcePolicy: str, ClientToken: str}
@optional {PolicyRevisionId: str}
@returns(200) {ResourceArn: str?, PolicyRevisionId: str?}

@endpoint POST /
@required {DatasetName: str, IngestionInputConfiguration: IngestionInputConfiguration, RoleArn: str, ClientToken: str}
@returns(200) {JobId: str?, Status: str?}

@endpoint POST /
@required {InferenceSchedulerName: str}
@returns(200) {ModelArn: str?, ModelName: str?, InferenceSchedulerName: str?, InferenceSchedulerArn: str?, Status: str?}

@endpoint POST /
@required {ModelName: str}
@returns(200) {ModelName: str?, ModelArn: str?, Status: str?}

@endpoint POST /
@required {InferenceSchedulerName: str}
@returns(200) {ModelArn: str?, ModelName: str?, InferenceSchedulerName: str?, InferenceSchedulerArn: str?, Status: str?}

@endpoint POST /
@required {ModelName: str}
@returns(200) {ModelName: str?, ModelArn: str?, Status: str?}

@endpoint POST /
@required {ResourceArn: str, Tags: [Tag]}

@endpoint POST /
@required {ResourceArn: str, TagKeys: [str]}

@endpoint POST /
@required {ModelName: str, ModelVersion: int(i64)}
@returns(200) {ModelName: str?, ModelArn: str?, CurrentActiveVersion: int(i64)?, PreviousActiveVersion: int(i64)?, CurrentActiveVersionArn: str?, PreviousActiveVersionArn: str?}

@endpoint POST /
@required {InferenceSchedulerName: str}
@optional {DataDelayOffsetInMinutes: int(i64), DataUploadFrequency: str, DataInputConfiguration: InferenceInputConfiguration, DataOutputConfiguration: InferenceOutputConfiguration, RoleArn: str}

@endpoint POST /
@required {LabelGroupName: str}
@optional {FaultCodes: [str]}

@endpoint POST /
@required {ModelName: str}
@optional {LabelsInputConfiguration: LabelsInputConfiguration, RoleArn: str, ModelDiagnosticsOutputConfiguration: ModelDiagnosticsOutputConfiguration}

@endpoint POST /
@required {ModelName: str}
@optional {RetrainingStartDate: str(timestamp), RetrainingFrequency: str, LookbackWindow: str, PromoteMode: str}

@end