@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Amazon Forecast Service
@version 2018-06-26
@auth AWS SigV4
@endpoints 63
@hint download_for_search
@toc root(63)

@endpoint POST /
@required {PredictorName: str}
@optional {ForecastHorizon: int, ForecastTypes: [str], ForecastDimensions: [str], ForecastFrequency: str, DataConfig: DataConfig, EncryptionConfig: EncryptionConfig, ReferencePredictorArn: str, OptimizationMetric: str, ExplainPredictor: bool, Tags: [Tag], MonitorConfig: MonitorConfig, TimeAlignmentBoundary: TimeAlignmentBoundary}
@returns(200) {PredictorArn: str?}

@endpoint POST /
@required {DatasetName: str, Domain: str, DatasetType: str, Schema: Schema}
@optional {DataFrequency: str, EncryptionConfig: EncryptionConfig, Tags: [Tag]}
@returns(200) {DatasetArn: str?}

@endpoint POST /
@required {DatasetGroupName: str, Domain: str}
@optional {DatasetArns: [str], Tags: [Tag]}
@returns(200) {DatasetGroupArn: str?}

@endpoint POST /
@required {DatasetImportJobName: str, DatasetArn: str, DataSource: DataSource}
@optional {TimestampFormat: str, TimeZone: str, UseGeolocationForTimeZone: bool, GeolocationFormat: str, Tags: [Tag], Format: str, ImportMode: str}
@returns(200) {DatasetImportJobArn: str?}

@endpoint POST /
@required {ExplainabilityName: str, ResourceArn: str, ExplainabilityConfig: ExplainabilityConfig}
@optional {DataSource: DataSource, Schema: Schema, EnableVisualization: bool, StartDateTime: str, EndDateTime: str, Tags: [Tag]}
@returns(200) {ExplainabilityArn: str?}

@endpoint POST /
@required {ExplainabilityExportName: str, ExplainabilityArn: str, Destination: DataDestination}
@optional {Tags: [Tag], Format: str}
@returns(200) {ExplainabilityExportArn: str?}

@endpoint POST /
@required {ForecastName: str, PredictorArn: str}
@optional {ForecastTypes: [str], Tags: [Tag], TimeSeriesSelector: TimeSeriesSelector}
@returns(200) {ForecastArn: str?}

@endpoint POST /
@required {ForecastExportJobName: str, ForecastArn: str, Destination: DataDestination}
@optional {Tags: [Tag], Format: str}
@returns(200) {ForecastExportJobArn: str?}

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

@endpoint POST /
@required {PredictorName: str, ForecastHorizon: int, InputDataConfig: InputDataConfig, FeaturizationConfig: FeaturizationConfig}
@optional {AlgorithmArn: str, ForecastTypes: [str], PerformAutoML: bool, AutoMLOverrideStrategy: str, PerformHPO: bool, TrainingParameters: map<str,str>, EvaluationParameters: EvaluationParameters, HPOConfig: HyperParameterTuningJobConfig, EncryptionConfig: EncryptionConfig, Tags: [Tag], OptimizationMetric: str}
@returns(200) {PredictorArn: str?}

@endpoint POST /
@required {PredictorBacktestExportJobName: str, PredictorArn: str, Destination: DataDestination}
@optional {Tags: [Tag], Format: str}
@returns(200) {PredictorBacktestExportJobArn: str?}

@endpoint POST /
@required {WhatIfAnalysisName: str, ForecastArn: str}
@optional {TimeSeriesSelector: TimeSeriesSelector, Tags: [Tag]}
@returns(200) {WhatIfAnalysisArn: str?}

@endpoint POST /
@required {WhatIfForecastName: str, WhatIfAnalysisArn: str}
@optional {TimeSeriesTransformations: [TimeSeriesTransformation], TimeSeriesReplacementsDataSource: TimeSeriesReplacementsDataSource, Tags: [Tag]}
@returns(200) {WhatIfForecastArn: str?}

@endpoint POST /
@required {WhatIfForecastExportName: str, WhatIfForecastArns: [str], Destination: DataDestination}
@optional {Tags: [Tag], Format: str}
@returns(200) {WhatIfForecastExportArn: str?}

@endpoint POST /
@required {DatasetArn: str}

@endpoint POST /
@required {DatasetGroupArn: str}

@endpoint POST /
@required {DatasetImportJobArn: str}

