You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.ForecastService

Inherits:
AWS.Service show all
Identifier:
forecastservice
API Version:
2018-06-26
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Provides APIs for creating and managing Amazon Forecast resources.

Sending a Request Using ForecastService

var forecastservice = new AWS.ForecastService();
forecastservice.createDataset(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the ForecastService object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var forecastservice = new AWS.ForecastService({apiVersion: '2018-06-26'});

You can also set the API version globally in AWS.config.apiVersions using the forecastservice service identifier:

AWS.config.apiVersions = {
  forecastservice: '2018-06-26',
  // other service API versions
};

var forecastservice = new AWS.ForecastService();

Version:

  • 2018-06-26

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.ForecastService(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a ForecastService object

var forecastservice = new AWS.ForecastService({apiVersion: '2018-06-26'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.ForecastService.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.ForecastService.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.ForecastService.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

createDataset(params = {}, callback) ⇒ AWS.Request

Creates an Amazon Forecast dataset. The information about the dataset that you provide helps Forecast understand how to consume the data for model training. This includes the following:

  • DataFrequency - How frequently your historical time-series data is collected.

  • Domain and DatasetType - Each dataset has an associated dataset domain and a type within the domain. Amazon Forecast provides a list of predefined domains and types within each domain. For each unique dataset domain and type within the domain, Amazon Forecast requires your data to include a minimum set of predefined fields.

  • Schema - A schema specifies the fields in the dataset, including the field name and data type.

After creating a dataset, you import your training data into it and add the dataset to a dataset group. You use the dataset group to create a predictor. For more information, see howitworks-datasets-groups.

To get a list of all your datasets, use the ListDatasets operation.

For example Forecast datasets, see the Amazon Forecast Sample GitHub repository.

Note: The Status of a dataset must be ACTIVE before you can import training data. Use the DescribeDataset operation to get the status.

Service Reference:

Examples:

Calling the createDataset operation

var params = {
  DatasetName: 'STRING_VALUE', /* required */
  DatasetType: TARGET_TIME_SERIES | RELATED_TIME_SERIES | ITEM_METADATA, /* required */
  Domain: RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE | WEB_TRAFFIC | METRICS, /* required */
  Schema: { /* required */
    Attributes: [
      {
        AttributeName: 'STRING_VALUE',
        AttributeType: string | integer | float | timestamp | geolocation
      },
      /* more items */
    ]
  },
  DataFrequency: 'STRING_VALUE',
  EncryptionConfig: {
    KMSKeyArn: 'STRING_VALUE', /* required */
    RoleArn: 'STRING_VALUE' /* required */
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
forecastservice.createDataset(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DatasetName — (String)

      A name for the dataset.

    • Domain — (String)

      The domain associated with the dataset. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDatasetGroup operation must match.

      The Domain and DatasetType that you choose determine the fields that must be present in the training data that you import to the dataset. For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires item_id, timestamp, and demand fields to be present in your data. For more information, see howitworks-datasets-groups.

      Possible values include:
      • "RETAIL"
      • "CUSTOM"
      • "INVENTORY_PLANNING"
      • "EC2_CAPACITY"
      • "WORK_FORCE"
      • "WEB_TRAFFIC"
      • "METRICS"
    • DatasetType — (String)

      The dataset type. Valid values depend on the chosen Domain.

      Possible values include:
      • "TARGET_TIME_SERIES"
      • "RELATED_TIME_SERIES"
      • "ITEM_METADATA"
    • DataFrequency — (String)

      The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.

      Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "D" indicates every day and "15min" indicates every 15 minutes.

    • Schema — (map)

      The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset Domain and DatasetType that you choose determine the minimum required fields in your training data. For information about the required fields for a specific dataset domain and type, see howitworks-domains-ds-types.

      • Attributes — (Array<map>)

        An array of attributes specifying the name and type of each field in a dataset.

        • AttributeName — (String)

          The name of the dataset field.

        • AttributeType — (String)

          The data type of the field.

          Possible values include:
          • "string"
          • "integer"
          • "float"
          • "timestamp"
          • "geolocation"
    • EncryptionConfig — (map)

      An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

      • RoleArn — required — (String)

        The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.

        Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

      • KMSKeyArn — required — (String)

        The Amazon Resource Name (ARN) of the KMS key.

    • Tags — (Array<map>)

      The optional metadata that you apply to the dataset to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

      The following basic restrictions apply to tags:

      • Maximum number of tags per resource - 50.

      • For each resource, each tag key must be unique, and each tag key can have only one value.

      • Maximum key length - 128 Unicode characters in UTF-8.

      • Maximum value length - 256 Unicode characters in UTF-8.

      • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

      • Tag keys and values are case sensitive.

      • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

      • Key — required — (String)

        One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.

      • Value — required — (String)

        The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DatasetArn — (String)

        The Amazon Resource Name (ARN) of the dataset.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createDatasetGroup(params = {}, callback) ⇒ AWS.Request

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 by using the UpdateDatasetGroup operation.

After creating a dataset group and adding datasets, you use the dataset group when you create a predictor. For more information, see howitworks-datasets-groups.

To get a list of all your datasets groups, use the ListDatasetGroups operation.

Note: The Status of a dataset group must be ACTIVE before you can use the dataset group to create a predictor. To get the status, use the DescribeDatasetGroup operation.

Service Reference:

Examples:

Calling the createDatasetGroup operation

var params = {
  DatasetGroupName: 'STRING_VALUE', /* required */
  Domain: RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE | WEB_TRAFFIC | METRICS, /* required */
  DatasetArns: [
    'STRING_VALUE',
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
forecastservice.createDatasetGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DatasetGroupName — (String)

      A name for the dataset group.

    • Domain — (String)

      The domain associated with the dataset group. When you add a dataset to a dataset group, this value and the value specified for the Domain parameter of the CreateDataset operation must match.

      The Domain and DatasetType that you choose determine the fields that must be present in training data that you import to a dataset. For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires that item_id, timestamp, and demand fields are present in your data. For more information, see howitworks-datasets-groups.

      Possible values include:
      • "RETAIL"
      • "CUSTOM"
      • "INVENTORY_PLANNING"
      • "EC2_CAPACITY"
      • "WORK_FORCE"
      • "WEB_TRAFFIC"
      • "METRICS"
    • DatasetArns — (Array<String>)

      An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.

    • Tags — (Array<map>)

      The optional metadata that you apply to the dataset group to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

      The following basic restrictions apply to tags:

      • Maximum number of tags per resource - 50.

      • For each resource, each tag key must be unique, and each tag key can have only one value.

      • Maximum key length - 128 Unicode characters in UTF-8.

      • Maximum value length - 256 Unicode characters in UTF-8.

      • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

      • Tag keys and values are case sensitive.

      • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

      • Key — required — (String)

        One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.

      • Value — required — (String)

        The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DatasetGroupArn — (String)

        The Amazon Resource Name (ARN) of the dataset group.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createDatasetImportJob(params = {}, callback) ⇒ AWS.Request

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) bucket and the Amazon Resource Name (ARN) of the dataset that you want to import the data to.

You must specify a DataSource object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy of your data and processes it in an internal AWS system. For more information, see aws-forecast-iam-roles.

The training data must be in CSV format. The delimiter must be a comma (,).

You can specify the path to a specific CSV file, the S3 bucket, or to a folder in the S3 bucket. For the latter two cases, Amazon Forecast imports all files up to the limit of 10,000 files.

Because dataset imports are not aggregated, your most recent dataset import is the one that is used when training a predictor or generating a forecast. Make sure that your most recent dataset import contains all of the data you want to model off of, and not just the new data collected since the previous import.

To get a list of all your dataset import jobs, filtered by specified criteria, use the ListDatasetImportJobs operation.

Service Reference:

Examples:

Calling the createDatasetImportJob operation

var params = {
  DataSource: { /* required */
    S3Config: { /* required */
      Path: 'STRING_VALUE', /* required */
      RoleArn: 'STRING_VALUE', /* required */
      KMSKeyArn: 'STRING_VALUE'
    }
  },
  DatasetArn: 'STRING_VALUE', /* required */
  DatasetImportJobName: 'STRING_VALUE', /* required */
  GeolocationFormat: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  TimeZone: 'STRING_VALUE',
  TimestampFormat: 'STRING_VALUE',
  UseGeolocationForTimeZone: true || false
};
forecastservice.createDatasetImportJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DatasetImportJobName — (String)

      The name for the dataset import job. We recommend including the current timestamp in the name, for example, 20190721DatasetImport. This can help you avoid getting a ResourceAlreadyExistsException exception.

    • DatasetArn — (String)

      The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want to import data to.

    • DataSource — (map)

      The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data. The training data must be stored in an Amazon S3 bucket.

      If encryption is used, DataSource must include an AWS Key Management Service (KMS) key and the IAM role must allow Amazon Forecast permission to access the key. The KMS key and IAM role must match those specified in the EncryptionConfig parameter of the CreateDataset operation.

      • S3Config — required — (map)

        The path to the training data stored in an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the data.

        • Path — required — (String)

          The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.

        • RoleArn — required — (String)

          The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the KMSKeyArn key, the role must allow access to the key.

          Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

        • KMSKeyArn — (String)

          The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.

    • TimestampFormat — (String)

      The format of timestamps in the dataset. The format that you specify depends on the DataFrequency specified when the dataset was created. The following formats are supported

      • "yyyy-MM-dd"

        For the following data frequencies: Y, M, W, and D

      • "yyyy-MM-dd HH:mm:ss"

        For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D

      If the format isn't specified, Amazon Forecast expects the format to be "yyyy-MM-dd HH:mm:ss".

    • TimeZone — (String)

      A single time zone for every item in your dataset. This option is ideal for datasets with all timestamps within a single time zone, or if all timestamps are normalized to a single time zone.

      Refer to the Joda-Time API for a complete list of valid time zone names.

    • UseGeolocationForTimeZone — (Boolean)

      Automatically derive time zone information from the geolocation attribute. This option is ideal for datasets that contain timestamps in multiple time zones and those timestamps are expressed in local time.

    • GeolocationFormat — (String)

      The format of the geolocation attribute. The geolocation attribute can be formatted in one of two ways:

      • LAT_LONG - the latitude and longitude in decimal format (Example: 47.61_-122.33).

      • CC_POSTALCODE (US Only) - the country code (US), followed by the 5-digit ZIP code (Example: US_98121).

    • Tags — (Array<map>)

      The optional metadata that you apply to the dataset import job to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

      The following basic restrictions apply to tags:

      • Maximum number of tags per resource - 50.

      • For each resource, each tag key must be unique, and each tag key can have only one value.

      • Maximum key length - 128 Unicode characters in UTF-8.

      • Maximum value length - 256 Unicode characters in UTF-8.

      • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

      • Tag keys and values are case sensitive.

      • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

      • Key — required — (String)

        One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.

      • Value — required — (String)

        The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DatasetImportJobArn — (String)

        The Amazon Resource Name (ARN) of the dataset import job.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createForecast(params = {}, callback) ⇒ AWS.Request

Creates 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 for a single item at low latency, use the operation. To export the complete forecast into your Amazon Simple Storage Service (Amazon S3) bucket, use the CreateForecastExportJob operation.

The range of the forecast is determined by the ForecastHorizon value, which you specify in the CreatePredictor request. When you query a forecast, you can request a specific date range within the forecast.

To get a list of all your forecasts, use the ListForecasts operation.

Note: The forecasts generated by Amazon Forecast are in the same time zone as the dataset that was used to create the predictor.

For more information, see howitworks-forecast.

Note: The Status of the forecast must be ACTIVE before you can query or export the forecast. Use the DescribeForecast operation to get the status.

Service Reference:

Examples:

Calling the createForecast operation

var params = {
  ForecastName: 'STRING_VALUE', /* required */
  PredictorArn: 'STRING_VALUE', /* required */
  ForecastTypes: [
    'STRING_VALUE',
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
forecastservice.createForecast(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ForecastName — (String)

      A name for the forecast.

    • PredictorArn — (String)

      The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.

    • ForecastTypes — (Array<String>)

      The quantiles at which probabilistic forecasts are generated. You can currently specify up to 5 quantiles per forecast. Accepted values include 0.01 to 0.99 (increments of .01 only) and mean. The mean forecast is different from the median (0.50) when the distribution is not symmetric (for example, Beta and Negative Binomial). The default value is ["0.1", "0.5", "0.9"].

    • Tags — (Array<map>)

      The optional metadata that you apply to the forecast to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

      The following basic restrictions apply to tags:

      • Maximum number of tags per resource - 50.

      • For each resource, each tag key must be unique, and each tag key can have only one value.

      • Maximum key length - 128 Unicode characters in UTF-8.

      • Maximum value length - 256 Unicode characters in UTF-8.

      • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

      • Tag keys and values are case sensitive.

      • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

      • Key — required — (String)

        One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.

      • Value — required — (String)

        The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ForecastArn — (String)

        The Amazon Resource Name (ARN) of the forecast.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createForecastExportJob(params = {}, callback) ⇒ AWS.Request

Exports a forecast created by the CreateForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions:

<ForecastExportJobName><ExportTimestamp><PartNumber>

where the <ExportTimestamp> component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).

You must specify a DataDestination object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.

For more information, see howitworks-forecast.

To get a list of all your forecast export jobs, use the ListForecastExportJobs operation.

Note: The Status of the forecast export job must be ACTIVE before you can access the forecast in your Amazon S3 bucket. To get the status, use the DescribeForecastExportJob operation.

Service Reference:

Examples:

Calling the createForecastExportJob operation

var params = {
  Destination: { /* required */
    S3Config: { /* required */
      Path: 'STRING_VALUE', /* required */
      RoleArn: 'STRING_VALUE', /* required */
      KMSKeyArn: 'STRING_VALUE'
    }
  },
  ForecastArn: 'STRING_VALUE', /* required */
  ForecastExportJobName: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
forecastservice.createForecastExportJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ForecastExportJobName — (String)

      The name for the forecast export job.

    • ForecastArn — (String)

      The Amazon Resource Name (ARN) of the forecast that you want to export.

    • Destination — (map)

      The location where you want to save the forecast and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3 bucket.

      If encryption is used, Destination must include an AWS Key Management Service (KMS) key. The IAM role must allow Amazon Forecast permission to access the key.

      • S3Config — required — (map)

        The path to an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the bucket.

        • Path — required — (String)

          The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.

        • RoleArn — required — (String)

          The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the KMSKeyArn key, the role must allow access to the key.

          Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

        • KMSKeyArn — (String)

          The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.

    • Tags — (Array<map>)

      The optional metadata that you apply to the forecast export job to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

      The following basic restrictions apply to tags:

      • Maximum number of tags per resource - 50.

      • For each resource, each tag key must be unique, and each tag key can have only one value.

      • Maximum key length - 128 Unicode characters in UTF-8.

      • Maximum value length - 256 Unicode characters in UTF-8.

      • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

      • Tag keys and values are case sensitive.

      • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

      • Key — required — (String)

        One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.

      • Value — required — (String)

        The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ForecastExportJobArn — (String)

        The Amazon Resource Name (ARN) of the export job.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createPredictor(params = {}, callback) ⇒ AWS.Request

Creates an Amazon Forecast predictor.

In the request, provide a dataset group and either specify an algorithm or let Amazon Forecast choose an algorithm for you using AutoML. If you specify an algorithm, you also can override algorithm-specific hyperparameters.

Amazon Forecast uses the algorithm to train a predictor using the latest version of the datasets in the specified dataset group. You can then generate a forecast using the CreateForecast operation.

To see the evaluation metrics, use the GetAccuracyMetrics operation.

You can specify a featurization configuration to fill and aggregate the data fields in the TARGET_TIME_SERIES dataset to improve model training. For more information, see FeaturizationConfig.

For RELATED_TIME_SERIES datasets, CreatePredictor verifies that the DataFrequency specified when the dataset was created matches the ForecastFrequency. TARGET_TIME_SERIES datasets don't have this restriction. Amazon Forecast also verifies the delimiter and timestamp format. For more information, see howitworks-datasets-groups.

By default, predictors are trained and evaluated at the 0.1 (P10), 0.5 (P50), and 0.9 (P90) quantiles. You can choose custom forecast types to train and evaluate your predictor by setting the ForecastTypes.

AutoML

If you want Amazon Forecast to evaluate each algorithm and choose the one that minimizes the objective function, set PerformAutoML to true. The objective function is defined as the mean of the weighted losses over the forecast types. By default, these are the p10, p50, and p90 quantile losses. For more information, see EvaluationResult.

When AutoML is enabled, the following properties are disallowed:

  • AlgorithmArn

  • HPOConfig

  • PerformHPO

  • TrainingParameters

To get a list of all of your predictors, use the ListPredictors operation.

Note: Before you can use the predictor to create a forecast, the Status of the predictor must be ACTIVE, signifying that training has completed. To get the status, use the DescribePredictor operation.

Service Reference:

Examples:

Calling the createPredictor operation

var params = {
  FeaturizationConfig: { /* required */
    ForecastFrequency: 'STRING_VALUE', /* required */
    Featurizations: [
      {
        AttributeName: 'STRING_VALUE', /* required */
        FeaturizationPipeline: [
          {
            FeaturizationMethodName: filling, /* required */
            FeaturizationMethodParameters: {
              '<ParameterKey>': 'STRING_VALUE',
              /* '<ParameterKey>': ... */
            }
          },
          /* more items */
        ]
      },
      /* more items */
    ],
    ForecastDimensions: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  ForecastHorizon: 'NUMBER_VALUE', /* required */
  InputDataConfig: { /* required */
    DatasetGroupArn: 'STRING_VALUE', /* required */
    SupplementaryFeatures: [
      {
        Name: 'STRING_VALUE', /* required */
        Value: 'STRING_VALUE' /* required */
      },
      /* more items */
    ]
  },
  PredictorName: 'STRING_VALUE', /* required */
  AlgorithmArn: 'STRING_VALUE',
  AutoMLOverrideStrategy: LatencyOptimized,
  EncryptionConfig: {
    KMSKeyArn: 'STRING_VALUE', /* required */
    RoleArn: 'STRING_VALUE' /* required */
  },
  EvaluationParameters: {
    BackTestWindowOffset: 'NUMBER_VALUE',
    NumberOfBacktestWindows: 'NUMBER_VALUE'
  },
  ForecastTypes: [
    'STRING_VALUE',
    /* more items */
  ],
  HPOConfig: {
    ParameterRanges: {
      CategoricalParameterRanges: [
        {
          Name: 'STRING_VALUE', /* required */
          Values: [ /* required */
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ],
      ContinuousParameterRanges: [
        {
          MaxValue: 'NUMBER_VALUE', /* required */
          MinValue: 'NUMBER_VALUE', /* required */
          Name: 'STRING_VALUE', /* required */
          ScalingType: Auto | Linear | Logarithmic | ReverseLogarithmic
        },
        /* more items */
      ],
      IntegerParameterRanges: [
        {
          MaxValue: 'NUMBER_VALUE', /* required */
          MinValue: 'NUMBER_VALUE', /* required */
          Name: 'STRING_VALUE', /* required */
          ScalingType: Auto | Linear | Logarithmic | ReverseLogarithmic
        },
        /* more items */
      ]
    }
  },
  OptimizationMetric: WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE,
  PerformAutoML: true || false,
  PerformHPO: true || false,
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  TrainingParameters: {
    '<ParameterKey>': 'STRING_VALUE',
    /* '<ParameterKey>': ... */
  }
};
forecastservice.createPredictor(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • PredictorName — (String)

      A name for the predictor.

    • AlgorithmArn — (String)

      The Amazon Resource Name (ARN) of the algorithm to use for model training. Required if PerformAutoML is not set to true.

      Supported algorithms:

      • arn:aws:forecast:::algorithm/ARIMA

      • arn:aws:forecast:::algorithm/CNN-QR

      • arn:aws:forecast:::algorithm/Deep_AR_Plus

      • arn:aws:forecast:::algorithm/ETS

      • arn:aws:forecast:::algorithm/NPTS

      • arn:aws:forecast:::algorithm/Prophet

    • ForecastHorizon — (Integer)

      Specifies the number of time-steps that the model is trained to predict. The forecast horizon is also called the prediction length.

      For example, if you configure a dataset for daily data collection (using the DataFrequency parameter of the CreateDataset operation) and set the forecast horizon to 10, the model returns predictions for 10 days.

      The maximum forecast horizon is the lesser of 500 time-steps or 1/3 of the TARGET_TIME_SERIES dataset length.

    • ForecastTypes — (Array<String>)

      Specifies the forecast types used to train a predictor. You can specify up to five forecast types. Forecast types can be quantiles from 0.01 to 0.99, by increments of 0.01 or higher. You can also specify the mean forecast with mean.

      The default value is ["0.10", "0.50", "0.9"].

    • PerformAutoML — (Boolean)

      Whether to perform AutoML. When Amazon Forecast performs AutoML, it evaluates the algorithms it provides and chooses the best algorithm and configuration for your training dataset.

      The default value is false. In this case, you are required to specify an algorithm.

      Set PerformAutoML to true to have Amazon Forecast perform AutoML. This is a good option if you aren't sure which algorithm is suitable for your training data. In this case, PerformHPO must be false.

    • AutoMLOverrideStrategy — (String)
      Note: The LatencyOptimized AutoML override strategy is only available in private beta. Contact AWS Support or your account manager to learn more about access privileges.

      Used to overide the default AutoML strategy, which is to optimize predictor accuracy. To apply an AutoML strategy that minimizes training time, use LatencyOptimized.

      This parameter is only valid for predictors trained using AutoML.

      Possible values include:
      • "LatencyOptimized"
    • PerformHPO — (Boolean)

      Whether to perform hyperparameter optimization (HPO). HPO finds optimal hyperparameter values for your training data. The process of performing HPO is known as running a hyperparameter tuning job.

      The default value is false. In this case, Amazon Forecast uses default hyperparameter values from the chosen algorithm.

      To override the default values, set PerformHPO to true and, optionally, supply the HyperParameterTuningJobConfig object. The tuning job specifies a metric to optimize, which hyperparameters participate in tuning, and the valid range for each tunable hyperparameter. In this case, you are required to specify an algorithm and PerformAutoML must be false.

      The following algorithms support HPO:

      • DeepAR+

      • CNN-QR

    • TrainingParameters — (map<String>)

      The hyperparameters to override for model training. The hyperparameters that you can override are listed in the individual algorithms. For the list of supported algorithms, see aws-forecast-choosing-recipes.

    • EvaluationParameters — (map)

      Used to override the default evaluation parameters of the specified algorithm. Amazon Forecast evaluates a predictor by splitting a dataset into training data and testing data. The evaluation parameters define how to perform the split and the number of iterations.

      • NumberOfBacktestWindows — (Integer)

        The number of times to split the input data. The default is 1. Valid values are 1 through 5.

      • BackTestWindowOffset — (Integer)

        The point from the end of the dataset where you want to split the data for model training and testing (evaluation). Specify the value as the number of data points. The default is the value of the forecast horizon. BackTestWindowOffset can be used to mimic a past virtual forecast start date. This value must be greater than or equal to the forecast horizon and less than half of the TARGET_TIME_SERIES dataset length.

        ForecastHorizon <= BackTestWindowOffset < 1/2 * TARGET_TIME_SERIES dataset length

    • HPOConfig — (map)

      Provides hyperparameter override values for the algorithm. If you don't provide this parameter, Amazon Forecast uses default values. The individual algorithms specify which hyperparameters support hyperparameter optimization (HPO). For more information, see aws-forecast-choosing-recipes.

      If you included the HPOConfig object, you must set PerformHPO to true.

      • ParameterRanges — (map)

        Specifies the ranges of valid values for the hyperparameters.

        • CategoricalParameterRanges — (Array<map>)

          Specifies the tunable range for each categorical hyperparameter.

          • Name — required — (String)

            The name of the categorical hyperparameter to tune.

          • Values — required — (Array<String>)

            A list of the tunable categories for the hyperparameter.

        • ContinuousParameterRanges — (Array<map>)

          Specifies the tunable range for each continuous hyperparameter.

          • Name — required — (String)

            The name of the hyperparameter to tune.

          • MaxValue — required — (Float)

            The maximum tunable value of the hyperparameter.

          • MinValue — required — (Float)

            The minimum tunable value of the hyperparameter.

          • ScalingType — (String)

            The scale that hyperparameter tuning uses to search the hyperparameter range. Valid values:

            Auto

            Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.

            Linear

            Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

            Logarithmic

            Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

            Logarithmic scaling works only for ranges that have values greater than 0.

            ReverseLogarithmic

            hyperparameter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale.

            Reverse logarithmic scaling works only for ranges that are entirely within the range 0 <= x < 1.0.

            For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

            Possible values include:
            • "Auto"
            • "Linear"
            • "Logarithmic"
            • "ReverseLogarithmic"
        • IntegerParameterRanges — (Array<map>)

          Specifies the tunable range for each integer hyperparameter.

          • Name — required — (String)

            The name of the hyperparameter to tune.

          • MaxValue — required — (Integer)

            The maximum tunable value of the hyperparameter.

          • MinValue — required — (Integer)

            The minimum tunable value of the hyperparameter.

          • ScalingType — (String)

            The scale that hyperparameter tuning uses to search the hyperparameter range. Valid values:

            Auto

            Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.

            Linear

            Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

            Logarithmic

            Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

            Logarithmic scaling works only for ranges that have values greater than 0.

            ReverseLogarithmic

            Not supported for IntegerParameterRange.

            Reverse logarithmic scaling works only for ranges that are entirely within the range 0 <= x < 1.0.

            For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

            Possible values include:
            • "Auto"
            • "Linear"
            • "Logarithmic"
            • "ReverseLogarithmic"
    • InputDataConfig — (map)

      Describes the dataset group that contains the data to use to train the predictor.

      • DatasetGroupArn — required — (String)

        The Amazon Resource Name (ARN) of the dataset group.

      • SupplementaryFeatures — (Array<map>)

        An array of supplementary features. The only supported feature is a holiday calendar.

        • Name — required — (String)

          The name of the feature. Valid values: "holiday" and "weather".

        • Value — required — (String)

          Weather Index

          To enable the Weather Index, set the value to "true"

          Holidays

          To enable Holidays, specify a country with one of the following two-letter country codes:

          • "AL" - ALBANIA

          • "AR" - ARGENTINA

          • "AT" - AUSTRIA

          • "AU" - AUSTRALIA

          • "BA" - BOSNIA HERZEGOVINA

          • "BE" - BELGIUM

          • "BG" - BULGARIA

          • "BO" - BOLIVIA

          • "BR" - BRAZIL

          • "BY" - BELARUS

          • "CA" - CANADA

          • "CL" - CHILE

          • "CO" - COLOMBIA

          • "CR" - COSTA RICA

          • "HR" - CROATIA

          • "CZ" - CZECH REPUBLIC

          • "DK" - DENMARK

          • "EC" - ECUADOR

          • "EE" - ESTONIA

          • "ET" - ETHIOPIA

          • "FI" - FINLAND

          • "FR" - FRANCE

          • "DE" - GERMANY

          • "GR" - GREECE

          • "HU" - HUNGARY

          • "IS" - ICELAND

          • "IN" - INDIA

          • "IE" - IRELAND

          • "IT" - ITALY

          • "JP" - JAPAN

          • "KZ" - KAZAKHSTAN

          • "KR" - KOREA

          • "LV" - LATVIA

          • "LI" - LIECHTENSTEIN

          • "LT" - LITHUANIA

          • "LU" - LUXEMBOURG

          • "MK" - MACEDONIA

          • "MT" - MALTA

          • "MX" - MEXICO

          • "MD" - MOLDOVA

          • "ME" - MONTENEGRO

          • "NL" - NETHERLANDS

          • "NZ" - NEW ZEALAND

          • "NI" - NICARAGUA

          • "NG" - NIGERIA

          • "NO" - NORWAY

          • "PA" - PANAMA

          • "PY" - PARAGUAY

          • "PE" - PERU

          • "PL" - POLAND

          • "PT" - PORTUGAL

          • "RO" - ROMANIA

          • "RU" - RUSSIA

          • "RS" - SERBIA

          • "SK" - SLOVAKIA

          • "SI" - SLOVENIA

          • "ZA" - SOUTH AFRICA

          • "ES" - SPAIN

          • "SE" - SWEDEN

          • "CH" - SWITZERLAND

          • "UA" - UKRAINE

          • "AE" - UNITED ARAB EMIRATES

          • "US" - UNITED STATES

          • "UK" - UNITED KINGDOM

          • "UY" - URUGUAY

          • "VE" - VENEZUELA

    • FeaturizationConfig — (map)

      The featurization configuration.

      • ForecastFrequency — required — (String)

        The frequency of predictions in a forecast.

        Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "Y" indicates every year and "5min" indicates every five minutes.

        The frequency must be greater than or equal to the TARGET_TIME_SERIES dataset frequency.

        When a RELATED_TIME_SERIES dataset is provided, the frequency must be equal to the RELATED_TIME_SERIES dataset frequency.

      • ForecastDimensions — (Array<String>)

        An array of dimension (field) names that specify how to group the generated forecast.

        For example, suppose that you are generating a forecast for item sales across all of your stores, and your dataset contains a store_id field. If you want the sales forecast for each item by store, you would specify store_id as the dimension.

        All forecast dimensions specified in the TARGET_TIME_SERIES dataset don't need to be specified in the CreatePredictor request. All forecast dimensions specified in the RELATED_TIME_SERIES dataset must be specified in the CreatePredictor request.

      • Featurizations — (Array<map>)

        An array of featurization (transformation) information for the fields of a dataset.

        • AttributeName — required — (String)

          The name of the schema attribute that specifies the data field to be featurized. Amazon Forecast supports the target field of the TARGET_TIME_SERIES and the RELATED_TIME_SERIES datasets. For example, for the RETAIL domain, the target is demand, and for the CUSTOM domain, the target is target_value. For more information, see howitworks-missing-values.

        • FeaturizationPipeline — (Array<map>)

          An array of one FeaturizationMethod object that specifies the feature transformation method.

          • FeaturizationMethodName — required — (String)

            The name of the method. The "filling" method is the only supported method.

            Possible values include:
            • "filling"
          • FeaturizationMethodParameters — (map<String>)

            The method parameters (key-value pairs), which are a map of override parameters. Specify these parameters to override the default values. Related Time Series attributes do not accept aggregation parameters.

            The following list shows the parameters and their valid values for the "filling" featurization method for a Target Time Series dataset. Bold signifies the default value.

            • aggregation: sum, avg, first, min, max

            • frontfill: none

            • middlefill: zero, nan (not a number), value, median, mean, min, max

            • backfill: zero, nan, value, median, mean, min, max

            The following list shows the parameters and their valid values for a Related Time Series featurization method (there are no defaults):

            • middlefill: zero, value, median, mean, min, max

            • backfill: zero, value, median, mean, min, max

            • futurefill: zero, value, median, mean, min, max

            To set a filling method to a specific value, set the fill parameter to value and define the value in a corresponding _value parameter. For example, to set backfilling to a value of 2, include the following: "backfill": "value" and "backfill_value":"2".

    • EncryptionConfig — (map)

      An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

      • RoleArn — required — (String)

        The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.

        Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

      • KMSKeyArn — required — (String)

        The Amazon Resource Name (ARN) of the KMS key.

    • Tags — (Array<map>)

      The optional metadata that you apply to the predictor to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

      The following basic restrictions apply to tags:

      • Maximum number of tags per resource - 50.

      • For each resource, each tag key must be unique, and each tag key can have only one value.

      • Maximum key length - 128 Unicode characters in UTF-8.

      • Maximum value length - 256 Unicode characters in UTF-8.

      • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

      • Tag keys and values are case sensitive.

      • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

      • Key — required — (String)

        One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.

      • Value — required — (String)

        The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).

    • OptimizationMetric — (String)

      The accuracy metric used to optimize the predictor.

      Possible values include:
      • "WAPE"
      • "RMSE"
      • "AverageWeightedQuantileLoss"
      • "MASE"
      • "MAPE"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PredictorArn — (String)

        The Amazon Resource Name (ARN) of the predictor.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createPredictorBacktestExportJob(params = {}, callback) ⇒ AWS.Request

Exports backtest forecasts and accuracy metrics generated by the CreatePredictor operation. Two folders containing CSV files are exported to your specified S3 bucket.

The export file names will match the following conventions:

<ExportJobName>_<ExportTimestamp>_<PartNumber>.csv

The <ExportTimestamp> component is in Java SimpleDate format (yyyy-MM-ddTHH-mm-ssZ).

You must specify a DataDestination object that includes an Amazon S3 bucket and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.

Note: The Status of the export job must be ACTIVE before you can access the export in your Amazon S3 bucket. To get the status, use the DescribePredictorBacktestExportJob operation.

Service Reference:

Examples:

Calling the createPredictorBacktestExportJob operation

var params = {
  Destination: { /* required */
    S3Config: { /* required */
      Path: 'STRING_VALUE', /* required */
      RoleArn: 'STRING_VALUE', /* required */
      KMSKeyArn: 'STRING_VALUE'
    }
  },
  PredictorArn: 'STRING_VALUE', /* required */
  PredictorBacktestExportJobName: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
forecastservice.createPredictorBacktestExportJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • PredictorBacktestExportJobName — (String)

      The name for the backtest export job.

    • PredictorArn — (String)

      The Amazon Resource Name (ARN) of the predictor that you want to export.

    • Destination — (map)

      The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an AWS Key Management Service (KMS) key (optional).

      • S3Config — required — (map)

        The path to an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the bucket.

        • Path — required — (String)

          The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.

        • RoleArn — required — (String)

          The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the KMSKeyArn key, the role must allow access to the key.

          Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

        • KMSKeyArn — (String)

          The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.

    • Tags — (Array<map>)

      Optional metadata to help you categorize and organize your backtests. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.

      The following restrictions apply to tags:

      • For each resource, each tag key must be unique and each tag key must have one value.

      • Maximum number of tags per resource: 50.

      • Maximum key length: 128 Unicode characters in UTF-8.

      • Maximum value length: 256 Unicode characters in UTF-8.

      • Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.

      • Key prefixes cannot include any upper or lowercase combination of aws: or AWS:. Values can have this prefix. If a tag value has aws as its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.

      • Key — required — (String)

        One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.

      • Value — required — (String)

        The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PredictorBacktestExportJobArn — (String)

        The Amazon Resource Name (ARN) of the predictor backtest export job that you want to export.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteDataset(params = {}, callback) ⇒ AWS.Request

Deletes an Amazon Forecast dataset that was created using the CreateDataset operation. You can only delete datasets that have a status of ACTIVE or CREATE_FAILED. To get the status use the DescribeDataset operation.

Note: Forecast does not automatically update any dataset groups that contain the deleted dataset. In order to update the dataset group, use the operation, omitting the deleted dataset's ARN.

Service Reference:

Examples:

Calling the deleteDataset operation

var params = {
  DatasetArn: 'STRING_VALUE' /* required */
};
forecastservice.deleteDataset(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DatasetArn — (String)

      The Amazon Resource Name (ARN) of the dataset to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteDatasetGroup(params = {}, callback) ⇒ AWS.Request

Deletes a dataset group created using the CreateDatasetGroup operation. You can only delete dataset groups that have a status of ACTIVE, CREATE_FAILED, or UPDATE_FAILED. To get the status, use the DescribeDatasetGroup operation.

This operation deletes only the dataset group, not the datasets in the group.

Service Reference:

Examples:

Calling the deleteDatasetGroup operation

var params = {
  DatasetGroupArn: 'STRING_VALUE' /* required */
};
forecastservice.deleteDatasetGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DatasetGroupArn — (String)

      The Amazon Resource Name (ARN) of the dataset group to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteDatasetImportJob(params = {}, callback) ⇒ AWS.Request

Deletes a dataset import job created using the CreateDatasetImportJob operation. You can delete only dataset import jobs that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeDatasetImportJob operation.

Service Reference:

Examples:

Calling the deleteDatasetImportJob operation

var params = {
  DatasetImportJobArn: 'STRING_VALUE' /* required */
};
forecastservice.deleteDatasetImportJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DatasetImportJobArn — (String)

      The Amazon Resource Name (ARN) of the dataset import job to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteForecast(params = {}, callback) ⇒ AWS.Request

Deletes a forecast created using the CreateForecast operation. You can delete only forecasts that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeForecast operation.

You can't delete a forecast while it is being exported. After a forecast is deleted, you can no longer query the forecast.

Service Reference:

Examples:

Calling the deleteForecast operation

var params = {
  ForecastArn: 'STRING_VALUE' /* required */
};
forecastservice.deleteForecast(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ForecastArn — (String)

      The Amazon Resource Name (ARN) of the forecast to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteForecastExportJob(params = {}, callback) ⇒ AWS.Request

Deletes a forecast export job created using the CreateForecastExportJob operation. You can delete only export jobs that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeForecastExportJob operation.

Service Reference:

Examples:

Calling the deleteForecastExportJob operation

var params = {
  ForecastExportJobArn: 'STRING_VALUE' /* required */
};
forecastservice.deleteForecastExportJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ForecastExportJobArn — (String)

      The Amazon Resource Name (ARN) of the forecast export job to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deletePredictor(params = {}, callback) ⇒ AWS.Request

Deletes a predictor created using the CreatePredictor operation. You can delete only predictor that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribePredictor operation.

Service Reference:

Examples:

Calling the deletePredictor operation

var params = {
  PredictorArn: 'STRING_VALUE' /* required */
};
forecastservice.deletePredictor(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • PredictorArn — (String)

      The Amazon Resource Name (ARN) of the predictor to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deletePredictorBacktestExportJob(params = {}, callback) ⇒ AWS.Request

Deletes a predictor backtest export job.

Service Reference:

Examples:

Calling the deletePredictorBacktestExportJob operation

var params = {
  PredictorBacktestExportJobArn: 'STRING_VALUE' /* required */
};
forecastservice.deletePredictorBacktestExportJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • PredictorBacktestExportJobArn — (String)

      The Amazon Resource Name (ARN) of the predictor backtest export job to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteResourceTree(params = {}, callback) ⇒ AWS.Request

Deletes an entire resource tree. This operation will delete the parent resource and its child resources.

Child resources are resources that were created from another resource. For example, when a forecast is generated from a predictor, the forecast is the child resource and the predictor is the parent resource.

Amazon Forecast resources possess the following parent-child resource hierarchies:

  • Dataset: dataset import jobs

  • Dataset Group: predictors, predictor backtest export jobs, forecasts, forecast export jobs

  • Predictor: predictor backtest export jobs, forecasts, forecast export jobs

  • Forecast: forecast export jobs

Note: DeleteResourceTree will only delete Amazon Forecast resources, and will not delete datasets or exported files stored in Amazon S3.

Service Reference:

Examples:

Calling the deleteResourceTree operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
forecastservice.deleteResourceTree(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the parent resource to delete. All child resources of the parent resource will also be deleted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeDataset(params = {}, callback) ⇒ AWS.Request

Describes an Amazon Forecast dataset created using the CreateDataset operation.

In addition to listing the parameters specified in the CreateDataset request, this operation includes the following dataset properties:

  • CreationTime

  • LastModificationTime

  • Status

Service Reference:

Examples:

Calling the describeDataset operation

var params = {
  DatasetArn: 'STRING_VALUE' /* required */
};
forecastservice.describeDataset(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DatasetArn — (String)

      The Amazon Resource Name (ARN) of the dataset.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DatasetArn — (String)

        The Amazon Resource Name (ARN) of the dataset.

      • DatasetName — (String)

        The name of the dataset.

      • Domain — (String)

        The domain associated with the dataset.

        Possible values include:
        • "RETAIL"
        • "CUSTOM"
        • "INVENTORY_PLANNING"
        • "EC2_CAPACITY"
        • "WORK_FORCE"
        • "WEB_TRAFFIC"
        • "METRICS"
      • DatasetType — (String)

        The dataset type.

        Possible values include:
        • "TARGET_TIME_SERIES"
        • "RELATED_TIME_SERIES"
        • "ITEM_METADATA"
      • DataFrequency — (String)

        The frequency of data collection.

        Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "M" indicates every month and "30min" indicates every 30 minutes.

      • Schema — (map)

        An array of SchemaAttribute objects that specify the dataset fields. Each SchemaAttribute specifies the name and data type of a field.

        • Attributes — (Array<map>)

          An array of attributes specifying the name and type of each field in a dataset.

          • AttributeName — (String)

            The name of the dataset field.

          • AttributeType — (String)

            The data type of the field.

            Possible values include:
            • "string"
            • "integer"
            • "float"
            • "timestamp"
            • "geolocation"
      • EncryptionConfig — (map)

        The AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

        • RoleArn — required — (String)

          The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.

          Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

        • KMSKeyArn — required — (String)

          The Amazon Resource Name (ARN) of the KMS key.

      • Status — (String)

        The status of the dataset. States include:

        • ACTIVE

        • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

        • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

        • UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED

        The UPDATE states apply while data is imported to the dataset from a call to the CreateDatasetImportJob operation and reflect the status of the dataset import job. For example, when the import job status is CREATE_IN_PROGRESS, the status of the dataset is UPDATE_IN_PROGRESS.

        Note: The Status of the dataset must be ACTIVE before you can import training data.
      • CreationTime — (Date)

        When the dataset was created.

      • LastModificationTime — (Date)

        When you create a dataset, LastModificationTime is the same as CreationTime. While data is being imported to the dataset, LastModificationTime is the current time of the DescribeDataset call. After a CreateDatasetImportJob operation has finished, LastModificationTime is when the import job completed or failed.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeDatasetGroup(params = {}, callback) ⇒ AWS.Request

Describes a dataset group created using the CreateDatasetGroup operation.

In addition to listing the parameters provided in the CreateDatasetGroup request, this operation includes the following properties:

  • DatasetArns - The datasets belonging to the group.

  • CreationTime

  • LastModificationTime

  • Status

Service Reference:

Examples:

Calling the describeDatasetGroup operation

var params = {
  DatasetGroupArn: 'STRING_VALUE' /* required */
};
forecastservice.describeDatasetGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DatasetGroupArn — (String)

      The Amazon Resource Name (ARN) of the dataset group.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DatasetGroupName — (String)

        The name of the dataset group.

      • DatasetGroupArn — (String)

        The ARN of the dataset group.

      • DatasetArns — (Array<String>)

        An array of Amazon Resource Names (ARNs) of the datasets contained in the dataset group.

      • Domain — (String)

        The domain associated with the dataset group.

        Possible values include:
        • "RETAIL"
        • "CUSTOM"
        • "INVENTORY_PLANNING"
        • "EC2_CAPACITY"
        • "WORK_FORCE"
        • "WEB_TRAFFIC"
        • "METRICS"
      • Status — (String)

        The status of the dataset group. States include:

        • ACTIVE

        • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

        • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

        • UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED

        The UPDATE states apply when you call the UpdateDatasetGroup operation.

        Note: The Status of the dataset group must be ACTIVE before you can use the dataset group to create a predictor.
      • CreationTime — (Date)

        When the dataset group was created.

      • LastModificationTime — (Date)

        When the dataset group was created or last updated from a call to the UpdateDatasetGroup operation. While the dataset group is being updated, LastModificationTime is the current time of the DescribeDatasetGroup call.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeDatasetImportJob(params = {}, callback) ⇒ AWS.Request

Describes a dataset import job created using the CreateDatasetImportJob operation.

In addition to listing the parameters provided in the CreateDatasetImportJob request, this operation includes the following properties:

  • CreationTime

  • LastModificationTime

  • DataSize

  • FieldStatistics

  • Status

  • Message - If an error occurred, information about the error.

Service Reference:

Examples:

Calling the describeDatasetImportJob operation

var params = {
  DatasetImportJobArn: 'STRING_VALUE' /* required */
};
forecastservice.describeDatasetImportJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DatasetImportJobArn — (String)

      The Amazon Resource Name (ARN) of the dataset import job.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DatasetImportJobName — (String)

        The name of the dataset import job.

      • DatasetImportJobArn — (String)

        The ARN of the dataset import job.

      • DatasetArn — (String)

        The Amazon Resource Name (ARN) of the dataset that the training data was imported to.

      • TimestampFormat — (String)

        The format of timestamps in the dataset. The format that you specify depends on the DataFrequency specified when the dataset was created. The following formats are supported

        • "yyyy-MM-dd"

          For the following data frequencies: Y, M, W, and D

        • "yyyy-MM-dd HH:mm:ss"

          For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D

      • TimeZone — (String)

        The single time zone applied to every item in the dataset

      • UseGeolocationForTimeZone — (Boolean)

        Whether TimeZone is automatically derived from the geolocation attribute.

      • GeolocationFormat — (String)

        The format of the geolocation attribute. Valid Values:"LAT_LONG" and "CC_POSTALCODE".

      • DataSource — (map)

        The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data.

        If encryption is used, DataSource includes an AWS Key Management Service (KMS) key.

        • S3Config — required — (map)

          The path to the training data stored in an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the data.

          • Path — required — (String)

            The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.

          • RoleArn — required — (String)

            The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the KMSKeyArn key, the role must allow access to the key.

            Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

          • KMSKeyArn — (String)

            The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.

      • EstimatedTimeRemainingInMinutes — (Integer)

        The estimated time remaining in minutes for the dataset import job to complete.

      • FieldStatistics — (map<map>)

        Statistical information about each field in the input data.

        • Count — (Integer)

          The number of values in the field. If the response value is -1, refer to CountLong.

        • CountDistinct — (Integer)

          The number of distinct values in the field. If the response value is -1, refer to CountDistinctLong.

        • CountNull — (Integer)

          The number of null values in the field. If the response value is -1, refer to CountNullLong.

        • CountNan — (Integer)

          The number of NAN (not a number) values in the field. If the response value is -1, refer to CountNanLong.

        • Min — (String)

          For a numeric field, the minimum value in the field.

        • Max — (String)

          For a numeric field, the maximum value in the field.

        • Avg — (Float)

          For a numeric field, the average value in the field.

        • Stddev — (Float)

          For a numeric field, the standard deviation.

        • CountLong — (Integer)

          The number of values in the field. CountLong is used instead of Count if the value is greater than 2,147,483,647.

        • CountDistinctLong — (Integer)

          The number of distinct values in the field. CountDistinctLong is used instead of CountDistinct if the value is greater than 2,147,483,647.

        • CountNullLong — (Integer)

          The number of null values in the field. CountNullLong is used instead of CountNull if the value is greater than 2,147,483,647.

        • CountNanLong — (Integer)

          The number of NAN (not a number) values in the field. CountNanLong is used instead of CountNan if the value is greater than 2,147,483,647.

      • DataSize — (Float)

        The size of the dataset in gigabytes (GB) after the import job has finished.

      • Status — (String)

        The status of the dataset import job. States include:

        • ACTIVE

        • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

        • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

        • CREATE_STOPPING, CREATE_STOPPED

      • Message — (String)

        If an error occurred, an informational message about the error.

      • CreationTime — (Date)

        When the dataset import job was created.

      • LastModificationTime — (Date)

        The last time the resource was modified. The timestamp depends on the status of the job:

        • CREATE_PENDING - The CreationTime.

        • CREATE_IN_PROGRESS - The current timestamp.

        • CREATE_STOPPING - The current timestamp.

        • CREATE_STOPPED - When the job stopped.

        • ACTIVE or CREATE_FAILED - When the job finished or failed.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeForecast(params = {}, callback) ⇒ AWS.Request

Describes a forecast created using the CreateForecast operation.

In addition to listing the properties provided in the CreateForecast request, this operation lists the following properties:

  • DatasetGroupArn - The dataset group that provided the training data.

  • CreationTime

  • LastModificationTime

  • Status

  • Message - If an error occurred, information about the error.

Service Reference:

Examples:

Calling the describeForecast operation

var params = {
  ForecastArn: 'STRING_VALUE' /* required */
};
forecastservice.describeForecast(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ForecastArn — (String)

      The Amazon Resource Name (ARN) of the forecast.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ForecastArn — (String)

        The forecast ARN as specified in the request.

      • ForecastName — (String)

        The name of the forecast.

      • ForecastTypes — (Array<String>)

        The quantiles at which probabilistic forecasts were generated.

      • PredictorArn — (String)

        The ARN of the predictor used to generate the forecast.

      • DatasetGroupArn — (String)

        The ARN of the dataset group that provided the data used to train the predictor.

      • EstimatedTimeRemainingInMinutes — (Integer)

        The estimated time remaining in minutes for the forecast job to complete.

      • Status — (String)

        The status of the forecast. States include:

        • ACTIVE

        • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

        • CREATE_STOPPING, CREATE_STOPPED

        • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

        Note: The Status of the forecast must be ACTIVE before you can query or export the forecast.
      • Message — (String)

        If an error occurred, an informational message about the error.

      • CreationTime — (Date)

        When the forecast creation task was created.

      • LastModificationTime — (Date)

        The last time the resource was modified. The timestamp depends on the status of the job:

        • CREATE_PENDING - The CreationTime.

        • CREATE_IN_PROGRESS - The current timestamp.

        • CREATE_STOPPING - The current timestamp.

        • CREATE_STOPPED - When the job stopped.

        • ACTIVE or CREATE_FAILED - When the job finished or failed.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeForecastExportJob(params = {}, callback) ⇒ AWS.Request

Describes a forecast export job created using the CreateForecastExportJob operation.

In addition to listing the properties provided by the user in the CreateForecastExportJob request, this operation lists the following properties:

  • CreationTime

  • LastModificationTime

  • Status

  • Message - If an error occurred, information about the error.

Service Reference:

Examples:

Calling the describeForecastExportJob operation

var params = {
  ForecastExportJobArn: 'STRING_VALUE' /* required */
};
forecastservice.describeForecastExportJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ForecastExportJobArn — (String)

      The Amazon Resource Name (ARN) of the forecast export job.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ForecastExportJobArn — (String)

        The ARN of the forecast export job.

      • ForecastExportJobName — (String)

        The name of the forecast export job.

      • ForecastArn — (String)

        The Amazon Resource Name (ARN) of the exported forecast.

      • Destination — (map)

        The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.

        • S3Config — required — (map)

          The path to an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the bucket.

          • Path — required — (String)

            The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.

          • RoleArn — required — (String)

            The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the KMSKeyArn key, the role must allow access to the key.

            Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

          • KMSKeyArn — (String)

            The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.

      • Message — (String)

        If an error occurred, an informational message about the error.

      • Status — (String)

        The status of the forecast export job. States include:

        • ACTIVE

        • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

        • CREATE_STOPPING, CREATE_STOPPED

        • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

        Note: The Status of the forecast export job must be ACTIVE before you can access the forecast in your S3 bucket.
      • CreationTime — (Date)

        When the forecast export job was created.

      • LastModificationTime — (Date)

        The last time the resource was modified. The timestamp depends on the status of the job:

        • CREATE_PENDING - The CreationTime.

        • CREATE_IN_PROGRESS - The current timestamp.

        • CREATE_STOPPING - The current timestamp.

        • CREATE_STOPPED - When the job stopped.

        • ACTIVE or CREATE_FAILED - When the job finished or failed.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describePredictor(params = {}, callback) ⇒ AWS.Request

Describes a predictor created using the CreatePredictor operation.

In addition to listing the properties provided in the CreatePredictor request, this operation lists the following properties:

  • DatasetImportJobArns - The dataset import jobs used to import training data.

  • AutoMLAlgorithmArns - If AutoML is performed, the algorithms that were evaluated.

  • CreationTime

  • LastModificationTime

  • Status

  • Message - If an error occurred, information about the error.

Service Reference:

Examples:

Calling the describePredictor operation

var params = {
  PredictorArn: 'STRING_VALUE' /* required */
};
forecastservice.describePredictor(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • PredictorArn — (String)

      The Amazon Resource Name (ARN) of the predictor that you want information about.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PredictorArn — (String)

        The ARN of the predictor.

      • PredictorName — (String)

        The name of the predictor.

      • AlgorithmArn — (String)

        The Amazon Resource Name (ARN) of the algorithm used for model training.

      • ForecastHorizon — (Integer)

        The number of time-steps of the forecast. The forecast horizon is also called the prediction length.

      • ForecastTypes — (Array<String>)

        The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"]

      • PerformAutoML — (Boolean)

        Whether the predictor is set to perform AutoML.

      • AutoMLOverrideStrategy — (String)
        Note: The LatencyOptimized AutoML override strategy is only available in private beta. Contact AWS Support or your account manager to learn more about access privileges.

        The AutoML strategy used to train the predictor. Unless LatencyOptimized is specified, the AutoML strategy optimizes predictor accuracy.

        This parameter is only valid for predictors trained using AutoML.

        Possible values include:
        • "LatencyOptimized"
      • PerformHPO — (Boolean)

        Whether the predictor is set to perform hyperparameter optimization (HPO).

      • TrainingParameters — (map<String>)

        The default training parameters or overrides selected during model training. When running AutoML or choosing HPO with CNN-QR or DeepAR+, the optimized values for the chosen hyperparameters are returned. For more information, see aws-forecast-choosing-recipes.

      • EvaluationParameters — (map)

        Used to override the default evaluation parameters of the specified algorithm. Amazon Forecast evaluates a predictor by splitting a dataset into training data and testing data. The evaluation parameters define how to perform the split and the number of iterations.

        • NumberOfBacktestWindows — (Integer)

          The number of times to split the input data. The default is 1. Valid values are 1 through 5.

        • BackTestWindowOffset — (Integer)

          The point from the end of the dataset where you want to split the data for model training and testing (evaluation). Specify the value as the number of data points. The default is the value of the forecast horizon. BackTestWindowOffset can be used to mimic a past virtual forecast start date. This value must be greater than or equal to the forecast horizon and less than half of the TARGET_TIME_SERIES dataset length.

          ForecastHorizon <= BackTestWindowOffset < 1/2 * TARGET_TIME_SERIES dataset length

      • HPOConfig — (map)

        The hyperparameter override values for the algorithm.

        • ParameterRanges — (map)

          Specifies the ranges of valid values for the hyperparameters.

          • CategoricalParameterRanges — (Array<map>)

            Specifies the tunable range for each categorical hyperparameter.

            • Name — required — (String)

              The name of the categorical hyperparameter to tune.

            • Values — required — (Array<String>)

              A list of the tunable categories for the hyperparameter.

          • ContinuousParameterRanges — (Array<map>)

            Specifies the tunable range for each continuous hyperparameter.

            • Name — required — (String)

              The name of the hyperparameter to tune.

            • MaxValue — required — (Float)

              The maximum tunable value of the hyperparameter.

            • MinValue — required — (Float)

              The minimum tunable value of the hyperparameter.

            • ScalingType — (String)

              The scale that hyperparameter tuning uses to search the hyperparameter range. Valid values:

              Auto

              Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.

              Linear

              Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

              Logarithmic

              Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

              Logarithmic scaling works only for ranges that have values greater than 0.

              ReverseLogarithmic

              hyperparameter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale.

              Reverse logarithmic scaling works only for ranges that are entirely within the range 0 <= x < 1.0.

              For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

              Possible values include:
              • "Auto"
              • "Linear"
              • "Logarithmic"
              • "ReverseLogarithmic"
          • IntegerParameterRanges — (Array<map>)

            Specifies the tunable range for each integer hyperparameter.

            • Name — required — (String)

              The name of the hyperparameter to tune.

            • MaxValue — required — (Integer)

              The maximum tunable value of the hyperparameter.

            • MinValue — required — (Integer)

              The minimum tunable value of the hyperparameter.

            • ScalingType — (String)

              The scale that hyperparameter tuning uses to search the hyperparameter range. Valid values:

              Auto

              Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.

              Linear

              Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

              Logarithmic

              Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

              Logarithmic scaling works only for ranges that have values greater than 0.

              ReverseLogarithmic

              Not supported for IntegerParameterRange.

              Reverse logarithmic scaling works only for ranges that are entirely within the range 0 <= x < 1.0.

              For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

              Possible values include:
              • "Auto"
              • "Linear"
              • "Logarithmic"
              • "ReverseLogarithmic"
      • InputDataConfig — (map)

        Describes the dataset group that contains the data to use to train the predictor.

        • DatasetGroupArn — required — (String)

          The Amazon Resource Name (ARN) of the dataset group.

        • SupplementaryFeatures — (Array<map>)

          An array of supplementary features. The only supported feature is a holiday calendar.

          • Name — required — (String)

            The name of the feature. Valid values: "holiday" and "weather".

          • Value — required — (String)

            Weather Index

            To enable the Weather Index, set the value to "true"

            Holidays

            To enable Holidays, specify a country with one of the following two-letter country codes:

            • "AL" - ALBANIA

            • "AR" - ARGENTINA

            • "AT" - AUSTRIA

            • "AU" - AUSTRALIA

            • "BA" - BOSNIA HERZEGOVINA

            • "BE" - BELGIUM

            • "BG" - BULGARIA

            • "BO" - BOLIVIA

            • "BR" - BRAZIL

            • "BY" - BELARUS

            • "CA" - CANADA

            • "CL" - CHILE

            • "CO" - COLOMBIA

            • "CR" - COSTA RICA

            • "HR" - CROATIA

            • "CZ" - CZECH REPUBLIC

            • "DK" - DENMARK

            • "EC" - ECUADOR

            • "EE" - ESTONIA

            • "ET" - ETHIOPIA

            • "FI" - FINLAND

            • "FR" - FRANCE

            • "DE" - GERMANY

            • "GR" - GREECE

            • "HU" - HUNGARY

            • "IS" - ICELAND

            • "IN" - INDIA

            • "IE" - IRELAND

            • "IT" - ITALY

            • "JP" - JAPAN

            • "KZ" - KAZAKHSTAN

            • "KR" - KOREA

            • "LV" - LATVIA

            • "LI" - LIECHTENSTEIN

            • "LT" - LITHUANIA

            • "LU" - LUXEMBOURG

            • "MK" - MACEDONIA

            • "MT" - MALTA

            • "MX" - MEXICO

            • "MD" - MOLDOVA

            • "ME" - MONTENEGRO

            • "NL" - NETHERLANDS

            • "NZ" - NEW ZEALAND

            • "NI" - NICARAGUA

            • "NG" - NIGERIA

            • "NO" - NORWAY

            • "PA" - PANAMA

            • "PY" - PARAGUAY

            • "PE" - PERU

            • "PL" - POLAND

            • "PT" - PORTUGAL

            • "RO" - ROMANIA

            • "RU" - RUSSIA

            • "RS" - SERBIA

            • "SK" - SLOVAKIA

            • "SI" - SLOVENIA

            • "ZA" - SOUTH AFRICA

            • "ES" - SPAIN

            • "SE" - SWEDEN

            • "CH" - SWITZERLAND

            • "UA" - UKRAINE

            • "AE" - UNITED ARAB EMIRATES

            • "US" - UNITED STATES

            • "UK" - UNITED KINGDOM

            • "UY" - URUGUAY

            • "VE" - VENEZUELA

      • FeaturizationConfig — (map)

        The featurization configuration.

        • ForecastFrequency — required — (String)

          The frequency of predictions in a forecast.

          Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "Y" indicates every year and "5min" indicates every five minutes.

          The frequency must be greater than or equal to the TARGET_TIME_SERIES dataset frequency.

          When a RELATED_TIME_SERIES dataset is provided, the frequency must be equal to the RELATED_TIME_SERIES dataset frequency.

        • ForecastDimensions — (Array<String>)

          An array of dimension (field) names that specify how to group the generated forecast.

          For example, suppose that you are generating a forecast for item sales across all of your stores, and your dataset contains a store_id field. If you want the sales forecast for each item by store, you would specify store_id as the dimension.

          All forecast dimensions specified in the TARGET_TIME_SERIES dataset don't need to be specified in the CreatePredictor request. All forecast dimensions specified in the RELATED_TIME_SERIES dataset must be specified in the CreatePredictor request.

        • Featurizations — (Array<map>)

          An array of featurization (transformation) information for the fields of a dataset.

          • AttributeName — required — (String)

            The name of the schema attribute that specifies the data field to be featurized. Amazon Forecast supports the target field of the TARGET_TIME_SERIES and the RELATED_TIME_SERIES datasets. For example, for the RETAIL domain, the target is demand, and for the CUSTOM domain, the target is target_value. For more information, see howitworks-missing-values.

          • FeaturizationPipeline — (Array<map>)

            An array of one FeaturizationMethod object that specifies the feature transformation method.

            • FeaturizationMethodName — required — (String)

              The name of the method. The "filling" method is the only supported method.

              Possible values include:
              • "filling"
            • FeaturizationMethodParameters — (map<String>)

              The method parameters (key-value pairs), which are a map of override parameters. Specify these parameters to override the default values. Related Time Series attributes do not accept aggregation parameters.

              The following list shows the parameters and their valid values for the "filling" featurization method for a Target Time Series dataset. Bold signifies the default value.

              • aggregation: sum, avg, first, min, max

              • frontfill: none

              • middlefill: zero, nan (not a number), value, median, mean, min, max

              • backfill: zero, nan, value, median, mean, min, max

              The following list shows the parameters and their valid values for a Related Time Series featurization method (there are no defaults):

              • middlefill: zero, value, median, mean, min, max

              • backfill: zero, value, median, mean, min, max

              • futurefill: zero, value, median, mean, min, max

              To set a filling method to a specific value, set the fill parameter to value and define the value in a corresponding _value parameter. For example, to set backfilling to a value of 2, include the following: "backfill": "value" and "backfill_value":"2".

      • EncryptionConfig — (map)

        An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

        • RoleArn — required — (String)

          The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.

          Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

        • KMSKeyArn — required — (String)

          The Amazon Resource Name (ARN) of the KMS key.

      • PredictorExecutionDetails — (map)

        Details on the the status and results of the backtests performed to evaluate the accuracy of the predictor. You specify the number of backtests to perform when you call the operation.

        • PredictorExecutions — (Array<map>)

          An array of the backtests performed to evaluate the accuracy of the predictor against a particular algorithm. The NumberOfBacktestWindows from the object determines the number of windows in the array.

          • AlgorithmArn — (String)

            The ARN of the algorithm used to test the predictor.

          • TestWindows — (Array<map>)

            An array of test windows used to evaluate the algorithm. The NumberOfBacktestWindows from the object determines the number of windows in the array.

            • TestWindowStart — (Date)

              The time at which the test began.

            • TestWindowEnd — (Date)

              The time at which the test ended.

            • Status — (String)

              The status of the test. Possible status values are:

              • ACTIVE

              • CREATE_IN_PROGRESS

              • CREATE_FAILED

            • Message — (String)

              If the test failed, the reason why it failed.

      • EstimatedTimeRemainingInMinutes — (Integer)

        The estimated time remaining in minutes for the predictor training job to complete.

      • DatasetImportJobArns — (Array<String>)

        An array of the ARNs of the dataset import jobs used to import training data for the predictor.

      • AutoMLAlgorithmArns — (Array<String>)

        When PerformAutoML is specified, the ARN of the chosen algorithm.

      • Status — (String)

        The status of the predictor. States include:

        • ACTIVE

        • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

        • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

        • CREATE_STOPPING, CREATE_STOPPED

        Note: The Status of the predictor must be ACTIVE before you can use the predictor to create a forecast.
      • Message — (String)

        If an error occurred, an informational message about the error.

      • CreationTime — (Date)

        When the model training task was created.

      • LastModificationTime — (Date)

        The last time the resource was modified. The timestamp depends on the status of the job:

        • CREATE_PENDING - The CreationTime.

        • CREATE_IN_PROGRESS - The current timestamp.

        • CREATE_STOPPING - The current timestamp.

        • CREATE_STOPPED - When the job stopped.

        • ACTIVE or CREATE_FAILED - When the job finished or failed.

      • OptimizationMetric — (String)

        The accuracy metric used to optimize the predictor.

        Possible values include:
        • "WAPE"
        • "RMSE"
        • "AverageWeightedQuantileLoss"
        • "MASE"
        • "MAPE"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describePredictorBacktestExportJob(params = {}, callback) ⇒ AWS.Request

Describes a predictor backtest export job created using the CreatePredictorBacktestExportJob operation.

In addition to listing the properties provided by the user in the CreatePredictorBacktestExportJob request, this operation lists the following properties:

  • CreationTime

  • LastModificationTime

  • Status

  • Message (if an error occurred)

Service Reference:

Examples:

Calling the describePredictorBacktestExportJob operation

var params = {
  PredictorBacktestExportJobArn: 'STRING_VALUE' /* required */
};
forecastservice.describePredictorBacktestExportJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • PredictorBacktestExportJobArn — (String)

      The Amazon Resource Name (ARN) of the predictor backtest export job.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PredictorBacktestExportJobArn — (String)

        The Amazon Resource Name (ARN) of the predictor backtest export job.

      • PredictorBacktestExportJobName — (String)

        The name of the predictor backtest export job.

      • PredictorArn — (String)

        The Amazon Resource Name (ARN) of the predictor.

      • Destination — (map)

        The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an AWS Key Management Service (KMS) key (optional).

        • S3Config — required — (map)

          The path to an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the bucket.

          • Path — required — (String)

            The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.

          • RoleArn — required — (String)

            The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the KMSKeyArn key, the role must allow access to the key.

            Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

          • KMSKeyArn — (String)

            The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.

      • Message — (String)

        Information about any errors that may have occurred during the backtest export.

      • Status — (String)

        The status of the predictor backtest export job. States include:

        • ACTIVE

        • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

        • CREATE_STOPPING, CREATE_STOPPED

        • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

      • CreationTime — (Date)

        When the predictor backtest export job was created.

      • LastModificationTime — (Date)

        The last time the resource was modified. The timestamp depends on the status of the job:

        • CREATE_PENDING - The CreationTime.

        • CREATE_IN_PROGRESS - The current timestamp.

        • CREATE_STOPPING - The current timestamp.

        • CREATE_STOPPED - When the job stopped.

        • ACTIVE or CREATE_FAILED - When the job finished or failed.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getAccuracyMetrics(params = {}, callback) ⇒ AWS.Request

Provides 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 decide whether to use the predictor to generate a forecast. For more information, see Predictor Metrics.

This operation generates metrics for each backtest window that was evaluated. The number of backtest windows (NumberOfBacktestWindows) is specified using the EvaluationParameters object, which is optionally included in the CreatePredictor request. If NumberOfBacktestWindows isn't specified, the number defaults to one.

The parameters of the filling method determine which items contribute to the metrics. If you want all items to contribute, specify zero. If you want only those items that have complete data in the range being evaluated to contribute, specify nan. For more information, see FeaturizationMethod.

Note: Before you can get accuracy metrics, the Status of the predictor must be ACTIVE, signifying that training has completed. To get the status, use the DescribePredictor operation.

Service Reference:

Examples:

Calling the getAccuracyMetrics operation

var params = {
  PredictorArn: 'STRING_VALUE' /* required */
};
forecastservice.getAccuracyMetrics(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • PredictorArn — (String)

      The Amazon Resource Name (ARN) of the predictor to get metrics for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PredictorEvaluationResults — (Array<map>)

        An array of results from evaluating the predictor.

        • AlgorithmArn — (String)

          The Amazon Resource Name (ARN) of the algorithm that was evaluated.

        • TestWindows — (Array<map>)

          The array of test windows used for evaluating the algorithm. The NumberOfBacktestWindows from the EvaluationParameters object determines the number of windows in the array.

          • TestWindowStart — (Date)

            The timestamp that defines the start of the window.

          • TestWindowEnd — (Date)

            The timestamp that defines the end of the window.

          • ItemCount — (Integer)

            The number of data points within the window.

          • EvaluationType — (String)

            The type of evaluation.

            • SUMMARY - The average metrics across all windows.

            • COMPUTED - The metrics for the specified window.

            Possible values include:
            • "SUMMARY"
            • "COMPUTED"
          • Metrics — (map)

            Provides metrics used to evaluate the performance of a predictor.

            • RMSE — (Float)

              The root-mean-square error (RMSE).

            • WeightedQuantileLosses — (Array<map>)

              An array of weighted quantile losses. Quantiles divide a probability distribution into regions of equal probability. The distribution in this case is the loss function.

              • Quantile — (Float)

                The quantile. Quantiles divide a probability distribution into regions of equal probability. For example, if the distribution was divided into 5 regions of equal probability, the quantiles would be 0.2, 0.4, 0.6, and 0.8.

              • LossValue — (Float)

                The difference between the predicted value and the actual value over the quantile, weighted (normalized) by dividing by the sum over all quantiles.

            • ErrorMetrics — (Array<map>)

              Provides detailed error metrics for each forecast type. Metrics include root-mean square-error (RMSE), mean absolute percentage error (MAPE), mean absolute scaled error (MASE), and weighted average percentage error (WAPE).

              • ForecastType — (String)

                The Forecast type used to compute WAPE, MAPE, MASE, and RMSE.

              • WAPE — (Float)

                The weighted absolute percentage error (WAPE).

              • RMSE — (Float)

                The root-mean-square error (RMSE).

              • MASE — (Float)

                The Mean Absolute Scaled Error (MASE)

              • MAPE — (Float)

                The Mean Absolute Percentage Error (MAPE)

            • AverageWeightedQuantileLoss — (Float)

              The average value of all weighted quantile losses.

      • AutoMLOverrideStrategy — (String)
        Note: The LatencyOptimized AutoML override strategy is only available in private beta. Contact AWS Support or your account manager to learn more about access privileges.

        The AutoML strategy used to train the predictor. Unless LatencyOptimized is specified, the AutoML strategy optimizes predictor accuracy.

        This parameter is only valid for predictors trained using AutoML.

        Possible values include:
        • "LatencyOptimized"
      • OptimizationMetric — (String)

        The accuracy metric used to optimize the predictor.

        Possible values include:
        • "WAPE"
        • "RMSE"
        • "AverageWeightedQuantileLoss"
        • "MASE"
        • "MAPE"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listDatasetGroups(params = {}, callback) ⇒ AWS.Request

Returns a list of dataset groups created using the CreateDatasetGroup operation. For each dataset group, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the dataset group ARN with the DescribeDatasetGroup operation.

Service Reference:

Examples:

Calling the listDatasetGroups operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
forecastservice.listDatasetGroups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

      If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

    • MaxResults — (Integer)

      The number of items to return in the response.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DatasetGroups — (Array<map>)

        An array of objects that summarize each dataset group's properties.

        • DatasetGroupArn — (String)

          The Amazon Resource Name (ARN) of the dataset group.

        • DatasetGroupName — (String)

          The name of the dataset group.

        • CreationTime — (Date)

          When the dataset group was created.

        • LastModificationTime — (Date)

          When the dataset group was created or last updated from a call to the UpdateDatasetGroup operation. While the dataset group is being updated, LastModificationTime is the current time of the ListDatasetGroups call.

      • NextToken — (String)

        If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listDatasetImportJobs(params = {}, callback) ⇒ AWS.Request

Returns a list of dataset import jobs created using the CreateDatasetImportJob operation. For each import job, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the ARN with the DescribeDatasetImportJob operation. You can filter the list by providing an array of Filter objects.

Service Reference:

Examples:

Calling the listDatasetImportJobs operation

var params = {
  Filters: [
    {
      Condition: IS | IS_NOT, /* required */
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
forecastservice.listDatasetImportJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

      If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

    • MaxResults — (Integer)

      The number of items to return in the response.

    • Filters — (Array<map>)

      An array of filters. For each filter, you provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the datasets that match the statement from the list, respectively. The match statement consists of a key and a value.

      Filter properties

      • Condition - The condition to apply. Valid values are IS and IS_NOT. To include the datasets that match the statement, specify IS. To exclude matching datasets, specify IS_NOT.

      • Key - The name of the parameter to filter on. Valid values are DatasetArn and Status.

      • Value - The value to match.

      For example, to list all dataset import jobs whose status is ACTIVE, you specify the following filter:

      "Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]

      • Key — required — (String)

        The name of the parameter to filter on.

      • Value — required — (String)

        The value to match.

      • Condition — required — (String)

        The condition to apply. To include the objects that match the statement, specify IS. To exclude matching objects, specify IS_NOT.

        Possible values include:
        • "IS"
        • "IS_NOT"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DatasetImportJobs — (Array<map>)

        An array of objects that summarize each dataset import job's properties.

        • DatasetImportJobArn — (String)

          The Amazon Resource Name (ARN) of the dataset import job.

        • DatasetImportJobName — (String)

          The name of the dataset import job.

        • DataSource — (map)

          The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data. The training data must be stored in an Amazon S3 bucket.

          If encryption is used, DataSource includes an AWS Key Management Service (KMS) key.

          • S3Config — required — (map)

            The path to the training data stored in an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the data.

            • Path — required — (String)

              The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.

            • RoleArn — required — (String)

              The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the KMSKeyArn key, the role must allow access to the key.

              Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

            • KMSKeyArn — (String)

              The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.

        • Status — (String)

          The status of the dataset import job. States include:

          • ACTIVE

          • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

          • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

          • CREATE_STOPPING, CREATE_STOPPED

        • Message — (String)

          If an error occurred, an informational message about the error.

        • CreationTime — (Date)

          When the dataset import job was created.

        • LastModificationTime — (Date)

          The last time the resource was modified. The timestamp depends on the status of the job:

          • CREATE_PENDING - The CreationTime.

          • CREATE_IN_PROGRESS - The current timestamp.

          • CREATE_STOPPING - The current timestamp.

          • CREATE_STOPPED - When the job stopped.

          • ACTIVE or CREATE_FAILED - When the job finished or failed.

      • NextToken — (String)

        If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listDatasets(params = {}, callback) ⇒ AWS.Request

Returns a list of datasets created using the CreateDataset operation. For each dataset, a summary of its properties, including its Amazon Resource Name (ARN), is returned. To retrieve the complete set of properties, use the ARN with the DescribeDataset operation.

Service Reference:

Examples:

Calling the listDatasets operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
forecastservice.listDatasets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

      If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

    • MaxResults — (Integer)

      The number of items to return in the response.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Datasets — (Array<map>)

        An array of objects that summarize each dataset's properties.

        • DatasetArn — (String)

          The Amazon Resource Name (ARN) of the dataset.

        • DatasetName — (String)

          The name of the dataset.

        • DatasetType — (String)

          The dataset type.

          Possible values include:
          • "TARGET_TIME_SERIES"
          • "RELATED_TIME_SERIES"
          • "ITEM_METADATA"
        • Domain — (String)

          The domain associated with the dataset.

          Possible values include:
          • "RETAIL"
          • "CUSTOM"
          • "INVENTORY_PLANNING"
          • "EC2_CAPACITY"
          • "WORK_FORCE"
          • "WEB_TRAFFIC"
          • "METRICS"
        • CreationTime — (Date)

          When the dataset was created.

        • LastModificationTime — (Date)

          When you create a dataset, LastModificationTime is the same as CreationTime. While data is being imported to the dataset, LastModificationTime is the current time of the ListDatasets call. After a CreateDatasetImportJob operation has finished, LastModificationTime is when the import job completed or failed.

      • NextToken — (String)

        If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listForecastExportJobs(params = {}, callback) ⇒ AWS.Request

Returns a list of forecast export jobs created using the CreateForecastExportJob operation. For each forecast export job, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, use the ARN with the DescribeForecastExportJob operation. You can filter the list using an array of Filter objects.

Service Reference:

Examples:

Calling the listForecastExportJobs operation

var params = {
  Filters: [
    {
      Condition: IS | IS_NOT, /* required */
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
forecastservice.listForecastExportJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

      If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

    • MaxResults — (Integer)

      The number of items to return in the response.

    • Filters — (Array<map>)

      An array of filters. For each filter, you provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the forecast export jobs that match the statement from the list, respectively. The match statement consists of a key and a value.

      Filter properties

      • Condition - The condition to apply. Valid values are IS and IS_NOT. To include the forecast export jobs that match the statement, specify IS. To exclude matching forecast export jobs, specify IS_NOT.

      • Key - The name of the parameter to filter on. Valid values are ForecastArn and Status.

      • Value - The value to match.

      For example, to list all jobs that export a forecast named electricityforecast, specify the following filter:

      "Filters": [ { "Condition": "IS", "Key": "ForecastArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityforecast" } ]

      • Key — required — (String)

        The name of the parameter to filter on.

      • Value — required — (String)

        The value to match.

      • Condition — required — (String)

        The condition to apply. To include the objects that match the statement, specify IS. To exclude matching objects, specify IS_NOT.

        Possible values include:
        • "IS"
        • "IS_NOT"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ForecastExportJobs — (Array<map>)

        An array of objects that summarize each export job's properties.

        • ForecastExportJobArn — (String)

          The Amazon Resource Name (ARN) of the forecast export job.

        • ForecastExportJobName — (String)

          The name of the forecast export job.

        • Destination — (map)

          The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.

          • S3Config — required — (map)

            The path to an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the bucket.

            • Path — required — (String)

              The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.

            • RoleArn — required — (String)

              The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the KMSKeyArn key, the role must allow access to the key.

              Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

            • KMSKeyArn — (String)

              The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.

        • Status — (String)

          The status of the forecast export job. States include:

          • ACTIVE

          • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

          • CREATE_STOPPING, CREATE_STOPPED

          • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

          Note: The Status of the forecast export job must be ACTIVE before you can access the forecast in your S3 bucket.
        • Message — (String)

          If an error occurred, an informational message about the error.

        • CreationTime — (Date)

          When the forecast export job was created.

        • LastModificationTime — (Date)

          The last time the resource was modified. The timestamp depends on the status of the job:

          • CREATE_PENDING - The CreationTime.

          • CREATE_IN_PROGRESS - The current timestamp.

          • CREATE_STOPPING - The current timestamp.

          • CREATE_STOPPED - When the job stopped.

          • ACTIVE or CREATE_FAILED - When the job finished or failed.

      • NextToken — (String)

        If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listForecasts(params = {}, callback) ⇒ AWS.Request

Returns a list of forecasts created using the CreateForecast operation. For each forecast, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, specify the ARN with the DescribeForecast operation. You can filter the list using an array of Filter objects.

Service Reference:

Examples:

Calling the listForecasts operation

var params = {
  Filters: [
    {
      Condition: IS | IS_NOT, /* required */
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
forecastservice.listForecasts(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

      If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

    • MaxResults — (Integer)

      The number of items to return in the response.

    • Filters — (Array<map>)

      An array of filters. For each filter, you provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the forecasts that match the statement from the list, respectively. The match statement consists of a key and a value.

      Filter properties

      • Condition - The condition to apply. Valid values are IS and IS_NOT. To include the forecasts that match the statement, specify IS. To exclude matching forecasts, specify IS_NOT.

      • Key - The name of the parameter to filter on. Valid values are DatasetGroupArn, PredictorArn, and Status.

      • Value - The value to match.

      For example, to list all forecasts whose status is not ACTIVE, you would specify:

      "Filters": [ { "Condition": "IS_NOT", "Key": "Status", "Value": "ACTIVE" } ]

      • Key — required — (String)

        The name of the parameter to filter on.

      • Value — required — (String)

        The value to match.

      • Condition — required — (String)

        The condition to apply. To include the objects that match the statement, specify IS. To exclude matching objects, specify IS_NOT.

        Possible values include:
        • "IS"
        • "IS_NOT"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Forecasts — (Array<map>)

        An array of objects that summarize each forecast's properties.

        • ForecastArn — (String)

          The ARN of the forecast.

        • ForecastName — (String)

          The name of the forecast.

        • PredictorArn — (String)

          The ARN of the predictor used to generate the forecast.

        • DatasetGroupArn — (String)

          The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.

        • Status — (String)

          The status of the forecast. States include:

          • ACTIVE

          • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

          • CREATE_STOPPING, CREATE_STOPPED

          • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

          Note: The Status of the forecast must be ACTIVE before you can query or export the forecast.
        • Message — (String)

          If an error occurred, an informational message about the error.

        • CreationTime — (Date)

          When the forecast creation task was created.

        • LastModificationTime — (Date)

          The last time the resource was modified. The timestamp depends on the status of the job:

          • CREATE_PENDING - The CreationTime.

          • CREATE_IN_PROGRESS - The current timestamp.

          • CREATE_STOPPING - The current timestamp.

          • CREATE_STOPPED - When the job stopped.

          • ACTIVE or CREATE_FAILED - When the job finished or failed.

      • NextToken — (String)

        If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listPredictorBacktestExportJobs(params = {}, callback) ⇒ AWS.Request

Returns a list of predictor backtest export jobs created using the CreatePredictorBacktestExportJob operation. This operation returns a summary for each backtest export job. You can filter the list using an array of Filter objects.

To retrieve the complete set of properties for a particular backtest export job, use the ARN with the DescribePredictorBacktestExportJob operation.

Service Reference:

Examples:

Calling the listPredictorBacktestExportJobs operation

var params = {
  Filters: [
    {
      Condition: IS | IS_NOT, /* required */
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
forecastservice.listPredictorBacktestExportJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

      If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

    • MaxResults — (Integer)

      The number of items to return in the response.

    • Filters — (Array<map>)

      An array of filters. For each filter, provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the predictor backtest export jobs that match the statement from the list. The match statement consists of a key and a value.

      Filter properties

      • Condition - The condition to apply. Valid values are IS and IS_NOT. To include the predictor backtest export jobs that match the statement, specify IS. To exclude matching predictor backtest export jobs, specify IS_NOT.

      • Key - The name of the parameter to filter on. Valid values are PredictorArn and Status.

      • Value - The value to match.

      • Key — required — (String)

        The name of the parameter to filter on.

      • Value — required — (String)

        The value to match.

      • Condition — required — (String)

        The condition to apply. To include the objects that match the statement, specify IS. To exclude matching objects, specify IS_NOT.

        Possible values include:
        • "IS"
        • "IS_NOT"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PredictorBacktestExportJobs — (Array<map>)

        An array of objects that summarize the properties of each predictor backtest export job.

        • PredictorBacktestExportJobArn — (String)

          The Amazon Resource Name (ARN) of the predictor backtest export job.

        • PredictorBacktestExportJobName — (String)

          The name of the predictor backtest export job.

        • Destination — (map)

          The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an AWS Key Management Service (KMS) key (optional).

          • S3Config — required — (map)

            The path to an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the bucket.

            • Path — required — (String)

              The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.

            • RoleArn — required — (String)

              The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the KMSKeyArn key, the role must allow access to the key.

              Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

            • KMSKeyArn — (String)

              The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.

        • Status — (String)

          The status of the predictor backtest export job. States include:

          • ACTIVE

          • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

          • CREATE_STOPPING, CREATE_STOPPED

          • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

        • Message — (String)

          Information about any errors that may have occurred during the backtest export.

        • CreationTime — (Date)

          When the predictor backtest export job was created.

        • LastModificationTime — (Date)

          The last time the resource was modified. The timestamp depends on the status of the job:

          • CREATE_PENDING - The CreationTime.

          • CREATE_IN_PROGRESS - The current timestamp.

          • CREATE_STOPPING - The current timestamp.

          • CREATE_STOPPED - When the job stopped.

          • ACTIVE or CREATE_FAILED - When the job finished or failed.

      • NextToken — (String)

        Returns this token if the response is truncated. To retrieve the next set of results, use the token in the next request.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listPredictors(params = {}, callback) ⇒ AWS.Request

Returns a list of predictors created using the CreatePredictor operation. For each predictor, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the ARN with the DescribePredictor operation. You can filter the list using an array of Filter objects.

Service Reference:

Examples:

Calling the listPredictors operation

var params = {
  Filters: [
    {
      Condition: IS | IS_NOT, /* required */
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
forecastservice.listPredictors(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

      If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

    • MaxResults — (Integer)

      The number of items to return in the response.

    • Filters — (Array<map>)

      An array of filters. For each filter, you provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the predictors that match the statement from the list, respectively. The match statement consists of a key and a value.

      Filter properties

      • Condition - The condition to apply. Valid values are IS and IS_NOT. To include the predictors that match the statement, specify IS. To exclude matching predictors, specify IS_NOT.

      • Key - The name of the parameter to filter on. Valid values are DatasetGroupArn and Status.

      • Value - The value to match.

      For example, to list all predictors whose status is ACTIVE, you would specify:

      "Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]

      • Key — required — (String)

        The name of the parameter to filter on.

      • Value — required — (String)

        The value to match.

      • Condition — required — (String)

        The condition to apply. To include the objects that match the statement, specify IS. To exclude matching objects, specify IS_NOT.

        Possible values include:
        • "IS"
        • "IS_NOT"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Predictors — (Array<map>)

        An array of objects that summarize each predictor's properties.

        • PredictorArn — (String)

          The ARN of the predictor.

        • PredictorName — (String)

          The name of the predictor.

        • DatasetGroupArn — (String)

          The Amazon Resource Name (ARN) of the dataset group that contains the data used to train the predictor.

        • Status — (String)

          The status of the predictor. States include:

          • ACTIVE

          • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

          • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

          • CREATE_STOPPING, CREATE_STOPPED

          Note: The Status of the predictor must be ACTIVE before you can use the predictor to create a forecast.
        • Message — (String)

          If an error occurred, an informational message about the error.

        • CreationTime — (Date)

          When the model training task was created.

        • LastModificationTime — (Date)

          The last time the resource was modified. The timestamp depends on the status of the job:

          • CREATE_PENDING - The CreationTime.

          • CREATE_IN_PROGRESS - The current timestamp.

          • CREATE_STOPPING - The current timestamp.

          • CREATE_STOPPED - When the job stopped.

          • ACTIVE or CREATE_FAILED - When the job finished or failed.

      • NextToken — (String)

        If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists the tags for an Amazon Forecast resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
forecastservice.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Forecast dataset groups, datasets, dataset import jobs, predictors, forecasts, and forecast export jobs.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (Array<map>)

        The tags for the resource.

        • Key — required — (String)

          One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.

        • Value — required — (String)

          The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

stopResource(params = {}, callback) ⇒ AWS.Request

Stops a resource.

The resource undergoes the following states: CREATE_STOPPING and CREATE_STOPPED. You cannot resume a resource once it has been stopped.

This operation can be applied to the following resources (and their corresponding child resources):

  • Dataset Import Job

  • Predictor Job

  • Forecast Job

  • Forecast Export Job

  • Predictor Backtest Export Job

Service Reference:

Examples:

Calling the stopResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
forecastservice.stopResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) that identifies the resource to stop. The supported ARNs are DatasetImportJobArn, PredictorArn, PredictorBacktestExportJobArn, ForecastArn, and ForecastExportJobArn.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are also deleted.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
forecastservice.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Forecast dataset groups, datasets, dataset import jobs, predictors, forecasts, and forecast export jobs.

    • Tags — (Array<map>)

      The tags to add to the resource. A tag is an array of key-value pairs.

      The following basic restrictions apply to tags:

      • Maximum number of tags per resource - 50.

      • For each resource, each tag key must be unique, and each tag key can have only one value.

      • Maximum key length - 128 Unicode characters in UTF-8.

      • Maximum value length - 256 Unicode characters in UTF-8.

      • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

      • Tag keys and values are case sensitive.

      • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

      • Key — required — (String)

        One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.

      • Value — required — (String)

        The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Deletes the specified tags from a resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
forecastservice.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Forecast dataset groups, datasets, dataset import jobs, predictors, forecasts, and forecast exports.

    • TagKeys — (Array<String>)

      The keys of the tags to be removed.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateDatasetGroup(params = {}, callback) ⇒ AWS.Request

Replaces the datasets in a dataset group with the specified datasets.

Note: The Status of the dataset group must be ACTIVE before you can use the dataset group to create a predictor. Use the DescribeDatasetGroup operation to get the status.

Service Reference:

Examples:

Calling the updateDatasetGroup operation

var params = {
  DatasetArns: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  DatasetGroupArn: 'STRING_VALUE' /* required */
};
forecastservice.updateDatasetGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DatasetGroupArn — (String)

      The ARN of the dataset group.

    • DatasetArns — (Array<String>)

      An array of the Amazon Resource Names (ARNs) of the datasets to add to the dataset group.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.