Skip to content

Amazon Forecast Service API

by amazonaws.com

API keyHTTPSCloud Platforms
Open documentation ↗

Overview

Provides APIs for creating and managing Amazon Forecast resources.

Amazon Forecast Service is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 63 endpoints.

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Version
2018-06-26
Endpoints
63
Spec updated
2020-03-11

Endpoints

MethodPathWhat it does
POST/#X-Amz-Target=AmazonForecast.CreateAutoPredictor<p>Creates an Amazon Forecast predictor.</p> <p>Amazon Forecast creates predictors with AutoPredictor, which involves applying the optimal combination of algori
POST/#X-Amz-Target=AmazonForecast.CreateDataset<p>Creates an Amazon Forecast dataset. The information about the dataset that you provide helps Forecast understand how to consume the data for model training.
POST/#X-Amz-Target=AmazonForecast.CreateDatasetGroup<p>Creates 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
POST/#X-Amz-Target=AmazonForecast.CreateDatasetImportJob<p>Imports your training data to an Amazon Forecast dataset. You provide the location of your training data in an Amazon Simple Storage Service (Amazon S3) buck
POST/#X-Amz-Target=AmazonForecast.CreateExplainability<note> <p>Explainability is only available for Forecasts and Predictors generated from an AutoPredictor (<a>CreateAutoPredictor</a>)</p> </note> <p>Creates an A
POST/#X-Amz-Target=AmazonForecast.CreateExplainabilityExport<p>Exports an Explainability resource created by the <a>CreateExplainability</a> operation. Exported files are exported to an Amazon Simple Storage Service (Ama
POST/#X-Amz-Target=AmazonForecast.CreateForecast<p>Creates a forecast for each item in the <code>TARGET_TIME_SERIES</code> dataset that was used to train the predictor. This is known as inference. To retrieve
POST/#X-Amz-Target=AmazonForecast.CreateForecastExportJob<p>Exports a forecast created by the <a>CreateForecast</a> operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match
POST/#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 time.
POST/#X-Amz-Target=AmazonForecast.CreatePredictor<note> <p> This operation creates a legacy predictor that does not include all the predictor functionalities provided by Amazon Forecast. To create a predictor
POST/#X-Amz-Target=AmazonForecast.CreatePredictorBacktestExportJob<p>Exports backtest forecasts and accuracy metrics generated by the <a>CreateAutoPredictor</a> or <a>CreatePredictor</a> operations. Two folders containing CSV
POST/#X-Amz-Target=AmazonForecast.CreateWhatIfAnalysis<p>What-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
POST/#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 datas
POST/#X-Amz-Target=AmazonForecast.CreateWhatIfForecastExport<p>Exports a forecast created by the <a>CreateWhatIfForecast</a> operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will
POST/#X-Amz-Target=AmazonForecast.DeleteDataset<p>Deletes an Amazon Forecast dataset that was created using the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html">CreateDataset</
POST/#X-Amz-Target=AmazonForecast.DeleteDatasetGroup<p>Deletes a dataset group created using the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html">CreateDatasetGroup</a> operati
POST/#X-Amz-Target=AmazonForecast.DeleteDatasetImportJobDeletes a dataset import job created using the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</
POST/#X-Amz-Target=AmazonForecast.DeleteExplainability<p>Deletes an Explainability resource.</p> <p>You can delete only predictor that have a status of <code>ACTIVE</code> or <code>CREATE_FAILED</code>. To get the
POST/#X-Amz-Target=AmazonForecast.DeleteExplainabilityExportDeletes an Explainability export.
POST/#X-Amz-Target=AmazonForecast.DeleteForecast<p>Deletes a forecast created using the <a>CreateForecast</a> operation. You can delete only forecasts that have a status of <code>ACTIVE</code> or <code>CREATE
POST/#X-Amz-Target=AmazonForecast.DeleteForecastExportJobDeletes a forecast export job created using the <a>CreateForecastExportJob</a> operation. You can delete only export jobs that have a status of <code>ACTIVE</co
POST/#X-Amz-Target=AmazonForecast.DeleteMonitorDeletes a monitor resource. You can only delete a monitor resource with a status of <code>ACTIVE</code>, <code>ACTIVE_STOPPED</code>, <code>CREATE_FAILED</code>
POST/#X-Amz-Target=AmazonForecast.DeletePredictorDeletes a predictor created using the <a>DescribePredictor</a> or <a>CreatePredictor</a> operations. You can delete only predictor that have a status of <code>A
POST/#X-Amz-Target=AmazonForecast.DeletePredictorBacktestExportJobDeletes a predictor backtest export job.
POST/#X-Amz-Target=AmazonForecast.DeleteResourceTree<p>Deletes an entire resource tree. This operation will delete the parent resource and its child resources.</p> <p>Child resources are resources that were creat
POST/#X-Amz-Target=AmazonForecast.DeleteWhatIfAnalysis<p>Deletes a what-if analysis created using the <a>CreateWhatIfAnalysis</a> operation. You can delete only what-if analyses that have a status of <code>ACTIVE</
POST/#X-Amz-Target=AmazonForecast.DeleteWhatIfForecast<p>Deletes a what-if forecast created using the <a>CreateWhatIfForecast</a> operation. You can delete only what-if forecasts that have a status of <code>ACTIVE<
POST/#X-Amz-Target=AmazonForecast.DeleteWhatIfForecastExportDeletes a what-if forecast export created using the <a>CreateWhatIfForecastExport</a> operation. You can delete only what-if forecast exports that have a status
POST/#X-Amz-Target=AmazonForecast.DescribeAutoPredictorDescribes a predictor created using the CreateAutoPredictor operation.
POST/#X-Amz-Target=AmazonForecast.DescribeDataset<p>Describes an Amazon Forecast dataset created using the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html">CreateDataset</a> oper
POST/#X-Amz-Target=AmazonForecast.DescribeDatasetGroup<p>Describes a dataset group created using the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html">CreateDatasetGroup</a> opera
POST/#X-Amz-Target=AmazonForecast.DescribeDatasetImportJob<p>Describes a dataset import job created using the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImport
POST/#X-Amz-Target=AmazonForecast.DescribeExplainabilityDescribes an Explainability resource created using the <a>CreateExplainability</a> operation.
POST/#X-Amz-Target=AmazonForecast.DescribeExplainabilityExportDescribes an Explainability export created using the <a>CreateExplainabilityExport</a> operation.
POST/#X-Amz-Target=AmazonForecast.DescribeForecast<p>Describes a forecast created using the <a>CreateForecast</a> operation.</p> <p>In addition to listing the properties provided in the <code>CreateForecast</co
POST/#X-Amz-Target=AmazonForecast.DescribeForecastExportJob<p>Describes a forecast export job created using the <a>CreateForecastExportJob</a> operation.</p> <p>In addition to listing the properties provided by the user
POST/#X-Amz-Target=AmazonForecast.DescribeMonitor<p>Describes a monitor resource. In addition to listing the properties provided in the <a>CreateMonitor</a> request, this operation lists the following properti
POST/#X-Amz-Target=AmazonForecast.DescribePredictor<note> <p> This operation is only valid for legacy predictors created with CreatePredictor. If you are not using a legacy predictor, use <a>DescribeAutoPredicto
POST/#X-Amz-Target=AmazonForecast.DescribePredictorBacktestExportJob<p>Describes a predictor backtest export job created using the <a>CreatePredictorBacktestExportJob</a> operation.</p> <p>In addition to listing the properties p
POST/#X-Amz-Target=AmazonForecast.DescribeWhatIfAnalysis<p>Describes the what-if analysis created using the <a>CreateWhatIfAnalysis</a> operation.</p> <p>In addition to listing the properties provided in the <code>Cr
POST/#X-Amz-Target=AmazonForecast.DescribeWhatIfForecast<p>Describes the what-if forecast created using the <a>CreateWhatIfForecast</a> operation.</p> <p>In addition to listing the properties provided in the <code>Cr
POST/#X-Amz-Target=AmazonForecast.DescribeWhatIfForecastExport<p>Describes the what-if forecast export created using the <a>CreateWhatIfForecastExport</a> operation.</p> <p>In addition to listing the properties provided in
POST/#X-Amz-Target=AmazonForecast.GetAccuracyMetrics<p>Provides metrics on the accuracy of the models that were trained by the <a>CreatePredictor</a> operation. Use metrics to see how well the model performed and
POST/#X-Amz-Target=AmazonForecast.ListDatasetGroupsReturns a list of dataset groups created using the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html">CreateDatasetGroup</a> o
POST/#X-Amz-Target=AmazonForecast.ListDatasetImportJobsReturns a list of dataset import jobs created using the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetIm
POST/#X-Amz-Target=AmazonForecast.ListDatasetsReturns a list of datasets created using the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html">CreateDataset</a> operation. For ea
POST/#X-Amz-Target=AmazonForecast.ListExplainabilities<p>Returns a list of Explainability resources created using the <a>CreateExplainability</a> operation. This operation returns a summary for each Explainability.
POST/#X-Amz-Target=AmazonForecast.ListExplainabilityExports<p>Returns a list of Explainability exports created using the <a>CreateExplainabilityExport</a> operation. This operation returns a summary for each Explainabil
POST/#X-Amz-Target=AmazonForecast.ListForecastExportJobsReturns a list of forecast export jobs created using the <a>CreateForecastExportJob</a> operation. For each forecast export job, this operation returns a summar
POST/#X-Amz-Target=AmazonForecast.ListForecastsReturns a list of forecasts created using the <a>CreateForecast</a> operation. For each forecast, this operation returns a summary of its properties, including
POST/#X-Amz-Target=AmazonForecast.ListMonitorEvaluations<p>Returns a list of the monitoring evaluation results and predictor events collected by the monitor resource during different windows of time.</p> <p>For infor
POST/#X-Amz-Target=AmazonForecast.ListMonitorsReturns a list of monitors created with the <a>CreateMonitor</a> operation and <a>CreateAutoPredictor</a> operation. For each monitor resource, this operation r
POST/#X-Amz-Target=AmazonForecast.ListPredictorBacktestExportJobs<p>Returns a list of predictor backtest export jobs created using the <a>CreatePredictorBacktestExportJob</a> operation. This operation returns a summary for ea
POST/#X-Amz-Target=AmazonForecast.ListPredictors<p>Returns a list of predictors created using the <a>CreateAutoPredictor</a> or <a>CreatePredictor</a> operations. For each predictor, this operation returns a
POST/#X-Amz-Target=AmazonForecast.ListTagsForResourceLists the tags for an Amazon Forecast resource.
POST/#X-Amz-Target=AmazonForecast.ListWhatIfAnalysesReturns a list of what-if analyses created using the <a>CreateWhatIfAnalysis</a> operation. For each what-if analysis, this operation returns a summary of its p
POST/#X-Amz-Target=AmazonForecast.ListWhatIfForecastExportsReturns a list of what-if forecast exports created using the <a>CreateWhatIfForecastExport</a> operation. For each what-if forecast export, this operation retur
POST/#X-Amz-Target=AmazonForecast.ListWhatIfForecastsReturns a list of what-if forecasts created using the <a>CreateWhatIfForecast</a> operation. For each what-if forecast, this operation returns a summary of its
POST/#X-Amz-Target=AmazonForecast.ResumeResourceResumes a stopped monitor resource.
POST/#X-Amz-Target=AmazonForecast.StopResource<p>Stops a resource.</p> <p>The resource undergoes the following states: <code>CREATE_STOPPING</code> and <code>CREATE_STOPPED</code>. You cannot resume a resou
POST/#X-Amz-Target=AmazonForecast.TagResourceAssociates the specified tags to a resource with the specified <code>resourceArn</code>. If existing tags on a resource are not specified in the request paramet
POST/#X-Amz-Target=AmazonForecast.UntagResourceDeletes the specified tags from a resource.
POST/#X-Amz-Target=AmazonForecast.UpdateDatasetGroup<p>Replaces the datasets in a dataset group with the specified datasets.</p> <note> <p>The <code>Status</code> of the dataset group must be <code>ACTIVE</code>

