software.amazon.awssdk.services.forecast.ForecastAsyncClient Maven / Gradle / Ivy
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.forecast;
import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.core.SdkClient;
import software.amazon.awssdk.services.forecast.model.CreateAutoPredictorRequest;
import software.amazon.awssdk.services.forecast.model.CreateAutoPredictorResponse;
import software.amazon.awssdk.services.forecast.model.CreateDatasetGroupRequest;
import software.amazon.awssdk.services.forecast.model.CreateDatasetGroupResponse;
import software.amazon.awssdk.services.forecast.model.CreateDatasetImportJobRequest;
import software.amazon.awssdk.services.forecast.model.CreateDatasetImportJobResponse;
import software.amazon.awssdk.services.forecast.model.CreateDatasetRequest;
import software.amazon.awssdk.services.forecast.model.CreateDatasetResponse;
import software.amazon.awssdk.services.forecast.model.CreateExplainabilityExportRequest;
import software.amazon.awssdk.services.forecast.model.CreateExplainabilityExportResponse;
import software.amazon.awssdk.services.forecast.model.CreateExplainabilityRequest;
import software.amazon.awssdk.services.forecast.model.CreateExplainabilityResponse;
import software.amazon.awssdk.services.forecast.model.CreateForecastExportJobRequest;
import software.amazon.awssdk.services.forecast.model.CreateForecastExportJobResponse;
import software.amazon.awssdk.services.forecast.model.CreateForecastRequest;
import software.amazon.awssdk.services.forecast.model.CreateForecastResponse;
import software.amazon.awssdk.services.forecast.model.CreatePredictorBacktestExportJobRequest;
import software.amazon.awssdk.services.forecast.model.CreatePredictorBacktestExportJobResponse;
import software.amazon.awssdk.services.forecast.model.CreatePredictorRequest;
import software.amazon.awssdk.services.forecast.model.CreatePredictorResponse;
import software.amazon.awssdk.services.forecast.model.DeleteDatasetGroupRequest;
import software.amazon.awssdk.services.forecast.model.DeleteDatasetGroupResponse;
import software.amazon.awssdk.services.forecast.model.DeleteDatasetImportJobRequest;
import software.amazon.awssdk.services.forecast.model.DeleteDatasetImportJobResponse;
import software.amazon.awssdk.services.forecast.model.DeleteDatasetRequest;
import software.amazon.awssdk.services.forecast.model.DeleteDatasetResponse;
import software.amazon.awssdk.services.forecast.model.DeleteExplainabilityExportRequest;
import software.amazon.awssdk.services.forecast.model.DeleteExplainabilityExportResponse;
import software.amazon.awssdk.services.forecast.model.DeleteExplainabilityRequest;
import software.amazon.awssdk.services.forecast.model.DeleteExplainabilityResponse;
import software.amazon.awssdk.services.forecast.model.DeleteForecastExportJobRequest;
import software.amazon.awssdk.services.forecast.model.DeleteForecastExportJobResponse;
import software.amazon.awssdk.services.forecast.model.DeleteForecastRequest;
import software.amazon.awssdk.services.forecast.model.DeleteForecastResponse;
import software.amazon.awssdk.services.forecast.model.DeletePredictorBacktestExportJobRequest;
import software.amazon.awssdk.services.forecast.model.DeletePredictorBacktestExportJobResponse;
import software.amazon.awssdk.services.forecast.model.DeletePredictorRequest;
import software.amazon.awssdk.services.forecast.model.DeletePredictorResponse;
import software.amazon.awssdk.services.forecast.model.DeleteResourceTreeRequest;
import software.amazon.awssdk.services.forecast.model.DeleteResourceTreeResponse;
import software.amazon.awssdk.services.forecast.model.DescribeAutoPredictorRequest;
import software.amazon.awssdk.services.forecast.model.DescribeAutoPredictorResponse;
import software.amazon.awssdk.services.forecast.model.DescribeDatasetGroupRequest;
import software.amazon.awssdk.services.forecast.model.DescribeDatasetGroupResponse;
import software.amazon.awssdk.services.forecast.model.DescribeDatasetImportJobRequest;
import software.amazon.awssdk.services.forecast.model.DescribeDatasetImportJobResponse;
import software.amazon.awssdk.services.forecast.model.DescribeDatasetRequest;
import software.amazon.awssdk.services.forecast.model.DescribeDatasetResponse;
import software.amazon.awssdk.services.forecast.model.DescribeExplainabilityExportRequest;
import software.amazon.awssdk.services.forecast.model.DescribeExplainabilityExportResponse;
import software.amazon.awssdk.services.forecast.model.DescribeExplainabilityRequest;
import software.amazon.awssdk.services.forecast.model.DescribeExplainabilityResponse;
import software.amazon.awssdk.services.forecast.model.DescribeForecastExportJobRequest;
import software.amazon.awssdk.services.forecast.model.DescribeForecastExportJobResponse;
import software.amazon.awssdk.services.forecast.model.DescribeForecastRequest;
import software.amazon.awssdk.services.forecast.model.DescribeForecastResponse;
import software.amazon.awssdk.services.forecast.model.DescribePredictorBacktestExportJobRequest;
import software.amazon.awssdk.services.forecast.model.DescribePredictorBacktestExportJobResponse;
import software.amazon.awssdk.services.forecast.model.DescribePredictorRequest;
import software.amazon.awssdk.services.forecast.model.DescribePredictorResponse;
import software.amazon.awssdk.services.forecast.model.GetAccuracyMetricsRequest;
import software.amazon.awssdk.services.forecast.model.GetAccuracyMetricsResponse;
import software.amazon.awssdk.services.forecast.model.ListDatasetGroupsRequest;
import software.amazon.awssdk.services.forecast.model.ListDatasetGroupsResponse;
import software.amazon.awssdk.services.forecast.model.ListDatasetImportJobsRequest;
import software.amazon.awssdk.services.forecast.model.ListDatasetImportJobsResponse;
import software.amazon.awssdk.services.forecast.model.ListDatasetsRequest;
import software.amazon.awssdk.services.forecast.model.ListDatasetsResponse;
import software.amazon.awssdk.services.forecast.model.ListExplainabilitiesRequest;
import software.amazon.awssdk.services.forecast.model.ListExplainabilitiesResponse;
import software.amazon.awssdk.services.forecast.model.ListExplainabilityExportsRequest;
import software.amazon.awssdk.services.forecast.model.ListExplainabilityExportsResponse;
import software.amazon.awssdk.services.forecast.model.ListForecastExportJobsRequest;
import software.amazon.awssdk.services.forecast.model.ListForecastExportJobsResponse;
import software.amazon.awssdk.services.forecast.model.ListForecastsRequest;
import software.amazon.awssdk.services.forecast.model.ListForecastsResponse;
import software.amazon.awssdk.services.forecast.model.ListPredictorBacktestExportJobsRequest;
import software.amazon.awssdk.services.forecast.model.ListPredictorBacktestExportJobsResponse;
import software.amazon.awssdk.services.forecast.model.ListPredictorsRequest;
import software.amazon.awssdk.services.forecast.model.ListPredictorsResponse;
import software.amazon.awssdk.services.forecast.model.ListTagsForResourceRequest;
import software.amazon.awssdk.services.forecast.model.ListTagsForResourceResponse;
import software.amazon.awssdk.services.forecast.model.StopResourceRequest;
import software.amazon.awssdk.services.forecast.model.StopResourceResponse;
import software.amazon.awssdk.services.forecast.model.TagResourceRequest;
import software.amazon.awssdk.services.forecast.model.TagResourceResponse;
import software.amazon.awssdk.services.forecast.model.UntagResourceRequest;
import software.amazon.awssdk.services.forecast.model.UntagResourceResponse;
import software.amazon.awssdk.services.forecast.model.UpdateDatasetGroupRequest;
import software.amazon.awssdk.services.forecast.model.UpdateDatasetGroupResponse;
import software.amazon.awssdk.services.forecast.paginators.ListDatasetGroupsPublisher;
import software.amazon.awssdk.services.forecast.paginators.ListDatasetImportJobsPublisher;
import software.amazon.awssdk.services.forecast.paginators.ListDatasetsPublisher;
import software.amazon.awssdk.services.forecast.paginators.ListForecastExportJobsPublisher;
import software.amazon.awssdk.services.forecast.paginators.ListForecastsPublisher;
import software.amazon.awssdk.services.forecast.paginators.ListPredictorBacktestExportJobsPublisher;
import software.amazon.awssdk.services.forecast.paginators.ListPredictorsPublisher;
/**
* Service client for accessing Amazon Forecast Service asynchronously. This can be created using the static
* {@link #builder()} method.
*
*
* Provides APIs for creating and managing Amazon Forecast resources.
*
*/
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface ForecastAsyncClient extends SdkClient {
String SERVICE_NAME = "forecast";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "forecast";
/**
* Create a {@link ForecastAsyncClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static ForecastAsyncClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link ForecastAsyncClient}.
*/
static ForecastAsyncClientBuilder builder() {
return new DefaultForecastAsyncClientBuilder();
}
/**
*
* Creates an Amazon Forecast predictor.
*
*
* Amazon Forecast creates predictors with AutoPredictor, which involves applying the optimal combination of
* algorithms to each time series in your datasets. You can use CreateAutoPredictor to create new predictors
* or upgrade/retrain existing predictors.
*
*
* Creating new predictors
*
*
* The following parameters are required when creating a new predictor:
*
*
* -
*
* PredictorName - A unique name for the predictor.
*
*
* -
*
* DatasetGroupArn - The ARN of the dataset group used to train the predictor.
*
*
* -
*
* ForecastFrequency - The granularity of your forecasts (hourly, daily, weekly, etc).
*
*
* -
*
* ForecastHorizon - The number of time steps being forecasted.
*
*
*
*
* When creating a new predictor, do not specify a value for ReferencePredictorArn.
*
*
* Upgrading and retraining predictors
*
*
* The following parameters are required when retraining or upgrading a predictor:
*
*
* -
*
* PredictorName - A unique name for the predictor.
*
*
* -
*
* ReferencePredictorArn - The ARN of the predictor to retrain or upgrade.
*
*
*
*
* When upgrading or retraining a predictor, only specify values for the ReferencePredictorArn and
* PredictorName.
*
*
* @param createAutoPredictorRequest
* @return A Java Future containing the result of the CreateAutoPredictor operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.CreateAutoPredictor
* @see AWS
* API Documentation
*/
default CompletableFuture createAutoPredictor(
CreateAutoPredictorRequest createAutoPredictorRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates an Amazon Forecast predictor.
*
*
* Amazon Forecast creates predictors with AutoPredictor, which involves applying the optimal combination of
* algorithms to each time series in your datasets. You can use CreateAutoPredictor to create new predictors
* or upgrade/retrain existing predictors.
*
*
* Creating new predictors
*
*
* The following parameters are required when creating a new predictor:
*
*
* -
*
* PredictorName - A unique name for the predictor.
*
*
* -
*
* DatasetGroupArn - The ARN of the dataset group used to train the predictor.
*
*
* -
*
* ForecastFrequency - The granularity of your forecasts (hourly, daily, weekly, etc).
*
*
* -
*
* ForecastHorizon - The number of time steps being forecasted.
*
*
*
*
* When creating a new predictor, do not specify a value for ReferencePredictorArn.
*
*
* Upgrading and retraining predictors
*
*
* The following parameters are required when retraining or upgrading a predictor:
*
*
* -
*
* PredictorName - A unique name for the predictor.
*
*
* -
*
* ReferencePredictorArn - The ARN of the predictor to retrain or upgrade.
*
*
*
*
* When upgrading or retraining a predictor, only specify values for the ReferencePredictorArn and
* PredictorName.
*
*
*
* This is a convenience which creates an instance of the {@link CreateAutoPredictorRequest.Builder} avoiding the
* need to create one manually via {@link CreateAutoPredictorRequest#builder()}
*
*
* @param createAutoPredictorRequest
* A {@link Consumer} that will call methods on {@link CreateAutoPredictorRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CreateAutoPredictor operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.CreateAutoPredictor
* @see AWS
* API Documentation
*/
default CompletableFuture createAutoPredictor(
Consumer createAutoPredictorRequest) {
return createAutoPredictor(CreateAutoPredictorRequest.builder().applyMutation(createAutoPredictorRequest).build());
}
/**
*
* 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.
*
*
*
* @param createDatasetRequest
* @return A Java Future containing the result of the CreateDataset operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.CreateDataset
* @see AWS API
* Documentation
*/
default CompletableFuture createDataset(CreateDatasetRequest createDatasetRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateDatasetRequest.Builder} avoiding the need to
* create one manually via {@link CreateDatasetRequest#builder()}
*
*
* @param createDatasetRequest
* A {@link Consumer} that will call methods on {@link CreateDatasetRequest.Builder} to create a request.
* @return A Java Future containing the result of the CreateDataset operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.CreateDataset
* @see AWS API
* Documentation
*/
default CompletableFuture createDataset(Consumer createDatasetRequest) {
return createDataset(CreateDatasetRequest.builder().applyMutation(createDatasetRequest).build());
}
/**
*
* Creates a dataset group, which holds a collection of related datasets. You can add datasets to the dataset group
* when you create the dataset group, or later by using the UpdateDatasetGroup operation.
*
*
* After creating a dataset group and adding datasets, you use the dataset group when you create a predictor. For
* more information, see howitworks-datasets-groups.
*
*
* To get a list of all your datasets groups, use the ListDatasetGroups operation.
*
*
*
* The Status of a dataset group must be ACTIVE before you can use the dataset group to
* create a predictor. To get the status, use the DescribeDatasetGroup operation.
*
*
*
* @param createDatasetGroupRequest
* @return A Java Future containing the result of the CreateDatasetGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.CreateDatasetGroup
* @see AWS
* API Documentation
*/
default CompletableFuture createDatasetGroup(CreateDatasetGroupRequest createDatasetGroupRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a dataset group, which holds a collection of related datasets. You can add datasets to the dataset group
* when you create the dataset group, or later by using the UpdateDatasetGroup operation.
*
*
* After creating a dataset group and adding datasets, you use the dataset group when you create a predictor. For
* more information, see howitworks-datasets-groups.
*
*
* To get a list of all your datasets groups, use the ListDatasetGroups operation.
*
*
*
* The Status of a dataset group must be ACTIVE before you can use the dataset group to
* create a predictor. To get the status, use the DescribeDatasetGroup operation.
*
*
*
* This is a convenience which creates an instance of the {@link CreateDatasetGroupRequest.Builder} avoiding the
* need to create one manually via {@link CreateDatasetGroupRequest#builder()}
*
*
* @param createDatasetGroupRequest
* A {@link Consumer} that will call methods on {@link CreateDatasetGroupRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CreateDatasetGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.CreateDatasetGroup
* @see AWS
* API Documentation
*/
default CompletableFuture createDatasetGroup(
Consumer createDatasetGroupRequest) {
return createDatasetGroup(CreateDatasetGroupRequest.builder().applyMutation(createDatasetGroupRequest).build());
}
/**
*
* 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.
*
*
* @param createDatasetImportJobRequest
* @return A Java Future containing the result of the CreateDatasetImportJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.CreateDatasetImportJob
* @see AWS API Documentation
*/
default CompletableFuture createDatasetImportJob(
CreateDatasetImportJobRequest createDatasetImportJobRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateDatasetImportJobRequest.Builder} avoiding the
* need to create one manually via {@link CreateDatasetImportJobRequest#builder()}
*
*
* @param createDatasetImportJobRequest
* A {@link Consumer} that will call methods on {@link CreateDatasetImportJobRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CreateDatasetImportJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.CreateDatasetImportJob
* @see AWS API Documentation
*/
default CompletableFuture createDatasetImportJob(
Consumer createDatasetImportJobRequest) {
return createDatasetImportJob(CreateDatasetImportJobRequest.builder().applyMutation(createDatasetImportJobRequest)
.build());
}
/**
*
*
* Explainability is only available for Forecasts and Predictors generated from an AutoPredictor
* (CreateAutoPredictor)
*
*
*
* Creates an Amazon Forecast Explainability.
*
*
* Explainability helps you better understand how the attributes in your datasets impact forecast. Amazon Forecast
* uses a metric called Impact scores to quantify the relative impact of each attribute and determine whether they
* increase or decrease forecast values.
*
*
* To enable Forecast Explainability, your predictor must include at least one of the following: related time
* series, item metadata, or additional datasets like Holidays and the Weather Index.
*
*
* CreateExplainability accepts either a Predictor ARN or Forecast ARN. To receive aggregated Impact scores for all
* time series and time points in your datasets, provide a Predictor ARN. To receive Impact scores for specific time
* series and time points, provide a Forecast ARN.
*
*
* CreateExplainability with a Predictor ARN
*
*
*
* You can only have one Explainability resource per predictor. If you already enabled ExplainPredictor
* in CreateAutoPredictor, that predictor already has an Explainability resource.
*
*
*
* The following parameters are required when providing a Predictor ARN:
*
*
* -
*
* ExplainabilityName - A unique name for the Explainability.
*
*
* -
*
* ResourceArn - The Arn of the predictor.
*
*
* -
*
* TimePointGranularity - Must be set to “ALL”.
*
*
* -
*
* TimeSeriesGranularity - Must be set to “ALL”.
*
*
*
*
* Do not specify a value for the following parameters:
*
*
* -
*
* DataSource - Only valid when TimeSeriesGranularity is “SPECIFIC”.
*
*
* -
*
* Schema - Only valid when TimeSeriesGranularity is “SPECIFIC”.
*
*
* -
*
* StartDateTime - Only valid when TimePointGranularity is “SPECIFIC”.
*
*
* -
*
* EndDateTime - Only valid when TimePointGranularity is “SPECIFIC”.
*
*
*
*
* CreateExplainability with a Forecast ARN
*
*
*
* You can specify a maximum of 50 time series and 500 time points.
*
*
*
* The following parameters are required when providing a Predictor ARN:
*
*
* -
*
* ExplainabilityName - A unique name for the Explainability.
*
*
* -
*
* ResourceArn - The Arn of the forecast.
*
*
* -
*
* TimePointGranularity - Either “ALL” or “SPECIFIC”.
*
*
* -
*
* TimeSeriesGranularity - Either “ALL” or “SPECIFIC”.
*
*
*
*
* If you set TimeSeriesGranularity to “SPECIFIC”, you must also provide the following:
*
*
* -
*
* DataSource - The S3 location of the CSV file specifying your time series.
*
*
* -
*
* Schema - The Schema defines the attributes and attribute types listed in the Data Source.
*
*
*
*
* If you set TimePointGranularity to “SPECIFIC”, you must also provide the following:
*
*
* -
*
* StartDateTime - The first timestamp in the range of time points.
*
*
* -
*
* EndDateTime - The last timestamp in the range of time points.
*
*
*
*
* @param createExplainabilityRequest
* @return A Java Future containing the result of the CreateExplainability operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.CreateExplainability
* @see AWS
* API Documentation
*/
default CompletableFuture createExplainability(
CreateExplainabilityRequest createExplainabilityRequest) {
throw new UnsupportedOperationException();
}
/**
*
*
* Explainability is only available for Forecasts and Predictors generated from an AutoPredictor
* (CreateAutoPredictor)
*
*
*
* Creates an Amazon Forecast Explainability.
*
*
* Explainability helps you better understand how the attributes in your datasets impact forecast. Amazon Forecast
* uses a metric called Impact scores to quantify the relative impact of each attribute and determine whether they
* increase or decrease forecast values.
*
*
* To enable Forecast Explainability, your predictor must include at least one of the following: related time
* series, item metadata, or additional datasets like Holidays and the Weather Index.
*
*
* CreateExplainability accepts either a Predictor ARN or Forecast ARN. To receive aggregated Impact scores for all
* time series and time points in your datasets, provide a Predictor ARN. To receive Impact scores for specific time
* series and time points, provide a Forecast ARN.
*
*
* CreateExplainability with a Predictor ARN
*
*
*
* You can only have one Explainability resource per predictor. If you already enabled ExplainPredictor
* in CreateAutoPredictor, that predictor already has an Explainability resource.
*
*
*
* The following parameters are required when providing a Predictor ARN:
*
*
* -
*
* ExplainabilityName - A unique name for the Explainability.
*
*
* -
*
* ResourceArn - The Arn of the predictor.
*
*
* -
*
* TimePointGranularity - Must be set to “ALL”.
*
*
* -
*
* TimeSeriesGranularity - Must be set to “ALL”.
*
*
*
*
* Do not specify a value for the following parameters:
*
*
* -
*
* DataSource - Only valid when TimeSeriesGranularity is “SPECIFIC”.
*
*
* -
*
* Schema - Only valid when TimeSeriesGranularity is “SPECIFIC”.
*
*
* -
*
* StartDateTime - Only valid when TimePointGranularity is “SPECIFIC”.
*
*
* -
*
* EndDateTime - Only valid when TimePointGranularity is “SPECIFIC”.
*
*
*
*
* CreateExplainability with a Forecast ARN
*
*
*
* You can specify a maximum of 50 time series and 500 time points.
*
*
*
* The following parameters are required when providing a Predictor ARN:
*
*
* -
*
* ExplainabilityName - A unique name for the Explainability.
*
*
* -
*
* ResourceArn - The Arn of the forecast.
*
*
* -
*
* TimePointGranularity - Either “ALL” or “SPECIFIC”.
*
*
* -
*
* TimeSeriesGranularity - Either “ALL” or “SPECIFIC”.
*
*
*
*
* If you set TimeSeriesGranularity to “SPECIFIC”, you must also provide the following:
*
*
* -
*
* DataSource - The S3 location of the CSV file specifying your time series.
*
*
* -
*
* Schema - The Schema defines the attributes and attribute types listed in the Data Source.
*
*
*
*
* If you set TimePointGranularity to “SPECIFIC”, you must also provide the following:
*
*
* -
*
* StartDateTime - The first timestamp in the range of time points.
*
*
* -
*
* EndDateTime - The last timestamp in the range of time points.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link CreateExplainabilityRequest.Builder} avoiding the
* need to create one manually via {@link CreateExplainabilityRequest#builder()}
*
*
* @param createExplainabilityRequest
* A {@link Consumer} that will call methods on {@link CreateExplainabilityRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CreateExplainability operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.CreateExplainability
* @see AWS
* API Documentation
*/
default CompletableFuture createExplainability(
Consumer createExplainabilityRequest) {
return createExplainability(CreateExplainabilityRequest.builder().applyMutation(createExplainabilityRequest).build());
}
/**
*
* Exports an Explainability resource created by the CreateExplainability operation. Exported files are
* exported to an Amazon Simple Storage Service (Amazon S3) bucket.
*
*
* You must specify a DataDestination object that includes an Amazon S3 bucket and an AWS Identity and Access
* Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see
* aws-forecast-iam-roles.
*
*
*
* The Status of the export job must be ACTIVE before you can access the export in your
* Amazon S3 bucket. To get the status, use the DescribeExplainabilityExport operation.
*
*
*
* @param createExplainabilityExportRequest
* @return A Java Future containing the result of the CreateExplainabilityExport operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.CreateExplainabilityExport
* @see AWS API Documentation
*/
default CompletableFuture createExplainabilityExport(
CreateExplainabilityExportRequest createExplainabilityExportRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Exports an Explainability resource created by the CreateExplainability operation. Exported files are
* exported to an Amazon Simple Storage Service (Amazon S3) bucket.
*
*
* You must specify a DataDestination object that includes an Amazon S3 bucket and an AWS Identity and Access
* Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see
* aws-forecast-iam-roles.
*
*
*
* The Status of the export job must be ACTIVE before you can access the export in your
* Amazon S3 bucket. To get the status, use the DescribeExplainabilityExport operation.
*
*
*
* This is a convenience which creates an instance of the {@link CreateExplainabilityExportRequest.Builder} avoiding
* the need to create one manually via {@link CreateExplainabilityExportRequest#builder()}
*
*
* @param createExplainabilityExportRequest
* A {@link Consumer} that will call methods on {@link CreateExplainabilityExportRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CreateExplainabilityExport operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.CreateExplainabilityExport
* @see AWS API Documentation
*/
default CompletableFuture createExplainabilityExport(
Consumer createExplainabilityExportRequest) {
return createExplainabilityExport(CreateExplainabilityExportRequest.builder()
.applyMutation(createExplainabilityExportRequest).build());
}
/**
*
* 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.
*
*
*
* @param createForecastRequest
* @return A Java Future containing the result of the CreateForecast operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.CreateForecast
* @see AWS API
* Documentation
*/
default CompletableFuture createForecast(CreateForecastRequest createForecastRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateForecastRequest.Builder} avoiding the need to
* create one manually via {@link CreateForecastRequest#builder()}
*
*
* @param createForecastRequest
* A {@link Consumer} that will call methods on {@link CreateForecastRequest.Builder} to create a request.
* @return A Java Future containing the result of the CreateForecast operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.CreateForecast
* @see AWS API
* Documentation
*/
default CompletableFuture createForecast(Consumer createForecastRequest) {
return createForecast(CreateForecastRequest.builder().applyMutation(createForecastRequest).build());
}
/**
*
* 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.
*
*
*
* @param createForecastExportJobRequest
* @return A Java Future containing the result of the CreateForecastExportJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.CreateForecastExportJob
* @see AWS API Documentation
*/
default CompletableFuture createForecastExportJob(
CreateForecastExportJobRequest createForecastExportJobRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateForecastExportJobRequest.Builder} avoiding
* the need to create one manually via {@link CreateForecastExportJobRequest#builder()}
*
*
* @param createForecastExportJobRequest
* A {@link Consumer} that will call methods on {@link CreateForecastExportJobRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CreateForecastExportJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.CreateForecastExportJob
* @see AWS API Documentation
*/
default CompletableFuture createForecastExportJob(
Consumer createForecastExportJobRequest) {
return createForecastExportJob(CreateForecastExportJobRequest.builder().applyMutation(createForecastExportJobRequest)
.build());
}
/**
*
*
* This operation creates a legacy predictor that does not include all the predictor functionalities provided by
* Amazon Forecast. To create a predictor that is compatible with all aspects of Forecast, use
* CreateAutoPredictor.
*
*
*
* Creates an Amazon Forecast predictor.
*
*
* In the request, provide a dataset group and either specify an algorithm or let Amazon Forecast choose an
* algorithm for you using AutoML. If you specify an algorithm, you also can override algorithm-specific
* hyperparameters.
*
*
* Amazon Forecast uses the algorithm to train a predictor using the latest version of the datasets in the specified
* dataset group. You can then generate a forecast using the CreateForecast operation.
*
*
* To see the evaluation metrics, use the GetAccuracyMetrics operation.
*
*
* You can specify a featurization configuration to fill and aggregate the data fields in the
* TARGET_TIME_SERIES dataset to improve model training. For more information, see
* FeaturizationConfig.
*
*
* For RELATED_TIME_SERIES datasets, CreatePredictor verifies that the DataFrequency
* specified when the dataset was created matches the ForecastFrequency. TARGET_TIME_SERIES datasets
* don't have this restriction. Amazon Forecast also verifies the delimiter and timestamp format. For more
* information, see howitworks-datasets-groups.
*
*
* By default, predictors are trained and evaluated at the 0.1 (P10), 0.5 (P50), and 0.9 (P90) quantiles. You can
* choose custom forecast types to train and evaluate your predictor by setting the ForecastTypes.
*
*
* AutoML
*
*
* If you want Amazon Forecast to evaluate each algorithm and choose the one that minimizes the
* objective function, set PerformAutoML to true. The
* objective function is defined as the mean of the weighted losses over the forecast types. By
* default, these are the p10, p50, and p90 quantile losses. For more information, see EvaluationResult.
*
*
* When AutoML is enabled, the following properties are disallowed:
*
*
* -
*
* AlgorithmArn
*
*
* -
*
* HPOConfig
*
*
* -
*
* PerformHPO
*
*
* -
*
* TrainingParameters
*
*
*
*
* To get a list of all of your predictors, use the ListPredictors operation.
*
*
*
* Before you can use the predictor to create a forecast, the Status of the predictor must be
* ACTIVE, signifying that training has completed. To get the status, use the DescribePredictor
* operation.
*
*
*
* @param createPredictorRequest
* @return A Java Future containing the result of the CreatePredictor operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.CreatePredictor
* @see AWS API
* Documentation
*/
default CompletableFuture createPredictor(CreatePredictorRequest createPredictorRequest) {
throw new UnsupportedOperationException();
}
/**
*
*
* This operation creates a legacy predictor that does not include all the predictor functionalities provided by
* Amazon Forecast. To create a predictor that is compatible with all aspects of Forecast, use
* CreateAutoPredictor.
*
*
*
* Creates an Amazon Forecast predictor.
*
*
* In the request, provide a dataset group and either specify an algorithm or let Amazon Forecast choose an
* algorithm for you using AutoML. If you specify an algorithm, you also can override algorithm-specific
* hyperparameters.
*
*
* Amazon Forecast uses the algorithm to train a predictor using the latest version of the datasets in the specified
* dataset group. You can then generate a forecast using the CreateForecast operation.
*
*
* To see the evaluation metrics, use the GetAccuracyMetrics operation.
*
*
* You can specify a featurization configuration to fill and aggregate the data fields in the
* TARGET_TIME_SERIES dataset to improve model training. For more information, see
* FeaturizationConfig.
*
*
* For RELATED_TIME_SERIES datasets, CreatePredictor verifies that the DataFrequency
* specified when the dataset was created matches the ForecastFrequency. TARGET_TIME_SERIES datasets
* don't have this restriction. Amazon Forecast also verifies the delimiter and timestamp format. For more
* information, see howitworks-datasets-groups.
*
*
* By default, predictors are trained and evaluated at the 0.1 (P10), 0.5 (P50), and 0.9 (P90) quantiles. You can
* choose custom forecast types to train and evaluate your predictor by setting the ForecastTypes.
*
*
* AutoML
*
*
* If you want Amazon Forecast to evaluate each algorithm and choose the one that minimizes the
* objective function, set PerformAutoML to true. The
* objective function is defined as the mean of the weighted losses over the forecast types. By
* default, these are the p10, p50, and p90 quantile losses. For more information, see EvaluationResult.
*
*
* When AutoML is enabled, the following properties are disallowed:
*
*
* -
*
* AlgorithmArn
*
*
* -
*
* HPOConfig
*
*
* -
*
* PerformHPO
*
*
* -
*
* TrainingParameters
*
*
*
*
* To get a list of all of your predictors, use the ListPredictors operation.
*
*
*
* Before you can use the predictor to create a forecast, the Status of the predictor must be
* ACTIVE, signifying that training has completed. To get the status, use the DescribePredictor
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link CreatePredictorRequest.Builder} avoiding the need
* to create one manually via {@link CreatePredictorRequest#builder()}
*
*
* @param createPredictorRequest
* A {@link Consumer} that will call methods on {@link CreatePredictorRequest.Builder} to create a request.
* @return A Java Future containing the result of the CreatePredictor operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.CreatePredictor
* @see AWS API
* Documentation
*/
default CompletableFuture createPredictor(
Consumer createPredictorRequest) {
return createPredictor(CreatePredictorRequest.builder().applyMutation(createPredictorRequest).build());
}
/**
*
* Exports backtest forecasts and accuracy metrics generated by the CreateAutoPredictor or
* CreatePredictor operations. Two folders containing CSV files are exported to your specified S3 bucket.
*
*
* The export file names will match the following conventions:
*
*
* <ExportJobName>_<ExportTimestamp>_<PartNumber>.csv
*
*
* The <ExportTimestamp> component is in Java SimpleDate format (yyyy-MM-ddTHH-mm-ssZ).
*
*
* You must specify a DataDestination object that includes an Amazon S3 bucket and an AWS Identity and Access
* Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see
* aws-forecast-iam-roles.
*
*
*
* The Status of the export job must be ACTIVE before you can access the export in your
* Amazon S3 bucket. To get the status, use the DescribePredictorBacktestExportJob operation.
*
*
*
* @param createPredictorBacktestExportJobRequest
* @return A Java Future containing the result of the CreatePredictorBacktestExportJob operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.CreatePredictorBacktestExportJob
* @see AWS API Documentation
*/
default CompletableFuture createPredictorBacktestExportJob(
CreatePredictorBacktestExportJobRequest createPredictorBacktestExportJobRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Exports backtest forecasts and accuracy metrics generated by the CreateAutoPredictor or
* CreatePredictor operations. Two folders containing CSV files are exported to your specified S3 bucket.
*
*
* The export file names will match the following conventions:
*
*
* <ExportJobName>_<ExportTimestamp>_<PartNumber>.csv
*
*
* The <ExportTimestamp> component is in Java SimpleDate format (yyyy-MM-ddTHH-mm-ssZ).
*
*
* You must specify a DataDestination object that includes an Amazon S3 bucket and an AWS Identity and Access
* Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see
* aws-forecast-iam-roles.
*
*
*
* The Status of the export job must be ACTIVE before you can access the export in your
* Amazon S3 bucket. To get the status, use the DescribePredictorBacktestExportJob operation.
*
*
*
* This is a convenience which creates an instance of the {@link CreatePredictorBacktestExportJobRequest.Builder}
* avoiding the need to create one manually via {@link CreatePredictorBacktestExportJobRequest#builder()}
*
*
* @param createPredictorBacktestExportJobRequest
* A {@link Consumer} that will call methods on {@link CreatePredictorBacktestExportJobRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the CreatePredictorBacktestExportJob operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.CreatePredictorBacktestExportJob
* @see AWS API Documentation
*/
default CompletableFuture createPredictorBacktestExportJob(
Consumer createPredictorBacktestExportJobRequest) {
return createPredictorBacktestExportJob(CreatePredictorBacktestExportJobRequest.builder()
.applyMutation(createPredictorBacktestExportJobRequest).build());
}
/**
*
* 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.
*
*
*
* @param deleteDatasetRequest
* @return A Java Future containing the result of the DeleteDataset operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DeleteDataset
* @see AWS API
* Documentation
*/
default CompletableFuture deleteDataset(DeleteDatasetRequest deleteDatasetRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteDatasetRequest.Builder} avoiding the need to
* create one manually via {@link DeleteDatasetRequest#builder()}
*
*
* @param deleteDatasetRequest
* A {@link Consumer} that will call methods on {@link DeleteDatasetRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeleteDataset operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DeleteDataset
* @see AWS API
* Documentation
*/
default CompletableFuture deleteDataset(Consumer deleteDatasetRequest) {
return deleteDataset(DeleteDatasetRequest.builder().applyMutation(deleteDatasetRequest).build());
}
/**
*
* 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.
*
*
* @param deleteDatasetGroupRequest
* @return A Java Future containing the result of the DeleteDatasetGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DeleteDatasetGroup
* @see AWS
* API Documentation
*/
default CompletableFuture deleteDatasetGroup(DeleteDatasetGroupRequest deleteDatasetGroupRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteDatasetGroupRequest.Builder} avoiding the
* need to create one manually via {@link DeleteDatasetGroupRequest#builder()}
*
*
* @param deleteDatasetGroupRequest
* A {@link Consumer} that will call methods on {@link DeleteDatasetGroupRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteDatasetGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DeleteDatasetGroup
* @see AWS
* API Documentation
*/
default CompletableFuture deleteDatasetGroup(
Consumer deleteDatasetGroupRequest) {
return deleteDatasetGroup(DeleteDatasetGroupRequest.builder().applyMutation(deleteDatasetGroupRequest).build());
}
/**
*
* 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.
*
*
* @param deleteDatasetImportJobRequest
* @return A Java Future containing the result of the DeleteDatasetImportJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DeleteDatasetImportJob
* @see AWS API Documentation
*/
default CompletableFuture deleteDatasetImportJob(
DeleteDatasetImportJobRequest deleteDatasetImportJobRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteDatasetImportJobRequest.Builder} avoiding the
* need to create one manually via {@link DeleteDatasetImportJobRequest#builder()}
*
*
* @param deleteDatasetImportJobRequest
* A {@link Consumer} that will call methods on {@link DeleteDatasetImportJobRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteDatasetImportJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DeleteDatasetImportJob
* @see AWS API Documentation
*/
default CompletableFuture deleteDatasetImportJob(
Consumer deleteDatasetImportJobRequest) {
return deleteDatasetImportJob(DeleteDatasetImportJobRequest.builder().applyMutation(deleteDatasetImportJobRequest)
.build());
}
/**
*
* Deletes an Explainability resource.
*
*
* You can delete only predictor that have a status of ACTIVE or CREATE_FAILED. To get the
* status, use the DescribeExplainability operation.
*
*
* @param deleteExplainabilityRequest
* @return A Java Future containing the result of the DeleteExplainability operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DeleteExplainability
* @see AWS
* API Documentation
*/
default CompletableFuture deleteExplainability(
DeleteExplainabilityRequest deleteExplainabilityRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an Explainability resource.
*
*
* You can delete only predictor that have a status of ACTIVE or CREATE_FAILED. To get the
* status, use the DescribeExplainability operation.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteExplainabilityRequest.Builder} avoiding the
* need to create one manually via {@link DeleteExplainabilityRequest#builder()}
*
*
* @param deleteExplainabilityRequest
* A {@link Consumer} that will call methods on {@link DeleteExplainabilityRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteExplainability operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DeleteExplainability
* @see AWS
* API Documentation
*/
default CompletableFuture deleteExplainability(
Consumer deleteExplainabilityRequest) {
return deleteExplainability(DeleteExplainabilityRequest.builder().applyMutation(deleteExplainabilityRequest).build());
}
/**
*
* Deletes an Explainability export.
*
*
* @param deleteExplainabilityExportRequest
* @return A Java Future containing the result of the DeleteExplainabilityExport operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DeleteExplainabilityExport
* @see AWS API Documentation
*/
default CompletableFuture deleteExplainabilityExport(
DeleteExplainabilityExportRequest deleteExplainabilityExportRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an Explainability export.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteExplainabilityExportRequest.Builder} avoiding
* the need to create one manually via {@link DeleteExplainabilityExportRequest#builder()}
*
*
* @param deleteExplainabilityExportRequest
* A {@link Consumer} that will call methods on {@link DeleteExplainabilityExportRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteExplainabilityExport operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DeleteExplainabilityExport
* @see AWS API Documentation
*/
default CompletableFuture deleteExplainabilityExport(
Consumer deleteExplainabilityExportRequest) {
return deleteExplainabilityExport(DeleteExplainabilityExportRequest.builder()
.applyMutation(deleteExplainabilityExportRequest).build());
}
/**
*
* 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.
*
*
* @param deleteForecastRequest
* @return A Java Future containing the result of the DeleteForecast operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DeleteForecast
* @see AWS API
* Documentation
*/
default CompletableFuture deleteForecast(DeleteForecastRequest deleteForecastRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteForecastRequest.Builder} avoiding the need to
* create one manually via {@link DeleteForecastRequest#builder()}
*
*
* @param deleteForecastRequest
* A {@link Consumer} that will call methods on {@link DeleteForecastRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeleteForecast operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DeleteForecast
* @see AWS API
* Documentation
*/
default CompletableFuture deleteForecast(Consumer deleteForecastRequest) {
return deleteForecast(DeleteForecastRequest.builder().applyMutation(deleteForecastRequest).build());
}
/**
*
* 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.
*
*
* @param deleteForecastExportJobRequest
* @return A Java Future containing the result of the DeleteForecastExportJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DeleteForecastExportJob
* @see AWS API Documentation
*/
default CompletableFuture deleteForecastExportJob(
DeleteForecastExportJobRequest deleteForecastExportJobRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteForecastExportJobRequest.Builder} avoiding
* the need to create one manually via {@link DeleteForecastExportJobRequest#builder()}
*
*
* @param deleteForecastExportJobRequest
* A {@link Consumer} that will call methods on {@link DeleteForecastExportJobRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteForecastExportJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DeleteForecastExportJob
* @see AWS API Documentation
*/
default CompletableFuture deleteForecastExportJob(
Consumer deleteForecastExportJobRequest) {
return deleteForecastExportJob(DeleteForecastExportJobRequest.builder().applyMutation(deleteForecastExportJobRequest)
.build());
}
/**
*
* Deletes a predictor created using the DescribePredictor or CreatePredictor operations. You can
* delete only predictor that have a status of ACTIVE or CREATE_FAILED. To get the status,
* use the DescribePredictor operation.
*
*
* @param deletePredictorRequest
* @return A Java Future containing the result of the DeletePredictor operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DeletePredictor
* @see AWS API
* Documentation
*/
default CompletableFuture deletePredictor(DeletePredictorRequest deletePredictorRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a predictor created using the DescribePredictor or CreatePredictor operations. You can
* delete only predictor that have a status of ACTIVE or CREATE_FAILED. To get the status,
* use the DescribePredictor operation.
*
*
*
* This is a convenience which creates an instance of the {@link DeletePredictorRequest.Builder} avoiding the need
* to create one manually via {@link DeletePredictorRequest#builder()}
*
*
* @param deletePredictorRequest
* A {@link Consumer} that will call methods on {@link DeletePredictorRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeletePredictor operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DeletePredictor
* @see AWS API
* Documentation
*/
default CompletableFuture deletePredictor(
Consumer deletePredictorRequest) {
return deletePredictor(DeletePredictorRequest.builder().applyMutation(deletePredictorRequest).build());
}
/**
*
* Deletes a predictor backtest export job.
*
*
* @param deletePredictorBacktestExportJobRequest
* @return A Java Future containing the result of the DeletePredictorBacktestExportJob operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DeletePredictorBacktestExportJob
* @see AWS API Documentation
*/
default CompletableFuture deletePredictorBacktestExportJob(
DeletePredictorBacktestExportJobRequest deletePredictorBacktestExportJobRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a predictor backtest export job.
*
*
*
* This is a convenience which creates an instance of the {@link DeletePredictorBacktestExportJobRequest.Builder}
* avoiding the need to create one manually via {@link DeletePredictorBacktestExportJobRequest#builder()}
*
*
* @param deletePredictorBacktestExportJobRequest
* A {@link Consumer} that will call methods on {@link DeletePredictorBacktestExportJobRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the DeletePredictorBacktestExportJob operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DeletePredictorBacktestExportJob
* @see AWS API Documentation
*/
default CompletableFuture deletePredictorBacktestExportJob(
Consumer deletePredictorBacktestExportJobRequest) {
return deletePredictorBacktestExportJob(DeletePredictorBacktestExportJobRequest.builder()
.applyMutation(deletePredictorBacktestExportJobRequest).build());
}
/**
*
* Deletes an entire resource tree. This operation will delete the parent resource and its child resources.
*
*
* Child resources are resources that were created from another resource. For example, when a forecast is generated
* from a predictor, the forecast is the child resource and the predictor is the parent resource.
*
*
* Amazon Forecast resources possess the following parent-child resource hierarchies:
*
*
* -
*
* Dataset: dataset import jobs
*
*
* -
*
* Dataset Group: predictors, predictor backtest export jobs, forecasts, forecast export jobs
*
*
* -
*
* Predictor: predictor backtest export jobs, forecasts, forecast export jobs
*
*
* -
*
* Forecast: forecast export jobs
*
*
*
*
*
* DeleteResourceTree will only delete Amazon Forecast resources, and will not delete datasets or
* exported files stored in Amazon S3.
*
*
*
* @param deleteResourceTreeRequest
* @return A Java Future containing the result of the DeleteResourceTree operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DeleteResourceTree
* @see AWS
* API Documentation
*/
default CompletableFuture deleteResourceTree(DeleteResourceTreeRequest deleteResourceTreeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an entire resource tree. This operation will delete the parent resource and its child resources.
*
*
* Child resources are resources that were created from another resource. For example, when a forecast is generated
* from a predictor, the forecast is the child resource and the predictor is the parent resource.
*
*
* Amazon Forecast resources possess the following parent-child resource hierarchies:
*
*
* -
*
* Dataset: dataset import jobs
*
*
* -
*
* Dataset Group: predictors, predictor backtest export jobs, forecasts, forecast export jobs
*
*
* -
*
* Predictor: predictor backtest export jobs, forecasts, forecast export jobs
*
*
* -
*
* Forecast: forecast export jobs
*
*
*
*
*
* DeleteResourceTree will only delete Amazon Forecast resources, and will not delete datasets or
* exported files stored in Amazon S3.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteResourceTreeRequest.Builder} avoiding the
* need to create one manually via {@link DeleteResourceTreeRequest#builder()}
*
*
* @param deleteResourceTreeRequest
* A {@link Consumer} that will call methods on {@link DeleteResourceTreeRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteResourceTree operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DeleteResourceTree
* @see AWS
* API Documentation
*/
default CompletableFuture deleteResourceTree(
Consumer deleteResourceTreeRequest) {
return deleteResourceTree(DeleteResourceTreeRequest.builder().applyMutation(deleteResourceTreeRequest).build());
}
/**
*
* Describes a predictor created using the CreateAutoPredictor operation.
*
*
* @param describeAutoPredictorRequest
* @return A Java Future containing the result of the DescribeAutoPredictor operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DescribeAutoPredictor
* @see AWS API Documentation
*/
default CompletableFuture describeAutoPredictor(
DescribeAutoPredictorRequest describeAutoPredictorRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes a predictor created using the CreateAutoPredictor operation.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeAutoPredictorRequest.Builder} avoiding the
* need to create one manually via {@link DescribeAutoPredictorRequest#builder()}
*
*
* @param describeAutoPredictorRequest
* A {@link Consumer} that will call methods on {@link DescribeAutoPredictorRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeAutoPredictor operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DescribeAutoPredictor
* @see AWS API Documentation
*/
default CompletableFuture describeAutoPredictor(
Consumer describeAutoPredictorRequest) {
return describeAutoPredictor(DescribeAutoPredictorRequest.builder().applyMutation(describeAutoPredictorRequest).build());
}
/**
*
* 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
*
*
*
*
* @param describeDatasetRequest
* @return A Java Future containing the result of the DescribeDataset operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DescribeDataset
* @see AWS API
* Documentation
*/
default CompletableFuture describeDataset(DescribeDatasetRequest describeDatasetRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeDatasetRequest.Builder} avoiding the need
* to create one manually via {@link DescribeDatasetRequest#builder()}
*
*
* @param describeDatasetRequest
* A {@link Consumer} that will call methods on {@link DescribeDatasetRequest.Builder} to create a request.
* @return A Java Future containing the result of the DescribeDataset operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DescribeDataset
* @see AWS API
* Documentation
*/
default CompletableFuture describeDataset(
Consumer describeDatasetRequest) {
return describeDataset(DescribeDatasetRequest.builder().applyMutation(describeDatasetRequest).build());
}
/**
*
* 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
*
*
*
*
* @param describeDatasetGroupRequest
* @return A Java Future containing the result of the DescribeDatasetGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DescribeDatasetGroup
* @see AWS
* API Documentation
*/
default CompletableFuture describeDatasetGroup(
DescribeDatasetGroupRequest describeDatasetGroupRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeDatasetGroupRequest.Builder} avoiding the
* need to create one manually via {@link DescribeDatasetGroupRequest#builder()}
*
*
* @param describeDatasetGroupRequest
* A {@link Consumer} that will call methods on {@link DescribeDatasetGroupRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeDatasetGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DescribeDatasetGroup
* @see AWS
* API Documentation
*/
default CompletableFuture describeDatasetGroup(
Consumer describeDatasetGroupRequest) {
return describeDatasetGroup(DescribeDatasetGroupRequest.builder().applyMutation(describeDatasetGroupRequest).build());
}
/**
*
* 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.
*
*
*
*
* @param describeDatasetImportJobRequest
* @return A Java Future containing the result of the DescribeDatasetImportJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DescribeDatasetImportJob
* @see AWS API Documentation
*/
default CompletableFuture describeDatasetImportJob(
DescribeDatasetImportJobRequest describeDatasetImportJobRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeDatasetImportJobRequest.Builder} avoiding
* the need to create one manually via {@link DescribeDatasetImportJobRequest#builder()}
*
*
* @param describeDatasetImportJobRequest
* A {@link Consumer} that will call methods on {@link DescribeDatasetImportJobRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeDatasetImportJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DescribeDatasetImportJob
* @see AWS API Documentation
*/
default CompletableFuture describeDatasetImportJob(
Consumer describeDatasetImportJobRequest) {
return describeDatasetImportJob(DescribeDatasetImportJobRequest.builder().applyMutation(describeDatasetImportJobRequest)
.build());
}
/**
*
* Describes an Explainability resource created using the CreateExplainability operation.
*
*
* @param describeExplainabilityRequest
* @return A Java Future containing the result of the DescribeExplainability operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DescribeExplainability
* @see AWS API Documentation
*/
default CompletableFuture describeExplainability(
DescribeExplainabilityRequest describeExplainabilityRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes an Explainability resource created using the CreateExplainability operation.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeExplainabilityRequest.Builder} avoiding the
* need to create one manually via {@link DescribeExplainabilityRequest#builder()}
*
*
* @param describeExplainabilityRequest
* A {@link Consumer} that will call methods on {@link DescribeExplainabilityRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeExplainability operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DescribeExplainability
* @see AWS API Documentation
*/
default CompletableFuture describeExplainability(
Consumer describeExplainabilityRequest) {
return describeExplainability(DescribeExplainabilityRequest.builder().applyMutation(describeExplainabilityRequest)
.build());
}
/**
*
* Describes an Explainability export created using the CreateExplainabilityExport operation.
*
*
* @param describeExplainabilityExportRequest
* @return A Java Future containing the result of the DescribeExplainabilityExport operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DescribeExplainabilityExport
* @see AWS API Documentation
*/
default CompletableFuture describeExplainabilityExport(
DescribeExplainabilityExportRequest describeExplainabilityExportRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes an Explainability export created using the CreateExplainabilityExport operation.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeExplainabilityExportRequest.Builder}
* avoiding the need to create one manually via {@link DescribeExplainabilityExportRequest#builder()}
*
*
* @param describeExplainabilityExportRequest
* A {@link Consumer} that will call methods on {@link DescribeExplainabilityExportRequest.Builder} to create
* a request.
* @return A Java Future containing the result of the DescribeExplainabilityExport operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DescribeExplainabilityExport
* @see AWS API Documentation
*/
default CompletableFuture describeExplainabilityExport(
Consumer describeExplainabilityExportRequest) {
return describeExplainabilityExport(DescribeExplainabilityExportRequest.builder()
.applyMutation(describeExplainabilityExportRequest).build());
}
/**
*
* 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.
*
*
*
*
* @param describeForecastRequest
* @return A Java Future containing the result of the DescribeForecast operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DescribeForecast
* @see AWS API
* Documentation
*/
default CompletableFuture describeForecast(DescribeForecastRequest describeForecastRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeForecastRequest.Builder} avoiding the need
* to create one manually via {@link DescribeForecastRequest#builder()}
*
*
* @param describeForecastRequest
* A {@link Consumer} that will call methods on {@link DescribeForecastRequest.Builder} to create a request.
* @return A Java Future containing the result of the DescribeForecast operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DescribeForecast
* @see AWS API
* Documentation
*/
default CompletableFuture describeForecast(
Consumer describeForecastRequest) {
return describeForecast(DescribeForecastRequest.builder().applyMutation(describeForecastRequest).build());
}
/**
*
* 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.
*
*
*
*
* @param describeForecastExportJobRequest
* @return A Java Future containing the result of the DescribeForecastExportJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DescribeForecastExportJob
* @see AWS API Documentation
*/
default CompletableFuture describeForecastExportJob(
DescribeForecastExportJobRequest describeForecastExportJobRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeForecastExportJobRequest.Builder} avoiding
* the need to create one manually via {@link DescribeForecastExportJobRequest#builder()}
*
*
* @param describeForecastExportJobRequest
* A {@link Consumer} that will call methods on {@link DescribeForecastExportJobRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeForecastExportJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DescribeForecastExportJob
* @see AWS API Documentation
*/
default CompletableFuture describeForecastExportJob(
Consumer describeForecastExportJobRequest) {
return describeForecastExportJob(DescribeForecastExportJobRequest.builder()
.applyMutation(describeForecastExportJobRequest).build());
}
/**
*
*
* This operation is only valid for legacy predictors created with CreatePredictor. If you are not using a legacy
* predictor, use DescribeAutoPredictor.
*
*
*
* Describes a predictor created using the CreatePredictor operation.
*
*
* In addition to listing the properties provided in the CreatePredictor request, this operation lists
* the following properties:
*
*
* -
*
* DatasetImportJobArns - The dataset import jobs used to import training data.
*
*
* -
*
* AutoMLAlgorithmArns - If AutoML is performed, the algorithms that were evaluated.
*
*
* -
*
* CreationTime
*
*
* -
*
* LastModificationTime
*
*
* -
*
* Status
*
*
* -
*
* Message - If an error occurred, information about the error.
*
*
*
*
* @param describePredictorRequest
* @return A Java Future containing the result of the DescribePredictor operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DescribePredictor
* @see AWS
* API Documentation
*/
default CompletableFuture describePredictor(DescribePredictorRequest describePredictorRequest) {
throw new UnsupportedOperationException();
}
/**
*
*
* This operation is only valid for legacy predictors created with CreatePredictor. If you are not using a legacy
* predictor, use DescribeAutoPredictor.
*
*
*
* Describes a predictor created using the CreatePredictor operation.
*
*
* In addition to listing the properties provided in the CreatePredictor request, this operation lists
* the following properties:
*
*
* -
*
* DatasetImportJobArns - The dataset import jobs used to import training data.
*
*
* -
*
* AutoMLAlgorithmArns - If AutoML is performed, the algorithms that were evaluated.
*
*
* -
*
* CreationTime
*
*
* -
*
* LastModificationTime
*
*
* -
*
* Status
*
*
* -
*
* Message - If an error occurred, information about the error.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link DescribePredictorRequest.Builder} avoiding the need
* to create one manually via {@link DescribePredictorRequest#builder()}
*
*
* @param describePredictorRequest
* A {@link Consumer} that will call methods on {@link DescribePredictorRequest.Builder} to create a request.
* @return A Java Future containing the result of the DescribePredictor operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DescribePredictor
* @see AWS
* API Documentation
*/
default CompletableFuture describePredictor(
Consumer describePredictorRequest) {
return describePredictor(DescribePredictorRequest.builder().applyMutation(describePredictorRequest).build());
}
/**
*
* Describes a predictor backtest export job created using the CreatePredictorBacktestExportJob operation.
*
*
* In addition to listing the properties provided by the user in the CreatePredictorBacktestExportJob
* request, this operation lists the following properties:
*
*
* -
*
* CreationTime
*
*
* -
*
* LastModificationTime
*
*
* -
*
* Status
*
*
* -
*
* Message (if an error occurred)
*
*
*
*
* @param describePredictorBacktestExportJobRequest
* @return A Java Future containing the result of the DescribePredictorBacktestExportJob operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DescribePredictorBacktestExportJob
* @see AWS API Documentation
*/
default CompletableFuture describePredictorBacktestExportJob(
DescribePredictorBacktestExportJobRequest describePredictorBacktestExportJobRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describes a predictor backtest export job created using the CreatePredictorBacktestExportJob operation.
*
*
* In addition to listing the properties provided by the user in the CreatePredictorBacktestExportJob
* request, this operation lists the following properties:
*
*
* -
*
* CreationTime
*
*
* -
*
* LastModificationTime
*
*
* -
*
* Status
*
*
* -
*
* Message (if an error occurred)
*
*
*
*
*
* This is a convenience which creates an instance of the {@link DescribePredictorBacktestExportJobRequest.Builder}
* avoiding the need to create one manually via {@link DescribePredictorBacktestExportJobRequest#builder()}
*
*
* @param describePredictorBacktestExportJobRequest
* A {@link Consumer} that will call methods on {@link DescribePredictorBacktestExportJobRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the DescribePredictorBacktestExportJob operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.DescribePredictorBacktestExportJob
* @see AWS API Documentation
*/
default CompletableFuture describePredictorBacktestExportJob(
Consumer describePredictorBacktestExportJobRequest) {
return describePredictorBacktestExportJob(DescribePredictorBacktestExportJobRequest.builder()
.applyMutation(describePredictorBacktestExportJobRequest).build());
}
/**
*
* Provides metrics on the accuracy of the models that were trained by the CreatePredictor operation. Use
* metrics to see how well the model performed and to decide whether to use the predictor to generate a forecast.
* For more information, see Predictor
* Metrics.
*
*
* This operation generates metrics for each backtest window that was evaluated. The number of backtest windows (
* NumberOfBacktestWindows) is specified using the EvaluationParameters object, which is
* optionally included in the CreatePredictor request. If NumberOfBacktestWindows isn't
* specified, the number defaults to one.
*
*
* The parameters of the filling method determine which items contribute to the metrics. If you want
* all items to contribute, specify zero. If you want only those items that have complete data in the
* range being evaluated to contribute, specify nan. For more information, see
* FeaturizationMethod.
*
*
*
* Before you can get accuracy metrics, the Status of the predictor must be ACTIVE,
* signifying that training has completed. To get the status, use the DescribePredictor operation.
*
*
*
* @param getAccuracyMetricsRequest
* @return A Java Future containing the result of the GetAccuracyMetrics operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.GetAccuracyMetrics
* @see AWS
* API Documentation
*/
default CompletableFuture getAccuracyMetrics(GetAccuracyMetricsRequest getAccuracyMetricsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Provides metrics on the accuracy of the models that were trained by the CreatePredictor operation. Use
* metrics to see how well the model performed and to decide whether to use the predictor to generate a forecast.
* For more information, see Predictor
* Metrics.
*
*
* This operation generates metrics for each backtest window that was evaluated. The number of backtest windows (
* NumberOfBacktestWindows) is specified using the EvaluationParameters object, which is
* optionally included in the CreatePredictor request. If NumberOfBacktestWindows isn't
* specified, the number defaults to one.
*
*
* The parameters of the filling method determine which items contribute to the metrics. If you want
* all items to contribute, specify zero. If you want only those items that have complete data in the
* range being evaluated to contribute, specify nan. For more information, see
* FeaturizationMethod.
*
*
*
* Before you can get accuracy metrics, the Status of the predictor must be ACTIVE,
* signifying that training has completed. To get the status, use the DescribePredictor operation.
*
*
*
* This is a convenience which creates an instance of the {@link GetAccuracyMetricsRequest.Builder} avoiding the
* need to create one manually via {@link GetAccuracyMetricsRequest#builder()}
*
*
* @param getAccuracyMetricsRequest
* A {@link Consumer} that will call methods on {@link GetAccuracyMetricsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the GetAccuracyMetrics operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.GetAccuracyMetrics
* @see AWS
* API Documentation
*/
default CompletableFuture getAccuracyMetrics(
Consumer getAccuracyMetricsRequest) {
return getAccuracyMetrics(GetAccuracyMetricsRequest.builder().applyMutation(getAccuracyMetricsRequest).build());
}
/**
*
* 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.
*
*
* @param listDatasetGroupsRequest
* @return A Java Future containing the result of the ListDatasetGroups operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.ListDatasetGroups
* @see AWS
* API Documentation
*/
default CompletableFuture listDatasetGroups(ListDatasetGroupsRequest listDatasetGroupsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListDatasetGroupsRequest.Builder} avoiding the need
* to create one manually via {@link ListDatasetGroupsRequest#builder()}
*
*
* @param listDatasetGroupsRequest
* A {@link Consumer} that will call methods on {@link ListDatasetGroupsRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListDatasetGroups operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.ListDatasetGroups
* @see AWS
* API Documentation
*/
default CompletableFuture listDatasetGroups(
Consumer listDatasetGroupsRequest) {
return listDatasetGroups(ListDatasetGroupsRequest.builder().applyMutation(listDatasetGroupsRequest).build());
}
/**
*
* 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
* {@link #listDatasetGroups(software.amazon.awssdk.services.forecast.model.ListDatasetGroupsRequest)} operation.
* The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.forecast.paginators.ListDatasetGroupsPublisher publisher = client.listDatasetGroupsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.forecast.paginators.ListDatasetGroupsPublisher publisher = client.listDatasetGroupsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.forecast.model.ListDatasetGroupsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listDatasetGroups(software.amazon.awssdk.services.forecast.model.ListDatasetGroupsRequest)}
* operation.
*
*
* @param listDatasetGroupsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.ListDatasetGroups
* @see AWS
* API Documentation
*/
default ListDatasetGroupsPublisher listDatasetGroupsPaginator(ListDatasetGroupsRequest listDatasetGroupsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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
* {@link #listDatasetGroups(software.amazon.awssdk.services.forecast.model.ListDatasetGroupsRequest)} operation.
* The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.forecast.paginators.ListDatasetGroupsPublisher publisher = client.listDatasetGroupsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.forecast.paginators.ListDatasetGroupsPublisher publisher = client.listDatasetGroupsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.forecast.model.ListDatasetGroupsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listDatasetGroups(software.amazon.awssdk.services.forecast.model.ListDatasetGroupsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListDatasetGroupsRequest.Builder} avoiding the need
* to create one manually via {@link ListDatasetGroupsRequest#builder()}
*
*
* @param listDatasetGroupsRequest
* A {@link Consumer} that will call methods on {@link ListDatasetGroupsRequest.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.ListDatasetGroups
* @see AWS
* API Documentation
*/
default ListDatasetGroupsPublisher listDatasetGroupsPaginator(
Consumer listDatasetGroupsRequest) {
return listDatasetGroupsPaginator(ListDatasetGroupsRequest.builder().applyMutation(listDatasetGroupsRequest).build());
}
/**
*
* 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.
*
*
* @param listDatasetImportJobsRequest
* @return A Java Future containing the result of the ListDatasetImportJobs operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.ListDatasetImportJobs
* @see AWS API Documentation
*/
default CompletableFuture listDatasetImportJobs(
ListDatasetImportJobsRequest listDatasetImportJobsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListDatasetImportJobsRequest.Builder} avoiding the
* need to create one manually via {@link ListDatasetImportJobsRequest#builder()}
*
*
* @param listDatasetImportJobsRequest
* A {@link Consumer} that will call methods on {@link ListDatasetImportJobsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListDatasetImportJobs operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.ListDatasetImportJobs
* @see AWS API Documentation
*/
default CompletableFuture listDatasetImportJobs(
Consumer listDatasetImportJobsRequest) {
return listDatasetImportJobs(ListDatasetImportJobsRequest.builder().applyMutation(listDatasetImportJobsRequest).build());
}
/**
*
* 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
* {@link #listDatasetImportJobs(software.amazon.awssdk.services.forecast.model.ListDatasetImportJobsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.forecast.paginators.ListDatasetImportJobsPublisher publisher = client.listDatasetImportJobsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.forecast.paginators.ListDatasetImportJobsPublisher publisher = client.listDatasetImportJobsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.forecast.model.ListDatasetImportJobsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listDatasetImportJobs(software.amazon.awssdk.services.forecast.model.ListDatasetImportJobsRequest)}
* operation.
*
*
* @param listDatasetImportJobsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.ListDatasetImportJobs
* @see AWS API Documentation
*/
default ListDatasetImportJobsPublisher listDatasetImportJobsPaginator(
ListDatasetImportJobsRequest listDatasetImportJobsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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
* {@link #listDatasetImportJobs(software.amazon.awssdk.services.forecast.model.ListDatasetImportJobsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.forecast.paginators.ListDatasetImportJobsPublisher publisher = client.listDatasetImportJobsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.forecast.paginators.ListDatasetImportJobsPublisher publisher = client.listDatasetImportJobsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.forecast.model.ListDatasetImportJobsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listDatasetImportJobs(software.amazon.awssdk.services.forecast.model.ListDatasetImportJobsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListDatasetImportJobsRequest.Builder} avoiding the
* need to create one manually via {@link ListDatasetImportJobsRequest#builder()}
*
*
* @param listDatasetImportJobsRequest
* A {@link Consumer} that will call methods on {@link ListDatasetImportJobsRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.ListDatasetImportJobs
* @see AWS API Documentation
*/
default ListDatasetImportJobsPublisher listDatasetImportJobsPaginator(
Consumer listDatasetImportJobsRequest) {
return listDatasetImportJobsPaginator(ListDatasetImportJobsRequest.builder().applyMutation(listDatasetImportJobsRequest)
.build());
}
/**
*
* 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.
*
*
* @param listDatasetsRequest
* @return A Java Future containing the result of the ListDatasets operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.ListDatasets
* @see AWS API
* Documentation
*/
default CompletableFuture listDatasets(ListDatasetsRequest listDatasetsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListDatasetsRequest.Builder} avoiding the need to
* create one manually via {@link ListDatasetsRequest#builder()}
*
*
* @param listDatasetsRequest
* A {@link Consumer} that will call methods on {@link ListDatasetsRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListDatasets operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.ListDatasets
* @see AWS API
* Documentation
*/
default CompletableFuture listDatasets(Consumer listDatasetsRequest) {
return listDatasets(ListDatasetsRequest.builder().applyMutation(listDatasetsRequest).build());
}
/**
*
* 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 {@link #listDatasets(software.amazon.awssdk.services.forecast.model.ListDatasetsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.forecast.paginators.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.forecast.paginators.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.forecast.model.ListDatasetsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listDatasets(software.amazon.awssdk.services.forecast.model.ListDatasetsRequest)} operation.
*
*
* @param listDatasetsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.ListDatasets
* @see AWS API
* Documentation
*/
default ListDatasetsPublisher listDatasetsPaginator(ListDatasetsRequest listDatasetsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link #listDatasets(software.amazon.awssdk.services.forecast.model.ListDatasetsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.forecast.paginators.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.forecast.paginators.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.forecast.model.ListDatasetsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listDatasets(software.amazon.awssdk.services.forecast.model.ListDatasetsRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link ListDatasetsRequest.Builder} avoiding the need to
* create one manually via {@link ListDatasetsRequest#builder()}
*
*
* @param listDatasetsRequest
* A {@link Consumer} that will call methods on {@link ListDatasetsRequest.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.ListDatasets
* @see AWS API
* Documentation
*/
default ListDatasetsPublisher listDatasetsPaginator(Consumer listDatasetsRequest) {
return listDatasetsPaginator(ListDatasetsRequest.builder().applyMutation(listDatasetsRequest).build());
}
/**
*
* Returns a list of Explainability resources created using the CreateExplainability operation. This
* operation returns a summary for each Explainability. You can filter the list using an array of Filter
* objects.
*
*
* To retrieve the complete set of properties for a particular Explainability resource, use the ARN with the
* DescribeExplainability operation.
*
*
* @param listExplainabilitiesRequest
* @return A Java Future containing the result of the ListExplainabilities operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.ListExplainabilities
* @see AWS
* API Documentation
*/
default CompletableFuture listExplainabilities(
ListExplainabilitiesRequest listExplainabilitiesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of Explainability resources created using the CreateExplainability operation. This
* operation returns a summary for each Explainability. You can filter the list using an array of Filter
* objects.
*
*
* To retrieve the complete set of properties for a particular Explainability resource, use the ARN with the
* DescribeExplainability operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListExplainabilitiesRequest.Builder} avoiding the
* need to create one manually via {@link ListExplainabilitiesRequest#builder()}
*
*
* @param listExplainabilitiesRequest
* A {@link Consumer} that will call methods on {@link ListExplainabilitiesRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListExplainabilities operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.ListExplainabilities
* @see AWS
* API Documentation
*/
default CompletableFuture listExplainabilities(
Consumer listExplainabilitiesRequest) {
return listExplainabilities(ListExplainabilitiesRequest.builder().applyMutation(listExplainabilitiesRequest).build());
}
/**
*
* Returns a list of Explainability exports created using the CreateExplainabilityExport operation. This
* operation returns a summary for each Explainability export. You can filter the list using an array of
* Filter objects.
*
*
* To retrieve the complete set of properties for a particular Explainability export, use the ARN with the
* DescribeExplainability operation.
*
*
* @param listExplainabilityExportsRequest
* @return A Java Future containing the result of the ListExplainabilityExports operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.ListExplainabilityExports
* @see AWS API Documentation
*/
default CompletableFuture listExplainabilityExports(
ListExplainabilityExportsRequest listExplainabilityExportsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of Explainability exports created using the CreateExplainabilityExport operation. This
* operation returns a summary for each Explainability export. You can filter the list using an array of
* Filter objects.
*
*
* To retrieve the complete set of properties for a particular Explainability export, use the ARN with the
* DescribeExplainability operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListExplainabilityExportsRequest.Builder} avoiding
* the need to create one manually via {@link ListExplainabilityExportsRequest#builder()}
*
*
* @param listExplainabilityExportsRequest
* A {@link Consumer} that will call methods on {@link ListExplainabilityExportsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListExplainabilityExports operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.ListExplainabilityExports
* @see AWS API Documentation
*/
default CompletableFuture listExplainabilityExports(
Consumer listExplainabilityExportsRequest) {
return listExplainabilityExports(ListExplainabilityExportsRequest.builder()
.applyMutation(listExplainabilityExportsRequest).build());
}
/**
*
* 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.
*
*
* @param listForecastExportJobsRequest
* @return A Java Future containing the result of the ListForecastExportJobs operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.ListForecastExportJobs
* @see AWS API Documentation
*/
default CompletableFuture listForecastExportJobs(
ListForecastExportJobsRequest listForecastExportJobsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListForecastExportJobsRequest.Builder} avoiding the
* need to create one manually via {@link ListForecastExportJobsRequest#builder()}
*
*
* @param listForecastExportJobsRequest
* A {@link Consumer} that will call methods on {@link ListForecastExportJobsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListForecastExportJobs operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.ListForecastExportJobs
* @see AWS API Documentation
*/
default CompletableFuture listForecastExportJobs(
Consumer listForecastExportJobsRequest) {
return listForecastExportJobs(ListForecastExportJobsRequest.builder().applyMutation(listForecastExportJobsRequest)
.build());
}
/**
*
* 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
* {@link #listForecastExportJobs(software.amazon.awssdk.services.forecast.model.ListForecastExportJobsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.forecast.paginators.ListForecastExportJobsPublisher publisher = client.listForecastExportJobsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.forecast.paginators.ListForecastExportJobsPublisher publisher = client.listForecastExportJobsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.forecast.model.ListForecastExportJobsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listForecastExportJobs(software.amazon.awssdk.services.forecast.model.ListForecastExportJobsRequest)}
* operation.
*
*
* @param listForecastExportJobsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.ListForecastExportJobs
* @see AWS API Documentation
*/
default ListForecastExportJobsPublisher listForecastExportJobsPaginator(
ListForecastExportJobsRequest listForecastExportJobsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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
* {@link #listForecastExportJobs(software.amazon.awssdk.services.forecast.model.ListForecastExportJobsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.forecast.paginators.ListForecastExportJobsPublisher publisher = client.listForecastExportJobsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.forecast.paginators.ListForecastExportJobsPublisher publisher = client.listForecastExportJobsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.forecast.model.ListForecastExportJobsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listForecastExportJobs(software.amazon.awssdk.services.forecast.model.ListForecastExportJobsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListForecastExportJobsRequest.Builder} avoiding the
* need to create one manually via {@link ListForecastExportJobsRequest#builder()}
*
*
* @param listForecastExportJobsRequest
* A {@link Consumer} that will call methods on {@link ListForecastExportJobsRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.ListForecastExportJobs
* @see AWS API Documentation
*/
default ListForecastExportJobsPublisher listForecastExportJobsPaginator(
Consumer listForecastExportJobsRequest) {
return listForecastExportJobsPaginator(ListForecastExportJobsRequest.builder()
.applyMutation(listForecastExportJobsRequest).build());
}
/**
*
* 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.
*
*
* @param listForecastsRequest
* @return A Java Future containing the result of the ListForecasts operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.ListForecasts
* @see AWS API
* Documentation
*/
default CompletableFuture listForecasts(ListForecastsRequest listForecastsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListForecastsRequest.Builder} avoiding the need to
* create one manually via {@link ListForecastsRequest#builder()}
*
*
* @param listForecastsRequest
* A {@link Consumer} that will call methods on {@link ListForecastsRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListForecasts operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.ListForecasts
* @see AWS API
* Documentation
*/
default CompletableFuture listForecasts(Consumer listForecastsRequest) {
return listForecasts(ListForecastsRequest.builder().applyMutation(listForecastsRequest).build());
}
/**
*
* 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 {@link #listForecasts(software.amazon.awssdk.services.forecast.model.ListForecastsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.forecast.paginators.ListForecastsPublisher publisher = client.listForecastsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.forecast.paginators.ListForecastsPublisher publisher = client.listForecastsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.forecast.model.ListForecastsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listForecasts(software.amazon.awssdk.services.forecast.model.ListForecastsRequest)} operation.
*
*
* @param listForecastsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.ListForecasts
* @see AWS API
* Documentation
*/
default ListForecastsPublisher listForecastsPaginator(ListForecastsRequest listForecastsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link #listForecasts(software.amazon.awssdk.services.forecast.model.ListForecastsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.forecast.paginators.ListForecastsPublisher publisher = client.listForecastsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.forecast.paginators.ListForecastsPublisher publisher = client.listForecastsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.forecast.model.ListForecastsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listForecasts(software.amazon.awssdk.services.forecast.model.ListForecastsRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link ListForecastsRequest.Builder} avoiding the need to
* create one manually via {@link ListForecastsRequest#builder()}
*
*
* @param listForecastsRequest
* A {@link Consumer} that will call methods on {@link ListForecastsRequest.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.ListForecasts
* @see AWS API
* Documentation
*/
default ListForecastsPublisher listForecastsPaginator(Consumer listForecastsRequest) {
return listForecastsPaginator(ListForecastsRequest.builder().applyMutation(listForecastsRequest).build());
}
/**
*
* Returns a list of predictor backtest export jobs created using the CreatePredictorBacktestExportJob
* operation. This operation returns a summary for each backtest export job. You can filter the list using an array
* of Filter objects.
*
*
* To retrieve the complete set of properties for a particular backtest export job, use the ARN with the
* DescribePredictorBacktestExportJob operation.
*
*
* @param listPredictorBacktestExportJobsRequest
* @return A Java Future containing the result of the ListPredictorBacktestExportJobs operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.ListPredictorBacktestExportJobs
* @see AWS API Documentation
*/
default CompletableFuture listPredictorBacktestExportJobs(
ListPredictorBacktestExportJobsRequest listPredictorBacktestExportJobsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of predictor backtest export jobs created using the CreatePredictorBacktestExportJob
* operation. This operation returns a summary for each backtest export job. You can filter the list using an array
* of Filter objects.
*
*
* To retrieve the complete set of properties for a particular backtest export job, use the ARN with the
* DescribePredictorBacktestExportJob operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListPredictorBacktestExportJobsRequest.Builder}
* avoiding the need to create one manually via {@link ListPredictorBacktestExportJobsRequest#builder()}
*
*
* @param listPredictorBacktestExportJobsRequest
* A {@link Consumer} that will call methods on {@link ListPredictorBacktestExportJobsRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the ListPredictorBacktestExportJobs operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.ListPredictorBacktestExportJobs
* @see AWS API Documentation
*/
default CompletableFuture listPredictorBacktestExportJobs(
Consumer listPredictorBacktestExportJobsRequest) {
return listPredictorBacktestExportJobs(ListPredictorBacktestExportJobsRequest.builder()
.applyMutation(listPredictorBacktestExportJobsRequest).build());
}
/**
*
* Returns a list of predictor backtest export jobs created using the CreatePredictorBacktestExportJob
* operation. This operation returns a summary for each backtest export job. You can filter the list using an array
* of Filter objects.
*
*
* To retrieve the complete set of properties for a particular backtest export job, use the ARN with the
* DescribePredictorBacktestExportJob operation.
*
*
*
* This is a variant of
* {@link #listPredictorBacktestExportJobs(software.amazon.awssdk.services.forecast.model.ListPredictorBacktestExportJobsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.forecast.paginators.ListPredictorBacktestExportJobsPublisher publisher = client.listPredictorBacktestExportJobsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.forecast.paginators.ListPredictorBacktestExportJobsPublisher publisher = client.listPredictorBacktestExportJobsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.forecast.model.ListPredictorBacktestExportJobsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listPredictorBacktestExportJobs(software.amazon.awssdk.services.forecast.model.ListPredictorBacktestExportJobsRequest)}
* operation.
*
*
* @param listPredictorBacktestExportJobsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.ListPredictorBacktestExportJobs
* @see AWS API Documentation
*/
default ListPredictorBacktestExportJobsPublisher listPredictorBacktestExportJobsPaginator(
ListPredictorBacktestExportJobsRequest listPredictorBacktestExportJobsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of predictor backtest export jobs created using the CreatePredictorBacktestExportJob
* operation. This operation returns a summary for each backtest export job. You can filter the list using an array
* of Filter objects.
*
*
* To retrieve the complete set of properties for a particular backtest export job, use the ARN with the
* DescribePredictorBacktestExportJob operation.
*
*
*
* This is a variant of
* {@link #listPredictorBacktestExportJobs(software.amazon.awssdk.services.forecast.model.ListPredictorBacktestExportJobsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.forecast.paginators.ListPredictorBacktestExportJobsPublisher publisher = client.listPredictorBacktestExportJobsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.forecast.paginators.ListPredictorBacktestExportJobsPublisher publisher = client.listPredictorBacktestExportJobsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.forecast.model.ListPredictorBacktestExportJobsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listPredictorBacktestExportJobs(software.amazon.awssdk.services.forecast.model.ListPredictorBacktestExportJobsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListPredictorBacktestExportJobsRequest.Builder}
* avoiding the need to create one manually via {@link ListPredictorBacktestExportJobsRequest#builder()}
*
*
* @param listPredictorBacktestExportJobsRequest
* A {@link Consumer} that will call methods on {@link ListPredictorBacktestExportJobsRequest.Builder} to
* create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.ListPredictorBacktestExportJobs
* @see AWS API Documentation
*/
default ListPredictorBacktestExportJobsPublisher listPredictorBacktestExportJobsPaginator(
Consumer listPredictorBacktestExportJobsRequest) {
return listPredictorBacktestExportJobsPaginator(ListPredictorBacktestExportJobsRequest.builder()
.applyMutation(listPredictorBacktestExportJobsRequest).build());
}
/**
*
* Returns a list of predictors created using the CreateAutoPredictor or CreatePredictor operations.
* For each predictor, this operation returns a summary of its properties, including its Amazon Resource Name (ARN).
*
*
* You can retrieve the complete set of properties by using the ARN with the DescribeAutoPredictor and
* DescribePredictor operations. You can filter the list using an array of Filter objects.
*
*
* @param listPredictorsRequest
* @return A Java Future containing the result of the ListPredictors operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.ListPredictors
* @see AWS API
* Documentation
*/
default CompletableFuture listPredictors(ListPredictorsRequest listPredictorsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of predictors created using the CreateAutoPredictor or CreatePredictor operations.
* For each predictor, this operation returns a summary of its properties, including its Amazon Resource Name (ARN).
*
*
* You can retrieve the complete set of properties by using the ARN with the DescribeAutoPredictor and
* DescribePredictor operations. You can filter the list using an array of Filter objects.
*
*
*
* This is a convenience which creates an instance of the {@link ListPredictorsRequest.Builder} avoiding the need to
* create one manually via {@link ListPredictorsRequest#builder()}
*
*
* @param listPredictorsRequest
* A {@link Consumer} that will call methods on {@link ListPredictorsRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListPredictors operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.ListPredictors
* @see AWS API
* Documentation
*/
default CompletableFuture listPredictors(Consumer listPredictorsRequest) {
return listPredictors(ListPredictorsRequest.builder().applyMutation(listPredictorsRequest).build());
}
/**
*
* Returns a list of predictors created using the CreateAutoPredictor or CreatePredictor operations.
* For each predictor, this operation returns a summary of its properties, including its Amazon Resource Name (ARN).
*
*
* You can retrieve the complete set of properties by using the ARN with the DescribeAutoPredictor and
* DescribePredictor operations. You can filter the list using an array of Filter objects.
*
*
*
* This is a variant of
* {@link #listPredictors(software.amazon.awssdk.services.forecast.model.ListPredictorsRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.forecast.paginators.ListPredictorsPublisher publisher = client.listPredictorsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.forecast.paginators.ListPredictorsPublisher publisher = client.listPredictorsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.forecast.model.ListPredictorsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listPredictors(software.amazon.awssdk.services.forecast.model.ListPredictorsRequest)} operation.
*
*
* @param listPredictorsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.ListPredictors
* @see AWS API
* Documentation
*/
default ListPredictorsPublisher listPredictorsPaginator(ListPredictorsRequest listPredictorsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of predictors created using the CreateAutoPredictor or CreatePredictor operations.
* For each predictor, this operation returns a summary of its properties, including its Amazon Resource Name (ARN).
*
*
* You can retrieve the complete set of properties by using the ARN with the DescribeAutoPredictor and
* DescribePredictor operations. You can filter the list using an array of Filter objects.
*
*
*
* This is a variant of
* {@link #listPredictors(software.amazon.awssdk.services.forecast.model.ListPredictorsRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.forecast.paginators.ListPredictorsPublisher publisher = client.listPredictorsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.forecast.paginators.ListPredictorsPublisher publisher = client.listPredictorsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.forecast.model.ListPredictorsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* 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
* {@link #listPredictors(software.amazon.awssdk.services.forecast.model.ListPredictorsRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link ListPredictorsRequest.Builder} avoiding the need to
* create one manually via {@link ListPredictorsRequest#builder()}
*
*
* @param listPredictorsRequest
* A {@link Consumer} that will call methods on {@link ListPredictorsRequest.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.ListPredictors
* @see AWS API
* Documentation
*/
default ListPredictorsPublisher listPredictorsPaginator(Consumer listPredictorsRequest) {
return listPredictorsPaginator(ListPredictorsRequest.builder().applyMutation(listPredictorsRequest).build());
}
/**
*
* Lists the tags for an Amazon Forecast resource.
*
*
* @param listTagsForResourceRequest
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.ListTagsForResource
* @see AWS
* API Documentation
*/
default CompletableFuture listTagsForResource(
ListTagsForResourceRequest listTagsForResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the tags for an Amazon Forecast resource.
*
*
*
* This is a convenience which creates an instance of the {@link ListTagsForResourceRequest.Builder} avoiding the
* need to create one manually via {@link ListTagsForResourceRequest#builder()}
*
*
* @param listTagsForResourceRequest
* A {@link Consumer} that will call methods on {@link ListTagsForResourceRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.ListTagsForResource
* @see AWS
* API Documentation
*/
default CompletableFuture listTagsForResource(
Consumer listTagsForResourceRequest) {
return listTagsForResource(ListTagsForResourceRequest.builder().applyMutation(listTagsForResourceRequest).build());
}
/**
*
* Stops a resource.
*
*
* The resource undergoes the following states: CREATE_STOPPING and CREATE_STOPPED. You
* cannot resume a resource once it has been stopped.
*
*
* This operation can be applied to the following resources (and their corresponding child resources):
*
*
* -
*
* Dataset Import Job
*
*
* -
*
* Predictor Job
*
*
* -
*
* Forecast Job
*
*
* -
*
* Forecast Export Job
*
*
* -
*
* Predictor Backtest Export Job
*
*
* -
*
* Explainability Job
*
*
* -
*
* Explainability Export Job
*
*
*
*
* @param stopResourceRequest
* @return A Java Future containing the result of the StopResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException We can't process the request because it includes an invalid value or a value
* that exceeds the valid range.
* - LimitExceededException The limit on the number of resources per account has been exceeded.
* - ResourceNotFoundException We can't find a resource with that Amazon Resource Name (ARN). Check the
* ARN and try again.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ForecastException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ForecastAsyncClient.StopResource
* @see AWS API
* Documentation
*/
default CompletableFuture stopResource(StopResourceRequest stopResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Stops a resource.
*
*
* The resource undergoes the following states: CREATE_STOPPING and CREATE_STOPPED. You
* cannot resume a resource once it has been stopped.
*
*
* This operation can be applied to the following resources (and their corresponding child resources):
*
*
* -
*
* Dataset Import Job
*
*
* -
*
* Predictor Job
*
*
* -
*
* Forecast Job
*
*
* -
*
* Forecast Export Job
*
*
* -
*
* Predictor Backtest Export Job
*
*
* -
*
* Explainability Job
*
*
* -
*
* Explainability Export Job
*
*
*
*
*
* This is a convenience which creates an instance of the {@link StopResourceRequest.Builder} avoiding the need to
* create one manually via {@link StopResourceRequest#builder()}
*
*
* @param stopResourceRequest
* A {@link Consumer} that will call methods on {@link StopResourceRequest.Builder} to create a request.
* @return A Java Future containing the result of the StopResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidInputException We can't process the request because it includes an invalid value or a value
* that exceeds the valid range.
* - LimitExceededException The limit on the number of resources per account has been exceeded.
* - ResourceNotFoundException We can't find a resource with that Amazon Resource Name (ARN). Check the
* ARN and try again.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - ForecastException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample ForecastAsyncClient.StopResource
* @see AWS API
* Documentation
*/
default CompletableFuture stopResource(Consumer stopResourceRequest) {
return stopResource(StopResourceRequest.builder().applyMutation(stopResourceRequest).build());
}
/**
*
* 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.
*
*
* @param tagResourceRequest
* @return A Java Future containing the result of the TagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.TagResource
* @see AWS API
* Documentation
*/
default CompletableFuture tagResource(TagResourceRequest tagResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link TagResourceRequest.Builder} avoiding the need to
* create one manually via {@link TagResourceRequest#builder()}
*
*
* @param tagResourceRequest
* A {@link Consumer} that will call methods on {@link TagResourceRequest.Builder} to create a request.
* @return A Java Future containing the result of the TagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.TagResource
* @see AWS API
* Documentation
*/
default CompletableFuture tagResource(Consumer tagResourceRequest) {
return tagResource(TagResourceRequest.builder().applyMutation(tagResourceRequest).build());
}
/**
*
* Deletes the specified tags from a resource.
*
*
* @param untagResourceRequest
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.UntagResource
* @see AWS API
* Documentation
*/
default CompletableFuture untagResource(UntagResourceRequest untagResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified tags from a resource.
*
*
*
* This is a convenience which creates an instance of the {@link UntagResourceRequest.Builder} avoiding the need to
* create one manually via {@link UntagResourceRequest#builder()}
*
*
* @param untagResourceRequest
* A {@link Consumer} that will call methods on {@link UntagResourceRequest.Builder} to create a request.
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.UntagResource
* @see AWS API
* Documentation
*/
default CompletableFuture untagResource(Consumer untagResourceRequest) {
return untagResource(UntagResourceRequest.builder().applyMutation(untagResourceRequest).build());
}
/**
*
* 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.
*
*
*
* @param updateDatasetGroupRequest
* @return A Java Future containing the result of the UpdateDatasetGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.UpdateDatasetGroup
* @see AWS
* API Documentation
*/
default CompletableFuture updateDatasetGroup(UpdateDatasetGroupRequest updateDatasetGroupRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link UpdateDatasetGroupRequest.Builder} avoiding the
* need to create one manually via {@link UpdateDatasetGroupRequest#builder()}
*
*
* @param updateDatasetGroupRequest
* A {@link Consumer} that will call methods on {@link UpdateDatasetGroupRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the UpdateDatasetGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
*
* @sample ForecastAsyncClient.UpdateDatasetGroup
* @see AWS
* API Documentation
*/
default CompletableFuture updateDatasetGroup(
Consumer updateDatasetGroupRequest) {
return updateDatasetGroup(UpdateDatasetGroupRequest.builder().applyMutation(updateDatasetGroupRequest).build());
}
}