Amazon Forecast Service
Provides APIs for creating and managing Amazon Forecast resources.
AI & machine learning#openapi#cloud
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Provides APIs for creating and managing Amazon Forecast resources.
Endpoints 63
- POSTCreate auto predictor
/#X-Amz-Target=AmazonForecast.CreateAutoPredictorCreates an Amazon Forecast predictor. Amazon Forecast creates predictors with AutoPredictor, which involves applying the optimal combination of algorithms to… - POSTCreate dataset
/#X-Amz-Target=AmazonForecast.CreateDatasetCreates an Amazon Forecast dataset. The information about the dataset that you provide helps Forecast understand how to consume the data for model training.… - POSTCreate dataset group
/#X-Amz-Target=AmazonForecast.CreateDatasetGroupCreates a dataset group, which holds a collection of related datasets. You can add datasets to the dataset group when you create the dataset group, or later… - POSTCreate dataset import job
/#X-Amz-Target=AmazonForecast.CreateDatasetImportJobImports your training data to an Amazon Forecast dataset. You provide the location of your training data in an Amazon Simple Storage Service (Amazon S3)… - POSTCreate explainability
/#X-Amz-Target=AmazonForecast.CreateExplainabilityExplainability is only available for Forecasts and Predictors generated from an AutoPredictor ( CreateAutoPredictor ) Creates an Amazon Forecast… - POSTCreate explainability export
/#X-Amz-Target=AmazonForecast.CreateExplainabilityExportExports an Explainability resource created by the CreateExplainability operation. Exported files are exported to an Amazon Simple Storage Service (Amazon S3)… - POSTCreate forecast
/#X-Amz-Target=AmazonForecast.CreateForecastCreates a forecast for each item in the TARGET_TIME_SERIES dataset that was used to train the predictor. This is known as inference. To retrieve the forecast… - POSTCreate forecast export job
/#X-Amz-Target=AmazonForecast.CreateForecastExportJobExports a forecast created by the CreateForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the… - POSTCreate monitor
/#X-Amz-Target=AmazonForecast.CreateMonitorCreates a predictor monitor resource for an existing auto predictor. Predictor monitoring allows you to see how your predictor's performance changes over… - POSTCreate predictor
/#X-Amz-Target=AmazonForecast.CreatePredictorThis operation creates a legacy predictor that does not include all the predictor functionalities provided by Amazon Forecast. To create a predictor that is… - POSTCreate predictor backtest export job
/#X-Amz-Target=AmazonForecast.CreatePredictorBacktestExportJobExports backtest forecasts and accuracy metrics generated by the CreateAutoPredictor or CreatePredictor operations. Two folders containing CSV or Parquet… - POSTCreate what if analysis
/#X-Amz-Target=AmazonForecast.CreateWhatIfAnalysisWhat-if analysis is a scenario modeling technique where you make a hypothetical change to a time series and compare the forecasts generated by these changes… - POSTCreate what if forecast
/#X-Amz-Target=AmazonForecast.CreateWhatIfForecastA what-if forecast is a forecast that is created from a modified version of the baseline forecast. Each what-if forecast incorporates either a replacement… - POSTCreate what if forecast export
/#X-Amz-Target=AmazonForecast.CreateWhatIfForecastExportExports a forecast created by the CreateWhatIfForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match… - POSTDelete dataset
/#X-Amz-Target=AmazonForecast.DeleteDatasetDeletes an Amazon Forecast dataset that was created using the CreateDataset operation. You can only delete datasets that have a status of ACTIVE or… - POSTDelete dataset group
/#X-Amz-Target=AmazonForecast.DeleteDatasetGroupDeletes a dataset group created using the CreateDatasetGroup operation. You can only delete dataset groups that have a status of ACTIVE , CREATE_FAILED , or… - POSTDelete dataset import job
/#X-Amz-Target=AmazonForecast.DeleteDatasetImportJobDeletes a dataset import job created using the CreateDatasetImportJob operation. You can delete only dataset import jobs that have a status of ACTIVE or… - POSTDelete explainability
/#X-Amz-Target=AmazonForecast.DeleteExplainabilityDeletes an Explainability resource. You can delete only predictor that have a status of ACTIVE or CREATE_FAILED . To get the status, use the… - POSTDelete explainability export
/#X-Amz-Target=AmazonForecast.DeleteExplainabilityExportDeletes an Explainability export. - POSTDelete forecast
/#X-Amz-Target=AmazonForecast.DeleteForecastDeletes a forecast created using the CreateForecast operation. You can delete only forecasts that have a status of ACTIVE or CREATE_FAILED . To get the… - POSTDelete forecast export job
/#X-Amz-Target=AmazonForecast.DeleteForecastExportJobDeletes a forecast export job created using the CreateForecastExportJob operation. You can delete only export jobs that have a status of ACTIVE or… - POSTDelete monitor
/#X-Amz-Target=AmazonForecast.DeleteMonitorDeletes a monitor resource. You can only delete a monitor resource with a status of ACTIVE , ACTIVE_STOPPED , CREATE_FAILED , or CREATE_STOPPED . - POSTDelete predictor
/#X-Amz-Target=AmazonForecast.DeletePredictorDeletes a predictor created using the DescribePredictor or CreatePredictor operations. You can delete only predictor that have a status of ACTIVE or… - POSTDelete predictor backtest export job
/#X-Amz-Target=AmazonForecast.DeletePredictorBacktestExportJobDeletes a predictor backtest export job. - POSTDelete resource tree
/#X-Amz-Target=AmazonForecast.DeleteResourceTreeDeletes an entire resource tree. This operation will delete the parent resource and its child resources. Child resources are resources that were created from… - POSTDelete what if analysis
/#X-Amz-Target=AmazonForecast.DeleteWhatIfAnalysisDeletes a what-if analysis created using the CreateWhatIfAnalysis operation. You can delete only what-if analyses that have a status of ACTIVE or… - POSTDelete what if forecast
/#X-Amz-Target=AmazonForecast.DeleteWhatIfForecastDeletes a what-if forecast created using the CreateWhatIfForecast operation. You can delete only what-if forecasts that have a status of ACTIVE or… - POSTDelete what if forecast export
/#X-Amz-Target=AmazonForecast.DeleteWhatIfForecastExportDeletes a what-if forecast export created using the CreateWhatIfForecastExport operation. You can delete only what-if forecast exports that have a status of… - POSTDescribe auto predictor
/#X-Amz-Target=AmazonForecast.DescribeAutoPredictorDescribes a predictor created using the CreateAutoPredictor operation. - POSTDescribe dataset
/#X-Amz-Target=AmazonForecast.DescribeDatasetDescribes an Amazon Forecast dataset created using the CreateDataset operation. In addition to listing the parameters specified in the CreateDataset request,… - POSTDescribe dataset group
/#X-Amz-Target=AmazonForecast.DescribeDatasetGroupDescribes a dataset group created using the CreateDatasetGroup operation. In addition to listing the parameters provided in the CreateDatasetGroup request,… - POSTDescribe dataset import job
/#X-Amz-Target=AmazonForecast.DescribeDatasetImportJobDescribes a dataset import job created using the CreateDatasetImportJob operation. In addition to listing the parameters provided in the… - POSTDescribe explainability
/#X-Amz-Target=AmazonForecast.DescribeExplainabilityDescribes an Explainability resource created using the CreateExplainability operation. - POSTDescribe explainability export
/#X-Amz-Target=AmazonForecast.DescribeExplainabilityExportDescribes an Explainability export created using the CreateExplainabilityExport operation. - POSTDescribe forecast
/#X-Amz-Target=AmazonForecast.DescribeForecastDescribes a forecast created using the CreateForecast operation. In addition to listing the properties provided in the CreateForecast request, this operation… - POSTDescribe forecast export job
/#X-Amz-Target=AmazonForecast.DescribeForecastExportJobDescribes a forecast export job created using the CreateForecastExportJob operation. In addition to listing the properties provided by the user in the… - POSTDescribe monitor
/#X-Amz-Target=AmazonForecast.DescribeMonitorDescribes a monitor resource. In addition to listing the properties provided in the CreateMonitor request, this operation lists the following properties:… - POSTDescribe predictor
/#X-Amz-Target=AmazonForecast.DescribePredictorThis operation is only valid for legacy predictors created with CreatePredictor. If you are not using a legacy predictor, use DescribeAutoPredictor .… - POSTDescribe predictor backtest export job
/#X-Amz-Target=AmazonForecast.DescribePredictorBacktestExportJobDescribes a predictor backtest export job created using the CreatePredictorBacktestExportJob operation. In addition to listing the properties provided by the… - POSTDescribe what if analysis
/#X-Amz-Target=AmazonForecast.DescribeWhatIfAnalysisDescribes the what-if analysis created using the CreateWhatIfAnalysis operation. In addition to listing the properties provided in the CreateWhatIfAnalysis… - POSTDescribe what if forecast
/#X-Amz-Target=AmazonForecast.DescribeWhatIfForecastDescribes the what-if forecast created using the CreateWhatIfForecast operation. In addition to listing the properties provided in the CreateWhatIfForecast… - POSTDescribe what if forecast export
/#X-Amz-Target=AmazonForecast.DescribeWhatIfForecastExportDescribes the what-if forecast export created using the CreateWhatIfForecastExport operation. In addition to listing the properties provided in the… - POSTGet accuracy metrics
/#X-Amz-Target=AmazonForecast.GetAccuracyMetricsProvides metrics on the accuracy of the models that were trained by the CreatePredictor operation. Use metrics to see how well the model performed and to… - POSTList dataset groups
/#X-Amz-Target=AmazonForecast.ListDatasetGroupsReturns a list of dataset groups created using the CreateDatasetGroup operation. For each dataset group, this operation returns a summary of its properties,… - POSTList dataset import jobs
/#X-Amz-Target=AmazonForecast.ListDatasetImportJobsReturns a list of dataset import jobs created using the CreateDatasetImportJob operation. For each import job, this operation returns a summary of its… - POSTList datasets
/#X-Amz-Target=AmazonForecast.ListDatasetsReturns a list of datasets created using the CreateDataset operation. For each dataset, a summary of its properties, including its Amazon Resource Name (ARN),… - POSTList explainabilities
/#X-Amz-Target=AmazonForecast.ListExplainabilitiesReturns a list of Explainability resources created using the CreateExplainability operation. This operation returns a summary for each Explainability. You can… - POSTList explainability exports
/#X-Amz-Target=AmazonForecast.ListExplainabilityExportsReturns a list of Explainability exports created using the CreateExplainabilityExport operation. This operation returns a summary for each Explainability… - POSTList forecast export jobs
/#X-Amz-Target=AmazonForecast.ListForecastExportJobsReturns a list of forecast export jobs created using the CreateForecastExportJob operation. For each forecast export job, this operation returns a summary of… - POSTList forecasts
/#X-Amz-Target=AmazonForecast.ListForecastsReturns a list of forecasts created using the CreateForecast operation. For each forecast, this operation returns a summary of its properties, including its… - POSTList monitor evaluations
/#X-Amz-Target=AmazonForecast.ListMonitorEvaluationsReturns a list of the monitoring evaluation results and predictor events collected by the monitor resource during different windows of time. For information… - POSTList monitors
/#X-Amz-Target=AmazonForecast.ListMonitorsReturns a list of monitors created with the CreateMonitor operation and CreateAutoPredictor operation. For each monitor resource, this operation returns of a… - POSTList predictor backtest export jobs
/#X-Amz-Target=AmazonForecast.ListPredictorBacktestExportJobsReturns a list of predictor backtest export jobs created using the CreatePredictorBacktestExportJob operation. This operation returns a summary for each… - POSTList predictors
/#X-Amz-Target=AmazonForecast.ListPredictorsReturns a list of predictors created using the CreateAutoPredictor or CreatePredictor operations. For each predictor, this operation returns a summary of its… - POSTList tags for resource
/#X-Amz-Target=AmazonForecast.ListTagsForResourceLists the tags for an Amazon Forecast resource. - POSTList what if analyses
/#X-Amz-Target=AmazonForecast.ListWhatIfAnalysesReturns a list of what-if analyses created using the CreateWhatIfAnalysis operation. For each what-if analysis, this operation returns a summary of its… - POSTList what if forecast exports
/#X-Amz-Target=AmazonForecast.ListWhatIfForecastExportsReturns a list of what-if forecast exports created using the CreateWhatIfForecastExport operation. For each what-if forecast export, this operation returns a… - POSTList what if forecasts
/#X-Amz-Target=AmazonForecast.ListWhatIfForecastsReturns a list of what-if forecasts created using the CreateWhatIfForecast operation. For each what-if forecast, this operation returns a summary of its… - POSTResume resource
/#X-Amz-Target=AmazonForecast.ResumeResourceResumes a stopped monitor resource. - POSTStop resource
/#X-Amz-Target=AmazonForecast.StopResourceStops a resource. The resource undergoes the following states: CREATE_STOPPING and CREATE_STOPPED . You cannot resume a resource once it has been stopped.… - POSTTag resource
/#X-Amz-Target=AmazonForecast.TagResourceAssociates the specified tags to a resource with the specified resourceArn . If existing tags on a resource are not specified in the request parameters, they… - POSTUntag resource
/#X-Amz-Target=AmazonForecast.UntagResourceDeletes the specified tags from a resource. - POSTUpdate dataset group
/#X-Amz-Target=AmazonForecast.UpdateDatasetGroupReplaces the datasets in a dataset group with the specified datasets. The Status of the dataset group must be ACTIVE before you can use the dataset group to…
API details
- Base URL
https://forecast.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 63 operations on 63 pathsPOST 63
- Description format
- AWS Smithy model, API version
2018-06-26 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon Forecast Service in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Forecast Service collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Create auto predictor” (POST /#X-Amz-Target=AmazonForecast.CreateAutoPredictor), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Amazon Forecast Service?
Provides APIs for creating and managing Amazon Forecast resources. It is listed under AI & machine learning and has 63 endpoints.
Who publishes the Amazon Forecast Service?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Amazon Forecast Service?
Requests go to https://forecast.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon Forecast Service?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon Forecast Service have?
63 operations on 63 paths (63 POST).
Is forking the Amazon Forecast Service free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.