com.amazonaws.services.forecastquery

Interface AmazonForecastQuery

All Known Subinterfaces:

AmazonForecastQueryAsync

All Known Implementing Classes:

AbstractAmazonForecastQuery, AbstractAmazonForecastQueryAsync, AmazonForecastQueryAsyncClient, AmazonForecastQueryClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonForecastQuery

Interface for accessing Amazon Forecast Query Service.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonForecastQuery instead.

Provides APIs for creating and managing Amazon Forecast resources.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
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 queryForecastRequest) Retrieves a forecast for a single item, filtered by the supplied criteria.
QueryWhatIfForecastResult	queryWhatIfForecast(QueryWhatIfForecastRequest queryWhatIfForecastRequest) Retrieves a what-if forecast.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

queryForecast

QueryForecastResult queryForecast(QueryForecastRequest queryForecastRequest)

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.

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

QueryWhatIfForecastResult queryWhatIfForecast(QueryWhatIfForecastRequest queryWhatIfForecastRequest)

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

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.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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