Questions

Does the Amazon Forecast Service API need an API key?

Yes. The Amazon Forecast Service API uses API key authentication; the documentation explains how to get credentials.

Does the Amazon Forecast Service API support HTTPS?

Yes, the Amazon Forecast Service API is served over HTTPS.

How many endpoints does the Amazon Forecast Service API have?

Its OpenAPI description lists 63 endpoints in version 2018-06-26. All of them are shown on this page.

What are alternatives to the Amazon Forecast Service API?

Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.

Compare alternatives →

Remote Settings PROD

Cloud Platforms

Firefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.

No auth19 endpoints

Linode API

Cloud Platforms

## Introduction The Linode API provides the ability to programmatically manage the full range of Linode products and services. This reference is designed to assist application developers and system administrators. Each endpoint includes descriptions, request syntax, and examples using standard HTTP requests. Response data is returned in JSON format. This document was generated from our OpenAPI Specification. See the <a target="_top" href="https://www.openapis.org">OpenAPI website</a> for more information. <a target="_top" href="/docs/api/openapi.yaml">Download the Linode OpenAPI Specification</a>. ## Changelog <a target="_top" href="/docs/products/tools/api/release-notes/">View our Changelog</a> to see release notes on all changes made to our API. ## Access and Authentication Some endpoints are publicly accessible without requiring authentication. All endpoints affecting your Account, however, require either a Personal Access Token or OAuth authentication (when using third-party applications). ### Personal Access Token The easiest way to access the API is with a Personal Access Token (PAT) generated from the <a target="_top" href="https://cloud.linode.com/profile/tokens">Linode Cloud Manager</a> or the [Create Personal Access Token](/docs/api/profile/#personal-access-token-create) endpoint. All scopes for the OAuth security model ([defined below](/docs/api/profile/#oauth)) apply to this security model as well. #### Authentication | Security Scheme Type: | HTTP | |-----------------------|------| | **HTTP Authorization Scheme** | bearer | ### OAuth If you only need to access the Linode API for personal use, we recommend that you create a [personal access token](/docs/api/#personal-access-token). If you're designing an application that can authenticate with an arbitrary Linode user, then you should use the OAuth 2.0 workflows presented in this section. For a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/products/tools/api/guides/create-an-oauth-app-with-the-python-api-library/#oauth-2-authentication-exchange). Before you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](/docs/api/account/#oauth-client-create) or [via the Cloud Manager](https://cloud.linode.com/profile/clients): - When creating the client, you'll supply a `label` and a `redirect_uri` (referred to as the Callback URL in the Cloud Manager). - The response from this endpoint will give you a `client_id` and a `secret`. - Clients can be public or private, and are private by default. You can choose to make the client public when it is created. - A private client is used with applications which can securely store the client secret (that is, the secret returned to you when you first created the client). For example, an application running on a secured server that only the developer has access to would use a private OAuth client. This is also called a confidential client in some OAuth documentation. - A public client is used with applications where the client secret is not guaranteed to be secure. For example, a native app running on a user's computer may not be able to keep the client secret safe, as a user could potentially inspect the source of the application. So, native apps or apps that run in a user's browser should use a public client. - Public and private clients follow different workflows, as described below. #### OAuth Workflow The OAuth workflow is a series of exchanges between your third-party app and Linode. The workflow is used to authenticate a user before an application can start making API calls on the user's behalf. Notes: - With respect to the diagram in [section 1.2 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-1.2), login.linode.com (referred to in this section as the *login server*) is the Resource Owner and the Authorization Server; api.linode.com (referred to here as the *api se

