com.amazonaws.services.forecastquery

Class AmazonForecastQueryClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.forecastquery.AmazonForecastQueryClient

All Implemented Interfaces:

AmazonForecastQuery

Direct Known Subclasses:

AmazonForecastQueryAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonForecastQueryClient
extends AmazonWebServiceClient
implements AmazonForecastQuery

Client for accessing Amazon Forecast Query Service. All service calls made using this client are blocking, and will not return until the service call completes.

Provides APIs for creating and managing Amazon Forecast resources.

Field Summary

Fields

Modifier and Type	Field and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.forecastquery.AmazonForecastQuery

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonForecastQueryClientBuilder	builder()
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
QueryForecastResult	queryForecast(QueryForecastRequest request) Retrieves a forecast for a single item, filtered by the supplied criteria.
QueryWhatIfForecastResult	queryWhatIfForecast(QueryWhatIfForecastRequest request) Retrieves a what-if forecast.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AmazonForecastQueryClientBuilder builder()

queryForecast

public QueryForecastResult queryForecast(QueryForecastRequest request)

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 the TARGET_TIME_SERIES dataset, or one of the forecast dimensions specified as part of the FeaturizationConfig 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.

Specified by:

queryForecast in interface AmazonForecastQuery

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.

See Also:

AWS API Documentation

queryWhatIfForecast

public QueryWhatIfForecastResult queryWhatIfForecast(QueryWhatIfForecastRequest request)

Retrieves a what-if forecast.

Specified by:

queryWhatIfForecast in interface AmazonForecastQuery

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.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AmazonForecastQuery

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from interface: AmazonForecastQuery

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonForecastQuery

Overrides:

shutdown in class AmazonWebServiceClient