Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Forecastquery

Provides APIs for creating and managing Amazon Forecast resources.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly config

The resolved configuration of ForecastqueryClient class. This is resolved and normalized from the constructor configuration interface.

middlewareStack

Methods

destroy

  • destroy(): void
  • Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

    Returns void

queryForecast

  • Retrieves a forecast for a single item, 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, QueryForecast returns the complete date range for the filtered forecast. You can request a specific date range.

    To get the full forecast, use the CreateForecastExportJob operation.

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

    Parameters

    Returns Promise<QueryForecastCommandOutput>

  • Retrieves a forecast for a single item, 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, QueryForecast returns the complete date range for the filtered forecast. You can request a specific date range.

    To get the full forecast, use the CreateForecastExportJob operation.

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

    Parameters

    Returns void

  • Retrieves a forecast for a single item, 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, QueryForecast returns the complete date range for the filtered forecast. You can request a specific date range.

    To get the full forecast, use the CreateForecastExportJob operation.

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

    Parameters

    Returns void

  • Retrieves a forecast for a single item, 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, QueryForecast returns the complete date range for the filtered forecast. You can request a specific date range.

    To get the full forecast, use the CreateForecastExportJob operation.

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

    Parameters

    • args: QueryForecastCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<QueryForecastCommandOutput>

  • Retrieves a forecast for a single item, 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, QueryForecast returns the complete date range for the filtered forecast. You can request a specific date range.

    To get the full forecast, use the CreateForecastExportJob operation.

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

    Parameters

    Returns void

  • Retrieves a forecast for a single item, 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, QueryForecast returns the complete date range for the filtered forecast. You can request a specific date range.

    To get the full forecast, use the CreateForecastExportJob operation.

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

    Parameters

    Returns void

queryWhatIfForecast

send