Skip to content

Typed dictionaries#

Index > ForecastService > Typed dictionaries

Auto-generated documentation for ForecastService type annotations stubs module mypy-boto3-forecast.

ActionTypeDef#

# ActionTypeDef usage example

from mypy_boto3_forecast.type_defs import ActionTypeDef

def get_value() -> ActionTypeDef:
    return {
        "AttributeName": ...,
        "Operation": ...,
        "Value": ...,
    }
# ActionTypeDef definition

class ActionTypeDef(TypedDict):
    AttributeName: str,
    Operation: OperationType,  # (1)
    Value: float,
  1. See OperationType

AdditionalDatasetTypeDef#

# AdditionalDatasetTypeDef usage example

from mypy_boto3_forecast.type_defs import AdditionalDatasetTypeDef

def get_value() -> AdditionalDatasetTypeDef:
    return {
        "Name": ...,
    }
# AdditionalDatasetTypeDef definition

class AdditionalDatasetTypeDef(TypedDict):
    Name: str,
    Configuration: NotRequired[Mapping[str, Sequence[str]]],

AttributeConfigTypeDef#

# AttributeConfigTypeDef usage example

from mypy_boto3_forecast.type_defs import AttributeConfigTypeDef

def get_value() -> AttributeConfigTypeDef:
    return {
        "AttributeName": ...,
        "Transformations": ...,
    }
# AttributeConfigTypeDef definition

class AttributeConfigTypeDef(TypedDict):
    AttributeName: str,
    Transformations: Mapping[str, str],

BaselineMetricTypeDef#

# BaselineMetricTypeDef usage example

from mypy_boto3_forecast.type_defs import BaselineMetricTypeDef

def get_value() -> BaselineMetricTypeDef:
    return {
        "Name": ...,
    }
# BaselineMetricTypeDef definition

class BaselineMetricTypeDef(TypedDict):
    Name: NotRequired[str],
    Value: NotRequired[float],

CategoricalParameterRangeTypeDef#

# CategoricalParameterRangeTypeDef usage example

from mypy_boto3_forecast.type_defs import CategoricalParameterRangeTypeDef

def get_value() -> CategoricalParameterRangeTypeDef:
    return {
        "Name": ...,
        "Values": ...,
    }
# CategoricalParameterRangeTypeDef definition

class CategoricalParameterRangeTypeDef(TypedDict):
    Name: str,
    Values: Sequence[str],

ContinuousParameterRangeTypeDef#

# ContinuousParameterRangeTypeDef usage example

from mypy_boto3_forecast.type_defs import ContinuousParameterRangeTypeDef

def get_value() -> ContinuousParameterRangeTypeDef:
    return {
        "Name": ...,
        "MaxValue": ...,
        "MinValue": ...,
    }
# ContinuousParameterRangeTypeDef definition

class ContinuousParameterRangeTypeDef(TypedDict):
    Name: str,
    MaxValue: float,
    MinValue: float,
    ScalingType: NotRequired[ScalingTypeType],  # (1)
  1. See ScalingTypeType

EncryptionConfigTypeDef#

# EncryptionConfigTypeDef usage example

from mypy_boto3_forecast.type_defs import EncryptionConfigTypeDef

def get_value() -> EncryptionConfigTypeDef:
    return {
        "RoleArn": ...,
        "KMSKeyArn": ...,
    }
# EncryptionConfigTypeDef definition

class EncryptionConfigTypeDef(TypedDict):
    RoleArn: str,
    KMSKeyArn: str,

MonitorConfigTypeDef#

# MonitorConfigTypeDef usage example

from mypy_boto3_forecast.type_defs import MonitorConfigTypeDef

def get_value() -> MonitorConfigTypeDef:
    return {
        "MonitorName": ...,
    }
# MonitorConfigTypeDef definition

class MonitorConfigTypeDef(TypedDict):
    MonitorName: str,

TagTypeDef#

# TagTypeDef usage example

from mypy_boto3_forecast.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "Key": ...,
        "Value": ...,
    }
# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

TimeAlignmentBoundaryTypeDef#

# TimeAlignmentBoundaryTypeDef usage example

from mypy_boto3_forecast.type_defs import TimeAlignmentBoundaryTypeDef

def get_value() -> TimeAlignmentBoundaryTypeDef:
    return {
        "Month": ...,
    }
# TimeAlignmentBoundaryTypeDef definition

class TimeAlignmentBoundaryTypeDef(TypedDict):
    Month: NotRequired[MonthType],  # (1)
    DayOfMonth: NotRequired[int],
    DayOfWeek: NotRequired[DayOfWeekType],  # (2)
    Hour: NotRequired[int],
  1. See MonthType
  2. See DayOfWeekType

CreateAutoPredictorResponseTypeDef#

# CreateAutoPredictorResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import CreateAutoPredictorResponseTypeDef

def get_value() -> CreateAutoPredictorResponseTypeDef:
    return {
        "PredictorArn": ...,
        "ResponseMetadata": ...,
    }
# CreateAutoPredictorResponseTypeDef definition

class CreateAutoPredictorResponseTypeDef(TypedDict):
    PredictorArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateDatasetGroupResponseTypeDef#

# CreateDatasetGroupResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import CreateDatasetGroupResponseTypeDef

def get_value() -> CreateDatasetGroupResponseTypeDef:
    return {
        "DatasetGroupArn": ...,
        "ResponseMetadata": ...,
    }
# CreateDatasetGroupResponseTypeDef definition

class CreateDatasetGroupResponseTypeDef(TypedDict):
    DatasetGroupArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateDatasetImportJobResponseTypeDef#

# CreateDatasetImportJobResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import CreateDatasetImportJobResponseTypeDef

def get_value() -> CreateDatasetImportJobResponseTypeDef:
    return {
        "DatasetImportJobArn": ...,
        "ResponseMetadata": ...,
    }
# CreateDatasetImportJobResponseTypeDef definition

class CreateDatasetImportJobResponseTypeDef(TypedDict):
    DatasetImportJobArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateDatasetResponseTypeDef#

# CreateDatasetResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import CreateDatasetResponseTypeDef

def get_value() -> CreateDatasetResponseTypeDef:
    return {
        "DatasetArn": ...,
        "ResponseMetadata": ...,
    }
# CreateDatasetResponseTypeDef definition

class CreateDatasetResponseTypeDef(TypedDict):
    DatasetArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateExplainabilityExportResponseTypeDef#

# CreateExplainabilityExportResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import CreateExplainabilityExportResponseTypeDef

def get_value() -> CreateExplainabilityExportResponseTypeDef:
    return {
        "ExplainabilityExportArn": ...,
        "ResponseMetadata": ...,
    }
# CreateExplainabilityExportResponseTypeDef definition

class CreateExplainabilityExportResponseTypeDef(TypedDict):
    ExplainabilityExportArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ExplainabilityConfigTypeDef#

# ExplainabilityConfigTypeDef usage example

from mypy_boto3_forecast.type_defs import ExplainabilityConfigTypeDef

def get_value() -> ExplainabilityConfigTypeDef:
    return {
        "TimeSeriesGranularity": ...,
        "TimePointGranularity": ...,
    }
# ExplainabilityConfigTypeDef definition

class ExplainabilityConfigTypeDef(TypedDict):
    TimeSeriesGranularity: TimeSeriesGranularityType,  # (1)
    TimePointGranularity: TimePointGranularityType,  # (2)
  1. See TimeSeriesGranularityType
  2. See TimePointGranularityType

CreateExplainabilityResponseTypeDef#

# CreateExplainabilityResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import CreateExplainabilityResponseTypeDef

def get_value() -> CreateExplainabilityResponseTypeDef:
    return {
        "ExplainabilityArn": ...,
        "ResponseMetadata": ...,
    }
# CreateExplainabilityResponseTypeDef definition

class CreateExplainabilityResponseTypeDef(TypedDict):
    ExplainabilityArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateForecastExportJobResponseTypeDef#

# CreateForecastExportJobResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import CreateForecastExportJobResponseTypeDef

def get_value() -> CreateForecastExportJobResponseTypeDef:
    return {
        "ForecastExportJobArn": ...,
        "ResponseMetadata": ...,
    }
# CreateForecastExportJobResponseTypeDef definition

class CreateForecastExportJobResponseTypeDef(TypedDict):
    ForecastExportJobArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateForecastResponseTypeDef#

# CreateForecastResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import CreateForecastResponseTypeDef

def get_value() -> CreateForecastResponseTypeDef:
    return {
        "ForecastArn": ...,
        "ResponseMetadata": ...,
    }
# CreateForecastResponseTypeDef definition

class CreateForecastResponseTypeDef(TypedDict):
    ForecastArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateMonitorResponseTypeDef#

# CreateMonitorResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import CreateMonitorResponseTypeDef

def get_value() -> CreateMonitorResponseTypeDef:
    return {
        "MonitorArn": ...,
        "ResponseMetadata": ...,
    }
# CreateMonitorResponseTypeDef definition

class CreateMonitorResponseTypeDef(TypedDict):
    MonitorArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreatePredictorBacktestExportJobResponseTypeDef#

# CreatePredictorBacktestExportJobResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import CreatePredictorBacktestExportJobResponseTypeDef

def get_value() -> CreatePredictorBacktestExportJobResponseTypeDef:
    return {
        "PredictorBacktestExportJobArn": ...,
        "ResponseMetadata": ...,
    }
# CreatePredictorBacktestExportJobResponseTypeDef definition

class CreatePredictorBacktestExportJobResponseTypeDef(TypedDict):
    PredictorBacktestExportJobArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EvaluationParametersTypeDef#

# EvaluationParametersTypeDef usage example

from mypy_boto3_forecast.type_defs import EvaluationParametersTypeDef

def get_value() -> EvaluationParametersTypeDef:
    return {
        "NumberOfBacktestWindows": ...,
    }
# EvaluationParametersTypeDef definition

class EvaluationParametersTypeDef(TypedDict):
    NumberOfBacktestWindows: NotRequired[int],
    BackTestWindowOffset: NotRequired[int],

CreatePredictorResponseTypeDef#

# CreatePredictorResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import CreatePredictorResponseTypeDef

def get_value() -> CreatePredictorResponseTypeDef:
    return {
        "PredictorArn": ...,
        "ResponseMetadata": ...,
    }
# CreatePredictorResponseTypeDef definition

class CreatePredictorResponseTypeDef(TypedDict):
    PredictorArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateWhatIfAnalysisResponseTypeDef#

# CreateWhatIfAnalysisResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import CreateWhatIfAnalysisResponseTypeDef

def get_value() -> CreateWhatIfAnalysisResponseTypeDef:
    return {
        "WhatIfAnalysisArn": ...,
        "ResponseMetadata": ...,
    }
# CreateWhatIfAnalysisResponseTypeDef definition

class CreateWhatIfAnalysisResponseTypeDef(TypedDict):
    WhatIfAnalysisArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateWhatIfForecastExportResponseTypeDef#

# CreateWhatIfForecastExportResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import CreateWhatIfForecastExportResponseTypeDef

def get_value() -> CreateWhatIfForecastExportResponseTypeDef:
    return {
        "WhatIfForecastExportArn": ...,
        "ResponseMetadata": ...,
    }
# CreateWhatIfForecastExportResponseTypeDef definition

class CreateWhatIfForecastExportResponseTypeDef(TypedDict):
    WhatIfForecastExportArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateWhatIfForecastResponseTypeDef#

# CreateWhatIfForecastResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import CreateWhatIfForecastResponseTypeDef

def get_value() -> CreateWhatIfForecastResponseTypeDef:
    return {
        "WhatIfForecastArn": ...,
        "ResponseMetadata": ...,
    }
# CreateWhatIfForecastResponseTypeDef definition

class CreateWhatIfForecastResponseTypeDef(TypedDict):
    WhatIfForecastArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

S3ConfigTypeDef#

# S3ConfigTypeDef usage example

from mypy_boto3_forecast.type_defs import S3ConfigTypeDef

def get_value() -> S3ConfigTypeDef:
    return {
        "Path": ...,
        "RoleArn": ...,
    }
# S3ConfigTypeDef definition

class S3ConfigTypeDef(TypedDict):
    Path: str,
    RoleArn: str,
    KMSKeyArn: NotRequired[str],

DatasetGroupSummaryTypeDef#

# DatasetGroupSummaryTypeDef usage example

from mypy_boto3_forecast.type_defs import DatasetGroupSummaryTypeDef

def get_value() -> DatasetGroupSummaryTypeDef:
    return {
        "DatasetGroupArn": ...,
    }
# DatasetGroupSummaryTypeDef definition

class DatasetGroupSummaryTypeDef(TypedDict):
    DatasetGroupArn: NotRequired[str],
    DatasetGroupName: NotRequired[str],
    CreationTime: NotRequired[datetime],
    LastModificationTime: NotRequired[datetime],

DatasetSummaryTypeDef#

# DatasetSummaryTypeDef usage example

from mypy_boto3_forecast.type_defs import DatasetSummaryTypeDef

def get_value() -> DatasetSummaryTypeDef:
    return {
        "DatasetArn": ...,
    }
# DatasetSummaryTypeDef definition

class DatasetSummaryTypeDef(TypedDict):
    DatasetArn: NotRequired[str],
    DatasetName: NotRequired[str],
    DatasetType: NotRequired[DatasetTypeType],  # (1)
    Domain: NotRequired[DomainType],  # (2)
    CreationTime: NotRequired[datetime],
    LastModificationTime: NotRequired[datetime],
  1. See DatasetTypeType
  2. See DomainType

DeleteDatasetGroupRequestRequestTypeDef#

# DeleteDatasetGroupRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import DeleteDatasetGroupRequestRequestTypeDef

def get_value() -> DeleteDatasetGroupRequestRequestTypeDef:
    return {
        "DatasetGroupArn": ...,
    }
# DeleteDatasetGroupRequestRequestTypeDef definition

class DeleteDatasetGroupRequestRequestTypeDef(TypedDict):
    DatasetGroupArn: str,

DeleteDatasetImportJobRequestRequestTypeDef#

# DeleteDatasetImportJobRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import DeleteDatasetImportJobRequestRequestTypeDef

def get_value() -> DeleteDatasetImportJobRequestRequestTypeDef:
    return {
        "DatasetImportJobArn": ...,
    }
# DeleteDatasetImportJobRequestRequestTypeDef definition

class DeleteDatasetImportJobRequestRequestTypeDef(TypedDict):
    DatasetImportJobArn: str,

DeleteDatasetRequestRequestTypeDef#

# DeleteDatasetRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import DeleteDatasetRequestRequestTypeDef

def get_value() -> DeleteDatasetRequestRequestTypeDef:
    return {
        "DatasetArn": ...,
    }
# DeleteDatasetRequestRequestTypeDef definition

class DeleteDatasetRequestRequestTypeDef(TypedDict):
    DatasetArn: str,

DeleteExplainabilityExportRequestRequestTypeDef#

# DeleteExplainabilityExportRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import DeleteExplainabilityExportRequestRequestTypeDef

def get_value() -> DeleteExplainabilityExportRequestRequestTypeDef:
    return {
        "ExplainabilityExportArn": ...,
    }
# DeleteExplainabilityExportRequestRequestTypeDef definition

class DeleteExplainabilityExportRequestRequestTypeDef(TypedDict):
    ExplainabilityExportArn: str,

DeleteExplainabilityRequestRequestTypeDef#

# DeleteExplainabilityRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import DeleteExplainabilityRequestRequestTypeDef

def get_value() -> DeleteExplainabilityRequestRequestTypeDef:
    return {
        "ExplainabilityArn": ...,
    }
# DeleteExplainabilityRequestRequestTypeDef definition

class DeleteExplainabilityRequestRequestTypeDef(TypedDict):
    ExplainabilityArn: str,

DeleteForecastExportJobRequestRequestTypeDef#

# DeleteForecastExportJobRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import DeleteForecastExportJobRequestRequestTypeDef

def get_value() -> DeleteForecastExportJobRequestRequestTypeDef:
    return {
        "ForecastExportJobArn": ...,
    }
# DeleteForecastExportJobRequestRequestTypeDef definition

class DeleteForecastExportJobRequestRequestTypeDef(TypedDict):
    ForecastExportJobArn: str,

DeleteForecastRequestRequestTypeDef#

# DeleteForecastRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import DeleteForecastRequestRequestTypeDef

def get_value() -> DeleteForecastRequestRequestTypeDef:
    return {
        "ForecastArn": ...,
    }
# DeleteForecastRequestRequestTypeDef definition

class DeleteForecastRequestRequestTypeDef(TypedDict):
    ForecastArn: str,

DeleteMonitorRequestRequestTypeDef#

# DeleteMonitorRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import DeleteMonitorRequestRequestTypeDef

def get_value() -> DeleteMonitorRequestRequestTypeDef:
    return {
        "MonitorArn": ...,
    }
# DeleteMonitorRequestRequestTypeDef definition

class DeleteMonitorRequestRequestTypeDef(TypedDict):
    MonitorArn: str,

DeletePredictorBacktestExportJobRequestRequestTypeDef#

# DeletePredictorBacktestExportJobRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import DeletePredictorBacktestExportJobRequestRequestTypeDef

def get_value() -> DeletePredictorBacktestExportJobRequestRequestTypeDef:
    return {
        "PredictorBacktestExportJobArn": ...,
    }
# DeletePredictorBacktestExportJobRequestRequestTypeDef definition

class DeletePredictorBacktestExportJobRequestRequestTypeDef(TypedDict):
    PredictorBacktestExportJobArn: str,

DeletePredictorRequestRequestTypeDef#

# DeletePredictorRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import DeletePredictorRequestRequestTypeDef

def get_value() -> DeletePredictorRequestRequestTypeDef:
    return {
        "PredictorArn": ...,
    }
# DeletePredictorRequestRequestTypeDef definition

class DeletePredictorRequestRequestTypeDef(TypedDict):
    PredictorArn: str,

DeleteResourceTreeRequestRequestTypeDef#

# DeleteResourceTreeRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import DeleteResourceTreeRequestRequestTypeDef

def get_value() -> DeleteResourceTreeRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
    }
# DeleteResourceTreeRequestRequestTypeDef definition

class DeleteResourceTreeRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

DeleteWhatIfAnalysisRequestRequestTypeDef#

# DeleteWhatIfAnalysisRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import DeleteWhatIfAnalysisRequestRequestTypeDef

def get_value() -> DeleteWhatIfAnalysisRequestRequestTypeDef:
    return {
        "WhatIfAnalysisArn": ...,
    }
# DeleteWhatIfAnalysisRequestRequestTypeDef definition

class DeleteWhatIfAnalysisRequestRequestTypeDef(TypedDict):
    WhatIfAnalysisArn: str,

DeleteWhatIfForecastExportRequestRequestTypeDef#

# DeleteWhatIfForecastExportRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import DeleteWhatIfForecastExportRequestRequestTypeDef

def get_value() -> DeleteWhatIfForecastExportRequestRequestTypeDef:
    return {
        "WhatIfForecastExportArn": ...,
    }
# DeleteWhatIfForecastExportRequestRequestTypeDef definition

class DeleteWhatIfForecastExportRequestRequestTypeDef(TypedDict):
    WhatIfForecastExportArn: str,

DeleteWhatIfForecastRequestRequestTypeDef#

# DeleteWhatIfForecastRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import DeleteWhatIfForecastRequestRequestTypeDef

def get_value() -> DeleteWhatIfForecastRequestRequestTypeDef:
    return {
        "WhatIfForecastArn": ...,
    }
# DeleteWhatIfForecastRequestRequestTypeDef definition

class DeleteWhatIfForecastRequestRequestTypeDef(TypedDict):
    WhatIfForecastArn: str,

DescribeAutoPredictorRequestRequestTypeDef#

# DescribeAutoPredictorRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import DescribeAutoPredictorRequestRequestTypeDef

def get_value() -> DescribeAutoPredictorRequestRequestTypeDef:
    return {
        "PredictorArn": ...,
    }
# DescribeAutoPredictorRequestRequestTypeDef definition

class DescribeAutoPredictorRequestRequestTypeDef(TypedDict):
    PredictorArn: str,

ExplainabilityInfoTypeDef#

# ExplainabilityInfoTypeDef usage example

from mypy_boto3_forecast.type_defs import ExplainabilityInfoTypeDef

def get_value() -> ExplainabilityInfoTypeDef:
    return {
        "ExplainabilityArn": ...,
    }
# ExplainabilityInfoTypeDef definition

class ExplainabilityInfoTypeDef(TypedDict):
    ExplainabilityArn: NotRequired[str],
    Status: NotRequired[str],

MonitorInfoTypeDef#

# MonitorInfoTypeDef usage example

from mypy_boto3_forecast.type_defs import MonitorInfoTypeDef

def get_value() -> MonitorInfoTypeDef:
    return {
        "MonitorArn": ...,
    }
# MonitorInfoTypeDef definition

class MonitorInfoTypeDef(TypedDict):
    MonitorArn: NotRequired[str],
    Status: NotRequired[str],

ReferencePredictorSummaryTypeDef#

# ReferencePredictorSummaryTypeDef usage example

from mypy_boto3_forecast.type_defs import ReferencePredictorSummaryTypeDef

def get_value() -> ReferencePredictorSummaryTypeDef:
    return {
        "Arn": ...,
    }
# ReferencePredictorSummaryTypeDef definition

class ReferencePredictorSummaryTypeDef(TypedDict):
    Arn: NotRequired[str],
    State: NotRequired[StateType],  # (1)
  1. See StateType

DescribeDatasetGroupRequestRequestTypeDef#

# DescribeDatasetGroupRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import DescribeDatasetGroupRequestRequestTypeDef

def get_value() -> DescribeDatasetGroupRequestRequestTypeDef:
    return {
        "DatasetGroupArn": ...,
    }
# DescribeDatasetGroupRequestRequestTypeDef definition

class DescribeDatasetGroupRequestRequestTypeDef(TypedDict):
    DatasetGroupArn: str,

DescribeDatasetGroupResponseTypeDef#

# DescribeDatasetGroupResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import DescribeDatasetGroupResponseTypeDef

def get_value() -> DescribeDatasetGroupResponseTypeDef:
    return {
        "DatasetGroupName": ...,
        "DatasetGroupArn": ...,
        "DatasetArns": ...,
        "Domain": ...,
        "Status": ...,
        "CreationTime": ...,
        "LastModificationTime": ...,
        "ResponseMetadata": ...,
    }
# DescribeDatasetGroupResponseTypeDef definition

class DescribeDatasetGroupResponseTypeDef(TypedDict):
    DatasetGroupName: str,
    DatasetGroupArn: str,
    DatasetArns: List[str],
    Domain: DomainType,  # (1)
    Status: str,
    CreationTime: datetime,
    LastModificationTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainType
  2. See ResponseMetadataTypeDef

DescribeDatasetImportJobRequestRequestTypeDef#

# DescribeDatasetImportJobRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import DescribeDatasetImportJobRequestRequestTypeDef

def get_value() -> DescribeDatasetImportJobRequestRequestTypeDef:
    return {
        "DatasetImportJobArn": ...,
    }
# DescribeDatasetImportJobRequestRequestTypeDef definition

class DescribeDatasetImportJobRequestRequestTypeDef(TypedDict):
    DatasetImportJobArn: str,

StatisticsTypeDef#

# StatisticsTypeDef usage example

from mypy_boto3_forecast.type_defs import StatisticsTypeDef

def get_value() -> StatisticsTypeDef:
    return {
        "Count": ...,
    }
# StatisticsTypeDef definition

class StatisticsTypeDef(TypedDict):
    Count: NotRequired[int],
    CountDistinct: NotRequired[int],
    CountNull: NotRequired[int],
    CountNan: NotRequired[int],
    Min: NotRequired[str],
    Max: NotRequired[str],
    Avg: NotRequired[float],
    Stddev: NotRequired[float],
    CountLong: NotRequired[int],
    CountDistinctLong: NotRequired[int],
    CountNullLong: NotRequired[int],
    CountNanLong: NotRequired[int],

DescribeDatasetRequestRequestTypeDef#

# DescribeDatasetRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import DescribeDatasetRequestRequestTypeDef

def get_value() -> DescribeDatasetRequestRequestTypeDef:
    return {
        "DatasetArn": ...,
    }
# DescribeDatasetRequestRequestTypeDef definition

class DescribeDatasetRequestRequestTypeDef(TypedDict):
    DatasetArn: str,

DescribeExplainabilityExportRequestRequestTypeDef#

# DescribeExplainabilityExportRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import DescribeExplainabilityExportRequestRequestTypeDef

def get_value() -> DescribeExplainabilityExportRequestRequestTypeDef:
    return {
        "ExplainabilityExportArn": ...,
    }
# DescribeExplainabilityExportRequestRequestTypeDef definition

class DescribeExplainabilityExportRequestRequestTypeDef(TypedDict):
    ExplainabilityExportArn: str,

DescribeExplainabilityRequestRequestTypeDef#

# DescribeExplainabilityRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import DescribeExplainabilityRequestRequestTypeDef

def get_value() -> DescribeExplainabilityRequestRequestTypeDef:
    return {
        "ExplainabilityArn": ...,
    }
# DescribeExplainabilityRequestRequestTypeDef definition

class DescribeExplainabilityRequestRequestTypeDef(TypedDict):
    ExplainabilityArn: str,

DescribeForecastExportJobRequestRequestTypeDef#

# DescribeForecastExportJobRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import DescribeForecastExportJobRequestRequestTypeDef

def get_value() -> DescribeForecastExportJobRequestRequestTypeDef:
    return {
        "ForecastExportJobArn": ...,
    }
# DescribeForecastExportJobRequestRequestTypeDef definition

class DescribeForecastExportJobRequestRequestTypeDef(TypedDict):
    ForecastExportJobArn: str,

DescribeForecastRequestRequestTypeDef#

# DescribeForecastRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import DescribeForecastRequestRequestTypeDef

def get_value() -> DescribeForecastRequestRequestTypeDef:
    return {
        "ForecastArn": ...,
    }
# DescribeForecastRequestRequestTypeDef definition

class DescribeForecastRequestRequestTypeDef(TypedDict):
    ForecastArn: str,

DescribeMonitorRequestRequestTypeDef#

# DescribeMonitorRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import DescribeMonitorRequestRequestTypeDef

def get_value() -> DescribeMonitorRequestRequestTypeDef:
    return {
        "MonitorArn": ...,
    }
# DescribeMonitorRequestRequestTypeDef definition

class DescribeMonitorRequestRequestTypeDef(TypedDict):
    MonitorArn: str,

DescribePredictorBacktestExportJobRequestRequestTypeDef#

# DescribePredictorBacktestExportJobRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import DescribePredictorBacktestExportJobRequestRequestTypeDef

def get_value() -> DescribePredictorBacktestExportJobRequestRequestTypeDef:
    return {
        "PredictorBacktestExportJobArn": ...,
    }
# DescribePredictorBacktestExportJobRequestRequestTypeDef definition

class DescribePredictorBacktestExportJobRequestRequestTypeDef(TypedDict):
    PredictorBacktestExportJobArn: str,

DescribePredictorRequestRequestTypeDef#

# DescribePredictorRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import DescribePredictorRequestRequestTypeDef

def get_value() -> DescribePredictorRequestRequestTypeDef:
    return {
        "PredictorArn": ...,
    }
# DescribePredictorRequestRequestTypeDef definition

class DescribePredictorRequestRequestTypeDef(TypedDict):
    PredictorArn: str,

DescribeWhatIfAnalysisRequestRequestTypeDef#

# DescribeWhatIfAnalysisRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import DescribeWhatIfAnalysisRequestRequestTypeDef

def get_value() -> DescribeWhatIfAnalysisRequestRequestTypeDef:
    return {
        "WhatIfAnalysisArn": ...,
    }
# DescribeWhatIfAnalysisRequestRequestTypeDef definition

class DescribeWhatIfAnalysisRequestRequestTypeDef(TypedDict):
    WhatIfAnalysisArn: str,

DescribeWhatIfForecastExportRequestRequestTypeDef#

# DescribeWhatIfForecastExportRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import DescribeWhatIfForecastExportRequestRequestTypeDef

def get_value() -> DescribeWhatIfForecastExportRequestRequestTypeDef:
    return {
        "WhatIfForecastExportArn": ...,
    }
# DescribeWhatIfForecastExportRequestRequestTypeDef definition

class DescribeWhatIfForecastExportRequestRequestTypeDef(TypedDict):
    WhatIfForecastExportArn: str,

DescribeWhatIfForecastRequestRequestTypeDef#

# DescribeWhatIfForecastRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import DescribeWhatIfForecastRequestRequestTypeDef

def get_value() -> DescribeWhatIfForecastRequestRequestTypeDef:
    return {
        "WhatIfForecastArn": ...,
    }
# DescribeWhatIfForecastRequestRequestTypeDef definition

class DescribeWhatIfForecastRequestRequestTypeDef(TypedDict):
    WhatIfForecastArn: str,

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef usage example

from mypy_boto3_forecast.type_defs import EmptyResponseMetadataTypeDef

def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }
# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ErrorMetricTypeDef#

# ErrorMetricTypeDef usage example

from mypy_boto3_forecast.type_defs import ErrorMetricTypeDef

def get_value() -> ErrorMetricTypeDef:
    return {
        "ForecastType": ...,
    }
# ErrorMetricTypeDef definition

class ErrorMetricTypeDef(TypedDict):
    ForecastType: NotRequired[str],
    WAPE: NotRequired[float],
    RMSE: NotRequired[float],
    MASE: NotRequired[float],
    MAPE: NotRequired[float],

FeaturizationMethodTypeDef#

# FeaturizationMethodTypeDef usage example

from mypy_boto3_forecast.type_defs import FeaturizationMethodTypeDef

def get_value() -> FeaturizationMethodTypeDef:
    return {
        "FeaturizationMethodName": ...,
    }
# FeaturizationMethodTypeDef definition

class FeaturizationMethodTypeDef(TypedDict):
    FeaturizationMethodName: FeaturizationMethodNameType,  # (1)
    FeaturizationMethodParameters: NotRequired[Mapping[str, str]],
  1. See FeaturizationMethodNameType

FilterTypeDef#

# FilterTypeDef usage example

from mypy_boto3_forecast.type_defs import FilterTypeDef

def get_value() -> FilterTypeDef:
    return {
        "Key": ...,
        "Value": ...,
        "Condition": ...,
    }
# FilterTypeDef definition

class FilterTypeDef(TypedDict):
    Key: str,
    Value: str,
    Condition: FilterConditionStringType,  # (1)
  1. See FilterConditionStringType

ForecastSummaryTypeDef#

# ForecastSummaryTypeDef usage example

from mypy_boto3_forecast.type_defs import ForecastSummaryTypeDef

def get_value() -> ForecastSummaryTypeDef:
    return {
        "ForecastArn": ...,
    }
# ForecastSummaryTypeDef definition

class ForecastSummaryTypeDef(TypedDict):
    ForecastArn: NotRequired[str],
    ForecastName: NotRequired[str],
    PredictorArn: NotRequired[str],
    CreatedUsingAutoPredictor: NotRequired[bool],
    DatasetGroupArn: NotRequired[str],
    Status: NotRequired[str],
    Message: NotRequired[str],
    CreationTime: NotRequired[datetime],
    LastModificationTime: NotRequired[datetime],

GetAccuracyMetricsRequestRequestTypeDef#

# GetAccuracyMetricsRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import GetAccuracyMetricsRequestRequestTypeDef

def get_value() -> GetAccuracyMetricsRequestRequestTypeDef:
    return {
        "PredictorArn": ...,
    }
# GetAccuracyMetricsRequestRequestTypeDef definition

class GetAccuracyMetricsRequestRequestTypeDef(TypedDict):
    PredictorArn: str,

SupplementaryFeatureTypeDef#

# SupplementaryFeatureTypeDef usage example

from mypy_boto3_forecast.type_defs import SupplementaryFeatureTypeDef

def get_value() -> SupplementaryFeatureTypeDef:
    return {
        "Name": ...,
        "Value": ...,
    }
# SupplementaryFeatureTypeDef definition

class SupplementaryFeatureTypeDef(TypedDict):
    Name: str,
    Value: str,

IntegerParameterRangeTypeDef#

# IntegerParameterRangeTypeDef usage example

from mypy_boto3_forecast.type_defs import IntegerParameterRangeTypeDef

def get_value() -> IntegerParameterRangeTypeDef:
    return {
        "Name": ...,
        "MaxValue": ...,
        "MinValue": ...,
    }
# IntegerParameterRangeTypeDef definition

class IntegerParameterRangeTypeDef(TypedDict):
    Name: str,
    MaxValue: int,
    MinValue: int,
    ScalingType: NotRequired[ScalingTypeType],  # (1)
  1. See ScalingTypeType

ListDatasetGroupsRequestListDatasetGroupsPaginateTypeDef#

# ListDatasetGroupsRequestListDatasetGroupsPaginateTypeDef usage example

from mypy_boto3_forecast.type_defs import ListDatasetGroupsRequestListDatasetGroupsPaginateTypeDef

def get_value() -> ListDatasetGroupsRequestListDatasetGroupsPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }
# ListDatasetGroupsRequestListDatasetGroupsPaginateTypeDef definition

class ListDatasetGroupsRequestListDatasetGroupsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListDatasetGroupsRequestRequestTypeDef#

# ListDatasetGroupsRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import ListDatasetGroupsRequestRequestTypeDef

def get_value() -> ListDatasetGroupsRequestRequestTypeDef:
    return {
        "NextToken": ...,
    }
# ListDatasetGroupsRequestRequestTypeDef definition

class ListDatasetGroupsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListDatasetsRequestListDatasetsPaginateTypeDef#

# ListDatasetsRequestListDatasetsPaginateTypeDef usage example

from mypy_boto3_forecast.type_defs import ListDatasetsRequestListDatasetsPaginateTypeDef

def get_value() -> ListDatasetsRequestListDatasetsPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }
# ListDatasetsRequestListDatasetsPaginateTypeDef definition

class ListDatasetsRequestListDatasetsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListDatasetsRequestRequestTypeDef#

# ListDatasetsRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import ListDatasetsRequestRequestTypeDef

def get_value() -> ListDatasetsRequestRequestTypeDef:
    return {
        "NextToken": ...,
    }
# ListDatasetsRequestRequestTypeDef definition

class ListDatasetsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

MonitorSummaryTypeDef#

# MonitorSummaryTypeDef usage example

from mypy_boto3_forecast.type_defs import MonitorSummaryTypeDef

def get_value() -> MonitorSummaryTypeDef:
    return {
        "MonitorArn": ...,
    }
# MonitorSummaryTypeDef definition

class MonitorSummaryTypeDef(TypedDict):
    MonitorArn: NotRequired[str],
    MonitorName: NotRequired[str],
    ResourceArn: NotRequired[str],
    Status: NotRequired[str],
    CreationTime: NotRequired[datetime],
    LastModificationTime: NotRequired[datetime],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import ListTagsForResourceRequestRequestTypeDef

def get_value() -> ListTagsForResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
    }
# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

WhatIfAnalysisSummaryTypeDef#

# WhatIfAnalysisSummaryTypeDef usage example

from mypy_boto3_forecast.type_defs import WhatIfAnalysisSummaryTypeDef

def get_value() -> WhatIfAnalysisSummaryTypeDef:
    return {
        "WhatIfAnalysisArn": ...,
    }
# WhatIfAnalysisSummaryTypeDef definition

class WhatIfAnalysisSummaryTypeDef(TypedDict):
    WhatIfAnalysisArn: NotRequired[str],
    WhatIfAnalysisName: NotRequired[str],
    ForecastArn: NotRequired[str],
    Status: NotRequired[str],
    Message: NotRequired[str],
    CreationTime: NotRequired[datetime],
    LastModificationTime: NotRequired[datetime],

WhatIfForecastSummaryTypeDef#

# WhatIfForecastSummaryTypeDef usage example

from mypy_boto3_forecast.type_defs import WhatIfForecastSummaryTypeDef

def get_value() -> WhatIfForecastSummaryTypeDef:
    return {
        "WhatIfForecastArn": ...,
    }
# WhatIfForecastSummaryTypeDef definition

class WhatIfForecastSummaryTypeDef(TypedDict):
    WhatIfForecastArn: NotRequired[str],
    WhatIfForecastName: NotRequired[str],
    WhatIfAnalysisArn: NotRequired[str],
    Status: NotRequired[str],
    Message: NotRequired[str],
    CreationTime: NotRequired[datetime],
    LastModificationTime: NotRequired[datetime],

MetricResultTypeDef#

# MetricResultTypeDef usage example

from mypy_boto3_forecast.type_defs import MetricResultTypeDef

def get_value() -> MetricResultTypeDef:
    return {
        "MetricName": ...,
    }
# MetricResultTypeDef definition

class MetricResultTypeDef(TypedDict):
    MetricName: NotRequired[str],
    MetricValue: NotRequired[float],

WeightedQuantileLossTypeDef#

# WeightedQuantileLossTypeDef usage example

from mypy_boto3_forecast.type_defs import WeightedQuantileLossTypeDef

def get_value() -> WeightedQuantileLossTypeDef:
    return {
        "Quantile": ...,
    }
# WeightedQuantileLossTypeDef definition

class WeightedQuantileLossTypeDef(TypedDict):
    Quantile: NotRequired[float],
    LossValue: NotRequired[float],

MonitorDataSourceTypeDef#

# MonitorDataSourceTypeDef usage example

from mypy_boto3_forecast.type_defs import MonitorDataSourceTypeDef

def get_value() -> MonitorDataSourceTypeDef:
    return {
        "DatasetImportJobArn": ...,
    }
# MonitorDataSourceTypeDef definition

class MonitorDataSourceTypeDef(TypedDict):
    DatasetImportJobArn: NotRequired[str],
    ForecastArn: NotRequired[str],
    PredictorArn: NotRequired[str],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef usage example

from mypy_boto3_forecast.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }
# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

PredictorEventTypeDef#

# PredictorEventTypeDef usage example

from mypy_boto3_forecast.type_defs import PredictorEventTypeDef

def get_value() -> PredictorEventTypeDef:
    return {
        "Detail": ...,
    }
# PredictorEventTypeDef definition

class PredictorEventTypeDef(TypedDict):
    Detail: NotRequired[str],
    Datetime: NotRequired[datetime],

TestWindowSummaryTypeDef#

# TestWindowSummaryTypeDef usage example

from mypy_boto3_forecast.type_defs import TestWindowSummaryTypeDef

def get_value() -> TestWindowSummaryTypeDef:
    return {
        "TestWindowStart": ...,
    }
# TestWindowSummaryTypeDef definition

class TestWindowSummaryTypeDef(TypedDict):
    TestWindowStart: NotRequired[datetime],
    TestWindowEnd: NotRequired[datetime],
    Status: NotRequired[str],
    Message: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef usage example

from mypy_boto3_forecast.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
# ResponseMetadataTypeDef definition

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

ResumeResourceRequestRequestTypeDef#

# ResumeResourceRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import ResumeResourceRequestRequestTypeDef

def get_value() -> ResumeResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
    }
# ResumeResourceRequestRequestTypeDef definition

class ResumeResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

SchemaAttributeTypeDef#

# SchemaAttributeTypeDef usage example

from mypy_boto3_forecast.type_defs import SchemaAttributeTypeDef

def get_value() -> SchemaAttributeTypeDef:
    return {
        "AttributeName": ...,
    }
# SchemaAttributeTypeDef definition

class SchemaAttributeTypeDef(TypedDict):
    AttributeName: NotRequired[str],
    AttributeType: NotRequired[AttributeTypeType],  # (1)
  1. See AttributeTypeType

StopResourceRequestRequestTypeDef#

# StopResourceRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import StopResourceRequestRequestTypeDef

def get_value() -> StopResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
    }
# StopResourceRequestRequestTypeDef definition

class StopResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

TimeSeriesConditionTypeDef#

# TimeSeriesConditionTypeDef usage example

from mypy_boto3_forecast.type_defs import TimeSeriesConditionTypeDef

def get_value() -> TimeSeriesConditionTypeDef:
    return {
        "AttributeName": ...,
        "AttributeValue": ...,
        "Condition": ...,
    }
# TimeSeriesConditionTypeDef definition

class TimeSeriesConditionTypeDef(TypedDict):
    AttributeName: str,
    AttributeValue: str,
    Condition: ConditionType,  # (1)
  1. See ConditionType

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
        "TagKeys": ...,
    }
# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

UpdateDatasetGroupRequestRequestTypeDef#

# UpdateDatasetGroupRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import UpdateDatasetGroupRequestRequestTypeDef

def get_value() -> UpdateDatasetGroupRequestRequestTypeDef:
    return {
        "DatasetGroupArn": ...,
        "DatasetArns": ...,
    }
# UpdateDatasetGroupRequestRequestTypeDef definition

class UpdateDatasetGroupRequestRequestTypeDef(TypedDict):
    DatasetGroupArn: str,
    DatasetArns: Sequence[str],

DataConfigTypeDef#

# DataConfigTypeDef usage example

from mypy_boto3_forecast.type_defs import DataConfigTypeDef

def get_value() -> DataConfigTypeDef:
    return {
        "DatasetGroupArn": ...,
    }
# DataConfigTypeDef definition

class DataConfigTypeDef(TypedDict):
    DatasetGroupArn: str,
    AttributeConfigs: NotRequired[Sequence[AttributeConfigTypeDef]],  # (1)
    AdditionalDatasets: NotRequired[Sequence[AdditionalDatasetTypeDef]],  # (2)
  1. See AttributeConfigTypeDef
  2. See AdditionalDatasetTypeDef

PredictorBaselineTypeDef#

# PredictorBaselineTypeDef usage example

from mypy_boto3_forecast.type_defs import PredictorBaselineTypeDef

