Service object for interacting with AWS AppConfigData service.
public struct AppConfigData: AWSService
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.
StartConfigurationSession, your code sends the following
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
In response, AppConfig provides an
InitialConfigurationToken to be given to
the session's client and used the first time it calls
for that session.
GetLatestConfiguration, your client code sends the most recent
ConfigurationToken value it has and receives in response:
ConfigurationTokenvalue to use on the next call to
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
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
GetLatestConfiguration API actions, see Receiving the
configuration in the AppConfig User Guide.
Initialize the AppConfigData client
public init( client: AWSClient, region: SotoCore.Region? = nil, partition: AWSPartition = .aws, endpoint: String? = nil, timeout: TimeAmount? = nil, byteBufferAllocator: ByteBufferAllocator = ByteBufferAllocator(), options: AWSServiceConfig.Options =  )
- client: AWSClient used to process requests
- region: Region of server you want to communicate with. This will override the partition parameter.
- partition: AWS partition where service resides, standard (.aws), china (.awscn), government (.awsusgov).
- endpoint: Custom endpoint URL to use instead of standard AWS servers
- timeout: Timeout value for HTTP requests
Initializer required by
AWSService.with(middlewares:timeout:byteBufferAllocator:options). You are not able to use this initializer directly as there are no public initializers for
AWSServiceConfig.Patch. Please use
public init(from: AppConfigData, patch: AWSServiceConfig.Patch)
Client used for communication with AWS
public let client: AWSClient
public let config: AWSServiceConfig
public func getLatestConfiguration(_ input: GetLatestConfigurationRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetLatestConfigurationResponse>
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 Receiving the configuration in the AppConfig User Guide.
Note the following important information.
Each configuration token is only valid for one call to
GetLatestConfigurationresponse includes a
NextPollConfigurationTokenthat should always replace the token used for the just-completed call in preparation for the next one.
GetLatestConfigurationis a priced call. For more information, see Pricing.
public func startConfigurationSession(_ input: StartConfigurationSessionRequest, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<StartConfigurationSessionResponse>
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 Receiving the configuration in the AppConfig User Guide.