AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: AWS.ForecastQueryService

Inherits:

AWS.Service

• Object
• AWS.Service
• AWS.ForecastQueryService

Identifier:

forecastqueryservice

API Version:

2018-06-26

Defined in:

(unknown)

Overview

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

Service Description

Provides APIs for creating and managing Amazon Forecast resources.

Sending a Request Using ForecastQueryService

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

Locking the API Version

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

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

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

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

var forecastqueryservice = new AWS.ForecastQueryService();

Version:

• 2018-06-26

Constructor Summary

• new AWS.ForecastQueryService(options = {}) ⇒ Object constructor

  Constructs a service object.

Property Summary

• endpoint ⇒ AWS.Endpoint readwrite

  An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summary

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

  Retrieves a forecast filtered by the supplied criteria.

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a ForecastQueryService object

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

Options Hash (options):

• params (map) —

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

• endpoint (String) —

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

• accessKeyId (String) —

  your AWS access key ID.

• secretAccessKey (String) —

  your AWS secret access key.

• sessionToken (AWS.Credentials) —

  the optional AWS session token to sign requests with.

• credentials (AWS.Credentials) —

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

• credentialProvider (AWS.CredentialProviderChain) —

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

• region (String) —

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

• maxRetries (Integer) —

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

• maxRedirects (Integer) —

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

• sslEnabled (Boolean) —

  whether to enable SSL for requests.

• paramValidation (Boolean|map) —

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

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

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

• convertResponseTypes (Boolean) —

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

• correctClockSkew (Boolean) —

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

• s3ForcePathStyle (Boolean) —

  whether to force path style URLs for S3 objects.

• s3BucketEndpoint (Boolean) —

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

• s3DisableBodySigning (Boolean) —

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

• retryDelayOptions (map) —

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

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

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

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

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

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

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

• logger (#write, #log) —

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

• systemClockOffset (Number) —

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

• signatureVersion (String) —

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

• signatureCache (Boolean) —

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

• dynamoDbCrc32 (Boolean) —

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

• useAccelerateEndpoint (Boolean) —

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

• clientSideMonitoring (Boolean) —

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

• endpointDiscoveryEnabled (Boolean) —

  whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

• endpointCacheSize (Number) —

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

• hostPrefixEnabled (Boolean) —

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

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

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

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

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

Returns:

• (AWS.Endpoint) —

  an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Retrieves a forecast filtered by the supplied criteria.

The criteria is a key-value pair. The key is either item_id (or the equivalent non-timestamp, non-target field) from the TARGET_TIME_SERIES dataset, or one of the forecast dimensions specified as part of the FeaturizationConfig object.

By default, the complete date range of the filtered forecast is returned. Optionally, you can request a specific date range within the forecast.

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

Service Reference:

• QueryForecast

Examples:

Calling the queryForecast operation

var params = {
  Filters: { /* required */
    '<AttributeName>': 'STRING_VALUE',
    /* '<AttributeName>': ... */
  },
  ForecastArn: 'STRING_VALUE', /* required */
  EndDate: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  StartDate: 'STRING_VALUE'
};
forecastqueryservice.queryForecast(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 query.

  • StartDate — (String)

    The start date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss'Z' (ISO 8601 format) For example, "1970-01-01T00:00:00Z."

  • EndDate — (String)

    The end date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss'Z' (ISO 8601 format). For example, "1970-01-01T00:00:00Z."

  • Filters — (map<String>)

    The filtering criteria to apply when retrieving the forecast. For example:

    • To get a forecast for a specific item specify the following:

      {"item_id" : "client_1"}

    • To get a forecast for a specific item sold in a specific location, specify the following:

      {"item_id" : "client_1", "location" : "ny"}

    • To get a forecast for all blue items sold in a specific location, specify the following:

      { "location" : "ny", "color":"blue"}

    To get the full forecast, use the operation.

  • NextToken — (String)

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

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:

    • Forecast — (map)

      The forecast.

      • Predictions — (map<Array<map>>)

        The forecast.

        The string of the string to array map is one of the following values:

        • mean

        • p10

        • p50

        • p90

        • Timestamp — (String)

          The timestamp of the specific forecast.

        • Value — (Float)

          The forecast value.

Returns:

• (AWS.Request) —

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