configurations

Creates, updates, deletes, gets or lists a configurations resource.

Overview

Name	configurations
Type	Resource
Id	aws.appconfig.configurations

Fields

The following fields are returned by SELECT queries:

get_configuration

Name	Datatype	Description
configuration_version	string	The configuration version.
content	string (byte)	The content of the configuration or the configuration data. The Content attribute only contains data if the system finds new or updated configuration data. If there is no new or updated data and ClientConfigurationVersion matches the version of the current configuration, AppConfig returns a 204 No Content HTTP response code and the Content value will be empty.
content_type	string	A standard MIME type describing the format of the configuration content. For more information, see Content-Type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_configuration	select	application, environment, configuration, client_id, region	client_configuration_version	(Deprecated) Retrieves the latest deployed configuration. Note the following important information. This API action is deprecated. Calls to receive configuration data should use the StartConfigurationSession and GetLatestConfiguration APIs instead. GetConfiguration is a priced call. For more information, see Pricing.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
application	string	The application to get. Specify either the application name or the application ID.
client_id	string	The clientId parameter in the following command is a unique, user-specified ID to identify the client for the configuration. This ID enables AppConfig to deploy the configuration in intervals, as defined in the deployment strategy.
configuration	string	The configuration to get. Specify either the configuration name or the configuration ID.
environment	string	The environment to get. Specify either the environment name or the environment ID.
region	string	AWS region (default: us-east-1)
client_configuration_version	string	The configuration version returned in the most recent GetConfiguration response. 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 you use the StartConfigurationSession and GetLatestConfiguration APIs, which track the client configuration version on your behalf. If you choose to continue using GetConfiguration, we recommend that you include the ClientConfigurationVersion value with every call to GetConfiguration. The value to use for ClientConfigurationVersion comes from the ConfigurationVersion attribute returned by GetConfiguration when there is new or updated data, and should be saved for subsequent calls to GetConfiguration. For more information about working with configurations, see Retrieving feature flags and configuration data in AppConfig in the AppConfig User Guide.

SELECT examples

get_configuration

(Deprecated) Retrieves the latest deployed configuration. Note the following important information. This API action is deprecated. Calls to receive configuration data should use the StartConfigurationSession and GetLatestConfiguration APIs instead. GetConfiguration is a priced call. For more information, see Pricing.

SELECT
configuration_version,
content,
content_type
FROM aws.appconfig.configurations
WHERE application = '{{ application }}' -- required
AND environment = '{{ environment }}' -- required
AND configuration = '{{ configuration }}' -- required
AND client_id = '{{ client_id }}' -- required
AND region = '{{ region }}' -- required
AND client_configuration_version = '{{ client_configuration_version }}'
;