software.amazon.awssdk.services.appconfigdata

Interface AppConfigDataClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

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

Service client for accessing AWS AppConfig Data. This can be created using the static builder() method.

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

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

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.

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

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

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

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

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. See the GetLatestConfiguration API for more details.

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

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

serviceMetadata

static ServiceMetadata serviceMetadata()