@endpoint POST /
@required {ExplainabilityArn: str}

@endpoint POST /
@required {ExplainabilityExportArn: str}

@endpoint POST /
@required {ForecastArn: str}

@endpoint POST /
@required {ForecastExportJobArn: str}

@endpoint POST /
@required {MonitorArn: str}

@endpoint POST /
@required {PredictorArn: str}

@endpoint POST /
@required {PredictorBacktestExportJobArn: str}

@endpoint POST /
@required {ResourceArn: str}

@endpoint POST /
@required {WhatIfAnalysisArn: str}

@endpoint POST /
@required {WhatIfForecastArn: str}

@endpoint POST /
@required {WhatIfForecastExportArn: str}

@endpoint POST /
@required {PredictorArn: str}
@returns(200) {PredictorArn: str?, PredictorName: str?, ForecastHorizon: int?, ForecastTypes: [str]?, ForecastFrequency: str?, ForecastDimensions: [str]?, DatasetImportJobArns: [str]?, DataConfig: DataConfig?{DatasetGroupArn: str, AttributeConfigs: [AttributeConfig]?, AdditionalDatasets: [AdditionalDataset]?}, EncryptionConfig: EncryptionConfig?{RoleArn: str, KMSKeyArn: str}, ReferencePredictorSummary: ReferencePredictorSummary?{Arn: str?, State: str?}, EstimatedTimeRemainingInMinutes: int(i64)?, Status: str?, Message: str?, CreationTime: str(timestamp)?, LastModificationTime: str(timestamp)?, OptimizationMetric: str?, ExplainabilityInfo: ExplainabilityInfo?{ExplainabilityArn: str?, Status: str?}, MonitorInfo: MonitorInfo?{MonitorArn: str?, Status: str?}, TimeAlignmentBoundary: TimeAlignmentBoundary?{Month: str?, DayOfMonth: int?, DayOfWeek: str?, Hour: int?}}

@endpoint POST /
@required {DatasetArn: str}
@returns(200) {DatasetArn: str?, DatasetName: str?, Domain: str?, DatasetType: str?, DataFrequency: str?, Schema: Schema?{Attributes: [SchemaAttribute]?}, EncryptionConfig: EncryptionConfig?{RoleArn: str, KMSKeyArn: str}, Status: str?, CreationTime: str(timestamp)?, LastModificationTime: str(timestamp)?}

@endpoint POST /
@required {DatasetGroupArn: str}
@returns(200) {DatasetGroupName: str?, DatasetGroupArn: str?, DatasetArns: [str]?, Domain: str?, Status: str?, CreationTime: str(timestamp)?, LastModificationTime: str(timestamp)?}

@endpoint POST /
@required {DatasetImportJobArn: str}
@returns(200) {DatasetImportJobName: str?, DatasetImportJobArn: str?, DatasetArn: str?, TimestampFormat: str?, TimeZone: str?, UseGeolocationForTimeZone: bool?, GeolocationFormat: str?, DataSource: DataSource?{S3Config: S3Config{Path: str, RoleArn: str, KMSKeyArn: str?}}, EstimatedTimeRemainingInMinutes: int(i64)?, FieldStatistics: map<str,Statistics>?, DataSize: num(f64)?, Status: str?, Message: str?, CreationTime: str(timestamp)?, LastModificationTime: str(timestamp)?, Format: str?, ImportMode: str?}

@endpoint POST /
@required {ExplainabilityArn: str}
@returns(200) {ExplainabilityArn: str?, ExplainabilityName: str?, ResourceArn: str?, ExplainabilityConfig: ExplainabilityConfig?{TimeSeriesGranularity: str, TimePointGranularity: str}, EnableVisualization: bool?, DataSource: DataSource?{S3Config: S3Config{Path: str, RoleArn: str, KMSKeyArn: str?}}, Schema: Schema?{Attributes: [SchemaAttribute]?}, StartDateTime: str?, EndDateTime: str?, EstimatedTimeRemainingInMinutes: int(i64)?, Message: str?, Status: str?, CreationTime: str(timestamp)?, LastModificationTime: str(timestamp)?}

@endpoint POST /
@required {ExplainabilityExportArn: str}
@returns(200) {ExplainabilityExportArn: str?, ExplainabilityExportName: str?, ExplainabilityArn: str?, Destination: DataDestination?{S3Config: S3Config{Path: str, RoleArn: str, KMSKeyArn: str?}}, Message: str?, Status: str?, CreationTime: str(timestamp)?, LastModificationTime: str(timestamp)?, Format: str?}

