Crate aws_sdk_appconfigdata
source · [−]Expand description
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
: theConfigurationToken
value 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 theStartConfigurationSession
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.
Crate Organization
The entry point for most customers will be Client
. Client
exposes one method for each API offered
by the service.
Some APIs require complex or nested arguments. These exist in model
.
Lastly, errors that can be returned by the service are contained within error
. Error
defines a meta
error encompassing all possible errors that can be returned by the service.
The other modules within this crate are not required for normal usage.
Modules
Client and fluent builders for calling the service.
Configuration for the service.
Errors that can occur when calling the service.
Input structures for operations.
Base Middleware Stack
Data structures used by operation inputs/outputs.
All operations that this crate can perform.
Output structures for operations.
Re-exported types from supporting crates.
Structs
App name that can be configured with an AWS SDK client to become part of the user agent string.
Client for AWS AppConfig Data
Service config.
AWS SDK Credentials
API Endpoint
The region to send requests to.
Retry configuration for requests.
Enums
All possible error types for this service.
Statics
Crate version number.