Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.AppConfig.GetConfiguration

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Receive information about a configuration.

AWS AppConfig uses the value of the ClientConfigurationVersion parameter to identify the configuration version on your clients. If you don’t send ClientConfigurationVersion with each call to GetConfiguration, your clients receive the current configuration. You are charged each time your clients receive a configuration.

To avoid excess charges, we recommend that you include the ClientConfigurationVersion value with every call to GetConfiguration. This value must be saved on your client. Subsequent calls to GetConfiguration must pass this value by using the ClientConfigurationVersion parameter.

Synopsis

data GetConfiguration = GetConfiguration' {
- clientConfigurationVersion :: Maybe Text
- application :: Text
- environment :: Text
- configuration :: Text
- clientId :: Text
}
newGetConfiguration :: Text -> Text -> Text -> Text -> GetConfiguration
getConfiguration_clientConfigurationVersion :: Lens' GetConfiguration (Maybe Text)
getConfiguration_application :: Lens' GetConfiguration Text
getConfiguration_environment :: Lens' GetConfiguration Text
getConfiguration_configuration :: Lens' GetConfiguration Text
getConfiguration_clientId :: Lens' GetConfiguration Text
data GetConfigurationResponse = GetConfigurationResponse' {
- configurationVersion :: Maybe Text
- content :: Maybe (Sensitive ByteString)
- contentType :: Maybe Text
- httpStatus :: Int
}
newGetConfigurationResponse :: Int -> GetConfigurationResponse
getConfigurationResponse_configurationVersion :: Lens' GetConfigurationResponse (Maybe Text)
getConfigurationResponse_content :: Lens' GetConfigurationResponse (Maybe ByteString)
getConfigurationResponse_contentType :: Lens' GetConfigurationResponse (Maybe Text)
getConfigurationResponse_httpStatus :: Lens' GetConfigurationResponse Int

Creating a Request

data GetConfiguration Source #

See: newGetConfiguration smart constructor.

Constructors

GetConfiguration'

Fields

clientConfigurationVersion :: Maybe Text
The configuration version returned in the most recent GetConfiguration response.
AWS AppConfig uses the value of the ClientConfigurationVersion parameter to identify the configuration version on your clients. If you don’t send ClientConfigurationVersion with each call to GetConfiguration, your clients receive the current configuration. You are charged each time your clients receive a configuration.
To avoid excess charges, we recommend that you include the ClientConfigurationVersion value with every call to GetConfiguration. This value must be saved on your client. Subsequent calls to GetConfiguration must pass this value by using the ClientConfigurationVersion parameter.
For more information about working with configurations, see Retrieving the Configuration in the AWS AppConfig User Guide.
application :: Text
The application to get. Specify either the application name or the application ID.
environment :: Text
The environment to get. Specify either the environment name or the environment ID.
configuration :: Text
The configuration to get. Specify either the configuration name or the configuration ID.
clientId :: Text
A unique ID to identify the client for the configuration. This ID enables AppConfig to deploy the configuration in intervals, as defined in the deployment strategy.

Instances

Instances details

