| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.AppConfigData
Description
Derived from API version 2021-11-11 of the AWS service descriptions, licensed under Apache 2.0.
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: 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.
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.
Synopsis
- defaultService :: Service
- _BadRequestException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- data GetLatestConfiguration = GetLatestConfiguration' Text
- newGetLatestConfiguration :: Text -> GetLatestConfiguration
- data GetLatestConfigurationResponse = GetLatestConfigurationResponse' (Maybe (Sensitive ByteString)) (Maybe Text) (Maybe Text) (Maybe Int) Int
- newGetLatestConfigurationResponse :: Int -> GetLatestConfigurationResponse
- data StartConfigurationSession = StartConfigurationSession' (Maybe Natural) Text Text Text
- newStartConfigurationSession :: Text -> Text -> Text -> StartConfigurationSession
- data StartConfigurationSessionResponse = StartConfigurationSessionResponse' (Maybe Text) Int
- newStartConfigurationSessionResponse :: Int -> StartConfigurationSessionResponse
Service Configuration
defaultService :: Service Source #
API version 2021-11-11 of the Amazon AppConfig Data SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by AppConfigData.
BadRequestException
_BadRequestException :: AsError a => Fold a ServiceError Source #
The input fails to satisfy the constraints specified by the service.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
There was an internal failure in the service.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The requested resource could not be found.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The request was denied due to request throttling.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
GetLatestConfiguration
data GetLatestConfiguration Source #
See: newGetLatestConfiguration smart constructor.
Constructors
| GetLatestConfiguration' Text |
Instances
newGetLatestConfiguration Source #
Create a value of GetLatestConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:configurationToken:GetLatestConfiguration', getLatestConfiguration_configurationToken - Token describing the current state of the configuration session. To
obtain a token, first call the StartConfigurationSession API. Note that
every call to GetLatestConfiguration will return a new
ConfigurationToken (NextPollConfigurationToken in the response) and
MUST be provided to subsequent GetLatestConfiguration API calls.
data GetLatestConfigurationResponse Source #
See: newGetLatestConfigurationResponse smart constructor.
Constructors
| GetLatestConfigurationResponse' (Maybe (Sensitive ByteString)) (Maybe Text) (Maybe Text) (Maybe Int) Int |
Instances
newGetLatestConfigurationResponse Source #
Create a value of GetLatestConfigurationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:configuration:GetLatestConfigurationResponse', getLatestConfigurationResponse_configuration - The data of the configuration. This may be empty if the client already
has the latest version of configuration.
$sel:contentType:GetLatestConfigurationResponse', getLatestConfigurationResponse_contentType - A standard MIME type describing the format of the configuration content.
$sel:nextPollConfigurationToken:GetLatestConfigurationResponse', getLatestConfigurationResponse_nextPollConfigurationToken - The latest token describing the current state of the configuration
session. This MUST be provided to the next call to
GetLatestConfiguration.
$sel:nextPollIntervalInSeconds:GetLatestConfigurationResponse', getLatestConfigurationResponse_nextPollIntervalInSeconds - The amount of time the client should wait before polling for
configuration updates again. Use RequiredMinimumPollIntervalInSeconds
to set the desired poll interval.
$sel:httpStatus:GetLatestConfigurationResponse', getLatestConfigurationResponse_httpStatus - The response's http status code.
StartConfigurationSession
data StartConfigurationSession Source #
See: newStartConfigurationSession smart constructor.
Instances
newStartConfigurationSession Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text |
|
| -> StartConfigurationSession |
Create a value of StartConfigurationSession with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:requiredMinimumPollIntervalInSeconds:StartConfigurationSession', startConfigurationSession_requiredMinimumPollIntervalInSeconds - Sets a constraint on a session. If you specify a value of, for example,
60 seconds, then the client that established the session can't call
GetLatestConfiguration more frequently then every 60 seconds.
$sel:applicationIdentifier:StartConfigurationSession', startConfigurationSession_applicationIdentifier - The application ID or the application name.
$sel:environmentIdentifier:StartConfigurationSession', startConfigurationSession_environmentIdentifier - The environment ID or the environment name.
$sel:configurationProfileIdentifier:StartConfigurationSession', startConfigurationSession_configurationProfileIdentifier - The configuration profile ID or the configuration profile name.
data StartConfigurationSessionResponse Source #
See: newStartConfigurationSessionResponse smart constructor.
Constructors
| StartConfigurationSessionResponse' (Maybe Text) Int |
Instances
newStartConfigurationSessionResponse Source #
Arguments
| :: Int | |
| -> StartConfigurationSessionResponse |
Create a value of StartConfigurationSessionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:initialConfigurationToken:StartConfigurationSessionResponse', startConfigurationSessionResponse_initialConfigurationToken - Token encapsulating state about the configuration session. Provide this
token to the GetLatestConfiguration API to retrieve configuration
data.
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.
$sel:httpStatus:StartConfigurationSessionResponse', startConfigurationSessionResponse_httpStatus - The response's http status code.