AmazonForecastClient (AWS Java SDK for Amazon Forecast 1.11.936 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.forecast.AmazonForecastClient

All Implemented Interfaces:

AmazonForecast

Direct Known Subclasses:

AmazonForecastAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonForecastClient
extends AmazonWebServiceClient
implements AmazonForecast
```
Client for accessing Amazon Forecast Service. All service calls made using this client are blocking, and will not return until the service call completes.

Provides APIs for creating and managing Amazon Forecast resources.

Field Summary

Fields
Modifier and Type Field and Description

protected static ClientConfigurationFactory configFactory
Client configuration factory providing ClientConfigurations tailored to this client
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
- Fields inherited from interface com.amazonaws.services.forecast.AmazonForecast
  ENDPOINT_PREFIX

Fields
Modifier and Type	Field and Description
`protected static ClientConfigurationFactory`	`configFactory` Client configuration factory providing ClientConfigurations tailored to this client

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AmazonForecastClientBuilder`	`builder()`
`CreateDatasetResult`	`createDataset(CreateDatasetRequest request)` Creates an Amazon Forecast dataset.
`CreateDatasetGroupResult`	`createDatasetGroup(CreateDatasetGroupRequest request)` Creates a dataset group, which holds a collection of related datasets.
`CreateDatasetImportJobResult`	`createDatasetImportJob(CreateDatasetImportJobRequest request)` Imports your training data to an Amazon Forecast dataset.
`CreateForecastResult`	`createForecast(CreateForecastRequest request)` Creates a forecast for each item in the `TARGET_TIME_SERIES` dataset that was used to train the predictor.
`CreateForecastExportJobResult`	`createForecastExportJob(CreateForecastExportJobRequest request)` Exports a forecast created by the CreateForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket.
`CreatePredictorResult`	`createPredictor(CreatePredictorRequest request)` Creates an Amazon Forecast predictor.
`CreatePredictorBacktestExportJobResult`	`createPredictorBacktestExportJob(CreatePredictorBacktestExportJobRequest request)` Exports backtest forecasts and accuracy metrics generated by the CreatePredictor operation.
`DeleteDatasetResult`	`deleteDataset(DeleteDatasetRequest request)` Deletes an Amazon Forecast dataset that was created using the CreateDataset operation.
`DeleteDatasetGroupResult`	`deleteDatasetGroup(DeleteDatasetGroupRequest request)` Deletes a dataset group created using the CreateDatasetGroup operation.
`DeleteDatasetImportJobResult`	`deleteDatasetImportJob(DeleteDatasetImportJobRequest request)` Deletes a dataset import job created using the CreateDatasetImportJob operation.
`DeleteForecastResult`	`deleteForecast(DeleteForecastRequest request)` Deletes a forecast created using the CreateForecast operation.
`DeleteForecastExportJobResult`	`deleteForecastExportJob(DeleteForecastExportJobRequest request)` Deletes a forecast export job created using the CreateForecastExportJob operation.
`DeletePredictorResult`	`deletePredictor(DeletePredictorRequest request)` Deletes a predictor created using the CreatePredictor operation.
`DeletePredictorBacktestExportJobResult`	`deletePredictorBacktestExportJob(DeletePredictorBacktestExportJobRequest request)` Deletes a predictor backtest export job.
`DescribeDatasetResult`	`describeDataset(DescribeDatasetRequest request)` Describes an Amazon Forecast dataset created using the CreateDataset operation.
`DescribeDatasetGroupResult`	`describeDatasetGroup(DescribeDatasetGroupRequest request)` Describes a dataset group created using the CreateDatasetGroup operation.
`DescribeDatasetImportJobResult`	`describeDatasetImportJob(DescribeDatasetImportJobRequest request)` Describes a dataset import job created using the CreateDatasetImportJob operation.
`DescribeForecastResult`	`describeForecast(DescribeForecastRequest request)` Describes a forecast created using the CreateForecast operation.
`DescribeForecastExportJobResult`	`describeForecastExportJob(DescribeForecastExportJobRequest request)` Describes a forecast export job created using the CreateForecastExportJob operation.
`DescribePredictorResult`	`describePredictor(DescribePredictorRequest request)` Describes a predictor created using the CreatePredictor operation.
`DescribePredictorBacktestExportJobResult`	`describePredictorBacktestExportJob(DescribePredictorBacktestExportJobRequest request)` Describes a predictor backtest export job created using the CreatePredictorBacktestExportJob operation.
`GetAccuracyMetricsResult`	`getAccuracyMetrics(GetAccuracyMetricsRequest request)` Provides metrics on the accuracy of the models that were trained by the CreatePredictor operation.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
`ListDatasetGroupsResult`	`listDatasetGroups(ListDatasetGroupsRequest request)` Returns a list of dataset groups created using the CreateDatasetGroup operation.
`ListDatasetImportJobsResult`	`listDatasetImportJobs(ListDatasetImportJobsRequest request)` Returns a list of dataset import jobs created using the CreateDatasetImportJob operation.
`ListDatasetsResult`	`listDatasets(ListDatasetsRequest request)` Returns a list of datasets created using the CreateDataset operation.
`ListForecastExportJobsResult`	`listForecastExportJobs(ListForecastExportJobsRequest request)` Returns a list of forecast export jobs created using the CreateForecastExportJob operation.
`ListForecastsResult`	`listForecasts(ListForecastsRequest request)` Returns a list of forecasts created using the CreateForecast operation.
`ListPredictorBacktestExportJobsResult`	`listPredictorBacktestExportJobs(ListPredictorBacktestExportJobsRequest request)` Returns a list of predictor backtest export jobs created using the CreatePredictorBacktestExportJob operation.
`ListPredictorsResult`	`listPredictors(ListPredictorsRequest request)` Returns a list of predictors created using the CreatePredictor operation.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Lists the tags for an Amazon Forecast resource.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Associates the specified tags to a resource with the specified `resourceArn`.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Deletes the specified tags from a resource.
`UpdateDatasetGroupResult`	`updateDatasetGroup(UpdateDatasetGroupRequest request)` Replaces the datasets in a dataset group with the specified datasets.

Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - configFactory
```
protected static final ClientConfigurationFactory configFactory
```
    Client configuration factory providing ClientConfigurations tailored to this client
- Method Detail
  - builder
```
public static AmazonForecastClientBuilder builder()
```
  - createDataset
```
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.
    Specified by:
    
    createDataset in interface AmazonForecast
    
    Parameters:
    
    createDatasetRequest -
    
    Returns:
    
    Result of the CreateDataset operation returned by the service.
    
    Throws:
    
    InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid range.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createDatasetGroup
```
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 use the dataset group to create a predictor. To get the status, use the DescribeDatasetGroup operation.
    
    Specified by:
    
    createDatasetGroup in interface AmazonForecast
    
    Parameters:
    
    createDatasetGroupRequest -
    
    Returns:
    
    Result of the CreateDatasetGroup operation returned by the service.
    
    Throws:
    
    InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid range.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createDatasetImportJob
```
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, as Amazon Forecast makes a copy of your data and processes it in an internal AWS system. 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.
    
    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.
    
    Specified by:
    
    createDatasetImportJob in interface AmazonForecast
    
    Parameters:
    
    createDatasetImportJobRequest -
    
    Returns:
    
    Result of the CreateDatasetImportJob operation returned by the service.
    
    Throws:
    
    InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid range.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createForecast
```
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. 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.
    
    Specified by:
    
    createForecast in interface AmazonForecast
    
    Parameters:
    
    createForecastRequest -
    
    Returns:
    
    Result of the CreateForecast operation returned by the service.
    
    Throws:
    
    InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid range.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createForecastExportJob
```
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>_<PartNumber>
    
    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.
    
    Specified by:
    
    createForecastExportJob in interface AmazonForecast
    
    Parameters:
    
    createForecastExportJobRequest -
    
    Returns:
    
    Result of the CreateForecastExportJob operation returned by the service.
    
    Throws:
    
    InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid range.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createPredictor
```
public CreatePredictorResult createPredictor(CreatePredictorRequest request)
```
    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.
    Specified by:
    
    createPredictor in interface AmazonForecast
    
    Parameters:
    
    createPredictorRequest -
    
    Returns:
    
    Result of the CreatePredictor operation returned by the service.
    
    Throws:
    
    InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid range.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createPredictorBacktestExportJob
```
public CreatePredictorBacktestExportJobResult createPredictorBacktestExportJob(CreatePredictorBacktestExportJobRequest request)
```
    Exports backtest forecasts and accuracy metrics generated by the CreatePredictor operation. Two folders containing CSV 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 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.
    
    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.
    
    Specified by:
    
    createPredictorBacktestExportJob in interface AmazonForecast
    
    Parameters:
    
    createPredictorBacktestExportJobRequest -
    
    Returns:
    
    Result of the CreatePredictorBacktestExportJob operation returned by the service.
    
    Throws:
    
    InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid range.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteDataset
```
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.
    
    Forecast does not automatically update any dataset groups that contain the deleted dataset. In order to update the dataset group, use the operation, omitting the deleted dataset's ARN.
    
    Specified by:
    
    deleteDataset in interface AmazonForecast
    
    Parameters:
    
    deleteDatasetRequest -
    
    Returns:
    
    Result of the DeleteDataset operation returned by the service.
    
    Throws:
    
    InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid range.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteDatasetGroup
```
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.
    
    Specified by:
    
    deleteDatasetGroup in interface AmazonForecast
    
    Parameters:
    
    deleteDatasetGroupRequest -
    
    Returns:
    
    Result of the DeleteDatasetGroup operation returned by the service.
    
    Throws:
    
    InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid range.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteDatasetImportJob
```
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.
    
    Specified by:
    
    deleteDatasetImportJob in interface AmazonForecast
    
    Parameters:
    
    deleteDatasetImportJobRequest -
    
    Returns:
    
    Result of the DeleteDatasetImportJob operation returned by the service.
    
    Throws:
    
    InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid range.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteForecast
```
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.
    
    Specified by:
    
    deleteForecast in interface AmazonForecast
    
    Parameters:
    
    deleteForecastRequest -
    
    Returns:
    
    Result of the DeleteForecast operation returned by the service.
    
    Throws:
    
    InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid range.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteForecastExportJob
```
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.
    
    Specified by:
    
    deleteForecastExportJob in interface AmazonForecast
    
    Parameters:
    
    deleteForecastExportJobRequest -
    
    Returns:
    
    Result of the DeleteForecastExportJob operation returned by the service.
    
    Throws:
    
    InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid range.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deletePredictor
```
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.
    
    Specified by:
    
    deletePredictor in interface AmazonForecast
    
    Parameters:
    
    deletePredictorRequest -
    
    Returns:
    
    Result of the DeletePredictor operation returned by the service.
    
    Throws:
    
    InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid range.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deletePredictorBacktestExportJob
```
public DeletePredictorBacktestExportJobResult deletePredictorBacktestExportJob(DeletePredictorBacktestExportJobRequest request)
```
    Deletes a predictor backtest export job.
    
    Specified by:
    
    deletePredictorBacktestExportJob in interface AmazonForecast
    
    Parameters:
    
    deletePredictorBacktestExportJobRequest -
    
    Returns:
    
    Result of the DeletePredictorBacktestExportJob operation returned by the service.
    
    Throws:
    
    InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid range.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - describeDataset
```
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
    Specified by:
    
    describeDataset in interface AmazonForecast
    
    Parameters:
    
    describeDatasetRequest -
    
    Returns:
    
    Result of the DescribeDataset operation returned by the service.
    
    Throws:
    
    InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid range.
    
    ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
    
    See Also:
    
    AWS API Documentation
  - describeDatasetGroup
```
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
    Specified by:
    
    describeDatasetGroup in interface AmazonForecast
    
    Parameters:
    
    describeDatasetGroupRequest -
    
    Returns:
    
    Result of the DescribeDatasetGroup operation returned by the service.
    
    Throws:
    
    InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid range.
    
    ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
    
    See Also:
    
    AWS API Documentation
  - describeDatasetImportJob
```
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.
    Specified by:
    
    describeDatasetImportJob in interface AmazonForecast
    
    Parameters:
    
    describeDatasetImportJobRequest -
    
    Returns:
    
    Result of the DescribeDatasetImportJob operation returned by the service.
    
    Throws:
    
    InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid range.
    
    ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
    
    See Also:
    
    AWS API Documentation
  - describeForecast
```
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.
    Specified by:
    
    describeForecast in interface AmazonForecast
    
    Parameters:
    
    describeForecastRequest -
    
    Returns:
    
    Result of the DescribeForecast operation returned by the service.
    
    Throws:
    
    InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid range.
    
    ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
    
    See Also:
    
    AWS API Documentation
  - describeForecastExportJob
```
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.
    Specified by:
    
    describeForecastExportJob in interface AmazonForecast
    
    Parameters:
    
    describeForecastExportJobRequest -
    
    Returns:
    
    Result of the DescribeForecastExportJob operation returned by the service.
    
    Throws:
    
    InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid range.
    
    ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
    
    See Also:
    
    AWS API Documentation
  - describePredictor
```
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.
    Specified by:
    
    describePredictor in interface AmazonForecast
    
    Parameters:
    
    describePredictorRequest -
    
    Returns:
    
    Result of the DescribePredictor operation returned by the service.
    
    Throws:
    
    InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid range.
    
    ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
    
    See Also:
    
    AWS API Documentation
  - describePredictorBacktestExportJob
```
public DescribePredictorBacktestExportJobResult describePredictorBacktestExportJob(DescribePredictorBacktestExportJobRequest request)
```
    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)
    Specified by:
    
    describePredictorBacktestExportJob in interface AmazonForecast
    
    Parameters:
    
    describePredictorBacktestExportJobRequest -
    
    Returns:
    
    Result of the DescribePredictorBacktestExportJob operation returned by the service.
    
    Throws:
    
    InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid range.
    
    ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
    
    See Also:
    
    AWS API Documentation
  - getAccuracyMetrics
```
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 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.
    
    Specified by:
    
    getAccuracyMetrics in interface AmazonForecast
    
    Parameters:
    
    getAccuracyMetricsRequest -
    
    Returns:
    
    Result of the GetAccuracyMetrics operation returned by the service.
    
    Throws:
    
    InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid range.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listDatasetGroups
```
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.
    
    Specified by:
    
    listDatasetGroups in interface AmazonForecast
    
    Parameters:
    
    listDatasetGroupsRequest -
    
    Returns:
    
    Result of the ListDatasetGroups operation returned by the service.
    
    Throws:
    
    InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.
    
    See Also:
    
    AWS API Documentation
  - listDatasetImportJobs
```
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.
    
    Specified by:
    
    listDatasetImportJobs in interface AmazonForecast
    
    Parameters:
    
    listDatasetImportJobsRequest -
    
    Returns:
    
    Result of the ListDatasetImportJobs operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listDatasets
```
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.
    
    Specified by:
    
    listDatasets in interface AmazonForecast
    
    Parameters:
    
    listDatasetsRequest -
    
    Returns:
    
    Result of the ListDatasets operation returned by the service.
    
    Throws:
    
    InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.
    
    See Also:
    
    AWS API Documentation
  - listForecastExportJobs
```
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.
    
    Specified by:
    
    listForecastExportJobs in interface AmazonForecast
    
    Parameters:
    
    listForecastExportJobsRequest -
    
    Returns:
    
    Result of the ListForecastExportJobs operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listForecasts
```
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.
    
    Specified by:
    
    listForecasts in interface AmazonForecast
    
    Parameters:
    
    listForecastsRequest -
    
    Returns:
    
    Result of the ListForecasts operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listPredictorBacktestExportJobs
```
public ListPredictorBacktestExportJobsResult listPredictorBacktestExportJobs(ListPredictorBacktestExportJobsRequest request)
```
    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.
    
    Specified by:
    
    listPredictorBacktestExportJobs in interface AmazonForecast
    
    Parameters:
    
    listPredictorBacktestExportJobsRequest -
    
    Returns:
    
    Result of the ListPredictorBacktestExportJobs operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listPredictors
```
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.
    
    Specified by:
    
    listPredictors in interface AmazonForecast
    
    Parameters:
    
    listPredictorsRequest -
    
    Returns:
    
    Result of the ListPredictors operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Lists the tags for an Amazon Forecast resource.
    
    Specified by:
    
    listTagsForResource in interface AmazonForecast
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
    
    InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid range.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    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.
    
    Specified by:
    
    tagResource in interface AmazonForecast
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
    
    LimitExceededException - The limit on the number of resources per account has been exceeded.
    
    InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid range.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Deletes the specified tags from a resource.
    
    Specified by:
    
    untagResource in interface AmazonForecast
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
    
    InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid range.
    
    See Also:
    
    AWS API Documentation
  - updateDatasetGroup
```
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.
    
    Specified by:
    
    updateDatasetGroup in interface AmazonForecast
    
    Parameters:
    
    updateDatasetGroupRequest -
    
    Returns:
    
    Result of the UpdateDatasetGroup operation returned by the service.
    
    Throws:
    
    InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid range.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonForecast
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonForecast
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonForecast
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Class AmazonForecastClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.forecast.AmazonForecast

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Field Detail

configFactory

Method Detail

builder

createDataset

createDatasetGroup

createDatasetImportJob

createForecast

createForecastExportJob

createPredictor

createPredictorBacktestExportJob

deleteDataset

deleteDatasetGroup

deleteDatasetImportJob

deleteForecast

deleteForecastExportJob

deletePredictor

deletePredictorBacktestExportJob

describeDataset

describeDatasetGroup

describeDatasetImportJob

describeForecast

describeForecastExportJob

describePredictor

describePredictorBacktestExportJob

getAccuracyMetrics

listDatasetGroups

listDatasetImportJobs

listDatasets

listForecastExportJobs

listForecasts

listPredictorBacktestExportJobs

listPredictors

listTagsForResource

tagResource

untagResource

updateDatasetGroup

getCachedResponseMetadata

shutdown