software.amazon.awssdk.services.appconfigdata

Interface AppConfigDataClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
 @ThreadSafe
public interface AppConfigDataClient
extends AwsClient

Service client for accessing AWS AppConfig Data. This can be created using the static 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: 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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_METADATA_ID Value for looking up the service's metadata from the ServiceMetadataProvider.
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
static AppConfigDataClientBuilder	builder() Create a builder that can be used to configure and create a AppConfigDataClient.
static AppConfigDataClient	create() Create a AppConfigDataClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default GetLatestConfigurationResponse	getLatestConfiguration(Consumer<GetLatestConfigurationRequest.Builder> getLatestConfigurationRequest) Retrieves the latest deployed configuration.
default GetLatestConfigurationResponse	getLatestConfiguration(GetLatestConfigurationRequest getLatestConfigurationRequest) Retrieves the latest deployed configuration.
default AppConfigDataServiceClientConfiguration	serviceClientConfiguration()
static ServiceMetadata	serviceMetadata()
default StartConfigurationSessionResponse	startConfigurationSession(Consumer<StartConfigurationSessionRequest.Builder> startConfigurationSessionRequest) Starts a configuration session used to retrieve a deployed configuration.
default StartConfigurationSessionResponse	startConfigurationSession(StartConfigurationSessionRequest startConfigurationSessionRequest) Starts a configuration session used to retrieve a deployed configuration.

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

Constant Field Values

Method Detail

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

Parameters:

getLatestConfigurationRequest -

Returns:

Result of the GetLatestConfiguration operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling.

ResourceNotFoundException - The requested resource could not be found.

BadRequestException - The input fails to satisfy the constraints specified by the service.

InternalServerException - There was an internal failure in the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

AppConfigDataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

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

This is a convenience which creates an instance of the GetLatestConfigurationRequest.Builder avoiding the need to create one manually via GetLatestConfigurationRequest.builder()

Parameters:

getLatestConfigurationRequest - A Consumer that will call methods on GetLatestConfigurationRequest.Builder to create a request.

Returns:

Result of the GetLatestConfiguration operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling.

ResourceNotFoundException - The requested resource could not be found.

BadRequestException - The input fails to satisfy the constraints specified by the service.

InternalServerException - There was an internal failure in the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

AppConfigDataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

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.

Throws:

ThrottlingException - The request was denied due to request throttling.

ResourceNotFoundException - The requested resource could not be found.

BadRequestException - The input fails to satisfy the constraints specified by the service.

InternalServerException - There was an internal failure in the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

AppConfigDataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

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 via StartConfigurationSessionRequest.builder()

Parameters:

startConfigurationSessionRequest - A Consumer that will call methods on StartConfigurationSessionRequest.Builder to create a request.

Returns:

Result of the StartConfigurationSession operation returned by the service.

Throws:

ThrottlingException - The request was denied due to request throttling.

ResourceNotFoundException - The requested resource could not be found.

BadRequestException - The input fails to satisfy the constraints specified by the service.

InternalServerException - There was an internal failure in the service.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

AppConfigDataException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

create

static AppConfigDataClient create()

Create a AppConfigDataClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static AppConfigDataClientBuilder builder()

Create a builder that can be used to configure and create a AppConfigDataClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default AppConfigDataServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient