Navigation Guide
You are on the package index page for the Client of a service. Return to the Client landing page

@aws-sdk/client-forecast

Description

Provides APIs for creating and managing Amazon Forecast resources.

Installation

NPM

npm install @aws-sdk/client-forecast

Yarn

yarn add @aws-sdk/client-forecast

pnpm

pnpm add @aws-sdk/client-forecast

Types

Type Name	Type
Action	Interface
AdditionalDataset	Interface
AttributeConfig	Interface
AttributeType	TypeAlias
AttributeTypeenum	Variable
AutoMLOverrideStrategy	TypeAlias
AutoMLOverrideStrategyenum	Variable
Baseline	Interface
BaselineMetric	Interface
CategoricalParameterRange	Interface
ClientDefaults	Interface
ClientInputEndpointParameters	Interface
Condition	TypeAlias
Conditionenum	Variable
ContinuousParameterRange	Interface
CreateAutoPredictorCommand	Class
CreateAutoPredictorCommandInput	Interface
CreateAutoPredictorCommandOutput	Interface
CreateAutoPredictorRequest	Interface
CreateAutoPredictorResponse	Interface
CreateDatasetCommand	Class
CreateDatasetCommandInput	Interface
CreateDatasetCommandOutput	Interface
CreateDatasetGroupCommand	Class
CreateDatasetGroupCommandInput	Interface
CreateDatasetGroupCommandOutput	Interface
CreateDatasetGroupRequest	Interface
CreateDatasetGroupResponse	Interface
CreateDatasetImportJobCommand	Class
CreateDatasetImportJobCommandInput	Interface
CreateDatasetImportJobCommandOutput	Interface
CreateDatasetImportJobRequest	Interface
CreateDatasetImportJobResponse	Interface
CreateDatasetRequest	Interface
CreateDatasetResponse	Interface
CreateExplainabilityCommand	Class
CreateExplainabilityCommandInput	Interface
CreateExplainabilityCommandOutput	Interface
CreateExplainabilityExportCommand	Class
CreateExplainabilityExportCommandInput	Interface
CreateExplainabilityExportCommandOutput	Interface
CreateExplainabilityExportRequest	Interface
CreateExplainabilityExportResponse	Interface
CreateExplainabilityRequest	Interface
CreateExplainabilityResponse	Interface
CreateForecastCommand	Class
CreateForecastCommandInput	Interface
CreateForecastCommandOutput	Interface
CreateForecastExportJobCommand	Class
CreateForecastExportJobCommandInput	Interface
CreateForecastExportJobCommandOutput	Interface
CreateForecastExportJobRequest	Interface
CreateForecastExportJobResponse	Interface
CreateForecastRequest	Interface
CreateForecastResponse	Interface
CreateMonitorCommand	Class
CreateMonitorCommandInput	Interface
CreateMonitorCommandOutput	Interface
CreateMonitorRequest	Interface
CreateMonitorResponse	Interface
CreatePredictorBacktestExportJobCommand	Class
CreatePredictorBacktestExportJobCommandInput	Interface
CreatePredictorBacktestExportJobCommandOutput	Interface
CreatePredictorBacktestExportJobRequest	Interface
CreatePredictorBacktestExportJobResponse	Interface
CreatePredictorCommand	Class
CreatePredictorCommandInput	Interface
CreatePredictorCommandOutput	Interface
CreatePredictorRequest	Interface
CreatePredictorResponse	Interface
CreateWhatIfAnalysisCommand	Class
CreateWhatIfAnalysisCommandInput	Interface
CreateWhatIfAnalysisCommandOutput	Interface
CreateWhatIfAnalysisRequest	Interface
CreateWhatIfAnalysisResponse	Interface
CreateWhatIfForecastCommand	Class
CreateWhatIfForecastCommandInput	Interface
CreateWhatIfForecastCommandOutput	Interface
CreateWhatIfForecastExportCommand	Class
CreateWhatIfForecastExportCommandInput	Interface
CreateWhatIfForecastExportCommandOutput	Interface
CreateWhatIfForecastExportRequest	Interface
CreateWhatIfForecastExportResponse	Interface
CreateWhatIfForecastRequest	Interface
CreateWhatIfForecastResponse	Interface
DataConfig	Interface
DataDestination	Interface
DatasetGroupSummary	Interface
DatasetImportJobSummary	Interface
DatasetSummary	Interface
DatasetType	TypeAlias
DatasetTypeenum	Variable
DataSource	Interface
DayOfWeek	TypeAlias
DayOfWeekenum	Variable
DeleteDatasetCommand	Class
DeleteDatasetCommandInput	Interface
DeleteDatasetCommandOutput	Interface
DeleteDatasetGroupCommand	Class
DeleteDatasetGroupCommandInput	Interface
DeleteDatasetGroupCommandOutput	Interface
DeleteDatasetGroupRequest	Interface
DeleteDatasetImportJobCommand	Class
DeleteDatasetImportJobCommandInput	Interface
DeleteDatasetImportJobCommandOutput	Interface
DeleteDatasetImportJobRequest	Interface
DeleteDatasetRequest	Interface
DeleteExplainabilityCommand	Class
DeleteExplainabilityCommandInput	Interface
DeleteExplainabilityCommandOutput	Interface
DeleteExplainabilityExportCommand	Class
DeleteExplainabilityExportCommandInput	Interface
DeleteExplainabilityExportCommandOutput	Interface
DeleteExplainabilityExportRequest	Interface
DeleteExplainabilityRequest	Interface
DeleteForecastCommand	Class
DeleteForecastCommandInput	Interface
DeleteForecastCommandOutput	Interface
DeleteForecastExportJobCommand	Class
DeleteForecastExportJobCommandInput	Interface
DeleteForecastExportJobCommandOutput	Interface
DeleteForecastExportJobRequest	Interface
DeleteForecastRequest	Interface
DeleteMonitorCommand	Class
DeleteMonitorCommandInput	Interface
DeleteMonitorCommandOutput	Interface
DeleteMonitorRequest	Interface
DeletePredictorBacktestExportJobCommand	Class
DeletePredictorBacktestExportJobCommandInput	Interface
DeletePredictorBacktestExportJobCommandOutput	Interface
DeletePredictorBacktestExportJobRequest	Interface
DeletePredictorCommand	Class
DeletePredictorCommandInput	Interface
DeletePredictorCommandOutput	Interface
DeletePredictorRequest	Interface
DeleteResourceTreeCommand	Class
DeleteResourceTreeCommandInput	Interface
DeleteResourceTreeCommandOutput	Interface
DeleteResourceTreeRequest	Interface
DeleteWhatIfAnalysisCommand	Class
DeleteWhatIfAnalysisCommandInput	Interface
DeleteWhatIfAnalysisCommandOutput	Interface
DeleteWhatIfAnalysisRequest	Interface
DeleteWhatIfForecastCommand	Class
DeleteWhatIfForecastCommandInput	Interface
DeleteWhatIfForecastCommandOutput	Interface
DeleteWhatIfForecastExportCommand	Class
DeleteWhatIfForecastExportCommandInput	Interface
DeleteWhatIfForecastExportCommandOutput	Interface
DeleteWhatIfForecastExportRequest	Interface
DeleteWhatIfForecastRequest	Interface
DescribeAutoPredictorCommand	Class
DescribeAutoPredictorCommandInput	Interface
DescribeAutoPredictorCommandOutput	Interface
DescribeAutoPredictorRequest	Interface
DescribeAutoPredictorResponse	Interface
DescribeDatasetCommand	Class
DescribeDatasetCommandInput	Interface
DescribeDatasetCommandOutput	Interface
DescribeDatasetGroupCommand	Class
DescribeDatasetGroupCommandInput	Interface
DescribeDatasetGroupCommandOutput	Interface
DescribeDatasetGroupRequest	Interface
DescribeDatasetGroupResponse	Interface
DescribeDatasetImportJobCommand	Class
DescribeDatasetImportJobCommandInput	Interface
DescribeDatasetImportJobCommandOutput	Interface
DescribeDatasetImportJobRequest	Interface
DescribeDatasetImportJobResponse	Interface
DescribeDatasetRequest	Interface
DescribeDatasetResponse	Interface
DescribeExplainabilityCommand	Class
DescribeExplainabilityCommandInput	Interface
DescribeExplainabilityCommandOutput	Interface
DescribeExplainabilityExportCommand	Class
DescribeExplainabilityExportCommandInput	Interface
DescribeExplainabilityExportCommandOutput	Interface
DescribeExplainabilityExportRequest	Interface
DescribeExplainabilityExportResponse	Interface
DescribeExplainabilityRequest	Interface
DescribeExplainabilityResponse	Interface
DescribeForecastCommand	Class
DescribeForecastCommandInput	Interface
DescribeForecastCommandOutput	Interface
DescribeForecastExportJobCommand	Class
DescribeForecastExportJobCommandInput	Interface
DescribeForecastExportJobCommandOutput	Interface
DescribeForecastExportJobRequest	Interface
DescribeForecastExportJobResponse	Interface
DescribeForecastRequest	Interface
DescribeForecastResponse	Interface
DescribeMonitorCommand	Class
DescribeMonitorCommandInput	Interface
DescribeMonitorCommandOutput	Interface
DescribeMonitorRequest	Interface
DescribeMonitorResponse	Interface
DescribePredictorBacktestExportJobCommand	Class
DescribePredictorBacktestExportJobCommandInput	Interface
DescribePredictorBacktestExportJobCommandOutput	Interface
DescribePredictorBacktestExportJobRequest	Interface
DescribePredictorBacktestExportJobResponse	Interface
DescribePredictorCommand	Class
DescribePredictorCommandInput	Interface
DescribePredictorCommandOutput	Interface
DescribePredictorRequest	Interface
DescribePredictorResponse	Interface
DescribeWhatIfAnalysisCommand	Class
DescribeWhatIfAnalysisCommandInput	Interface
DescribeWhatIfAnalysisCommandOutput	Interface
DescribeWhatIfAnalysisRequest	Interface
DescribeWhatIfAnalysisResponse	Interface
DescribeWhatIfForecastCommand	Class
DescribeWhatIfForecastCommandInput	Interface
DescribeWhatIfForecastCommandOutput	Interface
DescribeWhatIfForecastExportCommand	Class
DescribeWhatIfForecastExportCommandInput	Interface
DescribeWhatIfForecastExportCommandOutput	Interface
DescribeWhatIfForecastExportRequest	Interface
DescribeWhatIfForecastExportResponse	Interface
DescribeWhatIfForecastRequest	Interface
DescribeWhatIfForecastResponse	Interface
Domain	TypeAlias
Domainenum	Variable
EncryptionConfig	Interface
ErrorMetric	Interface
EvaluationParameters	Interface
EvaluationResult	Interface
EvaluationType	TypeAlias
EvaluationTypeenum	Variable
ExplainabilityConfig	Interface
ExplainabilityExportSummary	Interface
ExplainabilityInfo	Interface
ExplainabilitySummary	Interface
Featurization	Interface
FeaturizationConfig	Interface
FeaturizationMethod	Interface
FeaturizationMethodName	TypeAlias
FeaturizationMethodNameenum	Variable
Filter	Interface
FilterConditionString	TypeAlias
FilterConditionStringenum	Variable
Forecast	Class
Forecast	Interface
ForecastClient	Class
ForecastClientConfig	Interface
ForecastClientConfigType	TypeAlias
ForecastClientResolvedConfig	Interface
ForecastClientResolvedConfigType	TypeAlias
ForecastExportJobSummary	Interface
ForecastPaginationConfiguration	Interface
ForecastServiceException	Class
ForecastSummary	Interface
GetAccuracyMetricsCommand	Class
GetAccuracyMetricsCommandInput	Interface
GetAccuracyMetricsCommandOutput	Interface
GetAccuracyMetricsRequest	Interface
GetAccuracyMetricsResponse	Interface
HyperParameterTuningJobConfig	Interface
ImportMode	TypeAlias
ImportModeenum	Variable
InputDataConfig	Interface
IntegerParameterRange	Interface
InvalidInputException	Class
InvalidNextTokenException	Class
LimitExceededException	Class
ListDatasetGroupsCommand	Class
ListDatasetGroupsCommandInput	Interface
ListDatasetGroupsCommandOutput	Interface
ListDatasetGroupsRequest	Interface
ListDatasetGroupsResponse	Interface
ListDatasetImportJobsCommand	Class
ListDatasetImportJobsCommandInput	Interface
ListDatasetImportJobsCommandOutput	Interface
ListDatasetImportJobsRequest	Interface
ListDatasetImportJobsResponse	Interface
ListDatasetsCommand	Class
ListDatasetsCommandInput	Interface
ListDatasetsCommandOutput	Interface
ListDatasetsRequest	Interface
ListDatasetsResponse	Interface
ListExplainabilitiesCommand	Class
ListExplainabilitiesCommandInput	Interface
ListExplainabilitiesCommandOutput	Interface
ListExplainabilitiesRequest	Interface
ListExplainabilitiesResponse	Interface
ListExplainabilityExportsCommand	Class
ListExplainabilityExportsCommandInput	Interface
ListExplainabilityExportsCommandOutput	Interface
ListExplainabilityExportsRequest	Interface
ListExplainabilityExportsResponse	Interface
ListForecastExportJobsCommand	Class
ListForecastExportJobsCommandInput	Interface
ListForecastExportJobsCommandOutput	Interface
ListForecastExportJobsRequest	Interface
ListForecastExportJobsResponse	Interface
ListForecastsCommand	Class
ListForecastsCommandInput	Interface
ListForecastsCommandOutput	Interface
ListForecastsRequest	Interface
ListForecastsResponse	Interface
ListMonitorEvaluationsCommand	Class
ListMonitorEvaluationsCommandInput	Interface
ListMonitorEvaluationsCommandOutput	Interface
ListMonitorEvaluationsRequest	Interface
ListMonitorEvaluationsResponse	Interface
ListMonitorsCommand	Class
ListMonitorsCommandInput	Interface
ListMonitorsCommandOutput	Interface
ListMonitorsRequest	Interface
ListMonitorsResponse	Interface
ListPredictorBacktestExportJobsCommand	Class
ListPredictorBacktestExportJobsCommandInput	Interface
ListPredictorBacktestExportJobsCommandOutput	Interface
ListPredictorBacktestExportJobsRequest	Interface
ListPredictorBacktestExportJobsResponse	Interface
ListPredictorsCommand	Class
ListPredictorsCommandInput	Interface
ListPredictorsCommandOutput	Interface
ListPredictorsRequest	Interface
ListPredictorsResponse	Interface
ListTagsForResourceCommand	Class
ListTagsForResourceCommandInput	Interface
ListTagsForResourceCommandOutput	Interface
ListTagsForResourceRequest	Interface
ListTagsForResourceResponse	Interface
ListWhatIfAnalysesCommand	Class
ListWhatIfAnalysesCommandInput	Interface
ListWhatIfAnalysesCommandOutput	Interface
ListWhatIfAnalysesRequest	Interface
ListWhatIfAnalysesResponse	Interface
ListWhatIfForecastExportsCommand	Class
ListWhatIfForecastExportsCommandInput	Interface
ListWhatIfForecastExportsCommandOutput	Interface
ListWhatIfForecastExportsRequest	Interface
ListWhatIfForecastExportsResponse	Interface
ListWhatIfForecastsCommand	Class
ListWhatIfForecastsCommandInput	Interface
ListWhatIfForecastsCommandOutput	Interface
ListWhatIfForecastsRequest	Interface
ListWhatIfForecastsResponse	Interface
MetricResult	Interface
Metrics	Interface
MonitorConfig	Interface
MonitorDataSource	Interface
MonitorInfo	Interface
MonitorSummary	Interface
Month	TypeAlias
Monthenum	Variable
Operation	TypeAlias
Operationenum	Variable
OptimizationMetric	TypeAlias
OptimizationMetricenum	Variable
paginateListDatasetGroups	Variable
paginateListDatasetImportJobs	Variable
paginateListDatasets	Variable
paginateListExplainabilities	Variable
paginateListExplainabilityExports	Variable
paginateListForecastExportJobs	Variable
paginateListForecasts	Variable
paginateListMonitorEvaluations	Variable
paginateListMonitors	Variable
paginateListPredictorBacktestExportJobs	Variable
paginateListPredictors	Variable
paginateListWhatIfAnalyses	Variable
paginateListWhatIfForecastExports	Variable
paginateListWhatIfForecasts	Variable
ParameterRanges	Interface
PredictorBacktestExportJobSummary	Interface
PredictorBaseline	Interface
PredictorEvent	Interface
PredictorExecution	Interface
PredictorExecutionDetails	Interface
PredictorMonitorEvaluation	Interface
PredictorSummary	Interface
ReferencePredictorSummary	Interface
ResourceAlreadyExistsException	Class
ResourceInUseException	Class
ResourceNotFoundException	Class
ResumeResourceCommand	Class
ResumeResourceCommandInput	Interface
ResumeResourceCommandOutput	Interface
ResumeResourceRequest	Interface
RuntimeExtension	Interface
S3Config	Interface
ScalingType	TypeAlias
ScalingTypeenum	Variable
Schema	Interface
SchemaAttribute	Interface
ServiceInputTypes	TypeAlias
ServiceOutputTypes	TypeAlias
State	TypeAlias
Stateenum	Variable
Statistics	Interface
StopResourceCommand	Class
StopResourceCommandInput	Interface
StopResourceCommandOutput	Interface
StopResourceRequest	Interface
SupplementaryFeature	Interface
Tag	Interface
TagResourceCommand	Class
TagResourceCommandInput	Interface
TagResourceCommandOutput	Interface
TagResourceRequest	Interface
TagResourceResponse	Interface
TestWindowSummary	Interface
TimeAlignmentBoundary	Interface
TimePointGranularity	TypeAlias
TimePointGranularityenum	Variable
TimeSeriesCondition	Interface
TimeSeriesGranularity	TypeAlias
TimeSeriesGranularityenum	Variable
TimeSeriesIdentifiers	Interface
TimeSeriesReplacementsDataSource	Interface
TimeSeriesSelector	Interface
TimeSeriesTransformation	Interface
UntagResourceCommand	Class
UntagResourceCommandInput	Interface
UntagResourceCommandOutput	Interface
UntagResourceRequest	Interface
UntagResourceResponse	Interface
UpdateDatasetGroupCommand	Class
UpdateDatasetGroupCommandInput	Interface
UpdateDatasetGroupCommandOutput	Interface
UpdateDatasetGroupRequest	Interface
UpdateDatasetGroupResponse	Interface
WeightedQuantileLoss	Interface
WhatIfAnalysisSummary	Interface
WhatIfForecastExportSummary	Interface
WhatIfForecastSummary	Interface
WindowSummary	Interface

Getting Started

References

@aws-sdk/client-forecast

Description

Installation

Types