com.amazonaws.services.appconfigdata

Interface AWSAppConfigData

All Known Subinterfaces:

AWSAppConfigDataAsync

All Known Implementing Classes:

AbstractAWSAppConfigData, AbstractAWSAppConfigDataAsync, AWSAppConfigDataAsyncClient, AWSAppConfigDataClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSAppConfigData

Interface for accessing AWS AppConfig Data.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSAppConfigData instead.

Use the AppConfigData API, a capability of AWS AppConfig, to retrieve deployed configuration.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

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

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

getLatestConfiguration

GetLatestConfigurationResult getLatestConfiguration(GetLatestConfigurationRequest getLatestConfigurationRequest)

Retrieves the latest deployed configuration. This API may return empty Configuration data if the client already has the latest version. See StartConfigurationSession to obtain an InitialConfigurationToken to call this API.

Each call to GetLatestConfiguration returns a new ConfigurationToken (NextPollConfigurationToken in the response). This new token MUST be provided to the next call to GetLatestConfiguration when polling for configuration updates.

To avoid excess charges, we recommend that you include the ClientConfigurationVersion value with every call to GetConfiguration. This value must be saved on your client. Subsequent calls to GetConfiguration must pass this value by using the ClientConfigurationVersion parameter.

Parameters:

getLatestConfigurationRequest - Request parameters for the GetLatestConfiguration API

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

StartConfigurationSessionResult startConfigurationSession(StartConfigurationSessionRequest startConfigurationSessionRequest)

Starts a configuration session used to retrieve a deployed configuration. See the GetLatestConfiguration API for more details.

Parameters:

startConfigurationSessionRequest - Request parameters for the StartConfigurationSession API.

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

shutdown

void shutdown()

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.

getCachedResponseMetadata

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

Parameters:

request - The originally executed request.

Returns:

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