Interface ForecastClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
Provides APIs for creating and managing Amazon Forecast resources.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic ForecastClientBuilder
builder()
Create a builder that can be used to configure and create aForecastClient
.static ForecastClient
create()
Create aForecastClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.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) createExplainabilityExport
(Consumer<CreateExplainabilityExportRequest.Builder> createExplainabilityExportRequest) Exports an Explainability resource created by the CreateExplainability operation.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 theTARGET_TIME_SERIES
dataset that was used to train the predictor.default CreateForecastResponse
createForecast
(CreateForecastRequest createForecastRequest) Creates a forecast for each item in theTARGET_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) createPredictorBacktestExportJob
(Consumer<CreatePredictorBacktestExportJobRequest.Builder> createPredictorBacktestExportJobRequest) Exports backtest forecasts and accuracy metrics generated by the CreateAutoPredictor or CreatePredictor operations.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.createWhatIfForecastExport
(Consumer<CreateWhatIfForecastExportRequest.Builder> createWhatIfForecastExportRequest) Exports a forecast created by the CreateWhatIfForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket.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.deleteExplainabilityExport
(Consumer<DeleteExplainabilityExportRequest.Builder> deleteExplainabilityExportRequest) Deletes an Explainability export.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.deletePredictorBacktestExportJob
(Consumer<DeletePredictorBacktestExportJobRequest.Builder> deletePredictorBacktestExportJobRequest) Deletes a predictor backtest export job.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.deleteWhatIfForecastExport
(Consumer<DeleteWhatIfForecastExportRequest.Builder> deleteWhatIfForecastExportRequest) Deletes a what-if forecast export created using the CreateWhatIfForecastExport operation.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.describeExplainabilityExport
(Consumer<DescribeExplainabilityExportRequest.Builder> describeExplainabilityExportRequest) Describes an Explainability export created using the CreateExplainabilityExport operation.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.describeForecastExportJob
(Consumer<DescribeForecastExportJobRequest.Builder> describeForecastExportJobRequest) Describes a forecast export job created using the CreateForecastExportJob operation.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) describePredictorBacktestExportJob
(Consumer<DescribePredictorBacktestExportJobRequest.Builder> describePredictorBacktestExportJobRequest) Describes a predictor backtest export job created using the CreatePredictorBacktestExportJob operation.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.describeWhatIfForecastExport
(Consumer<DescribeWhatIfForecastExportRequest.Builder> describeWhatIfForecastExportRequest) Describes the what-if forecast export created using the CreateWhatIfForecastExport operation.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) This is a variant oflistDatasetGroups(software.amazon.awssdk.services.forecast.model.ListDatasetGroupsRequest)
operation.default ListDatasetGroupsIterable
listDatasetGroupsPaginator
(ListDatasetGroupsRequest listDatasetGroupsRequest) This is a variant oflistDatasetGroups(software.amazon.awssdk.services.forecast.model.ListDatasetGroupsRequest)
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) This is a variant oflistDatasetImportJobs(software.amazon.awssdk.services.forecast.model.ListDatasetImportJobsRequest)
operation.default ListDatasetImportJobsIterable
listDatasetImportJobsPaginator
(ListDatasetImportJobsRequest listDatasetImportJobsRequest) This is a variant oflistDatasetImportJobs(software.amazon.awssdk.services.forecast.model.ListDatasetImportJobsRequest)
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) This is a variant oflistDatasets(software.amazon.awssdk.services.forecast.model.ListDatasetsRequest)
operation.default ListDatasetsIterable
listDatasetsPaginator
(ListDatasetsRequest listDatasetsRequest) This is a variant oflistDatasets(software.amazon.awssdk.services.forecast.model.ListDatasetsRequest)
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) This is a variant oflistExplainabilities(software.amazon.awssdk.services.forecast.model.ListExplainabilitiesRequest)
operation.default ListExplainabilitiesIterable
listExplainabilitiesPaginator
(ListExplainabilitiesRequest listExplainabilitiesRequest) This is a variant oflistExplainabilities(software.amazon.awssdk.services.forecast.model.ListExplainabilitiesRequest)
operation.listExplainabilityExports
(Consumer<ListExplainabilityExportsRequest.Builder> listExplainabilityExportsRequest) Returns a list of Explainability exports created using the CreateExplainabilityExport operation.listExplainabilityExports
(ListExplainabilityExportsRequest listExplainabilityExportsRequest) Returns a list of Explainability exports created using the CreateExplainabilityExport operation.listExplainabilityExportsPaginator
(Consumer<ListExplainabilityExportsRequest.Builder> listExplainabilityExportsRequest) This is a variant oflistExplainabilityExports(software.amazon.awssdk.services.forecast.model.ListExplainabilityExportsRequest)
operation.listExplainabilityExportsPaginator
(ListExplainabilityExportsRequest listExplainabilityExportsRequest) This is a variant oflistExplainabilityExports(software.amazon.awssdk.services.forecast.model.ListExplainabilityExportsRequest)
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) This is a variant oflistForecastExportJobs(software.amazon.awssdk.services.forecast.model.ListForecastExportJobsRequest)
operation.default ListForecastExportJobsIterable
listForecastExportJobsPaginator
(ListForecastExportJobsRequest listForecastExportJobsRequest) This is a variant oflistForecastExportJobs(software.amazon.awssdk.services.forecast.model.ListForecastExportJobsRequest)
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) This is a variant oflistForecasts(software.amazon.awssdk.services.forecast.model.ListForecastsRequest)
operation.default ListForecastsIterable
listForecastsPaginator
(ListForecastsRequest listForecastsRequest) This is a variant oflistForecasts(software.amazon.awssdk.services.forecast.model.ListForecastsRequest)
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) This is a variant oflistMonitorEvaluations(software.amazon.awssdk.services.forecast.model.ListMonitorEvaluationsRequest)
operation.default ListMonitorEvaluationsIterable
listMonitorEvaluationsPaginator
(ListMonitorEvaluationsRequest listMonitorEvaluationsRequest) This is a variant oflistMonitorEvaluations(software.amazon.awssdk.services.forecast.model.ListMonitorEvaluationsRequest)
operation.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) This is a variant oflistMonitors(software.amazon.awssdk.services.forecast.model.ListMonitorsRequest)
operation.default ListMonitorsIterable
listMonitorsPaginator
(ListMonitorsRequest listMonitorsRequest) This is a variant oflistMonitors(software.amazon.awssdk.services.forecast.model.ListMonitorsRequest)
operation.listPredictorBacktestExportJobs
(Consumer<ListPredictorBacktestExportJobsRequest.Builder> listPredictorBacktestExportJobsRequest) Returns a list of predictor backtest export jobs created using the CreatePredictorBacktestExportJob operation.listPredictorBacktestExportJobs
(ListPredictorBacktestExportJobsRequest listPredictorBacktestExportJobsRequest) Returns a list of predictor backtest export jobs created using the CreatePredictorBacktestExportJob operation.listPredictorBacktestExportJobsPaginator
(Consumer<ListPredictorBacktestExportJobsRequest.Builder> listPredictorBacktestExportJobsRequest) This is a variant oflistPredictorBacktestExportJobs(software.amazon.awssdk.services.forecast.model.ListPredictorBacktestExportJobsRequest)
operation.listPredictorBacktestExportJobsPaginator
(ListPredictorBacktestExportJobsRequest listPredictorBacktestExportJobsRequest) This is a variant oflistPredictorBacktestExportJobs(software.amazon.awssdk.services.forecast.model.ListPredictorBacktestExportJobsRequest)
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) This is a variant oflistPredictors(software.amazon.awssdk.services.forecast.model.ListPredictorsRequest)
operation.default ListPredictorsIterable
listPredictorsPaginator
(ListPredictorsRequest listPredictorsRequest) This is a variant oflistPredictors(software.amazon.awssdk.services.forecast.model.ListPredictorsRequest)
operation.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) This is a variant oflistWhatIfAnalyses(software.amazon.awssdk.services.forecast.model.ListWhatIfAnalysesRequest)
operation.default ListWhatIfAnalysesIterable
listWhatIfAnalysesPaginator
(ListWhatIfAnalysesRequest listWhatIfAnalysesRequest) This is a variant oflistWhatIfAnalyses(software.amazon.awssdk.services.forecast.model.ListWhatIfAnalysesRequest)
operation.listWhatIfForecastExports
(Consumer<ListWhatIfForecastExportsRequest.Builder> listWhatIfForecastExportsRequest) Returns a list of what-if forecast exports created using the CreateWhatIfForecastExport operation.listWhatIfForecastExports
(ListWhatIfForecastExportsRequest listWhatIfForecastExportsRequest) Returns a list of what-if forecast exports created using the CreateWhatIfForecastExport operation.listWhatIfForecastExportsPaginator
(Consumer<ListWhatIfForecastExportsRequest.Builder> listWhatIfForecastExportsRequest) This is a variant oflistWhatIfForecastExports(software.amazon.awssdk.services.forecast.model.ListWhatIfForecastExportsRequest)
operation.listWhatIfForecastExportsPaginator
(ListWhatIfForecastExportsRequest listWhatIfForecastExportsRequest) This is a variant oflistWhatIfForecastExports(software.amazon.awssdk.services.forecast.model.ListWhatIfForecastExportsRequest)
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) This is a variant oflistWhatIfForecasts(software.amazon.awssdk.services.forecast.model.ListWhatIfForecastsRequest)
operation.default ListWhatIfForecastsIterable
listWhatIfForecastsPaginator
(ListWhatIfForecastsRequest listWhatIfForecastsRequest) This is a variant oflistWhatIfForecasts(software.amazon.awssdk.services.forecast.model.ListWhatIfForecastsRequest)
operation.default ResumeResourceResponse
resumeResource
(Consumer<ResumeResourceRequest.Builder> resumeResourceRequest) Resumes a stopped monitor resource.default ResumeResourceResponse
resumeResource
(ResumeResourceRequest resumeResourceRequest) Resumes a stopped monitor resource.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic 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 specifiedresourceArn
.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Associates the specified tags to a resource with the specifiedresourceArn
.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.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createAutoPredictor
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
andPredictorName
.- Parameters:
createAutoPredictorRequest
-- Returns:
- Result of the CreateAutoPredictor operation returned by the service.
- See Also:
-
-
createAutoPredictor
default 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
andPredictorName
.
This is a convenience which creates an instance of the
CreateAutoPredictorRequest.Builder
avoiding the need to create one manually viaCreateAutoPredictorRequest.builder()
- Parameters:
createAutoPredictorRequest
- AConsumer
that will call methods onCreateAutoPredictorRequest.Builder
to create a request.- Returns:
- Result of the CreateAutoPredictor operation returned by the service.
- See Also:
-
-
createDataset
default 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
andDatasetType
- 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 beACTIVE
before you can import training data. Use the DescribeDataset operation to get the status.- Parameters:
createDatasetRequest
-- Returns:
- Result of the CreateDataset operation returned by the service.
- See Also:
-
-
createDataset
default 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
andDatasetType
- 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 beACTIVE
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 viaCreateDatasetRequest.builder()
- Parameters:
createDatasetRequest
- AConsumer
that will call methods onCreateDatasetRequest.Builder
to create a request.- Returns:
- Result of the CreateDataset operation returned by the service.
- See Also:
-
-
createDatasetGroup
default 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 beACTIVE
before you can use the dataset group to create a predictor. To get the status, use the DescribeDatasetGroup operation.- Parameters:
createDatasetGroupRequest
-- Returns:
- Result of the CreateDatasetGroup operation returned by the service.
- See Also:
-
createDatasetGroup
default 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 beACTIVE
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 viaCreateDatasetGroupRequest.builder()
- Parameters:
createDatasetGroupRequest
- AConsumer
that will call methods onCreateDatasetGroupRequest.Builder
to create a request.- Returns:
- Result of the CreateDatasetGroup operation returned by the service.
- See Also:
-
createDatasetImportJob
default 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.
- Parameters:
createDatasetImportJobRequest
-- Returns:
- Result of the CreateDatasetImportJob operation returned by the service.
- See Also:
-
createDatasetImportJob
default 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 viaCreateDatasetImportJobRequest.builder()
- Parameters:
createDatasetImportJobRequest
- AConsumer
that will call methods onCreateDatasetImportJobRequest.Builder
to create a request.- Returns:
- Result of the CreateDatasetImportJob operation returned by the service.
- See Also:
-
createExplainability
default 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.
- Parameters:
createExplainabilityRequest
-- Returns:
- Result of the CreateExplainability operation returned by the service.
- See Also:
-
-
createExplainability
default 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 viaCreateExplainabilityRequest.builder()
- Parameters:
createExplainabilityRequest
- AConsumer
that will call methods onCreateExplainabilityRequest.Builder
to create a request.- Returns:
- Result of the CreateExplainability operation returned by the service.
- See Also:
-
-
createExplainabilityExport
default 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 beACTIVE
before you can access the export in your Amazon S3 bucket. To get the status, use the DescribeExplainabilityExport operation.- Parameters:
createExplainabilityExportRequest
-- Returns:
- Result of the CreateExplainabilityExport operation returned by the service.
- See Also:
-
createExplainabilityExport
default 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 beACTIVE
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 viaCreateExplainabilityExportRequest.builder()
- Parameters:
createExplainabilityExportRequest
- AConsumer
that will call methods onCreateExplainabilityExportRequest.Builder
to create a request.- Returns:
- Result of the CreateExplainabilityExport operation returned by the service.
- See Also:
-
createForecast
default 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 beACTIVE
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 theTimeSeriesSelector
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.- Parameters:
createForecastRequest
-- Returns:
- Result of the CreateForecast operation returned by the service.
- See Also:
-
createForecast
default 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 beACTIVE
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 theTimeSeriesSelector
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 viaCreateForecastRequest.builder()
- Parameters:
createForecastRequest
- AConsumer
that will call methods onCreateForecastRequest.Builder
to create a request.- Returns:
- Result of the CreateForecast operation returned by the service.
- See Also:
-
createForecastExportJob
default 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 beACTIVE
before you can access the forecast in your Amazon S3 bucket. To get the status, use the DescribeForecastExportJob operation.- Parameters:
createForecastExportJobRequest
-- Returns:
- Result of the CreateForecastExportJob operation returned by the service.
- See Also:
-
createForecastExportJob
default 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 beACTIVE
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 viaCreateForecastExportJobRequest.builder()
- Parameters:
createForecastExportJobRequest
- AConsumer
that will call methods onCreateForecastExportJobRequest.Builder
to create a request.- Returns:
- Result of the CreateForecastExportJob operation returned by the service.
- See Also:
-
createMonitor
default 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.
- Parameters:
createMonitorRequest
-- Returns:
- Result of the CreateMonitor operation returned by the service.
- See Also:
-
createMonitor
default 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 viaCreateMonitorRequest.builder()
- Parameters:
createMonitorRequest
- AConsumer
that will call methods onCreateMonitorRequest.Builder
to create a request.- Returns:
- Result of the CreateMonitor operation returned by the service.
- See Also:
-
createPredictor
default 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 theDataFrequency
specified when the dataset was created matches theForecastFrequency
. 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
, setPerformAutoML
totrue
. Theobjective 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 beACTIVE
, signifying that training has completed. To get the status, use the DescribePredictor operation.- Parameters:
createPredictorRequest
-- Returns:
- Result of the CreatePredictor operation returned by the service.
- See Also:
-
-
createPredictor
default 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 theDataFrequency
specified when the dataset was created matches theForecastFrequency
. 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
, setPerformAutoML
totrue
. Theobjective 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 beACTIVE
, 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 viaCreatePredictorRequest.builder()
- Parameters:
createPredictorRequest
- AConsumer
that will call methods onCreatePredictorRequest.Builder
to create a request.- Returns:
- Result of the CreatePredictor operation returned by the service.
- See Also:
-
-
createPredictorBacktestExportJob
default 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 beACTIVE
before you can access the export in your Amazon S3 bucket. To get the status, use the DescribePredictorBacktestExportJob operation.- Parameters:
createPredictorBacktestExportJobRequest
-- Returns:
- Result of the CreatePredictorBacktestExportJob operation returned by the service.
- See Also:
-
createPredictorBacktestExportJob
default 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 beACTIVE
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 viaCreatePredictorBacktestExportJobRequest.builder()
- Parameters:
createPredictorBacktestExportJobRequest
- AConsumer
that will call methods onCreatePredictorBacktestExportJobRequest.Builder
to create a request.- Returns:
- Result of the CreatePredictorBacktestExportJob operation returned by the service.
- See Also:
-
createWhatIfAnalysis
default 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.
- Parameters:
createWhatIfAnalysisRequest
-- Returns:
- Result of the CreateWhatIfAnalysis operation returned by the service.
- See Also:
-
createWhatIfAnalysis
default 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 viaCreateWhatIfAnalysisRequest.builder()
- Parameters:
createWhatIfAnalysisRequest
- AConsumer
that will call methods onCreateWhatIfAnalysisRequest.Builder
to create a request.- Returns:
- Result of the CreateWhatIfAnalysis operation returned by the service.
- See Also:
-
createWhatIfForecast
default 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.
- Parameters:
createWhatIfForecastRequest
-- Returns:
- Result of the CreateWhatIfForecast operation returned by the service.
- See Also:
-
createWhatIfForecast
default 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 viaCreateWhatIfForecastRequest.builder()
- Parameters:
createWhatIfForecastRequest
- AConsumer
that will call methods onCreateWhatIfForecastRequest.Builder
to create a request.- Returns:
- Result of the CreateWhatIfForecast operation returned by the service.
- See Also:
-
createWhatIfForecastExport
default 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 beACTIVE
before you can access the forecast in your Amazon S3 bucket. To get the status, use the DescribeWhatIfForecastExport operation.- Parameters:
createWhatIfForecastExportRequest
-- Returns:
- Result of the CreateWhatIfForecastExport operation returned by the service.
- See Also:
-
createWhatIfForecastExport
default 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 beACTIVE
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 viaCreateWhatIfForecastExportRequest.builder()
- Parameters:
createWhatIfForecastExportRequest
- AConsumer
that will call methods onCreateWhatIfForecastExportRequest.Builder
to create a request.- Returns:
- Result of the CreateWhatIfForecastExport operation returned by the service.
- See Also:
-
deleteDataset
default 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
orCREATE_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.
- Parameters:
deleteDatasetRequest
-- Returns:
- Result of the DeleteDataset operation returned by the service.
- See Also:
-
deleteDataset
default 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
orCREATE_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 viaDeleteDatasetRequest.builder()
- Parameters:
deleteDatasetRequest
- AConsumer
that will call methods onDeleteDatasetRequest.Builder
to create a request.- Returns:
- Result of the DeleteDataset operation returned by the service.
- See Also:
-
deleteDatasetGroup
default 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
, orUPDATE_FAILED
. To get the status, use the DescribeDatasetGroup operation.This operation deletes only the dataset group, not the datasets in the group.
- Parameters:
deleteDatasetGroupRequest
-- Returns:
- Result of the DeleteDatasetGroup operation returned by the service.
- See Also:
-
deleteDatasetGroup
default 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
, orUPDATE_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 viaDeleteDatasetGroupRequest.builder()
- Parameters:
deleteDatasetGroupRequest
- AConsumer
that will call methods onDeleteDatasetGroupRequest.Builder
to create a request.- Returns:
- Result of the DeleteDatasetGroup operation returned by the service.
- See Also:
-
deleteDatasetImportJob
default 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
orCREATE_FAILED
. To get the status, use the DescribeDatasetImportJob operation.- Parameters:
deleteDatasetImportJobRequest
-- Returns:
- Result of the DeleteDatasetImportJob operation returned by the service.
- See Also:
-
deleteDatasetImportJob
default 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
orCREATE_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 viaDeleteDatasetImportJobRequest.builder()
- Parameters:
deleteDatasetImportJobRequest
- AConsumer
that will call methods onDeleteDatasetImportJobRequest.Builder
to create a request.- Returns:
- Result of the DeleteDatasetImportJob operation returned by the service.
- See Also:
-
deleteExplainability
default 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
orCREATE_FAILED
. To get the status, use the DescribeExplainability operation.- Parameters:
deleteExplainabilityRequest
-- Returns:
- Result of the DeleteExplainability operation returned by the service.
- See Also:
-
deleteExplainability
default 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
orCREATE_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 viaDeleteExplainabilityRequest.builder()
- Parameters:
deleteExplainabilityRequest
- AConsumer
that will call methods onDeleteExplainabilityRequest.Builder
to create a request.- Returns:
- Result of the DeleteExplainability operation returned by the service.
- See Also:
-
deleteExplainabilityExport
default DeleteExplainabilityExportResponse deleteExplainabilityExport(DeleteExplainabilityExportRequest deleteExplainabilityExportRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException Deletes an Explainability export.
- Parameters:
deleteExplainabilityExportRequest
-- Returns:
- Result of the DeleteExplainabilityExport operation returned by the service.
- See Also:
-
deleteExplainabilityExport
default 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 viaDeleteExplainabilityExportRequest.builder()
- Parameters:
deleteExplainabilityExportRequest
- AConsumer
that will call methods onDeleteExplainabilityExportRequest.Builder
to create a request.- Returns:
- Result of the DeleteExplainabilityExport operation returned by the service.
- See Also:
-
deleteForecast
default 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
orCREATE_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.
- Parameters:
deleteForecastRequest
-- Returns:
- Result of the DeleteForecast operation returned by the service.
- See Also:
-
deleteForecast
default 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
orCREATE_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 viaDeleteForecastRequest.builder()
- Parameters:
deleteForecastRequest
- AConsumer
that will call methods onDeleteForecastRequest.Builder
to create a request.- Returns:
- Result of the DeleteForecast operation returned by the service.
- See Also:
-
deleteForecastExportJob
default 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
orCREATE_FAILED
. To get the status, use the DescribeForecastExportJob operation.- Parameters:
deleteForecastExportJobRequest
-- Returns:
- Result of the DeleteForecastExportJob operation returned by the service.
- See Also:
-
deleteForecastExportJob
default 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
orCREATE_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 viaDeleteForecastExportJobRequest.builder()
- Parameters:
deleteForecastExportJobRequest
- AConsumer
that will call methods onDeleteForecastExportJobRequest.Builder
to create a request.- Returns:
- Result of the DeleteForecastExportJob operation returned by the service.
- See Also:
-
deleteMonitor
default 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
, orCREATE_STOPPED
.- Parameters:
deleteMonitorRequest
-- Returns:
- Result of the DeleteMonitor operation returned by the service.
- See Also:
-
deleteMonitor
default 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
, orCREATE_STOPPED
.
This is a convenience which creates an instance of the
DeleteMonitorRequest.Builder
avoiding the need to create one manually viaDeleteMonitorRequest.builder()
- Parameters:
deleteMonitorRequest
- AConsumer
that will call methods onDeleteMonitorRequest.Builder
to create a request.- Returns:
- Result of the DeleteMonitor operation returned by the service.
- See Also:
-
deletePredictor
default 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
orCREATE_FAILED
. To get the status, use the DescribePredictor operation.- Parameters:
deletePredictorRequest
-- Returns:
- Result of the DeletePredictor operation returned by the service.
- See Also:
-
deletePredictor
default 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
orCREATE_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 viaDeletePredictorRequest.builder()
- Parameters:
deletePredictorRequest
- AConsumer
that will call methods onDeletePredictorRequest.Builder
to create a request.- Returns:
- Result of the DeletePredictor operation returned by the service.
- See Also:
-
deletePredictorBacktestExportJob
default DeletePredictorBacktestExportJobResponse deletePredictorBacktestExportJob(DeletePredictorBacktestExportJobRequest deletePredictorBacktestExportJobRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException Deletes a predictor backtest export job.
- Parameters:
deletePredictorBacktestExportJobRequest
-- Returns:
- Result of the DeletePredictorBacktestExportJob operation returned by the service.
- See Also:
-
deletePredictorBacktestExportJob
default 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 viaDeletePredictorBacktestExportJobRequest.builder()
- Parameters:
deletePredictorBacktestExportJobRequest
- AConsumer
that will call methods onDeletePredictorBacktestExportJobRequest.Builder
to create a request.- Returns:
- Result of the DeletePredictorBacktestExportJob operation returned by the service.
- See Also:
-
deleteResourceTree
default 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.- Parameters:
deleteResourceTreeRequest
-- Returns:
- Result of the DeleteResourceTree operation returned by the service.
- See Also:
-
-
deleteResourceTree
default 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 viaDeleteResourceTreeRequest.builder()
- Parameters:
deleteResourceTreeRequest
- AConsumer
that will call methods onDeleteResourceTreeRequest.Builder
to create a request.- Returns:
- Result of the DeleteResourceTree operation returned by the service.
- See Also:
-
-
deleteWhatIfAnalysis
default 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
orCREATE_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.
- Parameters:
deleteWhatIfAnalysisRequest
-- Returns:
- Result of the DeleteWhatIfAnalysis operation returned by the service.
- See Also:
-
deleteWhatIfAnalysis
default 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
orCREATE_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 viaDeleteWhatIfAnalysisRequest.builder()
- Parameters:
deleteWhatIfAnalysisRequest
- AConsumer
that will call methods onDeleteWhatIfAnalysisRequest.Builder
to create a request.- Returns:
- Result of the DeleteWhatIfAnalysis operation returned by the service.
- See Also:
-
deleteWhatIfForecast
default 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
orCREATE_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.
- Parameters:
deleteWhatIfForecastRequest
-- Returns:
- Result of the DeleteWhatIfForecast operation returned by the service.
- See Also:
-
deleteWhatIfForecast
default 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
orCREATE_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 viaDeleteWhatIfForecastRequest.builder()
- Parameters:
deleteWhatIfForecastRequest
- AConsumer
that will call methods onDeleteWhatIfForecastRequest.Builder
to create a request.- Returns:
- Result of the DeleteWhatIfForecast operation returned by the service.
- See Also:
-
deleteWhatIfForecastExport
default 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
orCREATE_FAILED
. To get the status, use the DescribeWhatIfForecastExport operation.- Parameters:
deleteWhatIfForecastExportRequest
-- Returns:
- Result of the DeleteWhatIfForecastExport operation returned by the service.
- See Also:
-
deleteWhatIfForecastExport
default 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
orCREATE_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 viaDeleteWhatIfForecastExportRequest.builder()
- Parameters:
deleteWhatIfForecastExportRequest
- AConsumer
that will call methods onDeleteWhatIfForecastExportRequest.Builder
to create a request.- Returns:
- Result of the DeleteWhatIfForecastExport operation returned by the service.
- See Also:
-
describeAutoPredictor
default DescribeAutoPredictorResponse describeAutoPredictor(DescribeAutoPredictorRequest describeAutoPredictorRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException Describes a predictor created using the CreateAutoPredictor operation.
- Parameters:
describeAutoPredictorRequest
-- Returns:
- Result of the DescribeAutoPredictor operation returned by the service.
- See Also:
-
describeAutoPredictor
default 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 viaDescribeAutoPredictorRequest.builder()
- Parameters:
describeAutoPredictorRequest
- AConsumer
that will call methods onDescribeAutoPredictorRequest.Builder
to create a request.- Returns:
- Result of the DescribeAutoPredictor operation returned by the service.
- See Also:
-
describeDataset
default 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
- Parameters:
describeDatasetRequest
-- Returns:
- Result of the DescribeDataset operation returned by the service.
- See Also:
-
-
describeDataset
default 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 viaDescribeDatasetRequest.builder()
- Parameters:
describeDatasetRequest
- AConsumer
that will call methods onDescribeDatasetRequest.Builder
to create a request.- Returns:
- Result of the DescribeDataset operation returned by the service.
- See Also:
-
-
describeDatasetGroup
default 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
- Parameters:
describeDatasetGroupRequest
-- Returns:
- Result of the DescribeDatasetGroup operation returned by the service.
- See Also:
-
-
describeDatasetGroup
default 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 viaDescribeDatasetGroupRequest.builder()
- Parameters:
describeDatasetGroupRequest
- AConsumer
that will call methods onDescribeDatasetGroupRequest.Builder
to create a request.- Returns:
- Result of the DescribeDatasetGroup operation returned by the service.
- See Also:
-
-
describeDatasetImportJob
default 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.
- Parameters:
describeDatasetImportJobRequest
-- Returns:
- Result of the DescribeDatasetImportJob operation returned by the service.
- See Also:
-
-
describeDatasetImportJob
default 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 viaDescribeDatasetImportJobRequest.builder()
- Parameters:
describeDatasetImportJobRequest
- AConsumer
that will call methods onDescribeDatasetImportJobRequest.Builder
to create a request.- Returns:
- Result of the DescribeDatasetImportJob operation returned by the service.
- See Also:
-
-
describeExplainability
default DescribeExplainabilityResponse describeExplainability(DescribeExplainabilityRequest describeExplainabilityRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException Describes an Explainability resource created using the CreateExplainability operation.
- Parameters:
describeExplainabilityRequest
-- Returns:
- Result of the DescribeExplainability operation returned by the service.
- See Also:
-
describeExplainability
default 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 viaDescribeExplainabilityRequest.builder()
- Parameters:
describeExplainabilityRequest
- AConsumer
that will call methods onDescribeExplainabilityRequest.Builder
to create a request.- Returns:
- Result of the DescribeExplainability operation returned by the service.
- See Also:
-
describeExplainabilityExport
default DescribeExplainabilityExportResponse describeExplainabilityExport(DescribeExplainabilityExportRequest describeExplainabilityExportRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException Describes an Explainability export created using the CreateExplainabilityExport operation.
- Parameters:
describeExplainabilityExportRequest
-- Returns:
- Result of the DescribeExplainabilityExport operation returned by the service.
- See Also:
-
describeExplainabilityExport
default 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 viaDescribeExplainabilityExportRequest.builder()
- Parameters:
describeExplainabilityExportRequest
- AConsumer
that will call methods onDescribeExplainabilityExportRequest.Builder
to create a request.- Returns:
- Result of the DescribeExplainabilityExport operation returned by the service.
- See Also:
-
describeForecast
default 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.
- Parameters:
describeForecastRequest
-- Returns:
- Result of the DescribeForecast operation returned by the service.
- See Also:
-
-
describeForecast
default 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 viaDescribeForecastRequest.builder()
- Parameters:
describeForecastRequest
- AConsumer
that will call methods onDescribeForecastRequest.Builder
to create a request.- Returns:
- Result of the DescribeForecast operation returned by the service.
- See Also:
-
-
describeForecastExportJob
default 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.
- Parameters:
describeForecastExportJobRequest
-- Returns:
- Result of the DescribeForecastExportJob operation returned by the service.
- See Also:
-
-
describeForecastExportJob
default 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 viaDescribeForecastExportJobRequest.builder()
- Parameters:
describeForecastExportJobRequest
- AConsumer
that will call methods onDescribeForecastExportJobRequest.Builder
to create a request.- Returns:
- Result of the DescribeForecastExportJob operation returned by the service.
- See Also:
-
-
describeMonitor
default 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
- Parameters:
describeMonitorRequest
-- Returns:
- Result of the DescribeMonitor operation returned by the service.
- See Also:
-
-
describeMonitor
default 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 viaDescribeMonitorRequest.builder()
- Parameters:
describeMonitorRequest
- AConsumer
that will call methods onDescribeMonitorRequest.Builder
to create a request.- Returns:
- Result of the DescribeMonitor operation returned by the service.
- See Also:
-
-
describePredictor
default 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.
- Parameters:
describePredictorRequest
-- Returns:
- Result of the DescribePredictor operation returned by the service.
- See Also:
-
-
describePredictor
default 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 viaDescribePredictorRequest.builder()
- Parameters:
describePredictorRequest
- AConsumer
that will call methods onDescribePredictorRequest.Builder
to create a request.- Returns:
- Result of the DescribePredictor operation returned by the service.
- See Also:
-
-
describePredictorBacktestExportJob
default 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)
- Parameters:
describePredictorBacktestExportJobRequest
-- Returns:
- Result of the DescribePredictorBacktestExportJob operation returned by the service.
- See Also:
-
-
describePredictorBacktestExportJob
default 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 viaDescribePredictorBacktestExportJobRequest.builder()
- Parameters:
describePredictorBacktestExportJobRequest
- AConsumer
that will call methods onDescribePredictorBacktestExportJobRequest.Builder
to create a request.- Returns:
- Result of the DescribePredictorBacktestExportJob operation returned by the service.
- See Also:
-
-
describeWhatIfAnalysis
default 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
- Parameters:
describeWhatIfAnalysisRequest
-- Returns:
- Result of the DescribeWhatIfAnalysis operation returned by the service.
- See Also:
-
-
describeWhatIfAnalysis
default 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 viaDescribeWhatIfAnalysisRequest.builder()
- Parameters:
describeWhatIfAnalysisRequest
- AConsumer
that will call methods onDescribeWhatIfAnalysisRequest.Builder
to create a request.- Returns:
- Result of the DescribeWhatIfAnalysis operation returned by the service.
- See Also:
-
-
describeWhatIfForecast
default 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
- Parameters:
describeWhatIfForecastRequest
-- Returns:
- Result of the DescribeWhatIfForecast operation returned by the service.
- See Also:
-
-
describeWhatIfForecast
default 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 viaDescribeWhatIfForecastRequest.builder()
- Parameters:
describeWhatIfForecastRequest
- AConsumer
that will call methods onDescribeWhatIfForecastRequest.Builder
to create a request.- Returns:
- Result of the DescribeWhatIfForecast operation returned by the service.
- See Also:
-
-
describeWhatIfForecastExport
default 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
- Parameters:
describeWhatIfForecastExportRequest
-- Returns:
- Result of the DescribeWhatIfForecastExport operation returned by the service.
- See Also:
-
-
describeWhatIfForecastExport
default 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 viaDescribeWhatIfForecastExportRequest.builder()
- Parameters:
describeWhatIfForecastExportRequest
- AConsumer
that will call methods onDescribeWhatIfForecastExportRequest.Builder
to create a request.- Returns:
- Result of the DescribeWhatIfForecastExport operation returned by the service.
- See Also:
-
-
getAccuracyMetrics
default 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 theCreatePredictor
request. IfNumberOfBacktestWindows
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, specifyzero
. If you want only those items that have complete data in the range being evaluated to contribute, specifynan
. For more information, see FeaturizationMethod.Before you can get accuracy metrics, the
Status
of the predictor must beACTIVE
, signifying that training has completed. To get the status, use the DescribePredictor operation.- Parameters:
getAccuracyMetricsRequest
-- Returns:
- Result of the GetAccuracyMetrics operation returned by the service.
- See Also:
-
getAccuracyMetrics
default 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 theCreatePredictor
request. IfNumberOfBacktestWindows
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, specifyzero
. If you want only those items that have complete data in the range being evaluated to contribute, specifynan
. For more information, see FeaturizationMethod.Before you can get accuracy metrics, the
Status
of the predictor must beACTIVE
, 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 viaGetAccuracyMetricsRequest.builder()
- Parameters:
getAccuracyMetricsRequest
- AConsumer
that will call methods onGetAccuracyMetricsRequest.Builder
to create a request.- Returns:
- Result of the GetAccuracyMetrics operation returned by the service.
- See Also:
-
listDatasetGroups
default 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.
- Parameters:
listDatasetGroupsRequest
-- Returns:
- Result of the ListDatasetGroups operation returned by the service.
- See Also:
-
listDatasetGroups
default 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 viaListDatasetGroupsRequest.builder()
- Parameters:
listDatasetGroupsRequest
- AConsumer
that will call methods onListDatasetGroupsRequest.Builder
to create a request.- Returns:
- Result of the ListDatasetGroups operation returned by the service.
- See Also:
-
listDatasetGroupsPaginator
default ListDatasetGroupsIterable listDatasetGroupsPaginator(ListDatasetGroupsRequest listDatasetGroupsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, ForecastException 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 Streamsoftware.amazon.awssdk.services.forecast.paginators.ListDatasetGroupsIterable responses = client.listDatasetGroupsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listDatasetGroupsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDatasetGroupsPaginator
default ListDatasetGroupsIterable listDatasetGroupsPaginator(Consumer<ListDatasetGroupsRequest.Builder> listDatasetGroupsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, ForecastException 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 Streamsoftware.amazon.awssdk.services.forecast.paginators.ListDatasetGroupsIterable responses = client.listDatasetGroupsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListDatasetGroupsRequest.builder()
- Parameters:
listDatasetGroupsRequest
- AConsumer
that will call methods onListDatasetGroupsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDatasetImportJobs
default 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.
- Parameters:
listDatasetImportJobsRequest
-- Returns:
- Result of the ListDatasetImportJobs operation returned by the service.
- See Also:
-
listDatasetImportJobs
default 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 viaListDatasetImportJobsRequest.builder()
- Parameters:
listDatasetImportJobsRequest
- AConsumer
that will call methods onListDatasetImportJobsRequest.Builder
to create a request.- Returns:
- Result of the ListDatasetImportJobs operation returned by the service.
- See Also:
-
listDatasetImportJobsPaginator
default ListDatasetImportJobsIterable listDatasetImportJobsPaginator(ListDatasetImportJobsRequest listDatasetImportJobsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException 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 Streamsoftware.amazon.awssdk.services.forecast.paginators.ListDatasetImportJobsIterable responses = client.listDatasetImportJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listDatasetImportJobsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDatasetImportJobsPaginator
default ListDatasetImportJobsIterable listDatasetImportJobsPaginator(Consumer<ListDatasetImportJobsRequest.Builder> listDatasetImportJobsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException 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 Streamsoftware.amazon.awssdk.services.forecast.paginators.ListDatasetImportJobsIterable responses = client.listDatasetImportJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListDatasetImportJobsRequest.builder()
- Parameters:
listDatasetImportJobsRequest
- AConsumer
that will call methods onListDatasetImportJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDatasets
default 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.
- Parameters:
listDatasetsRequest
-- Returns:
- Result of the ListDatasets operation returned by the service.
- See Also:
-
listDatasets
default 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 viaListDatasetsRequest.builder()
- Parameters:
listDatasetsRequest
- AConsumer
that will call methods onListDatasetsRequest.Builder
to create a request.- Returns:
- Result of the ListDatasets operation returned by the service.
- See Also:
-
listDatasetsPaginator
default ListDatasetsIterable listDatasetsPaginator(ListDatasetsRequest listDatasetsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, ForecastException 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 Streamsoftware.amazon.awssdk.services.forecast.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listDatasetsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDatasetsPaginator
default ListDatasetsIterable listDatasetsPaginator(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, ForecastException 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 Streamsoftware.amazon.awssdk.services.forecast.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListDatasetsRequest.builder()
- Parameters:
listDatasetsRequest
- AConsumer
that will call methods onListDatasetsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listExplainabilities
default 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.
- Parameters:
listExplainabilitiesRequest
-- Returns:
- Result of the ListExplainabilities operation returned by the service.
- See Also:
-
listExplainabilities
default 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 viaListExplainabilitiesRequest.builder()
- Parameters:
listExplainabilitiesRequest
- AConsumer
that will call methods onListExplainabilitiesRequest.Builder
to create a request.- Returns:
- Result of the ListExplainabilities operation returned by the service.
- See Also:
-
listExplainabilitiesPaginator
default ListExplainabilitiesIterable listExplainabilitiesPaginator(ListExplainabilitiesRequest listExplainabilitiesRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException 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 Streamsoftware.amazon.awssdk.services.forecast.paginators.ListExplainabilitiesIterable responses = client.listExplainabilitiesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listExplainabilitiesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listExplainabilitiesPaginator
default ListExplainabilitiesIterable listExplainabilitiesPaginator(Consumer<ListExplainabilitiesRequest.Builder> listExplainabilitiesRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException 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 Streamsoftware.amazon.awssdk.services.forecast.paginators.ListExplainabilitiesIterable responses = client.listExplainabilitiesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListExplainabilitiesRequest.builder()
- Parameters:
listExplainabilitiesRequest
- AConsumer
that will call methods onListExplainabilitiesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listExplainabilityExports
default 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.
- Parameters:
listExplainabilityExportsRequest
-- Returns:
- Result of the ListExplainabilityExports operation returned by the service.
- See Also:
-
listExplainabilityExports
default 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 viaListExplainabilityExportsRequest.builder()
- Parameters:
listExplainabilityExportsRequest
- AConsumer
that will call methods onListExplainabilityExportsRequest.Builder
to create a request.- Returns:
- Result of the ListExplainabilityExports operation returned by the service.
- See Also:
-
listExplainabilityExportsPaginator
default ListExplainabilityExportsIterable listExplainabilityExportsPaginator(ListExplainabilityExportsRequest listExplainabilityExportsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException 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 Streamsoftware.amazon.awssdk.services.forecast.paginators.ListExplainabilityExportsIterable responses = client.listExplainabilityExportsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listExplainabilityExportsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listExplainabilityExportsPaginator
default ListExplainabilityExportsIterable listExplainabilityExportsPaginator(Consumer<ListExplainabilityExportsRequest.Builder> listExplainabilityExportsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException 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 Streamsoftware.amazon.awssdk.services.forecast.paginators.ListExplainabilityExportsIterable responses = client.listExplainabilityExportsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListExplainabilityExportsRequest.builder()
- Parameters:
listExplainabilityExportsRequest
- AConsumer
that will call methods onListExplainabilityExportsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listForecastExportJobs
default 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.
- Parameters:
listForecastExportJobsRequest
-- Returns:
- Result of the ListForecastExportJobs operation returned by the service.
- See Also:
-
listForecastExportJobs
default 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 viaListForecastExportJobsRequest.builder()
- Parameters:
listForecastExportJobsRequest
- AConsumer
that will call methods onListForecastExportJobsRequest.Builder
to create a request.- Returns:
- Result of the ListForecastExportJobs operation returned by the service.
- See Also:
-
listForecastExportJobsPaginator
default ListForecastExportJobsIterable listForecastExportJobsPaginator(ListForecastExportJobsRequest listForecastExportJobsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException 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 Streamsoftware.amazon.awssdk.services.forecast.paginators.ListForecastExportJobsIterable responses = client.listForecastExportJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listForecastExportJobsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listForecastExportJobsPaginator
default ListForecastExportJobsIterable listForecastExportJobsPaginator(Consumer<ListForecastExportJobsRequest.Builder> listForecastExportJobsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException 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 Streamsoftware.amazon.awssdk.services.forecast.paginators.ListForecastExportJobsIterable responses = client.listForecastExportJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListForecastExportJobsRequest.builder()
- Parameters:
listForecastExportJobsRequest
- AConsumer
that will call methods onListForecastExportJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listForecasts
default 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.
- Parameters:
listForecastsRequest
-- Returns:
- Result of the ListForecasts operation returned by the service.
- See Also:
-
listForecasts
default 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 viaListForecastsRequest.builder()
- Parameters:
listForecastsRequest
- AConsumer
that will call methods onListForecastsRequest.Builder
to create a request.- Returns:
- Result of the ListForecasts operation returned by the service.
- See Also:
-
listForecastsPaginator
default ListForecastsIterable listForecastsPaginator(ListForecastsRequest listForecastsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException 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 Streamsoftware.amazon.awssdk.services.forecast.paginators.ListForecastsIterable responses = client.listForecastsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listForecastsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listForecastsPaginator
default ListForecastsIterable listForecastsPaginator(Consumer<ListForecastsRequest.Builder> listForecastsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException 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 Streamsoftware.amazon.awssdk.services.forecast.paginators.ListForecastsIterable responses = client.listForecastsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListForecastsRequest.builder()
- Parameters:
listForecastsRequest
- AConsumer
that will call methods onListForecastsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listMonitorEvaluations
default 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.
- Parameters:
listMonitorEvaluationsRequest
-- Returns:
- Result of the ListMonitorEvaluations operation returned by the service.
- See Also:
-
listMonitorEvaluations
default 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 viaListMonitorEvaluationsRequest.builder()
- Parameters:
listMonitorEvaluationsRequest
- AConsumer
that will call methods onListMonitorEvaluationsRequest.Builder
to create a request.- Returns:
- Result of the ListMonitorEvaluations operation returned by the service.
- See Also:
-
listMonitorEvaluationsPaginator
default ListMonitorEvaluationsIterable listMonitorEvaluationsPaginator(ListMonitorEvaluationsRequest listMonitorEvaluationsRequest) throws InvalidNextTokenException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException 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 Streamsoftware.amazon.awssdk.services.forecast.paginators.ListMonitorEvaluationsIterable responses = client.listMonitorEvaluationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listMonitorEvaluationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listMonitorEvaluationsPaginator
default ListMonitorEvaluationsIterable listMonitorEvaluationsPaginator(Consumer<ListMonitorEvaluationsRequest.Builder> listMonitorEvaluationsRequest) throws InvalidNextTokenException, InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException 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 Streamsoftware.amazon.awssdk.services.forecast.paginators.ListMonitorEvaluationsIterable responses = client.listMonitorEvaluationsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListMonitorEvaluationsRequest.builder()
- Parameters:
listMonitorEvaluationsRequest
- AConsumer
that will call methods onListMonitorEvaluationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listMonitors
default 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.
- Parameters:
listMonitorsRequest
-- Returns:
- Result of the ListMonitors operation returned by the service.
- See Also:
-
listMonitors
default 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 viaListMonitorsRequest.builder()
- Parameters:
listMonitorsRequest
- AConsumer
that will call methods onListMonitorsRequest.Builder
to create a request.- Returns:
- Result of the ListMonitors operation returned by the service.
- See Also:
-
listMonitorsPaginator
default ListMonitorsIterable listMonitorsPaginator(ListMonitorsRequest listMonitorsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException 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 Streamsoftware.amazon.awssdk.services.forecast.paginators.ListMonitorsIterable responses = client.listMonitorsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listMonitorsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listMonitorsPaginator
default ListMonitorsIterable listMonitorsPaginator(Consumer<ListMonitorsRequest.Builder> listMonitorsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException 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 Streamsoftware.amazon.awssdk.services.forecast.paginators.ListMonitorsIterable responses = client.listMonitorsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListMonitorsRequest.builder()
- Parameters:
listMonitorsRequest
- AConsumer
that will call methods onListMonitorsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPredictorBacktestExportJobs
default 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.
- Parameters:
listPredictorBacktestExportJobsRequest
-- Returns:
- Result of the ListPredictorBacktestExportJobs operation returned by the service.
- See Also:
-
listPredictorBacktestExportJobs
default 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 viaListPredictorBacktestExportJobsRequest.builder()
- Parameters:
listPredictorBacktestExportJobsRequest
- AConsumer
that will call methods onListPredictorBacktestExportJobsRequest.Builder
to create a request.- Returns:
- Result of the ListPredictorBacktestExportJobs operation returned by the service.
- See Also:
-
listPredictorBacktestExportJobsPaginator
default ListPredictorBacktestExportJobsIterable listPredictorBacktestExportJobsPaginator(ListPredictorBacktestExportJobsRequest listPredictorBacktestExportJobsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException 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 Streamsoftware.amazon.awssdk.services.forecast.paginators.ListPredictorBacktestExportJobsIterable responses = client.listPredictorBacktestExportJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listPredictorBacktestExportJobsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPredictorBacktestExportJobsPaginator
default ListPredictorBacktestExportJobsIterable listPredictorBacktestExportJobsPaginator(Consumer<ListPredictorBacktestExportJobsRequest.Builder> listPredictorBacktestExportJobsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException 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 Streamsoftware.amazon.awssdk.services.forecast.paginators.ListPredictorBacktestExportJobsIterable responses = client.listPredictorBacktestExportJobsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListPredictorBacktestExportJobsRequest.builder()
- Parameters:
listPredictorBacktestExportJobsRequest
- AConsumer
that will call methods onListPredictorBacktestExportJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPredictors
default 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.
- Parameters:
listPredictorsRequest
-- Returns:
- Result of the ListPredictors operation returned by the service.
- See Also:
-
listPredictors
default 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 viaListPredictorsRequest.builder()
- Parameters:
listPredictorsRequest
- AConsumer
that will call methods onListPredictorsRequest.Builder
to create a request.- Returns:
- Result of the ListPredictors operation returned by the service.
- See Also:
-
listPredictorsPaginator
default ListPredictorsIterable listPredictorsPaginator(ListPredictorsRequest listPredictorsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException 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 Streamsoftware.amazon.awssdk.services.forecast.paginators.ListPredictorsIterable responses = client.listPredictorsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listPredictorsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPredictorsPaginator
default ListPredictorsIterable listPredictorsPaginator(Consumer<ListPredictorsRequest.Builder> listPredictorsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException 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 Streamsoftware.amazon.awssdk.services.forecast.paginators.ListPredictorsIterable responses = client.listPredictorsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListPredictorsRequest.builder()
- Parameters:
listPredictorsRequest
- AConsumer
that will call methods onListPredictorsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException Lists the tags for an Amazon Forecast resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default 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 viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listWhatIfAnalyses
default 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.
- Parameters:
listWhatIfAnalysesRequest
-- Returns:
- Result of the ListWhatIfAnalyses operation returned by the service.
- See Also:
-
listWhatIfAnalyses
default 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 viaListWhatIfAnalysesRequest.builder()
- Parameters:
listWhatIfAnalysesRequest
- AConsumer
that will call methods onListWhatIfAnalysesRequest.Builder
to create a request.- Returns:
- Result of the ListWhatIfAnalyses operation returned by the service.
- See Also:
-
listWhatIfAnalysesPaginator
default ListWhatIfAnalysesIterable listWhatIfAnalysesPaginator(ListWhatIfAnalysesRequest listWhatIfAnalysesRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException 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 Streamsoftware.amazon.awssdk.services.forecast.paginators.ListWhatIfAnalysesIterable responses = client.listWhatIfAnalysesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listWhatIfAnalysesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listWhatIfAnalysesPaginator
default ListWhatIfAnalysesIterable listWhatIfAnalysesPaginator(Consumer<ListWhatIfAnalysesRequest.Builder> listWhatIfAnalysesRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException 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 Streamsoftware.amazon.awssdk.services.forecast.paginators.ListWhatIfAnalysesIterable responses = client.listWhatIfAnalysesPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListWhatIfAnalysesRequest.builder()
- Parameters:
listWhatIfAnalysesRequest
- AConsumer
that will call methods onListWhatIfAnalysesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listWhatIfForecastExports
default 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.
- Parameters:
listWhatIfForecastExportsRequest
-- Returns:
- Result of the ListWhatIfForecastExports operation returned by the service.
- See Also:
-
listWhatIfForecastExports
default 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 viaListWhatIfForecastExportsRequest.builder()
- Parameters:
listWhatIfForecastExportsRequest
- AConsumer
that will call methods onListWhatIfForecastExportsRequest.Builder
to create a request.- Returns:
- Result of the ListWhatIfForecastExports operation returned by the service.
- See Also:
-
listWhatIfForecastExportsPaginator
default ListWhatIfForecastExportsIterable listWhatIfForecastExportsPaginator(ListWhatIfForecastExportsRequest listWhatIfForecastExportsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException 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 Streamsoftware.amazon.awssdk.services.forecast.paginators.ListWhatIfForecastExportsIterable responses = client.listWhatIfForecastExportsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listWhatIfForecastExportsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listWhatIfForecastExportsPaginator
default ListWhatIfForecastExportsIterable listWhatIfForecastExportsPaginator(Consumer<ListWhatIfForecastExportsRequest.Builder> listWhatIfForecastExportsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException 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 Streamsoftware.amazon.awssdk.services.forecast.paginators.ListWhatIfForecastExportsIterable responses = client.listWhatIfForecastExportsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListWhatIfForecastExportsRequest.builder()
- Parameters:
listWhatIfForecastExportsRequest
- AConsumer
that will call methods onListWhatIfForecastExportsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listWhatIfForecasts
default 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.
- Parameters:
listWhatIfForecastsRequest
-- Returns:
- Result of the ListWhatIfForecasts operation returned by the service.
- See Also:
-
listWhatIfForecasts
default 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 viaListWhatIfForecastsRequest.builder()
- Parameters:
listWhatIfForecastsRequest
- AConsumer
that will call methods onListWhatIfForecastsRequest.Builder
to create a request.- Returns:
- Result of the ListWhatIfForecasts operation returned by the service.
- See Also:
-
listWhatIfForecastsPaginator
default ListWhatIfForecastsIterable listWhatIfForecastsPaginator(ListWhatIfForecastsRequest listWhatIfForecastsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException 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 Streamsoftware.amazon.awssdk.services.forecast.paginators.ListWhatIfForecastsIterable responses = client.listWhatIfForecastsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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.- Parameters:
listWhatIfForecastsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listWhatIfForecastsPaginator
default ListWhatIfForecastsIterable listWhatIfForecastsPaginator(Consumer<ListWhatIfForecastsRequest.Builder> listWhatIfForecastsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException 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 Streamsoftware.amazon.awssdk.services.forecast.paginators.ListWhatIfForecastsIterable responses = client.listWhatIfForecastsPaginator(request); responses.stream().forEach(....);
{ @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 directlysoftware.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 viaListWhatIfForecastsRequest.builder()
- Parameters:
listWhatIfForecastsRequest
- AConsumer
that will call methods onListWhatIfForecastsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
resumeResource
default ResumeResourceResponse resumeResource(ResumeResourceRequest resumeResourceRequest) throws InvalidInputException, LimitExceededException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException Resumes a stopped monitor resource.
- Parameters:
resumeResourceRequest
-- Returns:
- Result of the ResumeResource operation returned by the service.
- See Also:
-
resumeResource
default 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 viaResumeResourceRequest.builder()
- Parameters:
resumeResourceRequest
- AConsumer
that will call methods onResumeResourceRequest.Builder
to create a request.- Returns:
- Result of the ResumeResource operation returned by the service.
- See Also:
-
stopResource
default StopResourceResponse stopResource(StopResourceRequest stopResourceRequest) throws InvalidInputException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException Stops a resource.
The resource undergoes the following states:
CREATE_STOPPING
andCREATE_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
- Parameters:
stopResourceRequest
-- Returns:
- Result of the StopResource operation returned by the service.
- See Also:
-
-
stopResource
default StopResourceResponse stopResource(Consumer<StopResourceRequest.Builder> stopResourceRequest) throws InvalidInputException, LimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException Stops a resource.
The resource undergoes the following states:
CREATE_STOPPING
andCREATE_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 viaStopResourceRequest.builder()
- Parameters:
stopResourceRequest
- AConsumer
that will call methods onStopResourceRequest.Builder
to create a request.- Returns:
- Result of the StopResource operation returned by the service.
- See Also:
-
-
tagResource
default 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.- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default 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 viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException Deletes the specified tags from a resource.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default 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 viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateDatasetGroup
default 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 beACTIVE
before you can use the dataset group to create a predictor. Use the DescribeDatasetGroup operation to get the status.- Parameters:
updateDatasetGroupRequest
-- Returns:
- Result of the UpdateDatasetGroup operation returned by the service.
- See Also:
-
updateDatasetGroup
default 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 beACTIVE
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 viaUpdateDatasetGroupRequest.builder()
- Parameters:
updateDatasetGroupRequest
- AConsumer
that will call methods onUpdateDatasetGroupRequest.Builder
to create a request.- Returns:
- Result of the UpdateDatasetGroup operation returned by the service.
- See Also:
-
create
Create aForecastClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aForecastClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-