@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonForecastAsync extends AmazonForecast
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonForecastAsync instead.
Provides APIs for creating and managing Amazon Forecast resources.
ENDPOINT_PREFIXcreateDataset, createDatasetGroup, createDatasetImportJob, createForecast, createForecastExportJob, createPredictor, deleteDataset, deleteDatasetGroup, deleteDatasetImportJob, deleteForecast, deleteForecastExportJob, deletePredictor, describeDataset, describeDatasetGroup, describeDatasetImportJob, describeForecast, describeForecastExportJob, describePredictor, getAccuracyMetrics, getCachedResponseMetadata, listDatasetGroups, listDatasetImportJobs, listDatasets, listForecastExportJobs, listForecasts, listPredictors, shutdown, updateDatasetGroupFuture<CreateDatasetResult> createDatasetAsync(CreateDatasetRequest createDatasetRequest)
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 howitworks-datasets-groups.
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.
createDatasetRequest - Future<CreateDatasetResult> createDatasetAsync(CreateDatasetRequest createDatasetRequest, AsyncHandler<CreateDatasetRequest,CreateDatasetResult> asyncHandler)
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 howitworks-datasets-groups.
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.
createDatasetRequest - 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.Future<CreateDatasetGroupResult> createDatasetGroupAsync(CreateDatasetGroupRequest createDatasetGroupRequest)
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 howitworks-datasets-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 create use the dataset
group to create a predictor. To get the status, use the DescribeDatasetGroup operation.
createDatasetGroupRequest - Future<CreateDatasetGroupResult> createDatasetGroupAsync(CreateDatasetGroupRequest createDatasetGroupRequest, AsyncHandler<CreateDatasetGroupRequest,CreateDatasetGroupResult> asyncHandler)
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 howitworks-datasets-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 create use the dataset
group to create a predictor. To get the status, use the DescribeDatasetGroup operation.
createDatasetGroupRequest - 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.Future<CreateDatasetImportJobResult> createDatasetImportJobAsync(CreateDatasetImportJobRequest createDatasetImportJobRequest)
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 AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data. For more information, see aws-forecast-iam-roles.
The training data must be in CSV format. The delimiter must be a comma (,).
You can specify the path to a specific CSV 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.
To get a list of all your dataset import jobs, filtered by specified criteria, use the ListDatasetImportJobs operation.
createDatasetImportJobRequest - Future<CreateDatasetImportJobResult> createDatasetImportJobAsync(CreateDatasetImportJobRequest createDatasetImportJobRequest, AsyncHandler<CreateDatasetImportJobRequest,CreateDatasetImportJobResult> asyncHandler)
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 AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data. For more information, see aws-forecast-iam-roles.
The training data must be in CSV format. The delimiter must be a comma (,).
You can specify the path to a specific CSV 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.
To get a list of all your dataset import jobs, filtered by specified criteria, use the ListDatasetImportJobs operation.
createDatasetImportJobRequest - 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.Future<CreateForecastResult> createForecastAsync(CreateForecastRequest createForecastRequest)
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, multiplied by the DataFrequency value, which you specify in the
CreateDataset 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.
createForecastRequest - Future<CreateForecastResult> createForecastAsync(CreateForecastRequest createForecastRequest, AsyncHandler<CreateForecastRequest,CreateForecastResult> asyncHandler)
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, multiplied by the DataFrequency value, which you specify in the
CreateDataset 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.
createForecastRequest - 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.Future<CreateForecastExportJobResult> createForecastExportJobAsync(CreateForecastExportJobRequest createForecastExportJobRequest)
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>_<PageNumber>
where the <ExportTimestamp> component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).
You must specify a DataDestination object that includes an AWS 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.
createForecastExportJobRequest - Future<CreateForecastExportJobResult> createForecastExportJobAsync(CreateForecastExportJobRequest createForecastExportJobRequest, AsyncHandler<CreateForecastExportJobRequest,CreateForecastExportJobResult> asyncHandler)
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>_<PageNumber>
where the <ExportTimestamp> component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).
You must specify a DataDestination object that includes an AWS 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.
createForecastExportJobRequest - 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.Future<CreatePredictorResult> createPredictorAsync(CreatePredictorRequest createPredictorRequest)
Creates an Amazon Forecast predictor.
In the request, you provide a dataset group and either specify an algorithm or let Amazon Forecast choose the algorithm for you using AutoML. If you specify an algorithm, you also can override algorithm-specific hyperparameters.
Amazon Forecast uses the chosen algorithm to train a model using the latest version of the datasets in the specified dataset group. The result is called a predictor. You then generate a forecast using the CreateForecast operation.
After training a model, the CreatePredictor operation also evaluates it. To see the evaluation
metrics, use the GetAccuracyMetrics operation. Always review the evaluation metrics before deciding to use
the predictor to generate a forecast.
Optionally, 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.
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 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.
createPredictorRequest - Future<CreatePredictorResult> createPredictorAsync(CreatePredictorRequest createPredictorRequest, AsyncHandler<CreatePredictorRequest,CreatePredictorResult> asyncHandler)
Creates an Amazon Forecast predictor.
In the request, you provide a dataset group and either specify an algorithm or let Amazon Forecast choose the algorithm for you using AutoML. If you specify an algorithm, you also can override algorithm-specific hyperparameters.
Amazon Forecast uses the chosen algorithm to train a model using the latest version of the datasets in the specified dataset group. The result is called a predictor. You then generate a forecast using the CreateForecast operation.
After training a model, the CreatePredictor operation also evaluates it. To see the evaluation
metrics, use the GetAccuracyMetrics operation. Always review the evaluation metrics before deciding to use
the predictor to generate a forecast.
Optionally, 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.
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 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.
createPredictorRequest - 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.Future<DeleteDatasetResult> deleteDatasetAsync(DeleteDatasetRequest deleteDatasetRequest)
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.
deleteDatasetRequest - Future<DeleteDatasetResult> deleteDatasetAsync(DeleteDatasetRequest deleteDatasetRequest, AsyncHandler<DeleteDatasetRequest,DeleteDatasetResult> asyncHandler)
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.
deleteDatasetRequest - 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.Future<DeleteDatasetGroupResult> deleteDatasetGroupAsync(DeleteDatasetGroupRequest deleteDatasetGroupRequest)
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.
deleteDatasetGroupRequest - Future<DeleteDatasetGroupResult> deleteDatasetGroupAsync(DeleteDatasetGroupRequest deleteDatasetGroupRequest, AsyncHandler<DeleteDatasetGroupRequest,DeleteDatasetGroupResult> asyncHandler)
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.
deleteDatasetGroupRequest - 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.Future<DeleteDatasetImportJobResult> deleteDatasetImportJobAsync(DeleteDatasetImportJobRequest deleteDatasetImportJobRequest)
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.
deleteDatasetImportJobRequest - Future<DeleteDatasetImportJobResult> deleteDatasetImportJobAsync(DeleteDatasetImportJobRequest deleteDatasetImportJobRequest, AsyncHandler<DeleteDatasetImportJobRequest,DeleteDatasetImportJobResult> asyncHandler)
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.
deleteDatasetImportJobRequest - 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.Future<DeleteForecastResult> deleteForecastAsync(DeleteForecastRequest deleteForecastRequest)
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.
deleteForecastRequest - Future<DeleteForecastResult> deleteForecastAsync(DeleteForecastRequest deleteForecastRequest, AsyncHandler<DeleteForecastRequest,DeleteForecastResult> asyncHandler)
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.
deleteForecastRequest - 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.Future<DeleteForecastExportJobResult> deleteForecastExportJobAsync(DeleteForecastExportJobRequest deleteForecastExportJobRequest)
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.
deleteForecastExportJobRequest - Future<DeleteForecastExportJobResult> deleteForecastExportJobAsync(DeleteForecastExportJobRequest deleteForecastExportJobRequest, AsyncHandler<DeleteForecastExportJobRequest,DeleteForecastExportJobResult> asyncHandler)
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.
deleteForecastExportJobRequest - 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.Future<DeletePredictorResult> deletePredictorAsync(DeletePredictorRequest deletePredictorRequest)
Deletes a predictor created using the CreatePredictor operation. You can delete only predictor that have a
status of ACTIVE or CREATE_FAILED. To get the status, use the DescribePredictor
operation.
deletePredictorRequest - Future<DeletePredictorResult> deletePredictorAsync(DeletePredictorRequest deletePredictorRequest, AsyncHandler<DeletePredictorRequest,DeletePredictorResult> asyncHandler)
Deletes a predictor created using the CreatePredictor operation. You can delete only predictor that have a
status of ACTIVE or CREATE_FAILED. To get the status, use the DescribePredictor
operation.
deletePredictorRequest - 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.Future<DescribeDatasetResult> describeDatasetAsync(DescribeDatasetRequest describeDatasetRequest)
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
describeDatasetRequest - Future<DescribeDatasetResult> describeDatasetAsync(DescribeDatasetRequest describeDatasetRequest, AsyncHandler<DescribeDatasetRequest,DescribeDatasetResult> asyncHandler)
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
describeDatasetRequest - 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.Future<DescribeDatasetGroupResult> describeDatasetGroupAsync(DescribeDatasetGroupRequest describeDatasetGroupRequest)
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
describeDatasetGroupRequest - Future<DescribeDatasetGroupResult> describeDatasetGroupAsync(DescribeDatasetGroupRequest describeDatasetGroupRequest, AsyncHandler<DescribeDatasetGroupRequest,DescribeDatasetGroupResult> asyncHandler)
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
describeDatasetGroupRequest - 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.Future<DescribeDatasetImportJobResult> describeDatasetImportJobAsync(DescribeDatasetImportJobRequest describeDatasetImportJobRequest)
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.
describeDatasetImportJobRequest - Future<DescribeDatasetImportJobResult> describeDatasetImportJobAsync(DescribeDatasetImportJobRequest describeDatasetImportJobRequest, AsyncHandler<DescribeDatasetImportJobRequest,DescribeDatasetImportJobResult> asyncHandler)
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.
describeDatasetImportJobRequest - 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.Future<DescribeForecastResult> describeForecastAsync(DescribeForecastRequest describeForecastRequest)
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.
describeForecastRequest - Future<DescribeForecastResult> describeForecastAsync(DescribeForecastRequest describeForecastRequest, AsyncHandler<DescribeForecastRequest,DescribeForecastResult> asyncHandler)
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.
describeForecastRequest - 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.Future<DescribeForecastExportJobResult> describeForecastExportJobAsync(DescribeForecastExportJobRequest describeForecastExportJobRequest)
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.
describeForecastExportJobRequest - Future<DescribeForecastExportJobResult> describeForecastExportJobAsync(DescribeForecastExportJobRequest describeForecastExportJobRequest, AsyncHandler<DescribeForecastExportJobRequest,DescribeForecastExportJobResult> asyncHandler)
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.
describeForecastExportJobRequest - 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.Future<DescribePredictorResult> describePredictorAsync(DescribePredictorRequest describePredictorRequest)
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.
describePredictorRequest - Future<DescribePredictorResult> describePredictorAsync(DescribePredictorRequest describePredictorRequest, AsyncHandler<DescribePredictorRequest,DescribePredictorResult> asyncHandler)
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.
describePredictorRequest - 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.Future<GetAccuracyMetricsResult> getAccuracyMetricsAsync(GetAccuracyMetricsRequest getAccuracyMetricsRequest)
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 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.
getAccuracyMetricsRequest - Future<GetAccuracyMetricsResult> getAccuracyMetricsAsync(GetAccuracyMetricsRequest getAccuracyMetricsRequest, AsyncHandler<GetAccuracyMetricsRequest,GetAccuracyMetricsResult> asyncHandler)
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 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.
getAccuracyMetricsRequest - 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.Future<ListDatasetGroupsResult> listDatasetGroupsAsync(ListDatasetGroupsRequest listDatasetGroupsRequest)
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.
listDatasetGroupsRequest - Future<ListDatasetGroupsResult> listDatasetGroupsAsync(ListDatasetGroupsRequest listDatasetGroupsRequest, AsyncHandler<ListDatasetGroupsRequest,ListDatasetGroupsResult> asyncHandler)
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.
listDatasetGroupsRequest - 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.Future<ListDatasetImportJobsResult> listDatasetImportJobsAsync(ListDatasetImportJobsRequest listDatasetImportJobsRequest)
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.
listDatasetImportJobsRequest - Future<ListDatasetImportJobsResult> listDatasetImportJobsAsync(ListDatasetImportJobsRequest listDatasetImportJobsRequest, AsyncHandler<ListDatasetImportJobsRequest,ListDatasetImportJobsResult> asyncHandler)
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.
listDatasetImportJobsRequest - 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.Future<ListDatasetsResult> listDatasetsAsync(ListDatasetsRequest listDatasetsRequest)
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.
listDatasetsRequest - Future<ListDatasetsResult> listDatasetsAsync(ListDatasetsRequest listDatasetsRequest, AsyncHandler<ListDatasetsRequest,ListDatasetsResult> asyncHandler)
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.
listDatasetsRequest - 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.Future<ListForecastExportJobsResult> listForecastExportJobsAsync(ListForecastExportJobsRequest listForecastExportJobsRequest)
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.
listForecastExportJobsRequest - Future<ListForecastExportJobsResult> listForecastExportJobsAsync(ListForecastExportJobsRequest listForecastExportJobsRequest, AsyncHandler<ListForecastExportJobsRequest,ListForecastExportJobsResult> asyncHandler)
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.
listForecastExportJobsRequest - 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.Future<ListForecastsResult> listForecastsAsync(ListForecastsRequest listForecastsRequest)
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.
listForecastsRequest - Future<ListForecastsResult> listForecastsAsync(ListForecastsRequest listForecastsRequest, AsyncHandler<ListForecastsRequest,ListForecastsResult> asyncHandler)
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.
listForecastsRequest - 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.Future<ListPredictorsResult> listPredictorsAsync(ListPredictorsRequest listPredictorsRequest)
Returns a list of predictors created using the CreatePredictor operation. For each predictor, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the ARN with the DescribePredictor operation. You can filter the list using an array of Filter objects.
listPredictorsRequest - Future<ListPredictorsResult> listPredictorsAsync(ListPredictorsRequest listPredictorsRequest, AsyncHandler<ListPredictorsRequest,ListPredictorsResult> asyncHandler)
Returns a list of predictors created using the CreatePredictor operation. For each predictor, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the ARN with the DescribePredictor operation. You can filter the list using an array of Filter objects.
listPredictorsRequest - 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.Future<UpdateDatasetGroupResult> updateDatasetGroupAsync(UpdateDatasetGroupRequest updateDatasetGroupRequest)
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.
updateDatasetGroupRequest - Future<UpdateDatasetGroupResult> updateDatasetGroupAsync(UpdateDatasetGroupRequest updateDatasetGroupRequest, AsyncHandler<UpdateDatasetGroupRequest,UpdateDatasetGroupResult> asyncHandler)
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.
updateDatasetGroupRequest - 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.Copyright © 2019. All rights reserved.