Interface AppConfigDataClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
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
: theConfigurationToken
value to use on the next call toGetLatestConfiguration
. -
NextPollIntervalInSeconds
: the duration the client should wait before making its next call toGetLatestConfiguration
. This duration may vary over the course of the session, so it should be used instead of the value sent on theStartConfigurationSession
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.
-
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 AppConfigDataClientBuilder
builder()
Create a builder that can be used to configure and create aAppConfigDataClient
.static AppConfigDataClient
create()
Create aAppConfigDataClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default GetLatestConfigurationResponse
getLatestConfiguration
(Consumer<GetLatestConfigurationRequest.Builder> getLatestConfigurationRequest) Retrieves the latest deployed configuration.default GetLatestConfigurationResponse
getLatestConfiguration
(GetLatestConfigurationRequest getLatestConfigurationRequest) Retrieves the latest deployed configuration.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
startConfigurationSession
(Consumer<StartConfigurationSessionRequest.Builder> startConfigurationSessionRequest) Starts a configuration session used to retrieve a deployed configuration.startConfigurationSession
(StartConfigurationSessionRequest startConfigurationSessionRequest) Starts a configuration session used to retrieve a deployed configuration.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
-
getLatestConfiguration
default GetLatestConfigurationResponse getLatestConfiguration(GetLatestConfigurationRequest getLatestConfigurationRequest) throws ThrottlingException, ResourceNotFoundException, BadRequestException, InternalServerException, AwsServiceException, SdkClientException, AppConfigDataException 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
. TheGetLatestConfiguration
response includes aNextPollConfigurationToken
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.
- Parameters:
getLatestConfigurationRequest
-- Returns:
- Result of the GetLatestConfiguration operation returned by the service.
- See Also:
-
-
getLatestConfiguration
default GetLatestConfigurationResponse getLatestConfiguration(Consumer<GetLatestConfigurationRequest.Builder> getLatestConfigurationRequest) throws ThrottlingException, ResourceNotFoundException, BadRequestException, InternalServerException, AwsServiceException, SdkClientException, AppConfigDataException 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
. TheGetLatestConfiguration
response includes aNextPollConfigurationToken
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.
This is a convenience which creates an instance of the
GetLatestConfigurationRequest.Builder
avoiding the need to create one manually viaGetLatestConfigurationRequest.builder()
- Parameters:
getLatestConfigurationRequest
- AConsumer
that will call methods onGetLatestConfigurationRequest.Builder
to create a request.- Returns:
- Result of the GetLatestConfiguration operation returned by the service.
- See Also:
-
-
startConfigurationSession
default StartConfigurationSessionResponse startConfigurationSession(StartConfigurationSessionRequest startConfigurationSessionRequest) throws ThrottlingException, ResourceNotFoundException, BadRequestException, InternalServerException, AwsServiceException, SdkClientException, AppConfigDataException 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.
- Parameters:
startConfigurationSessionRequest
-- Returns:
- Result of the StartConfigurationSession operation returned by the service.
- See Also:
-
startConfigurationSession
default StartConfigurationSessionResponse startConfigurationSession(Consumer<StartConfigurationSessionRequest.Builder> startConfigurationSessionRequest) throws ThrottlingException, ResourceNotFoundException, BadRequestException, InternalServerException, AwsServiceException, SdkClientException, AppConfigDataException 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.
This is a convenience which creates an instance of the
StartConfigurationSessionRequest.Builder
avoiding the need to create one manually viaStartConfigurationSessionRequest.builder()
- Parameters:
startConfigurationSessionRequest
- AConsumer
that will call methods onStartConfigurationSessionRequest.Builder
to create a request.- Returns:
- Result of the StartConfigurationSession operation returned by the service.
- See Also:
-
create
Create aAppConfigDataClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aAppConfigDataClient
. -
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
-