def get_value() -> PredictorBaselineTypeDef:
    return {
        "BaselineMetrics": ...,
    }
# PredictorBaselineTypeDef definition

class PredictorBaselineTypeDef(TypedDict):
    BaselineMetrics: NotRequired[List[BaselineMetricTypeDef]],  # (1)
  1. See BaselineMetricTypeDef

CreateDatasetGroupRequestRequestTypeDef#

# CreateDatasetGroupRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import CreateDatasetGroupRequestRequestTypeDef

def get_value() -> CreateDatasetGroupRequestRequestTypeDef:
    return {
        "DatasetGroupName": ...,
        "Domain": ...,
    }
# CreateDatasetGroupRequestRequestTypeDef definition

class CreateDatasetGroupRequestRequestTypeDef(TypedDict):
    DatasetGroupName: str,
    Domain: DomainType,  # (1)
    DatasetArns: NotRequired[Sequence[str]],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See DomainType
  2. See TagTypeDef

CreateMonitorRequestRequestTypeDef#

# CreateMonitorRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import CreateMonitorRequestRequestTypeDef

def get_value() -> CreateMonitorRequestRequestTypeDef:
    return {
        "MonitorName": ...,
        "ResourceArn": ...,
    }
# CreateMonitorRequestRequestTypeDef definition

class CreateMonitorRequestRequestTypeDef(TypedDict):
    MonitorName: str,
    ResourceArn: str,
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import ListTagsForResourceResponseTypeDef

def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "Tags": ...,
        "ResponseMetadata": ...,
    }
# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import TagResourceRequestRequestTypeDef

def get_value() -> TagResourceRequestRequestTypeDef:
    return {
        "ResourceArn": ...,
        "Tags": ...,
    }
# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

ExplainabilitySummaryTypeDef#

# ExplainabilitySummaryTypeDef usage example

from mypy_boto3_forecast.type_defs import ExplainabilitySummaryTypeDef

def get_value() -> ExplainabilitySummaryTypeDef:
    return {
        "ExplainabilityArn": ...,
    }
# ExplainabilitySummaryTypeDef definition

class ExplainabilitySummaryTypeDef(TypedDict):
    ExplainabilityArn: NotRequired[str],
    ExplainabilityName: NotRequired[str],
    ResourceArn: NotRequired[str],
    ExplainabilityConfig: NotRequired[ExplainabilityConfigTypeDef],  # (1)
    Status: NotRequired[str],
    Message: NotRequired[str],
    CreationTime: NotRequired[datetime],
    LastModificationTime: NotRequired[datetime],
  1. See ExplainabilityConfigTypeDef

DataDestinationTypeDef#

# DataDestinationTypeDef usage example

from mypy_boto3_forecast.type_defs import DataDestinationTypeDef

def get_value() -> DataDestinationTypeDef:
    return {
        "S3Config": ...,
    }
# DataDestinationTypeDef definition

class DataDestinationTypeDef(TypedDict):
    S3Config: S3ConfigTypeDef,  # (1)
  1. See S3ConfigTypeDef

DataSourceTypeDef#

# DataSourceTypeDef usage example

from mypy_boto3_forecast.type_defs import DataSourceTypeDef

def get_value() -> DataSourceTypeDef:
    return {
        "S3Config": ...,
    }
# DataSourceTypeDef definition

class DataSourceTypeDef(TypedDict):
    S3Config: S3ConfigTypeDef,  # (1)
  1. See S3ConfigTypeDef

ListDatasetGroupsResponseTypeDef#

# ListDatasetGroupsResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import ListDatasetGroupsResponseTypeDef

def get_value() -> ListDatasetGroupsResponseTypeDef:
    return {
        "DatasetGroups": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListDatasetGroupsResponseTypeDef definition

class ListDatasetGroupsResponseTypeDef(TypedDict):
    DatasetGroups: List[DatasetGroupSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DatasetGroupSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListDatasetsResponseTypeDef#

# ListDatasetsResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import ListDatasetsResponseTypeDef

def get_value() -> ListDatasetsResponseTypeDef:
    return {
        "Datasets": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListDatasetsResponseTypeDef definition

class ListDatasetsResponseTypeDef(TypedDict):
    Datasets: List[DatasetSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DatasetSummaryTypeDef
  2. See ResponseMetadataTypeDef

PredictorSummaryTypeDef#

# PredictorSummaryTypeDef usage example

from mypy_boto3_forecast.type_defs import PredictorSummaryTypeDef

def get_value() -> PredictorSummaryTypeDef:
    return {
        "PredictorArn": ...,
    }
# PredictorSummaryTypeDef definition

class PredictorSummaryTypeDef(TypedDict):
    PredictorArn: NotRequired[str],
    PredictorName: NotRequired[str],
    DatasetGroupArn: NotRequired[str],
    IsAutoPredictor: NotRequired[bool],
    ReferencePredictorSummary: NotRequired[ReferencePredictorSummaryTypeDef],  # (1)
    Status: NotRequired[str],
    Message: NotRequired[str],
    CreationTime: NotRequired[datetime],
    LastModificationTime: NotRequired[datetime],
  1. See ReferencePredictorSummaryTypeDef

FeaturizationTypeDef#

# FeaturizationTypeDef usage example

from mypy_boto3_forecast.type_defs import FeaturizationTypeDef

def get_value() -> FeaturizationTypeDef:
    return {
        "AttributeName": ...,
    }
# FeaturizationTypeDef definition

class FeaturizationTypeDef(TypedDict):
    AttributeName: str,
    FeaturizationPipeline: NotRequired[Sequence[FeaturizationMethodTypeDef]],  # (1)
  1. See FeaturizationMethodTypeDef

ListDatasetImportJobsRequestListDatasetImportJobsPaginateTypeDef#

# ListDatasetImportJobsRequestListDatasetImportJobsPaginateTypeDef usage example

from mypy_boto3_forecast.type_defs import ListDatasetImportJobsRequestListDatasetImportJobsPaginateTypeDef

def get_value() -> ListDatasetImportJobsRequestListDatasetImportJobsPaginateTypeDef:
    return {
        "Filters": ...,
    }
# ListDatasetImportJobsRequestListDatasetImportJobsPaginateTypeDef definition

class ListDatasetImportJobsRequestListDatasetImportJobsPaginateTypeDef(TypedDict):
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See FilterTypeDef
  2. See PaginatorConfigTypeDef

ListDatasetImportJobsRequestRequestTypeDef#

# ListDatasetImportJobsRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import ListDatasetImportJobsRequestRequestTypeDef

def get_value() -> ListDatasetImportJobsRequestRequestTypeDef:
    return {
        "NextToken": ...,
    }
# ListDatasetImportJobsRequestRequestTypeDef definition

class ListDatasetImportJobsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
  1. See FilterTypeDef

ListExplainabilitiesRequestListExplainabilitiesPaginateTypeDef#

# ListExplainabilitiesRequestListExplainabilitiesPaginateTypeDef usage example

from mypy_boto3_forecast.type_defs import ListExplainabilitiesRequestListExplainabilitiesPaginateTypeDef

def get_value() -> ListExplainabilitiesRequestListExplainabilitiesPaginateTypeDef:
    return {
        "Filters": ...,
    }
# ListExplainabilitiesRequestListExplainabilitiesPaginateTypeDef definition

class ListExplainabilitiesRequestListExplainabilitiesPaginateTypeDef(TypedDict):
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See FilterTypeDef
  2. See PaginatorConfigTypeDef

ListExplainabilitiesRequestRequestTypeDef#

# ListExplainabilitiesRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import ListExplainabilitiesRequestRequestTypeDef

def get_value() -> ListExplainabilitiesRequestRequestTypeDef:
    return {
        "NextToken": ...,
    }
# ListExplainabilitiesRequestRequestTypeDef definition

class ListExplainabilitiesRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
  1. See FilterTypeDef

ListExplainabilityExportsRequestListExplainabilityExportsPaginateTypeDef#

# ListExplainabilityExportsRequestListExplainabilityExportsPaginateTypeDef usage example

from mypy_boto3_forecast.type_defs import ListExplainabilityExportsRequestListExplainabilityExportsPaginateTypeDef

def get_value() -> ListExplainabilityExportsRequestListExplainabilityExportsPaginateTypeDef:
    return {
        "Filters": ...,
    }
# ListExplainabilityExportsRequestListExplainabilityExportsPaginateTypeDef definition

class ListExplainabilityExportsRequestListExplainabilityExportsPaginateTypeDef(TypedDict):
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See FilterTypeDef
  2. See PaginatorConfigTypeDef

ListExplainabilityExportsRequestRequestTypeDef#

# ListExplainabilityExportsRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import ListExplainabilityExportsRequestRequestTypeDef

def get_value() -> ListExplainabilityExportsRequestRequestTypeDef:
    return {
        "NextToken": ...,
    }
# ListExplainabilityExportsRequestRequestTypeDef definition

class ListExplainabilityExportsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
  1. See FilterTypeDef

ListForecastExportJobsRequestListForecastExportJobsPaginateTypeDef#

# ListForecastExportJobsRequestListForecastExportJobsPaginateTypeDef usage example

from mypy_boto3_forecast.type_defs import ListForecastExportJobsRequestListForecastExportJobsPaginateTypeDef

def get_value() -> ListForecastExportJobsRequestListForecastExportJobsPaginateTypeDef:
    return {
        "Filters": ...,
    }
# ListForecastExportJobsRequestListForecastExportJobsPaginateTypeDef definition

class ListForecastExportJobsRequestListForecastExportJobsPaginateTypeDef(TypedDict):
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See FilterTypeDef
  2. See PaginatorConfigTypeDef

ListForecastExportJobsRequestRequestTypeDef#

# ListForecastExportJobsRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import ListForecastExportJobsRequestRequestTypeDef

def get_value() -> ListForecastExportJobsRequestRequestTypeDef:
    return {
        "NextToken": ...,
    }
# ListForecastExportJobsRequestRequestTypeDef definition

class ListForecastExportJobsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
  1. See FilterTypeDef

ListForecastsRequestListForecastsPaginateTypeDef#

# ListForecastsRequestListForecastsPaginateTypeDef usage example

from mypy_boto3_forecast.type_defs import ListForecastsRequestListForecastsPaginateTypeDef

def get_value() -> ListForecastsRequestListForecastsPaginateTypeDef:
    return {
        "Filters": ...,
    }
# ListForecastsRequestListForecastsPaginateTypeDef definition

class ListForecastsRequestListForecastsPaginateTypeDef(TypedDict):
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See FilterTypeDef
  2. See PaginatorConfigTypeDef

ListForecastsRequestRequestTypeDef#

# ListForecastsRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import ListForecastsRequestRequestTypeDef

def get_value() -> ListForecastsRequestRequestTypeDef:
    return {
        "NextToken": ...,
    }
# ListForecastsRequestRequestTypeDef definition

class ListForecastsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
  1. See FilterTypeDef

ListMonitorEvaluationsRequestListMonitorEvaluationsPaginateTypeDef#

# ListMonitorEvaluationsRequestListMonitorEvaluationsPaginateTypeDef usage example

from mypy_boto3_forecast.type_defs import ListMonitorEvaluationsRequestListMonitorEvaluationsPaginateTypeDef

def get_value() -> ListMonitorEvaluationsRequestListMonitorEvaluationsPaginateTypeDef:
    return {
        "MonitorArn": ...,
    }
# ListMonitorEvaluationsRequestListMonitorEvaluationsPaginateTypeDef definition

class ListMonitorEvaluationsRequestListMonitorEvaluationsPaginateTypeDef(TypedDict):
    MonitorArn: str,
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See FilterTypeDef
  2. See PaginatorConfigTypeDef

ListMonitorEvaluationsRequestRequestTypeDef#

# ListMonitorEvaluationsRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import ListMonitorEvaluationsRequestRequestTypeDef

def get_value() -> ListMonitorEvaluationsRequestRequestTypeDef:
    return {
        "MonitorArn": ...,
    }
# ListMonitorEvaluationsRequestRequestTypeDef definition

class ListMonitorEvaluationsRequestRequestTypeDef(TypedDict):
    MonitorArn: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
  1. See FilterTypeDef

ListMonitorsRequestListMonitorsPaginateTypeDef#

# ListMonitorsRequestListMonitorsPaginateTypeDef usage example

from mypy_boto3_forecast.type_defs import ListMonitorsRequestListMonitorsPaginateTypeDef

def get_value() -> ListMonitorsRequestListMonitorsPaginateTypeDef:
    return {
        "Filters": ...,
    }
# ListMonitorsRequestListMonitorsPaginateTypeDef definition

class ListMonitorsRequestListMonitorsPaginateTypeDef(TypedDict):
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See FilterTypeDef
  2. See PaginatorConfigTypeDef

ListMonitorsRequestRequestTypeDef#

# ListMonitorsRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import ListMonitorsRequestRequestTypeDef

def get_value() -> ListMonitorsRequestRequestTypeDef:
    return {
        "NextToken": ...,
    }
# ListMonitorsRequestRequestTypeDef definition

class ListMonitorsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
  1. See FilterTypeDef

ListPredictorBacktestExportJobsRequestListPredictorBacktestExportJobsPaginateTypeDef#

# ListPredictorBacktestExportJobsRequestListPredictorBacktestExportJobsPaginateTypeDef usage example

from mypy_boto3_forecast.type_defs import ListPredictorBacktestExportJobsRequestListPredictorBacktestExportJobsPaginateTypeDef

def get_value() -> ListPredictorBacktestExportJobsRequestListPredictorBacktestExportJobsPaginateTypeDef:
    return {
        "Filters": ...,
    }
# ListPredictorBacktestExportJobsRequestListPredictorBacktestExportJobsPaginateTypeDef definition

class ListPredictorBacktestExportJobsRequestListPredictorBacktestExportJobsPaginateTypeDef(TypedDict):
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See FilterTypeDef
  2. See PaginatorConfigTypeDef

ListPredictorBacktestExportJobsRequestRequestTypeDef#

# ListPredictorBacktestExportJobsRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import ListPredictorBacktestExportJobsRequestRequestTypeDef

def get_value() -> ListPredictorBacktestExportJobsRequestRequestTypeDef:
    return {
        "NextToken": ...,
    }
# ListPredictorBacktestExportJobsRequestRequestTypeDef definition

class ListPredictorBacktestExportJobsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
  1. See FilterTypeDef

ListPredictorsRequestListPredictorsPaginateTypeDef#

# ListPredictorsRequestListPredictorsPaginateTypeDef usage example

from mypy_boto3_forecast.type_defs import ListPredictorsRequestListPredictorsPaginateTypeDef

def get_value() -> ListPredictorsRequestListPredictorsPaginateTypeDef:
    return {
        "Filters": ...,
    }
# ListPredictorsRequestListPredictorsPaginateTypeDef definition

class ListPredictorsRequestListPredictorsPaginateTypeDef(TypedDict):
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See FilterTypeDef
  2. See PaginatorConfigTypeDef

ListPredictorsRequestRequestTypeDef#

# ListPredictorsRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import ListPredictorsRequestRequestTypeDef

def get_value() -> ListPredictorsRequestRequestTypeDef:
    return {
        "NextToken": ...,
    }
# ListPredictorsRequestRequestTypeDef definition

class ListPredictorsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
  1. See FilterTypeDef

ListWhatIfAnalysesRequestListWhatIfAnalysesPaginateTypeDef#

# ListWhatIfAnalysesRequestListWhatIfAnalysesPaginateTypeDef usage example

from mypy_boto3_forecast.type_defs import ListWhatIfAnalysesRequestListWhatIfAnalysesPaginateTypeDef

def get_value() -> ListWhatIfAnalysesRequestListWhatIfAnalysesPaginateTypeDef:
    return {
        "Filters": ...,
    }
# ListWhatIfAnalysesRequestListWhatIfAnalysesPaginateTypeDef definition

class ListWhatIfAnalysesRequestListWhatIfAnalysesPaginateTypeDef(TypedDict):
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See FilterTypeDef
  2. See PaginatorConfigTypeDef

ListWhatIfAnalysesRequestRequestTypeDef#

# ListWhatIfAnalysesRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import ListWhatIfAnalysesRequestRequestTypeDef

def get_value() -> ListWhatIfAnalysesRequestRequestTypeDef:
    return {
        "NextToken": ...,
    }
# ListWhatIfAnalysesRequestRequestTypeDef definition

class ListWhatIfAnalysesRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
  1. See FilterTypeDef

ListWhatIfForecastExportsRequestListWhatIfForecastExportsPaginateTypeDef#

# ListWhatIfForecastExportsRequestListWhatIfForecastExportsPaginateTypeDef usage example

from mypy_boto3_forecast.type_defs import ListWhatIfForecastExportsRequestListWhatIfForecastExportsPaginateTypeDef

def get_value() -> ListWhatIfForecastExportsRequestListWhatIfForecastExportsPaginateTypeDef:
    return {
        "Filters": ...,
    }
# ListWhatIfForecastExportsRequestListWhatIfForecastExportsPaginateTypeDef definition

class ListWhatIfForecastExportsRequestListWhatIfForecastExportsPaginateTypeDef(TypedDict):
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See FilterTypeDef
  2. See PaginatorConfigTypeDef

ListWhatIfForecastExportsRequestRequestTypeDef#

# ListWhatIfForecastExportsRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import ListWhatIfForecastExportsRequestRequestTypeDef

def get_value() -> ListWhatIfForecastExportsRequestRequestTypeDef:
    return {
        "NextToken": ...,
    }
# ListWhatIfForecastExportsRequestRequestTypeDef definition

class ListWhatIfForecastExportsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
  1. See FilterTypeDef

ListWhatIfForecastsRequestListWhatIfForecastsPaginateTypeDef#

# ListWhatIfForecastsRequestListWhatIfForecastsPaginateTypeDef usage example

from mypy_boto3_forecast.type_defs import ListWhatIfForecastsRequestListWhatIfForecastsPaginateTypeDef

def get_value() -> ListWhatIfForecastsRequestListWhatIfForecastsPaginateTypeDef:
    return {
        "Filters": ...,
    }
# ListWhatIfForecastsRequestListWhatIfForecastsPaginateTypeDef definition

class ListWhatIfForecastsRequestListWhatIfForecastsPaginateTypeDef(TypedDict):
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See FilterTypeDef
  2. See PaginatorConfigTypeDef

ListWhatIfForecastsRequestRequestTypeDef#

# ListWhatIfForecastsRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import ListWhatIfForecastsRequestRequestTypeDef

def get_value() -> ListWhatIfForecastsRequestRequestTypeDef:
    return {
        "NextToken": ...,
    }
# ListWhatIfForecastsRequestRequestTypeDef definition

class ListWhatIfForecastsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
  1. See FilterTypeDef

ListForecastsResponseTypeDef#

# ListForecastsResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import ListForecastsResponseTypeDef

def get_value() -> ListForecastsResponseTypeDef:
    return {
        "Forecasts": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListForecastsResponseTypeDef definition

class ListForecastsResponseTypeDef(TypedDict):
    Forecasts: List[ForecastSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ForecastSummaryTypeDef
  2. See ResponseMetadataTypeDef

InputDataConfigTypeDef#

# InputDataConfigTypeDef usage example

from mypy_boto3_forecast.type_defs import InputDataConfigTypeDef

def get_value() -> InputDataConfigTypeDef:
    return {
        "DatasetGroupArn": ...,
    }
# InputDataConfigTypeDef definition

class InputDataConfigTypeDef(TypedDict):
    DatasetGroupArn: str,
    SupplementaryFeatures: NotRequired[Sequence[SupplementaryFeatureTypeDef]],  # (1)
  1. See SupplementaryFeatureTypeDef

ParameterRangesTypeDef#

# ParameterRangesTypeDef usage example

from mypy_boto3_forecast.type_defs import ParameterRangesTypeDef

def get_value() -> ParameterRangesTypeDef:
    return {
        "CategoricalParameterRanges": ...,
    }
# ParameterRangesTypeDef definition

class ParameterRangesTypeDef(TypedDict):
    CategoricalParameterRanges: NotRequired[Sequence[CategoricalParameterRangeTypeDef]],  # (1)
    ContinuousParameterRanges: NotRequired[Sequence[ContinuousParameterRangeTypeDef]],  # (2)
    IntegerParameterRanges: NotRequired[Sequence[IntegerParameterRangeTypeDef]],  # (3)
  1. See CategoricalParameterRangeTypeDef
  2. See ContinuousParameterRangeTypeDef
  3. See IntegerParameterRangeTypeDef

ListMonitorsResponseTypeDef#

# ListMonitorsResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import ListMonitorsResponseTypeDef

def get_value() -> ListMonitorsResponseTypeDef:
    return {
        "Monitors": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListMonitorsResponseTypeDef definition

class ListMonitorsResponseTypeDef(TypedDict):
    Monitors: List[MonitorSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MonitorSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListWhatIfAnalysesResponseTypeDef#

# ListWhatIfAnalysesResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import ListWhatIfAnalysesResponseTypeDef

def get_value() -> ListWhatIfAnalysesResponseTypeDef:
    return {
        "WhatIfAnalyses": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListWhatIfAnalysesResponseTypeDef definition

class ListWhatIfAnalysesResponseTypeDef(TypedDict):
    WhatIfAnalyses: List[WhatIfAnalysisSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WhatIfAnalysisSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListWhatIfForecastsResponseTypeDef#

# ListWhatIfForecastsResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import ListWhatIfForecastsResponseTypeDef

def get_value() -> ListWhatIfForecastsResponseTypeDef:
    return {
        "WhatIfForecasts": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListWhatIfForecastsResponseTypeDef definition

class ListWhatIfForecastsResponseTypeDef(TypedDict):
    WhatIfForecasts: List[WhatIfForecastSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WhatIfForecastSummaryTypeDef
  2. See ResponseMetadataTypeDef

MetricsTypeDef#

# MetricsTypeDef usage example

from mypy_boto3_forecast.type_defs import MetricsTypeDef

def get_value() -> MetricsTypeDef:
    return {
        "RMSE": ...,
    }
# MetricsTypeDef definition

class MetricsTypeDef(TypedDict):
    RMSE: NotRequired[float],
    WeightedQuantileLosses: NotRequired[List[WeightedQuantileLossTypeDef]],  # (1)
    ErrorMetrics: NotRequired[List[ErrorMetricTypeDef]],  # (2)
    AverageWeightedQuantileLoss: NotRequired[float],
  1. See WeightedQuantileLossTypeDef
  2. See ErrorMetricTypeDef

PredictorMonitorEvaluationTypeDef#

# PredictorMonitorEvaluationTypeDef usage example

from mypy_boto3_forecast.type_defs import PredictorMonitorEvaluationTypeDef

def get_value() -> PredictorMonitorEvaluationTypeDef:
    return {
        "ResourceArn": ...,
    }
# PredictorMonitorEvaluationTypeDef definition

class PredictorMonitorEvaluationTypeDef(TypedDict):
    ResourceArn: NotRequired[str],
    MonitorArn: NotRequired[str],
    EvaluationTime: NotRequired[datetime],
    EvaluationState: NotRequired[str],
    WindowStartDatetime: NotRequired[datetime],
    WindowEndDatetime: NotRequired[datetime],
    PredictorEvent: NotRequired[PredictorEventTypeDef],  # (1)
    MonitorDataSource: NotRequired[MonitorDataSourceTypeDef],  # (2)
    MetricResults: NotRequired[List[MetricResultTypeDef]],  # (3)
    NumItemsEvaluated: NotRequired[int],
    Message: NotRequired[str],
  1. See PredictorEventTypeDef
  2. See MonitorDataSourceTypeDef
  3. See MetricResultTypeDef

PredictorExecutionTypeDef#

# PredictorExecutionTypeDef usage example

from mypy_boto3_forecast.type_defs import PredictorExecutionTypeDef

def get_value() -> PredictorExecutionTypeDef:
    return {
        "AlgorithmArn": ...,
    }
# PredictorExecutionTypeDef definition

class PredictorExecutionTypeDef(TypedDict):
    AlgorithmArn: NotRequired[str],
    TestWindows: NotRequired[List[TestWindowSummaryTypeDef]],  # (1)
  1. See TestWindowSummaryTypeDef

SchemaTypeDef#

# SchemaTypeDef usage example

from mypy_boto3_forecast.type_defs import SchemaTypeDef

def get_value() -> SchemaTypeDef:
    return {
        "Attributes": ...,
    }
# SchemaTypeDef definition

class SchemaTypeDef(TypedDict):
    Attributes: NotRequired[Sequence[SchemaAttributeTypeDef]],  # (1)
  1. See SchemaAttributeTypeDef

TimeSeriesTransformationTypeDef#

# TimeSeriesTransformationTypeDef usage example

from mypy_boto3_forecast.type_defs import TimeSeriesTransformationTypeDef

def get_value() -> TimeSeriesTransformationTypeDef:
    return {
        "Action": ...,
    }
# TimeSeriesTransformationTypeDef definition

class TimeSeriesTransformationTypeDef(TypedDict):
    Action: NotRequired[ActionTypeDef],  # (1)
    TimeSeriesConditions: NotRequired[Sequence[TimeSeriesConditionTypeDef]],  # (2)
  1. See ActionTypeDef
  2. See TimeSeriesConditionTypeDef

CreateAutoPredictorRequestRequestTypeDef#

# CreateAutoPredictorRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import CreateAutoPredictorRequestRequestTypeDef

def get_value() -> CreateAutoPredictorRequestRequestTypeDef:
    return {
        "PredictorName": ...,
    }
# CreateAutoPredictorRequestRequestTypeDef definition

class CreateAutoPredictorRequestRequestTypeDef(TypedDict):
    PredictorName: str,
    ForecastHorizon: NotRequired[int],
    ForecastTypes: NotRequired[Sequence[str]],
    ForecastDimensions: NotRequired[Sequence[str]],
    ForecastFrequency: NotRequired[str],
    DataConfig: NotRequired[DataConfigTypeDef],  # (1)
    EncryptionConfig: NotRequired[EncryptionConfigTypeDef],  # (2)
    ReferencePredictorArn: NotRequired[str],
    OptimizationMetric: NotRequired[OptimizationMetricType],  # (3)
    ExplainPredictor: NotRequired[bool],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (4)
    MonitorConfig: NotRequired[MonitorConfigTypeDef],  # (5)
    TimeAlignmentBoundary: NotRequired[TimeAlignmentBoundaryTypeDef],  # (6)
  1. See DataConfigTypeDef
  2. See EncryptionConfigTypeDef
  3. See OptimizationMetricType
  4. See TagTypeDef
  5. See MonitorConfigTypeDef
  6. See TimeAlignmentBoundaryTypeDef

DescribeAutoPredictorResponseTypeDef#

# DescribeAutoPredictorResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import DescribeAutoPredictorResponseTypeDef

def get_value() -> DescribeAutoPredictorResponseTypeDef:
    return {
        "PredictorArn": ...,
        "PredictorName": ...,
        "ForecastHorizon": ...,
        "ForecastTypes": ...,
        "ForecastFrequency": ...,
        "ForecastDimensions": ...,
        "DatasetImportJobArns": ...,
        "DataConfig": ...,
        "EncryptionConfig": ...,
        "ReferencePredictorSummary": ...,
        "EstimatedTimeRemainingInMinutes": ...,
        "Status": ...,
        "Message": ...,
        "CreationTime": ...,
        "LastModificationTime": ...,
        "OptimizationMetric": ...,
        "ExplainabilityInfo": ...,
        "MonitorInfo": ...,
        "TimeAlignmentBoundary": ...,
        "ResponseMetadata": ...,
    }
# DescribeAutoPredictorResponseTypeDef definition

class DescribeAutoPredictorResponseTypeDef(TypedDict):
    PredictorArn: str,
    PredictorName: str,
    ForecastHorizon: int,
    ForecastTypes: List[str],
    ForecastFrequency: str,
    ForecastDimensions: List[str],
    DatasetImportJobArns: List[str],
    DataConfig: DataConfigTypeDef,  # (1)
    EncryptionConfig: EncryptionConfigTypeDef,  # (2)
    ReferencePredictorSummary: ReferencePredictorSummaryTypeDef,  # (3)
    EstimatedTimeRemainingInMinutes: int,
    Status: str,
    Message: str,
    CreationTime: datetime,
    LastModificationTime: datetime,
    OptimizationMetric: OptimizationMetricType,  # (4)
    ExplainabilityInfo: ExplainabilityInfoTypeDef,  # (5)
    MonitorInfo: MonitorInfoTypeDef,  # (6)
    TimeAlignmentBoundary: TimeAlignmentBoundaryTypeDef,  # (7)
    ResponseMetadata: ResponseMetadataTypeDef,  # (8)
  1. See DataConfigTypeDef
  2. See EncryptionConfigTypeDef
  3. See ReferencePredictorSummaryTypeDef
  4. See OptimizationMetricType
  5. See ExplainabilityInfoTypeDef
  6. See MonitorInfoTypeDef
  7. See TimeAlignmentBoundaryTypeDef
  8. See ResponseMetadataTypeDef

BaselineTypeDef#

# BaselineTypeDef usage example

from mypy_boto3_forecast.type_defs import BaselineTypeDef

def get_value() -> BaselineTypeDef:
    return {
        "PredictorBaseline": ...,
    }
# BaselineTypeDef definition

class BaselineTypeDef(TypedDict):
    PredictorBaseline: NotRequired[PredictorBaselineTypeDef],  # (1)
  1. See PredictorBaselineTypeDef

ListExplainabilitiesResponseTypeDef#

# ListExplainabilitiesResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import ListExplainabilitiesResponseTypeDef

def get_value() -> ListExplainabilitiesResponseTypeDef:
    return {
        "Explainabilities": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListExplainabilitiesResponseTypeDef definition

class ListExplainabilitiesResponseTypeDef(TypedDict):
    Explainabilities: List[ExplainabilitySummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ExplainabilitySummaryTypeDef
  2. See ResponseMetadataTypeDef

CreateExplainabilityExportRequestRequestTypeDef#

# CreateExplainabilityExportRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import CreateExplainabilityExportRequestRequestTypeDef

def get_value() -> CreateExplainabilityExportRequestRequestTypeDef:
    return {
        "ExplainabilityExportName": ...,
        "ExplainabilityArn": ...,
        "Destination": ...,
    }
# CreateExplainabilityExportRequestRequestTypeDef definition

class CreateExplainabilityExportRequestRequestTypeDef(TypedDict):
    ExplainabilityExportName: str,
    ExplainabilityArn: str,
    Destination: DataDestinationTypeDef,  # (1)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
    Format: NotRequired[str],
  1. See DataDestinationTypeDef
  2. See TagTypeDef

CreateForecastExportJobRequestRequestTypeDef#

# CreateForecastExportJobRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import CreateForecastExportJobRequestRequestTypeDef

def get_value() -> CreateForecastExportJobRequestRequestTypeDef:
    return {
        "ForecastExportJobName": ...,
        "ForecastArn": ...,
        "Destination": ...,
    }
# CreateForecastExportJobRequestRequestTypeDef definition

class CreateForecastExportJobRequestRequestTypeDef(TypedDict):
    ForecastExportJobName: str,
    ForecastArn: str,
    Destination: DataDestinationTypeDef,  # (1)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
    Format: NotRequired[str],
  1. See DataDestinationTypeDef
  2. See TagTypeDef

CreatePredictorBacktestExportJobRequestRequestTypeDef#

# CreatePredictorBacktestExportJobRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import CreatePredictorBacktestExportJobRequestRequestTypeDef

def get_value() -> CreatePredictorBacktestExportJobRequestRequestTypeDef:
    return {
        "PredictorBacktestExportJobName": ...,
        "PredictorArn": ...,
        "Destination": ...,
    }
# CreatePredictorBacktestExportJobRequestRequestTypeDef definition

class CreatePredictorBacktestExportJobRequestRequestTypeDef(TypedDict):
    PredictorBacktestExportJobName: str,
    PredictorArn: str,
    Destination: DataDestinationTypeDef,  # (1)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
    Format: NotRequired[str],
  1. See DataDestinationTypeDef
  2. See TagTypeDef

CreateWhatIfForecastExportRequestRequestTypeDef#

# CreateWhatIfForecastExportRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import CreateWhatIfForecastExportRequestRequestTypeDef

def get_value() -> CreateWhatIfForecastExportRequestRequestTypeDef:
    return {
        "WhatIfForecastExportName": ...,
        "WhatIfForecastArns": ...,
        "Destination": ...,
    }
# CreateWhatIfForecastExportRequestRequestTypeDef definition

class CreateWhatIfForecastExportRequestRequestTypeDef(TypedDict):
    WhatIfForecastExportName: str,
    WhatIfForecastArns: Sequence[str],
    Destination: DataDestinationTypeDef,  # (1)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
    Format: NotRequired[str],
  1. See DataDestinationTypeDef
  2. See TagTypeDef

DescribeExplainabilityExportResponseTypeDef#

# DescribeExplainabilityExportResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import DescribeExplainabilityExportResponseTypeDef

def get_value() -> DescribeExplainabilityExportResponseTypeDef:
    return {
        "ExplainabilityExportArn": ...,
        "ExplainabilityExportName": ...,
        "ExplainabilityArn": ...,
        "Destination": ...,
        "Message": ...,
        "Status": ...,
        "CreationTime": ...,
        "LastModificationTime": ...,
        "Format": ...,
        "ResponseMetadata": ...,
    }
# DescribeExplainabilityExportResponseTypeDef definition

class DescribeExplainabilityExportResponseTypeDef(TypedDict):
    ExplainabilityExportArn: str,
    ExplainabilityExportName: str,
    ExplainabilityArn: str,
    Destination: DataDestinationTypeDef,  # (1)
    Message: str,
    Status: str,
    CreationTime: datetime,
    LastModificationTime: datetime,
    Format: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DataDestinationTypeDef
  2. See ResponseMetadataTypeDef

DescribeForecastExportJobResponseTypeDef#

# DescribeForecastExportJobResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import DescribeForecastExportJobResponseTypeDef

def get_value() -> DescribeForecastExportJobResponseTypeDef:
    return {
        "ForecastExportJobArn": ...,
        "ForecastExportJobName": ...,
        "ForecastArn": ...,
        "Destination": ...,
        "Message": ...,
        "Status": ...,
        "CreationTime": ...,
        "LastModificationTime": ...,
        "Format": ...,
        "ResponseMetadata": ...,
    }
# DescribeForecastExportJobResponseTypeDef definition

class DescribeForecastExportJobResponseTypeDef(TypedDict):
    ForecastExportJobArn: str,
    ForecastExportJobName: str,
    ForecastArn: str,
    Destination: DataDestinationTypeDef,  # (1)
    Message: str,
    Status: str,
    CreationTime: datetime,
    LastModificationTime: datetime,
    Format: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DataDestinationTypeDef
  2. See ResponseMetadataTypeDef

DescribePredictorBacktestExportJobResponseTypeDef#

# DescribePredictorBacktestExportJobResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import DescribePredictorBacktestExportJobResponseTypeDef

def get_value() -> DescribePredictorBacktestExportJobResponseTypeDef:
    return {
        "PredictorBacktestExportJobArn": ...,
        "PredictorBacktestExportJobName": ...,
        "PredictorArn": ...,
        "Destination": ...,
        "Message": ...,
        "Status": ...,
        "CreationTime": ...,
        "LastModificationTime": ...,
        "Format": ...,
        "ResponseMetadata": ...,
    }
# DescribePredictorBacktestExportJobResponseTypeDef definition

class DescribePredictorBacktestExportJobResponseTypeDef(TypedDict):
    PredictorBacktestExportJobArn: str,
    PredictorBacktestExportJobName: str,
    PredictorArn: str,
    Destination: DataDestinationTypeDef,  # (1)
    Message: str,
    Status: str,
    CreationTime: datetime,
    LastModificationTime: datetime,
    Format: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DataDestinationTypeDef
  2. See ResponseMetadataTypeDef

DescribeWhatIfForecastExportResponseTypeDef#

# DescribeWhatIfForecastExportResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import DescribeWhatIfForecastExportResponseTypeDef

def get_value() -> DescribeWhatIfForecastExportResponseTypeDef:
    return {
        "WhatIfForecastExportArn": ...,
        "WhatIfForecastExportName": ...,
        "WhatIfForecastArns": ...,
        "Destination": ...,
        "Message": ...,
        "Status": ...,
        "CreationTime": ...,
        "EstimatedTimeRemainingInMinutes": ...,
        "LastModificationTime": ...,
        "Format": ...,
        "ResponseMetadata": ...,
    }
# DescribeWhatIfForecastExportResponseTypeDef definition

class DescribeWhatIfForecastExportResponseTypeDef(TypedDict):
    WhatIfForecastExportArn: str,
    WhatIfForecastExportName: str,
    WhatIfForecastArns: List[str],
    Destination: DataDestinationTypeDef,  # (1)
    Message: str,
    Status: str,
    CreationTime: datetime,
    EstimatedTimeRemainingInMinutes: int,
    LastModificationTime: datetime,
    Format: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DataDestinationTypeDef
  2. See ResponseMetadataTypeDef

ExplainabilityExportSummaryTypeDef#

# ExplainabilityExportSummaryTypeDef usage example

from mypy_boto3_forecast.type_defs import ExplainabilityExportSummaryTypeDef

def get_value() -> ExplainabilityExportSummaryTypeDef:
    return {
        "ExplainabilityExportArn": ...,
    }
# ExplainabilityExportSummaryTypeDef definition

class ExplainabilityExportSummaryTypeDef(TypedDict):
    ExplainabilityExportArn: NotRequired[str],
    ExplainabilityExportName: NotRequired[str],
    Destination: NotRequired[DataDestinationTypeDef],  # (1)
    Status: NotRequired[str],
    Message: NotRequired[str],
    CreationTime: NotRequired[datetime],
    LastModificationTime: NotRequired[datetime],
  1. See DataDestinationTypeDef

ForecastExportJobSummaryTypeDef#

# ForecastExportJobSummaryTypeDef usage example

from mypy_boto3_forecast.type_defs import ForecastExportJobSummaryTypeDef

def get_value() -> ForecastExportJobSummaryTypeDef:
    return {
        "ForecastExportJobArn": ...,
    }
# ForecastExportJobSummaryTypeDef definition

class ForecastExportJobSummaryTypeDef(TypedDict):
    ForecastExportJobArn: NotRequired[str],
    ForecastExportJobName: NotRequired[str],
    Destination: NotRequired[DataDestinationTypeDef],  # (1)
    Status: NotRequired[str],
    Message: NotRequired[str],
    CreationTime: NotRequired[datetime],
    LastModificationTime: NotRequired[datetime],
  1. See DataDestinationTypeDef

PredictorBacktestExportJobSummaryTypeDef#

# PredictorBacktestExportJobSummaryTypeDef usage example

from mypy_boto3_forecast.type_defs import PredictorBacktestExportJobSummaryTypeDef

def get_value() -> PredictorBacktestExportJobSummaryTypeDef:
    return {
        "PredictorBacktestExportJobArn": ...,
    }
# PredictorBacktestExportJobSummaryTypeDef definition

class PredictorBacktestExportJobSummaryTypeDef(TypedDict):
    PredictorBacktestExportJobArn: NotRequired[str],
    PredictorBacktestExportJobName: NotRequired[str],
    Destination: NotRequired[DataDestinationTypeDef],  # (1)
    Status: NotRequired[str],
    Message: NotRequired[str],
    CreationTime: NotRequired[datetime],
    LastModificationTime: NotRequired[datetime],
  1. See DataDestinationTypeDef

WhatIfForecastExportSummaryTypeDef#

# WhatIfForecastExportSummaryTypeDef usage example

from mypy_boto3_forecast.type_defs import WhatIfForecastExportSummaryTypeDef

def get_value() -> WhatIfForecastExportSummaryTypeDef:
    return {
        "WhatIfForecastExportArn": ...,
    }
# WhatIfForecastExportSummaryTypeDef definition

class WhatIfForecastExportSummaryTypeDef(TypedDict):
    WhatIfForecastExportArn: NotRequired[str],
    WhatIfForecastArns: NotRequired[List[str]],
    WhatIfForecastExportName: NotRequired[str],
    Destination: NotRequired[DataDestinationTypeDef],  # (1)
    Status: NotRequired[str],
    Message: NotRequired[str],
    CreationTime: NotRequired[datetime],
    LastModificationTime: NotRequired[datetime],
  1. See DataDestinationTypeDef

CreateDatasetImportJobRequestRequestTypeDef#

# CreateDatasetImportJobRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import CreateDatasetImportJobRequestRequestTypeDef

def get_value() -> CreateDatasetImportJobRequestRequestTypeDef:
    return {
        "DatasetImportJobName": ...,
        "DatasetArn": ...,
        "DataSource": ...,
    }
# CreateDatasetImportJobRequestRequestTypeDef definition

class CreateDatasetImportJobRequestRequestTypeDef(TypedDict):
    DatasetImportJobName: str,
    DatasetArn: str,
    DataSource: DataSourceTypeDef,  # (1)
    TimestampFormat: NotRequired[str],
    TimeZone: NotRequired[str],
    UseGeolocationForTimeZone: NotRequired[bool],
    GeolocationFormat: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
    Format: NotRequired[str],
    ImportMode: NotRequired[ImportModeType],  # (3)
  1. See DataSourceTypeDef
  2. See TagTypeDef
  3. See ImportModeType

DatasetImportJobSummaryTypeDef#

# DatasetImportJobSummaryTypeDef usage example

from mypy_boto3_forecast.type_defs import DatasetImportJobSummaryTypeDef

def get_value() -> DatasetImportJobSummaryTypeDef:
    return {
        "DatasetImportJobArn": ...,
    }
# DatasetImportJobSummaryTypeDef definition

class DatasetImportJobSummaryTypeDef(TypedDict):
    DatasetImportJobArn: NotRequired[str],
    DatasetImportJobName: NotRequired[str],
    DataSource: NotRequired[DataSourceTypeDef],  # (1)
    Status: NotRequired[str],
    Message: NotRequired[str],
    CreationTime: NotRequired[datetime],
    LastModificationTime: NotRequired[datetime],
    ImportMode: NotRequired[ImportModeType],  # (2)
  1. See DataSourceTypeDef
  2. See ImportModeType

DescribeDatasetImportJobResponseTypeDef#

# DescribeDatasetImportJobResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import DescribeDatasetImportJobResponseTypeDef

def get_value() -> DescribeDatasetImportJobResponseTypeDef:
    return {
        "DatasetImportJobName": ...,
        "DatasetImportJobArn": ...,
        "DatasetArn": ...,
        "TimestampFormat": ...,
        "TimeZone": ...,
        "UseGeolocationForTimeZone": ...,
        "GeolocationFormat": ...,
        "DataSource": ...,
        "EstimatedTimeRemainingInMinutes": ...,
        "FieldStatistics": ...,
        "DataSize": ...,
        "Status": ...,
        "Message": ...,
        "CreationTime": ...,
        "LastModificationTime": ...,
        "Format": ...,
        "ImportMode": ...,
        "ResponseMetadata": ...,
    }
# DescribeDatasetImportJobResponseTypeDef definition

class DescribeDatasetImportJobResponseTypeDef(TypedDict):
    DatasetImportJobName: str,
    DatasetImportJobArn: str,
    DatasetArn: str,
    TimestampFormat: str,
    TimeZone: str,
    UseGeolocationForTimeZone: bool,
    GeolocationFormat: str,
    DataSource: DataSourceTypeDef,  # (1)
    EstimatedTimeRemainingInMinutes: int,
    FieldStatistics: Dict[str, StatisticsTypeDef],  # (2)
    DataSize: float,
    Status: str,
    Message: str,
    CreationTime: datetime,
    LastModificationTime: datetime,
    Format: str,
    ImportMode: ImportModeType,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See DataSourceTypeDef
  2. See StatisticsTypeDef
  3. See ImportModeType
  4. See ResponseMetadataTypeDef

ListPredictorsResponseTypeDef#

# ListPredictorsResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import ListPredictorsResponseTypeDef

def get_value() -> ListPredictorsResponseTypeDef:
    return {
        "Predictors": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListPredictorsResponseTypeDef definition

class ListPredictorsResponseTypeDef(TypedDict):
    Predictors: List[PredictorSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PredictorSummaryTypeDef
  2. See ResponseMetadataTypeDef

FeaturizationConfigTypeDef#

# FeaturizationConfigTypeDef usage example

from mypy_boto3_forecast.type_defs import FeaturizationConfigTypeDef

def get_value() -> FeaturizationConfigTypeDef:
    return {
        "ForecastFrequency": ...,
    }
# FeaturizationConfigTypeDef definition

class FeaturizationConfigTypeDef(TypedDict):
    ForecastFrequency: str,
    ForecastDimensions: NotRequired[Sequence[str]],
    Featurizations: NotRequired[Sequence[FeaturizationTypeDef]],  # (1)
  1. See FeaturizationTypeDef

HyperParameterTuningJobConfigTypeDef#

# HyperParameterTuningJobConfigTypeDef usage example

from mypy_boto3_forecast.type_defs import HyperParameterTuningJobConfigTypeDef

def get_value() -> HyperParameterTuningJobConfigTypeDef:
    return {
        "ParameterRanges": ...,
    }
# HyperParameterTuningJobConfigTypeDef definition

class HyperParameterTuningJobConfigTypeDef(TypedDict):
    ParameterRanges: NotRequired[ParameterRangesTypeDef],  # (1)
  1. See ParameterRangesTypeDef

WindowSummaryTypeDef#

# WindowSummaryTypeDef usage example

from mypy_boto3_forecast.type_defs import WindowSummaryTypeDef

def get_value() -> WindowSummaryTypeDef:
    return {
        "TestWindowStart": ...,
    }
# WindowSummaryTypeDef definition

class WindowSummaryTypeDef(TypedDict):
    TestWindowStart: NotRequired[datetime],
    TestWindowEnd: NotRequired[datetime],
    ItemCount: NotRequired[int],
    EvaluationType: NotRequired[EvaluationTypeType],  # (1)
    Metrics: NotRequired[MetricsTypeDef],  # (2)
  1. See EvaluationTypeType
  2. See MetricsTypeDef

ListMonitorEvaluationsResponseTypeDef#

# ListMonitorEvaluationsResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import ListMonitorEvaluationsResponseTypeDef

def get_value() -> ListMonitorEvaluationsResponseTypeDef:
    return {
        "NextToken": ...,
        "PredictorMonitorEvaluations": ...,
        "ResponseMetadata": ...,
    }
# ListMonitorEvaluationsResponseTypeDef definition

class ListMonitorEvaluationsResponseTypeDef(TypedDict):
    NextToken: str,
    PredictorMonitorEvaluations: List[PredictorMonitorEvaluationTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PredictorMonitorEvaluationTypeDef
  2. See ResponseMetadataTypeDef

PredictorExecutionDetailsTypeDef#

# PredictorExecutionDetailsTypeDef usage example

from mypy_boto3_forecast.type_defs import PredictorExecutionDetailsTypeDef

def get_value() -> PredictorExecutionDetailsTypeDef:
    return {
        "PredictorExecutions": ...,
    }
# PredictorExecutionDetailsTypeDef definition

class PredictorExecutionDetailsTypeDef(TypedDict):
    PredictorExecutions: NotRequired[List[PredictorExecutionTypeDef]],  # (1)
  1. See PredictorExecutionTypeDef

CreateDatasetRequestRequestTypeDef#

# CreateDatasetRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import CreateDatasetRequestRequestTypeDef

def get_value() -> CreateDatasetRequestRequestTypeDef:
    return {
        "DatasetName": ...,
        "Domain": ...,
        "DatasetType": ...,
        "Schema": ...,
    }
# CreateDatasetRequestRequestTypeDef definition

class CreateDatasetRequestRequestTypeDef(TypedDict):
    DatasetName: str,
    Domain: DomainType,  # (1)
    DatasetType: DatasetTypeType,  # (2)
    Schema: SchemaTypeDef,  # (3)
    DataFrequency: NotRequired[str],
    EncryptionConfig: NotRequired[EncryptionConfigTypeDef],  # (4)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (5)
  1. See DomainType
  2. See DatasetTypeType
  3. See SchemaTypeDef
  4. See EncryptionConfigTypeDef
  5. See TagTypeDef

CreateExplainabilityRequestRequestTypeDef#

# CreateExplainabilityRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import CreateExplainabilityRequestRequestTypeDef

def get_value() -> CreateExplainabilityRequestRequestTypeDef:
    return {
        "ExplainabilityName": ...,
        "ResourceArn": ...,
        "ExplainabilityConfig": ...,
    }
# CreateExplainabilityRequestRequestTypeDef definition

class CreateExplainabilityRequestRequestTypeDef(TypedDict):
    ExplainabilityName: str,
    ResourceArn: str,
    ExplainabilityConfig: ExplainabilityConfigTypeDef,  # (1)
    DataSource: NotRequired[DataSourceTypeDef],  # (2)
    Schema: NotRequired[SchemaTypeDef],  # (3)
    EnableVisualization: NotRequired[bool],
    StartDateTime: NotRequired[str],
    EndDateTime: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (4)
  1. See ExplainabilityConfigTypeDef
  2. See DataSourceTypeDef
  3. See SchemaTypeDef
  4. See TagTypeDef

DescribeDatasetResponseTypeDef#

# DescribeDatasetResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import DescribeDatasetResponseTypeDef

def get_value() -> DescribeDatasetResponseTypeDef:
    return {
        "DatasetArn": ...,
        "DatasetName": ...,
        "Domain": ...,
        "DatasetType": ...,
        "DataFrequency": ...,
        "Schema": ...,
        "EncryptionConfig": ...,
        "Status": ...,
        "CreationTime": ...,
        "LastModificationTime": ...,
        "ResponseMetadata": ...,
    }
# DescribeDatasetResponseTypeDef definition

class DescribeDatasetResponseTypeDef(TypedDict):
    DatasetArn: str,
    DatasetName: str,
    Domain: DomainType,  # (1)
    DatasetType: DatasetTypeType,  # (2)
    DataFrequency: str,
    Schema: SchemaTypeDef,  # (3)
    EncryptionConfig: EncryptionConfigTypeDef,  # (4)
    Status: str,
    CreationTime: datetime,
    LastModificationTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See DomainType
  2. See DatasetTypeType
  3. See SchemaTypeDef
  4. See EncryptionConfigTypeDef
  5. See ResponseMetadataTypeDef

DescribeExplainabilityResponseTypeDef#

# DescribeExplainabilityResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import DescribeExplainabilityResponseTypeDef

def get_value() -> DescribeExplainabilityResponseTypeDef:
    return {
        "ExplainabilityArn": ...,
        "ExplainabilityName": ...,
        "ResourceArn": ...,
        "ExplainabilityConfig": ...,
        "EnableVisualization": ...,
        "DataSource": ...,
        "Schema": ...,
        "StartDateTime": ...,
        "EndDateTime": ...,
        "EstimatedTimeRemainingInMinutes": ...,
        "Message": ...,
        "Status": ...,
        "CreationTime": ...,
        "LastModificationTime": ...,
        "ResponseMetadata": ...,
    }
# DescribeExplainabilityResponseTypeDef definition

class DescribeExplainabilityResponseTypeDef(TypedDict):
    ExplainabilityArn: str,
    ExplainabilityName: str,
    ResourceArn: str,
    ExplainabilityConfig: ExplainabilityConfigTypeDef,  # (1)
    EnableVisualization: bool,
    DataSource: DataSourceTypeDef,  # (2)
    Schema: SchemaTypeDef,  # (3)
    StartDateTime: str,
    EndDateTime: str,
    EstimatedTimeRemainingInMinutes: int,
    Message: str,
    Status: str,
    CreationTime: datetime,
    LastModificationTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See ExplainabilityConfigTypeDef
  2. See DataSourceTypeDef
  3. See SchemaTypeDef
  4. See ResponseMetadataTypeDef

TimeSeriesIdentifiersTypeDef#

# TimeSeriesIdentifiersTypeDef usage example

from mypy_boto3_forecast.type_defs import TimeSeriesIdentifiersTypeDef

def get_value() -> TimeSeriesIdentifiersTypeDef:
    return {
        "DataSource": ...,
    }
# TimeSeriesIdentifiersTypeDef definition

class TimeSeriesIdentifiersTypeDef(TypedDict):
    DataSource: NotRequired[DataSourceTypeDef],  # (1)
    Schema: NotRequired[SchemaTypeDef],  # (2)
    Format: NotRequired[str],
  1. See DataSourceTypeDef
  2. See SchemaTypeDef

TimeSeriesReplacementsDataSourceTypeDef#

# TimeSeriesReplacementsDataSourceTypeDef usage example

from mypy_boto3_forecast.type_defs import TimeSeriesReplacementsDataSourceTypeDef

def get_value() -> TimeSeriesReplacementsDataSourceTypeDef:
    return {
        "S3Config": ...,
        "Schema": ...,
    }
# TimeSeriesReplacementsDataSourceTypeDef definition

class TimeSeriesReplacementsDataSourceTypeDef(TypedDict):
    S3Config: S3ConfigTypeDef,  # (1)
    Schema: SchemaTypeDef,  # (2)
    Format: NotRequired[str],
    TimestampFormat: NotRequired[str],
  1. See S3ConfigTypeDef
  2. See SchemaTypeDef

DescribeMonitorResponseTypeDef#

# DescribeMonitorResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import DescribeMonitorResponseTypeDef

def get_value() -> DescribeMonitorResponseTypeDef:
    return {
        "MonitorName": ...,
        "MonitorArn": ...,
        "ResourceArn": ...,
        "Status": ...,
        "LastEvaluationTime": ...,
        "LastEvaluationState": ...,
        "Baseline": ...,
        "Message": ...,
        "CreationTime": ...,
        "LastModificationTime": ...,
        "EstimatedEvaluationTimeRemainingInMinutes": ...,
        "ResponseMetadata": ...,
    }
# DescribeMonitorResponseTypeDef definition

class DescribeMonitorResponseTypeDef(TypedDict):
    MonitorName: str,
    MonitorArn: str,
    ResourceArn: str,
    Status: str,
    LastEvaluationTime: datetime,
    LastEvaluationState: str,
    Baseline: BaselineTypeDef,  # (1)
    Message: str,
    CreationTime: datetime,
    LastModificationTime: datetime,
    EstimatedEvaluationTimeRemainingInMinutes: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BaselineTypeDef
  2. See ResponseMetadataTypeDef

ListExplainabilityExportsResponseTypeDef#

# ListExplainabilityExportsResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import ListExplainabilityExportsResponseTypeDef

def get_value() -> ListExplainabilityExportsResponseTypeDef:
    return {
        "ExplainabilityExports": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListExplainabilityExportsResponseTypeDef definition

class ListExplainabilityExportsResponseTypeDef(TypedDict):
    ExplainabilityExports: List[ExplainabilityExportSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ExplainabilityExportSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListForecastExportJobsResponseTypeDef#

# ListForecastExportJobsResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import ListForecastExportJobsResponseTypeDef

def get_value() -> ListForecastExportJobsResponseTypeDef:
    return {
        "ForecastExportJobs": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListForecastExportJobsResponseTypeDef definition

class ListForecastExportJobsResponseTypeDef(TypedDict):
    ForecastExportJobs: List[ForecastExportJobSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ForecastExportJobSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListPredictorBacktestExportJobsResponseTypeDef#

# ListPredictorBacktestExportJobsResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import ListPredictorBacktestExportJobsResponseTypeDef

def get_value() -> ListPredictorBacktestExportJobsResponseTypeDef:
    return {
        "PredictorBacktestExportJobs": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListPredictorBacktestExportJobsResponseTypeDef definition

class ListPredictorBacktestExportJobsResponseTypeDef(TypedDict):
    PredictorBacktestExportJobs: List[PredictorBacktestExportJobSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PredictorBacktestExportJobSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListWhatIfForecastExportsResponseTypeDef#

# ListWhatIfForecastExportsResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import ListWhatIfForecastExportsResponseTypeDef

def get_value() -> ListWhatIfForecastExportsResponseTypeDef:
    return {
        "WhatIfForecastExports": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListWhatIfForecastExportsResponseTypeDef definition

class ListWhatIfForecastExportsResponseTypeDef(TypedDict):
    WhatIfForecastExports: List[WhatIfForecastExportSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WhatIfForecastExportSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListDatasetImportJobsResponseTypeDef#

# ListDatasetImportJobsResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import ListDatasetImportJobsResponseTypeDef

def get_value() -> ListDatasetImportJobsResponseTypeDef:
    return {
        "DatasetImportJobs": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListDatasetImportJobsResponseTypeDef definition

class ListDatasetImportJobsResponseTypeDef(TypedDict):
    DatasetImportJobs: List[DatasetImportJobSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DatasetImportJobSummaryTypeDef
  2. See ResponseMetadataTypeDef

CreatePredictorRequestRequestTypeDef#

# CreatePredictorRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import CreatePredictorRequestRequestTypeDef

def get_value() -> CreatePredictorRequestRequestTypeDef:
    return {
        "PredictorName": ...,
        "ForecastHorizon": ...,
        "InputDataConfig": ...,
        "FeaturizationConfig": ...,
    }
# CreatePredictorRequestRequestTypeDef definition

class CreatePredictorRequestRequestTypeDef(TypedDict):
    PredictorName: str,
    ForecastHorizon: int,
    InputDataConfig: InputDataConfigTypeDef,  # (1)
    FeaturizationConfig: FeaturizationConfigTypeDef,  # (2)
    AlgorithmArn: NotRequired[str],
    ForecastTypes: NotRequired[Sequence[str]],
    PerformAutoML: NotRequired[bool],
    AutoMLOverrideStrategy: NotRequired[AutoMLOverrideStrategyType],  # (3)
    PerformHPO: NotRequired[bool],
    TrainingParameters: NotRequired[Mapping[str, str]],
    EvaluationParameters: NotRequired[EvaluationParametersTypeDef],  # (4)
    HPOConfig: NotRequired[HyperParameterTuningJobConfigTypeDef],  # (5)
    EncryptionConfig: NotRequired[EncryptionConfigTypeDef],  # (6)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (7)
    OptimizationMetric: NotRequired[OptimizationMetricType],  # (8)
  1. See InputDataConfigTypeDef
  2. See FeaturizationConfigTypeDef
  3. See AutoMLOverrideStrategyType
  4. See EvaluationParametersTypeDef
  5. See HyperParameterTuningJobConfigTypeDef
  6. See EncryptionConfigTypeDef
  7. See TagTypeDef
  8. See OptimizationMetricType

EvaluationResultTypeDef#

# EvaluationResultTypeDef usage example

from mypy_boto3_forecast.type_defs import EvaluationResultTypeDef

def get_value() -> EvaluationResultTypeDef:
    return {
        "AlgorithmArn": ...,
    }
# EvaluationResultTypeDef definition

class EvaluationResultTypeDef(TypedDict):
    AlgorithmArn: NotRequired[str],
    TestWindows: NotRequired[List[WindowSummaryTypeDef]],  # (1)
  1. See WindowSummaryTypeDef

DescribePredictorResponseTypeDef#

# DescribePredictorResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import DescribePredictorResponseTypeDef

def get_value() -> DescribePredictorResponseTypeDef:
    return {
        "PredictorArn": ...,
        "PredictorName": ...,
        "AlgorithmArn": ...,
        "AutoMLAlgorithmArns": ...,
        "ForecastHorizon": ...,
        "ForecastTypes": ...,
        "PerformAutoML": ...,
        "AutoMLOverrideStrategy": ...,
        "PerformHPO": ...,
        "TrainingParameters": ...,
        "EvaluationParameters": ...,
        "HPOConfig": ...,
        "InputDataConfig": ...,
        "FeaturizationConfig": ...,
        "EncryptionConfig": ...,
        "PredictorExecutionDetails": ...,
        "EstimatedTimeRemainingInMinutes": ...,
        "IsAutoPredictor": ...,
        "DatasetImportJobArns": ...,
        "Status": ...,
        "Message": ...,
        "CreationTime": ...,
        "LastModificationTime": ...,
        "OptimizationMetric": ...,
        "ResponseMetadata": ...,
    }
# DescribePredictorResponseTypeDef definition

class DescribePredictorResponseTypeDef(TypedDict):
    PredictorArn: str,
    PredictorName: str,
    AlgorithmArn: str,
    AutoMLAlgorithmArns: List[str],
    ForecastHorizon: int,
    ForecastTypes: List[str],
    PerformAutoML: bool,
    AutoMLOverrideStrategy: AutoMLOverrideStrategyType,  # (1)
    PerformHPO: bool,
    TrainingParameters: Dict[str, str],
    EvaluationParameters: EvaluationParametersTypeDef,  # (2)
    HPOConfig: HyperParameterTuningJobConfigTypeDef,  # (3)
    InputDataConfig: InputDataConfigTypeDef,  # (4)
    FeaturizationConfig: FeaturizationConfigTypeDef,  # (5)
    EncryptionConfig: EncryptionConfigTypeDef,  # (6)
    PredictorExecutionDetails: PredictorExecutionDetailsTypeDef,  # (7)
    EstimatedTimeRemainingInMinutes: int,
    IsAutoPredictor: bool,
    DatasetImportJobArns: List[str],
    Status: str,
    Message: str,
    CreationTime: datetime,
    LastModificationTime: datetime,
    OptimizationMetric: OptimizationMetricType,  # (8)
    ResponseMetadata: ResponseMetadataTypeDef,  # (9)
  1. See AutoMLOverrideStrategyType
  2. See EvaluationParametersTypeDef
  3. See HyperParameterTuningJobConfigTypeDef
  4. See InputDataConfigTypeDef
  5. See FeaturizationConfigTypeDef
  6. See EncryptionConfigTypeDef
  7. See PredictorExecutionDetailsTypeDef
  8. See OptimizationMetricType
  9. See ResponseMetadataTypeDef

TimeSeriesSelectorTypeDef#

# TimeSeriesSelectorTypeDef usage example

from mypy_boto3_forecast.type_defs import TimeSeriesSelectorTypeDef

def get_value() -> TimeSeriesSelectorTypeDef:
    return {
        "TimeSeriesIdentifiers": ...,
    }
# TimeSeriesSelectorTypeDef definition

class TimeSeriesSelectorTypeDef(TypedDict):
    TimeSeriesIdentifiers: NotRequired[TimeSeriesIdentifiersTypeDef],  # (1)
  1. See TimeSeriesIdentifiersTypeDef

CreateWhatIfForecastRequestRequestTypeDef#

# CreateWhatIfForecastRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import CreateWhatIfForecastRequestRequestTypeDef

def get_value() -> CreateWhatIfForecastRequestRequestTypeDef:
    return {
        "WhatIfForecastName": ...,
        "WhatIfAnalysisArn": ...,
    }
# CreateWhatIfForecastRequestRequestTypeDef definition

class CreateWhatIfForecastRequestRequestTypeDef(TypedDict):
    WhatIfForecastName: str,
    WhatIfAnalysisArn: str,
    TimeSeriesTransformations: NotRequired[Sequence[TimeSeriesTransformationTypeDef]],  # (1)
    TimeSeriesReplacementsDataSource: NotRequired[TimeSeriesReplacementsDataSourceTypeDef],  # (2)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (3)
  1. See TimeSeriesTransformationTypeDef
  2. See TimeSeriesReplacementsDataSourceTypeDef
  3. See TagTypeDef

DescribeWhatIfForecastResponseTypeDef#

# DescribeWhatIfForecastResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import DescribeWhatIfForecastResponseTypeDef

def get_value() -> DescribeWhatIfForecastResponseTypeDef:
    return {
        "WhatIfForecastName": ...,
        "WhatIfForecastArn": ...,
        "WhatIfAnalysisArn": ...,
        "EstimatedTimeRemainingInMinutes": ...,
        "Status": ...,
        "Message": ...,
        "CreationTime": ...,
        "LastModificationTime": ...,
        "TimeSeriesTransformations": ...,
        "TimeSeriesReplacementsDataSource": ...,
        "ForecastTypes": ...,
        "ResponseMetadata": ...,
    }
# DescribeWhatIfForecastResponseTypeDef definition

class DescribeWhatIfForecastResponseTypeDef(TypedDict):
    WhatIfForecastName: str,
    WhatIfForecastArn: str,
    WhatIfAnalysisArn: str,
    EstimatedTimeRemainingInMinutes: int,
    Status: str,
    Message: str,
    CreationTime: datetime,
    LastModificationTime: datetime,
    TimeSeriesTransformations: List[TimeSeriesTransformationTypeDef],  # (1)
    TimeSeriesReplacementsDataSource: TimeSeriesReplacementsDataSourceTypeDef,  # (2)
    ForecastTypes: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See TimeSeriesTransformationTypeDef
  2. See TimeSeriesReplacementsDataSourceTypeDef
  3. See ResponseMetadataTypeDef

GetAccuracyMetricsResponseTypeDef#

# GetAccuracyMetricsResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import GetAccuracyMetricsResponseTypeDef

def get_value() -> GetAccuracyMetricsResponseTypeDef:
    return {
        "PredictorEvaluationResults": ...,
        "IsAutoPredictor": ...,
        "AutoMLOverrideStrategy": ...,
        "OptimizationMetric": ...,
        "ResponseMetadata": ...,
    }
# GetAccuracyMetricsResponseTypeDef definition

class GetAccuracyMetricsResponseTypeDef(TypedDict):
    PredictorEvaluationResults: List[EvaluationResultTypeDef],  # (1)
    IsAutoPredictor: bool,
    AutoMLOverrideStrategy: AutoMLOverrideStrategyType,  # (2)
    OptimizationMetric: OptimizationMetricType,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See EvaluationResultTypeDef
  2. See AutoMLOverrideStrategyType
  3. See OptimizationMetricType
  4. See ResponseMetadataTypeDef

CreateForecastRequestRequestTypeDef#

# CreateForecastRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import CreateForecastRequestRequestTypeDef

def get_value() -> CreateForecastRequestRequestTypeDef:
    return {
        "ForecastName": ...,
        "PredictorArn": ...,
    }
# CreateForecastRequestRequestTypeDef definition

class CreateForecastRequestRequestTypeDef(TypedDict):
    ForecastName: str,
    PredictorArn: str,
    ForecastTypes: NotRequired[Sequence[str]],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
    TimeSeriesSelector: NotRequired[TimeSeriesSelectorTypeDef],  # (2)
  1. See TagTypeDef
  2. See TimeSeriesSelectorTypeDef

CreateWhatIfAnalysisRequestRequestTypeDef#

# CreateWhatIfAnalysisRequestRequestTypeDef usage example

from mypy_boto3_forecast.type_defs import CreateWhatIfAnalysisRequestRequestTypeDef

def get_value() -> CreateWhatIfAnalysisRequestRequestTypeDef:
    return {
        "WhatIfAnalysisName": ...,
        "ForecastArn": ...,
    }
# CreateWhatIfAnalysisRequestRequestTypeDef definition

class CreateWhatIfAnalysisRequestRequestTypeDef(TypedDict):
    WhatIfAnalysisName: str,
    ForecastArn: str,
    TimeSeriesSelector: NotRequired[TimeSeriesSelectorTypeDef],  # (1)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See TimeSeriesSelectorTypeDef
  2. See TagTypeDef

DescribeForecastResponseTypeDef#

# DescribeForecastResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import DescribeForecastResponseTypeDef

def get_value() -> DescribeForecastResponseTypeDef:
    return {
        "ForecastArn": ...,
        "ForecastName": ...,
        "ForecastTypes": ...,
        "PredictorArn": ...,
        "DatasetGroupArn": ...,
        "EstimatedTimeRemainingInMinutes": ...,
        "Status": ...,
        "Message": ...,
        "CreationTime": ...,
        "LastModificationTime": ...,
        "TimeSeriesSelector": ...,
        "ResponseMetadata": ...,
    }
# DescribeForecastResponseTypeDef definition

class DescribeForecastResponseTypeDef(TypedDict):
    ForecastArn: str,
    ForecastName: str,
    ForecastTypes: List[str],
    PredictorArn: str,
    DatasetGroupArn: str,
    EstimatedTimeRemainingInMinutes: int,
    Status: str,
    Message: str,
    CreationTime: datetime,
    LastModificationTime: datetime,
    TimeSeriesSelector: TimeSeriesSelectorTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TimeSeriesSelectorTypeDef
  2. See ResponseMetadataTypeDef

DescribeWhatIfAnalysisResponseTypeDef#

# DescribeWhatIfAnalysisResponseTypeDef usage example

from mypy_boto3_forecast.type_defs import DescribeWhatIfAnalysisResponseTypeDef

def get_value() -> DescribeWhatIfAnalysisResponseTypeDef:
    return {
        "WhatIfAnalysisName": ...,
        "WhatIfAnalysisArn": ...,
        "ForecastArn": ...,
        "EstimatedTimeRemainingInMinutes": ...,
        "Status": ...,
        "Message": ...,
        "CreationTime": ...,
        "LastModificationTime": ...,
        "TimeSeriesSelector": ...,
        "ResponseMetadata": ...,
    }
# DescribeWhatIfAnalysisResponseTypeDef definition

class DescribeWhatIfAnalysisResponseTypeDef(TypedDict):
    WhatIfAnalysisName: str,
    WhatIfAnalysisArn: str,
    ForecastArn: str,
    EstimatedTimeRemainingInMinutes: int,
    Status: str,
    Message: str,
    CreationTime: datetime,
    LastModificationTime: datetime,
    TimeSeriesSelector: TimeSeriesSelectorTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TimeSeriesSelectorTypeDef
  2. See ResponseMetadataTypeDef