AmazonForecastClient (AWS Java SDK for Amazon Forecast 1.11.678 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 an Amazon Forecast 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.
`DeleteDatasetResult`	`deleteDataset(DeleteDatasetRequest request)` Deletes an Amazon Forecast dataset 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.
`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.
`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.
`ListPredictorsResult`	`listPredictors(ListPredictorsRequest request)` Returns a list of predictors created using the CreatePredictor operation.
`UpdateDatasetGroupResult`	`updateDatasetGroup(UpdateDatasetGroupRequest request)` Replaces any existing datasets in the 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, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

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

Methods inherited from interface com.amazonaws.services.forecast.AmazonForecast
shutdown

- 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. Amazon Forecast uses this information when training the model and generating a forecast.
    - 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 of the dataset, including the field name and data type.
    After creating a dataset, you import your training data into the dataset and add the dataset to a dataset group. You then 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.
    
    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 that Amazon Resource Name (ARN). Try again with a different ARN.
    
    LimitExceededException - The limit on the number of requests per second has been exceeded.
    
    See Also:
    
    AWS API Documentation
  - createDatasetGroup
```
public CreateDatasetGroupResult createDatasetGroup(CreateDatasetGroupRequest request)
```
    Creates an Amazon Forecast dataset group, which holds a collection of related datasets. You can add datasets to the dataset group when you create the dataset group, or you can add datasets later with 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 a predictor using the dataset group. Use the DescribeDatasetGroup operation to get the status.
    
    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 that Amazon Resource Name (ARN). Try again with a different ARN.
    
    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 requests per second 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. For more information, see aws-forecast-iam-roles.
    
    Two properties of the training data are optionally specified:
    - The delimiter that separates the data fields.
      
      The default delimiter is a comma (,), which is the only supported delimiter in this release.
    - The format of timestamps.
      
      If the format is not specified, Amazon Forecast expects the format to be "yyyy-MM-dd HH:mm:ss".
    When Amazon Forecast uploads your training data, it verifies that the data was collected at the DataFrequency specified when the target dataset was created. For more information, see CreateDataset and howitworks-datasets-groups. Amazon Forecast also verifies the delimiter and timestamp format.
    
    You can use the ListDatasetImportJobs operation to get a list of all your dataset import jobs, filtered by specified criteria.
    
    To get a list of all your dataset import jobs, filtered by the specified criteria, use the ListDatasetGroups 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 that Amazon Resource Name (ARN). Try again with a different ARN.
    
    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 requests per second 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), use the CreateForecastExportJob operation.
    
    The range of the forecast is determined by the ForecastHorizon, specified in the CreatePredictor request, multiplied by the DataFrequency, specified in the CreateDataset request. When you query a forecast, you can request a specific date range within the complete forecast.
    
    To get a list of all your forecasts, use the ListForecasts operation.
    
    The forecasts generated by Amazon Forecast are in the same timezone 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 that Amazon Resource Name (ARN). Try again with a different ARN.
    
    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 requests per second 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.
    
    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. Use the DescribeForecastExportJob operation to get the status.
    
    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 that Amazon Resource Name (ARN). Try again with a different ARN.
    
    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 requests per second has been exceeded.
    
    See Also:
    
    AWS API Documentation
  - createPredictor
