Interface ForecastqueryClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface ForecastqueryClient extends AwsClient
Service client for accessing Amazon Forecast Query Service. This can be created using the staticbuilder()method.Provides APIs for creating and managing Amazon Forecast resources.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description static ForecastqueryClientBuilderbuilder()Create a builder that can be used to configure and create aForecastqueryClient.static ForecastqueryClientcreate()Create aForecastqueryClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default QueryForecastResponsequeryForecast(Consumer<QueryForecastRequest.Builder> queryForecastRequest)Retrieves a forecast for a single item, filtered by the supplied criteria.default QueryForecastResponsequeryForecast(QueryForecastRequest queryForecastRequest)Retrieves a forecast for a single item, filtered by the supplied criteria.default QueryWhatIfForecastResponsequeryWhatIfForecast(Consumer<QueryWhatIfForecastRequest.Builder> queryWhatIfForecastRequest)Retrieves a what-if forecast.default QueryWhatIfForecastResponsequeryWhatIfForecast(QueryWhatIfForecastRequest queryWhatIfForecastRequest)Retrieves a what-if forecast.default ForecastqueryServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
queryForecast
default QueryForecastResponse queryForecast(QueryForecastRequest queryForecastRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidInputException, LimitExceededException, InvalidNextTokenException, AwsServiceException, SdkClientException, ForecastqueryException
Retrieves a forecast for a single item, filtered by the supplied criteria.
The criteria is a key-value pair. The key is either
item_id(or the equivalent non-timestamp, non-target field) from theTARGET_TIME_SERIESdataset, or one of the forecast dimensions specified as part of theFeaturizationConfigobject.By default,
QueryForecastreturns the complete date range for the filtered forecast. You can request a specific date range.To get the full forecast, use the CreateForecastExportJob operation.
The forecasts generated by Amazon Forecast are in the same timezone as the dataset that was used to create the predictor.
- Parameters:
queryForecastRequest-- Returns:
- Result of the QueryForecast operation returned by the service.
- Throws:
ResourceNotFoundException- We can't find that resource. Check the information that you've provided and try again.ResourceInUseException- The specified resource is in use.InvalidInputException- The value is invalid or is too long.LimitExceededException- The limit on the number of requests per second has been exceeded.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.ForecastqueryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
queryForecast
default QueryForecastResponse queryForecast(Consumer<QueryForecastRequest.Builder> queryForecastRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidInputException, LimitExceededException, InvalidNextTokenException, AwsServiceException, SdkClientException, ForecastqueryException
Retrieves a forecast for a single item, filtered by the supplied criteria.
The criteria is a key-value pair. The key is either
item_id(or the equivalent non-timestamp, non-target field) from theTARGET_TIME_SERIESdataset, or one of the forecast dimensions specified as part of theFeaturizationConfigobject.By default,
QueryForecastreturns the complete date range for the filtered forecast. You can request a specific date range.To get the full forecast, use the CreateForecastExportJob operation.
The forecasts generated by Amazon Forecast are in the same timezone as the dataset that was used to create the predictor.
This is a convenience which creates an instance of the
QueryForecastRequest.Builderavoiding the need to create one manually viaQueryForecastRequest.builder()- Parameters:
queryForecastRequest- AConsumerthat will call methods onQueryForecastRequest.Builderto create a request.- Returns:
- Result of the QueryForecast operation returned by the service.
- Throws:
ResourceNotFoundException- We can't find that resource. Check the information that you've provided and try again.ResourceInUseException- The specified resource is in use.InvalidInputException- The value is invalid or is too long.LimitExceededException- The limit on the number of requests per second has been exceeded.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.ForecastqueryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
queryWhatIfForecast
default QueryWhatIfForecastResponse queryWhatIfForecast(QueryWhatIfForecastRequest queryWhatIfForecastRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidInputException, LimitExceededException, InvalidNextTokenException, AwsServiceException, SdkClientException, ForecastqueryException
Retrieves a what-if forecast.
- Parameters:
queryWhatIfForecastRequest-- Returns:
- Result of the QueryWhatIfForecast operation returned by the service.
- Throws:
ResourceNotFoundException- We can't find that resource. Check the information that you've provided and try again.ResourceInUseException- The specified resource is in use.InvalidInputException- The value is invalid or is too long.LimitExceededException- The limit on the number of requests per second has been exceeded.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.ForecastqueryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
queryWhatIfForecast
default QueryWhatIfForecastResponse queryWhatIfForecast(Consumer<QueryWhatIfForecastRequest.Builder> queryWhatIfForecastRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidInputException, LimitExceededException, InvalidNextTokenException, AwsServiceException, SdkClientException, ForecastqueryException
Retrieves a what-if forecast.
This is a convenience which creates an instance of the
QueryWhatIfForecastRequest.Builderavoiding the need to create one manually viaQueryWhatIfForecastRequest.builder()- Parameters:
queryWhatIfForecastRequest- AConsumerthat will call methods onQueryWhatIfForecastRequest.Builderto create a request.- Returns:
- Result of the QueryWhatIfForecast operation returned by the service.
- Throws:
ResourceNotFoundException- We can't find that resource. Check the information that you've provided and try again.ResourceInUseException- The specified resource is in use.InvalidInputException- The value is invalid or is too long.LimitExceededException- The limit on the number of requests per second has been exceeded.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.ForecastqueryException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
create
static ForecastqueryClient create()
Create aForecastqueryClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static ForecastqueryClientBuilder builder()
Create a builder that can be used to configure and create aForecastqueryClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default ForecastqueryServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-