Skip to content

Type definitions#

Index > ForecastQueryService > Type definitions

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

DataPointTypeDef#

# DataPointTypeDef TypedDict usage example

from mypy_boto3_forecastquery.type_defs import DataPointTypeDef


def get_value() -> DataPointTypeDef:
    return {
        "Timestamp": ...,
    }


# DataPointTypeDef definition

class DataPointTypeDef(TypedDict):
    Timestamp: NotRequired[str],
    Value: NotRequired[float],

QueryForecastRequestTypeDef#

# QueryForecastRequestTypeDef TypedDict usage example

from mypy_boto3_forecastquery.type_defs import QueryForecastRequestTypeDef


def get_value() -> QueryForecastRequestTypeDef:
    return {
        "ForecastArn": ...,
    }


# QueryForecastRequestTypeDef definition

class QueryForecastRequestTypeDef(TypedDict):
    ForecastArn: str,
    Filters: Mapping[str, str],
    StartDate: NotRequired[str],
    EndDate: NotRequired[str],
    NextToken: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_forecastquery.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

QueryWhatIfForecastRequestTypeDef#

# QueryWhatIfForecastRequestTypeDef TypedDict usage example

from mypy_boto3_forecastquery.type_defs import QueryWhatIfForecastRequestTypeDef


def get_value() -> QueryWhatIfForecastRequestTypeDef:
    return {
        "WhatIfForecastArn": ...,
    }


# QueryWhatIfForecastRequestTypeDef definition

class QueryWhatIfForecastRequestTypeDef(TypedDict):
    WhatIfForecastArn: str,
    Filters: Mapping[str, str],
    StartDate: NotRequired[str],
    EndDate: NotRequired[str],
    NextToken: NotRequired[str],

ForecastTypeDef#

# ForecastTypeDef TypedDict usage example

from mypy_boto3_forecastquery.type_defs import ForecastTypeDef


def get_value() -> ForecastTypeDef:
    return {
        "Predictions": ...,
    }


# ForecastTypeDef definition

class ForecastTypeDef(TypedDict):
    Predictions: NotRequired[Dict[str, List[DataPointTypeDef]]],  # (1)
  1. See Dict[str, List[DataPointTypeDef]]

QueryForecastResponseTypeDef#

# QueryForecastResponseTypeDef TypedDict usage example

from mypy_boto3_forecastquery.type_defs import QueryForecastResponseTypeDef


def get_value() -> QueryForecastResponseTypeDef:
    return {
        "Forecast": ...,
    }


# QueryForecastResponseTypeDef definition

class QueryForecastResponseTypeDef(TypedDict):
    Forecast: ForecastTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ForecastTypeDef
  2. See ResponseMetadataTypeDef

QueryWhatIfForecastResponseTypeDef#

# QueryWhatIfForecastResponseTypeDef TypedDict usage example

from mypy_boto3_forecastquery.type_defs import QueryWhatIfForecastResponseTypeDef


def get_value() -> QueryWhatIfForecastResponseTypeDef:
    return {
        "Forecast": ...,
    }


# QueryWhatIfForecastResponseTypeDef definition

class QueryWhatIfForecastResponseTypeDef(TypedDict):
    Forecast: ForecastTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ForecastTypeDef
  2. See ResponseMetadataTypeDef