com.amazonaws.services.appconfigdata.AWSAppConfigDataAsync Maven / Gradle / Ivy
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.appconfigdata;
import javax.annotation.Generated;
import com.amazonaws.services.appconfigdata.model.*;
/**
* Interface for accessing AWS AppConfig Data asynchronously. Each asynchronous method will return a Java Future object
* representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive
* notification when an asynchronous operation completes.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.appconfigdata.AbstractAWSAppConfigDataAsync} 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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSAppConfigDataAsync extends AWSAppConfigData {
/**
*
* 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.
*
*
*
*
*
* @param getLatestConfigurationRequest
* @return A Java Future containing the result of the GetLatestConfiguration operation returned by the service.
* @sample AWSAppConfigDataAsync.GetLatestConfiguration
* @see AWS API Documentation
*/
java.util.concurrent.Future getLatestConfigurationAsync(GetLatestConfigurationRequest getLatestConfigurationRequest);
/**
*
* 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.
*
*
*
*
*
* @param getLatestConfigurationRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetLatestConfiguration operation returned by the service.
* @sample AWSAppConfigDataAsyncHandler.GetLatestConfiguration
* @see AWS API Documentation
*/
java.util.concurrent.Future getLatestConfigurationAsync(GetLatestConfigurationRequest getLatestConfigurationRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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 A Java Future containing the result of the StartConfigurationSession operation returned by the service.
* @sample AWSAppConfigDataAsync.StartConfigurationSession
* @see AWS API Documentation
*/
java.util.concurrent.Future startConfigurationSessionAsync(
StartConfigurationSessionRequest startConfigurationSessionRequest);
/**
*
* 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
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the StartConfigurationSession operation returned by the service.
* @sample AWSAppConfigDataAsyncHandler.StartConfigurationSession
* @see AWS API Documentation
*/
java.util.concurrent.Future startConfigurationSessionAsync(
StartConfigurationSessionRequest startConfigurationSessionRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}