@endpoint POST /
@required {ForecastArn: str}
@returns(200) {ForecastArn: str?, ForecastName: str?, ForecastTypes: [str]?, PredictorArn: str?, DatasetGroupArn: str?, EstimatedTimeRemainingInMinutes: int(i64)?, Status: str?, Message: str?, CreationTime: str(timestamp)?, LastModificationTime: str(timestamp)?, TimeSeriesSelector: TimeSeriesSelector?{TimeSeriesIdentifiers: TimeSeriesIdentifiers?{DataSource: DataSource?{S3Config: S3Config}, Schema: Schema?{Attributes: [SchemaAttribute]?}, Format: str?}}}

@endpoint POST /
@required {ForecastExportJobArn: str}
@returns(200) {ForecastExportJobArn: str?, ForecastExportJobName: str?, ForecastArn: str?, Destination: DataDestination?{S3Config: S3Config{Path: str, RoleArn: str, KMSKeyArn: str?}}, Message: str?, Status: str?, CreationTime: str(timestamp)?, LastModificationTime: str(timestamp)?, Format: str?}

@endpoint POST /
@required {MonitorArn: str}
@returns(200) {MonitorName: str?, MonitorArn: str?, ResourceArn: str?, Status: str?, LastEvaluationTime: str(timestamp)?, LastEvaluationState: str?, Baseline: Baseline?{PredictorBaseline: PredictorBaseline?{BaselineMetrics: [BaselineMetric]?}}, Message: str?, CreationTime: str(timestamp)?, LastModificationTime: str(timestamp)?, EstimatedEvaluationTimeRemainingInMinutes: int(i64)?}

@endpoint POST /
@required {PredictorArn: str}
@returns(200) {PredictorArn: str?, PredictorName: str?, AlgorithmArn: str?, AutoMLAlgorithmArns: [str]?, ForecastHorizon: int?, ForecastTypes: [str]?, PerformAutoML: bool?, AutoMLOverrideStrategy: str?, PerformHPO: bool?, TrainingParameters: map<str,str>?, EvaluationParameters: EvaluationParameters?{NumberOfBacktestWindows: int?, BackTestWindowOffset: int?}, HPOConfig: HyperParameterTuningJobConfig?{ParameterRanges: ParameterRanges?{CategoricalParameterRanges: [CategoricalParameterRange]?, ContinuousParameterRanges: [ContinuousParameterRange]?, IntegerParameterRanges: [IntegerParameterRange]?}}, InputDataConfig: InputDataConfig?{DatasetGroupArn: str, SupplementaryFeatures: [SupplementaryFeature]?}, FeaturizationConfig: FeaturizationConfig?{ForecastFrequency: str, ForecastDimensions: [str]?, Featurizations: [Featurization]?}, EncryptionConfig: EncryptionConfig?{RoleArn: str, KMSKeyArn: str}, PredictorExecutionDetails: PredictorExecutionDetails?{PredictorExecutions: [PredictorExecution]?}, EstimatedTimeRemainingInMinutes: int(i64)?, IsAutoPredictor: bool?, DatasetImportJobArns: [str]?, Status: str?, Message: str?, CreationTime: str(timestamp)?, LastModificationTime: str(timestamp)?, OptimizationMetric: str?}

@endpoint POST /
@required {PredictorBacktestExportJobArn: str}
@returns(200) {PredictorBacktestExportJobArn: str?, PredictorBacktestExportJobName: str?, PredictorArn: str?, Destination: DataDestination?{S3Config: S3Config{Path: str, RoleArn: str, KMSKeyArn: str?}}, Message: str?, Status: str?, CreationTime: str(timestamp)?, LastModificationTime: str(timestamp)?, Format: str?}

@endpoint POST /
@required {WhatIfAnalysisArn: str}
@returns(200) {WhatIfAnalysisName: str?, WhatIfAnalysisArn: str?, ForecastArn: str?, EstimatedTimeRemainingInMinutes: int(i64)?, Status: str?, Message: str?, CreationTime: str(timestamp)?, LastModificationTime: str(timestamp)?, TimeSeriesSelector: TimeSeriesSelector?{TimeSeriesIdentifiers: TimeSeriesIdentifiers?{DataSource: DataSource?{S3Config: S3Config}, Schema: Schema?{Attributes: [SchemaAttribute]?}, Format: str?}}}