Eq GetConfiguration Source #
Instance details Defined in Amazonka.AppConfig.GetConfiguration Methods (==) :: GetConfiguration -> GetConfiguration -> Bool # (/=) :: GetConfiguration -> GetConfiguration -> Bool #
Read GetConfiguration Source #
Instance details Defined in Amazonka.AppConfig.GetConfiguration Methods readsPrec :: Int -> ReadS GetConfiguration # readList :: ReadS [GetConfiguration] # readPrec :: ReadPrec GetConfiguration # readListPrec :: ReadPrec [GetConfiguration] #
Show GetConfiguration Source #
Instance details Defined in Amazonka.AppConfig.GetConfiguration Methods showsPrec :: Int -> GetConfiguration -> ShowS # show :: GetConfiguration -> String # showList :: [GetConfiguration] -> ShowS #
Generic GetConfiguration Source #
Instance details Defined in Amazonka.AppConfig.GetConfiguration Associated Types type Rep GetConfiguration :: Type -> Type # Methods from :: GetConfiguration -> Rep GetConfiguration x # to :: Rep GetConfiguration x -> GetConfiguration #
NFData GetConfiguration Source #
Instance details Defined in Amazonka.AppConfig.GetConfiguration Methods rnf :: GetConfiguration -> () #
Hashable GetConfiguration Source #
Instance details Defined in Amazonka.AppConfig.GetConfiguration Methods hashWithSalt :: Int -> GetConfiguration -> Int # hash :: GetConfiguration -> Int #
AWSRequest GetConfiguration Source #
Instance details Defined in Amazonka.AppConfig.GetConfiguration Associated Types type AWSResponse GetConfiguration # Methods request :: GetConfiguration -> Request GetConfiguration # response :: MonadResource m => Logger -> Service -> Proxy GetConfiguration -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetConfiguration))) #
ToHeaders GetConfiguration Source #
Instance details Defined in Amazonka.AppConfig.GetConfiguration Methods toHeaders :: GetConfiguration -> [Header] #
ToPath GetConfiguration Source #
Instance details Defined in Amazonka.AppConfig.GetConfiguration Methods toPath :: GetConfiguration -> ByteString #
ToQuery GetConfiguration Source #
Instance details Defined in Amazonka.AppConfig.GetConfiguration Methods toQuery :: GetConfiguration -> QueryString #
type Rep GetConfiguration Source #
Instance details Defined in Amazonka.AppConfig.GetConfiguration type Rep GetConfiguration = D1 ('MetaData "GetConfiguration" "Amazonka.AppConfig.GetConfiguration" "libZSservicesZSamazonka-appconfigZSamazonka-appconfig" 'False) (C1 ('MetaCons "GetConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientConfigurationVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "application") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "environment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "clientId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse GetConfiguration Source #
Instance details Defined in Amazonka.AppConfig.GetConfiguration type AWSResponse GetConfiguration = GetConfigurationResponse

newGetConfiguration Source #

Arguments

:: Text	`$sel:application:GetConfiguration'`
-> Text	`$sel:environment:GetConfiguration'`
-> Text	`$sel:configuration:GetConfiguration'`
-> Text	`$sel:clientId:GetConfiguration'`
-> GetConfiguration

Create a value of GetConfiguration 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:clientConfigurationVersion:GetConfiguration', getConfiguration_clientConfigurationVersion - The configuration version returned in the most recent GetConfiguration response.

AWS AppConfig uses the value of the ClientConfigurationVersion parameter to identify the configuration version on your clients. If you don’t send ClientConfigurationVersion with each call to GetConfiguration, your clients receive the current configuration. You are charged each time your clients receive a configuration.

To avoid excess charges, we recommend that you include the ClientConfigurationVersion value with every call to GetConfiguration. This value must be saved on your client. Subsequent calls to GetConfiguration must pass this value by using the ClientConfigurationVersion parameter.

For more information about working with configurations, see Retrieving the Configuration in the AWS AppConfig User Guide.

$sel:application:GetConfiguration', getConfiguration_application - The application to get. Specify either the application name or the application ID.

$sel:environment:GetConfiguration', getConfiguration_environment - The environment to get. Specify either the environment name or the environment ID.

$sel:configuration:GetConfiguration', getConfiguration_configuration - The configuration to get. Specify either the configuration name or the configuration ID.

$sel:clientId:GetConfiguration', getConfiguration_clientId - A unique ID to identify the client for the configuration. This ID enables AppConfig to deploy the configuration in intervals, as defined in the deployment strategy.

Request Lenses

getConfiguration_clientConfigurationVersion :: Lens' GetConfiguration (Maybe Text) Source #

The configuration version returned in the most recent GetConfiguration response.

AWS AppConfig uses the value of the ClientConfigurationVersion parameter to identify the configuration version on your clients. If you don’t send ClientConfigurationVersion with each call to GetConfiguration, your clients receive the current configuration. You are charged each time your clients receive a configuration.

To avoid excess charges, we recommend that you include the ClientConfigurationVersion value with every call to GetConfiguration. This value must be saved on your client. Subsequent calls to GetConfiguration must pass this value by using the ClientConfigurationVersion parameter.

For more information about working with configurations, see Retrieving the Configuration in the AWS AppConfig User Guide.

getConfiguration_application :: Lens' GetConfiguration Text Source #

The application to get. Specify either the application name or the application ID.

getConfiguration_environment :: Lens' GetConfiguration Text Source #

The environment to get. Specify either the environment name or the environment ID.

getConfiguration_configuration :: Lens' GetConfiguration Text Source #

The configuration to get. Specify either the configuration name or the configuration ID.

getConfiguration_clientId :: Lens' GetConfiguration Text Source #

A unique ID to identify the client for the configuration. This ID enables AppConfig to deploy the configuration in intervals, as defined in the deployment strategy.

Destructuring the Response

data GetConfigurationResponse Source #

See: newGetConfigurationResponse smart constructor.

Constructors

GetConfigurationResponse'
Fields configurationVersion :: Maybe Text The configuration version. content :: Maybe (Sensitive ByteString) The content of the configuration or the configuration data. contentType :: Maybe Text A standard MIME type describing the format of the configuration content. For more information, see Content-Type. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq GetConfigurationResponse Source #
Instance details Defined in Amazonka.AppConfig.GetConfiguration Methods (==) :: GetConfigurationResponse -> GetConfigurationResponse -> Bool # (/=) :: GetConfigurationResponse -> GetConfigurationResponse -> Bool #
Show GetConfigurationResponse Source #
Instance details Defined in Amazonka.AppConfig.GetConfiguration Methods showsPrec :: Int -> GetConfigurationResponse -> ShowS # show :: GetConfigurationResponse -> String # showList :: [GetConfigurationResponse] -> ShowS #
Generic GetConfigurationResponse Source #
Instance details Defined in Amazonka.AppConfig.GetConfiguration Associated Types type Rep GetConfigurationResponse :: Type -> Type # Methods from :: GetConfigurationResponse -> Rep GetConfigurationResponse x # to :: Rep GetConfigurationResponse x -> GetConfigurationResponse #
NFData GetConfigurationResponse Source #
Instance details Defined in Amazonka.AppConfig.GetConfiguration Methods rnf :: GetConfigurationResponse -> () #
type Rep GetConfigurationResponse Source #
Instance details Defined in Amazonka.AppConfig.GetConfiguration type Rep GetConfigurationResponse = D1 ('MetaData "GetConfigurationResponse" "Amazonka.AppConfig.GetConfiguration" "libZSservicesZSamazonka-appconfigZSamazonka-appconfig" 'False) (C1 ('MetaCons "GetConfigurationResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "configurationVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive ByteString)))) :: (S1 ('MetaSel ('Just "contentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetConfigurationResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetConfigurationResponse'`
-> GetConfigurationResponse

Create a value of GetConfigurationResponse 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:configurationVersion:GetConfigurationResponse', getConfigurationResponse_configurationVersion - The configuration version.

$sel:content:GetConfigurationResponse', getConfigurationResponse_content - The content of the configuration or the configuration data.

$sel:contentType:GetConfigurationResponse', getConfigurationResponse_contentType - A standard MIME type describing the format of the configuration content. For more information, see Content-Type.

$sel:httpStatus:GetConfigurationResponse', getConfigurationResponse_httpStatus - The response's http status code.

Response Lenses

getConfigurationResponse_configurationVersion :: Lens' GetConfigurationResponse (Maybe Text) Source #

The configuration version.

getConfigurationResponse_content :: Lens' GetConfigurationResponse (Maybe ByteString) Source #

The content of the configuration or the configuration data.

getConfigurationResponse_contentType :: Lens' GetConfigurationResponse (Maybe Text) Source #

A standard MIME type describing the format of the configuration content. For more information, see Content-Type.

getConfigurationResponse_httpStatus :: Lens' GetConfigurationResponse Int Source #

The response's http status code.