@Generated(value="software.amazon.awssdk:codegen") public interface ForecastClient extends SdkClient
builder() method.
Provides APIs for creating and managing Amazon Forecast resources.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static ForecastClientBuilder |
builder()
Create a builder that can be used to configure and create a
ForecastClient. |
static ForecastClient |
create()
Create a
ForecastClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default 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 CreateForecastResponse |
createForecast(Consumer<CreateForecastRequest.Builder> createForecastRequest)
Creates a forecast for each item in the
TARGET_TIME_SERIES dataset that was used to train the
predictor. |
default CreateForecastResponse |
createForecast(CreateForecastRequest createForecastRequest)
Creates a forecast for each item in the
TARGET_TIME_SERIES dataset that was used to train the
predictor. |
default CreateForecastExportJobResponse |
createForecastExportJob(Consumer<CreateForecastExportJobRequest.Builder> createForecastExportJobRequest)
Exports a forecast created by the CreateForecast operation to your Amazon Simple Storage Service (Amazon
S3) bucket.
|
default CreateForecastExportJobResponse |
createForecastExportJob(CreateForecastExportJobRequest createForecastExportJobRequest)
Exports a forecast created by the CreateForecast operation to your Amazon Simple Storage Service (Amazon
S3) bucket.
|
default CreatePredictorResponse |
createPredictor(Consumer<CreatePredictorRequest.Builder> createPredictorRequest)
Creates an Amazon Forecast predictor.
|
default CreatePredictorResponse |
createPredictor(CreatePredictorRequest createPredictorRequest)
Creates an Amazon Forecast predictor.
|
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 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 DeletePredictorResponse |
deletePredictor(Consumer<DeletePredictorRequest.Builder> deletePredictorRequest)
Deletes a predictor created using the CreatePredictor operation.
|
default DeletePredictorResponse |
deletePredictor(DeletePredictorRequest deletePredictorRequest)
Deletes a predictor created using the CreatePredictor 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 DescribeForecastResponse |
describeForecast(Consumer<DescribeForecastRequest.Builder> describeForecastRequest)
Describes a forecast created using the CreateForecast operation.
|
default DescribeForecastResponse |
describeForecast(DescribeForecastRequest describeForecastRequest)
Describes a forecast created using the CreateForecast operation.
|
default DescribeForecastExportJobResponse |
describeForecastExportJob(Consumer<DescribeForecastExportJobRequest.Builder> describeForecastExportJobRequest)
Describes a forecast export job created using the CreateForecastExportJob operation.
|
default DescribeForecastExportJobResponse |
describeForecastExportJob(DescribeForecastExportJobRequest describeForecastExportJobRequest)
Describes a forecast export job created using the CreateForecastExportJob operation.
|
default DescribePredictorResponse |
describePredictor(Consumer<DescribePredictorRequest.Builder> describePredictorRequest)
Describes a predictor created using the CreatePredictor operation.
|
default DescribePredictorResponse |
describePredictor(DescribePredictorRequest describePredictorRequest)
Describes a predictor created using the CreatePredictor operation.
|
default GetAccuracyMetricsResponse |
getAccuracyMetrics(Consumer<GetAccuracyMetricsRequest.Builder> getAccuracyMetricsRequest)
Provides metrics on the accuracy of the models that were trained by the CreatePredictor operation.
|
default GetAccuracyMetricsResponse |
getAccuracyMetrics(GetAccuracyMetricsRequest getAccuracyMetricsRequest)
Provides metrics on the accuracy of the models that were trained by the CreatePredictor operation.
|
default ListDatasetGroupsResponse |
listDatasetGroups(Consumer<ListDatasetGroupsRequest.Builder> listDatasetGroupsRequest)
Returns a list of dataset groups created using the CreateDatasetGroup operation.
|
default ListDatasetGroupsResponse |
listDatasetGroups(ListDatasetGroupsRequest listDatasetGroupsRequest)
Returns a list of dataset groups created using the CreateDatasetGroup operation.
|
default ListDatasetGroupsIterable |
listDatasetGroupsPaginator(Consumer<ListDatasetGroupsRequest.Builder> listDatasetGroupsRequest)
Returns a list of dataset groups created using the CreateDatasetGroup operation.
|
default ListDatasetGroupsIterable |
listDatasetGroupsPaginator(ListDatasetGroupsRequest listDatasetGroupsRequest)
Returns a list of dataset groups created using the CreateDatasetGroup operation.
|
default ListDatasetImportJobsResponse |
listDatasetImportJobs(Consumer<ListDatasetImportJobsRequest.Builder> listDatasetImportJobsRequest)
Returns a list of dataset import jobs created using the CreateDatasetImportJob operation.
|
default ListDatasetImportJobsResponse |
listDatasetImportJobs(ListDatasetImportJobsRequest listDatasetImportJobsRequest)
Returns a list of dataset import jobs created using the CreateDatasetImportJob operation.
|
default ListDatasetImportJobsIterable |
listDatasetImportJobsPaginator(Consumer<ListDatasetImportJobsRequest.Builder> listDatasetImportJobsRequest)
Returns a list of dataset import jobs created using the CreateDatasetImportJob operation.
|
default ListDatasetImportJobsIterable |
listDatasetImportJobsPaginator(ListDatasetImportJobsRequest listDatasetImportJobsRequest)
Returns a list of dataset import jobs created using the CreateDatasetImportJob operation.
|
default ListDatasetsResponse |
listDatasets(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest)
Returns a list of datasets created using the CreateDataset operation.
|
default ListDatasetsResponse |
listDatasets(ListDatasetsRequest listDatasetsRequest)
Returns a list of datasets created using the CreateDataset operation.
|
default ListDatasetsIterable |
listDatasetsPaginator(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest)
Returns a list of datasets created using the CreateDataset operation.
|
default ListDatasetsIterable |
listDatasetsPaginator(ListDatasetsRequest listDatasetsRequest)
Returns a list of datasets created using the CreateDataset operation.
|
default ListForecastExportJobsResponse |
listForecastExportJobs(Consumer<ListForecastExportJobsRequest.Builder> listForecastExportJobsRequest)
Returns a list of forecast export jobs created using the CreateForecastExportJob operation.
|
default ListForecastExportJobsResponse |
listForecastExportJobs(ListForecastExportJobsRequest listForecastExportJobsRequest)
Returns a list of forecast export jobs created using the CreateForecastExportJob operation.
|
default ListForecastExportJobsIterable |
listForecastExportJobsPaginator(Consumer<ListForecastExportJobsRequest.Builder> listForecastExportJobsRequest)
Returns a list of forecast export jobs created using the CreateForecastExportJob operation.
|
default ListForecastExportJobsIterable |
listForecastExportJobsPaginator(ListForecastExportJobsRequest listForecastExportJobsRequest)
Returns a list of forecast export jobs created using the CreateForecastExportJob operation.
|
default ListForecastsResponse |
listForecasts(Consumer<ListForecastsRequest.Builder> listForecastsRequest)
Returns a list of forecasts created using the CreateForecast operation.
|
default ListForecastsResponse |
listForecasts(ListForecastsRequest listForecastsRequest)
Returns a list of forecasts created using the CreateForecast operation.
|
default ListForecastsIterable |
listForecastsPaginator(Consumer<ListForecastsRequest.Builder> listForecastsRequest)
Returns a list of forecasts created using the CreateForecast operation.
|
default ListForecastsIterable |
listForecastsPaginator(ListForecastsRequest listForecastsRequest)
Returns a list of forecasts created using the CreateForecast operation.
|
default ListPredictorsResponse |
listPredictors(Consumer<ListPredictorsRequest.Builder> listPredictorsRequest)
Returns a list of predictors created using the CreatePredictor operation.
|
default ListPredictorsResponse |
listPredictors(ListPredictorsRequest listPredictorsRequest)
Returns a list of predictors created using the CreatePredictor operation.
|
default ListPredictorsIterable |
listPredictorsPaginator(Consumer<ListPredictorsRequest.Builder> listPredictorsRequest)
Returns a list of predictors created using the CreatePredictor operation.
|
default ListPredictorsIterable |
listPredictorsPaginator(ListPredictorsRequest listPredictorsRequest)
Returns a list of predictors created using the CreatePredictor 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.
|
static ServiceMetadata |
serviceMetadata() |
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Associates the specified tags to a resource with the specified
resourceArn. |
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Associates the specified tags to a resource with the specified
resourceArn. |
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Deletes the specified tags from a resource.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Deletes the specified tags from a resource.
|
default UpdateDatasetGroupResponse |
updateDatasetGroup(Consumer<UpdateDatasetGroupRequest.Builder> updateDatasetGroupRequest)
Replaces the datasets in a dataset group with the specified datasets.
|
default UpdateDatasetGroupResponse |
updateDatasetGroup(UpdateDatasetGroupRequest updateDatasetGroupRequest)
Replaces the datasets in a dataset group with the specified datasets.
|
serviceNameclosestatic final String SERVICE_NAME
static ForecastClient create()
ForecastClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static ForecastClientBuilder builder()
ForecastClient.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 and DatasetType - Each dataset has an associated dataset
domain and a type within the domain. Amazon Forecast provides a list of predefined domains and types within each
domain. For each unique dataset domain and type within the domain, Amazon Forecast requires your data to include
a minimum set of predefined fields.
Schema - A schema specifies the fields in the dataset, including the field name and data
type.
After creating a dataset, you import your training data into it and add the dataset to a dataset group. You use the dataset group to create a predictor. For more information, see howitworks-datasets-groups.
To get a list of all your datasets, use the ListDatasets operation.
For example Forecast datasets, see the Amazon Forecast Sample GitHub repository.
The Status of a dataset must be ACTIVE before you can import training data. Use the
DescribeDataset operation to get the status.
createDatasetRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceAlreadyExistsException - There is already a resource with this name. Try again with a different name.LimitExceededException - The limit on the number of resources per account has been exceeded.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDatasetResponse createDataset(Consumer<CreateDatasetRequest.Builder> createDatasetRequest) throws InvalidInputException, ResourceAlreadyExistsException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
Creates an Amazon Forecast dataset. The information about the dataset that you provide helps Forecast understand how to consume the data for model training. This includes the following:
DataFrequency - How frequently your historical time-series data is collected.
Domain and DatasetType - Each dataset has an associated dataset
domain and a type within the domain. Amazon Forecast provides a list of predefined domains and types within each
domain. For each unique dataset domain and type within the domain, Amazon Forecast requires your data to include
a minimum set of predefined fields.
Schema - A schema specifies the fields in the dataset, including the field name and data
type.
After creating a dataset, you import your training data into it and add the dataset to a dataset group. You use the dataset group to create a predictor. For more information, see howitworks-datasets-groups.
To get a list of all your datasets, use the ListDatasets operation.
For example Forecast datasets, see the Amazon Forecast Sample GitHub repository.
The Status of a dataset must be ACTIVE before you can import training data. Use the
DescribeDataset operation to get the status.
This is a convenience which creates an instance of the CreateDatasetRequest.Builder avoiding the need to
create one manually via CreateDatasetRequest.builder()
createDatasetRequest - A Consumer that will call methods on CreateDatasetRequest.Builder to create a request.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceAlreadyExistsException - There is already a resource with this name. Try again with a different name.LimitExceededException - The limit on the number of resources per account has been exceeded.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDatasetGroupResponse createDatasetGroup(CreateDatasetGroupRequest createDatasetGroupRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
Creates a dataset group, which holds a collection of related datasets. You can add datasets to the dataset group when you create the dataset group, or later by using the UpdateDatasetGroup operation.
After creating a dataset group and adding datasets, you use the dataset group when you create a predictor. For more information, see howitworks-datasets-groups.
To get a list of all your datasets groups, use the ListDatasetGroups operation.
The Status of a dataset group must be ACTIVE before you can create use the dataset
group to create a predictor. To get the status, use the DescribeDatasetGroup operation.
createDatasetGroupRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceAlreadyExistsException - There is already a resource with this name. Try again with a different name.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.LimitExceededException - The limit on the number of resources per account has been exceeded.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDatasetGroupResponse createDatasetGroup(Consumer<CreateDatasetGroupRequest.Builder> createDatasetGroupRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
Creates a dataset group, which holds a collection of related datasets. You can add datasets to the dataset group when you create the dataset group, or later by using the UpdateDatasetGroup operation.
After creating a dataset group and adding datasets, you use the dataset group when you create a predictor. For more information, see howitworks-datasets-groups.
To get a list of all your datasets groups, use the ListDatasetGroups operation.
The Status of a dataset group must be ACTIVE before you can create use the dataset
group to create a predictor. To get the status, use the DescribeDatasetGroup operation.
This is a convenience which creates an instance of the CreateDatasetGroupRequest.Builder avoiding the
need to create one manually via CreateDatasetGroupRequest.builder()
createDatasetGroupRequest - A Consumer that will call methods on CreateDatasetGroupRequest.Builder to create a
request.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceAlreadyExistsException - There is already a resource with this name. Try again with a different name.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.LimitExceededException - The limit on the number of resources per account has been exceeded.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDatasetImportJobResponse createDatasetImportJob(CreateDatasetImportJobRequest createDatasetImportJobRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
Imports your training data to an Amazon Forecast dataset. You provide the location of your training data in an Amazon Simple Storage Service (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset that you want to import the data to.
You must specify a DataSource object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy of your data and processes it in an internal AWS system. For more information, see aws-forecast-iam-roles.
The training data must be in CSV format. The delimiter must be a comma (,).
You can specify the path to a specific CSV file, the S3 bucket, or to a folder in the S3 bucket. For the latter two cases, Amazon Forecast imports all files up to the limit of 10,000 files.
Because dataset imports are not aggregated, your most recent dataset import is the one that is used when training a predictor or generating a forecast. Make sure that your most recent dataset import contains all of the data you want to model off of, and not just the new data collected since the previous import.
To get a list of all your dataset import jobs, filtered by specified criteria, use the ListDatasetImportJobs operation.
createDatasetImportJobRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceAlreadyExistsException - There is already a resource with this name. Try again with a different name.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.LimitExceededException - The limit on the number of resources per account has been exceeded.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDatasetImportJobResponse createDatasetImportJob(Consumer<CreateDatasetImportJobRequest.Builder> createDatasetImportJobRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
Imports your training data to an Amazon Forecast dataset. You provide the location of your training data in an Amazon Simple Storage Service (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset that you want to import the data to.
You must specify a DataSource object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy of your data and processes it in an internal AWS system. For more information, see aws-forecast-iam-roles.
The training data must be in CSV format. The delimiter must be a comma (,).
You can specify the path to a specific CSV file, the S3 bucket, or to a folder in the S3 bucket. For the latter two cases, Amazon Forecast imports all files up to the limit of 10,000 files.
Because dataset imports are not aggregated, your most recent dataset import is the one that is used when training a predictor or generating a forecast. Make sure that your most recent dataset import contains all of the data you want to model off of, and not just the new data collected since the previous import.
To get a list of all your dataset import jobs, filtered by specified criteria, use the ListDatasetImportJobs operation.
This is a convenience which creates an instance of the CreateDatasetImportJobRequest.Builder avoiding the
need to create one manually via CreateDatasetImportJobRequest.builder()
createDatasetImportJobRequest - A Consumer that will call methods on CreateDatasetImportJobRequest.Builder to create a
request.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceAlreadyExistsException - There is already a resource with this name. Try again with a different name.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.LimitExceededException - The limit on the number of resources per account has been exceeded.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateForecastResponse createForecast(CreateForecastRequest createForecastRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
Creates a forecast for each item in the TARGET_TIME_SERIES dataset that was used to train the
predictor. This is known as inference. To retrieve the forecast for a single item at low latency, use the
operation. To export the complete forecast into your Amazon Simple Storage Service (Amazon S3) bucket, use the
CreateForecastExportJob operation.
The range of the forecast is determined by the ForecastHorizon value, which you specify in the
CreatePredictor request. When you query a forecast, you can request a specific date range within the
forecast.
To get a list of all your forecasts, use the ListForecasts operation.
The forecasts generated by Amazon Forecast are in the same time zone as the dataset that was used to create the predictor.
For more information, see howitworks-forecast.
The Status of the forecast must be ACTIVE before you can query or export the forecast.
Use the DescribeForecast operation to get the status.
createForecastRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceAlreadyExistsException - There is already a resource with this name. Try again with a different name.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.LimitExceededException - The limit on the number of resources per account has been exceeded.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateForecastResponse createForecast(Consumer<CreateForecastRequest.Builder> createForecastRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
Creates a forecast for each item in the TARGET_TIME_SERIES dataset that was used to train the
predictor. This is known as inference. To retrieve the forecast for a single item at low latency, use the
operation. To export the complete forecast into your Amazon Simple Storage Service (Amazon S3) bucket, use the
CreateForecastExportJob operation.
The range of the forecast is determined by the ForecastHorizon value, which you specify in the
CreatePredictor request. When you query a forecast, you can request a specific date range within the
forecast.
To get a list of all your forecasts, use the ListForecasts operation.
The forecasts generated by Amazon Forecast are in the same time zone as the dataset that was used to create the predictor.
For more information, see howitworks-forecast.
The Status of the forecast must be ACTIVE before you can query or export the forecast.
Use the DescribeForecast operation to get the status.
This is a convenience which creates an instance of the CreateForecastRequest.Builder avoiding the need to
create one manually via CreateForecastRequest.builder()
createForecastRequest - A Consumer that will call methods on CreateForecastRequest.Builder to create a request.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceAlreadyExistsException - There is already a resource with this name. Try again with a different name.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.LimitExceededException - The limit on the number of resources per account has been exceeded.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateForecastExportJobResponse createForecastExportJob(CreateForecastExportJobRequest createForecastExportJobRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
Exports a forecast created by the CreateForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions:
<ForecastExportJobName>_<ExportTimestamp>_<PartNumber>
where the <ExportTimestamp> component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).
You must specify a DataDestination object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.
For more information, see howitworks-forecast.
To get a list of all your forecast export jobs, use the ListForecastExportJobs operation.
The Status of the forecast export job must be ACTIVE before you can access the forecast
in your Amazon S3 bucket. To get the status, use the DescribeForecastExportJob operation.
createForecastExportJobRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceAlreadyExistsException - There is already a resource with this name. Try again with a different name.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.LimitExceededException - The limit on the number of resources per account has been exceeded.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateForecastExportJobResponse createForecastExportJob(Consumer<CreateForecastExportJobRequest.Builder> createForecastExportJobRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
Exports a forecast created by the CreateForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions:
<ForecastExportJobName>_<ExportTimestamp>_<PartNumber>
where the <ExportTimestamp> component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).
You must specify a DataDestination object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.
For more information, see howitworks-forecast.
To get a list of all your forecast export jobs, use the ListForecastExportJobs operation.
The Status of the forecast export job must be ACTIVE before you can access the forecast
in your Amazon S3 bucket. To get the status, use the DescribeForecastExportJob operation.
This is a convenience which creates an instance of the CreateForecastExportJobRequest.Builder avoiding
the need to create one manually via CreateForecastExportJobRequest.builder()
createForecastExportJobRequest - A Consumer that will call methods on CreateForecastExportJobRequest.Builder to create a
request.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceAlreadyExistsException - There is already a resource with this name. Try again with a different name.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.LimitExceededException - The limit on the number of resources per account has been exceeded.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreatePredictorResponse createPredictor(CreatePredictorRequest createPredictorRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
Creates an Amazon Forecast predictor.
In the request, you provide a dataset group and either specify an algorithm or let Amazon Forecast choose the algorithm for you using AutoML. If you specify an algorithm, you also can override algorithm-specific hyperparameters.
Amazon Forecast uses the chosen algorithm to train a model using the latest version of the datasets in the specified dataset group. The result is called a predictor. You then generate a forecast using the CreateForecast operation.
After training a model, the CreatePredictor operation also evaluates it. To see the evaluation
metrics, use the GetAccuracyMetrics operation. Always review the evaluation metrics before deciding to use
the predictor to generate a forecast.
Optionally, you can specify a featurization configuration to fill and aggregate the data fields in the
TARGET_TIME_SERIES dataset to improve model training. For more information, see
FeaturizationConfig.
For RELATED_TIME_SERIES datasets, CreatePredictor verifies that the DataFrequency
specified when the dataset was created matches the ForecastFrequency. TARGET_TIME_SERIES datasets
don't have this restriction. Amazon Forecast also verifies the delimiter and timestamp format. For more
information, see howitworks-datasets-groups.
AutoML
If you want Amazon Forecast to evaluate each algorithm and choose the one that minimizes the
objective function, set PerformAutoML to true. The
objective function is defined as the mean of the weighted p10, p50, and p90 quantile losses. For
more information, see EvaluationResult.
When AutoML is enabled, the following properties are disallowed:
AlgorithmArn
HPOConfig
PerformHPO
TrainingParameters
To get a list of all of your predictors, use the ListPredictors operation.
Before you can use the predictor to create a forecast, the Status of the predictor must be
ACTIVE, signifying that training has completed. To get the status, use the DescribePredictor
operation.
createPredictorRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceAlreadyExistsException - There is already a resource with this name. Try again with a different name.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.LimitExceededException - The limit on the number of resources per account has been exceeded.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreatePredictorResponse createPredictor(Consumer<CreatePredictorRequest.Builder> createPredictorRequest) throws InvalidInputException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceInUseException, LimitExceededException, AwsServiceException, SdkClientException, ForecastException
Creates an Amazon Forecast predictor.
In the request, you provide a dataset group and either specify an algorithm or let Amazon Forecast choose the algorithm for you using AutoML. If you specify an algorithm, you also can override algorithm-specific hyperparameters.
Amazon Forecast uses the chosen algorithm to train a model using the latest version of the datasets in the specified dataset group. The result is called a predictor. You then generate a forecast using the CreateForecast operation.
After training a model, the CreatePredictor operation also evaluates it. To see the evaluation
metrics, use the GetAccuracyMetrics operation. Always review the evaluation metrics before deciding to use
the predictor to generate a forecast.
Optionally, you can specify a featurization configuration to fill and aggregate the data fields in the
TARGET_TIME_SERIES dataset to improve model training. For more information, see
FeaturizationConfig.
For RELATED_TIME_SERIES datasets, CreatePredictor verifies that the DataFrequency
specified when the dataset was created matches the ForecastFrequency. TARGET_TIME_SERIES datasets
don't have this restriction. Amazon Forecast also verifies the delimiter and timestamp format. For more
information, see howitworks-datasets-groups.
AutoML
If you want Amazon Forecast to evaluate each algorithm and choose the one that minimizes the
objective function, set PerformAutoML to true. The
objective function is defined as the mean of the weighted p10, p50, and p90 quantile losses. For
more information, see EvaluationResult.
When AutoML is enabled, the following properties are disallowed:
AlgorithmArn
HPOConfig
PerformHPO
TrainingParameters
To get a list of all of your predictors, use the ListPredictors operation.
Before you can use the predictor to create a forecast, the Status of the predictor must be
ACTIVE, signifying that training has completed. To get the status, use the DescribePredictor
operation.
This is a convenience which creates an instance of the CreatePredictorRequest.Builder avoiding the need
to create one manually via CreatePredictorRequest.builder()
createPredictorRequest - A Consumer that will call methods on CreatePredictorRequest.Builder to create a request.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceAlreadyExistsException - There is already a resource with this name. Try again with a different name.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.LimitExceededException - The limit on the number of resources per account has been exceeded.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDatasetResponse deleteDataset(DeleteDatasetRequest deleteDatasetRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Deletes an Amazon Forecast dataset that was created using the CreateDataset operation. You can only delete
datasets that have a status of ACTIVE or CREATE_FAILED. To get the status use the
DescribeDataset operation.
Forecast does not automatically update any dataset groups that contain the deleted dataset. In order to update the dataset group, use the operation, omitting the deleted dataset's ARN.
deleteDatasetRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDatasetResponse deleteDataset(Consumer<DeleteDatasetRequest.Builder> deleteDatasetRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Deletes an Amazon Forecast dataset that was created using the CreateDataset operation. You can only delete
datasets that have a status of ACTIVE or CREATE_FAILED. To get the status use the
DescribeDataset operation.
Forecast does not automatically update any dataset groups that contain the deleted dataset. In order to update the dataset group, use the operation, omitting the deleted dataset's ARN.
This is a convenience which creates an instance of the DeleteDatasetRequest.Builder avoiding the need to
create one manually via DeleteDatasetRequest.builder()
deleteDatasetRequest - A Consumer that will call methods on DeleteDatasetRequest.Builder to create a request.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDatasetGroupResponse deleteDatasetGroup(DeleteDatasetGroupRequest deleteDatasetGroupRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Deletes a dataset group created using the CreateDatasetGroup operation. You can only delete dataset groups
that have a status of ACTIVE, CREATE_FAILED, or UPDATE_FAILED. To get the
status, use the DescribeDatasetGroup operation.
This operation deletes only the dataset group, not the datasets in the group.
deleteDatasetGroupRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDatasetGroupResponse deleteDatasetGroup(Consumer<DeleteDatasetGroupRequest.Builder> deleteDatasetGroupRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Deletes a dataset group created using the CreateDatasetGroup operation. You can only delete dataset groups
that have a status of ACTIVE, CREATE_FAILED, or UPDATE_FAILED. To get the
status, use the DescribeDatasetGroup operation.
This operation deletes only the dataset group, not the datasets in the group.
This is a convenience which creates an instance of the DeleteDatasetGroupRequest.Builder avoiding the
need to create one manually via DeleteDatasetGroupRequest.builder()
deleteDatasetGroupRequest - A Consumer that will call methods on DeleteDatasetGroupRequest.Builder to create a
request.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDatasetImportJobResponse deleteDatasetImportJob(DeleteDatasetImportJobRequest deleteDatasetImportJobRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Deletes a dataset import job created using the CreateDatasetImportJob operation. You can delete only
dataset import jobs that have a status of ACTIVE or CREATE_FAILED. To get the status,
use the DescribeDatasetImportJob operation.
deleteDatasetImportJobRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDatasetImportJobResponse deleteDatasetImportJob(Consumer<DeleteDatasetImportJobRequest.Builder> deleteDatasetImportJobRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Deletes a dataset import job created using the CreateDatasetImportJob operation. You can delete only
dataset import jobs that have a status of ACTIVE or CREATE_FAILED. To get the status,
use the DescribeDatasetImportJob operation.
This is a convenience which creates an instance of the DeleteDatasetImportJobRequest.Builder avoiding the
need to create one manually via DeleteDatasetImportJobRequest.builder()
deleteDatasetImportJobRequest - A Consumer that will call methods on DeleteDatasetImportJobRequest.Builder to create a
request.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteForecastResponse deleteForecast(DeleteForecastRequest deleteForecastRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Deletes a forecast created using the CreateForecast operation. You can delete only forecasts that have a
status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeForecast
operation.
You can't delete a forecast while it is being exported. After a forecast is deleted, you can no longer query the forecast.
deleteForecastRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteForecastResponse deleteForecast(Consumer<DeleteForecastRequest.Builder> deleteForecastRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Deletes a forecast created using the CreateForecast operation. You can delete only forecasts that have a
status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeForecast
operation.
You can't delete a forecast while it is being exported. After a forecast is deleted, you can no longer query the forecast.
This is a convenience which creates an instance of the DeleteForecastRequest.Builder avoiding the need to
create one manually via DeleteForecastRequest.builder()
deleteForecastRequest - A Consumer that will call methods on DeleteForecastRequest.Builder to create a request.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteForecastExportJobResponse deleteForecastExportJob(DeleteForecastExportJobRequest deleteForecastExportJobRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Deletes a forecast export job created using the CreateForecastExportJob operation. You can delete only
export jobs that have a status of ACTIVE or CREATE_FAILED. To get the status, use the
DescribeForecastExportJob operation.
deleteForecastExportJobRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteForecastExportJobResponse deleteForecastExportJob(Consumer<DeleteForecastExportJobRequest.Builder> deleteForecastExportJobRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Deletes a forecast export job created using the CreateForecastExportJob operation. You can delete only
export jobs that have a status of ACTIVE or CREATE_FAILED. To get the status, use the
DescribeForecastExportJob operation.
This is a convenience which creates an instance of the DeleteForecastExportJobRequest.Builder avoiding
the need to create one manually via DeleteForecastExportJobRequest.builder()
deleteForecastExportJobRequest - A Consumer that will call methods on DeleteForecastExportJobRequest.Builder to create a
request.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeletePredictorResponse deletePredictor(DeletePredictorRequest deletePredictorRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Deletes a predictor created using the CreatePredictor operation. You can delete only predictor that have a
status of ACTIVE or CREATE_FAILED. To get the status, use the DescribePredictor
operation.
deletePredictorRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeletePredictorResponse deletePredictor(Consumer<DeletePredictorRequest.Builder> deletePredictorRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Deletes a predictor created using the CreatePredictor operation. You can delete only predictor that have a
status of ACTIVE or CREATE_FAILED. To get the status, use the DescribePredictor
operation.
This is a convenience which creates an instance of the DeletePredictorRequest.Builder avoiding the need
to create one manually via DeletePredictorRequest.builder()
deletePredictorRequest - A Consumer that will call methods on DeletePredictorRequest.Builder to create a request.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDatasetResponse describeDataset(DescribeDatasetRequest describeDatasetRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
Describes an Amazon Forecast dataset created using the CreateDataset operation.
In addition to listing the parameters specified in the CreateDataset request, this operation
includes the following dataset properties:
CreationTime
LastModificationTime
Status
describeDatasetRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDatasetResponse describeDataset(Consumer<DescribeDatasetRequest.Builder> describeDatasetRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
Describes an Amazon Forecast dataset created using the CreateDataset operation.
In addition to listing the parameters specified in the CreateDataset request, this operation
includes the following dataset properties:
CreationTime
LastModificationTime
Status
This is a convenience which creates an instance of the DescribeDatasetRequest.Builder avoiding the need
to create one manually via DescribeDatasetRequest.builder()
describeDatasetRequest - A Consumer that will call methods on DescribeDatasetRequest.Builder to create a request.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDatasetGroupResponse describeDatasetGroup(DescribeDatasetGroupRequest describeDatasetGroupRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
Describes a dataset group created using the CreateDatasetGroup operation.
In addition to listing the parameters provided in the CreateDatasetGroup request, this operation
includes the following properties:
DatasetArns - The datasets belonging to the group.
CreationTime
LastModificationTime
Status
describeDatasetGroupRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDatasetGroupResponse describeDatasetGroup(Consumer<DescribeDatasetGroupRequest.Builder> describeDatasetGroupRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
Describes a dataset group created using the CreateDatasetGroup operation.
In addition to listing the parameters provided in the CreateDatasetGroup request, this operation
includes the following properties:
DatasetArns - The datasets belonging to the group.
CreationTime
LastModificationTime
Status
This is a convenience which creates an instance of the DescribeDatasetGroupRequest.Builder avoiding the
need to create one manually via DescribeDatasetGroupRequest.builder()
describeDatasetGroupRequest - A Consumer that will call methods on DescribeDatasetGroupRequest.Builder to create a
request.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDatasetImportJobResponse describeDatasetImportJob(DescribeDatasetImportJobRequest describeDatasetImportJobRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
Describes a dataset import job created using the CreateDatasetImportJob operation.
In addition to listing the parameters provided in the CreateDatasetImportJob request, this operation
includes the following properties:
CreationTime
LastModificationTime
DataSize
FieldStatistics
Status
Message - If an error occurred, information about the error.
describeDatasetImportJobRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDatasetImportJobResponse describeDatasetImportJob(Consumer<DescribeDatasetImportJobRequest.Builder> describeDatasetImportJobRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
Describes a dataset import job created using the CreateDatasetImportJob operation.
In addition to listing the parameters provided in the CreateDatasetImportJob request, this operation
includes the following properties:
CreationTime
LastModificationTime
DataSize
FieldStatistics
Status
Message - If an error occurred, information about the error.
This is a convenience which creates an instance of the DescribeDatasetImportJobRequest.Builder avoiding
the need to create one manually via DescribeDatasetImportJobRequest.builder()
describeDatasetImportJobRequest - A Consumer that will call methods on DescribeDatasetImportJobRequest.Builder to create a
request.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeForecastResponse describeForecast(DescribeForecastRequest describeForecastRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
Describes a forecast created using the CreateForecast operation.
In addition to listing the properties provided in the CreateForecast request, this operation lists
the following properties:
DatasetGroupArn - The dataset group that provided the training data.
CreationTime
LastModificationTime
Status
Message - If an error occurred, information about the error.
describeForecastRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeForecastResponse describeForecast(Consumer<DescribeForecastRequest.Builder> describeForecastRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
Describes a forecast created using the CreateForecast operation.
In addition to listing the properties provided in the CreateForecast request, this operation lists
the following properties:
DatasetGroupArn - The dataset group that provided the training data.
CreationTime
LastModificationTime
Status
Message - If an error occurred, information about the error.
This is a convenience which creates an instance of the DescribeForecastRequest.Builder avoiding the need
to create one manually via DescribeForecastRequest.builder()
describeForecastRequest - A Consumer that will call methods on DescribeForecastRequest.Builder to create a request.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeForecastExportJobResponse describeForecastExportJob(DescribeForecastExportJobRequest describeForecastExportJobRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
Describes a forecast export job created using the CreateForecastExportJob operation.
In addition to listing the properties provided by the user in the CreateForecastExportJob request,
this operation lists the following properties:
CreationTime
LastModificationTime
Status
Message - If an error occurred, information about the error.
describeForecastExportJobRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeForecastExportJobResponse describeForecastExportJob(Consumer<DescribeForecastExportJobRequest.Builder> describeForecastExportJobRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
Describes a forecast export job created using the CreateForecastExportJob operation.
In addition to listing the properties provided by the user in the CreateForecastExportJob request,
this operation lists the following properties:
CreationTime
LastModificationTime
Status
Message - If an error occurred, information about the error.
This is a convenience which creates an instance of the DescribeForecastExportJobRequest.Builder avoiding
the need to create one manually via DescribeForecastExportJobRequest.builder()
describeForecastExportJobRequest - A Consumer that will call methods on DescribeForecastExportJobRequest.Builder to create a
request.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribePredictorResponse describePredictor(DescribePredictorRequest describePredictorRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
Describes a predictor created using the CreatePredictor operation.
In addition to listing the properties provided in the CreatePredictor request, this operation lists
the following properties:
DatasetImportJobArns - The dataset import jobs used to import training data.
AutoMLAlgorithmArns - If AutoML is performed, the algorithms that were evaluated.
CreationTime
LastModificationTime
Status
Message - If an error occurred, information about the error.
describePredictorRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribePredictorResponse describePredictor(Consumer<DescribePredictorRequest.Builder> describePredictorRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, ForecastException
Describes a predictor created using the CreatePredictor operation.
In addition to listing the properties provided in the CreatePredictor request, this operation lists
the following properties:
DatasetImportJobArns - The dataset import jobs used to import training data.
AutoMLAlgorithmArns - If AutoML is performed, the algorithms that were evaluated.
CreationTime
LastModificationTime
Status
Message - If an error occurred, information about the error.
This is a convenience which creates an instance of the DescribePredictorRequest.Builder avoiding the need
to create one manually via DescribePredictorRequest.builder()
describePredictorRequest - A Consumer that will call methods on DescribePredictorRequest.Builder to create a request.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 metrics.
This operation generates metrics for each backtest window that was evaluated. The number of backtest windows (
NumberOfBacktestWindows) is specified using the EvaluationParameters object, which is
optionally included in the CreatePredictor request. If NumberOfBacktestWindows isn't
specified, the number defaults to one.
The parameters of the filling method determine which items contribute to the metrics. If you want
all items to contribute, specify zero. If you want only those items that have complete data in the
range being evaluated to contribute, specify nan. For more information, see
FeaturizationMethod.
Before you can get accuracy metrics, the Status of the predictor must be ACTIVE,
signifying that training has completed. To get the status, use the DescribePredictor operation.
getAccuracyMetricsRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAccuracyMetricsResponse getAccuracyMetrics(Consumer<GetAccuracyMetricsRequest.Builder> getAccuracyMetricsRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Provides metrics on the accuracy of the models that were trained by the CreatePredictor operation. Use metrics to see how well the model performed and to decide whether to use the predictor to generate a forecast. For more information, see metrics.
This operation generates metrics for each backtest window that was evaluated. The number of backtest windows (
NumberOfBacktestWindows) is specified using the EvaluationParameters object, which is
optionally included in the CreatePredictor request. If NumberOfBacktestWindows isn't
specified, the number defaults to one.
The parameters of the filling method determine which items contribute to the metrics. If you want
all items to contribute, specify zero. If you want only those items that have complete data in the
range being evaluated to contribute, specify nan. For more information, see
FeaturizationMethod.
Before you can get accuracy metrics, the Status of the predictor must be ACTIVE,
signifying that training has completed. To get the status, use the DescribePredictor operation.
This is a convenience which creates an instance of the GetAccuracyMetricsRequest.Builder avoiding the
need to create one manually via GetAccuracyMetricsRequest.builder()
getAccuracyMetricsRequest - A Consumer that will call methods on GetAccuracyMetricsRequest.Builder to create a
request.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetGroupsResponse listDatasetGroups(ListDatasetGroupsRequest listDatasetGroupsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, ForecastException
Returns a list of dataset groups created using the CreateDatasetGroup operation. For each dataset group, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the dataset group ARN with the DescribeDatasetGroup operation.
listDatasetGroupsRequest - InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetGroupsResponse listDatasetGroups(Consumer<ListDatasetGroupsRequest.Builder> listDatasetGroupsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, ForecastException
Returns a list of dataset groups created using the CreateDatasetGroup operation. For each dataset group, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the dataset group ARN with the DescribeDatasetGroup operation.
This is a convenience which creates an instance of the ListDatasetGroupsRequest.Builder avoiding the need
to create one manually via ListDatasetGroupsRequest.builder()
listDatasetGroupsRequest - A Consumer that will call methods on ListDatasetGroupsRequest.Builder to create a request.InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetGroupsIterable listDatasetGroupsPaginator(ListDatasetGroupsRequest listDatasetGroupsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, ForecastException
Returns a list of dataset groups created using the CreateDatasetGroup operation. For each dataset group, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the dataset group ARN with the DescribeDatasetGroup operation.
This is a variant of
listDatasetGroups(software.amazon.awssdk.services.forecast.model.ListDatasetGroupsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListDatasetGroupsIterable responses = client.listDatasetGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListDatasetGroupsIterable responses = client
.listDatasetGroupsPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListDatasetGroupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListDatasetGroupsIterable responses = client.listDatasetGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasetGroups(software.amazon.awssdk.services.forecast.model.ListDatasetGroupsRequest)
operation.
listDatasetGroupsRequest - InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetGroupsIterable listDatasetGroupsPaginator(Consumer<ListDatasetGroupsRequest.Builder> listDatasetGroupsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, ForecastException
Returns a list of dataset groups created using the CreateDatasetGroup operation. For each dataset group, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the dataset group ARN with the DescribeDatasetGroup operation.
This is a variant of
listDatasetGroups(software.amazon.awssdk.services.forecast.model.ListDatasetGroupsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListDatasetGroupsIterable responses = client.listDatasetGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListDatasetGroupsIterable responses = client
.listDatasetGroupsPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListDatasetGroupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListDatasetGroupsIterable responses = client.listDatasetGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasetGroups(software.amazon.awssdk.services.forecast.model.ListDatasetGroupsRequest)
operation.
This is a convenience which creates an instance of the ListDatasetGroupsRequest.Builder avoiding the need
to create one manually via ListDatasetGroupsRequest.builder()
listDatasetGroupsRequest - A Consumer that will call methods on ListDatasetGroupsRequest.Builder to create a request.InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetImportJobsResponse listDatasetImportJobs(ListDatasetImportJobsRequest listDatasetImportJobsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of dataset import jobs created using the CreateDatasetImportJob operation. For each import job, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the ARN with the DescribeDatasetImportJob operation. You can filter the list by providing an array of Filter objects.
listDatasetImportJobsRequest - InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetImportJobsResponse listDatasetImportJobs(Consumer<ListDatasetImportJobsRequest.Builder> listDatasetImportJobsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of dataset import jobs created using the CreateDatasetImportJob operation. For each import job, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the ARN with the DescribeDatasetImportJob operation. You can filter the list by providing an array of Filter objects.
This is a convenience which creates an instance of the ListDatasetImportJobsRequest.Builder avoiding the
need to create one manually via ListDatasetImportJobsRequest.builder()
listDatasetImportJobsRequest - A Consumer that will call methods on ListDatasetImportJobsRequest.Builder to create a
request.InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetImportJobsIterable listDatasetImportJobsPaginator(ListDatasetImportJobsRequest listDatasetImportJobsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of dataset import jobs created using the CreateDatasetImportJob operation. For each import job, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the ARN with the DescribeDatasetImportJob operation. You can filter the list by providing an array of Filter objects.
This is a variant of
listDatasetImportJobs(software.amazon.awssdk.services.forecast.model.ListDatasetImportJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListDatasetImportJobsIterable responses = client.listDatasetImportJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListDatasetImportJobsIterable responses = client
.listDatasetImportJobsPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListDatasetImportJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListDatasetImportJobsIterable responses = client.listDatasetImportJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasetImportJobs(software.amazon.awssdk.services.forecast.model.ListDatasetImportJobsRequest)
operation.
listDatasetImportJobsRequest - InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetImportJobsIterable listDatasetImportJobsPaginator(Consumer<ListDatasetImportJobsRequest.Builder> listDatasetImportJobsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of dataset import jobs created using the CreateDatasetImportJob operation. For each import job, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the ARN with the DescribeDatasetImportJob operation. You can filter the list by providing an array of Filter objects.
This is a variant of
listDatasetImportJobs(software.amazon.awssdk.services.forecast.model.ListDatasetImportJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListDatasetImportJobsIterable responses = client.listDatasetImportJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListDatasetImportJobsIterable responses = client
.listDatasetImportJobsPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListDatasetImportJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListDatasetImportJobsIterable responses = client.listDatasetImportJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasetImportJobs(software.amazon.awssdk.services.forecast.model.ListDatasetImportJobsRequest)
operation.
This is a convenience which creates an instance of the ListDatasetImportJobsRequest.Builder avoiding the
need to create one manually via ListDatasetImportJobsRequest.builder()
listDatasetImportJobsRequest - A Consumer that will call methods on ListDatasetImportJobsRequest.Builder to create a
request.InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetsResponse listDatasets(ListDatasetsRequest listDatasetsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, ForecastException
Returns a list of datasets created using the CreateDataset operation. For each dataset, a summary of its properties, including its Amazon Resource Name (ARN), is returned. To retrieve the complete set of properties, use the ARN with the DescribeDataset operation.
listDatasetsRequest - InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetsResponse listDatasets(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, ForecastException
Returns a list of datasets created using the CreateDataset operation. For each dataset, a summary of its properties, including its Amazon Resource Name (ARN), is returned. To retrieve the complete set of properties, use the ARN with the DescribeDataset operation.
This is a convenience which creates an instance of the ListDatasetsRequest.Builder avoiding the need to
create one manually via ListDatasetsRequest.builder()
listDatasetsRequest - A Consumer that will call methods on ListDatasetsRequest.Builder to create a request.InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetsIterable listDatasetsPaginator(ListDatasetsRequest listDatasetsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, ForecastException
Returns a list of datasets created using the CreateDataset operation. For each dataset, a summary of its properties, including its Amazon Resource Name (ARN), is returned. To retrieve the complete set of properties, use the ARN with the DescribeDataset operation.
This is a variant of listDatasets(software.amazon.awssdk.services.forecast.model.ListDatasetsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListDatasetsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasets(software.amazon.awssdk.services.forecast.model.ListDatasetsRequest) operation.
listDatasetsRequest - InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDatasetsIterable listDatasetsPaginator(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, ForecastException
Returns a list of datasets created using the CreateDataset operation. For each dataset, a summary of its properties, including its Amazon Resource Name (ARN), is returned. To retrieve the complete set of properties, use the ARN with the DescribeDataset operation.
This is a variant of listDatasets(software.amazon.awssdk.services.forecast.model.ListDatasetsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListDatasetsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasets(software.amazon.awssdk.services.forecast.model.ListDatasetsRequest) operation.
This is a convenience which creates an instance of the ListDatasetsRequest.Builder avoiding the need to
create one manually via ListDatasetsRequest.builder()
listDatasetsRequest - A Consumer that will call methods on ListDatasetsRequest.Builder to create a request.InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListForecastExportJobsResponse listForecastExportJobs(ListForecastExportJobsRequest listForecastExportJobsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of forecast export jobs created using the CreateForecastExportJob operation. For each forecast export job, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, use the ARN with the DescribeForecastExportJob operation. You can filter the list using an array of Filter objects.
listForecastExportJobsRequest - InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListForecastExportJobsResponse listForecastExportJobs(Consumer<ListForecastExportJobsRequest.Builder> listForecastExportJobsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of forecast export jobs created using the CreateForecastExportJob operation. For each forecast export job, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, use the ARN with the DescribeForecastExportJob operation. You can filter the list using an array of Filter objects.
This is a convenience which creates an instance of the ListForecastExportJobsRequest.Builder avoiding the
need to create one manually via ListForecastExportJobsRequest.builder()
listForecastExportJobsRequest - A Consumer that will call methods on ListForecastExportJobsRequest.Builder to create a
request.InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListForecastExportJobsIterable listForecastExportJobsPaginator(ListForecastExportJobsRequest listForecastExportJobsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of forecast export jobs created using the CreateForecastExportJob operation. For each forecast export job, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, use the ARN with the DescribeForecastExportJob operation. You can filter the list using an array of Filter objects.
This is a variant of
listForecastExportJobs(software.amazon.awssdk.services.forecast.model.ListForecastExportJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListForecastExportJobsIterable responses = client.listForecastExportJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListForecastExportJobsIterable responses = client
.listForecastExportJobsPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListForecastExportJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListForecastExportJobsIterable responses = client.listForecastExportJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listForecastExportJobs(software.amazon.awssdk.services.forecast.model.ListForecastExportJobsRequest)
operation.
listForecastExportJobsRequest - InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListForecastExportJobsIterable listForecastExportJobsPaginator(Consumer<ListForecastExportJobsRequest.Builder> listForecastExportJobsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of forecast export jobs created using the CreateForecastExportJob operation. For each forecast export job, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, use the ARN with the DescribeForecastExportJob operation. You can filter the list using an array of Filter objects.
This is a variant of
listForecastExportJobs(software.amazon.awssdk.services.forecast.model.ListForecastExportJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListForecastExportJobsIterable responses = client.listForecastExportJobsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListForecastExportJobsIterable responses = client
.listForecastExportJobsPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListForecastExportJobsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListForecastExportJobsIterable responses = client.listForecastExportJobsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listForecastExportJobs(software.amazon.awssdk.services.forecast.model.ListForecastExportJobsRequest)
operation.
This is a convenience which creates an instance of the ListForecastExportJobsRequest.Builder avoiding the
need to create one manually via ListForecastExportJobsRequest.builder()
listForecastExportJobsRequest - A Consumer that will call methods on ListForecastExportJobsRequest.Builder to create a
request.InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListForecastsResponse listForecasts(ListForecastsRequest listForecastsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of forecasts created using the CreateForecast operation. For each forecast, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, specify the ARN with the DescribeForecast operation. You can filter the list using an array of Filter objects.
listForecastsRequest - InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListForecastsResponse listForecasts(Consumer<ListForecastsRequest.Builder> listForecastsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of forecasts created using the CreateForecast operation. For each forecast, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, specify the ARN with the DescribeForecast operation. You can filter the list using an array of Filter objects.
This is a convenience which creates an instance of the ListForecastsRequest.Builder avoiding the need to
create one manually via ListForecastsRequest.builder()
listForecastsRequest - A Consumer that will call methods on ListForecastsRequest.Builder to create a request.InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListForecastsIterable listForecastsPaginator(ListForecastsRequest listForecastsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of forecasts created using the CreateForecast operation. For each forecast, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, specify the ARN with the DescribeForecast operation. You can filter the list using an array of Filter objects.
This is a variant of listForecasts(software.amazon.awssdk.services.forecast.model.ListForecastsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListForecastsIterable responses = client.listForecastsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListForecastsIterable responses = client.listForecastsPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListForecastsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListForecastsIterable responses = client.listForecastsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listForecasts(software.amazon.awssdk.services.forecast.model.ListForecastsRequest) operation.
listForecastsRequest - InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListForecastsIterable listForecastsPaginator(Consumer<ListForecastsRequest.Builder> listForecastsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of forecasts created using the CreateForecast operation. For each forecast, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, specify the ARN with the DescribeForecast operation. You can filter the list using an array of Filter objects.
This is a variant of listForecasts(software.amazon.awssdk.services.forecast.model.ListForecastsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListForecastsIterable responses = client.listForecastsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListForecastsIterable responses = client.listForecastsPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListForecastsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListForecastsIterable responses = client.listForecastsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listForecasts(software.amazon.awssdk.services.forecast.model.ListForecastsRequest) operation.
This is a convenience which creates an instance of the ListForecastsRequest.Builder avoiding the need to
create one manually via ListForecastsRequest.builder()
listForecastsRequest - A Consumer that will call methods on ListForecastsRequest.Builder to create a request.InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPredictorsResponse listPredictors(ListPredictorsRequest listPredictorsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of predictors created using the CreatePredictor operation. For each predictor, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the ARN with the DescribePredictor operation. You can filter the list using an array of Filter objects.
listPredictorsRequest - InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPredictorsResponse listPredictors(Consumer<ListPredictorsRequest.Builder> listPredictorsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of predictors created using the CreatePredictor operation. For each predictor, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the ARN with the DescribePredictor operation. You can filter the list using an array of Filter objects.
This is a convenience which creates an instance of the ListPredictorsRequest.Builder avoiding the need to
create one manually via ListPredictorsRequest.builder()
listPredictorsRequest - A Consumer that will call methods on ListPredictorsRequest.Builder to create a request.InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPredictorsIterable listPredictorsPaginator(ListPredictorsRequest listPredictorsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of predictors created using the CreatePredictor operation. For each predictor, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the ARN with the DescribePredictor operation. You can filter the list using an array of Filter objects.
This is a variant of
listPredictors(software.amazon.awssdk.services.forecast.model.ListPredictorsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListPredictorsIterable responses = client.listPredictorsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListPredictorsIterable responses = client
.listPredictorsPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListPredictorsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListPredictorsIterable responses = client.listPredictorsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPredictors(software.amazon.awssdk.services.forecast.model.ListPredictorsRequest) operation.
listPredictorsRequest - InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPredictorsIterable listPredictorsPaginator(Consumer<ListPredictorsRequest.Builder> listPredictorsRequest) throws InvalidNextTokenException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Returns a list of predictors created using the CreatePredictor operation. For each predictor, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the ARN with the DescribePredictor operation. You can filter the list using an array of Filter objects.
This is a variant of
listPredictors(software.amazon.awssdk.services.forecast.model.ListPredictorsRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.forecast.paginators.ListPredictorsIterable responses = client.listPredictorsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.forecast.paginators.ListPredictorsIterable responses = client
.listPredictorsPaginator(request);
for (software.amazon.awssdk.services.forecast.model.ListPredictorsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.forecast.paginators.ListPredictorsIterable responses = client.listPredictorsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPredictors(software.amazon.awssdk.services.forecast.model.ListPredictorsRequest) operation.
This is a convenience which creates an instance of the ListPredictorsRequest.Builder avoiding the need to
create one manually via ListPredictorsRequest.builder()
listPredictorsRequest - A Consumer that will call methods on ListPredictorsRequest.Builder to create a request.InvalidNextTokenException - The token is not valid. Tokens expire after 24 hours.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Lists the tags for an Amazon Forecast resource.
listTagsForResourceRequest - ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ResourceNotFoundException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Lists the tags for an Amazon Forecast resource.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ResourceNotFoundException, LimitExceededException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Associates the specified tags to a resource with the specified resourceArn. If existing tags on a
resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags
associated with that resource are also deleted.
tagResourceRequest - ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.LimitExceededException - The limit on the number of resources per account has been exceeded.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ResourceNotFoundException, LimitExceededException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Associates the specified tags to a resource with the specified resourceArn. If existing tags on a
resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags
associated with that resource are also deleted.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.LimitExceededException - The limit on the number of resources per account has been exceeded.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Deletes the specified tags from a resource.
untagResourceRequest - ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ResourceNotFoundException, InvalidInputException, AwsServiceException, SdkClientException, ForecastException
Deletes the specified tags from a resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateDatasetGroupResponse updateDatasetGroup(UpdateDatasetGroupRequest updateDatasetGroupRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Replaces the datasets in a dataset group with the specified datasets.
The Status of the dataset group must be ACTIVE before you can use the dataset group to
create a predictor. Use the DescribeDatasetGroup operation to get the status.
updateDatasetGroupRequest - InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateDatasetGroupResponse updateDatasetGroup(Consumer<UpdateDatasetGroupRequest.Builder> updateDatasetGroupRequest) throws InvalidInputException, ResourceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ForecastException
Replaces the datasets in a dataset group with the specified datasets.
The Status of the dataset group must be ACTIVE before you can use the dataset group to
create a predictor. Use the DescribeDatasetGroup operation to get the status.
This is a convenience which creates an instance of the UpdateDatasetGroupRequest.Builder avoiding the
need to create one manually via UpdateDatasetGroupRequest.builder()
updateDatasetGroupRequest - A Consumer that will call methods on UpdateDatasetGroupRequest.Builder to create a
request.InvalidInputException - We can't process the request because it includes an invalid value or a value that exceeds the valid
range.ResourceNotFoundException - We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.ResourceInUseException - The specified resource is in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.ForecastException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2020 Amazon Web Services, Inc. All Rights Reserved.