@endpoint POST /
@required {WhatIfForecastArn: str}
@returns(200) {WhatIfForecastName: str?, WhatIfForecastArn: str?, WhatIfAnalysisArn: str?, EstimatedTimeRemainingInMinutes: int(i64)?, Status: str?, Message: str?, CreationTime: str(timestamp)?, LastModificationTime: str(timestamp)?, TimeSeriesTransformations: [TimeSeriesTransformation]?, TimeSeriesReplacementsDataSource: TimeSeriesReplacementsDataSource?{S3Config: S3Config{Path: str, RoleArn: str, KMSKeyArn: str?}, Schema: Schema{Attributes: [SchemaAttribute]?}, Format: str?, TimestampFormat: str?}, ForecastTypes: [str]?}

@endpoint POST /
@required {WhatIfForecastExportArn: str}
@returns(200) {WhatIfForecastExportArn: str?, WhatIfForecastExportName: str?, WhatIfForecastArns: [str]?, Destination: DataDestination?{S3Config: S3Config{Path: str, RoleArn: str, KMSKeyArn: str?}}, Message: str?, Status: str?, CreationTime: str(timestamp)?, EstimatedTimeRemainingInMinutes: int(i64)?, LastModificationTime: str(timestamp)?, Format: str?}

@endpoint POST /
@required {PredictorArn: str}
@returns(200) {PredictorEvaluationResults: [EvaluationResult]?, IsAutoPredictor: bool?, AutoMLOverrideStrategy: str?, OptimizationMetric: str?}

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

@endpoint POST /
@optional {NextToken: str, MaxResults: int, Filters: [Filter]}
@returns(200) {DatasetImportJobs: [DatasetImportJobSummary]?, NextToken: str?}

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

@endpoint POST /
@optional {NextToken: str, MaxResults: int, Filters: [Filter]}
@returns(200) {Explainabilities: [ExplainabilitySummary]?, NextToken: str?}

@endpoint POST /
@optional {NextToken: str, MaxResults: int, Filters: [Filter]}
@returns(200) {ExplainabilityExports: [ExplainabilityExportSummary]?, NextToken: str?}

@endpoint POST /
@optional {NextToken: str, MaxResults: int, Filters: [Filter]}
@returns(200) {ForecastExportJobs: [ForecastExportJobSummary]?, NextToken: str?}

@endpoint POST /
@optional {NextToken: str, MaxResults: int, Filters: [Filter]}
@returns(200) {Forecasts: [ForecastSummary]?, NextToken: str?}

@endpoint POST /
@required {MonitorArn: str}
@optional {NextToken: str, MaxResults: int, Filters: [Filter]}
@returns(200) {NextToken: str?, PredictorMonitorEvaluations: [PredictorMonitorEvaluation]?}

@endpoint POST /
@optional {NextToken: str, MaxResults: int, Filters: [Filter]}
@returns(200) {Monitors: [MonitorSummary]?, NextToken: str?}

@endpoint POST /
@optional {NextToken: str, MaxResults: int, Filters: [Filter]}
@returns(200) {PredictorBacktestExportJobs: [PredictorBacktestExportJobSummary]?, NextToken: str?}

@endpoint POST /
@optional {NextToken: str, MaxResults: int, Filters: [Filter]}
@returns(200) {Predictors: [PredictorSummary]?, NextToken: str?}

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

@endpoint POST /
@optional {NextToken: str, MaxResults: int, Filters: [Filter]}
@returns(200) {WhatIfAnalyses: [WhatIfAnalysisSummary]?, NextToken: str?}

@endpoint POST /
@optional {NextToken: str, MaxResults: int, Filters: [Filter]}
@returns(200) {WhatIfForecastExports: [WhatIfForecastExportSummary]?, NextToken: str?}

@endpoint POST /
@optional {NextToken: str, MaxResults: int, Filters: [Filter]}
@returns(200) {WhatIfForecasts: [WhatIfForecastSummary]?, NextToken: str?}

@endpoint POST /
@required {ResourceArn: str}

@endpoint POST /
@required {ResourceArn: str}

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

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

@endpoint POST /
@required {DatasetGroupArn: str, DatasetArns: [str]}

@end