@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonForecastAsyncClient extends AmazonForecastClient implements AmazonForecastAsync
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
Provides APIs for creating and managing Amazon Forecast resources.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
builder, createAutoPredictor, createDataset, createDatasetGroup, createDatasetImportJob, createExplainability, createExplainabilityExport, createForecast, createForecastExportJob, createMonitor, createPredictor, createPredictorBacktestExportJob, createWhatIfAnalysis, createWhatIfForecast, createWhatIfForecastExport, deleteDataset, deleteDatasetGroup, deleteDatasetImportJob, deleteExplainability, deleteExplainabilityExport, deleteForecast, deleteForecastExportJob, deleteMonitor, deletePredictor, deletePredictorBacktestExportJob, deleteResourceTree, deleteWhatIfAnalysis, deleteWhatIfForecast, deleteWhatIfForecastExport, describeAutoPredictor, describeDataset, describeDatasetGroup, describeDatasetImportJob, describeExplainability, describeExplainabilityExport, describeForecast, describeForecastExportJob, describeMonitor, describePredictor, describePredictorBacktestExportJob, describeWhatIfAnalysis, describeWhatIfForecast, describeWhatIfForecastExport, getAccuracyMetrics, getCachedResponseMetadata, listDatasetGroups, listDatasetImportJobs, listDatasets, listExplainabilities, listExplainabilityExports, listForecastExportJobs, listForecasts, listMonitorEvaluations, listMonitors, listPredictorBacktestExportJobs, listPredictors, listTagsForResource, listWhatIfAnalyses, listWhatIfForecastExports, listWhatIfForecasts, resumeResource, stopResource, tagResource, untagResource, updateDatasetGroup
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
createAutoPredictor, createDataset, createDatasetGroup, createDatasetImportJob, createExplainability, createExplainabilityExport, createForecast, createForecastExportJob, createMonitor, createPredictor, createPredictorBacktestExportJob, createWhatIfAnalysis, createWhatIfForecast, createWhatIfForecastExport, deleteDataset, deleteDatasetGroup, deleteDatasetImportJob, deleteExplainability, deleteExplainabilityExport, deleteForecast, deleteForecastExportJob, deleteMonitor, deletePredictor, deletePredictorBacktestExportJob, deleteResourceTree, deleteWhatIfAnalysis, deleteWhatIfForecast, deleteWhatIfForecastExport, describeAutoPredictor, describeDataset, describeDatasetGroup, describeDatasetImportJob, describeExplainability, describeExplainabilityExport, describeForecast, describeForecastExportJob, describeMonitor, describePredictor, describePredictorBacktestExportJob, describeWhatIfAnalysis, describeWhatIfForecast, describeWhatIfForecastExport, getAccuracyMetrics, getCachedResponseMetadata, listDatasetGroups, listDatasetImportJobs, listDatasets, listExplainabilities, listExplainabilityExports, listForecastExportJobs, listForecasts, listMonitorEvaluations, listMonitors, listPredictorBacktestExportJobs, listPredictors, listTagsForResource, listWhatIfAnalyses, listWhatIfForecastExports, listWhatIfForecasts, resumeResource, stopResource, tagResource, untagResource, updateDatasetGroup
public static AmazonForecastAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CreateAutoPredictorResult> createAutoPredictorAsync(CreateAutoPredictorRequest request)
AmazonForecastAsync
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
.
createAutoPredictorAsync
in interface AmazonForecastAsync
public Future<CreateAutoPredictorResult> createAutoPredictorAsync(CreateAutoPredictorRequest request, AsyncHandler<CreateAutoPredictorRequest,CreateAutoPredictorResult> asyncHandler)
AmazonForecastAsync
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
.
createAutoPredictorAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateDatasetResult> createDatasetAsync(CreateDatasetRequest request)
AmazonForecastAsync
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.
createDatasetAsync
in interface AmazonForecastAsync
public Future<CreateDatasetResult> createDatasetAsync(CreateDatasetRequest request, AsyncHandler<CreateDatasetRequest,CreateDatasetResult> asyncHandler)
AmazonForecastAsync
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.
createDatasetAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateDatasetGroupResult> createDatasetGroupAsync(CreateDatasetGroupRequest request)
AmazonForecastAsync
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.
createDatasetGroupAsync
in interface AmazonForecastAsync
public Future<CreateDatasetGroupResult> createDatasetGroupAsync(CreateDatasetGroupRequest request, AsyncHandler<CreateDatasetGroupRequest,CreateDatasetGroupResult> asyncHandler)
AmazonForecastAsync
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.
createDatasetGroupAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateDatasetImportJobResult> createDatasetImportJobAsync(CreateDatasetImportJobRequest request)
AmazonForecastAsync
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.
createDatasetImportJobAsync
in interface AmazonForecastAsync
public Future<CreateDatasetImportJobResult> createDatasetImportJobAsync(CreateDatasetImportJobRequest request, AsyncHandler<CreateDatasetImportJobRequest,CreateDatasetImportJobResult> asyncHandler)
AmazonForecastAsync
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.
createDatasetImportJobAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateExplainabilityResult> createExplainabilityAsync(CreateExplainabilityRequest request)
AmazonForecastAsync
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.
createExplainabilityAsync
in interface AmazonForecastAsync
public Future<CreateExplainabilityResult> createExplainabilityAsync(CreateExplainabilityRequest request, AsyncHandler<CreateExplainabilityRequest,CreateExplainabilityResult> asyncHandler)
AmazonForecastAsync
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.
createExplainabilityAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateExplainabilityExportResult> createExplainabilityExportAsync(CreateExplainabilityExportRequest request)
AmazonForecastAsync
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.
createExplainabilityExportAsync
in interface AmazonForecastAsync
public Future<CreateExplainabilityExportResult> createExplainabilityExportAsync(CreateExplainabilityExportRequest request, AsyncHandler<CreateExplainabilityExportRequest,CreateExplainabilityExportResult> asyncHandler)
AmazonForecastAsync
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.
createExplainabilityExportAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateForecastResult> createForecastAsync(CreateForecastRequest request)
AmazonForecastAsync
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.
createForecastAsync
in interface AmazonForecastAsync
public Future<CreateForecastResult> createForecastAsync(CreateForecastRequest request, AsyncHandler<CreateForecastRequest,CreateForecastResult> asyncHandler)
AmazonForecastAsync
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.
createForecastAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateForecastExportJobResult> createForecastExportJobAsync(CreateForecastExportJobRequest request)
AmazonForecastAsync
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.
createForecastExportJobAsync
in interface AmazonForecastAsync
public Future<CreateForecastExportJobResult> createForecastExportJobAsync(CreateForecastExportJobRequest request, AsyncHandler<CreateForecastExportJobRequest,CreateForecastExportJobResult> asyncHandler)
AmazonForecastAsync
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.
createForecastExportJobAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateMonitorResult> createMonitorAsync(CreateMonitorRequest request)
AmazonForecastAsync
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.
createMonitorAsync
in interface AmazonForecastAsync
public Future<CreateMonitorResult> createMonitorAsync(CreateMonitorRequest request, AsyncHandler<CreateMonitorRequest,CreateMonitorResult> asyncHandler)
AmazonForecastAsync
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.
createMonitorAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreatePredictorResult> createPredictorAsync(CreatePredictorRequest request)
AmazonForecastAsync
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.
createPredictorAsync
in interface AmazonForecastAsync
public Future<CreatePredictorResult> createPredictorAsync(CreatePredictorRequest request, AsyncHandler<CreatePredictorRequest,CreatePredictorResult> asyncHandler)
AmazonForecastAsync
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.
createPredictorAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreatePredictorBacktestExportJobResult> createPredictorBacktestExportJobAsync(CreatePredictorBacktestExportJobRequest request)
AmazonForecastAsync
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.
createPredictorBacktestExportJobAsync
in interface AmazonForecastAsync
public Future<CreatePredictorBacktestExportJobResult> createPredictorBacktestExportJobAsync(CreatePredictorBacktestExportJobRequest request, AsyncHandler<CreatePredictorBacktestExportJobRequest,CreatePredictorBacktestExportJobResult> asyncHandler)
AmazonForecastAsync
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.
createPredictorBacktestExportJobAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateWhatIfAnalysisResult> createWhatIfAnalysisAsync(CreateWhatIfAnalysisRequest request)
AmazonForecastAsync
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.
createWhatIfAnalysisAsync
in interface AmazonForecastAsync
public Future<CreateWhatIfAnalysisResult> createWhatIfAnalysisAsync(CreateWhatIfAnalysisRequest request, AsyncHandler<CreateWhatIfAnalysisRequest,CreateWhatIfAnalysisResult> asyncHandler)
AmazonForecastAsync
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.
createWhatIfAnalysisAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateWhatIfForecastResult> createWhatIfForecastAsync(CreateWhatIfForecastRequest request)
AmazonForecastAsync
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.
createWhatIfForecastAsync
in interface AmazonForecastAsync
public Future<CreateWhatIfForecastResult> createWhatIfForecastAsync(CreateWhatIfForecastRequest request, AsyncHandler<CreateWhatIfForecastRequest,CreateWhatIfForecastResult> asyncHandler)
AmazonForecastAsync
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.
createWhatIfForecastAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateWhatIfForecastExportResult> createWhatIfForecastExportAsync(CreateWhatIfForecastExportRequest request)
AmazonForecastAsync
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.
createWhatIfForecastExportAsync
in interface AmazonForecastAsync
public Future<CreateWhatIfForecastExportResult> createWhatIfForecastExportAsync(CreateWhatIfForecastExportRequest request, AsyncHandler<CreateWhatIfForecastExportRequest,CreateWhatIfForecastExportResult> asyncHandler)
AmazonForecastAsync
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.
createWhatIfForecastExportAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteDatasetResult> deleteDatasetAsync(DeleteDatasetRequest request)
AmazonForecastAsync
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.
deleteDatasetAsync
in interface AmazonForecastAsync
public Future<DeleteDatasetResult> deleteDatasetAsync(DeleteDatasetRequest request, AsyncHandler<DeleteDatasetRequest,DeleteDatasetResult> asyncHandler)
AmazonForecastAsync
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.
deleteDatasetAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteDatasetGroupResult> deleteDatasetGroupAsync(DeleteDatasetGroupRequest request)
AmazonForecastAsync
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.
deleteDatasetGroupAsync
in interface AmazonForecastAsync
public Future<DeleteDatasetGroupResult> deleteDatasetGroupAsync(DeleteDatasetGroupRequest request, AsyncHandler<DeleteDatasetGroupRequest,DeleteDatasetGroupResult> asyncHandler)
AmazonForecastAsync
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.
deleteDatasetGroupAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteDatasetImportJobResult> deleteDatasetImportJobAsync(DeleteDatasetImportJobRequest request)
AmazonForecastAsync
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.
deleteDatasetImportJobAsync
in interface AmazonForecastAsync
public Future<DeleteDatasetImportJobResult> deleteDatasetImportJobAsync(DeleteDatasetImportJobRequest request, AsyncHandler<DeleteDatasetImportJobRequest,DeleteDatasetImportJobResult> asyncHandler)
AmazonForecastAsync
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.
deleteDatasetImportJobAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteExplainabilityResult> deleteExplainabilityAsync(DeleteExplainabilityRequest request)
AmazonForecastAsync
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.
deleteExplainabilityAsync
in interface AmazonForecastAsync
public Future<DeleteExplainabilityResult> deleteExplainabilityAsync(DeleteExplainabilityRequest request, AsyncHandler<DeleteExplainabilityRequest,DeleteExplainabilityResult> asyncHandler)
AmazonForecastAsync
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.
deleteExplainabilityAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteExplainabilityExportResult> deleteExplainabilityExportAsync(DeleteExplainabilityExportRequest request)
AmazonForecastAsync
Deletes an Explainability export.
deleteExplainabilityExportAsync
in interface AmazonForecastAsync
public Future<DeleteExplainabilityExportResult> deleteExplainabilityExportAsync(DeleteExplainabilityExportRequest request, AsyncHandler<DeleteExplainabilityExportRequest,DeleteExplainabilityExportResult> asyncHandler)
AmazonForecastAsync
Deletes an Explainability export.
deleteExplainabilityExportAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteForecastResult> deleteForecastAsync(DeleteForecastRequest request)
AmazonForecastAsync
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.
deleteForecastAsync
in interface AmazonForecastAsync
public Future<DeleteForecastResult> deleteForecastAsync(DeleteForecastRequest request, AsyncHandler<DeleteForecastRequest,DeleteForecastResult> asyncHandler)
AmazonForecastAsync
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.
deleteForecastAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteForecastExportJobResult> deleteForecastExportJobAsync(DeleteForecastExportJobRequest request)
AmazonForecastAsync
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.
deleteForecastExportJobAsync
in interface AmazonForecastAsync
public Future<DeleteForecastExportJobResult> deleteForecastExportJobAsync(DeleteForecastExportJobRequest request, AsyncHandler<DeleteForecastExportJobRequest,DeleteForecastExportJobResult> asyncHandler)
AmazonForecastAsync
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.
deleteForecastExportJobAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteMonitorResult> deleteMonitorAsync(DeleteMonitorRequest request)
AmazonForecastAsync
Deletes a monitor resource. You can only delete a monitor resource with a status of ACTIVE
,
ACTIVE_STOPPED
, CREATE_FAILED
, or CREATE_STOPPED
.
deleteMonitorAsync
in interface AmazonForecastAsync
public Future<DeleteMonitorResult> deleteMonitorAsync(DeleteMonitorRequest request, AsyncHandler<DeleteMonitorRequest,DeleteMonitorResult> asyncHandler)
AmazonForecastAsync
Deletes a monitor resource. You can only delete a monitor resource with a status of ACTIVE
,
ACTIVE_STOPPED
, CREATE_FAILED
, or CREATE_STOPPED
.
deleteMonitorAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeletePredictorResult> deletePredictorAsync(DeletePredictorRequest request)
AmazonForecastAsync
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.
deletePredictorAsync
in interface AmazonForecastAsync
public Future<DeletePredictorResult> deletePredictorAsync(DeletePredictorRequest request, AsyncHandler<DeletePredictorRequest,DeletePredictorResult> asyncHandler)
AmazonForecastAsync
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.
deletePredictorAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeletePredictorBacktestExportJobResult> deletePredictorBacktestExportJobAsync(DeletePredictorBacktestExportJobRequest request)
AmazonForecastAsync
Deletes a predictor backtest export job.
deletePredictorBacktestExportJobAsync
in interface AmazonForecastAsync
public Future<DeletePredictorBacktestExportJobResult> deletePredictorBacktestExportJobAsync(DeletePredictorBacktestExportJobRequest request, AsyncHandler<DeletePredictorBacktestExportJobRequest,DeletePredictorBacktestExportJobResult> asyncHandler)
AmazonForecastAsync
Deletes a predictor backtest export job.
deletePredictorBacktestExportJobAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteResourceTreeResult> deleteResourceTreeAsync(DeleteResourceTreeRequest request)
AmazonForecastAsync
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.
deleteResourceTreeAsync
in interface AmazonForecastAsync
public Future<DeleteResourceTreeResult> deleteResourceTreeAsync(DeleteResourceTreeRequest request, AsyncHandler<DeleteResourceTreeRequest,DeleteResourceTreeResult> asyncHandler)
AmazonForecastAsync
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.
deleteResourceTreeAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteWhatIfAnalysisResult> deleteWhatIfAnalysisAsync(DeleteWhatIfAnalysisRequest request)
AmazonForecastAsync
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.
deleteWhatIfAnalysisAsync
in interface AmazonForecastAsync
public Future<DeleteWhatIfAnalysisResult> deleteWhatIfAnalysisAsync(DeleteWhatIfAnalysisRequest request, AsyncHandler<DeleteWhatIfAnalysisRequest,DeleteWhatIfAnalysisResult> asyncHandler)
AmazonForecastAsync
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.
deleteWhatIfAnalysisAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteWhatIfForecastResult> deleteWhatIfForecastAsync(DeleteWhatIfForecastRequest request)
AmazonForecastAsync
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.
deleteWhatIfForecastAsync
in interface AmazonForecastAsync
public Future<DeleteWhatIfForecastResult> deleteWhatIfForecastAsync(DeleteWhatIfForecastRequest request, AsyncHandler<DeleteWhatIfForecastRequest,DeleteWhatIfForecastResult> asyncHandler)
AmazonForecastAsync
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.
deleteWhatIfForecastAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteWhatIfForecastExportResult> deleteWhatIfForecastExportAsync(DeleteWhatIfForecastExportRequest request)
AmazonForecastAsync
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.
deleteWhatIfForecastExportAsync
in interface AmazonForecastAsync
public Future<DeleteWhatIfForecastExportResult> deleteWhatIfForecastExportAsync(DeleteWhatIfForecastExportRequest request, AsyncHandler<DeleteWhatIfForecastExportRequest,DeleteWhatIfForecastExportResult> asyncHandler)
AmazonForecastAsync
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.
deleteWhatIfForecastExportAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeAutoPredictorResult> describeAutoPredictorAsync(DescribeAutoPredictorRequest request)
AmazonForecastAsync
Describes a predictor created using the CreateAutoPredictor operation.
describeAutoPredictorAsync
in interface AmazonForecastAsync
public Future<DescribeAutoPredictorResult> describeAutoPredictorAsync(DescribeAutoPredictorRequest request, AsyncHandler<DescribeAutoPredictorRequest,DescribeAutoPredictorResult> asyncHandler)
AmazonForecastAsync
Describes a predictor created using the CreateAutoPredictor operation.
describeAutoPredictorAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDatasetResult> describeDatasetAsync(DescribeDatasetRequest request)
AmazonForecastAsync
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
describeDatasetAsync
in interface AmazonForecastAsync
public Future<DescribeDatasetResult> describeDatasetAsync(DescribeDatasetRequest request, AsyncHandler<DescribeDatasetRequest,DescribeDatasetResult> asyncHandler)
AmazonForecastAsync
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
describeDatasetAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDatasetGroupResult> describeDatasetGroupAsync(DescribeDatasetGroupRequest request)
AmazonForecastAsync
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
describeDatasetGroupAsync
in interface AmazonForecastAsync
public Future<DescribeDatasetGroupResult> describeDatasetGroupAsync(DescribeDatasetGroupRequest request, AsyncHandler<DescribeDatasetGroupRequest,DescribeDatasetGroupResult> asyncHandler)
AmazonForecastAsync
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
describeDatasetGroupAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDatasetImportJobResult> describeDatasetImportJobAsync(DescribeDatasetImportJobRequest request)
AmazonForecastAsync
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.
describeDatasetImportJobAsync
in interface AmazonForecastAsync
public Future<DescribeDatasetImportJobResult> describeDatasetImportJobAsync(DescribeDatasetImportJobRequest request, AsyncHandler<DescribeDatasetImportJobRequest,DescribeDatasetImportJobResult> asyncHandler)
AmazonForecastAsync
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.
describeDatasetImportJobAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeExplainabilityResult> describeExplainabilityAsync(DescribeExplainabilityRequest request)
AmazonForecastAsync
Describes an Explainability resource created using the CreateExplainability operation.
describeExplainabilityAsync
in interface AmazonForecastAsync
public Future<DescribeExplainabilityResult> describeExplainabilityAsync(DescribeExplainabilityRequest request, AsyncHandler<DescribeExplainabilityRequest,DescribeExplainabilityResult> asyncHandler)
AmazonForecastAsync
Describes an Explainability resource created using the CreateExplainability operation.
describeExplainabilityAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeExplainabilityExportResult> describeExplainabilityExportAsync(DescribeExplainabilityExportRequest request)
AmazonForecastAsync
Describes an Explainability export created using the CreateExplainabilityExport operation.
describeExplainabilityExportAsync
in interface AmazonForecastAsync
public Future<DescribeExplainabilityExportResult> describeExplainabilityExportAsync(DescribeExplainabilityExportRequest request, AsyncHandler<DescribeExplainabilityExportRequest,DescribeExplainabilityExportResult> asyncHandler)
AmazonForecastAsync
Describes an Explainability export created using the CreateExplainabilityExport operation.
describeExplainabilityExportAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeForecastResult> describeForecastAsync(DescribeForecastRequest request)
AmazonForecastAsync
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.
describeForecastAsync
in interface AmazonForecastAsync
public Future<DescribeForecastResult> describeForecastAsync(DescribeForecastRequest request, AsyncHandler<DescribeForecastRequest,DescribeForecastResult> asyncHandler)
AmazonForecastAsync
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.
describeForecastAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeForecastExportJobResult> describeForecastExportJobAsync(DescribeForecastExportJobRequest request)
AmazonForecastAsync
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.
describeForecastExportJobAsync
in interface AmazonForecastAsync
public Future<DescribeForecastExportJobResult> describeForecastExportJobAsync(DescribeForecastExportJobRequest request, AsyncHandler<DescribeForecastExportJobRequest,DescribeForecastExportJobResult> asyncHandler)
AmazonForecastAsync
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.
describeForecastExportJobAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeMonitorResult> describeMonitorAsync(DescribeMonitorRequest request)
AmazonForecastAsync
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
describeMonitorAsync
in interface AmazonForecastAsync
public Future<DescribeMonitorResult> describeMonitorAsync(DescribeMonitorRequest request, AsyncHandler<DescribeMonitorRequest,DescribeMonitorResult> asyncHandler)
AmazonForecastAsync
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
describeMonitorAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribePredictorResult> describePredictorAsync(DescribePredictorRequest request)
AmazonForecastAsync
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.
describePredictorAsync
in interface AmazonForecastAsync
public Future<DescribePredictorResult> describePredictorAsync(DescribePredictorRequest request, AsyncHandler<DescribePredictorRequest,DescribePredictorResult> asyncHandler)
AmazonForecastAsync
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.
describePredictorAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribePredictorBacktestExportJobResult> describePredictorBacktestExportJobAsync(DescribePredictorBacktestExportJobRequest request)
AmazonForecastAsync
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)
describePredictorBacktestExportJobAsync
in interface AmazonForecastAsync
public Future<DescribePredictorBacktestExportJobResult> describePredictorBacktestExportJobAsync(DescribePredictorBacktestExportJobRequest request, AsyncHandler<DescribePredictorBacktestExportJobRequest,DescribePredictorBacktestExportJobResult> asyncHandler)
AmazonForecastAsync
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)
describePredictorBacktestExportJobAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeWhatIfAnalysisResult> describeWhatIfAnalysisAsync(DescribeWhatIfAnalysisRequest request)
AmazonForecastAsync
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
describeWhatIfAnalysisAsync
in interface AmazonForecastAsync
public Future<DescribeWhatIfAnalysisResult> describeWhatIfAnalysisAsync(DescribeWhatIfAnalysisRequest request, AsyncHandler<DescribeWhatIfAnalysisRequest,DescribeWhatIfAnalysisResult> asyncHandler)
AmazonForecastAsync
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
describeWhatIfAnalysisAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeWhatIfForecastResult> describeWhatIfForecastAsync(DescribeWhatIfForecastRequest request)
AmazonForecastAsync
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
describeWhatIfForecastAsync
in interface AmazonForecastAsync
public Future<DescribeWhatIfForecastResult> describeWhatIfForecastAsync(DescribeWhatIfForecastRequest request, AsyncHandler<DescribeWhatIfForecastRequest,DescribeWhatIfForecastResult> asyncHandler)
AmazonForecastAsync
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
describeWhatIfForecastAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeWhatIfForecastExportResult> describeWhatIfForecastExportAsync(DescribeWhatIfForecastExportRequest request)
AmazonForecastAsync
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
describeWhatIfForecastExportAsync
in interface AmazonForecastAsync
public Future<DescribeWhatIfForecastExportResult> describeWhatIfForecastExportAsync(DescribeWhatIfForecastExportRequest request, AsyncHandler<DescribeWhatIfForecastExportRequest,DescribeWhatIfForecastExportResult> asyncHandler)
AmazonForecastAsync
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
describeWhatIfForecastExportAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetAccuracyMetricsResult> getAccuracyMetricsAsync(GetAccuracyMetricsRequest request)
AmazonForecastAsync
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.
getAccuracyMetricsAsync
in interface AmazonForecastAsync
public Future<GetAccuracyMetricsResult> getAccuracyMetricsAsync(GetAccuracyMetricsRequest request, AsyncHandler<GetAccuracyMetricsRequest,GetAccuracyMetricsResult> asyncHandler)
AmazonForecastAsync
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.
getAccuracyMetricsAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListDatasetGroupsResult> listDatasetGroupsAsync(ListDatasetGroupsRequest request)
AmazonForecastAsync
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.
listDatasetGroupsAsync
in interface AmazonForecastAsync
public Future<ListDatasetGroupsResult> listDatasetGroupsAsync(ListDatasetGroupsRequest request, AsyncHandler<ListDatasetGroupsRequest,ListDatasetGroupsResult> asyncHandler)
AmazonForecastAsync
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.
listDatasetGroupsAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListDatasetImportJobsResult> listDatasetImportJobsAsync(ListDatasetImportJobsRequest request)
AmazonForecastAsync
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.
listDatasetImportJobsAsync
in interface AmazonForecastAsync
public Future<ListDatasetImportJobsResult> listDatasetImportJobsAsync(ListDatasetImportJobsRequest request, AsyncHandler<ListDatasetImportJobsRequest,ListDatasetImportJobsResult> asyncHandler)
AmazonForecastAsync
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.
listDatasetImportJobsAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListDatasetsResult> listDatasetsAsync(ListDatasetsRequest request)
AmazonForecastAsync
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.
listDatasetsAsync
in interface AmazonForecastAsync
public Future<ListDatasetsResult> listDatasetsAsync(ListDatasetsRequest request, AsyncHandler<ListDatasetsRequest,ListDatasetsResult> asyncHandler)
AmazonForecastAsync
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.
listDatasetsAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListExplainabilitiesResult> listExplainabilitiesAsync(ListExplainabilitiesRequest request)
AmazonForecastAsync
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.
listExplainabilitiesAsync
in interface AmazonForecastAsync
public Future<ListExplainabilitiesResult> listExplainabilitiesAsync(ListExplainabilitiesRequest request, AsyncHandler<ListExplainabilitiesRequest,ListExplainabilitiesResult> asyncHandler)
AmazonForecastAsync
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.
listExplainabilitiesAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListExplainabilityExportsResult> listExplainabilityExportsAsync(ListExplainabilityExportsRequest request)
AmazonForecastAsync
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.
listExplainabilityExportsAsync
in interface AmazonForecastAsync
public Future<ListExplainabilityExportsResult> listExplainabilityExportsAsync(ListExplainabilityExportsRequest request, AsyncHandler<ListExplainabilityExportsRequest,ListExplainabilityExportsResult> asyncHandler)
AmazonForecastAsync
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.
listExplainabilityExportsAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListForecastExportJobsResult> listForecastExportJobsAsync(ListForecastExportJobsRequest request)
AmazonForecastAsync
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.
listForecastExportJobsAsync
in interface AmazonForecastAsync
public Future<ListForecastExportJobsResult> listForecastExportJobsAsync(ListForecastExportJobsRequest request, AsyncHandler<ListForecastExportJobsRequest,ListForecastExportJobsResult> asyncHandler)
AmazonForecastAsync
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.
listForecastExportJobsAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListForecastsResult> listForecastsAsync(ListForecastsRequest request)
AmazonForecastAsync
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.
listForecastsAsync
in interface AmazonForecastAsync
public Future<ListForecastsResult> listForecastsAsync(ListForecastsRequest request, AsyncHandler<ListForecastsRequest,ListForecastsResult> asyncHandler)
AmazonForecastAsync
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.
listForecastsAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListMonitorEvaluationsResult> listMonitorEvaluationsAsync(ListMonitorEvaluationsRequest request)
AmazonForecastAsync
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.
listMonitorEvaluationsAsync
in interface AmazonForecastAsync
public Future<ListMonitorEvaluationsResult> listMonitorEvaluationsAsync(ListMonitorEvaluationsRequest request, AsyncHandler<ListMonitorEvaluationsRequest,ListMonitorEvaluationsResult> asyncHandler)
AmazonForecastAsync
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.
listMonitorEvaluationsAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListMonitorsResult> listMonitorsAsync(ListMonitorsRequest request)
AmazonForecastAsync
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.
listMonitorsAsync
in interface AmazonForecastAsync
public Future<ListMonitorsResult> listMonitorsAsync(ListMonitorsRequest request, AsyncHandler<ListMonitorsRequest,ListMonitorsResult> asyncHandler)
AmazonForecastAsync
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.
listMonitorsAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListPredictorBacktestExportJobsResult> listPredictorBacktestExportJobsAsync(ListPredictorBacktestExportJobsRequest request)
AmazonForecastAsync
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.
listPredictorBacktestExportJobsAsync
in interface AmazonForecastAsync
public Future<ListPredictorBacktestExportJobsResult> listPredictorBacktestExportJobsAsync(ListPredictorBacktestExportJobsRequest request, AsyncHandler<ListPredictorBacktestExportJobsRequest,ListPredictorBacktestExportJobsResult> asyncHandler)
AmazonForecastAsync
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.
listPredictorBacktestExportJobsAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListPredictorsResult> listPredictorsAsync(ListPredictorsRequest request)
AmazonForecastAsync
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.
listPredictorsAsync
in interface AmazonForecastAsync
public Future<ListPredictorsResult> listPredictorsAsync(ListPredictorsRequest request, AsyncHandler<ListPredictorsRequest,ListPredictorsResult> asyncHandler)
AmazonForecastAsync
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.
listPredictorsAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AmazonForecastAsync
Lists the tags for an Amazon Forecast resource.
listTagsForResourceAsync
in interface AmazonForecastAsync
public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AmazonForecastAsync
Lists the tags for an Amazon Forecast resource.
listTagsForResourceAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListWhatIfAnalysesResult> listWhatIfAnalysesAsync(ListWhatIfAnalysesRequest request)
AmazonForecastAsync
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.
listWhatIfAnalysesAsync
in interface AmazonForecastAsync
public Future<ListWhatIfAnalysesResult> listWhatIfAnalysesAsync(ListWhatIfAnalysesRequest request, AsyncHandler<ListWhatIfAnalysesRequest,ListWhatIfAnalysesResult> asyncHandler)
AmazonForecastAsync
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.
listWhatIfAnalysesAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListWhatIfForecastExportsResult> listWhatIfForecastExportsAsync(ListWhatIfForecastExportsRequest request)
AmazonForecastAsync
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.
listWhatIfForecastExportsAsync
in interface AmazonForecastAsync
public Future<ListWhatIfForecastExportsResult> listWhatIfForecastExportsAsync(ListWhatIfForecastExportsRequest request, AsyncHandler<ListWhatIfForecastExportsRequest,ListWhatIfForecastExportsResult> asyncHandler)
AmazonForecastAsync
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.
listWhatIfForecastExportsAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListWhatIfForecastsResult> listWhatIfForecastsAsync(ListWhatIfForecastsRequest request)
AmazonForecastAsync
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.
listWhatIfForecastsAsync
in interface AmazonForecastAsync
public Future<ListWhatIfForecastsResult> listWhatIfForecastsAsync(ListWhatIfForecastsRequest request, AsyncHandler<ListWhatIfForecastsRequest,ListWhatIfForecastsResult> asyncHandler)
AmazonForecastAsync
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.
listWhatIfForecastsAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ResumeResourceResult> resumeResourceAsync(ResumeResourceRequest request)
AmazonForecastAsync
Resumes a stopped monitor resource.
resumeResourceAsync
in interface AmazonForecastAsync
public Future<ResumeResourceResult> resumeResourceAsync(ResumeResourceRequest request, AsyncHandler<ResumeResourceRequest,ResumeResourceResult> asyncHandler)
AmazonForecastAsync
Resumes a stopped monitor resource.
resumeResourceAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StopResourceResult> stopResourceAsync(StopResourceRequest request)
AmazonForecastAsync
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
stopResourceAsync
in interface AmazonForecastAsync
public Future<StopResourceResult> stopResourceAsync(StopResourceRequest request, AsyncHandler<StopResourceRequest,StopResourceResult> asyncHandler)
AmazonForecastAsync
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
stopResourceAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AmazonForecastAsync
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.
tagResourceAsync
in interface AmazonForecastAsync
public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AmazonForecastAsync
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.
tagResourceAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AmazonForecastAsync
Deletes the specified tags from a resource.
untagResourceAsync
in interface AmazonForecastAsync
public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AmazonForecastAsync
Deletes the specified tags from a resource.
untagResourceAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateDatasetGroupResult> updateDatasetGroupAsync(UpdateDatasetGroupRequest request)
AmazonForecastAsync
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.
updateDatasetGroupAsync
in interface AmazonForecastAsync
public Future<UpdateDatasetGroupResult> updateDatasetGroupAsync(UpdateDatasetGroupRequest request, AsyncHandler<UpdateDatasetGroupRequest,UpdateDatasetGroupResult> asyncHandler)
AmazonForecastAsync
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.
updateDatasetGroupAsync
in interface AmazonForecastAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown()
followed by getExecutorService().awaitTermination()
prior to
calling this method.shutdown
in interface AmazonForecast
shutdown
in class AmazonForecastClient