```
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 aggragate the data fields in the TARGET_TIME_SERIES dataset to improve model training. For more information, see FeaturizationConfig.
    
    AutoML
    
    If you set PerformAutoML to true, Amazon Forecast evaluates each algorithm and chooses the one that minimizes the objective function. 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 your predictors, use the ListPredictors operation.
    
    The Status of the predictor must be ACTIVE, signifying that training has completed, before you can use the predictor to create a forecast. Use the DescribePredictor operation to get the status.
    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 that Amazon Resource Name (ARN). Try again with a different ARN.
    
    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 requests per second has been exceeded.
    
    See Also:
    
    AWS API Documentation
  - deleteDataset
```
public DeleteDatasetResult deleteDataset(DeleteDatasetRequest request)
```
    Deletes an Amazon Forecast dataset created using the CreateDataset operation. To be deleted, the dataset must have a status of ACTIVE or CREATE_FAILED. Use the DescribeDataset operation to get the status.
    
    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. To be deleted, the dataset group must have a status of ACTIVE, CREATE_FAILED, or UPDATE_FAILED. Use the DescribeDatasetGroup operation to get the status.
    
    The 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. To be deleted, the import job must have a status of ACTIVE or CREATE_FAILED. Use the DescribeDatasetImportJob operation to get the status.
    
    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. To be deleted, the forecast must have a status of ACTIVE or CREATE_FAILED. Use the DescribeForecast operation to get the status.
    
    You can't delete a forecast while it is being exported.
    
    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. To be deleted, the export job must have a status of ACTIVE or CREATE_FAILED. Use the DescribeForecastExportJob operation to get the status.
    
    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. To be deleted, the predictor must have a status of ACTIVE or CREATE_FAILED. Use the DescribePredictor operation to get the status.
    
    Any forecasts generated by the predictor will no longer be available.
    
    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
  - describeDataset
```
public DescribeDatasetResult describeDataset(DescribeDatasetRequest request)
```
    Describes an Amazon Forecast dataset created using the CreateDataset operation.
    
    In addition to listing the properties provided by the user in the CreateDataset request, this operation includes the following 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 properties provided by the user 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 properties provided by the user 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 by the user in the CreateForecast request, this operation includes 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 includes 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 by the user in the CreatePredictor request, this operation includes the following properties:
    - DatasetImportJobArns - The dataset import jobs used to import training data.
    - AutoMLAlgorithmArns - If AutoML is performed, the algorithms 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
  - 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.
    
    Metrics are generated for each backtest window evaluated. For more information, see EvaluationParameters.
    
    The parameters of the filling method determine which items contribute to the metrics. If zero is specified, all items contribute. If nan is specified, only those items that have complete data in the range being evaluated contribute. For more information, see FeaturizationMethod.
    
    For an example of how to train a model and review metrics, see getting-started.
    
    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, a summary of its properties, including its Amazon Resource Name (ARN), is returned. You can retrieve the complete set of properties by using the 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, a summary of its properties, including its Amazon Resource Name (ARN), is returned. 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. You can retrieve the complete set of properties by using 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, a summary of its properties, including its Amazon Resource Name (ARN), is returned. You can retrieve the complete set of properties by using the ARN with the DescribeForecastExportJob operation. The list can be filtered 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, a summary of its properties, including its Amazon Resource Name (ARN), is returned. You can retrieve the complete set of properties by using the ARN with the DescribeForecast operation. The list can be filtered 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
  - listPredictors
```
public ListPredictorsResult listPredictors(ListPredictorsRequest request)
```
    Returns a list of predictors created using the CreatePredictor operation. For each predictor, a summary of its properties, including its Amazon Resource Name (ARN), is returned. You can retrieve the complete set of properties by using the ARN with the DescribePredictor operation. The list can be filtered 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
  - updateDatasetGroup
```
public UpdateDatasetGroupResult updateDatasetGroup(UpdateDatasetGroupRequest request)
```
    Replaces any existing datasets in the dataset group with the specified datasets.
    
    The Status of the dataset group must be ACTIVE before creating a predictor using the dataset group. 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.

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

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

Field Detail

configFactory

Method Detail

builder

createDataset

createDatasetGroup

createDatasetImportJob

createForecast

createForecastExportJob

createPredictor

deleteDataset

deleteDatasetGroup

deleteDatasetImportJob

deleteForecast

deleteForecastExportJob

deletePredictor

describeDataset

describeDatasetGroup

describeDatasetImportJob

describeForecast

describeForecastExportJob

describePredictor

getAccuracyMetrics

listDatasetGroups

listDatasetImportJobs

listDatasets

listForecastExportJobs

listForecasts

listPredictors

updateDatasetGroup

getCachedResponseMetadata