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.GetLatestConfiguration

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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 GetLatestConfiguration. The GetLatestConfiguration response includes a NextPollConfigurationToken that should always replace the token used for the just-completed call in preparation for the next one.
GetLatestConfiguration is a priced call. For more information, see Pricing.

Synopsis

Creating a Request

data GetLatestConfiguration Source #

See: newGetLatestConfiguration smart constructor.

Constructors

GetLatestConfiguration'
Fields configurationToken :: Text 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.

Instances

Instances details

ToHeaders GetLatestConfiguration Source #
Instance details Defined in Amazonka.AppConfigData.GetLatestConfiguration Methods toHeaders :: GetLatestConfiguration -> [Header] #
ToPath GetLatestConfiguration Source #
Instance details Defined in Amazonka.AppConfigData.GetLatestConfiguration Methods toPath :: GetLatestConfiguration -> ByteString #
ToQuery GetLatestConfiguration Source #
Instance details Defined in Amazonka.AppConfigData.GetLatestConfiguration Methods toQuery :: GetLatestConfiguration -> QueryString #
AWSRequest GetLatestConfiguration Source #
Instance details Defined in Amazonka.AppConfigData.GetLatestConfiguration Associated Types type AWSResponse GetLatestConfiguration # Methods request :: (Service -> Service) -> GetLatestConfiguration -> Request GetLatestConfiguration # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetLatestConfiguration -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetLatestConfiguration))) #
Generic GetLatestConfiguration Source #
Instance details Defined in Amazonka.AppConfigData.GetLatestConfiguration Associated Types type Rep GetLatestConfiguration :: Type -> Type # Methods from :: GetLatestConfiguration -> Rep GetLatestConfiguration x # to :: Rep GetLatestConfiguration x -> GetLatestConfiguration #
Read GetLatestConfiguration Source #
Instance details Defined in Amazonka.AppConfigData.GetLatestConfiguration Methods readsPrec :: Int -> ReadS GetLatestConfiguration # readList :: ReadS [GetLatestConfiguration] # readPrec :: ReadPrec GetLatestConfiguration # readListPrec :: ReadPrec [GetLatestConfiguration] #
Show GetLatestConfiguration Source #
Instance details Defined in Amazonka.AppConfigData.GetLatestConfiguration Methods showsPrec :: Int -> GetLatestConfiguration -> ShowS # show :: GetLatestConfiguration -> String # showList :: [GetLatestConfiguration] -> ShowS #
NFData GetLatestConfiguration Source #
Instance details Defined in Amazonka.AppConfigData.GetLatestConfiguration Methods rnf :: GetLatestConfiguration -> () #
Eq GetLatestConfiguration Source #
Instance details Defined in Amazonka.AppConfigData.GetLatestConfiguration Methods (==) :: GetLatestConfiguration -> GetLatestConfiguration -> Bool # (/=) :: GetLatestConfiguration -> GetLatestConfiguration -> Bool #
Hashable GetLatestConfiguration Source #
Instance details Defined in Amazonka.AppConfigData.GetLatestConfiguration Methods hashWithSalt :: Int -> GetLatestConfiguration -> Int # hash :: GetLatestConfiguration -> Int #
type AWSResponse GetLatestConfiguration Source #
Instance details Defined in Amazonka.AppConfigData.GetLatestConfiguration type AWSResponse GetLatestConfiguration = GetLatestConfigurationResponse
type Rep GetLatestConfiguration Source #
Instance details Defined in Amazonka.AppConfigData.GetLatestConfiguration type Rep GetLatestConfiguration = D1 ('MetaData "GetLatestConfiguration" "Amazonka.AppConfigData.GetLatestConfiguration" "amazonka-appconfigdata-2.0-4fFb59kQbZiI7zoxAdQXfi" 'False) (C1 ('MetaCons "GetLatestConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "configurationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetLatestConfiguration Source #

Arguments

:: Text	`$sel:configurationToken:GetLatestConfiguration'`
-> 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.

Request Lenses

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.

Destructuring the Response

data GetLatestConfigurationResponse Source #

See: newGetLatestConfigurationResponse smart constructor.

Constructors

GetLatestConfigurationResponse'

Fields

configuration :: Maybe (Sensitive ByteString)
The data of the configuration. This may be empty if the client already has the latest version of configuration.
contentType :: Maybe Text
A standard MIME type describing the format of the configuration content.
nextPollConfigurationToken :: Maybe Text
The latest token describing the current state of the configuration session. This MUST be provided to the next call to GetLatestConfiguration.
nextPollIntervalInSeconds :: Maybe Int
The amount of time the client should wait before polling for configuration updates again. Use RequiredMinimumPollIntervalInSeconds to set the desired poll interval.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetLatestConfigurationResponse Source #
Instance details Defined in Amazonka.AppConfigData.GetLatestConfiguration Associated Types type Rep GetLatestConfigurationResponse :: Type -> Type # Methods from :: GetLatestConfigurationResponse -> Rep GetLatestConfigurationResponse x # to :: Rep GetLatestConfigurationResponse x -> GetLatestConfigurationResponse #
Show GetLatestConfigurationResponse Source #
Instance details Defined in Amazonka.AppConfigData.GetLatestConfiguration Methods showsPrec :: Int -> GetLatestConfigurationResponse -> ShowS # show :: GetLatestConfigurationResponse -> String # showList :: [GetLatestConfigurationResponse] -> ShowS #
NFData GetLatestConfigurationResponse Source #
Instance details Defined in Amazonka.AppConfigData.GetLatestConfiguration Methods rnf :: GetLatestConfigurationResponse -> () #
Eq GetLatestConfigurationResponse Source #
Instance details Defined in Amazonka.AppConfigData.GetLatestConfiguration Methods (==) :: GetLatestConfigurationResponse -> GetLatestConfigurationResponse -> Bool # (/=) :: GetLatestConfigurationResponse -> GetLatestConfigurationResponse -> Bool #
type Rep GetLatestConfigurationResponse Source #
Instance details Defined in Amazonka.AppConfigData.GetLatestConfiguration type Rep GetLatestConfigurationResponse = D1 ('MetaData "GetLatestConfigurationResponse" "Amazonka.AppConfigData.GetLatestConfiguration" "amazonka-appconfigdata-2.0-4fFb59kQbZiI7zoxAdQXfi" 'False) (C1 ('MetaCons "GetLatestConfigurationResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive ByteString))) :: S1 ('MetaSel ('Just "contentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "nextPollConfigurationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "nextPollIntervalInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetLatestConfigurationResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetLatestConfigurationResponse'`
-> 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.

Response Lenses

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.