Skip to content

Typed dictionaries

Index > ForecastQueryService > Typed dictionaries

Auto-generated documentation for ForecastQueryService type annotations stubs module mypy-boto3-forecastquery.

DataPointTypeDef

Usage Example
from mypy_boto3_forecastquery.type_defs import DataPointTypeDef

def get_value() -> DataPointTypeDef:
    return {
        "Timestamp": ...,
    }
Definition
class DataPointTypeDef(TypedDict):
    Timestamp: NotRequired[str],
    Value: NotRequired[float],

QueryForecastRequestRequestTypeDef

Usage Example
from mypy_boto3_forecastquery.type_defs import QueryForecastRequestRequestTypeDef

def get_value() -> QueryForecastRequestRequestTypeDef:
    return {
        "ForecastArn": ...,
        "Filters": ...,
    }
Definition
class QueryForecastRequestRequestTypeDef(TypedDict):
    ForecastArn: str,
    Filters: Mapping[str, str],
    StartDate: NotRequired[str],
    EndDate: NotRequired[str],
    NextToken: NotRequired[str],

ResponseMetadataTypeDef

Usage Example
from mypy_boto3_forecastquery.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
Definition
class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

QueryWhatIfForecastRequestRequestTypeDef

Usage Example
from mypy_boto3_forecastquery.type_defs import QueryWhatIfForecastRequestRequestTypeDef

def get_value() -> QueryWhatIfForecastRequestRequestTypeDef:
    return {
        "WhatIfForecastArn": ...,
        "Filters": ...,
    }
Definition
class QueryWhatIfForecastRequestRequestTypeDef(TypedDict):
    WhatIfForecastArn: str,
    Filters: Mapping[str, str],
    StartDate: NotRequired[str],
    EndDate: NotRequired[str],
    NextToken: NotRequired[str],

ForecastTypeDef

Usage Example
from mypy_boto3_forecastquery.type_defs import ForecastTypeDef

def get_value() -> ForecastTypeDef:
    return {
        "Predictions": ...,
    }
Definition
class ForecastTypeDef(TypedDict):
    Predictions: NotRequired[Dict[str, List[DataPointTypeDef]]],  # (1)
  1. See DataPointTypeDef

QueryForecastResponseTypeDef

Usage Example
from mypy_boto3_forecastquery.type_defs import QueryForecastResponseTypeDef

def get_value() -> QueryForecastResponseTypeDef:
    return {
        "Forecast": ...,
        "ResponseMetadata": ...,
    }
Definition
class QueryForecastResponseTypeDef(TypedDict):
    Forecast: ForecastTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ForecastTypeDef
  2. See ResponseMetadataTypeDef

QueryWhatIfForecastResponseTypeDef

Usage Example
from mypy_boto3_forecastquery.type_defs import QueryWhatIfForecastResponseTypeDef

def get_value() -> QueryWhatIfForecastResponseTypeDef:
    return {
        "Forecast": ...,
        "ResponseMetadata": ...,
    }
Definition
class QueryWhatIfForecastResponseTypeDef(TypedDict):
    Forecast: ForecastTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ForecastTypeDef
  2. See ResponseMetadataTypeDef