Bearer token350 endpoints

DigitalOcean API

Cloud Platforms

# Introduction The DigitalOcean API allows you to manage Droplets and resources within the DigitalOcean cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through the API, allowing you to script the complex actions that your situation requires. The API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific endpoints. ## Requests Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required. |Method|Usage| |--- |--- | |GET|For simple retrieval of information about your account, Droplets, or environment, you should use the GET method. The information you request will be returned to you as a JSON object. The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the objects you are querying.| |DELETE|To destroy a resource and remove it from your account and environment, the DELETE method should be used. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found. This idempotency means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.| |PUT|To update the information about a resource in your account, the PUT method is available. Like the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.| |PATCH|Some resources support partial modification. In these cases, the PATCH method is available. Unlike PUT which generally requires a complete representation of a resource, a PATCH request is is a set of instructions on how to modify a resource updating only specific attributes.| |POST|To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.| |HEAD|Finally, to retrieve metadata information, you should use the HEAD method to get the headers. This returns only the header of what would be returned with an associated GET request. Response headers contain some useful information about your API access and the results that are available for your request. For instance, the headers contain your current rate-limit value and the amount of time available until the limit resets. It also contains metrics about the total number of objects found, pagination information, and the total content length.| ## HTTP Statuses Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes. In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered. In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered. Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed. If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having

Bearer token290 endpoints

Vercel API

Cloud Platforms

Vercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.

Bearer token112 endpoints

Platform API

Cloud Platforms

The [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.

HTTP Basic22 endpoints

Azure Data Lake Storage

Cloud Platforms

Azure Data Lake Storage provides storage for Hadoop and other big data workloads.

No auth10 endpoints

Listed from APIs.guru (CC0).