Interface ForecastqueryClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
Provides APIs for creating and managing Amazon Forecast resources.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic ForecastqueryClientBuilder
builder()
Create a builder that can be used to configure and create aForecastqueryClient
.static ForecastqueryClient
create()
Create aForecastqueryClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default QueryForecastResponse
queryForecast
(Consumer<QueryForecastRequest.Builder> queryForecastRequest) Retrieves a forecast for a single item, filtered by the supplied criteria.default QueryForecastResponse
queryForecast
(QueryForecastRequest queryForecastRequest) Retrieves a forecast for a single item, filtered by the supplied criteria.default QueryWhatIfForecastResponse
queryWhatIfForecast
(Consumer<QueryWhatIfForecastRequest.Builder> queryWhatIfForecastRequest) Retrieves a what-if forecast.default QueryWhatIfForecastResponse
queryWhatIfForecast
(QueryWhatIfForecastRequest queryWhatIfForecastRequest) Retrieves a what-if forecast.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
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_SERIES
dataset, or one of the forecast dimensions specified as part of theFeaturizationConfig
object.By default,
QueryForecast
returns 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.
- See Also:
-
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_SERIES
dataset, or one of the forecast dimensions specified as part of theFeaturizationConfig
object.By default,
QueryForecast
returns 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.Builder
avoiding the need to create one manually viaQueryForecastRequest.builder()
- Parameters:
queryForecastRequest
- AConsumer
that will call methods onQueryForecastRequest.Builder
to create a request.- Returns:
- Result of the QueryForecast operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaQueryWhatIfForecastRequest.builder()
- Parameters:
queryWhatIfForecastRequest
- AConsumer
that will call methods onQueryWhatIfForecastRequest.Builder
to create a request.- Returns:
- Result of the QueryWhatIfForecast operation returned by the service.
- See Also:
-
create
Create aForecastqueryClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aForecastqueryClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-