com.amazonaws.services.forecast.AmazonForecast Maven / Gradle / Ivy
Show all versions of aws-java-sdk-forecast Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.forecast;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.forecast.model.*;
/**
* Interface for accessing Amazon Forecast Service.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.forecast.AbstractAmazonForecast} instead.
*
*
*
* Provides APIs for creating and managing Amazon Forecast resources.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonForecast {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "forecast";
/**
*
* Creates an Amazon Forecast predictor.
*
*
* Amazon Forecast creates predictors with AutoPredictor, which involves applying the optimal combination of
* algorithms to each time series in your datasets. You can use CreateAutoPredictor to create new predictors
* or upgrade/retrain existing predictors.
*
*
* Creating new predictors
*
*
* The following parameters are required when creating a new predictor:
*
*
* -
*
* PredictorName - A unique name for the predictor.
*
*
* -
*
* DatasetGroupArn - The ARN of the dataset group used to train the predictor.
*
*
* -
*
* ForecastFrequency - The granularity of your forecasts (hourly, daily, weekly, etc).
*
*
* -
*
* ForecastHorizon - The number of time-steps that the model predicts. The forecast horizon is also
* called the prediction length.
*
*
*
*
* When creating a new predictor, do not specify a value for ReferencePredictorArn.
*
*
* Upgrading and retraining predictors
*
*
* The following parameters are required when retraining or upgrading a predictor:
*
*
* -
*
* PredictorName - A unique name for the predictor.
*
*
* -
*
* ReferencePredictorArn - The ARN of the predictor to retrain or upgrade.
*
*
*
*
* When upgrading or retraining a predictor, only specify values for the ReferencePredictorArn and
* PredictorName.
*
*
* @param createAutoPredictorRequest
* @return Result of the CreateAutoPredictor operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceAlreadyExistsException
* There is already a resource with this name. Try again with a different name.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @throws ResourceInUseException
* The specified resource is in use.
* @throws LimitExceededException
* The limit on the number of resources per account has been exceeded.
* @sample AmazonForecast.CreateAutoPredictor
* @see AWS
* API Documentation
*/
CreateAutoPredictorResult createAutoPredictor(CreateAutoPredictorRequest createAutoPredictorRequest);
/**
*
* 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:
*
*
* -
*
* DataFrequency - How frequently your historical time-series data is collected.
*
*
* -
*
* Domain and DatasetType - Each dataset has an associated dataset
* domain and a type within the domain. Amazon Forecast provides a list of predefined domains and types within each
* domain. For each unique dataset domain and type within the domain, Amazon Forecast requires your data to include
* a minimum set of predefined fields.
*
*
* -
*
* Schema - A schema specifies the fields in the dataset, including the field name and data
* type.
*
*
*
*
* After creating a dataset, you import your training data into it and add the dataset to a dataset group. You use
* the dataset group to create a predictor. For more information, see Importing datasets.
*
*
* To get a list of all your datasets, use the ListDatasets operation.
*
*
* For example Forecast datasets, see the Amazon
* Forecast Sample GitHub repository.
*
*
*
* The Status of a dataset must be ACTIVE before you can import training data. Use the DescribeDataset operation to
* get the status.
*
*
*
* @param createDatasetRequest
* @return Result of the CreateDataset operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceAlreadyExistsException
* There is already a resource with this name. Try again with a different name.
* @throws LimitExceededException
* The limit on the number of resources per account has been exceeded.
* @sample AmazonForecast.CreateDataset
* @see AWS API
* Documentation
*/
CreateDatasetResult createDataset(CreateDatasetRequest createDatasetRequest);
/**
*
* 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.
*
*
* After creating a dataset group and adding datasets, you use the dataset group when you create a predictor. For
* more information, see Dataset groups.
*
*
* To get a list of all your datasets groups, use the ListDatasetGroups operation.
*
*
*
* The Status of a dataset group must be ACTIVE before you can use the dataset group to
* create a predictor. To get the status, use the DescribeDatasetGroup
* operation.
*
*
*
* @param createDatasetGroupRequest
* @return Result of the CreateDatasetGroup operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceAlreadyExistsException
* There is already a resource with this name. Try again with a different name.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @throws ResourceInUseException
* The specified resource is in use.
* @throws LimitExceededException
* The limit on the number of resources per account has been exceeded.
* @sample AmazonForecast.CreateDatasetGroup
* @see AWS
* API Documentation
*/
CreateDatasetGroupResult createDatasetGroup(CreateDatasetGroupRequest createDatasetGroupRequest);
/**
*
* 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.
*
*
* You must specify a DataSource
* object that includes an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the
* data, as Amazon Forecast makes a copy of your data and processes it in an internal Amazon Web Services system.
* For more information, see Set up permissions.
*
*
* The training data must be in CSV or Parquet format. The delimiter must be a comma (,).
*
*
* You can specify the path to a specific file, the S3 bucket, or to a folder in the S3 bucket. For the latter two
* cases, Amazon Forecast imports all files up to the limit of 10,000 files.
*
*
* Because dataset imports are not aggregated, your most recent dataset import is the one that is used when training
* a predictor or generating a forecast. Make sure that your most recent dataset import contains all of the data you
* want to model off of, and not just the new data collected since the previous import.
*
*
* To get a list of all your dataset import jobs, filtered by specified criteria, use the ListDatasetImportJobs
* operation.
*
*
* @param createDatasetImportJobRequest
* @return Result of the CreateDatasetImportJob operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceAlreadyExistsException
* There is already a resource with this name. Try again with a different name.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @throws ResourceInUseException
* The specified resource is in use.
* @throws LimitExceededException
* The limit on the number of resources per account has been exceeded.
* @sample AmazonForecast.CreateDatasetImportJob
* @see AWS API Documentation
*/
CreateDatasetImportJobResult createDatasetImportJob(CreateDatasetImportJobRequest createDatasetImportJobRequest);
/**
*
*
* Explainability is only available for Forecasts and Predictors generated from an AutoPredictor
* (CreateAutoPredictor)
*
*
*
* Creates an Amazon Forecast Explainability.
*
*
* Explainability helps you better understand how the attributes in your datasets impact forecast. Amazon Forecast
* uses a metric called Impact scores to quantify the relative impact of each attribute and determine whether they
* increase or decrease forecast values.
*
*
* To enable Forecast Explainability, your predictor must include at least one of the following: related time
* series, item metadata, or additional datasets like Holidays and the Weather Index.
*
*
* CreateExplainability accepts either a Predictor ARN or Forecast ARN. To receive aggregated Impact scores for all
* time series and time points in your datasets, provide a Predictor ARN. To receive Impact scores for specific time
* series and time points, provide a Forecast ARN.
*
*
* CreateExplainability with a Predictor ARN
*
*
*
* You can only have one Explainability resource per predictor. If you already enabled ExplainPredictor
* in CreateAutoPredictor, that predictor already has an Explainability resource.
*
*
*
* The following parameters are required when providing a Predictor ARN:
*
*
* -
*
* ExplainabilityName - A unique name for the Explainability.
*
*
* -
*
* ResourceArn - The Arn of the predictor.
*
*
* -
*
* TimePointGranularity - Must be set to “ALL”.
*
*
* -
*
* TimeSeriesGranularity - Must be set to “ALL”.
*
*
*
*
* Do not specify a value for the following parameters:
*
*
* -
*
* DataSource - Only valid when TimeSeriesGranularity is “SPECIFIC”.
*
*
* -
*
* Schema - Only valid when TimeSeriesGranularity is “SPECIFIC”.
*
*
* -
*
* StartDateTime - Only valid when TimePointGranularity is “SPECIFIC”.
*
*
* -
*
* EndDateTime - Only valid when TimePointGranularity is “SPECIFIC”.
*
*
*
*
* CreateExplainability with a Forecast ARN
*
*
*
* You can specify a maximum of 50 time series and 500 time points.
*
*
*
* The following parameters are required when providing a Predictor ARN:
*
*
* -
*
* ExplainabilityName - A unique name for the Explainability.
*
*
* -
*
* ResourceArn - The Arn of the forecast.
*
*
* -
*
* TimePointGranularity - Either “ALL” or “SPECIFIC”.
*
*
* -
*
* TimeSeriesGranularity - Either “ALL” or “SPECIFIC”.
*
*
*
*
* If you set TimeSeriesGranularity to “SPECIFIC”, you must also provide the following:
*
*
* -
*
* DataSource - The S3 location of the CSV file specifying your time series.
*
*
* -
*
* Schema - The Schema defines the attributes and attribute types listed in the Data Source.
*
*
*
*
* If you set TimePointGranularity to “SPECIFIC”, you must also provide the following:
*
*
* -
*
* StartDateTime - The first timestamp in the range of time points.
*
*
* -
*
* EndDateTime - The last timestamp in the range of time points.
*
*
*
*
* @param createExplainabilityRequest
* @return Result of the CreateExplainability operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceAlreadyExistsException
* There is already a resource with this name. Try again with a different name.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @throws ResourceInUseException
* The specified resource is in use.
* @throws LimitExceededException
* The limit on the number of resources per account has been exceeded.
* @sample AmazonForecast.CreateExplainability
* @see AWS
* API Documentation
*/
CreateExplainabilityResult createExplainability(CreateExplainabilityRequest createExplainabilityRequest);
/**
*
* Exports an Explainability resource created by the CreateExplainability operation. Exported files are
* exported to an Amazon Simple Storage Service (Amazon S3) bucket.
*
*
* You must specify a DataDestination object that includes an Amazon S3 bucket and an Identity and Access
* Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see
* aws-forecast-iam-roles.
*
*
*
* The Status of the export job must be ACTIVE before you can access the export in your
* Amazon S3 bucket. To get the status, use the DescribeExplainabilityExport operation.
*
*
*
* @param createExplainabilityExportRequest
* @return Result of the CreateExplainabilityExport operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceAlreadyExistsException
* There is already a resource with this name. Try again with a different name.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @throws ResourceInUseException
* The specified resource is in use.
* @throws LimitExceededException
* The limit on the number of resources per account has been exceeded.
* @sample AmazonForecast.CreateExplainabilityExport
* @see AWS API Documentation
*/
CreateExplainabilityExportResult createExplainabilityExport(CreateExplainabilityExportRequest createExplainabilityExportRequest);
/**
*
* 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.
*
*
* The range of the forecast is determined by the ForecastHorizon value, which you specify in the
* CreatePredictor request. When you query a forecast, you can request a specific date range within the
* forecast.
*
*
* To get a list of all your forecasts, use the ListForecasts operation.
*
*
*
* The forecasts generated by Amazon Forecast are in the same time zone as the dataset that was used to create the
* predictor.
*
*
*
* For more information, see howitworks-forecast.
*
*
*
* The Status of the forecast must be ACTIVE before you can query or export the forecast.
* Use the DescribeForecast operation to get the status.
*
*
*
* By default, a forecast includes predictions for every item (item_id) in the dataset group that was
* used to train the predictor. However, you can use the TimeSeriesSelector object to generate a
* forecast on a subset of time series. Forecast creation is skipped for any time series that you specify that are
* not in the input dataset. The forecast export file will not contain these time series or their forecasted values.
*
*
* @param createForecastRequest
* @return Result of the CreateForecast operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceAlreadyExistsException
* There is already a resource with this name. Try again with a different name.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @throws ResourceInUseException
* The specified resource is in use.
* @throws LimitExceededException
* The limit on the number of resources per account has been exceeded.
* @sample AmazonForecast.CreateForecast
* @see AWS API
* Documentation
*/
CreateForecastResult createForecast(CreateForecastRequest createForecastRequest);
/**
*
* 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:
*
*
* <ForecastExportJobName>_<ExportTimestamp>_<PartNumber>
*
*
* where the <ExportTimestamp> component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).
*
*
* You must specify a DataDestination object that includes an Identity and Access Management (IAM) role that
* Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see
* aws-forecast-iam-roles.
*
*
* For more information, see howitworks-forecast.
*
*
* To get a list of all your forecast export jobs, use the ListForecastExportJobs operation.
*
*
*
* The Status of the forecast export job must be ACTIVE before you can access the forecast
* in your Amazon S3 bucket. To get the status, use the DescribeForecastExportJob operation.
*
*
*
* @param createForecastExportJobRequest
* @return Result of the CreateForecastExportJob operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceAlreadyExistsException
* There is already a resource with this name. Try again with a different name.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @throws ResourceInUseException
* The specified resource is in use.
* @throws LimitExceededException
* The limit on the number of resources per account has been exceeded.
* @sample AmazonForecast.CreateForecastExportJob
* @see AWS API Documentation
*/
CreateForecastExportJobResult createForecastExportJob(CreateForecastExportJobRequest createForecastExportJobRequest);
/**
*
* Creates a predictor monitor resource for an existing auto predictor. Predictor monitoring allows you to see how
* your predictor's performance changes over time. For more information, see Predictor Monitoring.
*
*
* @param createMonitorRequest
* @return Result of the CreateMonitor operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceAlreadyExistsException
* There is already a resource with this name. Try again with a different name.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @throws ResourceInUseException
* The specified resource is in use.
* @throws LimitExceededException
* The limit on the number of resources per account has been exceeded.
* @sample AmazonForecast.CreateMonitor
* @see AWS API
* Documentation
*/
CreateMonitorResult createMonitor(CreateMonitorRequest createMonitorRequest);
/**
*
*
* This operation creates a legacy predictor that does not include all the predictor functionalities provided by
* Amazon Forecast. To create a predictor that is compatible with all aspects of Forecast, use
* CreateAutoPredictor.
*
*
*
* Creates an Amazon Forecast predictor.
*
*
* In the request, provide a dataset group and either specify an algorithm or let Amazon Forecast choose an
* algorithm for you using AutoML. If you specify an algorithm, you also can override algorithm-specific
* hyperparameters.
*
*
* Amazon Forecast uses the algorithm to train a predictor using the latest version of the datasets in the specified
* dataset group. You can then generate a forecast using the CreateForecast operation.
*
*
* To see the evaluation metrics, use the GetAccuracyMetrics operation.
*
*
* You can specify a featurization configuration to fill and aggregate the data fields in the
* TARGET_TIME_SERIES dataset to improve model training. For more information, see
* FeaturizationConfig.
*
*
* For RELATED_TIME_SERIES datasets, CreatePredictor verifies that the DataFrequency
* specified when the dataset was created matches the ForecastFrequency. TARGET_TIME_SERIES datasets
* don't have this restriction. Amazon Forecast also verifies the delimiter and timestamp format. For more
* information, see howitworks-datasets-groups.
*
*
* By default, predictors are trained and evaluated at the 0.1 (P10), 0.5 (P50), and 0.9 (P90) quantiles. You can
* choose custom forecast types to train and evaluate your predictor by setting the ForecastTypes.
*
*
* AutoML
*
*
* If you want Amazon Forecast to evaluate each algorithm and choose the one that minimizes the
* objective function, set PerformAutoML to true. The
* objective function is defined as the mean of the weighted losses over the forecast types. By
* default, these are the p10, p50, and p90 quantile losses. For more information, see EvaluationResult.
*
*
* When AutoML is enabled, the following properties are disallowed:
*
*
* -
*
* AlgorithmArn
*
*
* -
*
* HPOConfig
*
*
* -
*
* PerformHPO
*
*
* -
*
* TrainingParameters
*
*
*
*
* To get a list of all of your predictors, use the ListPredictors operation.
*
*
*
* Before you can use the predictor to create a forecast, the Status of the predictor must be
* ACTIVE, signifying that training has completed. To get the status, use the DescribePredictor
* operation.
*
*
*
* @param createPredictorRequest
* @return Result of the CreatePredictor operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceAlreadyExistsException
* There is already a resource with this name. Try again with a different name.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @throws ResourceInUseException
* The specified resource is in use.
* @throws LimitExceededException
* The limit on the number of resources per account has been exceeded.
* @sample AmazonForecast.CreatePredictor
* @see AWS API
* Documentation
*/
CreatePredictorResult createPredictor(CreatePredictorRequest createPredictorRequest);
/**
*
* Exports backtest forecasts and accuracy metrics generated by the CreateAutoPredictor or
* CreatePredictor operations. Two folders containing CSV or Parquet files are exported to your specified S3
* bucket.
*
*
* The export file names will match the following conventions:
*
*
* <ExportJobName>_<ExportTimestamp>_<PartNumber>.csv
*
*
* The <ExportTimestamp> component is in Java SimpleDate format (yyyy-MM-ddTHH-mm-ssZ).
*
*
* You must specify a DataDestination object that includes an Amazon S3 bucket and an Identity and Access
* Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see
* aws-forecast-iam-roles.
*
*
*
* The Status of the export job must be ACTIVE before you can access the export in your
* Amazon S3 bucket. To get the status, use the DescribePredictorBacktestExportJob operation.
*
*
*
* @param createPredictorBacktestExportJobRequest
* @return Result of the CreatePredictorBacktestExportJob operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceAlreadyExistsException
* There is already a resource with this name. Try again with a different name.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @throws ResourceInUseException
* The specified resource is in use.
* @throws LimitExceededException
* The limit on the number of resources per account has been exceeded.
* @sample AmazonForecast.CreatePredictorBacktestExportJob
* @see AWS API Documentation
*/
CreatePredictorBacktestExportJobResult createPredictorBacktestExportJob(CreatePredictorBacktestExportJobRequest createPredictorBacktestExportJobRequest);
/**
*
* What-if analysis is a scenario modeling technique where you make a hypothetical change to a time series and
* compare the forecasts generated by these changes against the baseline, unchanged time series. It is important to
* remember that the purpose of a what-if analysis is to understand how a forecast can change given different
* modifications to the baseline time series.
*
*
* For example, imagine you are a clothing retailer who is considering an end of season sale to clear space for new
* styles. After creating a baseline forecast, you can use a what-if analysis to investigate how different sales
* tactics might affect your goals.
*
*
* You could create a scenario where everything is given a 25% markdown, and another where everything is given a
* fixed dollar markdown. You could create a scenario where the sale lasts for one week and another where the sale
* lasts for one month. With a what-if analysis, you can compare many different scenarios against each other.
*
*
* Note that a what-if analysis is meant to display what the forecasting model has learned and how it will behave in
* the scenarios that you are evaluating. Do not blindly use the results of the what-if analysis to make business
* decisions. For instance, forecasts might not be accurate for novel scenarios where there is no reference
* available to determine whether a forecast is good.
*
*
* The TimeSeriesSelector object defines the items that you want in the what-if analysis.
*
*
* @param createWhatIfAnalysisRequest
* @return Result of the CreateWhatIfAnalysis operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceAlreadyExistsException
* There is already a resource with this name. Try again with a different name.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @throws ResourceInUseException
* The specified resource is in use.
* @throws LimitExceededException
* The limit on the number of resources per account has been exceeded.
* @sample AmazonForecast.CreateWhatIfAnalysis
* @see AWS
* API Documentation
*/
CreateWhatIfAnalysisResult createWhatIfAnalysis(CreateWhatIfAnalysisRequest createWhatIfAnalysisRequest);
/**
*
* A what-if forecast is a forecast that is created from a modified version of the baseline forecast. Each what-if
* forecast incorporates either a replacement dataset or a set of transformations to the original dataset.
*
*
* @param createWhatIfForecastRequest
* @return Result of the CreateWhatIfForecast operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceAlreadyExistsException
* There is already a resource with this name. Try again with a different name.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @throws ResourceInUseException
* The specified resource is in use.
* @throws LimitExceededException
* The limit on the number of resources per account has been exceeded.
* @sample AmazonForecast.CreateWhatIfForecast
* @see AWS
* API Documentation
*/
CreateWhatIfForecastResult createWhatIfForecast(CreateWhatIfForecastRequest createWhatIfForecastRequest);
/**
*
* Exports a forecast created by the CreateWhatIfForecast operation to your Amazon Simple Storage Service
* (Amazon S3) bucket. The forecast file name will match the following conventions:
*
*
* ≈<ForecastExportJobName>_<ExportTimestamp>_<PartNumber>
*
*
* The <ExportTimestamp> component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).
*
*
* You must specify a DataDestination object that includes an Identity and Access Management (IAM) role that
* Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see
* aws-forecast-iam-roles.
*
*
* For more information, see howitworks-forecast.
*
*
* To get a list of all your what-if forecast export jobs, use the ListWhatIfForecastExports operation.
*
*
*
* The Status of the forecast export job must be ACTIVE before you can access the forecast
* in your Amazon S3 bucket. To get the status, use the DescribeWhatIfForecastExport operation.
*
*
*
* @param createWhatIfForecastExportRequest
* @return Result of the CreateWhatIfForecastExport operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceAlreadyExistsException
* There is already a resource with this name. Try again with a different name.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @throws ResourceInUseException
* The specified resource is in use.
* @throws LimitExceededException
* The limit on the number of resources per account has been exceeded.
* @sample AmazonForecast.CreateWhatIfForecastExport
* @see AWS API Documentation
*/
CreateWhatIfForecastExportResult createWhatIfForecastExport(CreateWhatIfForecastExportRequest createWhatIfForecastExportRequest);
/**
*
* 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.
*
*
*
* Forecast does not automatically update any dataset groups that contain the deleted dataset. In order to update
* the dataset group, use the UpdateDatasetGroup
* operation, omitting the deleted dataset's ARN.
*
*
*
* @param deleteDatasetRequest
* @return Result of the DeleteDataset operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @throws ResourceInUseException
* The specified resource is in use.
* @sample AmazonForecast.DeleteDataset
* @see AWS API
* Documentation
*/
DeleteDatasetResult deleteDataset(DeleteDatasetRequest deleteDatasetRequest);
/**
*
* 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.
*
*
* This operation deletes only the dataset group, not the datasets in the group.
*
*
* @param deleteDatasetGroupRequest
* @return Result of the DeleteDatasetGroup operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @throws ResourceInUseException
* The specified resource is in use.
* @sample AmazonForecast.DeleteDatasetGroup
* @see AWS
* API Documentation
*/
DeleteDatasetGroupResult deleteDatasetGroup(DeleteDatasetGroupRequest deleteDatasetGroupRequest);
/**
*
* 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.
*
*
* @param deleteDatasetImportJobRequest
* @return Result of the DeleteDatasetImportJob operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @throws ResourceInUseException
* The specified resource is in use.
* @sample AmazonForecast.DeleteDatasetImportJob
* @see AWS API Documentation
*/
DeleteDatasetImportJobResult deleteDatasetImportJob(DeleteDatasetImportJobRequest deleteDatasetImportJobRequest);
/**
*
* Deletes an Explainability resource.
*
*
* You can delete only predictor that have a status of ACTIVE or CREATE_FAILED. To get the
* status, use the DescribeExplainability operation.
*
*
* @param deleteExplainabilityRequest
* @return Result of the DeleteExplainability operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @throws ResourceInUseException
* The specified resource is in use.
* @sample AmazonForecast.DeleteExplainability
* @see AWS
* API Documentation
*/
DeleteExplainabilityResult deleteExplainability(DeleteExplainabilityRequest deleteExplainabilityRequest);
/**
*
* Deletes an Explainability export.
*
*
* @param deleteExplainabilityExportRequest
* @return Result of the DeleteExplainabilityExport operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @throws ResourceInUseException
* The specified resource is in use.
* @sample AmazonForecast.DeleteExplainabilityExport
* @see AWS API Documentation
*/
DeleteExplainabilityExportResult deleteExplainabilityExport(DeleteExplainabilityExportRequest deleteExplainabilityExportRequest);
/**
*
* 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.
*
*
* You can't delete a forecast while it is being exported. After a forecast is deleted, you can no longer query the
* forecast.
*
*
* @param deleteForecastRequest
* @return Result of the DeleteForecast operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @throws ResourceInUseException
* The specified resource is in use.
* @sample AmazonForecast.DeleteForecast
* @see AWS API
* Documentation
*/
DeleteForecastResult deleteForecast(DeleteForecastRequest deleteForecastRequest);
/**
*
* 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.
*
*
* @param deleteForecastExportJobRequest
* @return Result of the DeleteForecastExportJob operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @throws ResourceInUseException
* The specified resource is in use.
* @sample AmazonForecast.DeleteForecastExportJob
* @see AWS API Documentation
*/
DeleteForecastExportJobResult deleteForecastExportJob(DeleteForecastExportJobRequest deleteForecastExportJobRequest);
/**
*
* Deletes a monitor resource. You can only delete a monitor resource with a status of ACTIVE,
* ACTIVE_STOPPED, CREATE_FAILED, or CREATE_STOPPED.
*
*
* @param deleteMonitorRequest
* @return Result of the DeleteMonitor operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @throws ResourceInUseException
* The specified resource is in use.
* @sample AmazonForecast.DeleteMonitor
* @see AWS API
* Documentation
*/
DeleteMonitorResult deleteMonitor(DeleteMonitorRequest deleteMonitorRequest);
/**
*
* Deletes a predictor created using the DescribePredictor or CreatePredictor operations. You can
* delete only predictor that have a status of ACTIVE or CREATE_FAILED. To get the status,
* use the DescribePredictor operation.
*
*
* @param deletePredictorRequest
* @return Result of the DeletePredictor operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @throws ResourceInUseException
* The specified resource is in use.
* @sample AmazonForecast.DeletePredictor
* @see AWS API
* Documentation
*/
DeletePredictorResult deletePredictor(DeletePredictorRequest deletePredictorRequest);
/**
*
* Deletes a predictor backtest export job.
*
*
* @param deletePredictorBacktestExportJobRequest
* @return Result of the DeletePredictorBacktestExportJob operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @throws ResourceInUseException
* The specified resource is in use.
* @sample AmazonForecast.DeletePredictorBacktestExportJob
* @see AWS API Documentation
*/
DeletePredictorBacktestExportJobResult deletePredictorBacktestExportJob(DeletePredictorBacktestExportJobRequest deletePredictorBacktestExportJobRequest);
/**
*
* Deletes an entire resource tree. This operation will delete the parent resource and its child resources.
*
*
* Child resources are resources that were created from another resource. For example, when a forecast is generated
* from a predictor, the forecast is the child resource and the predictor is the parent resource.
*
*
* Amazon Forecast resources possess the following parent-child resource hierarchies:
*
*
* -
*
* Dataset: dataset import jobs
*
*
* -
*
* Dataset Group: predictors, predictor backtest export jobs, forecasts, forecast export jobs
*
*
* -
*
* Predictor: predictor backtest export jobs, forecasts, forecast export jobs
*
*
* -
*
* Forecast: forecast export jobs
*
*
*
*
*
* DeleteResourceTree will only delete Amazon Forecast resources, and will not delete datasets or
* exported files stored in Amazon S3.
*
*
*
* @param deleteResourceTreeRequest
* @return Result of the DeleteResourceTree operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @throws ResourceInUseException
* The specified resource is in use.
* @sample AmazonForecast.DeleteResourceTree
* @see AWS
* API Documentation
*/
DeleteResourceTreeResult deleteResourceTree(DeleteResourceTreeRequest deleteResourceTreeRequest);
/**
*
* Deletes a what-if analysis created using the CreateWhatIfAnalysis operation. You can delete only what-if
* analyses that have a status of ACTIVE or CREATE_FAILED. To get the status, use the
* DescribeWhatIfAnalysis operation.
*
*
* You can't delete a what-if analysis while any of its forecasts are being exported.
*
*
* @param deleteWhatIfAnalysisRequest
* @return Result of the DeleteWhatIfAnalysis operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @throws ResourceInUseException
* The specified resource is in use.
* @sample AmazonForecast.DeleteWhatIfAnalysis
* @see AWS
* API Documentation
*/
DeleteWhatIfAnalysisResult deleteWhatIfAnalysis(DeleteWhatIfAnalysisRequest deleteWhatIfAnalysisRequest);
/**
*
* Deletes a what-if forecast created using the CreateWhatIfForecast operation. You can delete only what-if
* forecasts that have a status of ACTIVE or CREATE_FAILED. To get the status, use the
* DescribeWhatIfForecast operation.
*
*
* You can't delete a what-if forecast while it is being exported. After a what-if forecast is deleted, you can no
* longer query the what-if analysis.
*
*
* @param deleteWhatIfForecastRequest
* @return Result of the DeleteWhatIfForecast operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @throws ResourceInUseException
* The specified resource is in use.
* @sample AmazonForecast.DeleteWhatIfForecast
* @see AWS
* API Documentation
*/
DeleteWhatIfForecastResult deleteWhatIfForecast(DeleteWhatIfForecastRequest deleteWhatIfForecastRequest);
/**
*
* Deletes a what-if forecast export created using the CreateWhatIfForecastExport operation. You can delete
* only what-if forecast exports that have a status of ACTIVE or CREATE_FAILED. To get the
* status, use the DescribeWhatIfForecastExport operation.
*
*
* @param deleteWhatIfForecastExportRequest
* @return Result of the DeleteWhatIfForecastExport operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @throws ResourceInUseException
* The specified resource is in use.
* @sample AmazonForecast.DeleteWhatIfForecastExport
* @see AWS API Documentation
*/
DeleteWhatIfForecastExportResult deleteWhatIfForecastExport(DeleteWhatIfForecastExportRequest deleteWhatIfForecastExportRequest);
/**
*
* Describes a predictor created using the CreateAutoPredictor operation.
*
*
* @param describeAutoPredictorRequest
* @return Result of the DescribeAutoPredictor operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @sample AmazonForecast.DescribeAutoPredictor
* @see AWS
* API Documentation
*/
DescribeAutoPredictorResult describeAutoPredictor(DescribeAutoPredictorRequest describeAutoPredictorRequest);
/**
*
* Describes an Amazon Forecast dataset created using the CreateDataset operation.
*
*
* In addition to listing the parameters specified in the CreateDataset request, this operation
* includes the following dataset properties:
*
*
* -
*
* CreationTime
*
*
* -
*
* LastModificationTime
*
*
* -
*
* Status
*
*
*
*
* @param describeDatasetRequest
* @return Result of the DescribeDataset operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @sample AmazonForecast.DescribeDataset
* @see AWS API
* Documentation
*/
DescribeDatasetResult describeDataset(DescribeDatasetRequest describeDatasetRequest);
/**
*
* Describes a dataset group created using the CreateDatasetGroup
* operation.
*
*
* In addition to listing the parameters provided in the CreateDatasetGroup request, this operation
* includes the following properties:
*
*
* -
*
* DatasetArns - The datasets belonging to the group.
*
*
* -
*
* CreationTime
*
*
* -
*
* LastModificationTime
*
*
* -
*
* Status
*
*
*
*
* @param describeDatasetGroupRequest
* @return Result of the DescribeDatasetGroup operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @sample AmazonForecast.DescribeDatasetGroup
* @see AWS
* API Documentation
*/
DescribeDatasetGroupResult describeDatasetGroup(DescribeDatasetGroupRequest describeDatasetGroupRequest);
/**
*
* Describes a dataset import job created using the CreateDatasetImportJob
* operation.
*
*
* In addition to listing the parameters provided in the CreateDatasetImportJob request, this operation
* includes the following properties:
*
*
* -
*
* CreationTime
*
*
* -
*
* LastModificationTime
*
*
* -
*
* DataSize
*
*
* -
*
* FieldStatistics
*
*
* -
*
* Status
*
*
* -
*
* Message - If an error occurred, information about the error.
*
*
*
*
* @param describeDatasetImportJobRequest
* @return Result of the DescribeDatasetImportJob operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @sample AmazonForecast.DescribeDatasetImportJob
* @see AWS API Documentation
*/
DescribeDatasetImportJobResult describeDatasetImportJob(DescribeDatasetImportJobRequest describeDatasetImportJobRequest);
/**
*
* Describes an Explainability resource created using the CreateExplainability operation.
*
*
* @param describeExplainabilityRequest
* @return Result of the DescribeExplainability operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @sample AmazonForecast.DescribeExplainability
* @see AWS API Documentation
*/
DescribeExplainabilityResult describeExplainability(DescribeExplainabilityRequest describeExplainabilityRequest);
/**
*
* Describes an Explainability export created using the CreateExplainabilityExport operation.
*
*
* @param describeExplainabilityExportRequest
* @return Result of the DescribeExplainabilityExport operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @sample AmazonForecast.DescribeExplainabilityExport
* @see AWS API Documentation
*/
DescribeExplainabilityExportResult describeExplainabilityExport(DescribeExplainabilityExportRequest describeExplainabilityExportRequest);
/**
*
* Describes a forecast created using the CreateForecast operation.
*
*
* In addition to listing the properties provided in the CreateForecast request, this operation lists
* the following properties:
*
*
* -
*
* DatasetGroupArn - The dataset group that provided the training data.
*
*
* -
*
* CreationTime
*
*
* -
*
* LastModificationTime
*
*
* -
*
* Status
*
*
* -
*
* Message - If an error occurred, information about the error.
*
*
*
*
* @param describeForecastRequest
* @return Result of the DescribeForecast operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @sample AmazonForecast.DescribeForecast
* @see AWS API
* Documentation
*/
DescribeForecastResult describeForecast(DescribeForecastRequest describeForecastRequest);
/**
*
* Describes a forecast export job created using the CreateForecastExportJob operation.
*
*
* In addition to listing the properties provided by the user in the CreateForecastExportJob request,
* this operation lists the following properties:
*
*
* -
*
* CreationTime
*
*
* -
*
* LastModificationTime
*
*
* -
*
* Status
*
*
* -
*
* Message - If an error occurred, information about the error.
*
*
*
*
* @param describeForecastExportJobRequest
* @return Result of the DescribeForecastExportJob operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @sample AmazonForecast.DescribeForecastExportJob
* @see AWS API Documentation
*/
DescribeForecastExportJobResult describeForecastExportJob(DescribeForecastExportJobRequest describeForecastExportJobRequest);
/**
*
* Describes a monitor resource. In addition to listing the properties provided in the CreateMonitor request,
* this operation lists the following properties:
*
*
* -
*
* Baseline
*
*
* -
*
* CreationTime
*
*
* -
*
* LastEvaluationTime
*
*
* -
*
* LastEvaluationState
*
*
* -
*
* LastModificationTime
*
*
* -
*
* Message
*
*
* -
*
* Status
*
*
*
*
* @param describeMonitorRequest
* @return Result of the DescribeMonitor operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @sample AmazonForecast.DescribeMonitor
* @see AWS API
* Documentation
*/
DescribeMonitorResult describeMonitor(DescribeMonitorRequest describeMonitorRequest);
/**
*
*
* This operation is only valid for legacy predictors created with CreatePredictor. If you are not using a legacy
* predictor, use DescribeAutoPredictor.
*
*
*
* Describes a predictor created using the CreatePredictor operation.
*
*
* In addition to listing the properties provided in the CreatePredictor request, this operation lists
* the following properties:
*
*
* -
*
* DatasetImportJobArns - The dataset import jobs used to import training data.
*
*
* -
*
* AutoMLAlgorithmArns - If AutoML is performed, the algorithms that were evaluated.
*
*
* -
*
* CreationTime
*
*
* -
*
* LastModificationTime
*
*
* -
*
* Status
*
*
* -
*
* Message - If an error occurred, information about the error.
*
*
*
*
* @param describePredictorRequest
* @return Result of the DescribePredictor operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @sample AmazonForecast.DescribePredictor
* @see AWS API
* Documentation
*/
DescribePredictorResult describePredictor(DescribePredictorRequest describePredictorRequest);
/**
*
* Describes a predictor backtest export job created using the CreatePredictorBacktestExportJob operation.
*
*
* In addition to listing the properties provided by the user in the CreatePredictorBacktestExportJob
* request, this operation lists the following properties:
*
*
* -
*
* CreationTime
*
*
* -
*
* LastModificationTime
*
*
* -
*
* Status
*
*
* -
*
* Message (if an error occurred)
*
*
*
*
* @param describePredictorBacktestExportJobRequest
* @return Result of the DescribePredictorBacktestExportJob operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @sample AmazonForecast.DescribePredictorBacktestExportJob
* @see AWS API Documentation
*/
DescribePredictorBacktestExportJobResult describePredictorBacktestExportJob(
DescribePredictorBacktestExportJobRequest describePredictorBacktestExportJobRequest);
/**
*
* Describes the what-if analysis created using the CreateWhatIfAnalysis operation.
*
*
* In addition to listing the properties provided in the CreateWhatIfAnalysis request, this operation
* lists the following properties:
*
*
* -
*
* CreationTime
*
*
* -
*
* LastModificationTime
*
*
* -
*
* Message - If an error occurred, information about the error.
*
*
* -
*
* Status
*
*
*
*
* @param describeWhatIfAnalysisRequest
* @return Result of the DescribeWhatIfAnalysis operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @sample AmazonForecast.DescribeWhatIfAnalysis
* @see AWS API Documentation
*/
DescribeWhatIfAnalysisResult describeWhatIfAnalysis(DescribeWhatIfAnalysisRequest describeWhatIfAnalysisRequest);
/**
*
* Describes the what-if forecast created using the CreateWhatIfForecast operation.
*
*
* In addition to listing the properties provided in the CreateWhatIfForecast request, this operation
* lists the following properties:
*
*
* -
*
* CreationTime
*
*
* -
*
* LastModificationTime
*
*
* -
*
* Message - If an error occurred, information about the error.
*
*
* -
*
* Status
*
*
*
*
* @param describeWhatIfForecastRequest
* @return Result of the DescribeWhatIfForecast operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @sample AmazonForecast.DescribeWhatIfForecast
* @see AWS API Documentation
*/
DescribeWhatIfForecastResult describeWhatIfForecast(DescribeWhatIfForecastRequest describeWhatIfForecastRequest);
/**
*
* Describes the what-if forecast export created using the CreateWhatIfForecastExport operation.
*
*
* In addition to listing the properties provided in the CreateWhatIfForecastExport request, this
* operation lists the following properties:
*
*
* -
*
* CreationTime
*
*
* -
*
* LastModificationTime
*
*
* -
*
* Message - If an error occurred, information about the error.
*
*
* -
*
* Status
*
*
*
*
* @param describeWhatIfForecastExportRequest
* @return Result of the DescribeWhatIfForecastExport operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @sample AmazonForecast.DescribeWhatIfForecastExport
* @see AWS API Documentation
*/
DescribeWhatIfForecastExportResult describeWhatIfForecastExport(DescribeWhatIfForecastExportRequest describeWhatIfForecastExportRequest);
/**
*
* 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.
*
*
* This operation generates metrics for each backtest window that was evaluated. The number of backtest windows (
* NumberOfBacktestWindows) is specified using the EvaluationParameters object, which is
* optionally included in the CreatePredictor request. If NumberOfBacktestWindows isn't
* specified, the number defaults to one.
*
*
* The parameters of the filling method determine which items contribute to the metrics. If you want
* all items to contribute, specify zero. If you want only those items that have complete data in the
* range being evaluated to contribute, specify nan. For more information, see
* FeaturizationMethod.
*
*
*
* Before you can get accuracy metrics, the Status of the predictor must be ACTIVE,
* signifying that training has completed. To get the status, use the DescribePredictor operation.
*
*
*
* @param getAccuracyMetricsRequest
* @return Result of the GetAccuracyMetrics operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @throws ResourceInUseException
* The specified resource is in use.
* @sample AmazonForecast.GetAccuracyMetrics
* @see AWS
* API Documentation
*/
GetAccuracyMetricsResult getAccuracyMetrics(GetAccuracyMetricsRequest getAccuracyMetricsRequest);
/**
*
* 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.
*
*
* @param listDatasetGroupsRequest
* @return Result of the ListDatasetGroups operation returned by the service.
* @throws InvalidNextTokenException
* The token is not valid. Tokens expire after 24 hours.
* @sample AmazonForecast.ListDatasetGroups
* @see AWS API
* Documentation
*/
ListDatasetGroupsResult listDatasetGroups(ListDatasetGroupsRequest listDatasetGroupsRequest);
/**
*
* 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.
*
*
* @param listDatasetImportJobsRequest
* @return Result of the ListDatasetImportJobs operation returned by the service.
* @throws InvalidNextTokenException
* The token is not valid. Tokens expire after 24 hours.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @sample AmazonForecast.ListDatasetImportJobs
* @see AWS
* API Documentation
*/
ListDatasetImportJobsResult listDatasetImportJobs(ListDatasetImportJobsRequest listDatasetImportJobsRequest);
/**
*
* 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.
*
*
* @param listDatasetsRequest
* @return Result of the ListDatasets operation returned by the service.
* @throws InvalidNextTokenException
* The token is not valid. Tokens expire after 24 hours.
* @sample AmazonForecast.ListDatasets
* @see AWS API
* Documentation
*/
ListDatasetsResult listDatasets(ListDatasetsRequest listDatasetsRequest);
/**
*
* Returns a list of Explainability resources created using the CreateExplainability operation. This
* operation returns a summary for each Explainability. You can filter the list using an array of Filter
* objects.
*
*
* To retrieve the complete set of properties for a particular Explainability resource, use the ARN with the
* DescribeExplainability operation.
*
*
* @param listExplainabilitiesRequest
* @return Result of the ListExplainabilities operation returned by the service.
* @throws InvalidNextTokenException
* The token is not valid. Tokens expire after 24 hours.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @sample AmazonForecast.ListExplainabilities
* @see AWS
* API Documentation
*/
ListExplainabilitiesResult listExplainabilities(ListExplainabilitiesRequest listExplainabilitiesRequest);
/**
*
* Returns a list of Explainability exports created using the CreateExplainabilityExport operation. This
* operation returns a summary for each Explainability export. You can filter the list using an array of
* Filter objects.
*
*
* To retrieve the complete set of properties for a particular Explainability export, use the ARN with the
* DescribeExplainability operation.
*
*
* @param listExplainabilityExportsRequest
* @return Result of the ListExplainabilityExports operation returned by the service.
* @throws InvalidNextTokenException
* The token is not valid. Tokens expire after 24 hours.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @sample AmazonForecast.ListExplainabilityExports
* @see AWS API Documentation
*/
ListExplainabilityExportsResult listExplainabilityExports(ListExplainabilityExportsRequest listExplainabilityExportsRequest);
/**
*
* 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.
*
*
* @param listForecastExportJobsRequest
* @return Result of the ListForecastExportJobs operation returned by the service.
* @throws InvalidNextTokenException
* The token is not valid. Tokens expire after 24 hours.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @sample AmazonForecast.ListForecastExportJobs
* @see AWS API Documentation
*/
ListForecastExportJobsResult listForecastExportJobs(ListForecastExportJobsRequest listForecastExportJobsRequest);
/**
*
* 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.
*
*
* @param listForecastsRequest
* @return Result of the ListForecasts operation returned by the service.
* @throws InvalidNextTokenException
* The token is not valid. Tokens expire after 24 hours.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @sample AmazonForecast.ListForecasts
* @see AWS API
* Documentation
*/
ListForecastsResult listForecasts(ListForecastsRequest listForecastsRequest);
/**
*
* Returns a list of the monitoring evaluation results and predictor events collected by the monitor resource during
* different windows of time.
*
*
* For information about monitoring see predictor-monitoring. For more information about retrieving
* monitoring results see Viewing Monitoring
* Results.
*
*
* @param listMonitorEvaluationsRequest
* @return Result of the ListMonitorEvaluations operation returned by the service.
* @throws InvalidNextTokenException
* The token is not valid. Tokens expire after 24 hours.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @sample AmazonForecast.ListMonitorEvaluations
* @see AWS API Documentation
*/
ListMonitorEvaluationsResult listMonitorEvaluations(ListMonitorEvaluationsRequest listMonitorEvaluationsRequest);
/**
*
* Returns a list of monitors created with the CreateMonitor operation and CreateAutoPredictor
* operation. For each monitor resource, this operation returns of a summary of its properties, including its Amazon
* Resource Name (ARN). You can retrieve a complete set of properties of a monitor resource by specify the monitor's
* ARN in the DescribeMonitor operation.
*
*
* @param listMonitorsRequest
* @return Result of the ListMonitors operation returned by the service.
* @throws InvalidNextTokenException
* The token is not valid. Tokens expire after 24 hours.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @sample AmazonForecast.ListMonitors
* @see AWS API
* Documentation
*/
ListMonitorsResult listMonitors(ListMonitorsRequest listMonitorsRequest);
/**
*
* 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.
*
*
* To retrieve the complete set of properties for a particular backtest export job, use the ARN with the
* DescribePredictorBacktestExportJob operation.
*
*
* @param listPredictorBacktestExportJobsRequest
* @return Result of the ListPredictorBacktestExportJobs operation returned by the service.
* @throws InvalidNextTokenException
* The token is not valid. Tokens expire after 24 hours.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @sample AmazonForecast.ListPredictorBacktestExportJobs
* @see AWS API Documentation
*/
ListPredictorBacktestExportJobsResult listPredictorBacktestExportJobs(ListPredictorBacktestExportJobsRequest listPredictorBacktestExportJobsRequest);
/**
*
* Returns a list of predictors created using the CreateAutoPredictor or CreatePredictor operations.
* 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 DescribeAutoPredictor and
* DescribePredictor operations. You can filter the list using an array of Filter objects.
*
*
* @param listPredictorsRequest
* @return Result of the ListPredictors operation returned by the service.
* @throws InvalidNextTokenException
* The token is not valid. Tokens expire after 24 hours.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @sample AmazonForecast.ListPredictors
* @see AWS API
* Documentation
*/
ListPredictorsResult listPredictors(ListPredictorsRequest listPredictorsRequest);
/**
*
* Lists the tags for an Amazon Forecast resource.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @sample AmazonForecast.ListTagsForResource
* @see AWS
* API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Returns a list of what-if analyses created using the CreateWhatIfAnalysis operation. For each what-if
* analysis, 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 what-if analysis ARN with the DescribeWhatIfAnalysis
* operation.
*
*
* @param listWhatIfAnalysesRequest
* @return Result of the ListWhatIfAnalyses operation returned by the service.
* @throws InvalidNextTokenException
* The token is not valid. Tokens expire after 24 hours.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @sample AmazonForecast.ListWhatIfAnalyses
* @see AWS
* API Documentation
*/
ListWhatIfAnalysesResult listWhatIfAnalyses(ListWhatIfAnalysesRequest listWhatIfAnalysesRequest);
/**
*
* Returns a list of what-if forecast exports created using the CreateWhatIfForecastExport operation. For
* each what-if forecast export, 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 what-if forecast export ARN with the
* DescribeWhatIfForecastExport operation.
*
*
* @param listWhatIfForecastExportsRequest
* @return Result of the ListWhatIfForecastExports operation returned by the service.
* @throws InvalidNextTokenException
* The token is not valid. Tokens expire after 24 hours.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @sample AmazonForecast.ListWhatIfForecastExports
* @see AWS API Documentation
*/
ListWhatIfForecastExportsResult listWhatIfForecastExports(ListWhatIfForecastExportsRequest listWhatIfForecastExportsRequest);
/**
*
* Returns a list of what-if forecasts created using the CreateWhatIfForecast operation. For each what-if
* forecast, 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 what-if forecast ARN with the DescribeWhatIfForecast
* operation.
*
*
* @param listWhatIfForecastsRequest
* @return Result of the ListWhatIfForecasts operation returned by the service.
* @throws InvalidNextTokenException
* The token is not valid. Tokens expire after 24 hours.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @sample AmazonForecast.ListWhatIfForecasts
* @see AWS
* API Documentation
*/
ListWhatIfForecastsResult listWhatIfForecasts(ListWhatIfForecastsRequest listWhatIfForecastsRequest);
/**
*
* Resumes a stopped monitor resource.
*
*
* @param resumeResourceRequest
* @return Result of the ResumeResource operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws LimitExceededException
* The limit on the number of resources per account has been exceeded.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @throws ResourceInUseException
* The specified resource is in use.
* @sample AmazonForecast.ResumeResource
* @see AWS API
* Documentation
*/
ResumeResourceResult resumeResource(ResumeResourceRequest resumeResourceRequest);
/**
*
* Stops a resource.
*
*
* The resource undergoes the following states: CREATE_STOPPING and CREATE_STOPPED. You
* cannot resume a resource once it has been stopped.
*
*
* This operation can be applied to the following resources (and their corresponding child resources):
*
*
* -
*
* Dataset Import Job
*
*
* -
*
* Predictor Job
*
*
* -
*
* Forecast Job
*
*
* -
*
* Forecast Export Job
*
*
* -
*
* Predictor Backtest Export Job
*
*
* -
*
* Explainability Job
*
*
* -
*
* Explainability Export Job
*
*
*
*
* @param stopResourceRequest
* @return Result of the StopResource operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws LimitExceededException
* The limit on the number of resources per account has been exceeded.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @sample AmazonForecast.StopResource
* @see AWS API
* Documentation
*/
StopResourceResult stopResource(StopResourceRequest stopResourceRequest);
/**
*
* 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.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @throws LimitExceededException
* The limit on the number of resources per account has been exceeded.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @sample AmazonForecast.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Deletes the specified tags from a resource.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @sample AmazonForecast.UntagResource
* @see AWS API
* Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Replaces the datasets in a dataset group with the specified datasets.
*
*
*
* The Status of the dataset group must be ACTIVE before you can use the dataset group to
* create a predictor. Use the DescribeDatasetGroup
* operation to get the status.
*
*
*
* @param updateDatasetGroupRequest
* @return Result of the UpdateDatasetGroup operation returned by the service.
* @throws InvalidInputException
* We can't process the request because it includes an invalid value or a value that exceeds the valid
* range.
* @throws ResourceNotFoundException
* We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
* @throws ResourceInUseException
* The specified resource is in use.
* @sample AmazonForecast.UpdateDatasetGroup
* @see AWS
* API Documentation
*/
UpdateDatasetGroupResult updateDatasetGroup(UpdateDatasetGroupRequest updateDatasetGroupRequest);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
*
* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic
* information for an executed request, you should use this method to retrieve it as soon as possible after
* executing a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}