Typed dictionaries
Index > ForecastService > Typed dictionaries
Auto-generated documentation for ForecastService type annotations stubs module mypy-boto3-forecast.
ActionTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import ActionTypeDef
def get_value() -> ActionTypeDef:
return {
"AttributeName": ...,
"Operation": ...,
"Value": ...,
}
Definition
class ActionTypeDef(TypedDict):
AttributeName: str,
Operation: OperationType, # (1)
Value: float,
- See OperationType
AdditionalDatasetTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import AdditionalDatasetTypeDef
def get_value() -> AdditionalDatasetTypeDef:
return {
"Name": ...,
}
Definition
class AdditionalDatasetTypeDef(TypedDict):
Name: str,
Configuration: NotRequired[Mapping[str, Sequence[str]]],
AttributeConfigTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import AttributeConfigTypeDef
def get_value() -> AttributeConfigTypeDef:
return {
"AttributeName": ...,
"Transformations": ...,
}
Definition
class AttributeConfigTypeDef(TypedDict):
AttributeName: str,
Transformations: Mapping[str, str],
BaselineMetricTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import BaselineMetricTypeDef
def get_value() -> BaselineMetricTypeDef:
return {
"Name": ...,
}
Definition
class BaselineMetricTypeDef(TypedDict):
Name: NotRequired[str],
Value: NotRequired[float],
CategoricalParameterRangeTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import CategoricalParameterRangeTypeDef
def get_value() -> CategoricalParameterRangeTypeDef:
return {
"Name": ...,
"Values": ...,
}
ContinuousParameterRangeTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import ContinuousParameterRangeTypeDef
def get_value() -> ContinuousParameterRangeTypeDef:
return {
"Name": ...,
"MaxValue": ...,
"MinValue": ...,
}
Definition
class ContinuousParameterRangeTypeDef(TypedDict):
Name: str,
MaxValue: float,
MinValue: float,
ScalingType: NotRequired[ScalingTypeType], # (1)
- See ScalingTypeType
EncryptionConfigTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import EncryptionConfigTypeDef
def get_value() -> EncryptionConfigTypeDef:
return {
"RoleArn": ...,
"KMSKeyArn": ...,
}
MonitorConfigTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import MonitorConfigTypeDef
def get_value() -> MonitorConfigTypeDef:
return {
"MonitorName": ...,
}
TagTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
"Value": ...,
}
TimeAlignmentBoundaryTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import TimeAlignmentBoundaryTypeDef
def get_value() -> TimeAlignmentBoundaryTypeDef:
return {
"Month": ...,
}
Definition
class TimeAlignmentBoundaryTypeDef(TypedDict):
Month: NotRequired[MonthType], # (1)
DayOfMonth: NotRequired[int],
DayOfWeek: NotRequired[DayOfWeekType], # (2)
Hour: NotRequired[int],
- See MonthType
- See DayOfWeekType
ResponseMetadataTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
Definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
ExplainabilityConfigTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import ExplainabilityConfigTypeDef
def get_value() -> ExplainabilityConfigTypeDef:
return {
"TimeSeriesGranularity": ...,
"TimePointGranularity": ...,
}
Definition
class ExplainabilityConfigTypeDef(TypedDict):
TimeSeriesGranularity: TimeSeriesGranularityType, # (1)
TimePointGranularity: TimePointGranularityType, # (2)
EvaluationParametersTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import EvaluationParametersTypeDef
def get_value() -> EvaluationParametersTypeDef:
return {
"NumberOfBacktestWindows": ...,
}
Definition
class EvaluationParametersTypeDef(TypedDict):
NumberOfBacktestWindows: NotRequired[int],
BackTestWindowOffset: NotRequired[int],
S3ConfigTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import S3ConfigTypeDef
def get_value() -> S3ConfigTypeDef:
return {
"Path": ...,
"RoleArn": ...,
}
DatasetGroupSummaryTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import DatasetGroupSummaryTypeDef
def get_value() -> DatasetGroupSummaryTypeDef:
return {
"DatasetGroupArn": ...,
}
Definition
class DatasetGroupSummaryTypeDef(TypedDict):
DatasetGroupArn: NotRequired[str],
DatasetGroupName: NotRequired[str],
CreationTime: NotRequired[datetime],
LastModificationTime: NotRequired[datetime],
DatasetSummaryTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import DatasetSummaryTypeDef
def get_value() -> DatasetSummaryTypeDef:
return {
"DatasetArn": ...,
}
Definition
class DatasetSummaryTypeDef(TypedDict):
DatasetArn: NotRequired[str],
DatasetName: NotRequired[str],
DatasetType: NotRequired[DatasetTypeType], # (1)
Domain: NotRequired[DomainType], # (2)
CreationTime: NotRequired[datetime],
LastModificationTime: NotRequired[datetime],
- See DatasetTypeType
- See DomainType
DeleteDatasetGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import DeleteDatasetGroupRequestRequestTypeDef
def get_value() -> DeleteDatasetGroupRequestRequestTypeDef:
return {
"DatasetGroupArn": ...,
}
DeleteDatasetImportJobRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import DeleteDatasetImportJobRequestRequestTypeDef
def get_value() -> DeleteDatasetImportJobRequestRequestTypeDef:
return {
"DatasetImportJobArn": ...,
}
DeleteDatasetRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import DeleteDatasetRequestRequestTypeDef
def get_value() -> DeleteDatasetRequestRequestTypeDef:
return {
"DatasetArn": ...,
}
DeleteExplainabilityExportRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import DeleteExplainabilityExportRequestRequestTypeDef
def get_value() -> DeleteExplainabilityExportRequestRequestTypeDef:
return {
"ExplainabilityExportArn": ...,
}
Definition
class DeleteExplainabilityExportRequestRequestTypeDef(TypedDict):
ExplainabilityExportArn: str,
DeleteExplainabilityRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import DeleteExplainabilityRequestRequestTypeDef
def get_value() -> DeleteExplainabilityRequestRequestTypeDef:
return {
"ExplainabilityArn": ...,
}
DeleteForecastExportJobRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import DeleteForecastExportJobRequestRequestTypeDef
def get_value() -> DeleteForecastExportJobRequestRequestTypeDef:
return {
"ForecastExportJobArn": ...,
}
DeleteForecastRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import DeleteForecastRequestRequestTypeDef
def get_value() -> DeleteForecastRequestRequestTypeDef:
return {
"ForecastArn": ...,
}
DeleteMonitorRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import DeleteMonitorRequestRequestTypeDef
def get_value() -> DeleteMonitorRequestRequestTypeDef:
return {
"MonitorArn": ...,
}
DeletePredictorBacktestExportJobRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import DeletePredictorBacktestExportJobRequestRequestTypeDef
def get_value() -> DeletePredictorBacktestExportJobRequestRequestTypeDef:
return {
"PredictorBacktestExportJobArn": ...,
}
Definition
class DeletePredictorBacktestExportJobRequestRequestTypeDef(TypedDict):
PredictorBacktestExportJobArn: str,
DeletePredictorRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import DeletePredictorRequestRequestTypeDef
def get_value() -> DeletePredictorRequestRequestTypeDef:
return {
"PredictorArn": ...,
}
DeleteResourceTreeRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import DeleteResourceTreeRequestRequestTypeDef
def get_value() -> DeleteResourceTreeRequestRequestTypeDef:
return {
"ResourceArn": ...,
}
DeleteWhatIfAnalysisRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import DeleteWhatIfAnalysisRequestRequestTypeDef
def get_value() -> DeleteWhatIfAnalysisRequestRequestTypeDef:
return {
"WhatIfAnalysisArn": ...,
}
DeleteWhatIfForecastExportRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import DeleteWhatIfForecastExportRequestRequestTypeDef
def get_value() -> DeleteWhatIfForecastExportRequestRequestTypeDef:
return {
"WhatIfForecastExportArn": ...,
}
Definition
class DeleteWhatIfForecastExportRequestRequestTypeDef(TypedDict):
WhatIfForecastExportArn: str,
DeleteWhatIfForecastRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import DeleteWhatIfForecastRequestRequestTypeDef
def get_value() -> DeleteWhatIfForecastRequestRequestTypeDef:
return {
"WhatIfForecastArn": ...,
}
DescribeAutoPredictorRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import DescribeAutoPredictorRequestRequestTypeDef
def get_value() -> DescribeAutoPredictorRequestRequestTypeDef:
return {
"PredictorArn": ...,
}
ExplainabilityInfoTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import ExplainabilityInfoTypeDef
def get_value() -> ExplainabilityInfoTypeDef:
return {
"ExplainabilityArn": ...,
}
Definition
class ExplainabilityInfoTypeDef(TypedDict):
ExplainabilityArn: NotRequired[str],
Status: NotRequired[str],
MonitorInfoTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import MonitorInfoTypeDef
def get_value() -> MonitorInfoTypeDef:
return {
"MonitorArn": ...,
}
Definition
class MonitorInfoTypeDef(TypedDict):
MonitorArn: NotRequired[str],
Status: NotRequired[str],
ReferencePredictorSummaryTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import ReferencePredictorSummaryTypeDef
def get_value() -> ReferencePredictorSummaryTypeDef:
return {
"Arn": ...,
}
Definition
class ReferencePredictorSummaryTypeDef(TypedDict):
Arn: NotRequired[str],
State: NotRequired[StateType], # (1)
- See StateType
DescribeDatasetGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import DescribeDatasetGroupRequestRequestTypeDef
def get_value() -> DescribeDatasetGroupRequestRequestTypeDef:
return {
"DatasetGroupArn": ...,
}
DescribeDatasetImportJobRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import DescribeDatasetImportJobRequestRequestTypeDef
def get_value() -> DescribeDatasetImportJobRequestRequestTypeDef:
return {
"DatasetImportJobArn": ...,
}
StatisticsTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import StatisticsTypeDef
def get_value() -> StatisticsTypeDef:
return {
"Count": ...,
}
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
Usage Example
from mypy_boto3_forecast.type_defs import DescribeDatasetRequestRequestTypeDef
def get_value() -> DescribeDatasetRequestRequestTypeDef:
return {
"DatasetArn": ...,
}
DescribeExplainabilityExportRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import DescribeExplainabilityExportRequestRequestTypeDef
def get_value() -> DescribeExplainabilityExportRequestRequestTypeDef:
return {
"ExplainabilityExportArn": ...,
}
Definition
class DescribeExplainabilityExportRequestRequestTypeDef(TypedDict):
ExplainabilityExportArn: str,
DescribeExplainabilityRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import DescribeExplainabilityRequestRequestTypeDef
def get_value() -> DescribeExplainabilityRequestRequestTypeDef:
return {
"ExplainabilityArn": ...,
}
DescribeForecastExportJobRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import DescribeForecastExportJobRequestRequestTypeDef
def get_value() -> DescribeForecastExportJobRequestRequestTypeDef:
return {
"ForecastExportJobArn": ...,
}
Definition
class DescribeForecastExportJobRequestRequestTypeDef(TypedDict):
ForecastExportJobArn: str,
DescribeForecastRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import DescribeForecastRequestRequestTypeDef
def get_value() -> DescribeForecastRequestRequestTypeDef:
return {
"ForecastArn": ...,
}
DescribeMonitorRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import DescribeMonitorRequestRequestTypeDef
def get_value() -> DescribeMonitorRequestRequestTypeDef:
return {
"MonitorArn": ...,
}
DescribePredictorBacktestExportJobRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import DescribePredictorBacktestExportJobRequestRequestTypeDef
def get_value() -> DescribePredictorBacktestExportJobRequestRequestTypeDef:
return {
"PredictorBacktestExportJobArn": ...,
}
Definition
class DescribePredictorBacktestExportJobRequestRequestTypeDef(TypedDict):
PredictorBacktestExportJobArn: str,
DescribePredictorRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import DescribePredictorRequestRequestTypeDef
def get_value() -> DescribePredictorRequestRequestTypeDef:
return {
"PredictorArn": ...,
}
DescribeWhatIfAnalysisRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import DescribeWhatIfAnalysisRequestRequestTypeDef
def get_value() -> DescribeWhatIfAnalysisRequestRequestTypeDef:
return {
"WhatIfAnalysisArn": ...,
}
DescribeWhatIfForecastExportRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import DescribeWhatIfForecastExportRequestRequestTypeDef
def get_value() -> DescribeWhatIfForecastExportRequestRequestTypeDef:
return {
"WhatIfForecastExportArn": ...,
}
Definition
class DescribeWhatIfForecastExportRequestRequestTypeDef(TypedDict):
WhatIfForecastExportArn: str,
DescribeWhatIfForecastRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import DescribeWhatIfForecastRequestRequestTypeDef
def get_value() -> DescribeWhatIfForecastRequestRequestTypeDef:
return {
"WhatIfForecastArn": ...,
}
ErrorMetricTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import ErrorMetricTypeDef
def get_value() -> ErrorMetricTypeDef:
return {
"ForecastType": ...,
}
Definition
class ErrorMetricTypeDef(TypedDict):
ForecastType: NotRequired[str],
WAPE: NotRequired[float],
RMSE: NotRequired[float],
MASE: NotRequired[float],
MAPE: NotRequired[float],
FeaturizationMethodTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import FeaturizationMethodTypeDef
def get_value() -> FeaturizationMethodTypeDef:
return {
"FeaturizationMethodName": ...,
}
Definition
class FeaturizationMethodTypeDef(TypedDict):
FeaturizationMethodName: FeaturizationMethodNameType, # (1)
FeaturizationMethodParameters: NotRequired[Mapping[str, str]],
FilterTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import FilterTypeDef
def get_value() -> FilterTypeDef:
return {
"Key": ...,
"Value": ...,
"Condition": ...,
}
Definition
class FilterTypeDef(TypedDict):
Key: str,
Value: str,
Condition: FilterConditionStringType, # (1)
ForecastSummaryTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import ForecastSummaryTypeDef
def get_value() -> ForecastSummaryTypeDef:
return {
"ForecastArn": ...,
}
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
Usage Example
from mypy_boto3_forecast.type_defs import GetAccuracyMetricsRequestRequestTypeDef
def get_value() -> GetAccuracyMetricsRequestRequestTypeDef:
return {
"PredictorArn": ...,
}
SupplementaryFeatureTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import SupplementaryFeatureTypeDef
def get_value() -> SupplementaryFeatureTypeDef:
return {
"Name": ...,
"Value": ...,
}
IntegerParameterRangeTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import IntegerParameterRangeTypeDef
def get_value() -> IntegerParameterRangeTypeDef:
return {
"Name": ...,
"MaxValue": ...,
"MinValue": ...,
}
Definition
class IntegerParameterRangeTypeDef(TypedDict):
Name: str,
MaxValue: int,
MinValue: int,
ScalingType: NotRequired[ScalingTypeType], # (1)
- See ScalingTypeType
PaginatorConfigTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
Definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListDatasetGroupsRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import ListDatasetGroupsRequestRequestTypeDef
def get_value() -> ListDatasetGroupsRequestRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListDatasetGroupsRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListDatasetsRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import ListDatasetsRequestRequestTypeDef
def get_value() -> ListDatasetsRequestRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListDatasetsRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
MonitorSummaryTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import MonitorSummaryTypeDef
def get_value() -> MonitorSummaryTypeDef:
return {
"MonitorArn": ...,
}
Definition
class MonitorSummaryTypeDef(TypedDict):
MonitorArn: NotRequired[str],
MonitorName: NotRequired[str],
ResourceArn: NotRequired[str],
Status: NotRequired[str],
CreationTime: NotRequired[datetime],
LastModificationTime: NotRequired[datetime],
ListTagsForResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"ResourceArn": ...,
}
WhatIfAnalysisSummaryTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import WhatIfAnalysisSummaryTypeDef
def get_value() -> WhatIfAnalysisSummaryTypeDef:
return {
"WhatIfAnalysisArn": ...,
}
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
Usage Example
from mypy_boto3_forecast.type_defs import WhatIfForecastSummaryTypeDef
def get_value() -> WhatIfForecastSummaryTypeDef:
return {
"WhatIfForecastArn": ...,
}
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
Usage Example
from mypy_boto3_forecast.type_defs import MetricResultTypeDef
def get_value() -> MetricResultTypeDef:
return {
"MetricName": ...,
}
Definition
class MetricResultTypeDef(TypedDict):
MetricName: NotRequired[str],
MetricValue: NotRequired[float],
WeightedQuantileLossTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import WeightedQuantileLossTypeDef
def get_value() -> WeightedQuantileLossTypeDef:
return {
"Quantile": ...,
}
Definition
class WeightedQuantileLossTypeDef(TypedDict):
Quantile: NotRequired[float],
LossValue: NotRequired[float],
MonitorDataSourceTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import MonitorDataSourceTypeDef
def get_value() -> MonitorDataSourceTypeDef:
return {
"DatasetImportJobArn": ...,
}
Definition
class MonitorDataSourceTypeDef(TypedDict):
DatasetImportJobArn: NotRequired[str],
ForecastArn: NotRequired[str],
PredictorArn: NotRequired[str],
PredictorEventTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import PredictorEventTypeDef
def get_value() -> PredictorEventTypeDef:
return {
"Detail": ...,
}
Definition
class PredictorEventTypeDef(TypedDict):
Detail: NotRequired[str],
Datetime: NotRequired[datetime],
TestWindowSummaryTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import TestWindowSummaryTypeDef
def get_value() -> TestWindowSummaryTypeDef:
return {
"TestWindowStart": ...,
}
Definition
class TestWindowSummaryTypeDef(TypedDict):
TestWindowStart: NotRequired[datetime],
TestWindowEnd: NotRequired[datetime],
Status: NotRequired[str],
Message: NotRequired[str],
ResumeResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import ResumeResourceRequestRequestTypeDef
def get_value() -> ResumeResourceRequestRequestTypeDef:
return {
"ResourceArn": ...,
}
SchemaAttributeTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import SchemaAttributeTypeDef
def get_value() -> SchemaAttributeTypeDef:
return {
"AttributeName": ...,
}
Definition
class SchemaAttributeTypeDef(TypedDict):
AttributeName: NotRequired[str],
AttributeType: NotRequired[AttributeTypeType], # (1)
StopResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import StopResourceRequestRequestTypeDef
def get_value() -> StopResourceRequestRequestTypeDef:
return {
"ResourceArn": ...,
}
TimeSeriesConditionTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import TimeSeriesConditionTypeDef
def get_value() -> TimeSeriesConditionTypeDef:
return {
"AttributeName": ...,
"AttributeValue": ...,
"Condition": ...,
}
Definition
class TimeSeriesConditionTypeDef(TypedDict):
AttributeName: str,
AttributeValue: str,
Condition: ConditionType, # (1)
- See ConditionType
UntagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"ResourceArn": ...,
"TagKeys": ...,
}
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,
TagKeys: Sequence[str],
UpdateDatasetGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import UpdateDatasetGroupRequestRequestTypeDef
def get_value() -> UpdateDatasetGroupRequestRequestTypeDef:
return {
"DatasetGroupArn": ...,
"DatasetArns": ...,
}
Definition
class UpdateDatasetGroupRequestRequestTypeDef(TypedDict):
DatasetGroupArn: str,
DatasetArns: Sequence[str],
DataConfigTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import DataConfigTypeDef
def get_value() -> DataConfigTypeDef:
return {
"DatasetGroupArn": ...,
}
Definition
class DataConfigTypeDef(TypedDict):
DatasetGroupArn: str,
AttributeConfigs: NotRequired[Sequence[AttributeConfigTypeDef]], # (1)
AdditionalDatasets: NotRequired[Sequence[AdditionalDatasetTypeDef]], # (2)
PredictorBaselineTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import PredictorBaselineTypeDef
def get_value() -> PredictorBaselineTypeDef:
return {
"BaselineMetrics": ...,
}
Definition
class PredictorBaselineTypeDef(TypedDict):
BaselineMetrics: NotRequired[List[BaselineMetricTypeDef]], # (1)
CreateDatasetGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import CreateDatasetGroupRequestRequestTypeDef
def get_value() -> CreateDatasetGroupRequestRequestTypeDef:
return {
"DatasetGroupName": ...,
"Domain": ...,
}
Definition
class CreateDatasetGroupRequestRequestTypeDef(TypedDict):
DatasetGroupName: str,
Domain: DomainType, # (1)
DatasetArns: NotRequired[Sequence[str]],
Tags: NotRequired[Sequence[TagTypeDef]], # (2)
- See DomainType
- See TagTypeDef
CreateMonitorRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import CreateMonitorRequestRequestTypeDef
def get_value() -> CreateMonitorRequestRequestTypeDef:
return {
"MonitorName": ...,
"ResourceArn": ...,
}
Definition
class CreateMonitorRequestRequestTypeDef(TypedDict):
MonitorName: str,
ResourceArn: str,
Tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
TagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import TagResourceRequestRequestTypeDef
def get_value() -> TagResourceRequestRequestTypeDef:
return {
"ResourceArn": ...,
"Tags": ...,
}
Definition
class TagResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,
Tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
CreateAutoPredictorResponseTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import CreateAutoPredictorResponseTypeDef
def get_value() -> CreateAutoPredictorResponseTypeDef:
return {
"PredictorArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateAutoPredictorResponseTypeDef(TypedDict):
PredictorArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateDatasetGroupResponseTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import CreateDatasetGroupResponseTypeDef
def get_value() -> CreateDatasetGroupResponseTypeDef:
return {
"DatasetGroupArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateDatasetGroupResponseTypeDef(TypedDict):
DatasetGroupArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateDatasetImportJobResponseTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import CreateDatasetImportJobResponseTypeDef
def get_value() -> CreateDatasetImportJobResponseTypeDef:
return {
"DatasetImportJobArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateDatasetImportJobResponseTypeDef(TypedDict):
DatasetImportJobArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateDatasetResponseTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import CreateDatasetResponseTypeDef
def get_value() -> CreateDatasetResponseTypeDef:
return {
"DatasetArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateDatasetResponseTypeDef(TypedDict):
DatasetArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateExplainabilityExportResponseTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import CreateExplainabilityExportResponseTypeDef
def get_value() -> CreateExplainabilityExportResponseTypeDef:
return {
"ExplainabilityExportArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateExplainabilityExportResponseTypeDef(TypedDict):
ExplainabilityExportArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateExplainabilityResponseTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import CreateExplainabilityResponseTypeDef
def get_value() -> CreateExplainabilityResponseTypeDef:
return {
"ExplainabilityArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateExplainabilityResponseTypeDef(TypedDict):
ExplainabilityArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateForecastExportJobResponseTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import CreateForecastExportJobResponseTypeDef
def get_value() -> CreateForecastExportJobResponseTypeDef:
return {
"ForecastExportJobArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateForecastExportJobResponseTypeDef(TypedDict):
ForecastExportJobArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateForecastResponseTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import CreateForecastResponseTypeDef
def get_value() -> CreateForecastResponseTypeDef:
return {
"ForecastArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateForecastResponseTypeDef(TypedDict):
ForecastArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateMonitorResponseTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import CreateMonitorResponseTypeDef
def get_value() -> CreateMonitorResponseTypeDef:
return {
"MonitorArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateMonitorResponseTypeDef(TypedDict):
MonitorArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreatePredictorBacktestExportJobResponseTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import CreatePredictorBacktestExportJobResponseTypeDef
def get_value() -> CreatePredictorBacktestExportJobResponseTypeDef:
return {
"PredictorBacktestExportJobArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreatePredictorBacktestExportJobResponseTypeDef(TypedDict):
PredictorBacktestExportJobArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreatePredictorResponseTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import CreatePredictorResponseTypeDef
def get_value() -> CreatePredictorResponseTypeDef:
return {
"PredictorArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreatePredictorResponseTypeDef(TypedDict):
PredictorArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateWhatIfAnalysisResponseTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import CreateWhatIfAnalysisResponseTypeDef
def get_value() -> CreateWhatIfAnalysisResponseTypeDef:
return {
"WhatIfAnalysisArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateWhatIfAnalysisResponseTypeDef(TypedDict):
WhatIfAnalysisArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateWhatIfForecastExportResponseTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import CreateWhatIfForecastExportResponseTypeDef
def get_value() -> CreateWhatIfForecastExportResponseTypeDef:
return {
"WhatIfForecastExportArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateWhatIfForecastExportResponseTypeDef(TypedDict):
WhatIfForecastExportArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateWhatIfForecastResponseTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import CreateWhatIfForecastResponseTypeDef
def get_value() -> CreateWhatIfForecastResponseTypeDef:
return {
"WhatIfForecastArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateWhatIfForecastResponseTypeDef(TypedDict):
WhatIfForecastArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeDatasetGroupResponseTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import DescribeDatasetGroupResponseTypeDef
def get_value() -> DescribeDatasetGroupResponseTypeDef:
return {
"DatasetGroupName": ...,
"DatasetGroupArn": ...,
"DatasetArns": ...,
"Domain": ...,
"Status": ...,
"CreationTime": ...,
"LastModificationTime": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeDatasetGroupResponseTypeDef(TypedDict):
DatasetGroupName: str,
DatasetGroupArn: str,
DatasetArns: List[str],
Domain: DomainType, # (1)
Status: str,
CreationTime: datetime,
LastModificationTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See DomainType
- See ResponseMetadataTypeDef
EmptyResponseMetadataTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import EmptyResponseMetadataTypeDef
def get_value() -> EmptyResponseMetadataTypeDef:
return {
"ResponseMetadata": ...,
}
Definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListTagsForResourceResponseTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"Tags": ...,
"ResponseMetadata": ...,
}
Definition
class ListTagsForResourceResponseTypeDef(TypedDict):
Tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
ExplainabilitySummaryTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import ExplainabilitySummaryTypeDef
def get_value() -> ExplainabilitySummaryTypeDef:
return {
"ExplainabilityArn": ...,
}
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],
DataDestinationTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import DataDestinationTypeDef
def get_value() -> DataDestinationTypeDef:
return {
"S3Config": ...,
}
- See S3ConfigTypeDef
DataSourceTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import DataSourceTypeDef
def get_value() -> DataSourceTypeDef:
return {
"S3Config": ...,
}
- See S3ConfigTypeDef
ListDatasetGroupsResponseTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import ListDatasetGroupsResponseTypeDef
def get_value() -> ListDatasetGroupsResponseTypeDef:
return {
"DatasetGroups": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListDatasetGroupsResponseTypeDef(TypedDict):
DatasetGroups: List[DatasetGroupSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListDatasetsResponseTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import ListDatasetsResponseTypeDef
def get_value() -> ListDatasetsResponseTypeDef:
return {
"Datasets": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListDatasetsResponseTypeDef(TypedDict):
Datasets: List[DatasetSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PredictorSummaryTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import PredictorSummaryTypeDef
def get_value() -> PredictorSummaryTypeDef:
return {
"PredictorArn": ...,
}
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],
FeaturizationTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import FeaturizationTypeDef
def get_value() -> FeaturizationTypeDef:
return {
"AttributeName": ...,
}
Definition
class FeaturizationTypeDef(TypedDict):
AttributeName: str,
FeaturizationPipeline: NotRequired[Sequence[FeaturizationMethodTypeDef]], # (1)
ListDatasetImportJobsRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import ListDatasetImportJobsRequestRequestTypeDef
def get_value() -> ListDatasetImportJobsRequestRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListDatasetImportJobsRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
- See FilterTypeDef
ListExplainabilitiesRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import ListExplainabilitiesRequestRequestTypeDef
def get_value() -> ListExplainabilitiesRequestRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListExplainabilitiesRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
- See FilterTypeDef
ListExplainabilityExportsRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import ListExplainabilityExportsRequestRequestTypeDef
def get_value() -> ListExplainabilityExportsRequestRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListExplainabilityExportsRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
- See FilterTypeDef
ListForecastExportJobsRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import ListForecastExportJobsRequestRequestTypeDef
def get_value() -> ListForecastExportJobsRequestRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListForecastExportJobsRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
- See FilterTypeDef
ListForecastsRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import ListForecastsRequestRequestTypeDef
def get_value() -> ListForecastsRequestRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListForecastsRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
- See FilterTypeDef
ListMonitorEvaluationsRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import ListMonitorEvaluationsRequestRequestTypeDef
def get_value() -> ListMonitorEvaluationsRequestRequestTypeDef:
return {
"MonitorArn": ...,
}
Definition
class ListMonitorEvaluationsRequestRequestTypeDef(TypedDict):
MonitorArn: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
- See FilterTypeDef
ListMonitorsRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import ListMonitorsRequestRequestTypeDef
def get_value() -> ListMonitorsRequestRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListMonitorsRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
- See FilterTypeDef
ListPredictorBacktestExportJobsRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import ListPredictorBacktestExportJobsRequestRequestTypeDef
def get_value() -> ListPredictorBacktestExportJobsRequestRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListPredictorBacktestExportJobsRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
- See FilterTypeDef
ListPredictorsRequestRequestTypeDef
Usage Example
from mypy_boto3_forecast.type_defs import ListPredictorsRequestRequestTypeDef
def get_value() -> ListPredictorsRequestRequestTypeDef:
return {
"NextToken": ...,
}
Defi