Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://aws-api.deno.dev/v0.3/services/forecastservice.ts?docs=full";

§Classes

ForecastService

§Interfaces

AdditionalDataset

Describes an additional dataset. This object is part of the "DataConfig" object. Forecast supports the Weather Index and Holidays additional datasets.

AttributeConfig

Provides information about the method used to transform attributes.

CategoricalParameterRange

Specifies a categorical hyperparameter and it's range of tunable values. This object is part of the "ParameterRanges" object.

ContinuousParameterRange

Specifies a continuous hyperparameter and it's range of tunable values. This object is part of the "ParameterRanges" object.

CreateAutoPredictorRequest
CreateAutoPredictorResponse
CreateDatasetGroupRequest
CreateDatasetGroupResponse
CreateDatasetImportJobRequest
CreateDatasetImportJobResponse
CreateDatasetRequest
CreateDatasetResponse
CreateExplainabilityExportRequest
CreateExplainabilityExportResponse
CreateExplainabilityRequest
CreateExplainabilityResponse
CreateForecastExportJobRequest
CreateForecastExportJobResponse
CreateForecastRequest
CreateForecastResponse
CreatePredictorBacktestExportJobRequest
CreatePredictorBacktestExportJobResponse
CreatePredictorRequest
CreatePredictorResponse
DataConfig

The data configuration for your dataset group and any additional datasets.

DataDestination

The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an AWS Key Management Service (KMS) key (optional).

DatasetGroupSummary

Provides a summary of the dataset group properties used in the "ListDatasetGroups" operation. To get the complete set of properties, call the "DescribeDatasetGroup" operation, and provide the DatasetGroupArn.

DatasetImportJobSummary

Provides a summary of the dataset import job properties used in the "ListDatasetImportJobs" operation. To get the complete set of properties, call the "DescribeDatasetImportJob" operation, and provide the DatasetImportJobArn.

DatasetSummary

Provides a summary of the dataset properties used in the "ListDatasets" operation. To get the complete set of properties, call the "DescribeDataset" operation, and provide the DatasetArn.

DataSource

The source of your data, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to access the data and, optionally, an AWS Key Management Service (KMS) key.

DeleteDatasetGroupRequest
DeleteDatasetImportJobRequest
DeleteDatasetRequest
DeleteExplainabilityExportRequest
DeleteExplainabilityRequest
DeleteForecastExportJobRequest
DeleteForecastRequest
DeletePredictorBacktestExportJobRequest
DeletePredictorRequest
DeleteResourceTreeRequest
DescribeAutoPredictorRequest
DescribeAutoPredictorResponse
DescribeDatasetGroupRequest
DescribeDatasetGroupResponse
DescribeDatasetImportJobRequest
DescribeDatasetImportJobResponse
DescribeDatasetRequest
DescribeDatasetResponse
DescribeExplainabilityExportRequest
DescribeExplainabilityExportResponse
DescribeExplainabilityRequest
DescribeExplainabilityResponse
DescribeForecastExportJobRequest
DescribeForecastExportJobResponse
DescribeForecastRequest
DescribeForecastResponse
DescribePredictorBacktestExportJobRequest
DescribePredictorBacktestExportJobResponse
DescribePredictorRequest
DescribePredictorResponse
EncryptionConfig

An AWS Key Management Service (KMS) key and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key. You can specify this optional object in the "CreateDataset" and "CreatePredictor" requests.

ErrorMetric

Provides detailed error metrics to evaluate the performance of a predictor. This object is part of the "Metrics" object.

EvaluationParameters

Parameters that define how to split a dataset into training data and testing data, and the number of iterations to perform. These parameters are specified in the predefined algorithms but you can override them in the "CreatePredictor" request.

EvaluationResult

The results of evaluating an algorithm. Returned as part of the "GetAccuracyMetrics" response.

ExplainabilityConfig

The ExplainabilityConfig data type defines the number of time series and time points included in "CreateExplainability".

ExplainabilityExportSummary

Provides a summary of the Explainability export properties used in the "ListExplainabilityExports" operation. To get a complete set of properties, call the "DescribeExplainabilityExport" operation, and provide the ExplainabilityExportArn.

ExplainabilityInfo

Provides information about the Explainability resource.

ExplainabilitySummary

Provides a summary of the Explainability properties used in the "ListExplainabilities" operation. To get a complete set of properties, call the "DescribeExplainability" operation, and provide the listed ExplainabilityArn.

Featurization

Note: This object belongs to the "CreatePredictor" operation. If you created your predictor with "CreateAutoPredictor", see "AttributeConfig".

FeaturizationConfig

Note: This object belongs to the "CreatePredictor" operation. If you created your predictor with "CreateAutoPredictor", see "AttributeConfig".

