* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.appconfigdata.AbstractAWSAppConfigData} instead. *
**
* AppConfig Data provides the data plane APIs your application uses to retrieve configuration data. Here's how it * works: *
** Your application retrieves configuration data by first establishing a configuration session using the AppConfig Data * StartConfigurationSession API action. Your session's client then makes periodic calls to * GetLatestConfiguration to check for and retrieve the latest data available. *
*
* When calling StartConfigurationSession, your code sends the following information:
*
* Identifiers (ID or name) of an AppConfig application, environment, and configuration profile that the session tracks. *
*
* (Optional) The minimum amount of time the session's client must wait between calls to
* GetLatestConfiguration.
*
* In response, AppConfig provides an InitialConfigurationToken to be given to the session's client and
* used the first time it calls GetLatestConfiguration for that session.
*
* This token should only be used once in your first call to GetLatestConfiguration. You must use
* the new token in the GetLatestConfiguration response (NextPollConfigurationToken) in each
* subsequent call to GetLatestConfiguration.
*
* When calling GetLatestConfiguration, your client code sends the most recent
* ConfigurationToken value it has and receives in response:
*
* NextPollConfigurationToken: the ConfigurationToken value to use on the next call to
* GetLatestConfiguration.
*
* NextPollIntervalInSeconds: the duration the client should wait before making its next call to
* GetLatestConfiguration. This duration may vary over the course of the session, so it should be used
* instead of the value sent on the StartConfigurationSession call.
*
* The configuration: the latest data intended for the session. This may be empty if the client already has the latest * version of the configuration. *
*
* The InitialConfigurationToken and NextPollConfigurationToken should only be used once. To
* support long poll use cases, the tokens are valid for up to 24 hours. If a GetLatestConfiguration call
* uses an expired token, the system returns BadRequestException.
*
* For more information and to view example CLI commands that show how to retrieve a configuration using the AppConfig
* Data StartConfigurationSession and GetLatestConfiguration API actions, see Retrieving the
* configuration in the AppConfig User Guide.
*
* Retrieves the latest deployed configuration. This API may return empty configuration data if the client already * has the latest version. For more information about this API action and to view example CLI commands that show how * to use it with the StartConfigurationSession API action, see Retrieving * the configuration in the AppConfig User Guide. *
** Note the following important information. *
*
* Each configuration token is only valid for one call to GetLatestConfiguration. The
* GetLatestConfiguration response includes a NextPollConfigurationToken that should
* always replace the token used for the just-completed call in preparation for the next one.
*
* GetLatestConfiguration is a priced call. For more information, see Pricing.
*
* Starts a configuration session used to retrieve a deployed configuration. For more information about this API * action and to view example CLI commands that show how to use it with the GetLatestConfiguration API * action, see Retrieving * the configuration in the AppConfig User Guide. *
* * @param startConfigurationSessionRequest * @return Result of the StartConfigurationSession operation returned by the service. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ResourceNotFoundException * The requested resource could not be found. * @throws BadRequestException * The input fails to satisfy the constraints specified by the service. * @throws InternalServerException * There was an internal failure in the service. * @sample AWSAppConfigData.StartConfigurationSession * @see AWS API Documentation */ StartConfigurationSessionResult startConfigurationSession(StartConfigurationSessionRequest startConfigurationSessionRequest); /** * 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. */ void shutdown(); /** * 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. * * @param request * The originally executed request. * * @return The response metadata for the specified request, or null if none is available. */ ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }