View Source AWS.AppConfig (aws-elixir v1.0.14)
AppConfig helps you safely change application behavior in production without redeploying code.
Using feature flags and dynamic free-form configurations, you can control how your application runs in real time. This approach reduces risk, accelerates releases, and enables faster responses to issues. You can gradually roll out new features to specific users, monitor their impact, and expand availability with confidence. You can also update block lists, allow lists, throttling limits, and logging levels instantly, allowing you to mitigate issues and fine-tune performance without a deployment.
AppConfig supports a broad spectrum of use cases:
*
Feature flags and toggles – Gradually release new capabilities to targeted users, monitor impact, and instantly roll back changes if issues occur.
*
Application tuning – Introduce changes safely in production, measure their effects, and refine behavior without redeploying code.
*
Allow list or block list – Control access to features or restrict specific users in real time, without modifying application code.
*
Centralized configuration storage – Manage configuration data consistently across workloads. AppConfig can deploy configuration from the AppConfig hosted configuration store, Secrets Manager, Systems Manager, Systems Manager Parameter Store, or Amazon S3.
how-appconfig-works
How AppConfig works
This section provides a high-level description of how AppConfig works and how you get started.
definitions
Definitions
1-identify-configuration-data-to-manage-in-appconfig
1. Identify configuration data to manage in AppConfig
Before creating a configuration profile, identify the configuration data in your code that you want to manage dynamically using AppConfig. Common examples include feature flags, allow and block lists, logging levels, service limits, and throttling rules. These values tend to change frequently and can cause issues if misconfigured.
If your configuration data already exists in cloud services such as Systems Manager Parameter Store or Amazon S3, you can use AppConfig to validate, deploy, and manage that data more effectively.
2-create-a-configuration-profile-in-appconfig
2. Create a configuration profile in AppConfig
A configuration profile defines how AppConfig locates and manages your configuration data. It includes a URI that points to the data source and a profile type.
AppConfig supports two profile types
Feature flags – Enable controlled feature releases, gradual rollouts, and testing in production.
Free-form configurations – Store and retrieve configuration data from external sources and update it without redeploying code.
Both profile types help decouple configuration from code, support continuous delivery, and reduce deployment risk.
You can also add optional validators to ensure that configuration data is syntactically and semantically correct. During deployment, AppConfig evaluates these validators and automatically rolls back changes if validation fails.
Each configuration profile is associated with an application, which acts as a logical container for your configuration resources. For more information about creating a configuration profile, see Creating a configuration profile in AppConfig in the the AppConfig User Guide.
3-deploy-configuration-data
3. Deploy configuration data
When you start a deployment, AppConfig:
Retrieves configuration data from the source defined in the configuration profile
Validates the data using the configured validators
Delivers the validated configuration to AppConfig Agent
The delivered configuration becomes the deployed version used by your application. For more information about deploying a configuration, see Deploying feature flags and configuration data in AppConfig.
4-retrieve-configuration-data
4. Retrieve configuration data
Your application retrieves configuration data by calling a local endpoint exposed by AppConfig Agent, which caches the deployed configuration. Retrieving data is a metered event. AppConfig Agent supports a variety of use cases, as described in How to use AppConfig Agent to retrieve configuration data.
If the agent is not suitable for your use case, your application can retrieve configuration data directly from AppConfig by calling the StartConfigurationSession and GetLatestConfiguration API actions.
For more information about retrieving a configuration, see Retrieving feature flags and configuration data in AppConfig.
This reference is intended to be used with the AppConfig User Guide.
Link to this section Summary
Functions
Creates an application.
Creates a configuration profile, which is information that enables AppConfig to access the configuration source.
Creates a deployment strategy that defines important criteria for rolling out your configuration to the designated targets.
Creates an environment.
Creates an experiment definition in AppConfig.
Creates an AppConfig extension.
When you create an extension or configure an Amazon Web Services authored extension, you associate the extension with an AppConfig application, environment, or configuration profile.
Creates a new configuration in the AppConfig hosted configuration store.
Deletes an application.
Deletes a configuration profile.
Deletes a deployment strategy.
Deletes an environment.
Deletes an experiment definition.
Deletes an AppConfig extension.
Deletes an extension association.
Deletes a version of a configuration from the AppConfig hosted configuration store.
Returns information about the status of the DeletionProtection
parameter.
Retrieves information about an application.
(Deprecated) Retrieves the latest deployed configuration.
Retrieves information about a configuration profile.
Retrieves information about a configuration deployment.
Retrieves information about a deployment strategy.
Retrieves information about an environment.
Retrieves information about an experiment definition.
Retrieves information about an experiment run, including its status, start time, and exposure settings.
Returns information about an AppConfig extension.
Returns information about an AppConfig extension association.
Retrieves information about a specific configuration version.
Lists all applications in your Amazon Web Services account.
Lists the configuration profiles for an application.
Lists deployment strategies.
Lists the deployments for an environment in descending deployment number order.
Lists the environments for an application.
Lists the experiment definitions for an account.
Lists the events for a specified experiment run.
Lists the experiment runs for a specified experiment definition.
Lists all AppConfig extension associations in the account.
Lists all custom and Amazon Web Services authored AppConfig extensions in the account.
Lists configurations stored in the AppConfig hosted configuration store by version.
Retrieves the list of key-value tags assigned to the resource.
Starts a deployment.
Starts an experiment run for the specified experiment definition.
Stops a deployment.
Stops a running experiment.
Assigns metadata to an AppConfig resource.
Deletes a tag key and value from an AppConfig resource.
Updates the value of the DeletionProtection parameter.
Updates an application.
Updates a configuration profile.
Updates a deployment strategy.
Updates an environment.
Updates an experiment definition.
Updates a running experiment.
Updates an AppConfig extension.
Updates an association.
Uses the validators in a configuration profile to validate a configuration.
Link to this section Functions
Creates an application.
In AppConfig, an application is simply an organizational construct like a folder. This organizational construct has a relationship with some unit of executable code. For example, you could create an application called MyMobileApp to organize and manage configuration data for a mobile application installed by your users.
create_configuration_profile(client, application_id, input, options \\ [])
View SourceCreates a configuration profile, which is information that enables AppConfig to access the configuration source.
Valid configuration sources include the following:
* Configuration data in YAML, JSON, and other formats stored in the AppConfig hosted configuration store
* Configuration data stored as objects in an Amazon Simple Storage Service (Amazon S3) bucket
* Pipelines stored in CodePipeline
* Secrets stored in Secrets Manager
* Standard and secure string parameters stored in Amazon Web Services Systems Manager Parameter Store
* Configuration data in SSM documents stored in the Systems Manager document store
A configuration profile includes the following information:
* The URI location of the configuration data.
* The Identity and Access Management (IAM) role that provides access to the configuration data.
* A validator for the configuration data. Available validators include either a JSON Schema or an Amazon Web Services Lambda function.
For more information, see Create a Configuration and a Configuration Profile in the AppConfig User Guide.
Creates a deployment strategy that defines important criteria for rolling out your configuration to the designated targets.
A deployment strategy includes the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time.
Creates an environment.
For each application, you define one or more environments. An
environment is a deployment group of AppConfig targets, such as applications in
a
Beta or Production environment. You can also define
environments for application subcomponents such as the Web,
Mobile and Back-end components for your application. You can
configure Amazon CloudWatch alarms for each environment. The system monitors
alarms during a
configuration deployment. If an alarm is triggered, the system rolls back the
configuration.
create_experiment_definition(client, application_identifier, input, options \\ [])
View SourceCreates an experiment definition in AppConfig.
An experiment definition describes the purpose, scope, and operational configuration of an experiment, including the target audience, feature flag, and treatment configurations.
Creates an AppConfig extension.
An extension augments your ability to inject logic or behavior at different points during the AppConfig workflow of creating or deploying a configuration.
You can create your own extensions or use the Amazon Web Services authored
extensions provided by
AppConfig. For an AppConfig extension that uses Lambda, you must create a Lambda
function to perform any computation and processing
defined in the extension. If you plan to create custom versions of the Amazon
Web Services
authored notification extensions, you only need to specify an Amazon Resource
Name (ARN) in
the Uri field for the new extension version.
*
For a custom EventBridge notification extension, enter the ARN of the
EventBridge
default events in the Uri field.
*
For a custom Amazon SNS notification extension, enter the ARN of an Amazon SNS
topic in the Uri field.
*
For a custom Amazon SQS notification extension, enter the ARN of an Amazon SQS
message queue in the Uri field.
For more information about extensions, see Extending workflows in the AppConfig User Guide.
When you create an extension or configure an Amazon Web Services authored extension, you associate the extension with an AppConfig application, environment, or configuration profile.
For example, you can choose to run the
AppConfig
deployment events to Amazon SNSAmazon Web Services authored extension and receive notifications on an Amazon SNS topic anytime a configuration deployment is started for a specific application. Defining which extension to associate with an AppConfig resource is called an extension association. An extension association is a specified relationship between an extension and an AppConfig resource, such as an application or a configuration profile. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.
create_hosted_configuration_version(client, application_id, configuration_profile_id, input, options \\ [])
View SourceCreates a new configuration in the AppConfig hosted configuration store.
If you're creating a feature flag, we recommend you familiarize yourself with the JSON schema for feature flag data. For more information, see Type reference for AWS.AppConfig.FeatureFlags in the AppConfig User Guide.
Deletes an application.
delete_configuration_profile(client, application_id, configuration_profile_id, input, options \\ [])
View SourceDeletes a configuration profile.
To prevent users from unintentionally deleting actively-used configuration profiles, enable deletion protection.
delete_deployment_strategy(client, deployment_strategy_id, input, options \\ [])
View SourceDeletes a deployment strategy.
delete_environment(client, application_id, environment_id, input, options \\ [])
View SourceDeletes an environment.
To prevent users from unintentionally deleting actively-used environments, enable deletion protection.
delete_experiment_definition(client, application_identifier, experiment_definition_identifier, input, options \\ [])
View SourceDeletes an experiment definition.
You can archive the definition to hide it from the active list while preserving it for future reference, or permanently delete it along with all associated run history.
delete_extension(client, extension_identifier, input, options \\ [])
View SourceDeletes an AppConfig extension.
You must delete all associations to an extension before you delete the extension.
delete_extension_association(client, extension_association_id, input, options \\ [])
View SourceDeletes an extension association.
This action doesn't delete extensions defined in the association.
delete_hosted_configuration_version(client, application_id, configuration_profile_id, version_number, input, options \\ [])
View SourceDeletes a version of a configuration from the AppConfig hosted configuration store.
Returns information about the status of the DeletionProtection
parameter.
Retrieves information about an application.
get_configuration(client, application, configuration, environment, client_configuration_version \\ nil, client_id, options \\ [])
View Source(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.
get_configuration_profile(client, application_id, configuration_profile_id, options \\ [])
View SourceRetrieves information about a configuration profile.
get_deployment(client, application_id, deployment_number, environment_id, options \\ [])
View SourceRetrieves information about a configuration deployment.
get_deployment_strategy(client, deployment_strategy_id, options \\ [])
View SourceRetrieves information about a deployment strategy.
A deployment strategy defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time.
get_environment(client, application_id, environment_id, options \\ [])
View SourceRetrieves information about an environment.
An environment is a deployment group of
AppConfig applications, such as applications in a Production
environment or in an EU_Region environment. Each configuration deployment
targets an environment. You can enable one or more Amazon CloudWatch alarms for
an environment. If
an alarm is triggered during a deployment, AppConfig roles back the
configuration.
get_experiment_definition(client, application_identifier, experiment_definition_identifier, options \\ [])
View SourceRetrieves information about an experiment definition.
get_experiment_run(client, application_identifier, experiment_definition_identifier, run, options \\ [])
View SourceRetrieves information about an experiment run, including its status, start time, and exposure settings.
get_extension(client, extension_identifier, version_number \\ nil, options \\ [])
View SourceReturns information about an AppConfig extension.
get_extension_association(client, extension_association_id, options \\ [])
View SourceReturns information about an AppConfig extension association.
For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.
get_hosted_configuration_version(client, application_id, configuration_profile_id, version_number, options \\ [])
View SourceRetrieves information about a specific configuration version.
list_applications(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists all applications in your Amazon Web Services account.
list_configuration_profiles(client, application_id, max_results \\ nil, next_token \\ nil, type \\ nil, options \\ [])
View SourceLists the configuration profiles for an application.
list_deployment_strategies(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists deployment strategies.
list_deployments(client, application_id, environment_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists the deployments for an environment in descending deployment number order.
list_environments(client, application_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists the environments for an application.
list_experiment_definitions(client, application_identifier \\ nil, configuration_profile_identifier \\ nil, environment_identifier \\ nil, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])
View SourceLists the experiment definitions for an account.
You can filter results by application, configuration profile, environment, or status.
list_experiment_run_events(client, application_identifier, experiment_definition_identifier, run, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists the events for a specified experiment run.
Events provide a timeline of actions and state changes that occurred during the run.
list_experiment_runs(client, application_identifier, experiment_definition_identifier, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])
View SourceLists the experiment runs for a specified experiment definition.
You can filter by status.
list_extension_associations(client, extension_identifier \\ nil, extension_version_number \\ nil, max_results \\ nil, next_token \\ nil, resource_identifier \\ nil, options \\ [])
View SourceLists all AppConfig extension associations in the account.
For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.
list_extensions(client, max_results \\ nil, name \\ nil, next_token \\ nil, options \\ [])
View SourceLists all custom and Amazon Web Services authored AppConfig extensions in the account.
For more information about extensions, see Extending workflows in the AppConfig User Guide.
list_hosted_configuration_versions(client, application_id, configuration_profile_id, max_results \\ nil, next_token \\ nil, version_label \\ nil, options \\ [])
View SourceLists configurations stored in the AppConfig hosted configuration store by version.
Retrieves the list of key-value tags assigned to the resource.
start_deployment(client, application_id, environment_id, input, options \\ [])
View SourceStarts a deployment.
AppConfig Agent supports deploying feature flag or free-form configuration data to specific segments or individual users during a gradual rollout. Entity-based gradual deployments ensure that once a user or segment receives a configuration version, they continue to receive that same version throughout the deployment period, regardless of which compute resource serves their requests. For more information, see Using AppConfig Agent for user-based or entity-based gradual deployments
start_experiment_run(client, application_identifier, experiment_definition_identifier, input, options \\ [])
View SourceStarts an experiment run for the specified experiment definition.
An experiment run delivers treatments to the target audience and collects metrics. You can start multiple experiment runs from the same experiment definition.
stop_deployment(client, application_id, deployment_number, environment_id, input, options \\ [])
View SourceStops a deployment.
This API action works only on deployments that have a status of
DEPLOYING, unless an AllowRevert parameter is supplied. If the
AllowRevert parameter is supplied, the status of an in-progress deployment
will be ROLLED_BACK. The status of a completed deployment will be
REVERTED. AppConfig only allows a revert within 72 hours of
deployment completion.
stop_experiment_run(client, application_identifier, experiment_definition_identifier, run, input, options \\ [])
View SourceStops a running experiment.
Stopping an experiment run ends audience exposure and returns users to the currently deployed feature flag configuration.
Assigns metadata to an AppConfig resource.
Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. You can specify a maximum of 50 tags for a resource.
Deletes a tag key and value from an AppConfig resource.
Updates the value of the DeletionProtection parameter.
Updates an application.
update_configuration_profile(client, application_id, configuration_profile_id, input, options \\ [])
View SourceUpdates a configuration profile.
update_deployment_strategy(client, deployment_strategy_id, input, options \\ [])
View SourceUpdates a deployment strategy.
update_environment(client, application_id, environment_id, input, options \\ [])
View SourceUpdates an environment.
update_experiment_definition(client, application_identifier, experiment_definition_identifier, input, options \\ [])
View SourceUpdates an experiment definition.
You can update treatments, the control, audience rules, and other properties. You cannot update an experiment definition while an experiment run is active.
update_experiment_run(client, application_identifier, experiment_definition_identifier, run, input, options \\ [])
View SourceUpdates a running experiment.
Use this operation to increase audience exposure, modify treatment assignment overrides, or update the description of an active experiment run. Audience exposure can only be increased, not decreased.
update_extension(client, extension_identifier, input, options \\ [])
View SourceUpdates an AppConfig extension.
For more information about extensions, see Extending workflows in the AppConfig User Guide.
update_extension_association(client, extension_association_id, input, options \\ [])
View SourceUpdates an association.
For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.
validate_configuration(client, application_id, configuration_profile_id, input, options \\ [])
View SourceUses the validators in a configuration profile to validate a configuration.