Amazon Forecast
Developer Guide

This is prerelease documentation for a service in preview release. It is subject to change.

As of 6/6/19, Amazon Forecast no longer supports the following recipes: DeepAR, MDN, MLP, MQRNN, RFQR, and SQF. You can continue to use predictors created with these recipes to generate forecasts. However, you can’t use these recipes to create new predictors or to update existing predictors with new data. In addition, AutoML no longer considers these recipes. We’ve made these changes to ensure that Forecast offers the highest level of accuracy and robustness. We continue to support the ARIMA, DeepAR+, ETS, NPTS, and Prophet recipes.

GetSchema

Returns a schema (a list of fields and datatypes) that is associated with a dataset domain and a dataset type within the domain. For a list of dataset domains, see GetDomains. For a list of types, see GetDatasetTypes. For a conceptual overview, see Datasets.

Request Syntax

{ "DatasetType": "string", "Domain": "string" }

Request Parameters

The request accepts the following data in JSON format.

DatasetType

A dataset type within the specified domain.

Type: String

Valid Values: TARGET_TIME_SERIES | RELATED_TIME_SERIES | ITEM_METADATA

Required: Yes

Domain

A dataset domain name.

Type: String

Valid Values: RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE | WEB_TRAFFIC | METRICS

Required: Yes

Response Syntax

{ "Schema": [ { "Attribute": { "AggregationMethod": "string", "AttributeName": "string", "AttributeType": "string", "BackFillMethod": "string", "FeatureType": "string", "FillMethod": "string", "FillValue": "string", "FrontFillMethod": "string" }, "Required": "string" } ] }

Response Elements

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

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

Schema

The schema for a dataset domain and dataset type within the domain. If you specify the domain and type in the request, the operation returns a specific schema. If you specify only a domain, the response returns schemas for all of the types within the domain. If you don't provide a domain or a type in the request, the operation returns all of the schemas.

Type: Array of CanonicalSchemaAttribute objects

Errors

InternalServiceException

Request processing has failed due to some unknown error, exception, or failure.

HTTP Status Code: 400

InvalidInputException

We can't process the request because it includes an invalid value or a value that exceeds the valid range.

HTTP Status Code: 400

ResourceAlreadyExistsException

There is already a resource with this name and characteristics. Try again with different settings.

HTTP Status Code: 400

ResourceNotFoundException

We can't find a resource with that name. Check the name and try again.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: