Class: AWS.ForecastService

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 Importing datasets.

    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 an integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). For example, "1D" indicates every day and "15min" indicates every 15 minutes. You cannot specify a value that would overlap with the next larger frequency. That means, for example, you cannot specify a frequency of 60 minutes, because that is equivalent to 1 hour. The valid values for each frequency are the following:

    • Minute - 1-59

    • Hour - 1-23

    • Day - 1-6

    • Week - 1-4

    • Month - 1-11

    • Year - 1

    Thus, if you want every other week forecasts, specify "2W". Or, if you want quarterly forecasts, you specify "3M".

  • 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 Dataset Domains and Dataset 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.

        For a related time series dataset, other than date, item_id, and forecast dimensions attributes, all attributes should be of numerical type (integer/float).

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

    An Key Management Service (KMS) key and the 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 KMS key.

      Passing a role across Amazon Web Services 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 Amazon Web Services 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.

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 Dataset 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 Amazon Web Services 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.

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 */
  Format: 'STRING_VALUE',
  GeolocationFormat: 'STRING_VALUE',
  ImportMode: FULL | INCREMENTAL,
  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 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 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 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 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 Amazon Web Services 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 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 Amazon Web Services 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).

  • Format — (String)

    The format of the imported data, CSV or PARQUET. The default value is CSV.

  • ImportMode — (String)

    Specifies whether the dataset import job is a FULL or INCREMENTAL import. A FULL dataset import replaces all of the existing data with the newly imported data. An INCREMENTAL import appends the imported data to the existing data.

    Possible values include:
    • "FULL"
    • "INCREMENTAL"

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.

var params = {
  ExplainabilityConfig: { /* required */
    TimePointGranularity: ALL | SPECIFIC, /* required */
    TimeSeriesGranularity: ALL | SPECIFIC /* required */
  },
  ExplainabilityName: 'STRING_VALUE', /* required */
  ResourceArn: 'STRING_VALUE', /* required */
  DataSource: {
    S3Config: { /* required */
      Path: 'STRING_VALUE', /* required */
      RoleArn: 'STRING_VALUE', /* required */
      KMSKeyArn: 'STRING_VALUE'
    }
  },
  EnableVisualization: true || false,
  EndDateTime: 'STRING_VALUE',
  Schema: {
    Attributes: [
      {
        AttributeName: 'STRING_VALUE',
        AttributeType: string | integer | float | timestamp | geolocation
      },
      /* more items */
    ]
  },
  StartDateTime: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
forecastservice.createExplainability(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: {}) —
  • ExplainabilityName — (String)

    A unique name for the Explainability.

  • ResourceArn — (String)

    The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.

  • ExplainabilityConfig — (map)

    The configuration settings that define the granularity of time series and time points for the Explainability.

    • TimeSeriesGranularity — required — (String)

      To create an Explainability for all time series in your datasets, use ALL. To create an Explainability for specific time series in your datasets, use SPECIFIC.

      Specify time series by uploading a CSV or Parquet file to an Amazon S3 bucket and set the location within the DataDestination data type.

      Possible values include:
      • "ALL"
      • "SPECIFIC"
    • TimePointGranularity — required — (String)

      To create an Explainability for all time points in your forecast horizon, use ALL. To create an Explainability for specific time points in your forecast horizon, use SPECIFIC.

      Specify time points with the StartDateTime and EndDateTime parameters within the CreateExplainability operation.

      Possible values include:
      • "ALL"
      • "SPECIFIC"
  • DataSource — (map)

    The source of your data, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the data and, optionally, an Key Management Service (KMS) key.

    • S3Config — required — (map)

      The path to the 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 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 Amazon Web Services 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 Key Management Service (KMS) key.

  • Schema — (map)

    Defines the fields of a dataset.

    • 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.

        For a related time series dataset, other than date, item_id, and forecast dimensions attributes, all attributes should be of numerical type (integer/float).

        Possible values include:
        • "string"
        • "integer"
        • "float"
        • "timestamp"
        • "geolocation"
  • EnableVisualization — (Boolean)

    Create an Explainability visualization that is viewable within the Amazon Web Services console.

  • StartDateTime — (String)

    If TimePointGranularity is set to SPECIFIC, define the first point for the Explainability.

    Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)

  • EndDateTime — (String)

    If TimePointGranularity is set to SPECIFIC, define the last time point for the Explainability.

    Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)

  • Tags — (Array<map>)

    Optional metadata to help you categorize and organize your resources. 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:

    • ExplainabilityArn — (String)

      The Amazon Resource Name (ARN) of the Explainability.

