com.amazonaws.services.appconfigdata

Class AWSAppConfigDataClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.appconfigdata.AWSAppConfigDataClient

All Implemented Interfaces:

AWSAppConfigData

Direct Known Subclasses:

AWSAppConfigDataAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSAppConfigDataClient
extends AmazonWebServiceClient
implements AWSAppConfigData

Client for accessing AWS AppConfig Data. All service calls made using this client are blocking, and will not return until the service call completes.

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.

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.

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 Receiving the configuration in the AppConfig User Guide.

Field Summary

Fields

Modifier and Type	Field and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.appconfigdata.AWSAppConfigData

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSAppConfigDataClientBuilder	builder()
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.
GetLatestConfigurationResult	getLatestConfiguration(GetLatestConfigurationRequest request) Retrieves the latest deployed configuration.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartConfigurationSessionResult	startConfigurationSession(StartConfigurationSessionRequest request) Starts a configuration session used to retrieve a deployed configuration.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AWSAppConfigDataClientBuilder builder()

getLatestConfiguration

public GetLatestConfigurationResult getLatestConfiguration(GetLatestConfigurationRequest request)

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

Specified by:

getLatestConfiguration in interface AWSAppConfigData

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.

See Also:

AWS API Documentation

startConfigurationSession

public StartConfigurationSessionResult startConfigurationSession(StartConfigurationSessionRequest request)

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 Receiving the configuration in the AppConfig User Guide.

Specified by:

startConfigurationSession in interface AWSAppConfigData

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.

See Also:

AWS API Documentation

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSAppConfigData

Parameters:

request - The originally executed request

Returns:

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

shutdown

public void shutdown()

Description copied from interface: AWSAppConfigData

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.

Specified by:

shutdown in interface AWSAppConfigData

Overrides:

shutdown in class AmazonWebServiceClient