Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

query_what_if_forecast

query_what_if_forecast(**kwargs)

Retrieves a what-if forecast.

See also: AWS API Documentation

Request Syntax

response = client.query_what_if_forecast(
    WhatIfForecastArn='string',
    StartDate='string',
    EndDate='string',
    Filters={
        'string': 'string'
    },
    NextToken='string'
)
Parameters
  • WhatIfForecastArn (string) --

    [REQUIRED]

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

  • StartDate (string) -- 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.
  • EndDate (string) -- 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.
  • Filters (dict) --

    [REQUIRED]

    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.

    • (string) --
      • (string) --
  • 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.
Return type

dict

Returns

Response Syntax

{
    'Forecast': {
        'Predictions': {
            'string': [
                {
                    'Timestamp': 'string',
                    'Value': 123.0
                },
            ]
        }
    }
}

Response Structure

  • (dict) --

    • Forecast (dict) --

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

      • Predictions (dict) --

        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.

        • (string) --

          • (list) --

            • (dict) --

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

              • Timestamp (string) --

                The timestamp of the specific forecast.

              • Value (float) --

                The forecast value.

Exceptions

  • ForecastQueryService.Client.exceptions.ResourceNotFoundException
  • ForecastQueryService.Client.exceptions.ResourceInUseException
  • ForecastQueryService.Client.exceptions.InvalidInputException
  • ForecastQueryService.Client.exceptions.LimitExceededException
  • ForecastQueryService.Client.exceptions.InvalidNextTokenException