AWS Fundamentals Logo
AWS Fundamentals
aws appconfig

AWS AWS AppConfig CLI Commands

56 CLI commands available for AWS AppConfig.

CommandSample
create-application

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

create-configuration-profile

Creates 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

create-deployment-strategy

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 g

create-environment

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

create-experiment-definition

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

create-extension

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

create-extension-association

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 SNS Amazon Web Services authored extensi

create-hosted-configuration-version

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

delete-application

Deletes an application.

delete-configuration-profile

Deletes a configuration profile. To prevent users from unintentionally deleting actively-used configuration profiles, enable deletion protection.

delete-deployment-strategy

Deletes a deployment strategy.

delete-environment

Deletes an environment. To prevent users from unintentionally deleting actively-used environments, enable deletion protection.

delete-experiment-definition

Deletes 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

Deletes an AppConfig extension. You must delete all associations to an extension before you delete the extension.

delete-extension-association

Deletes an extension association. This action doesn't delete extensions defined in the association.

delete-hosted-configuration-version

Deletes a version of a configuration from the AppConfig hosted configuration store.

get-account-settings

Returns information about the status of the DeletionProtection parameter.

get-application

Retrieves information about an application.

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

get-configuration-profile

Retrieves information about a configuration profile.

get-deployment

Retrieves information about a configuration deployment.

get-deployment-strategy

Retrieves 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 a

get-environment

Retrieves 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 a

get-experiment-definition

Retrieves information about an experiment definition.

get-experiment-run

Retrieves information about an experiment run, including its status, start time, and exposure settings.

get-extension

Returns information about an AppConfig extension.

get-extension-association

Returns 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

Retrieves information about a specific configuration version.

list-applications

Lists all applications in your Amazon Web Services account.

list-configuration-profiles

Lists the configuration profiles for an application.

list-deployment-strategies

Lists deployment strategies.

list-deployments

Lists the deployments for an environment in descending deployment number order.

list-environments

Lists the environments for an application.

list-experiment-definitions

Lists the experiment definitions for an account. You can filter results by application, configuration profile, environment, or status.

list-experiment-run-events

Lists the events for a specified experiment run. Events provide a timeline of actions and state changes that occurred during the run.

list-experiment-runs

Lists the experiment runs for a specified experiment definition. You can filter by status.

list-extension-associations

Lists all AppConfig extension associations in the account. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.

list-extensions

Lists 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

Lists configurations stored in the AppConfig hosted configuration store by version.

list-tags-for-resource

Retrieves the list of key-value tags assigned to the resource.

start-deployment

Starts 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

start-experiment-run

Starts 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. Billing for this experiment begins when you call this operation and contin

stop-deployment

Stops 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. Ap

stop-experiment-run

Stops a running experiment. Stopping an experiment run ends audience exposure and returns users to the currently deployed feature flag configuration.

tag-resource

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.

untag-resource

Deletes a tag key and value from an AppConfig resource.

update-account-settings

Updates the value of the DeletionProtection parameter.

update-application

Updates an application.

update-configuration-profile

Updates a configuration profile.

update-deployment-strategy

Updates a deployment strategy.

update-environment

Updates an environment.

update-experiment-definition

Updates 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

Updates 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

Updates an AppConfig extension. For more information about extensions, see Extending workflows in the AppConfig User Guide.

update-extension-association

Updates an association. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.

validate-configuration

Uses the validators in a configuration profile to validate a configuration.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Stats

Total Commands56
ServiceAppConfig