Returns:

• (AWS.Request) —

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

var params = {
  Destination: { /* required */
    S3Config: { /* required */
      Path: 'STRING_VALUE', /* required */
      RoleArn: 'STRING_VALUE', /* required */
      KMSKeyArn: 'STRING_VALUE'
    }
  },
  ExplainabilityArn: 'STRING_VALUE', /* required */
  ExplainabilityExportName: 'STRING_VALUE', /* required */
  Format: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
forecastservice.createExplainabilityExport(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: {}) —
  • ExplainabilityExportName — (String)

    A unique name for the Explainability export.

  • ExplainabilityArn — (String)

    The Amazon Resource Name (ARN) of the Explainability to export.

  • Destination — (map)

    The destination for an export job. Provide an S3 path, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an 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 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 Amazon Web Services 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 Key Management Service (KMS) key.

  • Tags — (Array<map>)

    Optional metadata to help you categorize and organize your resources. 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).

  • Format — (String)

    The format of the exported data, CSV or PARQUET.

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:

    • ExplainabilityExportArn — (String)

      The Amazon Resource Name (ARN) of the export.

Returns:

• (AWS.Request) —

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

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 */
  ],
  TimeSeriesSelector: {
    TimeSeriesIdentifiers: {
      DataSource: {
        S3Config: { /* required */
          Path: 'STRING_VALUE', /* required */
          RoleArn: 'STRING_VALUE', /* required */
          KMSKeyArn: 'STRING_VALUE'
        }
      },
      Format: 'STRING_VALUE',
      Schema: {
        Attributes: [
          {
            AttributeName: 'STRING_VALUE',
            AttributeType: string | integer | float | timestamp | geolocation
          },
          /* 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 quantiles are the quantiles you specified during predictor creation. If you didn't specify quantiles, the default values are ["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 Amazon Web Services 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).

  • TimeSeriesSelector — (map)

    Defines the set of time series that are used to create the forecasts in a TimeSeriesIdentifiers object.

    The TimeSeriesIdentifiers object needs the following information:

    • DataSource

    • Format

    • Schema

    • TimeSeriesIdentifiers — (map)

      Details about the import file that contains the time series for which you want to create forecasts.

      • DataSource — (map)

        The source of your data, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the data and, optionally, an Key Management Service (KMS) key.

        • S3Config — required — (map)

          The path to the 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 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 Amazon Web Services 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 Key Management Service (KMS) key.

      • Schema — (map)

        Defines the fields of a dataset.

        • 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.

            For a related time series dataset, other than date, item_id, and forecast dimensions attributes, all attributes should be of numerical type (integer/float).

            Possible values include:
            • "string"
            • "integer"
            • "float"
            • "timestamp"
            • "geolocation"
      • Format — (String)

        The format of the data, either CSV or PARQUET.

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.

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 */
  Format: 'STRING_VALUE',
  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 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 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 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 Amazon Web Services 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 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 Amazon Web Services 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).

  • Format — (String)

    The format of the exported data, CSV or PARQUET. The default value is CSV.

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.

var params = {
  MonitorName: 'STRING_VALUE', /* required */
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
forecastservice.createMonitor(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: {}) —
  • MonitorName — (String)

    The name of the monitor resource.

  • ResourceArn — (String)

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

  • Tags — (Array<map>)

    A list of tags to apply to the monitor 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).

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:

    • MonitorArn — (String)

      The Amazon Resource Name (ARN) of the monitor resource.

Returns:

• (AWS.Request) —

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

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 | AccuracyOptimized,
  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 Amazon Web Services 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"
    • "AccuracyOptimized"
  • 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 an integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). For example, "1D" indicates every day and "15min" indicates every 15 minutes. You cannot specify a value that would overlap with the next larger frequency. That means, for example, you cannot specify a frequency of 60 minutes, because that is equivalent to 1 hour. The valid values for each frequency are the following:

      • Minute - 1-59

      • Hour - 1-23

      • Day - 1-6

      • Week - 1-4

      • Month - 1-11

      • Year - 1

      Thus, if you want every other week forecasts, specify "2W". Or, if you want quarterly forecasts, you specify "3M".

      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 TARGET_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 Key Management Service (KMS) key and the 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 KMS key.

      Passing a role across Amazon Web Services 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 Amazon Web Services 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.

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 */
  Format: 'STRING_VALUE',
  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 Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an 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 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 Amazon Web Services 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 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).

  • Format — (String)

    The format of the exported data, CSV or PARQUET. The default value is CSV.

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.

var params = {
  ForecastArn: 'STRING_VALUE', /* required */
  WhatIfAnalysisName: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  TimeSeriesSelector: {
    TimeSeriesIdentifiers: {
      DataSource: {
        S3Config: { /* required */
          Path: 'STRING_VALUE', /* required */
          RoleArn: 'STRING_VALUE', /* required */
          KMSKeyArn: 'STRING_VALUE'
        }
      },
      Format: 'STRING_VALUE',
      Schema: {
        Attributes: [
          {
            AttributeName: 'STRING_VALUE',
            AttributeType: string | integer | float | timestamp | geolocation
          },
          /* more items */
        ]
      }
    }
  }
};
forecastservice.createWhatIfAnalysis(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: {}) —
  • WhatIfAnalysisName — (String)

    The name of the what-if analysis. Each name must be unique.

  • ForecastArn — (String)

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

  • TimeSeriesSelector — (map)

    Defines the set of time series that are used in the what-if analysis with a TimeSeriesIdentifiers object. What-if analyses are performed only for the time series in this object.

    The TimeSeriesIdentifiers object needs the following information:

    • DataSource

    • Format

    • Schema

    • TimeSeriesIdentifiers — (map)

      Details about the import file that contains the time series for which you want to create forecasts.

      • DataSource — (map)

        The source of your data, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the data and, optionally, an Key Management Service (KMS) key.

        • S3Config — required — (map)

          The path to the 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 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 Amazon Web Services 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 Key Management Service (KMS) key.

      • Schema — (map)

        Defines the fields of a dataset.

        • 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.

            For a related time series dataset, other than date, item_id, and forecast dimensions attributes, all attributes should be of numerical type (integer/float).

            Possible values include:
            • "string"
            • "integer"
            • "float"
            • "timestamp"
            • "geolocation"
      • Format — (String)

        The format of the data, either CSV or PARQUET.

  • Tags — (Array<map>)

    A list of tags to apply to the what if forecast.

    • 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:

    • WhatIfAnalysisArn — (String)

      The Amazon Resource Name (ARN) of the what-if analysis.

Returns:

• (AWS.Request) —

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

var params = {
  WhatIfAnalysisArn: 'STRING_VALUE', /* required */
  WhatIfForecastName: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  TimeSeriesReplacementsDataSource: {
    S3Config: { /* required */
      Path: 'STRING_VALUE', /* required */
      RoleArn: 'STRING_VALUE', /* required */
      KMSKeyArn: 'STRING_VALUE'
    },
    Schema: { /* required */
      Attributes: [
        {
          AttributeName: 'STRING_VALUE',
          AttributeType: string | integer | float | timestamp | geolocation
        },
        /* more items */
      ]
    },
    Format: 'STRING_VALUE',
    TimestampFormat: 'STRING_VALUE'
  },
  TimeSeriesTransformations: [
    {
      Action: {
        AttributeName: 'STRING_VALUE', /* required */
        Operation: ADD | SUBTRACT | MULTIPLY | DIVIDE, /* required */
        Value: 'NUMBER_VALUE' /* required */
      },
      TimeSeriesConditions: [
        {
          AttributeName: 'STRING_VALUE', /* required */
          AttributeValue: 'STRING_VALUE', /* required */
          Condition: EQUALS | NOT_EQUALS | LESS_THAN | GREATER_THAN /* required */
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
forecastservice.createWhatIfForecast(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: {}) —
  • WhatIfForecastName — (String)

    The name of the what-if forecast. Names must be unique within each what-if analysis.

  • WhatIfAnalysisArn — (String)

    The Amazon Resource Name (ARN) of the what-if analysis.

  • TimeSeriesTransformations — (Array<map>)

    The transformations that are applied to the baseline time series. Each transformation contains an action and a set of conditions. An action is applied only when all conditions are met. If no conditions are provided, the action is applied to all items.

    • Action — (map)

      An array of actions that define a time series and how it is transformed. These transformations create a new time series that is used for the what-if analysis.

      • AttributeName — required — (String)

        The related time series that you are modifying. This value is case insensitive.

      • Operation — required — (String)

        The operation that is applied to the provided attribute. Operations include:

        • ADD - adds Value to all rows of AttributeName.

        • SUBTRACT - subtracts Value from all rows of AttributeName.

        • MULTIPLY - multiplies all rows of AttributeName by Value.

        • DIVIDE - divides all rows of AttributeName by Value.

        Possible values include:
        • "ADD"
        • "SUBTRACT"
        • "MULTIPLY"
        • "DIVIDE"
      • Value — required — (Float)

        The value that is applied for the chosen Operation.

    • TimeSeriesConditions — (Array<map>)

      An array of conditions that define which members of the related time series are transformed.

      • AttributeName — required — (String)

        The item_id, dimension name, IM name, or timestamp that you are modifying.

      • AttributeValue — required — (String)

        The value that is applied for the chosen Condition.

      • Condition — required — (String)

        The condition to apply. Valid values are EQUALS, NOT_EQUALS, LESS_THAN and GREATER_THAN.

        Possible values include:
        • "EQUALS"
        • "NOT_EQUALS"
        • "LESS_THAN"
        • "GREATER_THAN"
  • TimeSeriesReplacementsDataSource — (map)

    The replacement time series dataset, which contains the rows that you want to change in the related time series dataset. A replacement time series does not need to contain all rows that are in the baseline related time series. Include only the rows (measure-dimension combinations) that you want to include in the what-if forecast.

    This dataset is merged with the original time series to create a transformed dataset that is used for the what-if analysis.

    This dataset should contain the items to modify (such as item_id or workforce_type), any relevant dimensions, the timestamp column, and at least one of the related time series columns. This file should not contain duplicate timestamps for the same time series.

    Timestamps and item_ids not included in this dataset are not included in the what-if analysis.

    • S3Config — required — (map)

      The path to the file(s) in an Amazon Simple Storage Service (Amazon S3) bucket, and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the file(s). Optionally, includes an Key Management Service (KMS) key. This object is part of the DataSource object that is submitted in the CreateDatasetImportJob request, and part of the DataDestination object.

      • 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 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 Amazon Web Services 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 Key Management Service (KMS) key.

    • Schema — required — (map)

      Defines the fields of a dataset.

      • 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.

          For a related time series dataset, other than date, item_id, and forecast dimensions attributes, all attributes should be of numerical type (integer/float).

          Possible values include:
          • "string"
          • "integer"
          • "float"
          • "timestamp"
          • "geolocation"
    • Format — (String)

      The format of the replacement data, CSV or PARQUET.

    • TimestampFormat — (String)

      The timestamp format of the replacement data.

  • Tags — (Array<map>)

    A list of tags to apply to the what if forecast.

    • 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:

    • WhatIfForecastArn — (String)

      The Amazon Resource Name (ARN) of the what-if forecast.

Returns:

• (AWS.Request) —

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

var params = {
  Destination: { /* required */
    S3Config: { /* required */
      Path: 'STRING_VALUE', /* required */
      RoleArn: 'STRING_VALUE', /* required */
      KMSKeyArn: 'STRING_VALUE'
    }
  },
  WhatIfForecastArns: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  WhatIfForecastExportName: 'STRING_VALUE', /* required */
  Format: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
forecastservice.createWhatIfForecastExport(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: {}) —
  • WhatIfForecastExportName — (String)

    The name of the what-if forecast to export.

  • WhatIfForecastArns — (Array<String>)

    The list of what-if forecast Amazon Resource Names (ARNs) to export.

  • Destination — (map)

    The location where you want to save the forecast and an 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 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 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 Amazon Web Services 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 Key Management Service (KMS) key.

  • Tags — (Array<map>)

    A list of tags to apply to the what if forecast.

    • 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).

  • Format — (String)

    The format of the exported data, CSV or PARQUET.

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:

    • WhatIfForecastExportArn — (String)

      The Amazon Resource Name (ARN) of the what-if forecast.

Returns:

• (AWS.Request) —

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

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.

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.

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.

var params = {
  ExplainabilityArn: 'STRING_VALUE' /* required */
};
forecastservice.deleteExplainability(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: {}) —
  • ExplainabilityArn — (String)

    The Amazon Resource Name (ARN) of the Explainability resource 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.

var params = {
  ExplainabilityExportArn: 'STRING_VALUE' /* required */
};
forecastservice.deleteExplainabilityExport(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: {}) —
  • ExplainabilityExportArn — (String)

    The Amazon Resource Name (ARN) of the Explainability export 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.

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.

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.

var params = {
  MonitorArn: 'STRING_VALUE' /* required */
};
forecastservice.deleteMonitor(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: {}) —
  • MonitorArn — (String)

    The Amazon Resource Name (ARN) of the monitor resource 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.

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.

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.

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.

var params = {
  WhatIfAnalysisArn: 'STRING_VALUE' /* required */
};
forecastservice.deleteWhatIfAnalysis(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: {}) —
  • WhatIfAnalysisArn — (String)

    The Amazon Resource Name (ARN) of the what-if analysis that you want 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.

var params = {
  WhatIfForecastArn: 'STRING_VALUE' /* required */
};
forecastservice.deleteWhatIfForecast(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: {}) —
  • WhatIfForecastArn — (String)

    The Amazon Resource Name (ARN) of the what-if forecast that you want 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.

var params = {
  WhatIfForecastExportArn: 'STRING_VALUE' /* required */
};
forecastservice.deleteWhatIfForecastExport(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: {}) —
  • WhatIfForecastExportArn — (String)

    The Amazon Resource Name (ARN) of the what-if forecast export that you want 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.

var params = {
  PredictorArn: 'STRING_VALUE' /* required */
};
forecastservice.describeAutoPredictor(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.

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

    • PredictorName — (String)

      The name of the predictor.

    • ForecastHorizon — (Integer)

      The number of time-steps that the model predicts. 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"].

    • ForecastFrequency — (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.

    • ForecastDimensions — (Array<String>)

      An array of dimension (field) names that specify the attributes used to group your time series.

    • DatasetImportJobArns — (Array<String>)

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

    • DataConfig — (map)

      The data configuration for your dataset group and any additional datasets.

      • DatasetGroupArn — required — (String)

        The ARN of the dataset group used to train the predictor.

      • AttributeConfigs — (Array<map>)

        Aggregation and filling options for attributes in your dataset group.

        • AttributeName — required — (String)

          The name of the attribute as specified in the schema. 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.

        • Transformations — required — (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. Default values are bolded.

          • 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".

      • AdditionalDatasets — (Array<map>)

        Additional built-in datasets like Holidays and the Weather Index.

        • Name — required — (String)

          The name of the additional dataset. Valid names: "holiday" and "weather".

        • Configuration — (map<Array<String>>)

          Weather Index

          To enable the Weather Index, do not specify a value for Configuration.

          Holidays

          Holidays

          To enable Holidays, set CountryCode to 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

    • EncryptionConfig — (map)

      An Key Management Service (KMS) key and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key. You can specify this optional object in the CreateDataset and CreatePredictor requests.

      • RoleArn — required — (String)

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

        Passing a role across Amazon Web Services 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.

    • ReferencePredictorSummary — (map)

      The ARN and state of the reference predictor. This parameter is only valid for retrained or upgraded predictors.

      • Arn — (String)

        The ARN of the reference predictor.

      • State — (String)

        Whether the reference predictor is Active or Deleted.

        Possible values include:
        • "Active"
        • "Deleted"
    • EstimatedTimeRemainingInMinutes — (Integer)

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

    • Status — (String)

      The status of the predictor. States include:

      • ACTIVE

      • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

      • CREATE_STOPPING, CREATE_STOPPED

      • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

    • Message — (String)

      In the event of an error, a message detailing the cause of the error.

    • CreationTime — (Date)

      The timestamp of the CreateAutoPredictor request.

    • 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"
    • ExplainabilityInfo — (map)

      Provides the status and ARN of the Predictor Explainability.

      • ExplainabilityArn — (String)

        The Amazon Resource Name (ARN) of the Explainability.

      • Status — (String)

        The status of the Explainability. States include:

        • ACTIVE

        • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

        • CREATE_STOPPING, CREATE_STOPPED

        • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

    • MonitorInfo — (map)

      A object with the Amazon Resource Name (ARN) and status of the monitor resource.

      • MonitorArn — (String)

        The Amazon Resource Name (ARN) of the monitor resource.

      • Status — (String)

        The status of the monitor. States include:

        • ACTIVE

        • ACTIVE_STOPPING, ACTIVE_STOPPED

        • UPDATE_IN_PROGRESS

        • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

        • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

    • TimeAlignmentBoundary — (map)

      The time boundary Forecast uses when aggregating data.

      • Month — (String)

        The month to use for time alignment during aggregation. The month must be in uppercase.

        Possible values include:
        • "JANUARY"
        • "FEBRUARY"
        • "MARCH"
        • "APRIL"
        • "MAY"
        • "JUNE"
        • "JULY"
        • "AUGUST"
        • "SEPTEMBER"
        • "OCTOBER"
        • "NOVEMBER"
        • "DECEMBER"
      • DayOfMonth — (Integer)

        The day of the month to use for time alignment during aggregation.

      • DayOfWeek — (String)

        The day of week to use for time alignment during aggregation. The day must be in uppercase.

        Possible values include:
        • "MONDAY"
        • "TUESDAY"
        • "WEDNESDAY"
        • "THURSDAY"
        • "FRIDAY"
        • "SATURDAY"
        • "SUNDAY"
      • Hour — (Integer)

        The hour of day to use for time alignment during aggregation.

Returns:

• (AWS.Request) —

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

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.

          For a related time series dataset, other than date, item_id, and forecast dimensions attributes, all attributes should be of numerical type (integer/float).

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

      The Key Management Service (KMS) key and the 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 KMS key.

        Passing a role across Amazon Web Services 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.

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.

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 Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data.

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

      • S3Config — required — (map)

        The path to the 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 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 Amazon Web Services 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 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.

    • Format — (String)

      The format of the imported data, CSV or PARQUET.

    • ImportMode — (String)

      The import mode of the dataset import job, FULL or INCREMENTAL.

      Possible values include:
      • "FULL"
      • "INCREMENTAL"

Returns:

• (AWS.Request) —

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

var params = {
  ExplainabilityArn: 'STRING_VALUE' /* required */
};
forecastservice.describeExplainability(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: {}) —
  • ExplainabilityArn — (String)

    The Amazon Resource Name (ARN) of the Explaianability to describe.

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:

    • ExplainabilityArn — (String)

      The Amazon Resource Name (ARN) of the Explainability.

    • ExplainabilityName — (String)

      The name of the Explainability.

    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability resource.

    • ExplainabilityConfig — (map)

      The configuration settings that define the granularity of time series and time points for the Explainability.

      • TimeSeriesGranularity — required — (String)

        To create an Explainability for all time series in your datasets, use ALL. To create an Explainability for specific time series in your datasets, use SPECIFIC.

        Specify time series by uploading a CSV or Parquet file to an Amazon S3 bucket and set the location within the DataDestination data type.

        Possible values include:
        • "ALL"
        • "SPECIFIC"
      • TimePointGranularity — required — (String)

        To create an Explainability for all time points in your forecast horizon, use ALL. To create an Explainability for specific time points in your forecast horizon, use SPECIFIC.

        Specify time points with the StartDateTime and EndDateTime parameters within the CreateExplainability operation.

        Possible values include:
        • "ALL"
        • "SPECIFIC"
    • EnableVisualization — (Boolean)

      Whether the visualization was enabled for the Explainability resource.

    • DataSource — (map)

      The source of your data, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the data and, optionally, an Key Management Service (KMS) key.

      • S3Config — required — (map)

        The path to the 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 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 Amazon Web Services 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 Key Management Service (KMS) key.

    • Schema — (map)

      Defines the fields of a dataset.

      • 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.

          For a related time series dataset, other than date, item_id, and forecast dimensions attributes, all attributes should be of numerical type (integer/float).

          Possible values include:
          • "string"
          • "integer"
          • "float"
          • "timestamp"
          • "geolocation"
    • StartDateTime — (String)

      If TimePointGranularity is set to SPECIFIC, the first time point in the Explainability.

    • EndDateTime — (String)

      If TimePointGranularity is set to SPECIFIC, the last time point in the Explainability.

    • EstimatedTimeRemainingInMinutes — (Integer)

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

    • Message — (String)

      If an error occurred, a message about the error.

    • Status — (String)

      The status of the Explainability resource. 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 Explainability resource 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.