ForecastService class

Provides APIs for creating and managing Amazon Forecast resources.

Constructors

ForecastService({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
createDataset({required String datasetName, required DatasetType datasetType, required Domain domain, required Schema schema, String? dataFrequency, EncryptionConfig? encryptionConfig, List<Tag>? tags}) → Future<CreateDatasetResponse>
Creates an Amazon Forecast dataset. The information about the dataset that you provide helps Forecast understand how to consume the data for model training. This includes the following:
createDatasetGroup({required String datasetGroupName, required Domain domain, List<String>? datasetArns, List<Tag>? tags}) → Future<CreateDatasetGroupResponse>
Creates a dataset group, which holds a collection of related datasets. You can add datasets to the dataset group when you create the dataset group, or later by using the UpdateDatasetGroup operation.
createDatasetImportJob({required DataSource dataSource, required String datasetArn, required String datasetImportJobName, String? geolocationFormat, List<Tag>? tags, String? timeZone, String? timestampFormat, bool? useGeolocationForTimeZone}) → Future<CreateDatasetImportJobResponse>
Imports your training data to an Amazon Forecast dataset. You provide the location of your training data in an Amazon Simple Storage Service (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset that you want to import the data to.
createForecast({required String forecastName, required String predictorArn, List<String>? forecastTypes, List<Tag>? tags}) → Future<CreateForecastResponse>
Creates a forecast for each item in the TARGET_TIME_SERIES dataset that was used to train the predictor. This is known as inference. To retrieve the forecast for a single item at low latency, use the operation. To export the complete forecast into your Amazon Simple Storage Service (Amazon S3) bucket, use the CreateForecastExportJob operation.
createForecastExportJob({required DataDestination destination, required String forecastArn, required String forecastExportJobName, List<Tag>? tags}) → Future<CreateForecastExportJobResponse>
Exports a forecast created by the CreateForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions:
createPredictor({required FeaturizationConfig featurizationConfig, required int forecastHorizon, required InputDataConfig inputDataConfig, required String predictorName, String? algorithmArn, EncryptionConfig? encryptionConfig, EvaluationParameters? evaluationParameters, List<String>? forecastTypes, HyperParameterTuningJobConfig? hPOConfig, bool? performAutoML, bool? performHPO, List<Tag>? tags, Map<String, String>? trainingParameters}) → Future<CreatePredictorResponse>
Creates an Amazon Forecast predictor.
createPredictorBacktestExportJob({required DataDestination destination, required String predictorArn, required String predictorBacktestExportJobName, List<Tag>? tags}) → Future<CreatePredictorBacktestExportJobResponse>
Exports backtest forecasts and accuracy metrics generated by the CreatePredictor operation. Two folders containing CSV files are exported to your specified S3 bucket.
deleteDataset({required String datasetArn}) → Future<void>
Deletes an Amazon Forecast dataset that was created using the CreateDataset operation. You can only delete datasets that have a status of ACTIVE or CREATE_FAILED. To get the status use the DescribeDataset operation.
deleteDatasetGroup({required String datasetGroupArn}) → Future<void>
Deletes a dataset group created using the CreateDatasetGroup operation. You can only delete dataset groups that have a status of ACTIVE, CREATE_FAILED, or UPDATE_FAILED. To get the status, use the DescribeDatasetGroup operation.
deleteDatasetImportJob({required String datasetImportJobArn}) → Future<void>
Deletes a dataset import job created using the CreateDatasetImportJob operation. You can delete only dataset import jobs that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeDatasetImportJob operation.
deleteForecast({required String forecastArn}) → Future<void>
Deletes a forecast created using the CreateForecast operation. You can delete only forecasts that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeForecast operation.
deleteForecastExportJob({required String forecastExportJobArn}) → Future<void>
Deletes a forecast export job created using the CreateForecastExportJob operation. You can delete only export jobs that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeForecastExportJob operation.
deletePredictor({required String predictorArn}) → Future<void>
Deletes a predictor created using the CreatePredictor operation. You can delete only predictor that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribePredictor operation.
deletePredictorBacktestExportJob({required String predictorBacktestExportJobArn}) → Future<void>
Deletes a predictor backtest export job.
describeDataset({required String datasetArn}) → Future<DescribeDatasetResponse>
Describes an Amazon Forecast dataset created using the CreateDataset operation.
describeDatasetGroup({required String datasetGroupArn}) → Future<DescribeDatasetGroupResponse>
Describes a dataset group created using the CreateDatasetGroup operation.
describeDatasetImportJob({required String datasetImportJobArn}) → Future<DescribeDatasetImportJobResponse>
Describes a dataset import job created using the CreateDatasetImportJob operation.
describeForecast({required String forecastArn}) → Future<DescribeForecastResponse>
Describes a forecast created using the CreateForecast operation.
describeForecastExportJob({required String forecastExportJobArn}) → Future<DescribeForecastExportJobResponse>
Describes a forecast export job created using the CreateForecastExportJob operation.
describePredictor({required String predictorArn}) → Future<DescribePredictorResponse>
Describes a predictor created using the CreatePredictor operation.
describePredictorBacktestExportJob({required String predictorBacktestExportJobArn}) → Future<DescribePredictorBacktestExportJobResponse>
Describes a predictor backtest export job created using the CreatePredictorBacktestExportJob operation.
getAccuracyMetrics({required String predictorArn}) → Future<GetAccuracyMetricsResponse>
Provides metrics on the accuracy of the models that were trained by the CreatePredictor operation. Use metrics to see how well the model performed and to decide whether to use the predictor to generate a forecast. For more information, see Predictor Metrics.
listDatasetGroups({int? maxResults, String? nextToken}) → Future<ListDatasetGroupsResponse>
Returns a list of dataset groups created using the CreateDatasetGroup operation. For each dataset group, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the dataset group ARN with the DescribeDatasetGroup operation.
listDatasetImportJobs({List<Filter>? filters, int? maxResults, String? nextToken}) → Future<ListDatasetImportJobsResponse>
Returns a list of dataset import jobs created using the CreateDatasetImportJob operation. For each import job, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the ARN with the DescribeDatasetImportJob operation. You can filter the list by providing an array of Filter objects.
listDatasets({int? maxResults, String? nextToken}) → Future<ListDatasetsResponse>
Returns a list of datasets created using the CreateDataset operation. For each dataset, a summary of its properties, including its Amazon Resource Name (ARN), is returned. To retrieve the complete set of properties, use the ARN with the DescribeDataset operation.
listForecastExportJobs({List<Filter>? filters, int? maxResults, String? nextToken}) → Future<ListForecastExportJobsResponse>
Returns a list of forecast export jobs created using the CreateForecastExportJob operation. For each forecast export job, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, use the ARN with the DescribeForecastExportJob operation. You can filter the list using an array of Filter objects.
listForecasts({List<Filter>? filters, int? maxResults, String? nextToken}) → Future<ListForecastsResponse>
Returns a list of forecasts created using the CreateForecast operation. For each forecast, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, specify the ARN with the DescribeForecast operation. You can filter the list using an array of Filter objects.
listPredictorBacktestExportJobs({List<Filter>? filters, int? maxResults, String? nextToken}) → Future<ListPredictorBacktestExportJobsResponse>
Returns a list of predictor backtest export jobs created using the CreatePredictorBacktestExportJob operation. This operation returns a summary for each backtest export job. You can filter the list using an array of Filter objects.
listPredictors({List<Filter>? filters, int? maxResults, String? nextToken}) → Future<ListPredictorsResponse>
Returns a list of predictors created using the CreatePredictor operation. For each predictor, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the ARN with the DescribePredictor operation. You can filter the list using an array of Filter objects.
listTagsForResource({required String resourceArn}) → Future<ListTagsForResourceResponse>
Lists the tags for an Amazon Forecast resource.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
tagResource({required String resourceArn, required List<Tag> tags}) → Future<void>
Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are also deleted.
toString() → String
A string representation of this object.
inherited
untagResource({required String resourceArn, required List<String> tagKeys}) → Future<void>
Deletes the specified tags from a resource.
updateDatasetGroup({required List<String> datasetArns, required String datasetGroupArn}) → Future<void>
Replaces the datasets in a dataset group with the specified datasets.

Operators

operator ==(Object other) → bool
The equality operator.
inherited