amazonaws.com – appconfig

OpenAPI apis-guru cloud

Use AppConfig, a capability of Amazon Web Services Systems Manager, to create, manage, and quickly deploy application configurations. AppConfig supports controlled deployments to applications of any size and includes built-in validation checks and monitoring. You can use AppConfig with applications hosted on Amazon EC2 instances, Lambda, containers, mobile applications, or IoT devices.

To prevent errors when deploying application configurations, especially for production systems where a simple typo could cause an unexpected outage, AppConfig includes validators. A validator provides a syntactic or semantic check to ensure that the configuration you want to deploy works as intended. To validate your application configuration data, you provide a schema or an Amazon Web Services Lambda function that runs against the configuration. The configuration deployment or update can only proceed when the configuration data is valid.

During a configuration deployment, AppConfig monitors the application to ensure that the deployment is successful. If the system encounters an error, AppConfig rolls back the change to minimize impact for your application users. You can configure a deployment strategy for each application or environment that includes deployment criteria, including velocity, bake time, and alarms to monitor. Similar to error monitoring, if a deployment triggers an alarm, AppConfig automatically rolls back to the previous version.

AppConfig supports multiple use cases. Here are some examples:

Feature flags: Use AppConfig to turn on new features that require a timely deployment, such as a product launch or announcement.
Application tuning: Use AppConfig to carefully introduce changes to your application that can only be tested with production traffic.
Allow list: Use AppConfig to allow premium subscribers to access paid content.
Operational issues: Use AppConfig to reduce stress on your application when a dependency or other external factor impacts the system.

This reference is intended to be used with the .

Homepage: https://api.apis.guru/v2/specs/amazonaws.com:appconfig/2019-10-09.json
Provider: amazonaws.com:appconfig / appconfig
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/amazonaws.com/appconfig/2019-10-09/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/amazonaws.com/appconfig/2019-10-09/openapi.yaml

Tools (45)

Extracted live via the executor SDK.

applications.createApplication

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.
applications.createConfigurationProfile
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 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 in the AppConfig User Guide.
applications.createEnvironment

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.
applications.createHostedConfigurationVersion

Creates a new configuration in the AppConfig hosted configuration store.
applications.deleteApplication

Deletes an application. Deleting an application does not delete a configuration from a host.
applications.deleteConfigurationProfile

Deletes a configuration profile. Deleting a configuration profile does not delete a configuration from a host.
applications.deleteEnvironment

Deletes an environment. Deleting an environment does not delete a configuration from a host.
applications.deleteHostedConfigurationVersion

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

Retrieves information about an application.
applications.getConfiguration
(Deprecated) Retrieves the latest deployed configuration.

Note the following important information.
- This API action is deprecated. Calls to receive configuration data should use the and APIs instead.
- GetConfiguration is a priced call. For more information, see .
applications.getConfigurationProfile

Retrieves information about a configuration profile.
applications.getDeployment

Retrieves information about a configuration deployment.
applications.getEnvironment

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 an environment. If an alarm is triggered during a deployment, AppConfig roles back the configuration.
applications.getHostedConfigurationVersion

Retrieves information about a specific configuration version.
applications.listApplications

Lists all applications in your Amazon Web Services account.
applications.listConfigurationProfiles

Lists the configuration profiles for an application.
applications.listDeployments

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

Lists the environments for an application.
applications.listHostedConfigurationVersions

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

Starts a deployment.
applications.stopDeployment

Stops a deployment. This API action works only on deployments that have a status of DEPLOYING. This action moves the deployment to a status of ROLLED_BACK.
applications.updateApplication

Updates an application.
applications.updateConfigurationProfile

Updates a configuration profile.
applications.updateEnvironment

Updates an environment.
applications.validateConfiguration

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

Deletes a deployment strategy. Deleting a deployment strategy does not delete a configuration from a host.
deploymentstrategies.createDeploymentStrategy

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.
deploymentstrategies.getDeploymentStrategy

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 algorithm that defines how percentage grows, and bake time.
deploymentstrategies.listDeploymentStrategies

Lists deployment strategies.
deploymentstrategies.updateDeploymentStrategy

Updates a deployment strategy.
extensionassociations.createExtensionAssociation

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 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 in the AppConfig User Guide.
extensionassociations.deleteExtensionAssociation

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

Returns information about an AppConfig extension association. For more information about extensions and associations, see in the AppConfig User Guide.
extensionassociations.listExtensionAssociations

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

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

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 most use cases, to create your own extension, you must create an Lambda function to perform any computation and processing defined in the extension. For more information about extensions, see in the AppConfig User Guide.
extensions.deleteExtension

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

Returns information about an AppConfig extension.
extensions.listExtensions

Lists all custom and Amazon Web Services authored AppConfig extensions in the account. For more information about extensions, see in the AppConfig User Guide.
extensions.updateExtension

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

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

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.
tags.untagResource

Deletes a tag key and value from an AppConfig resource.
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools