/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.appconfigdata; import org.w3c.dom.*; import java.net.*; import java.util.*; import javax.annotation.Generated; import org.apache.commons.logging.*; import com.amazonaws.*; import com.amazonaws.annotation.SdkInternalApi; import com.amazonaws.auth.*; import com.amazonaws.handlers.*; import com.amazonaws.http.*; import com.amazonaws.internal.*; import com.amazonaws.internal.auth.*; import com.amazonaws.metrics.*; import com.amazonaws.regions.*; import com.amazonaws.transform.*; import com.amazonaws.util.*; import com.amazonaws.protocol.json.*; import com.amazonaws.util.AWSRequestMetrics.Field; import com.amazonaws.annotation.ThreadSafe; import com.amazonaws.client.AwsSyncClientParams; import com.amazonaws.client.builder.AdvancedConfig; import com.amazonaws.services.appconfigdata.AWSAppConfigDataClientBuilder; import com.amazonaws.AmazonServiceException; import com.amazonaws.services.appconfigdata.model.*; import com.amazonaws.services.appconfigdata.model.transform.*; /** * 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.
*
* 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.
*
* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientParams * Object providing client parameters. */ AWSAppConfigDataClient(AwsSyncClientParams clientParams) { this(clientParams, false); } /** * Constructs a new client to invoke service methods on AWS AppConfig Data using the specified parameters. * *
* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientParams * Object providing client parameters. */ AWSAppConfigDataClient(AwsSyncClientParams clientParams, boolean endpointDiscoveryEnabled) { super(clientParams); this.awsCredentialsProvider = clientParams.getCredentialsProvider(); this.advancedConfig = clientParams.getAdvancedConfig(); init(); } private void init() { setServiceNameIntern(DEFAULT_SIGNING_NAME); setEndpointPrefix(ENDPOINT_PREFIX); // calling this.setEndPoint(...) will also modify the signer accordingly setEndpoint("appconfigdata.us-east-1.amazonaws.com"); HandlerChainFactory chainFactory = new HandlerChainFactory(); requestHandler2s.addAll(chainFactory.newRequestHandlerChain("/com/amazonaws/services/appconfigdata/request.handlers")); requestHandler2s.addAll(chainFactory.newRequestHandler2Chain("/com/amazonaws/services/appconfigdata/request.handler2s")); requestHandler2s.addAll(chainFactory.getGlobalHandlers()); } /** *
* 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.
*
* 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. *
* * @param startConfigurationSessionRequest * @return Result of the StartConfigurationSession operation returned by the service. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ResourceNotFoundException * The requested resource could not be found. * @throws BadRequestException * The input fails to satisfy the constraints specified by the service. * @throws InternalServerException * There was an internal failure in the service. * @sample AWSAppConfigData.StartConfigurationSession * @see AWS API Documentation */ @Override public StartConfigurationSessionResult startConfigurationSession(StartConfigurationSessionRequest request) { request = beforeClientExecution(request); return executeStartConfigurationSession(request); } @SdkInternalApi final StartConfigurationSessionResult executeStartConfigurationSession(StartConfigurationSessionRequest startConfigurationSessionRequest) { ExecutionContext executionContext = createExecutionContext(startConfigurationSessionRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request
* 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.
*
* @param request
* The originally executed request
*
* @return The response metadata for the specified request, or null if none is available.
*/
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request) {
return client.getResponseMetadataForRequest(request);
}
/**
* Normal invoke with authentication. Credentials are required and may be overriden at the request level.
**/
private