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 |
Synopsis
- getLatestConfiguration_configurationToken :: Lens' GetLatestConfiguration Text
- getLatestConfigurationResponse_configuration :: Lens' GetLatestConfigurationResponse (Maybe ByteString)
- getLatestConfigurationResponse_contentType :: Lens' GetLatestConfigurationResponse (Maybe Text)
- getLatestConfigurationResponse_nextPollConfigurationToken :: Lens' GetLatestConfigurationResponse (Maybe Text)
- getLatestConfigurationResponse_nextPollIntervalInSeconds :: Lens' GetLatestConfigurationResponse (Maybe Int)
- getLatestConfigurationResponse_httpStatus :: Lens' GetLatestConfigurationResponse Int
- startConfigurationSession_requiredMinimumPollIntervalInSeconds :: Lens' StartConfigurationSession (Maybe Natural)
- startConfigurationSession_applicationIdentifier :: Lens' StartConfigurationSession Text
- startConfigurationSession_environmentIdentifier :: Lens' StartConfigurationSession Text
- startConfigurationSession_configurationProfileIdentifier :: Lens' StartConfigurationSession Text
- startConfigurationSessionResponse_initialConfigurationToken :: Lens' StartConfigurationSessionResponse (Maybe Text)
- startConfigurationSessionResponse_httpStatus :: Lens' StartConfigurationSessionResponse Int
Operations
GetLatestConfiguration
getLatestConfiguration_configurationToken :: Lens' GetLatestConfiguration Text Source #
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.
getLatestConfigurationResponse_configuration :: Lens' GetLatestConfigurationResponse (Maybe ByteString) Source #
The data of the configuration. This may be empty if the client already has the latest version of configuration.
getLatestConfigurationResponse_contentType :: Lens' GetLatestConfigurationResponse (Maybe Text) Source #
A standard MIME type describing the format of the configuration content.
getLatestConfigurationResponse_nextPollConfigurationToken :: Lens' GetLatestConfigurationResponse (Maybe Text) Source #
The latest token describing the current state of the configuration
session. This MUST be provided to the next call to
GetLatestConfiguration.
getLatestConfigurationResponse_nextPollIntervalInSeconds :: Lens' GetLatestConfigurationResponse (Maybe Int) Source #
The amount of time the client should wait before polling for
configuration updates again. Use RequiredMinimumPollIntervalInSeconds
to set the desired poll interval.
getLatestConfigurationResponse_httpStatus :: Lens' GetLatestConfigurationResponse Int Source #
The response's http status code.
StartConfigurationSession
startConfigurationSession_requiredMinimumPollIntervalInSeconds :: Lens' StartConfigurationSession (Maybe Natural) Source #
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.
startConfigurationSession_applicationIdentifier :: Lens' StartConfigurationSession Text Source #
The application ID or the application name.
startConfigurationSession_environmentIdentifier :: Lens' StartConfigurationSession Text Source #
The environment ID or the environment name.
startConfigurationSession_configurationProfileIdentifier :: Lens' StartConfigurationSession Text Source #
The configuration profile ID or the configuration profile name.
startConfigurationSessionResponse_initialConfigurationToken :: Lens' StartConfigurationSessionResponse (Maybe Text) Source #
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
.
startConfigurationSessionResponse_httpStatus :: Lens' StartConfigurationSessionResponse Int Source #
The response's http status code.