Implementation for accessing AppConfigData
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: theConfigurationTokenvalue to use on the next call toGetLatestConfiguration. -
NextPollIntervalInSeconds: the duration the client should wait before making its next call toGetLatestConfiguration. This duration may vary over the course of the session, so it should be used instead of the value sent on theStartConfigurationSessioncall. -
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.
Inheritance Hierarchy
Namespace: Amazon.AppConfigData
Assembly: AWSSDK.AppConfigData.dll
Version: 3.x.y.z
Syntax
public class AmazonAppConfigDataClient : AmazonServiceClient IAmazonAppConfigData, IAmazonService, IDisposable
The AmazonAppConfigDataClient type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
AmazonAppConfigDataClient() |
Constructs AmazonAppConfigDataClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSProfileName" value="AWS Default"/>
</appSettings>
</configuration>
|
|
|
AmazonAppConfigDataClient(RegionEndpoint) |
Constructs AmazonAppConfigDataClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSProfileName" value="AWS Default"/>
</appSettings>
</configuration>
|
|
|
AmazonAppConfigDataClient(AmazonAppConfigDataConfig) |
Constructs AmazonAppConfigDataClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSProfileName" value="AWS Default"/>
</appSettings>
</configuration>
|
|
|
AmazonAppConfigDataClient(AWSCredentials) |
Constructs AmazonAppConfigDataClient with AWS Credentials |
|
|
AmazonAppConfigDataClient(AWSCredentials, RegionEndpoint) |
Constructs AmazonAppConfigDataClient with AWS Credentials |
|
|
AmazonAppConfigDataClient(AWSCredentials, AmazonAppConfigDataConfig) |
Constructs AmazonAppConfigDataClient with AWS Credentials and an AmazonAppConfigDataClient Configuration object. |
|
|
AmazonAppConfigDataClient(string, string) |
Constructs AmazonAppConfigDataClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonAppConfigDataClient(string, string, RegionEndpoint) |
Constructs AmazonAppConfigDataClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonAppConfigDataClient(string, string, AmazonAppConfigDataConfig) |
Constructs AmazonAppConfigDataClient with AWS Access Key ID, AWS Secret Key and an AmazonAppConfigDataClient Configuration object. |
|
|
AmazonAppConfigDataClient(string, string, string) |
Constructs AmazonAppConfigDataClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonAppConfigDataClient(string, string, string, RegionEndpoint) |
Constructs AmazonAppConfigDataClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonAppConfigDataClient(string, string, string, AmazonAppConfigDataConfig) |
Constructs AmazonAppConfigDataClient with AWS Access Key ID, AWS Secret Key and an AmazonAppConfigDataClient Configuration object. |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
Config | Amazon.Runtime.IClientConfig | Inherited from Amazon.Runtime.AmazonServiceClient. |
Methods
| Name | Description | |
|---|---|---|
|
|
DetermineServiceOperationEndpoint(AmazonWebServiceRequest) |
Returns the endpoint that will be used for a particular request. |
|
|
Dispose() | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
GetLatestConfiguration(GetLatestConfigurationRequest) |
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
|
|
|
GetLatestConfigurationAsync(GetLatestConfigurationRequest, CancellationToken) |
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
|
|
|
StartConfigurationSession(StartConfigurationSessionRequest) |
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. |
|
|
StartConfigurationSessionAsync(StartConfigurationSessionRequest, CancellationToken) |
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. |
Events
| Name | Description | |
|---|---|---|
|
|
AfterResponseEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
BeforeRequestEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
ExceptionEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5