FeaturizationMethod

Provides information about the method that featurizes (transforms) a dataset field. The method is part of the FeaturizationPipeline of the "Featurization" object.

Filter

Describes a filter for choosing a subset of objects. Each filter consists of a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the objects that match the statement, respectively. The match statement consists of a key and a value.

ForecastExportJobSummary

Provides a summary of the forecast export job properties used in the "ListForecastExportJobs" operation. To get the complete set of properties, call the "DescribeForecastExportJob" operation, and provide the listed ForecastExportJobArn.

ForecastSummary

Provides a summary of the forecast properties used in the "ListForecasts" operation. To get the complete set of properties, call the "DescribeForecast" operation, and provide the ForecastArn that is listed in the summary.

GetAccuracyMetricsRequest
GetAccuracyMetricsResponse
HyperParameterTuningJobConfig

Configuration information for a hyperparameter tuning job. You specify this object in the "CreatePredictor" request.

InputDataConfig

Note: This object belongs to the "CreatePredictor" operation. If you created your predictor with "CreateAutoPredictor", see "DataConfig".

IntegerParameterRange

Specifies an integer hyperparameter and it's range of tunable values. This object is part of the "ParameterRanges" object.

ListDatasetGroupsRequest
ListDatasetGroupsResponse
ListDatasetImportJobsRequest
ListDatasetImportJobsResponse
ListDatasetsRequest
ListDatasetsResponse
ListExplainabilitiesRequest
ListExplainabilitiesResponse
ListExplainabilityExportsRequest
ListExplainabilityExportsResponse
ListForecastExportJobsRequest
ListForecastExportJobsResponse
ListForecastsRequest
ListForecastsResponse
ListPredictorBacktestExportJobsRequest
ListPredictorBacktestExportJobsResponse
ListPredictorsRequest
ListPredictorsResponse
ListTagsForResourceRequest
ListTagsForResourceResponse
Metrics

Provides metrics that are used to evaluate the performance of a predictor. This object is part of the "WindowSummary" object.

ParameterRanges

Specifies the categorical, continuous, and integer hyperparameters, and their ranges of tunable values. The range of tunable values determines which values that a hyperparameter tuning job can choose for the specified hyperparameter. This object is part of the "HyperParameterTuningJobConfig" object.

PredictorBacktestExportJobSummary

Provides a summary of the predictor backtest export job properties used in the "ListPredictorBacktestExportJobs" operation. To get a complete set of properties, call the "DescribePredictorBacktestExportJob" operation, and provide the listed PredictorBacktestExportJobArn.

PredictorExecution

The algorithm used to perform a backtest and the status of those tests.

PredictorExecutionDetails

Contains details on the backtests performed to evaluate the accuracy of the predictor. The tests are returned in descending order of accuracy, with the most accurate backtest appearing first. You specify the number of backtests to perform when you call the operation.

PredictorSummary

Provides a summary of the predictor properties that are used in the "ListPredictors" operation. To get the complete set of properties, call the "DescribePredictor" operation, and provide the listed PredictorArn.

ReferencePredictorSummary

Provides a summary of the reference predictor used when retraining or upgrading a predictor.

S3Config

The path to the file(s) in an Amazon Simple Storage Service (Amazon S3) bucket, and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the file(s). Optionally, includes an AWS Key Management Service (KMS) key. This object is part of the "DataSource" object that is submitted in the "CreateDatasetImportJob" request, and part of the "DataDestination" object.

Schema

Defines the fields of a dataset.

SchemaAttribute

An attribute of a schema, which defines a dataset field. A schema attribute is required for every field in a dataset. The "Schema" object contains an array of SchemaAttribute objects.

Statistics

Provides statistics for each data field imported into to an Amazon Forecast dataset with the "CreateDatasetImportJob" operation.

StopResourceRequest
SupplementaryFeature

Note: This object belongs to the "CreatePredictor" operation. If you created your predictor with "CreateAutoPredictor", see "AdditionalDataset".

Tag

The optional metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

TagResourceRequest
TestWindowSummary

The status, start time, and end time of a backtest, as well as a failure reason if applicable.

UntagResourceRequest
UpdateDatasetGroupRequest
WeightedQuantileLoss

The weighted loss value for a quantile. This object is part of the "Metrics" object.

WindowSummary

The metrics for a time range within the evaluation portion of a dataset. This object is part of the "EvaluationResult" object.

§Type Aliases

AttributeType
AutoMLOverrideStrategy
DatasetType
Domain
EvaluationType
FeaturizationMethodName
FilterConditionString
OptimizationMetric
ScalingType
State
TimePointGranularity
TimeSeriesGranularity