Module Smaws_Client_Forecastquery.Types

type nonrec timestamp = string
type nonrec double = float
type nonrec data_point = {
  1. value : double option;
    (*

    The forecast value.

    *)
  2. timestamp : timestamp option;
    (*

    The timestamp of the specific forecast.

    *)
}

The forecast value for a specific date. Part of the Forecast object.

type nonrec time_series = data_point list
type nonrec statistic = string
type nonrec error_message = string
type nonrec resource_not_found_exception = {
  1. message : error_message option;
}

We can't find that resource. Check the information that you've provided and try again.

type nonrec resource_in_use_exception = {
  1. message : error_message option;
}

The specified resource is in use.

type nonrec predictions = (statistic * time_series) list
type nonrec forecast = {
  1. predictions : predictions option;
    (*

    The forecast.

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

    • p10
    • p50
    • p90

    The default setting is ["0.1", "0.5", "0.9"]. Use the optional ForecastTypes parameter of the CreateForecast operation to change the values. The values will vary depending on how this is set, with a minimum of 1 and a maximum of 5.

    *)
}

Provides information about a forecast. Returned as part of the QueryForecast response.

type nonrec query_what_if_forecast_response = {
  1. forecast : forecast option;
}
type nonrec long_arn = string
type nonrec date_time = string
type nonrec attribute_value = string
type nonrec attribute_name = string
type nonrec filters = (attribute_name * attribute_value) list
type nonrec next_token = string
type nonrec query_what_if_forecast_request = {
  1. next_token : next_token option;
    (*

    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.

    *)
  2. filters : filters;
    (*

    The filtering criteria to apply when retrieving the forecast. For example, to get the forecast for client_21 in the electricity usage dataset, specify the following:

    {"item_id" : "client_21"}

    To get the full what-if forecast, use the CreateForecastExportJob operation.

    *)
  3. end_date : date_time option;
    (*

    The end date for the what-if forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T20:00:00.

    *)
  4. start_date : date_time option;
    (*

    The start date for the what-if forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T08:00:00.

    *)
  5. what_if_forecast_arn : long_arn;
    (*

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

    *)
}
type nonrec limit_exceeded_exception = {
  1. message : error_message option;
}

The limit on the number of requests per second has been exceeded.

type nonrec invalid_next_token_exception = {
  1. message : error_message option;
}

The token is not valid. Tokens expire after 24 hours.

type nonrec invalid_input_exception = {
  1. message : error_message option;
}

The value is invalid or is too long.

type nonrec query_forecast_response = {
  1. forecast : forecast option;
    (*

    The forecast.

    *)
}
type nonrec arn = string
type nonrec query_forecast_request = {
  1. next_token : next_token option;
    (*

    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.

    *)
  2. filters : filters;
    (*

    The filtering criteria to apply when retrieving the forecast. For example, to get the forecast for client_21 in the electricity usage dataset, specify the following:

    {"item_id" : "client_21"}

    To get the full forecast, use the CreateForecastExportJob operation.

    *)
  3. end_date : date_time option;
    (*

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

    *)
  4. start_date : date_time option;
    (*

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

    *)
  5. forecast_arn : arn;
    (*

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

    *)
}