-- Hoogle documentation, generated by Haddock -- See Hoogle, http://www.haskell.org/hoogle/ -- | Amazon AppConfig Data SDK. -- -- Derived from API version 2021-11-11 of the AWS service -- descriptions, licensed under Apache 2.0. -- -- The types from this library are intended to be used with -- amazonka, which provides mechanisms for specifying AuthN/AuthZ -- information, sending requests, and receiving responses. -- -- It is recommended to use generic lenses or optics from packages such -- as generic-lens or optics to modify optional fields and -- deconstruct responses. -- -- Generated lenses can be found in Amazonka.AppConfigData.Lens -- and are suitable for use with a lens package such as lens or -- lens-family-core. -- -- See Amazonka.AppConfigData and the AWS documentation to -- get started. @package amazonka-appconfigdata @version 2.0 module Amazonka.AppConfigData.Types -- | API version 2021-11-11 of the Amazon AppConfig Data SDK -- configuration. defaultService :: Service -- | The input fails to satisfy the constraints specified by the service. _BadRequestException :: AsError a => Fold a ServiceError -- | There was an internal failure in the service. _InternalServerException :: AsError a => Fold a ServiceError -- | The requested resource could not be found. _ResourceNotFoundException :: AsError a => Fold a ServiceError -- | The request was denied due to request throttling. _ThrottlingException :: AsError a => Fold a ServiceError -- | 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. module Amazonka.AppConfigData.StartConfigurationSession -- | See: newStartConfigurationSession smart constructor. data StartConfigurationSession StartConfigurationSession' :: Maybe Natural -> Text -> Text -> Text -> StartConfigurationSession -- | 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:requiredMinimumPollIntervalInSeconds:StartConfigurationSession'] :: StartConfigurationSession -> Maybe Natural -- | The application ID or the application name. [$sel:applicationIdentifier:StartConfigurationSession'] :: StartConfigurationSession -> Text -- | The environment ID or the environment name. [$sel:environmentIdentifier:StartConfigurationSession'] :: StartConfigurationSession -> Text -- | The configuration profile ID or the configuration profile name. [$sel:configurationProfileIdentifier:StartConfigurationSession'] :: StartConfigurationSession -> Text -- | 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. newStartConfigurationSession :: Text -> Text -> Text -> StartConfigurationSession -- | 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_requiredMinimumPollIntervalInSeconds :: Lens' StartConfigurationSession (Maybe Natural) -- | The application ID or the application name. startConfigurationSession_applicationIdentifier :: Lens' StartConfigurationSession Text -- | The environment ID or the environment name. startConfigurationSession_environmentIdentifier :: Lens' StartConfigurationSession Text -- | The configuration profile ID or the configuration profile name. startConfigurationSession_configurationProfileIdentifier :: Lens' StartConfigurationSession Text -- | See: newStartConfigurationSessionResponse smart -- constructor. data StartConfigurationSessionResponse StartConfigurationSessionResponse' :: Maybe Text -> Int -> StartConfigurationSessionResponse -- | 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:initialConfigurationToken:StartConfigurationSessionResponse'] :: StartConfigurationSessionResponse -> Maybe Text -- | The response's http status code. [$sel:httpStatus:StartConfigurationSessionResponse'] :: StartConfigurationSessionResponse -> Int -- | 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. newStartConfigurationSessionResponse :: Int -> StartConfigurationSessionResponse -- | 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_initialConfigurationToken :: Lens' StartConfigurationSessionResponse (Maybe Text) -- | The response's http status code. startConfigurationSessionResponse_httpStatus :: Lens' StartConfigurationSessionResponse Int instance GHC.Generics.Generic Amazonka.AppConfigData.StartConfigurationSession.StartConfigurationSession instance GHC.Show.Show Amazonka.AppConfigData.StartConfigurationSession.StartConfigurationSession instance GHC.Read.Read Amazonka.AppConfigData.StartConfigurationSession.StartConfigurationSession instance GHC.Classes.Eq Amazonka.AppConfigData.StartConfigurationSession.StartConfigurationSession instance GHC.Generics.Generic Amazonka.AppConfigData.StartConfigurationSession.StartConfigurationSessionResponse instance GHC.Show.Show Amazonka.AppConfigData.StartConfigurationSession.StartConfigurationSessionResponse instance GHC.Read.Read Amazonka.AppConfigData.StartConfigurationSession.StartConfigurationSessionResponse instance GHC.Classes.Eq Amazonka.AppConfigData.StartConfigurationSession.StartConfigurationSessionResponse instance Amazonka.Types.AWSRequest Amazonka.AppConfigData.StartConfigurationSession.StartConfigurationSession instance Control.DeepSeq.NFData Amazonka.AppConfigData.StartConfigurationSession.StartConfigurationSessionResponse instance Data.Hashable.Class.Hashable Amazonka.AppConfigData.StartConfigurationSession.StartConfigurationSession instance Control.DeepSeq.NFData Amazonka.AppConfigData.StartConfigurationSession.StartConfigurationSession instance Amazonka.Data.Headers.ToHeaders Amazonka.AppConfigData.StartConfigurationSession.StartConfigurationSession instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.AppConfigData.StartConfigurationSession.StartConfigurationSession instance Amazonka.Data.Path.ToPath Amazonka.AppConfigData.StartConfigurationSession.StartConfigurationSession instance Amazonka.Data.Query.ToQuery Amazonka.AppConfigData.StartConfigurationSession.StartConfigurationSession -- | 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. -- -- module Amazonka.AppConfigData.GetLatestConfiguration -- | See: newGetLatestConfiguration smart constructor. data GetLatestConfiguration GetLatestConfiguration' :: Text -> GetLatestConfiguration -- | 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. [$sel:configurationToken:GetLatestConfiguration'] :: GetLatestConfiguration -> Text -- | 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. newGetLatestConfiguration :: Text -> GetLatestConfiguration -- | 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. getLatestConfiguration_configurationToken :: Lens' GetLatestConfiguration Text -- | See: newGetLatestConfigurationResponse smart -- constructor. data GetLatestConfigurationResponse GetLatestConfigurationResponse' :: Maybe (Sensitive ByteString) -> Maybe Text -> Maybe Text -> Maybe Int -> Int -> GetLatestConfigurationResponse -- | The data of the configuration. This may be empty if the client already -- has the latest version of configuration. [$sel:configuration:GetLatestConfigurationResponse'] :: GetLatestConfigurationResponse -> Maybe (Sensitive ByteString) -- | A standard MIME type describing the format of the configuration -- content. [$sel:contentType:GetLatestConfigurationResponse'] :: GetLatestConfigurationResponse -> Maybe Text -- | The latest token describing the current state of the configuration -- session. This MUST be provided to the next call to -- GetLatestConfiguration. [$sel:nextPollConfigurationToken:GetLatestConfigurationResponse'] :: GetLatestConfigurationResponse -> Maybe Text -- | The amount of time the client should wait before polling for -- configuration updates again. Use -- RequiredMinimumPollIntervalInSeconds to set the desired poll -- interval. [$sel:nextPollIntervalInSeconds:GetLatestConfigurationResponse'] :: GetLatestConfigurationResponse -> Maybe Int -- | The response's http status code. [$sel:httpStatus:GetLatestConfigurationResponse'] :: GetLatestConfigurationResponse -> Int -- | 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. newGetLatestConfigurationResponse :: Int -> GetLatestConfigurationResponse -- | The data of the configuration. This may be empty if the client already -- has the latest version of configuration. getLatestConfigurationResponse_configuration :: Lens' GetLatestConfigurationResponse (Maybe ByteString) -- | A standard MIME type describing the format of the configuration -- content. getLatestConfigurationResponse_contentType :: Lens' GetLatestConfigurationResponse (Maybe Text) -- | The latest token describing the current state of the configuration -- session. This MUST be provided to the next call to -- GetLatestConfiguration. getLatestConfigurationResponse_nextPollConfigurationToken :: Lens' GetLatestConfigurationResponse (Maybe Text) -- | The amount of time the client should wait before polling for -- configuration updates again. Use -- RequiredMinimumPollIntervalInSeconds to set the desired poll -- interval. getLatestConfigurationResponse_nextPollIntervalInSeconds :: Lens' GetLatestConfigurationResponse (Maybe Int) -- | The response's http status code. getLatestConfigurationResponse_httpStatus :: Lens' GetLatestConfigurationResponse Int instance GHC.Generics.Generic Amazonka.AppConfigData.GetLatestConfiguration.GetLatestConfiguration instance GHC.Show.Show Amazonka.AppConfigData.GetLatestConfiguration.GetLatestConfiguration instance GHC.Read.Read Amazonka.AppConfigData.GetLatestConfiguration.GetLatestConfiguration instance GHC.Classes.Eq Amazonka.AppConfigData.GetLatestConfiguration.GetLatestConfiguration instance GHC.Generics.Generic Amazonka.AppConfigData.GetLatestConfiguration.GetLatestConfigurationResponse instance GHC.Show.Show Amazonka.AppConfigData.GetLatestConfiguration.GetLatestConfigurationResponse instance GHC.Classes.Eq Amazonka.AppConfigData.GetLatestConfiguration.GetLatestConfigurationResponse instance Amazonka.Types.AWSRequest Amazonka.AppConfigData.GetLatestConfiguration.GetLatestConfiguration instance Control.DeepSeq.NFData Amazonka.AppConfigData.GetLatestConfiguration.GetLatestConfigurationResponse instance Data.Hashable.Class.Hashable Amazonka.AppConfigData.GetLatestConfiguration.GetLatestConfiguration instance Control.DeepSeq.NFData Amazonka.AppConfigData.GetLatestConfiguration.GetLatestConfiguration instance Amazonka.Data.Headers.ToHeaders Amazonka.AppConfigData.GetLatestConfiguration.GetLatestConfiguration instance Amazonka.Data.Path.ToPath Amazonka.AppConfigData.GetLatestConfiguration.GetLatestConfiguration instance Amazonka.Data.Query.ToQuery Amazonka.AppConfigData.GetLatestConfiguration.GetLatestConfiguration module Amazonka.AppConfigData.Lens -- | 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. getLatestConfiguration_configurationToken :: Lens' GetLatestConfiguration Text -- | The data of the configuration. This may be empty if the client already -- has the latest version of configuration. getLatestConfigurationResponse_configuration :: Lens' GetLatestConfigurationResponse (Maybe ByteString) -- | A standard MIME type describing the format of the configuration -- content. getLatestConfigurationResponse_contentType :: Lens' GetLatestConfigurationResponse (Maybe Text) -- | The latest token describing the current state of the configuration -- session. This MUST be provided to the next call to -- GetLatestConfiguration. getLatestConfigurationResponse_nextPollConfigurationToken :: Lens' GetLatestConfigurationResponse (Maybe Text) -- | The amount of time the client should wait before polling for -- configuration updates again. Use -- RequiredMinimumPollIntervalInSeconds to set the desired poll -- interval. getLatestConfigurationResponse_nextPollIntervalInSeconds :: Lens' GetLatestConfigurationResponse (Maybe Int) -- | The response's http status code. getLatestConfigurationResponse_httpStatus :: Lens' GetLatestConfigurationResponse Int -- | 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_requiredMinimumPollIntervalInSeconds :: Lens' StartConfigurationSession (Maybe Natural) -- | The application ID or the application name. startConfigurationSession_applicationIdentifier :: Lens' StartConfigurationSession Text -- | The environment ID or the environment name. startConfigurationSession_environmentIdentifier :: Lens' StartConfigurationSession Text -- | The configuration profile ID or the configuration profile name. startConfigurationSession_configurationProfileIdentifier :: Lens' StartConfigurationSession Text -- | 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_initialConfigurationToken :: Lens' StartConfigurationSessionResponse (Maybe Text) -- | The response's http status code. startConfigurationSessionResponse_httpStatus :: Lens' StartConfigurationSessionResponse Int module Amazonka.AppConfigData.Waiters -- | 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: -- -- -- -- 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: -- -- -- -- 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. module Amazonka.AppConfigData -- | API version 2021-11-11 of the Amazon AppConfig Data SDK -- configuration. defaultService :: Service -- | The input fails to satisfy the constraints specified by the service. _BadRequestException :: AsError a => Fold a ServiceError -- | There was an internal failure in the service. _InternalServerException :: AsError a => Fold a ServiceError -- | The requested resource could not be found. _ResourceNotFoundException :: AsError a => Fold a ServiceError -- | The request was denied due to request throttling. _ThrottlingException :: AsError a => Fold a ServiceError -- | See: newGetLatestConfiguration smart constructor. data GetLatestConfiguration GetLatestConfiguration' :: Text -> GetLatestConfiguration -- | 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. newGetLatestConfiguration :: Text -> GetLatestConfiguration -- | See: newGetLatestConfigurationResponse smart -- constructor. data GetLatestConfigurationResponse GetLatestConfigurationResponse' :: Maybe (Sensitive ByteString) -> Maybe Text -> Maybe Text -> Maybe Int -> Int -> GetLatestConfigurationResponse -- | 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. newGetLatestConfigurationResponse :: Int -> GetLatestConfigurationResponse -- | See: newStartConfigurationSession smart constructor. data StartConfigurationSession StartConfigurationSession' :: Maybe Natural -> 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. newStartConfigurationSession :: Text -> Text -> Text -> StartConfigurationSession -- | See: newStartConfigurationSessionResponse smart -- constructor. data StartConfigurationSessionResponse StartConfigurationSessionResponse' :: Maybe Text -> 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. newStartConfigurationSessionResponse :: Int -> StartConfigurationSessionResponse