@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonForecastClient extends AmazonWebServiceClient implements AmazonForecast
Provides APIs for creating and managing Amazon Forecast resources.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitshutdownpublic static AmazonForecastClientBuilder builder()
public CreateDatasetResult createDataset(CreateDatasetRequest request)
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.
createDataset in interface AmazonForecastcreateDatasetRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceAlreadyExistsException - There is already a resource with this name. Try again with a different name.LimitExceededException - The limit on the number of resources per account has been exceeded.public CreateDatasetGroupResult createDatasetGroup(CreateDatasetGroupRequest request)
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.
createDatasetGroup in interface AmazonForecastcreateDatasetGroupRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceAlreadyExistsException - There is already a resource with this name. Try again with a different name.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.LimitExceededException - The limit on the number of resources per account has been exceeded.public CreateDatasetImportJobResult createDatasetImportJob(CreateDatasetImportJobRequest request)
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.
createDatasetImportJob in interface AmazonForecastcreateDatasetImportJobRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceAlreadyExistsException - There is already a resource with this name. Try again with a different name.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.LimitExceededException - The limit on the number of resources per account has been exceeded.public CreateForecastResult createForecast(CreateForecastRequest request)
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.
createForecast in interface AmazonForecastcreateForecastRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceAlreadyExistsException - There is already a resource with this name. Try again with a different name.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.LimitExceededException - The limit on the number of resources per account has been exceeded.public CreateForecastExportJobResult createForecastExportJob(CreateForecastExportJobRequest request)
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.
createForecastExportJob in interface AmazonForecastcreateForecastExportJobRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceAlreadyExistsException - There is already a resource with this name. Try again with a different name.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.LimitExceededException - The limit on the number of resources per account has been exceeded.public CreatePredictorResult createPredictor(CreatePredictorRequest request)
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.
createPredictor in interface AmazonForecastcreatePredictorRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceAlreadyExistsException - There is already a resource with this name. Try again with a different name.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.LimitExceededException - The limit on the number of resources per account has been exceeded.public DeleteDatasetResult deleteDataset(DeleteDatasetRequest request)
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.
deleteDataset in interface AmazonForecastdeleteDatasetRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.public DeleteDatasetGroupResult deleteDatasetGroup(DeleteDatasetGroupRequest request)
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.
deleteDatasetGroup in interface AmazonForecastdeleteDatasetGroupRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.public DeleteDatasetImportJobResult deleteDatasetImportJob(DeleteDatasetImportJobRequest request)
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.
deleteDatasetImportJob in interface AmazonForecastdeleteDatasetImportJobRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.public DeleteForecastResult deleteForecast(DeleteForecastRequest request)
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.
deleteForecast in interface AmazonForecastdeleteForecastRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.public DeleteForecastExportJobResult deleteForecastExportJob(DeleteForecastExportJobRequest request)
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.
deleteForecastExportJob in interface AmazonForecastdeleteForecastExportJobRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.public DeletePredictorResult deletePredictor(DeletePredictorRequest request)
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.
deletePredictor in interface AmazonForecastdeletePredictorRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.public DescribeDatasetResult describeDataset(DescribeDatasetRequest request)
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
describeDataset in interface AmazonForecastdescribeDatasetRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.public DescribeDatasetGroupResult describeDatasetGroup(DescribeDatasetGroupRequest request)
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
describeDatasetGroup in interface AmazonForecastdescribeDatasetGroupRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.public DescribeDatasetImportJobResult describeDatasetImportJob(DescribeDatasetImportJobRequest request)
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.
describeDatasetImportJob in interface AmazonForecastdescribeDatasetImportJobRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.public DescribeForecastResult describeForecast(DescribeForecastRequest request)
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.
describeForecast in interface AmazonForecastdescribeForecastRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.public DescribeForecastExportJobResult describeForecastExportJob(DescribeForecastExportJobRequest request)
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.
describeForecastExportJob in interface AmazonForecastdescribeForecastExportJobRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.public DescribePredictorResult describePredictor(DescribePredictorRequest request)
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.
describePredictor in interface AmazonForecastdescribePredictorRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.public GetAccuracyMetricsResult getAccuracyMetrics(GetAccuracyMetricsRequest request)
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.
getAccuracyMetrics in interface AmazonForecastgetAccuracyMetricsRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.public ListDatasetGroupsResult listDatasetGroups(ListDatasetGroupsRequest request)
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.
listDatasetGroups in interface AmazonForecastlistDatasetGroupsRequest - InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.public ListDatasetImportJobsResult listDatasetImportJobs(ListDatasetImportJobsRequest request)
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.
listDatasetImportJobs in interface AmazonForecastlistDatasetImportJobsRequest - InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.public ListDatasetsResult listDatasets(ListDatasetsRequest request)
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.
listDatasets in interface AmazonForecastlistDatasetsRequest - InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.public ListForecastExportJobsResult listForecastExportJobs(ListForecastExportJobsRequest request)
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.
listForecastExportJobs in interface AmazonForecastlistForecastExportJobsRequest - InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.public ListForecastsResult listForecasts(ListForecastsRequest request)
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.
listForecasts in interface AmazonForecastlistForecastsRequest - InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.public ListPredictorsResult listPredictors(ListPredictorsRequest request)
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.
listPredictors in interface AmazonForecastlistPredictorsRequest - InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.public UpdateDatasetGroupResult updateDatasetGroup(UpdateDatasetGroupRequest request)
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.
updateDatasetGroup in interface AmazonForecastupdateDatasetGroupRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata in interface AmazonForecastrequest - The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.