@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface ForecastClient extends AwsClient
builder() method.
Provides APIs for creating and managing Amazon Forecast resources.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static ForecastClientBuilder |
builder()
Create a builder that can be used to configure and create a
ForecastClient. |
static ForecastClient |
create()
Create a
ForecastClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateAutoPredictorResponse |
createAutoPredictor(Consumer<CreateAutoPredictorRequest.Builder> createAutoPredictorRequest)
Creates an Amazon Forecast predictor.
|
default CreateAutoPredictorResponse |
createAutoPredictor(CreateAutoPredictorRequest createAutoPredictorRequest)
Creates an Amazon Forecast predictor.
|
default CreateDatasetResponse |
createDataset(Consumer<CreateDatasetRequest.Builder> createDatasetRequest)
Creates an Amazon Forecast dataset.
|
default CreateDatasetResponse |
createDataset(CreateDatasetRequest createDatasetRequest)
Creates an Amazon Forecast dataset.
|
default CreateDatasetGroupResponse |
createDatasetGroup(Consumer<CreateDatasetGroupRequest.Builder> createDatasetGroupRequest)
Creates a dataset group, which holds a collection of related datasets.
|
default CreateDatasetGroupResponse |
createDatasetGroup(CreateDatasetGroupRequest createDatasetGroupRequest)
Creates a dataset group, which holds a collection of related datasets.
|
default CreateDatasetImportJobResponse |
createDatasetImportJob(Consumer<CreateDatasetImportJobRequest.Builder> createDatasetImportJobRequest)
Imports your training data to an Amazon Forecast dataset.
|
default CreateDatasetImportJobResponse |
createDatasetImportJob(CreateDatasetImportJobRequest createDatasetImportJobRequest)
Imports your training data to an Amazon Forecast dataset.
|
default CreateExplainabilityResponse |
createExplainability(Consumer<CreateExplainabilityRequest.Builder> createExplainabilityRequest)
|
default CreateExplainabilityResponse |
createExplainability(CreateExplainabilityRequest createExplainabilityRequest)
|
default CreateExplainabilityExportResponse |
createExplainabilityExport(Consumer<CreateExplainabilityExportRequest.Builder> createExplainabilityExportRequest)
Exports an Explainability resource created by the CreateExplainability operation.
|
default CreateExplainabilityExportResponse |
createExplainabilityExport(CreateExplainabilityExportRequest createExplainabilityExportRequest)
Exports an Explainability resource created by the CreateExplainability operation.
|
default CreateForecastResponse |
createForecast(Consumer<CreateForecastRequest.Builder> createForecastRequest)
Creates a forecast for each item in the
TARGET_TIME_SERIES dataset that was used to train the
predictor. |
default CreateForecastResponse |
createForecast(CreateForecastRequest createForecastRequest)
Creates a forecast for each item in the
TARGET_TIME_SERIES dataset that was used to train the
predictor. |
default CreateForecastExportJobResponse |
createForecastExportJob(Consumer<CreateForecastExportJobRequest.Builder> createForecastExportJobRequest)
Exports a forecast created by the CreateForecast operation to your Amazon Simple Storage Service (Amazon
S3) bucket.
|
default CreateForecastExportJobResponse |
createForecastExportJob(CreateForecastExportJobRequest createForecastExportJobRequest)
Exports a forecast created by the CreateForecast operation to your Amazon Simple Storage Service (Amazon
S3) bucket.
|
default CreateMonitorResponse |
createMonitor(Consumer<CreateMonitorRequest.Builder> createMonitorRequest)
Creates a predictor monitor resource for an existing auto predictor.
|
default CreateMonitorResponse |
createMonitor(CreateMonitorRequest createMonitorRequest)
Creates a predictor monitor resource for an existing auto predictor.
|
default CreatePredictorResponse |
createPredictor(Consumer<CreatePredictorRequest.Builder> createPredictorRequest)
|
default CreatePredictorResponse |
createPredictor(CreatePredictorRequest createPredictorRequest)
|
default CreatePredictorBacktestExportJobResponse |
createPredictorBacktestExportJob(Consumer<CreatePredictorBacktestExportJobRequest.Builder> createPredictorBacktestExportJobRequest)
Exports backtest forecasts and accuracy metrics generated by the CreateAutoPredictor or
CreatePredictor operations.
|
default CreatePredictorBacktestExportJobResponse |
createPredictorBacktestExportJob(CreatePredictorBacktestExportJobRequest createPredictorBacktestExportJobRequest)
Exports backtest forecasts and accuracy metrics generated by the CreateAutoPredictor or
CreatePredictor operations.
|
default CreateWhatIfAnalysisResponse |
createWhatIfAnalysis(Consumer<CreateWhatIfAnalysisRequest.Builder> createWhatIfAnalysisRequest)
What-if analysis is a scenario modeling technique where you make a hypothetical change to a time series and
compare the forecasts generated by these changes against the baseline, unchanged time series.
|
default CreateWhatIfAnalysisResponse |
createWhatIfAnalysis(CreateWhatIfAnalysisRequest createWhatIfAnalysisRequest)
What-if analysis is a scenario modeling technique where you make a hypothetical change to a time series and
compare the forecasts generated by these changes against the baseline, unchanged time series.
|
default CreateWhatIfForecastResponse |
createWhatIfForecast(Consumer<CreateWhatIfForecastRequest.Builder> createWhatIfForecastRequest)
A what-if forecast is a forecast that is created from a modified version of the baseline forecast.
|
default CreateWhatIfForecastResponse |
createWhatIfForecast(CreateWhatIfForecastRequest createWhatIfForecastRequest)
A what-if forecast is a forecast that is created from a modified version of the baseline forecast.
|
default CreateWhatIfForecastExportResponse |
createWhatIfForecastExport(Consumer<CreateWhatIfForecastExportRequest.Builder> createWhatIfForecastExportRequest)
Exports a forecast created by the CreateWhatIfForecast operation to your Amazon Simple Storage Service
(Amazon S3) bucket.
|
default CreateWhatIfForecastExportResponse |
createWhatIfForecastExport(CreateWhatIfForecastExportRequest createWhatIfForecastExportRequest)
Exports a forecast created by the CreateWhatIfForecast operation to your Amazon Simple Storage Service
(Amazon S3) bucket.
|
default DeleteDatasetResponse |
deleteDataset(Consumer<DeleteDatasetRequest.Builder> deleteDatasetRequest)
Deletes an Amazon Forecast dataset that was created using the CreateDataset operation.
|
default DeleteDatasetResponse |
deleteDataset(DeleteDatasetRequest deleteDatasetRequest)
Deletes an Amazon Forecast dataset that was created using the CreateDataset operation.
|
default DeleteDatasetGroupResponse |
deleteDatasetGroup(Consumer<DeleteDatasetGroupRequest.Builder> deleteDatasetGroupRequest)
Deletes a dataset group created using the CreateDatasetGroup
operation.
|
default DeleteDatasetGroupResponse |
deleteDatasetGroup(DeleteDatasetGroupRequest deleteDatasetGroupRequest)
Deletes a dataset group created using the CreateDatasetGroup
operation.
|
default DeleteDatasetImportJobResponse |
deleteDatasetImportJob(Consumer<DeleteDatasetImportJobRequest.Builder> deleteDatasetImportJobRequest)
Deletes a dataset import job created using the CreateDatasetImportJob
operation.
|
default DeleteDatasetImportJobResponse |
deleteDatasetImportJob(DeleteDatasetImportJobRequest deleteDatasetImportJobRequest)
Deletes a dataset import job created using the CreateDatasetImportJob
operation.
|
default DeleteExplainabilityResponse |
deleteExplainability(Consumer<DeleteExplainabilityRequest.Builder> deleteExplainabilityRequest)
Deletes an Explainability resource.
|
default DeleteExplainabilityResponse |
deleteExplainability(DeleteExplainabilityRequest deleteExplainabilityRequest)
Deletes an Explainability resource.
|
default DeleteExplainabilityExportResponse |
deleteExplainabilityExport(Consumer<DeleteExplainabilityExportRequest.Builder> deleteExplainabilityExportRequest)
Deletes an Explainability export.
|
default DeleteExplainabilityExportResponse |
deleteExplainabilityExport(DeleteExplainabilityExportRequest deleteExplainabilityExportRequest)
Deletes an Explainability export.
|
default DeleteForecastResponse |
deleteForecast(Consumer<DeleteForecastRequest.Builder> deleteForecastRequest)
Deletes a forecast created using the CreateForecast operation.
|
default DeleteForecastResponse |
deleteForecast(DeleteForecastRequest deleteForecastRequest)
Deletes a forecast created using the CreateForecast operation.
|
default DeleteForecastExportJobResponse |
deleteForecastExportJob(Consumer<DeleteForecastExportJobRequest.Builder> deleteForecastExportJobRequest)
Deletes a forecast export job created using the CreateForecastExportJob operation.
|
default DeleteForecastExportJobResponse |
deleteForecastExportJob(DeleteForecastExportJobRequest deleteForecastExportJobRequest)
Deletes a forecast export job created using the CreateForecastExportJob operation.
|
default DeleteMonitorResponse |
deleteMonitor(Consumer<DeleteMonitorRequest.Builder> deleteMonitorRequest)
Deletes a monitor resource.
|
default DeleteMonitorResponse |
deleteMonitor(DeleteMonitorRequest deleteMonitorRequest)
Deletes a monitor resource.
|
default DeletePredictorResponse |
deletePredictor(Consumer<DeletePredictorRequest.Builder> deletePredictorRequest)
Deletes a predictor created using the DescribePredictor or CreatePredictor operations.
|
default DeletePredictorResponse |
deletePredictor(DeletePredictorRequest deletePredictorRequest)
Deletes a predictor created using the DescribePredictor or CreatePredictor operations.
|
default DeletePredictorBacktestExportJobResponse |
deletePredictorBacktestExportJob(Consumer<DeletePredictorBacktestExportJobRequest.Builder> deletePredictorBacktestExportJobRequest)
Deletes a predictor backtest export job.
|
default DeletePredictorBacktestExportJobResponse |
deletePredictorBacktestExportJob(DeletePredictorBacktestExportJobRequest deletePredictorBacktestExportJobRequest)
Deletes a predictor backtest export job.
|
default DeleteResourceTreeResponse |
deleteResourceTree(Consumer<DeleteResourceTreeRequest.Builder> deleteResourceTreeRequest)
Deletes an entire resource tree.
|
default DeleteResourceTreeResponse |
deleteResourceTree(DeleteResourceTreeRequest deleteResourceTreeRequest)
Deletes an entire resource tree.
|
default DeleteWhatIfAnalysisResponse |
deleteWhatIfAnalysis(Consumer<DeleteWhatIfAnalysisRequest.Builder> deleteWhatIfAnalysisRequest)
Deletes a what-if analysis created using the CreateWhatIfAnalysis operation.
|
default DeleteWhatIfAnalysisResponse |
deleteWhatIfAnalysis(DeleteWhatIfAnalysisRequest deleteWhatIfAnalysisRequest)
Deletes a what-if analysis created using the CreateWhatIfAnalysis operation.
|
default DeleteWhatIfForecastResponse |
deleteWhatIfForecast(Consumer<DeleteWhatIfForecastRequest.Builder> deleteWhatIfForecastRequest)
Deletes a what-if forecast created using the CreateWhatIfForecast operation.
|
default DeleteWhatIfForecastResponse |
deleteWhatIfForecast(DeleteWhatIfForecastRequest deleteWhatIfForecastRequest)
Deletes a what-if forecast created using the CreateWhatIfForecast operation.
|
default DeleteWhatIfForecastExportResponse |
deleteWhatIfForecastExport(Consumer<DeleteWhatIfForecastExportRequest.Builder> deleteWhatIfForecastExportRequest)
Deletes a what-if forecast export created using the CreateWhatIfForecastExport operation.
|
default DeleteWhatIfForecastExportResponse |
deleteWhatIfForecastExport(DeleteWhatIfForecastExportRequest deleteWhatIfForecastExportRequest)
Deletes a what-if forecast export created using the CreateWhatIfForecastExport operation.
|
default DescribeAutoPredictorResponse |
describeAutoPredictor(Consumer<DescribeAutoPredictorRequest.Builder> describeAutoPredictorRequest)
Describes a predictor created using the CreateAutoPredictor operation.
|
default DescribeAutoPredictorResponse |
describeAutoPredictor(DescribeAutoPredictorRequest describeAutoPredictorRequest)
Describes a predictor created using the CreateAutoPredictor operation.
|
default DescribeDatasetResponse |
describeDataset(Consumer<DescribeDatasetRequest.Builder> describeDatasetRequest)
Describes an Amazon Forecast dataset created using the CreateDataset operation.
|
default DescribeDatasetResponse |
describeDataset(DescribeDatasetRequest describeDatasetRequest)
Describes an Amazon Forecast dataset created using the CreateDataset operation.
|
default DescribeDatasetGroupResponse |
describeDatasetGroup(Consumer<DescribeDatasetGroupRequest.Builder> describeDatasetGroupRequest)
Describes a dataset group created using the CreateDatasetGroup
operation.
|
default DescribeDatasetGroupResponse |
describeDatasetGroup(DescribeDatasetGroupRequest describeDatasetGroupRequest)
Describes a dataset group created using the CreateDatasetGroup
operation.
|
default DescribeDatasetImportJobResponse |
describeDatasetImportJob(Consumer<DescribeDatasetImportJobRequest.Builder> describeDatasetImportJobRequest)
Describes a dataset import job created using the CreateDatasetImportJob
operation.
|
default DescribeDatasetImportJobResponse |
describeDatasetImportJob(DescribeDatasetImportJobRequest describeDatasetImportJobRequest)
Describes a dataset import job created using the CreateDatasetImportJob
operation.
|
default DescribeExplainabilityResponse |
describeExplainability(Consumer<DescribeExplainabilityRequest.Builder> describeExplainabilityRequest)
Describes an Explainability resource created using the CreateExplainability operation.
|
default DescribeExplainabilityResponse |
describeExplainability(DescribeExplainabilityRequest describeExplainabilityRequest)
Describes an Explainability resource created using the CreateExplainability operation.
|
default DescribeExplainabilityExportResponse |
describeExplainabilityExport(Consumer<DescribeExplainabilityExportRequest.Builder> describeExplainabilityExportRequest)
Describes an Explainability export created using the CreateExplainabilityExport operation.
|
default DescribeExplainabilityExportResponse |
describeExplainabilityExport(DescribeExplainabilityExportRequest describeExplainabilityExportRequest)
Describes an Explainability export created using the CreateExplainabilityExport operation.
|
default DescribeForecastResponse |
describeForecast(Consumer<DescribeForecastRequest.Builder> describeForecastRequest)
Describes a forecast created using the CreateForecast operation.
|
default DescribeForecastResponse |
describeForecast(DescribeForecastRequest describeForecastRequest)
Describes a forecast created using the CreateForecast operation.
|
default DescribeForecastExportJobResponse |
describeForecastExportJob(Consumer<DescribeForecastExportJobRequest.Builder> describeForecastExportJobRequest)
Describes a forecast export job created using the CreateForecastExportJob operation.
|
default DescribeForecastExportJobResponse |
describeForecastExportJob(DescribeForecastExportJobRequest describeForecastExportJobRequest)
Describes a forecast export job created using the CreateForecastExportJob operation.
|
default DescribeMonitorResponse |
describeMonitor(Consumer<DescribeMonitorRequest.Builder> describeMonitorRequest)
Describes a monitor resource.
|
default DescribeMonitorResponse |
describeMonitor(DescribeMonitorRequest describeMonitorRequest)
Describes a monitor resource.
|
default DescribePredictorResponse |
describePredictor(Consumer<DescribePredictorRequest.Builder> describePredictorRequest)
|
default DescribePredictorResponse |
describePredictor(DescribePredictorRequest describePredictorRequest)
|
default DescribePredictorBacktestExportJobResponse |
describePredictorBacktestExportJob(Consumer<DescribePredictorBacktestExportJobRequest.Builder> describePredictorBacktestExportJobRequest)
Describes a predictor backtest export job created using the CreatePredictorBacktestExportJob operation.
|
default DescribePredictorBacktestExportJobResponse |
describePredictorBacktestExportJob(DescribePredictorBacktestExportJobRequest describePredictorBacktestExportJobRequest)
Describes a predictor backtest export job created using the CreatePredictorBacktestExportJob operation.
|
default DescribeWhatIfAnalysisResponse |
describeWhatIfAnalysis(Consumer<DescribeWhatIfAnalysisRequest.Builder> describeWhatIfAnalysisRequest)
Describes the what-if analysis created using the CreateWhatIfAnalysis operation.
|
default DescribeWhatIfAnalysisResponse |
describeWhatIfAnalysis(DescribeWhatIfAnalysisRequest describeWhatIfAnalysisRequest)
Describes the what-if analysis created using the CreateWhatIfAnalysis operation.
|
default DescribeWhatIfForecastResponse |
describeWhatIfForecast(Consumer<DescribeWhatIfForecastRequest.Builder> describeWhatIfForecastRequest)
Describes the what-if forecast created using the CreateWhatIfForecast operation.
|
default DescribeWhatIfForecastResponse |
describeWhatIfForecast(DescribeWhatIfForecastRequest describeWhatIfForecastRequest)
Describes the what-if forecast created using the CreateWhatIfForecast operation.
|
default DescribeWhatIfForecastExportResponse |
describeWhatIfForecastExport(Consumer<DescribeWhatIfForecastExportRequest.Builder> describeWhatIfForecastExportRequest)
Describes the what-if forecast export created using the CreateWhatIfForecastExport operation.
|
default DescribeWhatIfForecastExportResponse |
describeWhatIfForecastExport(DescribeWhatIfForecastExportRequest describeWhatIfForecastExportRequest)
Describes the what-if forecast export created using the CreateWhatIfForecastExport operation.
|
default GetAccuracyMetricsResponse |
getAccuracyMetrics(Consumer<GetAccuracyMetricsRequest.Builder> getAccuracyMetricsRequest)
Provides metrics on the accuracy of the models that were trained by the CreatePredictor operation.
|
default GetAccuracyMetricsResponse |
getAccuracyMetrics(GetAccuracyMetricsRequest getAccuracyMetricsRequest)
Provides metrics on the accuracy of the models that were trained by the CreatePredictor operation.
|
default ListDatasetGroupsResponse |
listDatasetGroups(Consumer<ListDatasetGroupsRequest.Builder> listDatasetGroupsRequest)
Returns a list of dataset groups created using the CreateDatasetGroup
operation.
|
default ListDatasetGroupsResponse |
listDatasetGroups(ListDatasetGroupsRequest listDatasetGroupsRequest)
Returns a list of dataset groups created using the CreateDatasetGroup
operation.
|
default ListDatasetGroupsIterable |
listDatasetGroupsPaginator(Consumer<ListDatasetGroupsRequest.Builder> listDatasetGroupsRequest)
Returns a list of dataset groups created using the CreateDatasetGroup
operation.
|
default ListDatasetGroupsIterable |
listDatasetGroupsPaginator(ListDatasetGroupsRequest listDatasetGroupsRequest)
Returns a list of dataset groups created using the CreateDatasetGroup
operation.
|
default ListDatasetImportJobsResponse |
listDatasetImportJobs(Consumer<ListDatasetImportJobsRequest.Builder> listDatasetImportJobsRequest)
Returns a list of dataset import jobs created using the CreateDatasetImportJob
operation.
|
default ListDatasetImportJobsResponse |
listDatasetImportJobs(ListDatasetImportJobsRequest listDatasetImportJobsRequest)
Returns a list of dataset import jobs created using the CreateDatasetImportJob
operation.
|
default ListDatasetImportJobsIterable |
listDatasetImportJobsPaginator(Consumer<ListDatasetImportJobsRequest.Builder> listDatasetImportJobsRequest)
Returns a list of dataset import jobs created using the CreateDatasetImportJob
operation.
|
default ListDatasetImportJobsIterable |
listDatasetImportJobsPaginator(ListDatasetImportJobsRequest listDatasetImportJobsRequest)
Returns a list of dataset import jobs created using the CreateDatasetImportJob
operation.
|
default ListDatasetsResponse |
listDatasets(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest)
Returns a list of datasets created using the CreateDataset operation.
|
default ListDatasetsResponse |
listDatasets(ListDatasetsRequest listDatasetsRequest)
Returns a list of datasets created using the CreateDataset operation.
|
default ListDatasetsIterable |
listDatasetsPaginator(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest)
Returns a list of datasets created using the CreateDataset operation.
|
default ListDatasetsIterable |
listDatasetsPaginator(ListDatasetsRequest listDatasetsRequest)
Returns a list of datasets created using the CreateDataset operation.
|
default ListExplainabilitiesResponse |
listExplainabilities(Consumer<ListExplainabilitiesRequest.Builder> listExplainabilitiesRequest)
Returns a list of Explainability resources created using the CreateExplainability operation.
|
default ListExplainabilitiesResponse |
listExplainabilities(ListExplainabilitiesRequest listExplainabilitiesRequest)
Returns a list of Explainability resources created using the CreateExplainability operation.
|
default ListExplainabilitiesIterable |
listExplainabilitiesPaginator(Consumer<ListExplainabilitiesRequest.Builder> listExplainabilitiesRequest)
Returns a list of Explainability resources created using the CreateExplainability operation.
|
default ListExplainabilitiesIterable |
listExplainabilitiesPaginator(ListExplainabilitiesRequest listExplainabilitiesRequest)
Returns a list of Explainability resources created using the CreateExplainability operation.
|
default ListExplainabilityExportsResponse |
listExplainabilityExports(Consumer<ListExplainabilityExportsRequest.Builder> listExplainabilityExportsRequest)
Returns a list of Explainability exports created using the CreateExplainabilityExport operation.
|
default ListExplainabilityExportsResponse |
listExplainabilityExports(ListExplainabilityExportsRequest listExplainabilityExportsRequest)
Returns a list of Explainability exports created using the CreateExplainabilityExport operation.
|
default ListExplainabilityExportsIterable |
listExplainabilityExportsPaginator(Consumer<ListExplainabilityExportsRequest.Builder> listExplainabilityExportsRequest)
Returns a list of Explainability exports created using the CreateExplainabilityExport operation.
|
default ListExplainabilityExportsIterable |
listExplainabilityExportsPaginator(ListExplainabilityExportsRequest listExplainabilityExportsRequest)
Returns a list of Explainability exports created using the CreateExplainabilityExport operation.
|
default ListForecastExportJobsResponse |
listForecastExportJobs(Consumer<ListForecastExportJobsRequest.Builder> listForecastExportJobsRequest)
Returns a list of forecast export jobs created using the CreateForecastExportJob operation.
|
default ListForecastExportJobsResponse |
listForecastExportJobs(ListForecastExportJobsRequest listForecastExportJobsRequest)
Returns a list of forecast export jobs created using the CreateForecastExportJob operation.
|
default ListForecastExportJobsIterable |
listForecastExportJobsPaginator(Consumer<ListForecastExportJobsRequest.Builder> listForecastExportJobsRequest)
Returns a list of forecast export jobs created using the CreateForecastExportJob operation.
|
default ListForecastExportJobsIterable |
listForecastExportJobsPaginator(ListForecastExportJobsRequest listForecastExportJobsRequest)
Returns a list of forecast export jobs created using the CreateForecastExportJob operation.
|
default ListForecastsResponse |
listForecasts(Consumer<ListForecastsRequest.Builder> listForecastsRequest)
Returns a list of forecasts created using the CreateForecast operation.
|
default ListForecastsResponse |
listForecasts(ListForecastsRequest listForecastsRequest)
Returns a list of forecasts created using the CreateForecast operation.
|
default ListForecastsIterable |
listForecastsPaginator(Consumer<ListForecastsRequest.Builder> listForecastsRequest)
Returns a list of forecasts created using the CreateForecast operation.
|
default ListForecastsIterable |
listForecastsPaginator(ListForecastsRequest listForecastsRequest)
Returns a list of forecasts created using the CreateForecast operation.
|
default ListMonitorEvaluationsResponse |
listMonitorEvaluations(Consumer<ListMonitorEvaluationsRequest.Builder> listMonitorEvaluationsRequest)
Returns a list of the monitoring evaluation results and predictor events collected by the monitor resource during
different windows of time.
|
default ListMonitorEvaluationsResponse |
listMonitorEvaluations(ListMonitorEvaluationsRequest listMonitorEvaluationsRequest)
Returns a list of the monitoring evaluation results and predictor events collected by the monitor resource during
different windows of time.
|
default ListMonitorEvaluationsIterable |
listMonitorEvaluationsPaginator(Consumer<ListMonitorEvaluationsRequest.Builder> listMonitorEvaluationsRequest)
Returns a list of the monitoring evaluation results and predictor events collected by the monitor resource during
different windows of time.
|
default ListMonitorEvaluationsIterable |
listMonitorEvaluationsPaginator(ListMonitorEvaluationsRequest listMonitorEvaluationsRequest)
Returns a list of the monitoring evaluation results and predictor events collected by the monitor resource during
different windows of time.
|
default ListMonitorsResponse |
listMonitors(Consumer<ListMonitorsRequest.Builder> listMonitorsRequest)
Returns a list of monitors created with the CreateMonitor operation and CreateAutoPredictor
operation.
|
default ListMonitorsResponse |
listMonitors(ListMonitorsRequest listMonitorsRequest)
Returns a list of monitors created with the CreateMonitor operation and CreateAutoPredictor
operation.
|
default ListMonitorsIterable |
listMonitorsPaginator(Consumer<ListMonitorsRequest.Builder> listMonitorsRequest)
Returns a list of monitors created with the CreateMonitor operation and CreateAutoPredictor
operation.
|
default ListMonitorsIterable |
listMonitorsPaginator(ListMonitorsRequest listMonitorsRequest)
Returns a list of monitors created with the CreateMonitor operation and CreateAutoPredictor
operation.
|
default ListPredictorBacktestExportJobsResponse |
listPredictorBacktestExportJobs(Consumer<ListPredictorBacktestExportJobsRequest.Builder> listPredictorBacktestExportJobsRequest)
Returns a list of predictor backtest export jobs created using the CreatePredictorBacktestExportJob
operation.
|
default ListPredictorBacktestExportJobsResponse |
listPredictorBacktestExportJobs(ListPredictorBacktestExportJobsRequest listPredictorBacktestExportJobsRequest)
Returns a list of predictor backtest export jobs created using the CreatePredictorBacktestExportJob
operation.
|
default ListPredictorBacktestExportJobsIterable |
listPredictorBacktestExportJobsPaginator(Consumer<ListPredictorBacktestExportJobsRequest.Builder> listPredictorBacktestExportJobsRequest)
Returns a list of predictor backtest export jobs created using the CreatePredictorBacktestExportJob
operation.
|
default ListPredictorBacktestExportJobsIterable |
listPredictorBacktestExportJobsPaginator(ListPredictorBacktestExportJobsRequest listPredictorBacktestExportJobsRequest)
Returns a list of predictor backtest export jobs created using the CreatePredictorBacktestExportJob
operation.
|
default ListPredictorsResponse |
listPredictors(Consumer<ListPredictorsRequest.Builder> listPredictorsRequest)
Returns a list of predictors created using the CreateAutoPredictor or CreatePredictor operations.
|
default ListPredictorsResponse |
listPredictors(ListPredictorsRequest listPredictorsRequest)
Returns a list of predictors created using the CreateAutoPredictor or CreatePredictor operations.
|
default ListPredictorsIterable |
listPredictorsPaginator(Consumer<ListPredictorsRequest.Builder> listPredictorsRequest)
Returns a list of predictors created using the CreateAutoPredictor or CreatePredictor operations.
|
default ListPredictorsIterable |
listPredictorsPaginator(ListPredictorsRequest listPredictorsRequest)
Returns a list of predictors created using the CreateAutoPredictor or CreatePredictor operations.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags for an Amazon Forecast resource.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags for an Amazon Forecast resource.
|
default ListWhatIfAnalysesResponse |
listWhatIfAnalyses(Consumer<ListWhatIfAnalysesRequest.Builder> listWhatIfAnalysesRequest)
Returns a list of what-if analyses created using the CreateWhatIfAnalysis operation.
|
default ListWhatIfAnalysesResponse |
listWhatIfAnalyses(ListWhatIfAnalysesRequest listWhatIfAnalysesRequest)
Returns a list of what-if analyses created using the CreateWhatIfAnalysis operation.
|
default ListWhatIfAnalysesIterable |
listWhatIfAnalysesPaginator(Consumer<ListWhatIfAnalysesRequest.Builder> listWhatIfAnalysesRequest)
Returns a list of what-if analyses created using the CreateWhatIfAnalysis operation.
|
default ListWhatIfAnalysesIterable |
listWhatIfAnalysesPaginator(ListWhatIfAnalysesRequest listWhatIfAnalysesRequest)
Returns a list of what-if analyses created using the CreateWhatIfAnalysis operation.
|
default ListWhatIfForecastExportsResponse |
listWhatIfForecastExports(Consumer<ListWhatIfForecastExportsRequest.Builder> listWhatIfForecastExportsRequest)
Returns a list of what-if forecast exports created using the CreateWhatIfForecastExport operation.
|
default ListWhatIfForecastExportsResponse |
listWhatIfForecastExports(ListWhatIfForecastExportsRequest listWhatIfForecastExportsRequest)
Returns a list of what-if forecast exports created using the CreateWhatIfForecastExport operation.
|
default ListWhatIfForecastExportsIterable |
listWhatIfForecastExportsPaginator(Consumer<ListWhatIfForecastExportsRequest.Builder> listWhatIfForecastExportsRequest)
Returns a list of what-if forecast exports created using the CreateWhatIfForecastExport operation.
|
default ListWhatIfForecastExportsIterable |
listWhatIfForecastExportsPaginator(ListWhatIfForecastExportsRequest listWhatIfForecastExportsRequest)
Returns a list of what-if forecast exports created using the CreateWhatIfForecastExport operation.
|
default ListWhatIfForecastsResponse |
listWhatIfForecasts(Consumer<ListWhatIfForecastsRequest.Builder> listWhatIfForecastsRequest)
Returns a list of what-if forecasts created using the CreateWhatIfForecast operation.
|
default ListWhatIfForecastsResponse |
listWhatIfForecasts(ListWhatIfForecastsRequest listWhatIfForecastsRequest)
Returns a list of what-if forecasts created using the CreateWhatIfForecast operation.
|
default ListWhatIfForecastsIterable |
listWhatIfForecastsPaginator(Consumer<ListWhatIfForecastsRequest.Builder> listWhatIfForecastsRequest)
Returns a list of what-if forecasts created using the CreateWhatIfForecast operation.
|
default ListWhatIfForecastsIterable |
listWhatIfForecastsPaginator(ListWhatIfForecastsRequest listWhatIfForecastsRequest)
Returns a list of what-if forecasts created using the CreateWhatIfForecast operation.
|
default ResumeResourceResponse |
resumeResource(Consumer<ResumeResourceRequest.Builder> resumeResourceRequest)
Resumes a stopped monitor resource.
|
default ResumeResourceResponse |
resumeResource(ResumeResourceRequest resumeResourceRequest)
Resumes a stopped monitor resource.
|
default ForecastServiceClientConfiguration |
serviceClientConfiguration() |
static ServiceMetadata |
serviceMetadata() |
default StopResourceResponse |
stopResource(Consumer<StopResourceRequest.Builder> stopResourceRequest)
Stops a resource.
|
default StopResourceResponse |
stopResource(StopResourceRequest stopResourceRequest)
Stops a resource.
|
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Associates the specified tags to a resource with the specified
resourceArn. |
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Associates the specified tags to a resource with the specified
resourceArn. |
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Deletes the specified tags from a resource.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Deletes the specified tags from a resource.
|
default UpdateDatasetGroupResponse |
updateDatasetGroup(Consumer<UpdateDatasetGroupRequest.Builder> updateDatasetGroupRequest)
Replaces the datasets in a dataset group with the specified datasets.
|
default UpdateDatasetGroupResponse |
updateDatasetGroup(UpdateDatasetGroupRequest updateDatasetGroupRequest)
Replaces the datasets in a dataset group with the specified datasets.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CreateAutoPredictorResponse createAutoPredictor(CreateAutoPredictorRequest createAutoPredictorRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
Creates an Amazon Forecast predictor.
Amazon Forecast creates predictors with AutoPredictor, which involves applying the optimal combination of algorithms to each time series in your datasets. You can use CreateAutoPredictor to create new predictors or upgrade/retrain existing predictors.
Creating new predictors
The following parameters are required when creating a new predictor:
PredictorName - A unique name for the predictor.
DatasetGroupArn - The ARN of the dataset group used to train the predictor.
ForecastFrequency - The granularity of your forecasts (hourly, daily, weekly, etc).
ForecastHorizon - The number of time-steps that the model predicts. The forecast horizon is also
called the prediction length.
When creating a new predictor, do not specify a value for ReferencePredictorArn.
Upgrading and retraining predictors
The following parameters are required when retraining or upgrading a predictor:
PredictorName - A unique name for the predictor.
ReferencePredictorArn - The ARN of the predictor to retrain or upgrade.
When upgrading or retraining a predictor, only specify values for the ReferencePredictorArn and
PredictorName.
createAutoPredictorRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateAutoPredictorResponse createAutoPredictor(Consumer<CreateAutoPredictorRequest.Builder> createAutoPredictorRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
Creates an Amazon Forecast predictor.
Amazon Forecast creates predictors with AutoPredictor, which involves applying the optimal combination of algorithms to each time series in your datasets. You can use CreateAutoPredictor to create new predictors or upgrade/retrain existing predictors.
Creating new predictors
The following parameters are required when creating a new predictor:
PredictorName - A unique name for the predictor.
DatasetGroupArn - The ARN of the dataset group used to train the predictor.
ForecastFrequency - The granularity of your forecasts (hourly, daily, weekly, etc).
ForecastHorizon - The number of time-steps that the model predicts. The forecast horizon is also
called the prediction length.
When creating a new predictor, do not specify a value for ReferencePredictorArn.
Upgrading and retraining predictors
The following parameters are required when retraining or upgrading a predictor:
PredictorName - A unique name for the predictor.
ReferencePredictorArn - The ARN of the predictor to retrain or upgrade.
When upgrading or retraining a predictor, only specify values for the ReferencePredictorArn and
PredictorName.
This is a convenience which creates an instance of the CreateAutoPredictorRequest.Builder avoiding the
need to create one manually via CreateAutoPredictorRequest.builder()
createAutoPredictorRequest - A Consumer that will call methods on
CreateAutoPredictorRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDatasetResponse createDataset(CreateDatasetRequest createDatasetRequest) throws InvalidInputException, ResourceAlreadyExistsException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
Creates an Amazon Forecast dataset. The information about the dataset that you provide helps Forecast understand how to consume the data for model training. This includes the following:
DataFrequency - How frequently your historical time-series data is collected.
Domain and DatasetType - Each dataset has an associated dataset
domain and a type within the domain. Amazon Forecast provides a list of predefined domains and types within each
domain. For each unique dataset domain and type within the domain, Amazon Forecast requires your data to include
a minimum set of predefined fields.
Schema - A schema specifies the fields in the dataset, including the field name and data
type.
After creating a dataset, you import your training data into it and add the dataset to a dataset group. You use the dataset group to create a predictor. For more information, see Importing datasets.
To get a list of all your datasets, use the ListDatasets operation.
For example Forecast datasets, see the Amazon Forecast Sample GitHub repository.
The Status of a dataset must be ACTIVE before you can import training data. Use the DescribeDataset operation to
get the status.
createDatasetRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDatasetResponse createDataset(Consumer<CreateDatasetRequest.Builder> createDatasetRequest) throws InvalidInputException, ResourceAlreadyExistsException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
Creates an Amazon Forecast dataset. The information about the dataset that you provide helps Forecast understand how to consume the data for model training. This includes the following:
DataFrequency - How frequently your historical time-series data is collected.
Domain and DatasetType - Each dataset has an associated dataset
domain and a type within the domain. Amazon Forecast provides a list of predefined domains and types within each
domain. For each unique dataset domain and type within the domain, Amazon Forecast requires your data to include
a minimum set of predefined fields.
Schema - A schema specifies the fields in the dataset, including the field name and data
type.
After creating a dataset, you import your training data into it and add the dataset to a dataset group. You use the dataset group to create a predictor. For more information, see Importing datasets.
To get a list of all your datasets, use the ListDatasets operation.
For example Forecast datasets, see the Amazon Forecast Sample GitHub repository.
The Status of a dataset must be ACTIVE before you can import training data. Use the DescribeDataset operation to
get the status.
This is a convenience which creates an instance of the CreateDatasetRequest.Builder avoiding the need to
create one manually via CreateDatasetRequest.builder()
createDatasetRequest - A Consumer that will call methods on
CreateDatasetRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDatasetGroupResponse createDatasetGroup(CreateDatasetGroupRequest createDatasetGroupRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
Creates a dataset group, which holds a collection of related datasets. You can add datasets to the dataset group when you create the dataset group, or later by using the UpdateDatasetGroup operation.
After creating a dataset group and adding datasets, you use the dataset group when you create a predictor. For more information, see Dataset groups.
To get a list of all your datasets groups, use the ListDatasetGroups operation.
The Status of a dataset group must be ACTIVE before you can use the dataset group to
create a predictor. To get the status, use the DescribeDatasetGroup
operation.
createDatasetGroupRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDatasetGroupResponse createDatasetGroup(Consumer<CreateDatasetGroupRequest.Builder> createDatasetGroupRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
Creates a dataset group, which holds a collection of related datasets. You can add datasets to the dataset group when you create the dataset group, or later by using the UpdateDatasetGroup operation.
After creating a dataset group and adding datasets, you use the dataset group when you create a predictor. For more information, see Dataset groups.
To get a list of all your datasets groups, use the ListDatasetGroups operation.
The Status of a dataset group must be ACTIVE before you can use the dataset group to
create a predictor. To get the status, use the DescribeDatasetGroup
operation.
This is a convenience which creates an instance of the CreateDatasetGroupRequest.Builder avoiding the
need to create one manually via CreateDatasetGroupRequest.builder()
createDatasetGroupRequest - A Consumer that will call methods on
CreateDatasetGroupRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDatasetImportJobResponse createDatasetImportJob(CreateDatasetImportJobRequest createDatasetImportJobRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
Imports your training data to an Amazon Forecast dataset. You provide the location of your training data in an Amazon Simple Storage Service (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset that you want to import the data to.
You must specify a DataSource object that includes an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy of your data and processes it in an internal Amazon Web Services system. For more information, see Set up permissions.
The training data must be in CSV or Parquet format. The delimiter must be a comma (,).
You can specify the path to a specific file, the S3 bucket, or to a folder in the S3 bucket. For the latter two cases, Amazon Forecast imports all files up to the limit of 10,000 files.
Because dataset imports are not aggregated, your most recent dataset import is the one that is used when training a predictor or generating a forecast. Make sure that your most recent dataset import contains all of the data you want to model off of, and not just the new data collected since the previous import.
To get a list of all your dataset import jobs, filtered by specified criteria, use the ListDatasetImportJobs operation.
createDatasetImportJobRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDatasetImportJobResponse createDatasetImportJob(Consumer<CreateDatasetImportJobRequest.Builder> createDatasetImportJobRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
Imports your training data to an Amazon Forecast dataset. You provide the location of your training data in an Amazon Simple Storage Service (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset that you want to import the data to.
You must specify a DataSource object that includes an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy of your data and processes it in an internal Amazon Web Services system. For more information, see Set up permissions.
The training data must be in CSV or Parquet format. The delimiter must be a comma (,).
You can specify the path to a specific file, the S3 bucket, or to a folder in the S3 bucket. For the latter two cases, Amazon Forecast imports all files up to the limit of 10,000 files.
Because dataset imports are not aggregated, your most recent dataset import is the one that is used when training a predictor or generating a forecast. Make sure that your most recent dataset import contains all of the data you want to model off of, and not just the new data collected since the previous import.
To get a list of all your dataset import jobs, filtered by specified criteria, use the ListDatasetImportJobs operation.
This is a convenience which creates an instance of the CreateDatasetImportJobRequest.Builder avoiding the
need to create one manually via CreateDatasetImportJobRequest.builder()
createDatasetImportJobRequest - A Consumer that will call methods on
CreateDatasetImportJobRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateExplainabilityResponse createExplainability(CreateExplainabilityRequest createExplainabilityRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
Explainability is only available for Forecasts and Predictors generated from an AutoPredictor (CreateAutoPredictor)
Creates an Amazon Forecast Explainability.
Explainability helps you better understand how the attributes in your datasets impact forecast. Amazon Forecast uses a metric called Impact scores to quantify the relative impact of each attribute and determine whether they increase or decrease forecast values.
To enable Forecast Explainability, your predictor must include at least one of the following: related time series, item metadata, or additional datasets like Holidays and the Weather Index.
CreateExplainability accepts either a Predictor ARN or Forecast ARN. To receive aggregated Impact scores for all time series and time points in your datasets, provide a Predictor ARN. To receive Impact scores for specific time series and time points, provide a Forecast ARN.
CreateExplainability with a Predictor ARN
You can only have one Explainability resource per predictor. If you already enabled ExplainPredictor
in CreateAutoPredictor, that predictor already has an Explainability resource.
The following parameters are required when providing a Predictor ARN:
ExplainabilityName - A unique name for the Explainability.
ResourceArn - The Arn of the predictor.
TimePointGranularity - Must be set to “ALL”.
TimeSeriesGranularity - Must be set to “ALL”.
Do not specify a value for the following parameters:
DataSource - Only valid when TimeSeriesGranularity is “SPECIFIC”.
Schema - Only valid when TimeSeriesGranularity is “SPECIFIC”.
StartDateTime - Only valid when TimePointGranularity is “SPECIFIC”.
EndDateTime - Only valid when TimePointGranularity is “SPECIFIC”.
CreateExplainability with a Forecast ARN
You can specify a maximum of 50 time series and 500 time points.
The following parameters are required when providing a Predictor ARN:
ExplainabilityName - A unique name for the Explainability.
ResourceArn - The Arn of the forecast.
TimePointGranularity - Either “ALL” or “SPECIFIC”.
TimeSeriesGranularity - Either “ALL” or “SPECIFIC”.
If you set TimeSeriesGranularity to “SPECIFIC”, you must also provide the following:
DataSource - The S3 location of the CSV file specifying your time series.
Schema - The Schema defines the attributes and attribute types listed in the Data Source.
If you set TimePointGranularity to “SPECIFIC”, you must also provide the following:
StartDateTime - The first timestamp in the range of time points.
EndDateTime - The last timestamp in the range of time points.
createExplainabilityRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateExplainabilityResponse createExplainability(Consumer<CreateExplainabilityRequest.Builder> createExplainabilityRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
Explainability is only available for Forecasts and Predictors generated from an AutoPredictor (CreateAutoPredictor)
Creates an Amazon Forecast Explainability.
Explainability helps you better understand how the attributes in your datasets impact forecast. Amazon Forecast uses a metric called Impact scores to quantify the relative impact of each attribute and determine whether they increase or decrease forecast values.
To enable Forecast Explainability, your predictor must include at least one of the following: related time series, item metadata, or additional datasets like Holidays and the Weather Index.
CreateExplainability accepts either a Predictor ARN or Forecast ARN. To receive aggregated Impact scores for all time series and time points in your datasets, provide a Predictor ARN. To receive Impact scores for specific time series and time points, provide a Forecast ARN.
CreateExplainability with a Predictor ARN
You can only have one Explainability resource per predictor. If you already enabled ExplainPredictor
in CreateAutoPredictor, that predictor already has an Explainability resource.
The following parameters are required when providing a Predictor ARN:
ExplainabilityName - A unique name for the Explainability.
ResourceArn - The Arn of the predictor.
TimePointGranularity - Must be set to “ALL”.
TimeSeriesGranularity - Must be set to “ALL”.
Do not specify a value for the following parameters:
DataSource - Only valid when TimeSeriesGranularity is “SPECIFIC”.
Schema - Only valid when TimeSeriesGranularity is “SPECIFIC”.
StartDateTime - Only valid when TimePointGranularity is “SPECIFIC”.
EndDateTime - Only valid when TimePointGranularity is “SPECIFIC”.
CreateExplainability with a Forecast ARN
You can specify a maximum of 50 time series and 500 time points.
The following parameters are required when providing a Predictor ARN:
ExplainabilityName - A unique name for the Explainability.
ResourceArn - The Arn of the forecast.
TimePointGranularity - Either “ALL” or “SPECIFIC”.
TimeSeriesGranularity - Either “ALL” or “SPECIFIC”.
If you set TimeSeriesGranularity to “SPECIFIC”, you must also provide the following:
DataSource - The S3 location of the CSV file specifying your time series.
Schema - The Schema defines the attributes and attribute types listed in the Data Source.
If you set TimePointGranularity to “SPECIFIC”, you must also provide the following:
StartDateTime - The first timestamp in the range of time points.
EndDateTime - The last timestamp in the range of time points.
This is a convenience which creates an instance of the CreateExplainabilityRequest.Builder avoiding the
need to create one manually via CreateExplainabilityRequest.builder()
createExplainabilityRequest - A Consumer that will call methods on
CreateExplainabilityRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateExplainabilityExportResponse createExplainabilityExport(CreateExplainabilityExportRequest createExplainabilityExportRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
Exports an Explainability resource created by the CreateExplainability operation. Exported files are exported to an Amazon Simple Storage Service (Amazon S3) bucket.
You must specify a DataDestination object that includes an Amazon S3 bucket and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.
The Status of the export job must be ACTIVE before you can access the export in your
Amazon S3 bucket. To get the status, use the DescribeExplainabilityExport operation.
createExplainabilityExportRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateExplainabilityExportResponse createExplainabilityExport(Consumer<CreateExplainabilityExportRequest.Builder> createExplainabilityExportRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
Exports an Explainability resource created by the CreateExplainability operation. Exported files are exported to an Amazon Simple Storage Service (Amazon S3) bucket.
You must specify a DataDestination object that includes an Amazon S3 bucket and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.
The Status of the export job must be ACTIVE before you can access the export in your
Amazon S3 bucket. To get the status, use the DescribeExplainabilityExport operation.
This is a convenience which creates an instance of the CreateExplainabilityExportRequest.Builder avoiding
the need to create one manually via CreateExplainabilityExportRequest.builder()
createExplainabilityExportRequest - A Consumer that will call methods on
CreateExplainabilityExportRequest.Builder to create
a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateForecastResponse createForecast(CreateForecastRequest createForecastRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
Creates a forecast for each item in the TARGET_TIME_SERIES dataset that was used to train the
predictor. This is known as inference. To retrieve the forecast for a single item at low latency, use the
operation. To export the complete forecast into your Amazon Simple Storage Service (Amazon S3) bucket, use the
CreateForecastExportJob operation.
The range of the forecast is determined by the ForecastHorizon value, which you specify in the
CreatePredictor request. When you query a forecast, you can request a specific date range within the
forecast.
To get a list of all your forecasts, use the ListForecasts operation.
The forecasts generated by Amazon Forecast are in the same time zone as the dataset that was used to create the predictor.
For more information, see howitworks-forecast.
The Status of the forecast must be ACTIVE before you can query or export the forecast.
Use the DescribeForecast operation to get the status.
By default, a forecast includes predictions for every item (item_id) in the dataset group that was
used to train the predictor. However, you can use the TimeSeriesSelector object to generate a
forecast on a subset of time series. Forecast creation is skipped for any time series that you specify that are
not in the input dataset. The forecast export file will not contain these time series or their forecasted values.
createForecastRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateForecastResponse createForecast(Consumer<CreateForecastRequest.Builder> createForecastRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
Creates a forecast for each item in the TARGET_TIME_SERIES dataset that was used to train the
predictor. This is known as inference. To retrieve the forecast for a single item at low latency, use the
operation. To export the complete forecast into your Amazon Simple Storage Service (Amazon S3) bucket, use the
CreateForecastExportJob operation.
The range of the forecast is determined by the ForecastHorizon value, which you specify in the
CreatePredictor request. When you query a forecast, you can request a specific date range within the
forecast.
To get a list of all your forecasts, use the ListForecasts operation.
The forecasts generated by Amazon Forecast are in the same time zone as the dataset that was used to create the predictor.
For more information, see howitworks-forecast.
The Status of the forecast must be ACTIVE before you can query or export the forecast.
Use the DescribeForecast operation to get the status.
By default, a forecast includes predictions for every item (item_id) in the dataset group that was
used to train the predictor. However, you can use the TimeSeriesSelector object to generate a
forecast on a subset of time series. Forecast creation is skipped for any time series that you specify that are
not in the input dataset. The forecast export file will not contain these time series or their forecasted values.
This is a convenience which creates an instance of the CreateForecastRequest.Builder avoiding the need to
create one manually via CreateForecastRequest.builder()
createForecastRequest - A Consumer that will call methods on
CreateForecastRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateForecastExportJobResponse createForecastExportJob(CreateForecastExportJobRequest createForecastExportJobRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
Exports a forecast created by the CreateForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions:
<ForecastExportJobName>_<ExportTimestamp>_<PartNumber>
where the <ExportTimestamp> component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).
You must specify a DataDestination object that includes an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.
For more information, see howitworks-forecast.
To get a list of all your forecast export jobs, use the ListForecastExportJobs operation.
The Status of the forecast export job must be ACTIVE before you can access the forecast
in your Amazon S3 bucket. To get the status, use the DescribeForecastExportJob operation.
createForecastExportJobRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateForecastExportJobResponse createForecastExportJob(Consumer<CreateForecastExportJobRequest.Builder> createForecastExportJobRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
Exports a forecast created by the CreateForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions:
<ForecastExportJobName>_<ExportTimestamp>_<PartNumber>
where the <ExportTimestamp> component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).
You must specify a DataDestination object that includes an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.
For more information, see howitworks-forecast.
To get a list of all your forecast export jobs, use the ListForecastExportJobs operation.
The Status of the forecast export job must be ACTIVE before you can access the forecast
in your Amazon S3 bucket. To get the status, use the DescribeForecastExportJob operation.
This is a convenience which creates an instance of the CreateForecastExportJobRequest.Builder avoiding
the need to create one manually via CreateForecastExportJobRequest.builder()
createForecastExportJobRequest - A Consumer that will call methods on
CreateForecastExportJobRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateMonitorResponse createMonitor(CreateMonitorRequest createMonitorRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
Creates a predictor monitor resource for an existing auto predictor. Predictor monitoring allows you to see how your predictor's performance changes over time. For more information, see Predictor Monitoring.
createMonitorRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateMonitorResponse createMonitor(Consumer<CreateMonitorRequest.Builder> createMonitorRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
Creates a predictor monitor resource for an existing auto predictor. Predictor monitoring allows you to see how your predictor's performance changes over time. For more information, see Predictor Monitoring.
This is a convenience which creates an instance of the CreateMonitorRequest.Builder avoiding the need to
create one manually via CreateMonitorRequest.builder()
createMonitorRequest - A Consumer that will call methods on
CreateMonitorRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreatePredictorResponse createPredictor(CreatePredictorRequest createPredictorRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
This operation creates a legacy predictor that does not include all the predictor functionalities provided by Amazon Forecast. To create a predictor that is compatible with all aspects of Forecast, use CreateAutoPredictor.
Creates an Amazon Forecast predictor.
In the request, provide a dataset group and either specify an algorithm or let Amazon Forecast choose an algorithm for you using AutoML. If you specify an algorithm, you also can override algorithm-specific hyperparameters.
Amazon Forecast uses the algorithm to train a predictor using the latest version of the datasets in the specified dataset group. You can then generate a forecast using the CreateForecast operation.
To see the evaluation metrics, use the GetAccuracyMetrics operation.
You can specify a featurization configuration to fill and aggregate the data fields in the
TARGET_TIME_SERIES dataset to improve model training. For more information, see
FeaturizationConfig.
For RELATED_TIME_SERIES datasets, CreatePredictor verifies that the DataFrequency
specified when the dataset was created matches the ForecastFrequency. TARGET_TIME_SERIES datasets
don't have this restriction. Amazon Forecast also verifies the delimiter and timestamp format. For more
information, see howitworks-datasets-groups.
By default, predictors are trained and evaluated at the 0.1 (P10), 0.5 (P50), and 0.9 (P90) quantiles. You can
choose custom forecast types to train and evaluate your predictor by setting the ForecastTypes.
AutoML
If you want Amazon Forecast to evaluate each algorithm and choose the one that minimizes the
objective function, set PerformAutoML to true. The
objective function is defined as the mean of the weighted losses over the forecast types. By
default, these are the p10, p50, and p90 quantile losses. For more information, see EvaluationResult.
When AutoML is enabled, the following properties are disallowed:
AlgorithmArn
HPOConfig
PerformHPO
TrainingParameters
To get a list of all of your predictors, use the ListPredictors operation.
Before you can use the predictor to create a forecast, the Status of the predictor must be
ACTIVE, signifying that training has completed. To get the status, use the DescribePredictor
operation.
createPredictorRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreatePredictorResponse createPredictor(Consumer<CreatePredictorRequest.Builder> createPredictorRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
This operation creates a legacy predictor that does not include all the predictor functionalities provided by Amazon Forecast. To create a predictor that is compatible with all aspects of Forecast, use CreateAutoPredictor.
Creates an Amazon Forecast predictor.
In the request, provide a dataset group and either specify an algorithm or let Amazon Forecast choose an algorithm for you using AutoML. If you specify an algorithm, you also can override algorithm-specific hyperparameters.
Amazon Forecast uses the algorithm to train a predictor using the latest version of the datasets in the specified dataset group. You can then generate a forecast using the CreateForecast operation.
To see the evaluation metrics, use the GetAccuracyMetrics operation.
You can specify a featurization configuration to fill and aggregate the data fields in the
TARGET_TIME_SERIES dataset to improve model training. For more information, see
FeaturizationConfig.
For RELATED_TIME_SERIES datasets, CreatePredictor verifies that the DataFrequency
specified when the dataset was created matches the ForecastFrequency. TARGET_TIME_SERIES datasets
don't have this restriction. Amazon Forecast also verifies the delimiter and timestamp format. For more
information, see howitworks-datasets-groups.
By default, predictors are trained and evaluated at the 0.1 (P10), 0.5 (P50), and 0.9 (P90) quantiles. You can
choose custom forecast types to train and evaluate your predictor by setting the ForecastTypes.
AutoML
If you want Amazon Forecast to evaluate each algorithm and choose the one that minimizes the
objective function, set PerformAutoML to true. The
objective function is defined as the mean of the weighted losses over the forecast types. By
default, these are the p10, p50, and p90 quantile losses. For more information, see EvaluationResult.
When AutoML is enabled, the following properties are disallowed:
AlgorithmArn
HPOConfig
PerformHPO
TrainingParameters
To get a list of all of your predictors, use the ListPredictors operation.
Before you can use the predictor to create a forecast, the Status of the predictor must be
ACTIVE, signifying that training has completed. To get the status, use the DescribePredictor
operation.
This is a convenience which creates an instance of the CreatePredictorRequest.Builder avoiding the need
to create one manually via CreatePredictorRequest.builder()
createPredictorRequest - A Consumer that will call methods on
CreatePredictorRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreatePredictorBacktestExportJobResponse createPredictorBacktestExportJob(CreatePredictorBacktestExportJobRequest createPredictorBacktestExportJobRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
Exports backtest forecasts and accuracy metrics generated by the CreateAutoPredictor or CreatePredictor operations. Two folders containing CSV or Parquet files are exported to your specified S3 bucket.
The export file names will match the following conventions:
<ExportJobName>_<ExportTimestamp>_<PartNumber>.csv
The <ExportTimestamp> component is in Java SimpleDate format (yyyy-MM-ddTHH-mm-ssZ).
You must specify a DataDestination object that includes an Amazon S3 bucket and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.
The Status of the export job must be ACTIVE before you can access the export in your
Amazon S3 bucket. To get the status, use the DescribePredictorBacktestExportJob operation.
createPredictorBacktestExportJobRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreatePredictorBacktestExportJobResponse createPredictorBacktestExportJob(Consumer<CreatePredictorBacktestExportJobRequest.Builder> createPredictorBacktestExportJobRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
Exports backtest forecasts and accuracy metrics generated by the CreateAutoPredictor or CreatePredictor operations. Two folders containing CSV or Parquet files are exported to your specified S3 bucket.
The export file names will match the following conventions:
<ExportJobName>_<ExportTimestamp>_<PartNumber>.csv
The <ExportTimestamp> component is in Java SimpleDate format (yyyy-MM-ddTHH-mm-ssZ).
You must specify a DataDestination object that includes an Amazon S3 bucket and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.
The Status of the export job must be ACTIVE before you can access the export in your
Amazon S3 bucket. To get the status, use the DescribePredictorBacktestExportJob operation.
This is a convenience which creates an instance of the CreatePredictorBacktestExportJobRequest.Builder
avoiding the need to create one manually via CreatePredictorBacktestExportJobRequest.builder()
createPredictorBacktestExportJobRequest - A Consumer that will call methods on
CreatePredictorBacktestExportJobRequest.Builder to
create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateWhatIfAnalysisResponse createWhatIfAnalysis(CreateWhatIfAnalysisRequest createWhatIfAnalysisRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
What-if analysis is a scenario modeling technique where you make a hypothetical change to a time series and compare the forecasts generated by these changes against the baseline, unchanged time series. It is important to remember that the purpose of a what-if analysis is to understand how a forecast can change given different modifications to the baseline time series.
For example, imagine you are a clothing retailer who is considering an end of season sale to clear space for new styles. After creating a baseline forecast, you can use a what-if analysis to investigate how different sales tactics might affect your goals.
You could create a scenario where everything is given a 25% markdown, and another where everything is given a fixed dollar markdown. You could create a scenario where the sale lasts for one week and another where the sale lasts for one month. With a what-if analysis, you can compare many different scenarios against each other.
Note that a what-if analysis is meant to display what the forecasting model has learned and how it will behave in the scenarios that you are evaluating. Do not blindly use the results of the what-if analysis to make business decisions. For instance, forecasts might not be accurate for novel scenarios where there is no reference available to determine whether a forecast is good.
The TimeSeriesSelector object defines the items that you want in the what-if analysis.
createWhatIfAnalysisRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateWhatIfAnalysisResponse createWhatIfAnalysis(Consumer<CreateWhatIfAnalysisRequest.Builder> createWhatIfAnalysisRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
What-if analysis is a scenario modeling technique where you make a hypothetical change to a time series and compare the forecasts generated by these changes against the baseline, unchanged time series. It is important to remember that the purpose of a what-if analysis is to understand how a forecast can change given different modifications to the baseline time series.
For example, imagine you are a clothing retailer who is considering an end of season sale to clear space for new styles. After creating a baseline forecast, you can use a what-if analysis to investigate how different sales tactics might affect your goals.
You could create a scenario where everything is given a 25% markdown, and another where everything is given a fixed dollar markdown. You could create a scenario where the sale lasts for one week and another where the sale lasts for one month. With a what-if analysis, you can compare many different scenarios against each other.
Note that a what-if analysis is meant to display what the forecasting model has learned and how it will behave in the scenarios that you are evaluating. Do not blindly use the results of the what-if analysis to make business decisions. For instance, forecasts might not be accurate for novel scenarios where there is no reference available to determine whether a forecast is good.
The TimeSeriesSelector object defines the items that you want in the what-if analysis.
This is a convenience which creates an instance of the CreateWhatIfAnalysisRequest.Builder avoiding the
need to create one manually via CreateWhatIfAnalysisRequest.builder()
createWhatIfAnalysisRequest - A Consumer that will call methods on
CreateWhatIfAnalysisRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateWhatIfForecastResponse createWhatIfForecast(CreateWhatIfForecastRequest createWhatIfForecastRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
A what-if forecast is a forecast that is created from a modified version of the baseline forecast. Each what-if forecast incorporates either a replacement dataset or a set of transformations to the original dataset.
createWhatIfForecastRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateWhatIfForecastResponse createWhatIfForecast(Consumer<CreateWhatIfForecastRequest.Builder> createWhatIfForecastRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
A what-if forecast is a forecast that is created from a modified version of the baseline forecast. Each what-if forecast incorporates either a replacement dataset or a set of transformations to the original dataset.
This is a convenience which creates an instance of the CreateWhatIfForecastRequest.Builder avoiding the
need to create one manually via CreateWhatIfForecastRequest.builder()
createWhatIfForecastRequest - A Consumer that will call methods on
CreateWhatIfForecastRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateWhatIfForecastExportResponse createWhatIfForecastExport(CreateWhatIfForecastExportRequest createWhatIfForecastExportRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
Exports a forecast created by the CreateWhatIfForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions:
≈<ForecastExportJobName>_<ExportTimestamp>_<PartNumber>
The <ExportTimestamp> component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).
You must specify a DataDestination object that includes an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.
For more information, see howitworks-forecast.
To get a list of all your what-if forecast export jobs, use the ListWhatIfForecastExports operation.
The Status of the forecast export job must be ACTIVE before you can access the forecast
in your Amazon S3 bucket. To get the status, use the DescribeWhatIfForecastExport operation.
createWhatIfForecastExportRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateWhatIfForecastExportResponse createWhatIfForecastExport(Consumer<CreateWhatIfForecastExportRequest.Builder> createWhatIfForecastExportRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
Exports a forecast created by the CreateWhatIfForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions:
≈<ForecastExportJobName>_<ExportTimestamp>_<PartNumber>
The <ExportTimestamp> component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).
You must specify a DataDestination object that includes an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.
For more information, see howitworks-forecast.
To get a list of all your what-if forecast export jobs, use the ListWhatIfForecastExports operation.
The Status of the forecast export job must be ACTIVE before you can access the forecast
in your Amazon S3 bucket. To get the status, use the DescribeWhatIfForecastExport operation.
This is a convenience which creates an instance of the CreateWhatIfForecastExportRequest.Builder avoiding
the need to create one manually via CreateWhatIfForecastExportRequest.builder()
createWhatIfForecastExportRequest - A Consumer that will call methods on
CreateWhatIfForecastExportRequest.Builder to create
a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDatasetResponse deleteDataset(DeleteDatasetRequest deleteDatasetRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Deletes an Amazon Forecast dataset that was created using the CreateDataset operation. You can
only delete datasets that have a status of ACTIVE or CREATE_FAILED. To get the status
use the DescribeDataset
operation.
Forecast does not automatically update any dataset groups that contain the deleted dataset. In order to update the dataset group, use the UpdateDatasetGroup operation, omitting the deleted dataset's ARN.
deleteDatasetRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDatasetResponse deleteDataset(Consumer<DeleteDatasetRequest.Builder> deleteDatasetRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Deletes an Amazon Forecast dataset that was created using the CreateDataset operation. You can
only delete datasets that have a status of ACTIVE or CREATE_FAILED. To get the status
use the DescribeDataset
operation.
Forecast does not automatically update any dataset groups that contain the deleted dataset. In order to update the dataset group, use the UpdateDatasetGroup operation, omitting the deleted dataset's ARN.
This is a convenience which creates an instance of the DeleteDatasetRequest.Builder avoiding the need to
create one manually via DeleteDatasetRequest.builder()
deleteDatasetRequest - A Consumer that will call methods on
DeleteDatasetRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDatasetGroupResponse deleteDatasetGroup(DeleteDatasetGroupRequest deleteDatasetGroupRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Deletes a dataset group created using the CreateDatasetGroup
operation. You can only delete dataset groups that have a status of ACTIVE,
CREATE_FAILED, or UPDATE_FAILED. To get the status, use the DescribeDatasetGroup
operation.
This operation deletes only the dataset group, not the datasets in the group.
deleteDatasetGroupRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDatasetGroupResponse deleteDatasetGroup(Consumer<DeleteDatasetGroupRequest.Builder> deleteDatasetGroupRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
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.
This is a convenience which creates an instance of the DeleteDatasetGroupRequest.Builder avoiding the
need to create one manually via DeleteDatasetGroupRequest.builder()
deleteDatasetGroupRequest - A Consumer that will call methods on
DeleteDatasetGroupRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDatasetImportJobResponse deleteDatasetImportJob(DeleteDatasetImportJobRequest deleteDatasetImportJobRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Deletes a dataset import job created using the CreateDatasetImportJob
operation. You can delete only dataset import jobs that have a status of ACTIVE or
CREATE_FAILED. To get the status, use the DescribeDatasetImportJob operation.
deleteDatasetImportJobRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDatasetImportJobResponse deleteDatasetImportJob(Consumer<DeleteDatasetImportJobRequest.Builder> deleteDatasetImportJobRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
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.
This is a convenience which creates an instance of the DeleteDatasetImportJobRequest.Builder avoiding the
need to create one manually via DeleteDatasetImportJobRequest.builder()
deleteDatasetImportJobRequest - A Consumer that will call methods on
DeleteDatasetImportJobRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteExplainabilityResponse deleteExplainability(DeleteExplainabilityRequest deleteExplainabilityRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Deletes an Explainability resource.
You can delete only predictor that have a status of ACTIVE or CREATE_FAILED. To get the
status, use the DescribeExplainability operation.
deleteExplainabilityRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteExplainabilityResponse deleteExplainability(Consumer<DeleteExplainabilityRequest.Builder> deleteExplainabilityRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Deletes an Explainability resource.
You can delete only predictor that have a status of ACTIVE or CREATE_FAILED. To get the
status, use the DescribeExplainability operation.
This is a convenience which creates an instance of the DeleteExplainabilityRequest.Builder avoiding the
need to create one manually via DeleteExplainabilityRequest.builder()
deleteExplainabilityRequest - A Consumer that will call methods on
DeleteExplainabilityRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteExplainabilityExportResponse deleteExplainabilityExport(DeleteExplainabilityExportRequest deleteExplainabilityExportRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Deletes an Explainability export.
deleteExplainabilityExportRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteExplainabilityExportResponse deleteExplainabilityExport(Consumer<DeleteExplainabilityExportRequest.Builder> deleteExplainabilityExportRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Deletes an Explainability export.
This is a convenience which creates an instance of the DeleteExplainabilityExportRequest.Builder avoiding
the need to create one manually via DeleteExplainabilityExportRequest.builder()
deleteExplainabilityExportRequest - A Consumer that will call methods on
DeleteExplainabilityExportRequest.Builder to create
a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteForecastResponse deleteForecast(DeleteForecastRequest deleteForecastRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Deletes a forecast created using the CreateForecast operation. You can delete only forecasts that have a
status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeForecast
operation.
You can't delete a forecast while it is being exported. After a forecast is deleted, you can no longer query the forecast.
deleteForecastRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteForecastResponse deleteForecast(Consumer<DeleteForecastRequest.Builder> deleteForecastRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
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.
This is a convenience which creates an instance of the DeleteForecastRequest.Builder avoiding the need to
create one manually via DeleteForecastRequest.builder()
deleteForecastRequest - A Consumer that will call methods on
DeleteForecastRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteForecastExportJobResponse deleteForecastExportJob(DeleteForecastExportJobRequest deleteForecastExportJobRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Deletes a forecast export job created using the CreateForecastExportJob operation. You can delete only
export jobs that have a status of ACTIVE or CREATE_FAILED. To get the status, use the
DescribeForecastExportJob operation.
deleteForecastExportJobRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteForecastExportJobResponse deleteForecastExportJob(Consumer<DeleteForecastExportJobRequest.Builder> deleteForecastExportJobRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
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.
This is a convenience which creates an instance of the DeleteForecastExportJobRequest.Builder avoiding
the need to create one manually via DeleteForecastExportJobRequest.builder()
deleteForecastExportJobRequest - A Consumer that will call methods on
DeleteForecastExportJobRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteMonitorResponse deleteMonitor(DeleteMonitorRequest deleteMonitorRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Deletes a monitor resource. You can only delete a monitor resource with a status of ACTIVE,
ACTIVE_STOPPED, CREATE_FAILED, or CREATE_STOPPED.
deleteMonitorRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteMonitorResponse deleteMonitor(Consumer<DeleteMonitorRequest.Builder> deleteMonitorRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Deletes a monitor resource. You can only delete a monitor resource with a status of ACTIVE,
ACTIVE_STOPPED, CREATE_FAILED, or CREATE_STOPPED.
This is a convenience which creates an instance of the DeleteMonitorRequest.Builder avoiding the need to
create one manually via DeleteMonitorRequest.builder()
deleteMonitorRequest - A Consumer that will call methods on
DeleteMonitorRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeletePredictorResponse deletePredictor(DeletePredictorRequest deletePredictorRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Deletes a predictor created using the DescribePredictor or CreatePredictor operations. You can
delete only predictor that have a status of ACTIVE or CREATE_FAILED. To get the status,
use the DescribePredictor operation.
deletePredictorRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeletePredictorResponse deletePredictor(Consumer<DeletePredictorRequest.Builder> deletePredictorRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Deletes a predictor created using the DescribePredictor or CreatePredictor operations. You can
delete only predictor that have a status of ACTIVE or CREATE_FAILED. To get the status,
use the DescribePredictor operation.
This is a convenience which creates an instance of the DeletePredictorRequest.Builder avoiding the need
to create one manually via DeletePredictorRequest.builder()
deletePredictorRequest - A Consumer that will call methods on
DeletePredictorRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeletePredictorBacktestExportJobResponse deletePredictorBacktestExportJob(DeletePredictorBacktestExportJobRequest deletePredictorBacktestExportJobRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Deletes a predictor backtest export job.
deletePredictorBacktestExportJobRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeletePredictorBacktestExportJobResponse deletePredictorBacktestExportJob(Consumer<DeletePredictorBacktestExportJobRequest.Builder> deletePredictorBacktestExportJobRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Deletes a predictor backtest export job.
This is a convenience which creates an instance of the DeletePredictorBacktestExportJobRequest.Builder
avoiding the need to create one manually via DeletePredictorBacktestExportJobRequest.builder()
deletePredictorBacktestExportJobRequest - A Consumer that will call methods on
DeletePredictorBacktestExportJobRequest.Builder to
create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteResourceTreeResponse deleteResourceTree(DeleteResourceTreeRequest deleteResourceTreeRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Deletes an entire resource tree. This operation will delete the parent resource and its child resources.
Child resources are resources that were created from another resource. For example, when a forecast is generated from a predictor, the forecast is the child resource and the predictor is the parent resource.
Amazon Forecast resources possess the following parent-child resource hierarchies:
Dataset: dataset import jobs
Dataset Group: predictors, predictor backtest export jobs, forecasts, forecast export jobs
Predictor: predictor backtest export jobs, forecasts, forecast export jobs
Forecast: forecast export jobs
DeleteResourceTree will only delete Amazon Forecast resources, and will not delete datasets or
exported files stored in Amazon S3.
deleteResourceTreeRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteResourceTreeResponse deleteResourceTree(Consumer<DeleteResourceTreeRequest.Builder> deleteResourceTreeRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Deletes an entire resource tree. This operation will delete the parent resource and its child resources.
Child resources are resources that were created from another resource. For example, when a forecast is generated from a predictor, the forecast is the child resource and the predictor is the parent resource.
Amazon Forecast resources possess the following parent-child resource hierarchies:
Dataset: dataset import jobs
Dataset Group: predictors, predictor backtest export jobs, forecasts, forecast export jobs
Predictor: predictor backtest export jobs, forecasts, forecast export jobs
Forecast: forecast export jobs
DeleteResourceTree will only delete Amazon Forecast resources, and will not delete datasets or
exported files stored in Amazon S3.
This is a convenience which creates an instance of the DeleteResourceTreeRequest.Builder avoiding the
need to create one manually via DeleteResourceTreeRequest.builder()
deleteResourceTreeRequest - A Consumer that will call methods on
DeleteResourceTreeRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteWhatIfAnalysisResponse deleteWhatIfAnalysis(DeleteWhatIfAnalysisRequest deleteWhatIfAnalysisRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Deletes a what-if analysis created using the CreateWhatIfAnalysis operation. You can delete only what-if
analyses that have a status of ACTIVE or CREATE_FAILED. To get the status, use the
DescribeWhatIfAnalysis operation.
You can't delete a what-if analysis while any of its forecasts are being exported.
deleteWhatIfAnalysisRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteWhatIfAnalysisResponse deleteWhatIfAnalysis(Consumer<DeleteWhatIfAnalysisRequest.Builder> deleteWhatIfAnalysisRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Deletes a what-if analysis created using the CreateWhatIfAnalysis operation. You can delete only what-if
analyses that have a status of ACTIVE or CREATE_FAILED. To get the status, use the
DescribeWhatIfAnalysis operation.
You can't delete a what-if analysis while any of its forecasts are being exported.
This is a convenience which creates an instance of the DeleteWhatIfAnalysisRequest.Builder avoiding the
need to create one manually via DeleteWhatIfAnalysisRequest.builder()
deleteWhatIfAnalysisRequest - A Consumer that will call methods on
DeleteWhatIfAnalysisRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteWhatIfForecastResponse deleteWhatIfForecast(DeleteWhatIfForecastRequest deleteWhatIfForecastRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Deletes a what-if forecast created using the CreateWhatIfForecast operation. You can delete only what-if
forecasts that have a status of ACTIVE or CREATE_FAILED. To get the status, use the
DescribeWhatIfForecast operation.
You can't delete a what-if forecast while it is being exported. After a what-if forecast is deleted, you can no longer query the what-if analysis.
deleteWhatIfForecastRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteWhatIfForecastResponse deleteWhatIfForecast(Consumer<DeleteWhatIfForecastRequest.Builder> deleteWhatIfForecastRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Deletes a what-if forecast created using the CreateWhatIfForecast operation. You can delete only what-if
forecasts that have a status of ACTIVE or CREATE_FAILED. To get the status, use the
DescribeWhatIfForecast operation.
You can't delete a what-if forecast while it is being exported. After a what-if forecast is deleted, you can no longer query the what-if analysis.
This is a convenience which creates an instance of the DeleteWhatIfForecastRequest.Builder avoiding the
need to create one manually via DeleteWhatIfForecastRequest.builder()
deleteWhatIfForecastRequest - A Consumer that will call methods on
DeleteWhatIfForecastRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteWhatIfForecastExportResponse deleteWhatIfForecastExport(DeleteWhatIfForecastExportRequest deleteWhatIfForecastExportRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Deletes a what-if forecast export created using the CreateWhatIfForecastExport operation. You can delete
only what-if forecast exports that have a status of ACTIVE or CREATE_FAILED. To get the
status, use the DescribeWhatIfForecastExport operation.
deleteWhatIfForecastExportRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteWhatIfForecastExportResponse deleteWhatIfForecastExport(Consumer<DeleteWhatIfForecastExportRequest.Builder> deleteWhatIfForecastExportRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Deletes a what-if forecast export created using the CreateWhatIfForecastExport operation. You can delete
only what-if forecast exports that have a status of ACTIVE or CREATE_FAILED. To get the
status, use the DescribeWhatIfForecastExport operation.
This is a convenience which creates an instance of the DeleteWhatIfForecastExportRequest.Builder avoiding
the need to create one manually via DeleteWhatIfForecastExportRequest.builder()
deleteWhatIfForecastExportRequest - A Consumer that will call methods on
DeleteWhatIfForecastExportRequest.Builder to create
a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeAutoPredictorResponse describeAutoPredictor(DescribeAutoPredictorRequest describeAutoPredictorRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
Describes a predictor created using the CreateAutoPredictor operation.
describeAutoPredictorRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeAutoPredictorResponse describeAutoPredictor(Consumer<DescribeAutoPredictorRequest.Builder> describeAutoPredictorRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
Describes a predictor created using the CreateAutoPredictor operation.
This is a convenience which creates an instance of the DescribeAutoPredictorRequest.Builder avoiding the
need to create one manually via DescribeAutoPredictorRequest.builder()
describeAutoPredictorRequest - A Consumer that will call methods on
DescribeAutoPredictorRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDatasetResponse describeDataset(DescribeDatasetRequest describeDatasetRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
Describes an Amazon Forecast dataset created using the CreateDataset operation.
In addition to listing the parameters specified in the CreateDataset request, this operation
includes the following dataset properties:
CreationTime
LastModificationTime
Status
describeDatasetRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDatasetResponse describeDataset(Consumer<DescribeDatasetRequest.Builder> describeDatasetRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
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
This is a convenience which creates an instance of the DescribeDatasetRequest.Builder avoiding the need
to create one manually via DescribeDatasetRequest.builder()
describeDatasetRequest - A Consumer that will call methods on
DescribeDatasetRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDatasetGroupResponse describeDatasetGroup(DescribeDatasetGroupRequest describeDatasetGroupRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
Describes a dataset group created using the CreateDatasetGroup operation.
In addition to listing the parameters provided in the CreateDatasetGroup request, this operation
includes the following properties:
DatasetArns - The datasets belonging to the group.
CreationTime
LastModificationTime
Status
describeDatasetGroupRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDatasetGroupResponse describeDatasetGroup(Consumer<DescribeDatasetGroupRequest.Builder> describeDatasetGroupRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
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
This is a convenience which creates an instance of the DescribeDatasetGroupRequest.Builder avoiding the
need to create one manually via DescribeDatasetGroupRequest.builder()
describeDatasetGroupRequest - A Consumer that will call methods on
DescribeDatasetGroupRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDatasetImportJobResponse describeDatasetImportJob(DescribeDatasetImportJobRequest describeDatasetImportJobRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
Describes a dataset import job created using the CreateDatasetImportJob operation.
In addition to listing the parameters provided in the CreateDatasetImportJob request, this operation
includes the following properties:
CreationTime
LastModificationTime
DataSize
FieldStatistics
Status
Message - If an error occurred, information about the error.
describeDatasetImportJobRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDatasetImportJobResponse describeDatasetImportJob(Consumer<DescribeDatasetImportJobRequest.Builder> describeDatasetImportJobRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
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.
This is a convenience which creates an instance of the DescribeDatasetImportJobRequest.Builder avoiding
the need to create one manually via DescribeDatasetImportJobRequest.builder()
describeDatasetImportJobRequest - A Consumer that will call methods on
DescribeDatasetImportJobRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeExplainabilityResponse describeExplainability(DescribeExplainabilityRequest describeExplainabilityRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
Describes an Explainability resource created using the CreateExplainability operation.
describeExplainabilityRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeExplainabilityResponse describeExplainability(Consumer<DescribeExplainabilityRequest.Builder> describeExplainabilityRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
Describes an Explainability resource created using the CreateExplainability operation.
This is a convenience which creates an instance of the DescribeExplainabilityRequest.Builder avoiding the
need to create one manually via DescribeExplainabilityRequest.builder()
describeExplainabilityRequest - A Consumer that will call methods on
DescribeExplainabilityRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeExplainabilityExportResponse describeExplainabilityExport(DescribeExplainabilityExportRequest describeExplainabilityExportRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
Describes an Explainability export created using the CreateExplainabilityExport operation.
describeExplainabilityExportRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeExplainabilityExportResponse describeExplainabilityExport(Consumer<DescribeExplainabilityExportRequest.Builder> describeExplainabilityExportRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
Describes an Explainability export created using the CreateExplainabilityExport operation.
This is a convenience which creates an instance of the DescribeExplainabilityExportRequest.Builder
avoiding the need to create one manually via DescribeExplainabilityExportRequest.builder()
describeExplainabilityExportRequest - A Consumer that will call methods on
DescribeExplainabilityExportRequest.Builder to
create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeForecastResponse describeForecast(DescribeForecastRequest describeForecastRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
Describes a forecast created using the CreateForecast operation.
In addition to listing the properties provided in the CreateForecast request, this operation lists
the following properties:
DatasetGroupArn - The dataset group that provided the training data.
CreationTime
LastModificationTime
Status
Message - If an error occurred, information about the error.
describeForecastRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeForecastResponse describeForecast(Consumer<DescribeForecastRequest.Builder> describeForecastRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
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.
This is a convenience which creates an instance of the DescribeForecastRequest.Builder avoiding the need
to create one manually via DescribeForecastRequest.builder()
describeForecastRequest - A Consumer that will call methods on
DescribeForecastRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeForecastExportJobResponse describeForecastExportJob(DescribeForecastExportJobRequest describeForecastExportJobRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
Describes a forecast export job created using the CreateForecastExportJob operation.
In addition to listing the properties provided by the user in the CreateForecastExportJob request,
this operation lists the following properties:
CreationTime
LastModificationTime
Status
Message - If an error occurred, information about the error.
describeForecastExportJobRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeForecastExportJobResponse describeForecastExportJob(Consumer<DescribeForecastExportJobRequest.Builder> describeForecastExportJobRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
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.
This is a convenience which creates an instance of the DescribeForecastExportJobRequest.Builder avoiding
the need to create one manually via DescribeForecastExportJobRequest.builder()
describeForecastExportJobRequest - A Consumer that will call methods on
DescribeForecastExportJobRequest.Builder to create
a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeMonitorResponse describeMonitor(DescribeMonitorRequest describeMonitorRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
Describes a monitor resource. In addition to listing the properties provided in the CreateMonitor request, this operation lists the following properties:
Baseline
CreationTime
LastEvaluationTime
LastEvaluationState
LastModificationTime
Message
Status
describeMonitorRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeMonitorResponse describeMonitor(Consumer<DescribeMonitorRequest.Builder> describeMonitorRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
Describes a monitor resource. In addition to listing the properties provided in the CreateMonitor request, this operation lists the following properties:
Baseline
CreationTime
LastEvaluationTime
LastEvaluationState
LastModificationTime
Message
Status
This is a convenience which creates an instance of the DescribeMonitorRequest.Builder avoiding the need
to create one manually via DescribeMonitorRequest.builder()
describeMonitorRequest - A Consumer that will call methods on
DescribeMonitorRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribePredictorResponse describePredictor(DescribePredictorRequest describePredictorRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
This operation is only valid for legacy predictors created with CreatePredictor. If you are not using a legacy predictor, use DescribeAutoPredictor.
Describes a predictor created using the CreatePredictor operation.
In addition to listing the properties provided in the CreatePredictor request, this operation lists
the following properties:
DatasetImportJobArns - The dataset import jobs used to import training data.
AutoMLAlgorithmArns - If AutoML is performed, the algorithms that were evaluated.
CreationTime
LastModificationTime
Status
Message - If an error occurred, information about the error.
describePredictorRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribePredictorResponse describePredictor(Consumer<DescribePredictorRequest.Builder> describePredictorRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
This operation is only valid for legacy predictors created with CreatePredictor. If you are not using a legacy predictor, use DescribeAutoPredictor.
Describes a predictor created using the CreatePredictor operation.
In addition to listing the properties provided in the CreatePredictor request, this operation lists
the following properties:
DatasetImportJobArns - The dataset import jobs used to import training data.
AutoMLAlgorithmArns - If AutoML is performed, the algorithms that were evaluated.
CreationTime
LastModificationTime
Status
Message - If an error occurred, information about the error.
This is a convenience which creates an instance of the DescribePredictorRequest.Builder avoiding the need
to create one manually via DescribePredictorRequest.builder()
describePredictorRequest - A Consumer that will call methods on
DescribePredictorRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribePredictorBacktestExportJobResponse describePredictorBacktestExportJob(DescribePredictorBacktestExportJobRequest describePredictorBacktestExportJobRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
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)
describePredictorBacktestExportJobRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribePredictorBacktestExportJobResponse describePredictorBacktestExportJob(Consumer<DescribePredictorBacktestExportJobRequest.Builder> describePredictorBacktestExportJobRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
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)
This is a convenience which creates an instance of the DescribePredictorBacktestExportJobRequest.Builder
avoiding the need to create one manually via DescribePredictorBacktestExportJobRequest.builder()
describePredictorBacktestExportJobRequest - A Consumer that will call methods on
DescribePredictorBacktestExportJobRequest.Builder
to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeWhatIfAnalysisResponse describeWhatIfAnalysis(DescribeWhatIfAnalysisRequest describeWhatIfAnalysisRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
Describes the what-if analysis created using the CreateWhatIfAnalysis operation.
In addition to listing the properties provided in the CreateWhatIfAnalysis request, this operation
lists the following properties:
CreationTime
LastModificationTime
Message - If an error occurred, information about the error.
Status
describeWhatIfAnalysisRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeWhatIfAnalysisResponse describeWhatIfAnalysis(Consumer<DescribeWhatIfAnalysisRequest.Builder> describeWhatIfAnalysisRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
Describes the what-if analysis created using the CreateWhatIfAnalysis operation.
In addition to listing the properties provided in the CreateWhatIfAnalysis request, this operation
lists the following properties:
CreationTime
LastModificationTime
Message - If an error occurred, information about the error.
Status
This is a convenience which creates an instance of the DescribeWhatIfAnalysisRequest.Builder avoiding the
need to create one manually via DescribeWhatIfAnalysisRequest.builder()
describeWhatIfAnalysisRequest - A Consumer that will call methods on
DescribeWhatIfAnalysisRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeWhatIfForecastResponse describeWhatIfForecast(DescribeWhatIfForecastRequest describeWhatIfForecastRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
Describes the what-if forecast created using the CreateWhatIfForecast operation.
In addition to listing the properties provided in the CreateWhatIfForecast request, this operation
lists the following properties:
CreationTime
LastModificationTime
Message - If an error occurred, information about the error.
Status
describeWhatIfForecastRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeWhatIfForecastResponse describeWhatIfForecast(Consumer<DescribeWhatIfForecastRequest.Builder> describeWhatIfForecastRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
Describes the what-if forecast created using the CreateWhatIfForecast operation.
In addition to listing the properties provided in the CreateWhatIfForecast request, this operation
lists the following properties:
CreationTime
LastModificationTime
Message - If an error occurred, information about the error.
Status
This is a convenience which creates an instance of the DescribeWhatIfForecastRequest.Builder avoiding the
need to create one manually via DescribeWhatIfForecastRequest.builder()
describeWhatIfForecastRequest - A Consumer that will call methods on
DescribeWhatIfForecastRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeWhatIfForecastExportResponse describeWhatIfForecastExport(DescribeWhatIfForecastExportRequest describeWhatIfForecastExportRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
Describes the what-if forecast export created using the CreateWhatIfForecastExport operation.
In addition to listing the properties provided in the CreateWhatIfForecastExport request, this
operation lists the following properties:
CreationTime
LastModificationTime
Message - If an error occurred, information about the error.
Status
describeWhatIfForecastExportRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeWhatIfForecastExportResponse describeWhatIfForecastExport(Consumer<DescribeWhatIfForecastExportRequest.Builder> describeWhatIfForecastExportRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
Describes the what-if forecast export created using the CreateWhatIfForecastExport operation.
In addition to listing the properties provided in the CreateWhatIfForecastExport request, this
operation lists the following properties:
CreationTime
LastModificationTime
Message - If an error occurred, information about the error.
Status
This is a convenience which creates an instance of the DescribeWhatIfForecastExportRequest.Builder
avoiding the need to create one manually via DescribeWhatIfForecastExportRequest.builder()
describeWhatIfForecastExportRequest - A Consumer that will call methods on
DescribeWhatIfForecastExportRequest.Builder to
create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAccuracyMetricsResponse getAccuracyMetrics(GetAccuracyMetricsRequest getAccuracyMetricsRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
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.
getAccuracyMetricsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAccuracyMetricsResponse getAccuracyMetrics(Consumer<GetAccuracyMetricsRequest.Builder> getAccuracyMetricsRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
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.
This is a convenience which creates an instance of the GetAccuracyMetricsRequest.Builder avoiding the
need to create one manually via GetAccuracyMetricsRequest.builder()
getAccuracyMetricsRequest - A Consumer that will call methods on
GetAccuracyMetricsRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetGroupsResponse listDatasetGroups(ListDatasetGroupsRequest listDatasetGroupsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, ForecastException
Returns a list of dataset groups created using the CreateDatasetGroup operation. For each dataset group, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the dataset group ARN with the DescribeDatasetGroup operation.
listDatasetGroupsRequest - InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetGroupsResponse listDatasetGroups(Consumer<ListDatasetGroupsRequest.Builder> listDatasetGroupsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, ForecastException
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.
This is a convenience which creates an instance of the ListDatasetGroupsRequest.Builder avoiding the need
to create one manually via ListDatasetGroupsRequest.builder()
listDatasetGroupsRequest - A Consumer that will call methods on
ListDatasetGroupsRequest.Builder to create a
request.InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetGroupsIterable listDatasetGroupsPaginator(ListDatasetGroupsRequest listDatasetGroupsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, ForecastException
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.
This is a variant of
listDatasetGroups(software.amazon.awssdk.services.forecast.model.ListDatasetGroupsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListDatasetGroupsIterable responses = client.listDatasetGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListDatasetGroupsIterable responses = client
.listDatasetGroupsPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListDatasetGroupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListDatasetGroupsIterable responses = client.listDatasetGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasetGroups(software.amazon.awssdk.services.forecast.model.ListDatasetGroupsRequest)
operation.
listDatasetGroupsRequest - InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetGroupsIterable listDatasetGroupsPaginator(Consumer<ListDatasetGroupsRequest.Builder> listDatasetGroupsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, ForecastException
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.
This is a variant of
listDatasetGroups(software.amazon.awssdk.services.forecast.model.ListDatasetGroupsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListDatasetGroupsIterable responses = client.listDatasetGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListDatasetGroupsIterable responses = client
.listDatasetGroupsPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListDatasetGroupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListDatasetGroupsIterable responses = client.listDatasetGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasetGroups(software.amazon.awssdk.services.forecast.model.ListDatasetGroupsRequest)
operation.
This is a convenience which creates an instance of the ListDatasetGroupsRequest.Builder avoiding the need
to create one manually via ListDatasetGroupsRequest.builder()
listDatasetGroupsRequest - A Consumer that will call methods on
ListDatasetGroupsRequest.Builder to create a
request.InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetImportJobsResponse listDatasetImportJobs(ListDatasetImportJobsRequest listDatasetImportJobsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of dataset import jobs created using the CreateDatasetImportJob operation. For each import job, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the ARN with the DescribeDatasetImportJob operation. You can filter the list by providing an array of Filter objects.
listDatasetImportJobsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetImportJobsResponse listDatasetImportJobs(Consumer<ListDatasetImportJobsRequest.Builder> listDatasetImportJobsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
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.
This is a convenience which creates an instance of the ListDatasetImportJobsRequest.Builder avoiding the
need to create one manually via ListDatasetImportJobsRequest.builder()
listDatasetImportJobsRequest - A Consumer that will call methods on
ListDatasetImportJobsRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetImportJobsIterable listDatasetImportJobsPaginator(ListDatasetImportJobsRequest listDatasetImportJobsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
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.
This is a variant of
listDatasetImportJobs(software.amazon.awssdk.services.forecast.model.ListDatasetImportJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListDatasetImportJobsIterable responses = client.listDatasetImportJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListDatasetImportJobsIterable responses = client
.listDatasetImportJobsPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListDatasetImportJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListDatasetImportJobsIterable responses = client.listDatasetImportJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasetImportJobs(software.amazon.awssdk.services.forecast.model.ListDatasetImportJobsRequest)
operation.
listDatasetImportJobsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetImportJobsIterable listDatasetImportJobsPaginator(Consumer<ListDatasetImportJobsRequest.Builder> listDatasetImportJobsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
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.
This is a variant of
listDatasetImportJobs(software.amazon.awssdk.services.forecast.model.ListDatasetImportJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListDatasetImportJobsIterable responses = client.listDatasetImportJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListDatasetImportJobsIterable responses = client
.listDatasetImportJobsPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListDatasetImportJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListDatasetImportJobsIterable responses = client.listDatasetImportJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasetImportJobs(software.amazon.awssdk.services.forecast.model.ListDatasetImportJobsRequest)
operation.
This is a convenience which creates an instance of the ListDatasetImportJobsRequest.Builder avoiding the
need to create one manually via ListDatasetImportJobsRequest.builder()
listDatasetImportJobsRequest - A Consumer that will call methods on
ListDatasetImportJobsRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetsResponse listDatasets(ListDatasetsRequest listDatasetsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, ForecastException
Returns a list of datasets created using the CreateDataset operation. For each dataset, a summary of its properties, including its Amazon Resource Name (ARN), is returned. To retrieve the complete set of properties, use the ARN with the DescribeDataset operation.
listDatasetsRequest - InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetsResponse listDatasets(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, ForecastException
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.
This is a convenience which creates an instance of the ListDatasetsRequest.Builder avoiding the need to
create one manually via ListDatasetsRequest.builder()
listDatasetsRequest - A Consumer that will call methods on
ListDatasetsRequest.Builder to create a request.InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetsIterable listDatasetsPaginator(ListDatasetsRequest listDatasetsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, ForecastException
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.
This is a variant of listDatasets(software.amazon.awssdk.services.forecast.model.ListDatasetsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListDatasetsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasets(software.amazon.awssdk.services.forecast.model.ListDatasetsRequest) operation.
listDatasetsRequest - InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetsIterable listDatasetsPaginator(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, ForecastException
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.
This is a variant of listDatasets(software.amazon.awssdk.services.forecast.model.ListDatasetsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListDatasetsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasets(software.amazon.awssdk.services.forecast.model.ListDatasetsRequest) operation.
This is a convenience which creates an instance of the ListDatasetsRequest.Builder avoiding the need to
create one manually via ListDatasetsRequest.builder()
listDatasetsRequest - A Consumer that will call methods on
ListDatasetsRequest.Builder to create a request.InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListExplainabilitiesResponse listExplainabilities(ListExplainabilitiesRequest listExplainabilitiesRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of Explainability resources created using the CreateExplainability operation. This operation returns a summary for each Explainability. You can filter the list using an array of Filter objects.
To retrieve the complete set of properties for a particular Explainability resource, use the ARN with the DescribeExplainability operation.
listExplainabilitiesRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListExplainabilitiesResponse listExplainabilities(Consumer<ListExplainabilitiesRequest.Builder> listExplainabilitiesRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of Explainability resources created using the CreateExplainability operation. This operation returns a summary for each Explainability. You can filter the list using an array of Filter objects.
To retrieve the complete set of properties for a particular Explainability resource, use the ARN with the DescribeExplainability operation.
This is a convenience which creates an instance of the ListExplainabilitiesRequest.Builder avoiding the
need to create one manually via ListExplainabilitiesRequest.builder()
listExplainabilitiesRequest - A Consumer that will call methods on
ListExplainabilitiesRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListExplainabilitiesIterable listExplainabilitiesPaginator(ListExplainabilitiesRequest listExplainabilitiesRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of Explainability resources created using the CreateExplainability operation. This operation returns a summary for each Explainability. You can filter the list using an array of Filter objects.
To retrieve the complete set of properties for a particular Explainability resource, use the ARN with the DescribeExplainability operation.
This is a variant of
listExplainabilities(software.amazon.awssdk.services.forecast.model.ListExplainabilitiesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListExplainabilitiesIterable responses = client.listExplainabilitiesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListExplainabilitiesIterable responses = client
.listExplainabilitiesPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListExplainabilitiesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListExplainabilitiesIterable responses = client.listExplainabilitiesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listExplainabilities(software.amazon.awssdk.services.forecast.model.ListExplainabilitiesRequest)
operation.
listExplainabilitiesRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListExplainabilitiesIterable listExplainabilitiesPaginator(Consumer<ListExplainabilitiesRequest.Builder> listExplainabilitiesRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of Explainability resources created using the CreateExplainability operation. This operation returns a summary for each Explainability. You can filter the list using an array of Filter objects.
To retrieve the complete set of properties for a particular Explainability resource, use the ARN with the DescribeExplainability operation.
This is a variant of
listExplainabilities(software.amazon.awssdk.services.forecast.model.ListExplainabilitiesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListExplainabilitiesIterable responses = client.listExplainabilitiesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListExplainabilitiesIterable responses = client
.listExplainabilitiesPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListExplainabilitiesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListExplainabilitiesIterable responses = client.listExplainabilitiesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listExplainabilities(software.amazon.awssdk.services.forecast.model.ListExplainabilitiesRequest)
operation.
This is a convenience which creates an instance of the ListExplainabilitiesRequest.Builder avoiding the
need to create one manually via ListExplainabilitiesRequest.builder()
listExplainabilitiesRequest - A Consumer that will call methods on
ListExplainabilitiesRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListExplainabilityExportsResponse listExplainabilityExports(ListExplainabilityExportsRequest listExplainabilityExportsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of Explainability exports created using the CreateExplainabilityExport operation. This operation returns a summary for each Explainability export. You can filter the list using an array of Filter objects.
To retrieve the complete set of properties for a particular Explainability export, use the ARN with the DescribeExplainability operation.
listExplainabilityExportsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListExplainabilityExportsResponse listExplainabilityExports(Consumer<ListExplainabilityExportsRequest.Builder> listExplainabilityExportsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of Explainability exports created using the CreateExplainabilityExport operation. This operation returns a summary for each Explainability export. You can filter the list using an array of Filter objects.
To retrieve the complete set of properties for a particular Explainability export, use the ARN with the DescribeExplainability operation.
This is a convenience which creates an instance of the ListExplainabilityExportsRequest.Builder avoiding
the need to create one manually via ListExplainabilityExportsRequest.builder()
listExplainabilityExportsRequest - A Consumer that will call methods on
ListExplainabilityExportsRequest.Builder to create
a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListExplainabilityExportsIterable listExplainabilityExportsPaginator(ListExplainabilityExportsRequest listExplainabilityExportsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of Explainability exports created using the CreateExplainabilityExport operation. This operation returns a summary for each Explainability export. You can filter the list using an array of Filter objects.
To retrieve the complete set of properties for a particular Explainability export, use the ARN with the DescribeExplainability operation.
This is a variant of
listExplainabilityExports(software.amazon.awssdk.services.forecast.model.ListExplainabilityExportsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListExplainabilityExportsIterable responses = client.listExplainabilityExportsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListExplainabilityExportsIterable responses = client
.listExplainabilityExportsPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListExplainabilityExportsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListExplainabilityExportsIterable responses = client.listExplainabilityExportsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listExplainabilityExports(software.amazon.awssdk.services.forecast.model.ListExplainabilityExportsRequest)
operation.
listExplainabilityExportsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListExplainabilityExportsIterable listExplainabilityExportsPaginator(Consumer<ListExplainabilityExportsRequest.Builder> listExplainabilityExportsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of Explainability exports created using the CreateExplainabilityExport operation. This operation returns a summary for each Explainability export. You can filter the list using an array of Filter objects.
To retrieve the complete set of properties for a particular Explainability export, use the ARN with the DescribeExplainability operation.
This is a variant of
listExplainabilityExports(software.amazon.awssdk.services.forecast.model.ListExplainabilityExportsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListExplainabilityExportsIterable responses = client.listExplainabilityExportsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListExplainabilityExportsIterable responses = client
.listExplainabilityExportsPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListExplainabilityExportsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListExplainabilityExportsIterable responses = client.listExplainabilityExportsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listExplainabilityExports(software.amazon.awssdk.services.forecast.model.ListExplainabilityExportsRequest)
operation.
This is a convenience which creates an instance of the ListExplainabilityExportsRequest.Builder avoiding
the need to create one manually via ListExplainabilityExportsRequest.builder()
listExplainabilityExportsRequest - A Consumer that will call methods on
ListExplainabilityExportsRequest.Builder to create
a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListForecastExportJobsResponse listForecastExportJobs(ListForecastExportJobsRequest listForecastExportJobsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of forecast export jobs created using the CreateForecastExportJob operation. For each forecast export job, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, use the ARN with the DescribeForecastExportJob operation. You can filter the list using an array of Filter objects.
listForecastExportJobsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListForecastExportJobsResponse listForecastExportJobs(Consumer<ListForecastExportJobsRequest.Builder> listForecastExportJobsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
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.
This is a convenience which creates an instance of the ListForecastExportJobsRequest.Builder avoiding the
need to create one manually via ListForecastExportJobsRequest.builder()
listForecastExportJobsRequest - A Consumer that will call methods on
ListForecastExportJobsRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListForecastExportJobsIterable listForecastExportJobsPaginator(ListForecastExportJobsRequest listForecastExportJobsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
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.
This is a variant of
listForecastExportJobs(software.amazon.awssdk.services.forecast.model.ListForecastExportJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListForecastExportJobsIterable responses = client.listForecastExportJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListForecastExportJobsIterable responses = client
.listForecastExportJobsPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListForecastExportJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListForecastExportJobsIterable responses = client.listForecastExportJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listForecastExportJobs(software.amazon.awssdk.services.forecast.model.ListForecastExportJobsRequest)
operation.
listForecastExportJobsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListForecastExportJobsIterable listForecastExportJobsPaginator(Consumer<ListForecastExportJobsRequest.Builder> listForecastExportJobsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
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.
This is a variant of
listForecastExportJobs(software.amazon.awssdk.services.forecast.model.ListForecastExportJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListForecastExportJobsIterable responses = client.listForecastExportJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListForecastExportJobsIterable responses = client
.listForecastExportJobsPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListForecastExportJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListForecastExportJobsIterable responses = client.listForecastExportJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listForecastExportJobs(software.amazon.awssdk.services.forecast.model.ListForecastExportJobsRequest)
operation.
This is a convenience which creates an instance of the ListForecastExportJobsRequest.Builder avoiding the
need to create one manually via ListForecastExportJobsRequest.builder()
listForecastExportJobsRequest - A Consumer that will call methods on
ListForecastExportJobsRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListForecastsResponse listForecasts(ListForecastsRequest listForecastsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of forecasts created using the CreateForecast operation. For each forecast, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, specify the ARN with the DescribeForecast operation. You can filter the list using an array of Filter objects.
listForecastsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListForecastsResponse listForecasts(Consumer<ListForecastsRequest.Builder> listForecastsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
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.
This is a convenience which creates an instance of the ListForecastsRequest.Builder avoiding the need to
create one manually via ListForecastsRequest.builder()
listForecastsRequest - A Consumer that will call methods on
ListForecastsRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListForecastsIterable listForecastsPaginator(ListForecastsRequest listForecastsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
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.
This is a variant of listForecasts(software.amazon.awssdk.services.forecast.model.ListForecastsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListForecastsIterable responses = client.listForecastsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListForecastsIterable responses = client.listForecastsPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListForecastsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListForecastsIterable responses = client.listForecastsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listForecasts(software.amazon.awssdk.services.forecast.model.ListForecastsRequest) operation.
listForecastsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListForecastsIterable listForecastsPaginator(Consumer<ListForecastsRequest.Builder> listForecastsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
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.
This is a variant of listForecasts(software.amazon.awssdk.services.forecast.model.ListForecastsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListForecastsIterable responses = client.listForecastsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListForecastsIterable responses = client.listForecastsPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListForecastsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListForecastsIterable responses = client.listForecastsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listForecasts(software.amazon.awssdk.services.forecast.model.ListForecastsRequest) operation.
This is a convenience which creates an instance of the ListForecastsRequest.Builder avoiding the need to
create one manually via ListForecastsRequest.builder()
listForecastsRequest - A Consumer that will call methods on
ListForecastsRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListMonitorEvaluationsResponse listMonitorEvaluations(ListMonitorEvaluationsRequest listMonitorEvaluationsRequest) throws InvalidNextTokenException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
Returns a list of the monitoring evaluation results and predictor events collected by the monitor resource during different windows of time.
For information about monitoring see predictor-monitoring. For more information about retrieving monitoring results see Viewing Monitoring Results.
listMonitorEvaluationsRequest - 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.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListMonitorEvaluationsResponse listMonitorEvaluations(Consumer<ListMonitorEvaluationsRequest.Builder> listMonitorEvaluationsRequest) throws InvalidNextTokenException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
Returns a list of the monitoring evaluation results and predictor events collected by the monitor resource during different windows of time.
For information about monitoring see predictor-monitoring. For more information about retrieving monitoring results see Viewing Monitoring Results.
This is a convenience which creates an instance of the ListMonitorEvaluationsRequest.Builder avoiding the
need to create one manually via ListMonitorEvaluationsRequest.builder()
listMonitorEvaluationsRequest - A Consumer that will call methods on
ListMonitorEvaluationsRequest.Builder to create a
request.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.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListMonitorEvaluationsIterable listMonitorEvaluationsPaginator(ListMonitorEvaluationsRequest listMonitorEvaluationsRequest) throws InvalidNextTokenException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
Returns a list of the monitoring evaluation results and predictor events collected by the monitor resource during different windows of time.
For information about monitoring see predictor-monitoring. For more information about retrieving monitoring results see Viewing Monitoring Results.
This is a variant of
listMonitorEvaluations(software.amazon.awssdk.services.forecast.model.ListMonitorEvaluationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListMonitorEvaluationsIterable responses = client.listMonitorEvaluationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListMonitorEvaluationsIterable responses = client
.listMonitorEvaluationsPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListMonitorEvaluationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListMonitorEvaluationsIterable responses = client.listMonitorEvaluationsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMonitorEvaluations(software.amazon.awssdk.services.forecast.model.ListMonitorEvaluationsRequest)
operation.
listMonitorEvaluationsRequest - 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.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListMonitorEvaluationsIterable listMonitorEvaluationsPaginator(Consumer<ListMonitorEvaluationsRequest.Builder> listMonitorEvaluationsRequest) throws InvalidNextTokenException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
Returns a list of the monitoring evaluation results and predictor events collected by the monitor resource during different windows of time.
For information about monitoring see predictor-monitoring. For more information about retrieving monitoring results see Viewing Monitoring Results.
This is a variant of
listMonitorEvaluations(software.amazon.awssdk.services.forecast.model.ListMonitorEvaluationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListMonitorEvaluationsIterable responses = client.listMonitorEvaluationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListMonitorEvaluationsIterable responses = client
.listMonitorEvaluationsPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListMonitorEvaluationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListMonitorEvaluationsIterable responses = client.listMonitorEvaluationsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMonitorEvaluations(software.amazon.awssdk.services.forecast.model.ListMonitorEvaluationsRequest)
operation.
This is a convenience which creates an instance of the ListMonitorEvaluationsRequest.Builder avoiding the
need to create one manually via ListMonitorEvaluationsRequest.builder()
listMonitorEvaluationsRequest - A Consumer that will call methods on
ListMonitorEvaluationsRequest.Builder to create a
request.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.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListMonitorsResponse listMonitors(ListMonitorsRequest listMonitorsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of monitors created with the CreateMonitor operation and CreateAutoPredictor operation. For each monitor resource, this operation returns of a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve a complete set of properties of a monitor resource by specify the monitor's ARN in the DescribeMonitor operation.
listMonitorsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListMonitorsResponse listMonitors(Consumer<ListMonitorsRequest.Builder> listMonitorsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of monitors created with the CreateMonitor operation and CreateAutoPredictor operation. For each monitor resource, this operation returns of a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve a complete set of properties of a monitor resource by specify the monitor's ARN in the DescribeMonitor operation.
This is a convenience which creates an instance of the ListMonitorsRequest.Builder avoiding the need to
create one manually via ListMonitorsRequest.builder()
listMonitorsRequest - A Consumer that will call methods on
ListMonitorsRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListMonitorsIterable listMonitorsPaginator(ListMonitorsRequest listMonitorsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of monitors created with the CreateMonitor operation and CreateAutoPredictor operation. For each monitor resource, this operation returns of a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve a complete set of properties of a monitor resource by specify the monitor's ARN in the DescribeMonitor operation.
This is a variant of listMonitors(software.amazon.awssdk.services.forecast.model.ListMonitorsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListMonitorsIterable responses = client.listMonitorsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListMonitorsIterable responses = client.listMonitorsPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListMonitorsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListMonitorsIterable responses = client.listMonitorsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMonitors(software.amazon.awssdk.services.forecast.model.ListMonitorsRequest) operation.
listMonitorsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListMonitorsIterable listMonitorsPaginator(Consumer<ListMonitorsRequest.Builder> listMonitorsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of monitors created with the CreateMonitor operation and CreateAutoPredictor operation. For each monitor resource, this operation returns of a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve a complete set of properties of a monitor resource by specify the monitor's ARN in the DescribeMonitor operation.
This is a variant of listMonitors(software.amazon.awssdk.services.forecast.model.ListMonitorsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListMonitorsIterable responses = client.listMonitorsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListMonitorsIterable responses = client.listMonitorsPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListMonitorsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListMonitorsIterable responses = client.listMonitorsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMonitors(software.amazon.awssdk.services.forecast.model.ListMonitorsRequest) operation.
This is a convenience which creates an instance of the ListMonitorsRequest.Builder avoiding the need to
create one manually via ListMonitorsRequest.builder()
listMonitorsRequest - A Consumer that will call methods on
ListMonitorsRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPredictorBacktestExportJobsResponse listPredictorBacktestExportJobs(ListPredictorBacktestExportJobsRequest listPredictorBacktestExportJobsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
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.
listPredictorBacktestExportJobsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPredictorBacktestExportJobsResponse listPredictorBacktestExportJobs(Consumer<ListPredictorBacktestExportJobsRequest.Builder> listPredictorBacktestExportJobsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
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.
This is a convenience which creates an instance of the ListPredictorBacktestExportJobsRequest.Builder
avoiding the need to create one manually via ListPredictorBacktestExportJobsRequest.builder()
listPredictorBacktestExportJobsRequest - A Consumer that will call methods on
ListPredictorBacktestExportJobsRequest.Builder to
create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPredictorBacktestExportJobsIterable listPredictorBacktestExportJobsPaginator(ListPredictorBacktestExportJobsRequest listPredictorBacktestExportJobsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
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.
This is a variant of
listPredictorBacktestExportJobs(software.amazon.awssdk.services.forecast.model.ListPredictorBacktestExportJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListPredictorBacktestExportJobsIterable responses = client.listPredictorBacktestExportJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListPredictorBacktestExportJobsIterable responses = client
.listPredictorBacktestExportJobsPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListPredictorBacktestExportJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListPredictorBacktestExportJobsIterable responses = client.listPredictorBacktestExportJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPredictorBacktestExportJobs(software.amazon.awssdk.services.forecast.model.ListPredictorBacktestExportJobsRequest)
operation.
listPredictorBacktestExportJobsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPredictorBacktestExportJobsIterable listPredictorBacktestExportJobsPaginator(Consumer<ListPredictorBacktestExportJobsRequest.Builder> listPredictorBacktestExportJobsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
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.
This is a variant of
listPredictorBacktestExportJobs(software.amazon.awssdk.services.forecast.model.ListPredictorBacktestExportJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListPredictorBacktestExportJobsIterable responses = client.listPredictorBacktestExportJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListPredictorBacktestExportJobsIterable responses = client
.listPredictorBacktestExportJobsPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListPredictorBacktestExportJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListPredictorBacktestExportJobsIterable responses = client.listPredictorBacktestExportJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPredictorBacktestExportJobs(software.amazon.awssdk.services.forecast.model.ListPredictorBacktestExportJobsRequest)
operation.
This is a convenience which creates an instance of the ListPredictorBacktestExportJobsRequest.Builder
avoiding the need to create one manually via ListPredictorBacktestExportJobsRequest.builder()
listPredictorBacktestExportJobsRequest - A Consumer that will call methods on
ListPredictorBacktestExportJobsRequest.Builder to
create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPredictorsResponse listPredictors(ListPredictorsRequest listPredictorsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of predictors created using the CreateAutoPredictor or CreatePredictor operations. For each predictor, this operation returns a summary of its properties, including its Amazon Resource Name (ARN).
You can retrieve the complete set of properties by using the ARN with the DescribeAutoPredictor and DescribePredictor operations. You can filter the list using an array of Filter objects.
listPredictorsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPredictorsResponse listPredictors(Consumer<ListPredictorsRequest.Builder> listPredictorsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of predictors created using the CreateAutoPredictor or CreatePredictor operations. For each predictor, this operation returns a summary of its properties, including its Amazon Resource Name (ARN).
You can retrieve the complete set of properties by using the ARN with the DescribeAutoPredictor and DescribePredictor operations. You can filter the list using an array of Filter objects.
This is a convenience which creates an instance of the ListPredictorsRequest.Builder avoiding the need to
create one manually via ListPredictorsRequest.builder()
listPredictorsRequest - A Consumer that will call methods on
ListPredictorsRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPredictorsIterable listPredictorsPaginator(ListPredictorsRequest listPredictorsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of predictors created using the CreateAutoPredictor or CreatePredictor operations. For each predictor, this operation returns a summary of its properties, including its Amazon Resource Name (ARN).
You can retrieve the complete set of properties by using the ARN with the DescribeAutoPredictor and DescribePredictor operations. You can filter the list using an array of Filter objects.
This is a variant of
listPredictors(software.amazon.awssdk.services.forecast.model.ListPredictorsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListPredictorsIterable responses = client.listPredictorsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListPredictorsIterable responses = client
.listPredictorsPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListPredictorsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListPredictorsIterable responses = client.listPredictorsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPredictors(software.amazon.awssdk.services.forecast.model.ListPredictorsRequest) operation.
listPredictorsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPredictorsIterable listPredictorsPaginator(Consumer<ListPredictorsRequest.Builder> listPredictorsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of predictors created using the CreateAutoPredictor or CreatePredictor operations. For each predictor, this operation returns a summary of its properties, including its Amazon Resource Name (ARN).
You can retrieve the complete set of properties by using the ARN with the DescribeAutoPredictor and DescribePredictor operations. You can filter the list using an array of Filter objects.
This is a variant of
listPredictors(software.amazon.awssdk.services.forecast.model.ListPredictorsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListPredictorsIterable responses = client.listPredictorsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListPredictorsIterable responses = client
.listPredictorsPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListPredictorsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListPredictorsIterable responses = client.listPredictorsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPredictors(software.amazon.awssdk.services.forecast.model.ListPredictorsRequest) operation.
This is a convenience which creates an instance of the ListPredictorsRequest.Builder avoiding the need to
create one manually via ListPredictorsRequest.builder()
listPredictorsRequest - A Consumer that will call methods on
ListPredictorsRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Lists the tags for an Amazon Forecast resource.
listTagsForResourceRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ResourceNotFoundException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Lists the tags for an Amazon Forecast resource.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on
ListTagsForResourceRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListWhatIfAnalysesResponse listWhatIfAnalyses(ListWhatIfAnalysesRequest listWhatIfAnalysesRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of what-if analyses created using the CreateWhatIfAnalysis operation. For each what-if analysis, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the what-if analysis ARN with the DescribeWhatIfAnalysis operation.
listWhatIfAnalysesRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListWhatIfAnalysesResponse listWhatIfAnalyses(Consumer<ListWhatIfAnalysesRequest.Builder> listWhatIfAnalysesRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of what-if analyses created using the CreateWhatIfAnalysis operation. For each what-if analysis, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the what-if analysis ARN with the DescribeWhatIfAnalysis operation.
This is a convenience which creates an instance of the ListWhatIfAnalysesRequest.Builder avoiding the
need to create one manually via ListWhatIfAnalysesRequest.builder()
listWhatIfAnalysesRequest - A Consumer that will call methods on
ListWhatIfAnalysesRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListWhatIfAnalysesIterable listWhatIfAnalysesPaginator(ListWhatIfAnalysesRequest listWhatIfAnalysesRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of what-if analyses created using the CreateWhatIfAnalysis operation. For each what-if analysis, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the what-if analysis ARN with the DescribeWhatIfAnalysis operation.
This is a variant of
listWhatIfAnalyses(software.amazon.awssdk.services.forecast.model.ListWhatIfAnalysesRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListWhatIfAnalysesIterable responses = client.listWhatIfAnalysesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListWhatIfAnalysesIterable responses = client
.listWhatIfAnalysesPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListWhatIfAnalysesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListWhatIfAnalysesIterable responses = client.listWhatIfAnalysesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWhatIfAnalyses(software.amazon.awssdk.services.forecast.model.ListWhatIfAnalysesRequest)
operation.
listWhatIfAnalysesRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListWhatIfAnalysesIterable listWhatIfAnalysesPaginator(Consumer<ListWhatIfAnalysesRequest.Builder> listWhatIfAnalysesRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of what-if analyses created using the CreateWhatIfAnalysis operation. For each what-if analysis, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the what-if analysis ARN with the DescribeWhatIfAnalysis operation.
This is a variant of
listWhatIfAnalyses(software.amazon.awssdk.services.forecast.model.ListWhatIfAnalysesRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListWhatIfAnalysesIterable responses = client.listWhatIfAnalysesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListWhatIfAnalysesIterable responses = client
.listWhatIfAnalysesPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListWhatIfAnalysesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListWhatIfAnalysesIterable responses = client.listWhatIfAnalysesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWhatIfAnalyses(software.amazon.awssdk.services.forecast.model.ListWhatIfAnalysesRequest)
operation.
This is a convenience which creates an instance of the ListWhatIfAnalysesRequest.Builder avoiding the
need to create one manually via ListWhatIfAnalysesRequest.builder()
listWhatIfAnalysesRequest - A Consumer that will call methods on
ListWhatIfAnalysesRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListWhatIfForecastExportsResponse listWhatIfForecastExports(ListWhatIfForecastExportsRequest listWhatIfForecastExportsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of what-if forecast exports created using the CreateWhatIfForecastExport operation. For each what-if forecast export, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the what-if forecast export ARN with the DescribeWhatIfForecastExport operation.
listWhatIfForecastExportsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListWhatIfForecastExportsResponse listWhatIfForecastExports(Consumer<ListWhatIfForecastExportsRequest.Builder> listWhatIfForecastExportsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of what-if forecast exports created using the CreateWhatIfForecastExport operation. For each what-if forecast export, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the what-if forecast export ARN with the DescribeWhatIfForecastExport operation.
This is a convenience which creates an instance of the ListWhatIfForecastExportsRequest.Builder avoiding
the need to create one manually via ListWhatIfForecastExportsRequest.builder()
listWhatIfForecastExportsRequest - A Consumer that will call methods on
ListWhatIfForecastExportsRequest.Builder to create
a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListWhatIfForecastExportsIterable listWhatIfForecastExportsPaginator(ListWhatIfForecastExportsRequest listWhatIfForecastExportsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of what-if forecast exports created using the CreateWhatIfForecastExport operation. For each what-if forecast export, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the what-if forecast export ARN with the DescribeWhatIfForecastExport operation.
This is a variant of
listWhatIfForecastExports(software.amazon.awssdk.services.forecast.model.ListWhatIfForecastExportsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListWhatIfForecastExportsIterable responses = client.listWhatIfForecastExportsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListWhatIfForecastExportsIterable responses = client
.listWhatIfForecastExportsPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListWhatIfForecastExportsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListWhatIfForecastExportsIterable responses = client.listWhatIfForecastExportsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWhatIfForecastExports(software.amazon.awssdk.services.forecast.model.ListWhatIfForecastExportsRequest)
operation.
listWhatIfForecastExportsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListWhatIfForecastExportsIterable listWhatIfForecastExportsPaginator(Consumer<ListWhatIfForecastExportsRequest.Builder> listWhatIfForecastExportsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of what-if forecast exports created using the CreateWhatIfForecastExport operation. For each what-if forecast export, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the what-if forecast export ARN with the DescribeWhatIfForecastExport operation.
This is a variant of
listWhatIfForecastExports(software.amazon.awssdk.services.forecast.model.ListWhatIfForecastExportsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListWhatIfForecastExportsIterable responses = client.listWhatIfForecastExportsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListWhatIfForecastExportsIterable responses = client
.listWhatIfForecastExportsPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListWhatIfForecastExportsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListWhatIfForecastExportsIterable responses = client.listWhatIfForecastExportsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWhatIfForecastExports(software.amazon.awssdk.services.forecast.model.ListWhatIfForecastExportsRequest)
operation.
This is a convenience which creates an instance of the ListWhatIfForecastExportsRequest.Builder avoiding
the need to create one manually via ListWhatIfForecastExportsRequest.builder()
listWhatIfForecastExportsRequest - A Consumer that will call methods on
ListWhatIfForecastExportsRequest.Builder to create
a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListWhatIfForecastsResponse listWhatIfForecasts(ListWhatIfForecastsRequest listWhatIfForecastsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of what-if forecasts created using the CreateWhatIfForecast operation. For each what-if forecast, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the what-if forecast ARN with the DescribeWhatIfForecast operation.
listWhatIfForecastsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListWhatIfForecastsResponse listWhatIfForecasts(Consumer<ListWhatIfForecastsRequest.Builder> listWhatIfForecastsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of what-if forecasts created using the CreateWhatIfForecast operation. For each what-if forecast, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the what-if forecast ARN with the DescribeWhatIfForecast operation.
This is a convenience which creates an instance of the ListWhatIfForecastsRequest.Builder avoiding the
need to create one manually via ListWhatIfForecastsRequest.builder()
listWhatIfForecastsRequest - A Consumer that will call methods on
ListWhatIfForecastsRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListWhatIfForecastsIterable listWhatIfForecastsPaginator(ListWhatIfForecastsRequest listWhatIfForecastsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of what-if forecasts created using the CreateWhatIfForecast operation. For each what-if forecast, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the what-if forecast ARN with the DescribeWhatIfForecast operation.
This is a variant of
listWhatIfForecasts(software.amazon.awssdk.services.forecast.model.ListWhatIfForecastsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListWhatIfForecastsIterable responses = client.listWhatIfForecastsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListWhatIfForecastsIterable responses = client
.listWhatIfForecastsPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListWhatIfForecastsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListWhatIfForecastsIterable responses = client.listWhatIfForecastsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWhatIfForecasts(software.amazon.awssdk.services.forecast.model.ListWhatIfForecastsRequest)
operation.
listWhatIfForecastsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListWhatIfForecastsIterable listWhatIfForecastsPaginator(Consumer<ListWhatIfForecastsRequest.Builder> listWhatIfForecastsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of what-if forecasts created using the CreateWhatIfForecast operation. For each what-if forecast, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the what-if forecast ARN with the DescribeWhatIfForecast operation.
This is a variant of
listWhatIfForecasts(software.amazon.awssdk.services.forecast.model.ListWhatIfForecastsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListWhatIfForecastsIterable responses = client.listWhatIfForecastsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListWhatIfForecastsIterable responses = client
.listWhatIfForecastsPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListWhatIfForecastsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListWhatIfForecastsIterable responses = client.listWhatIfForecastsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWhatIfForecasts(software.amazon.awssdk.services.forecast.model.ListWhatIfForecastsRequest)
operation.
This is a convenience which creates an instance of the ListWhatIfForecastsRequest.Builder avoiding the
need to create one manually via ListWhatIfForecastsRequest.builder()
listWhatIfForecastsRequest - A Consumer that will call methods on
ListWhatIfForecastsRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ResumeResourceResponse resumeResource(ResumeResourceRequest resumeResourceRequest) throws InvalidInputException, LimitExceededException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Resumes a stopped monitor resource.
resumeResourceRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.LimitExceededException - The limit on the number of resources per account has been exceeded.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ResumeResourceResponse resumeResource(Consumer<ResumeResourceRequest.Builder> resumeResourceRequest) throws InvalidInputException, LimitExceededException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Resumes a stopped monitor resource.
This is a convenience which creates an instance of the ResumeResourceRequest.Builder avoiding the need to
create one manually via ResumeResourceRequest.builder()
resumeResourceRequest - A Consumer that will call methods on
ResumeResourceRequest.Builder to create a request.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.LimitExceededException - The limit on the number of resources per account has been exceeded.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopResourceResponse stopResource(StopResourceRequest stopResourceRequest) throws InvalidInputException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
Stops a resource.
The resource undergoes the following states: CREATE_STOPPING and CREATE_STOPPED. You
cannot resume a resource once it has been stopped.
This operation can be applied to the following resources (and their corresponding child resources):
Dataset Import Job
Predictor Job
Forecast Job
Forecast Export Job
Predictor Backtest Export Job
Explainability Job
Explainability Export Job
stopResourceRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.LimitExceededException - The limit on the number of resources per account has been exceeded.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopResourceResponse stopResource(Consumer<StopResourceRequest.Builder> stopResourceRequest) throws InvalidInputException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
Stops a resource.
The resource undergoes the following states: CREATE_STOPPING and CREATE_STOPPED. You
cannot resume a resource once it has been stopped.
This operation can be applied to the following resources (and their corresponding child resources):
Dataset Import Job
Predictor Job
Forecast Job
Forecast Export Job
Predictor Backtest Export Job
Explainability Job
Explainability Export Job
This is a convenience which creates an instance of the StopResourceRequest.Builder avoiding the need to
create one manually via StopResourceRequest.builder()
stopResourceRequest - A Consumer that will call methods on
StopResourceRequest.Builder to create a request.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.LimitExceededException - The limit on the number of resources per account has been exceeded.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ResourceNotFoundException, LimitExceededException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
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.
tagResourceRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ResourceNotFoundException, LimitExceededException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
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.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on
TagResourceRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Deletes the specified tags from a resource.
untagResourceRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ResourceNotFoundException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Deletes the specified tags from a resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on
UntagResourceRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateDatasetGroupResponse updateDatasetGroup(UpdateDatasetGroupRequest updateDatasetGroupRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Replaces the datasets in a dataset group with the specified datasets.
The Status of the dataset group must be ACTIVE before you can use the dataset group to
create a predictor. Use the DescribeDatasetGroup
operation to get the status.
updateDatasetGroupRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateDatasetGroupResponse updateDatasetGroup(Consumer<UpdateDatasetGroupRequest.Builder> updateDatasetGroupRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
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.
This is a convenience which creates an instance of the UpdateDatasetGroupRequest.Builder avoiding the
need to create one manually via UpdateDatasetGroupRequest.builder()
updateDatasetGroupRequest - A Consumer that will call methods on
UpdateDatasetGroupRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ForecastClient create()
ForecastClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static ForecastClientBuilder builder()
ForecastClient.static ServiceMetadata serviceMetadata()
default ForecastServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.