View Source aws_appconfig (aws v1.0.4)

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 AppConfig User Guide: http://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html.

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 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 a version of a configuration from the AppConfig hosted configuration store.
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.

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

Assigns metadata to an AppConfig resource.

Deletes a tag key and value from an AppConfig resource.
Uses the validators in a configuration profile to validate a configuration.

Functions

Link to this function

create_application(Client, Input)

View Source

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.
Link to this function

create_application(Client, Input0, Options0)

View Source
Link to this function

create_configuration_profile(Client, ApplicationId, Input)

View Source

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 Create a Configuration and a Configuration Profile: http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html in the AppConfig User Guide.
Link to this function

create_configuration_profile(Client, ApplicationId, Input0, Options0)

View Source
Link to this function

create_deployment_strategy(Client, Input)

View Source

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.
Link to this function

create_deployment_strategy(Client, Input0, Options0)

View Source
Link to this function

create_environment(Client, ApplicationId, Input)

View Source

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.
Link to this function

create_environment(Client, ApplicationId, Input0, Options0)

View Source
Link to this function

create_extension(Client, Input)

View Source

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 Working with AppConfig extensions: https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html in the AppConfig User Guide.
Link to this function

create_extension(Client, Input0, Options0)

View Source
Link to this function

create_extension_association(Client, Input)

View Source

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 Working with AppConfig extensions: https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html in the AppConfig User Guide.
Link to this function

create_extension_association(Client, Input0, Options0)

View Source
Link to this function

create_hosted_configuration_version(Client, ApplicationId, ConfigurationProfileId, Input)

View Source
Creates a new configuration in the AppConfig hosted configuration store.
Link to this function

create_hosted_configuration_version(Client, ApplicationId, ConfigurationProfileId, Input0, Options0)

View Source
Link to this function

delete_application(Client, ApplicationId, Input)

View Source

Deletes an application.

Deleting an application does not delete a configuration from a host.
Link to this function

delete_application(Client, ApplicationId, Input0, Options0)

View Source
Link to this function

delete_configuration_profile(Client, ApplicationId, ConfigurationProfileId, Input)

View Source

Deletes a configuration profile.

Deleting a configuration profile does not delete a configuration from a host.
Link to this function

delete_configuration_profile(Client, ApplicationId, ConfigurationProfileId, Input0, Options0)

View Source
Link to this function

delete_deployment_strategy(Client, DeploymentStrategyId, Input)

View Source

Deletes a deployment strategy.

Deleting a deployment strategy does not delete a configuration from a host.
Link to this function

delete_deployment_strategy(Client, DeploymentStrategyId, Input0, Options0)

View Source
Link to this function

delete_environment(Client, ApplicationId, EnvironmentId, Input)

View Source

Deletes an environment.

Deleting an environment does not delete a configuration from a host.
Link to this function

delete_environment(Client, ApplicationId, EnvironmentId, Input0, Options0)

View Source
Link to this function

delete_extension(Client, ExtensionIdentifier, Input)

View Source

Deletes an AppConfig extension.

You must delete all associations to an extension before you delete the extension.
Link to this function

delete_extension(Client, ExtensionIdentifier, Input0, Options0)

View Source
Link to this function

delete_extension_association(Client, ExtensionAssociationId, Input)

View Source

Deletes an extension association.

This action doesn't delete extensions defined in the association.
Link to this function

delete_extension_association(Client, ExtensionAssociationId, Input0, Options0)

View Source
Link to this function

delete_hosted_configuration_version(Client, ApplicationId, ConfigurationProfileId, VersionNumber, Input)

View Source
Deletes a version of a configuration from the AppConfig hosted configuration store.
Link to this function

delete_hosted_configuration_version(Client, ApplicationId, ConfigurationProfileId, VersionNumber, Input0, Options0)

View Source
Link to this function

get_application(Client, ApplicationId)

View Source
Retrieves information about an application.
Link to this function

get_application(Client, ApplicationId, QueryMap, HeadersMap)

View Source
Link to this function

get_application(Client, ApplicationId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_configuration(Client, Application, Configuration, Environment, ClientId)

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: https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_StartConfigurationSession.html and GetLatestConfiguration: https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_GetLatestConfiguration.html APIs instead.

GetConfiguration is a priced call. For more information, see Pricing: https://aws.amazon.com/systems-manager/pricing/.
Link to this function

get_configuration(Client, Application, Configuration, Environment, ClientId, QueryMap, HeadersMap)

View Source
Link to this function

get_configuration(Client, Application, Configuration, Environment, ClientId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_configuration_profile(Client, ApplicationId, ConfigurationProfileId)

View Source
Retrieves information about a configuration profile.
Link to this function

get_configuration_profile(Client, ApplicationId, ConfigurationProfileId, QueryMap, HeadersMap)

View Source
Link to this function

get_configuration_profile(Client, ApplicationId, ConfigurationProfileId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_deployment(Client, ApplicationId, DeploymentNumber, EnvironmentId)

View Source
Retrieves information about a configuration deployment.
Link to this function

get_deployment(Client, ApplicationId, DeploymentNumber, EnvironmentId, QueryMap, HeadersMap)

View Source
Link to this function

get_deployment(Client, ApplicationId, DeploymentNumber, EnvironmentId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_deployment_strategy(Client, DeploymentStrategyId)

View Source

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.
Link to this function

get_deployment_strategy(Client, DeploymentStrategyId, QueryMap, HeadersMap)

View Source
Link to this function

get_deployment_strategy(Client, DeploymentStrategyId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_environment(Client, ApplicationId, EnvironmentId)

View Source

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.
Link to this function

get_environment(Client, ApplicationId, EnvironmentId, QueryMap, HeadersMap)

View Source
Link to this function

get_environment(Client, ApplicationId, EnvironmentId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_extension(Client, ExtensionIdentifier)

View Source
Returns information about an AppConfig extension.
Link to this function

get_extension(Client, ExtensionIdentifier, QueryMap, HeadersMap)

View Source
Link to this function

get_extension(Client, ExtensionIdentifier, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_extension_association(Client, ExtensionAssociationId)

View Source

Returns information about an AppConfig extension association.

For more information about extensions and associations, see Working with AppConfig extensions: https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html in the AppConfig User Guide.
Link to this function

get_extension_association(Client, ExtensionAssociationId, QueryMap, HeadersMap)

View Source
Link to this function

get_extension_association(Client, ExtensionAssociationId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_hosted_configuration_version(Client, ApplicationId, ConfigurationProfileId, VersionNumber)

View Source
Retrieves information about a specific configuration version.
Link to this function

get_hosted_configuration_version(Client, ApplicationId, ConfigurationProfileId, VersionNumber, QueryMap, HeadersMap)

View Source
Link to this function

get_hosted_configuration_version(Client, ApplicationId, ConfigurationProfileId, VersionNumber, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_applications(Client)

View Source
Lists all applications in your Amazon Web Services account.
Link to this function

list_applications(Client, QueryMap, HeadersMap)

View Source
Link to this function

list_applications(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_configuration_profiles(Client, ApplicationId)

View Source
Lists the configuration profiles for an application.
Link to this function

list_configuration_profiles(Client, ApplicationId, QueryMap, HeadersMap)

View Source
Link to this function

list_configuration_profiles(Client, ApplicationId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_deployment_strategies(Client)

View Source
Lists deployment strategies.
Link to this function

list_deployment_strategies(Client, QueryMap, HeadersMap)

View Source
Link to this function

list_deployment_strategies(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_deployments(Client, ApplicationId, EnvironmentId)

View Source
Lists the deployments for an environment in descending deployment number order.
Link to this function

list_deployments(Client, ApplicationId, EnvironmentId, QueryMap, HeadersMap)

View Source
Link to this function

list_deployments(Client, ApplicationId, EnvironmentId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_environments(Client, ApplicationId)

View Source
Lists the environments for an application.
Link to this function

list_environments(Client, ApplicationId, QueryMap, HeadersMap)

View Source
Link to this function

list_environments(Client, ApplicationId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_extension_associations(Client)

View Source

Lists all AppConfig extension associations in the account.

For more information about extensions and associations, see Working with AppConfig extensions: https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html in the AppConfig User Guide.
Link to this function

list_extension_associations(Client, QueryMap, HeadersMap)

View Source
Link to this function

list_extension_associations(Client, QueryMap, HeadersMap, Options0)

View Source

Lists all custom and Amazon Web Services authored AppConfig extensions in the account.

For more information about extensions, see Working with AppConfig extensions: https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html in the AppConfig User Guide.
Link to this function

list_extensions(Client, QueryMap, HeadersMap)

View Source
Link to this function

list_extensions(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_hosted_configuration_versions(Client, ApplicationId, ConfigurationProfileId)

View Source
Lists configurations stored in the AppConfig hosted configuration store by version.
Link to this function

list_hosted_configuration_versions(Client, ApplicationId, ConfigurationProfileId, QueryMap, HeadersMap)

View Source
Link to this function

list_hosted_configuration_versions(Client, ApplicationId, ConfigurationProfileId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_tags_for_resource(Client, ResourceArn)

View Source
Retrieves the list of key-value tags assigned to the resource.
Link to this function

list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap)

View Source
Link to this function

list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)

View Source
Link to this function

start_deployment(Client, ApplicationId, EnvironmentId, Input)

View Source
Starts a deployment.
Link to this function

start_deployment(Client, ApplicationId, EnvironmentId, Input0, Options0)

View Source
Link to this function

stop_deployment(Client, ApplicationId, DeploymentNumber, EnvironmentId, Input)

View Source

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.
Link to this function

stop_deployment(Client, ApplicationId, DeploymentNumber, EnvironmentId, Input0, Options0)

View Source
Link to this function

tag_resource(Client, ResourceArn, Input)

View Source

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.
Link to this function

tag_resource(Client, ResourceArn, Input0, Options0)

View Source
Link to this function

untag_resource(Client, ResourceArn, Input)

View Source
Deletes a tag key and value from an AppConfig resource.
Link to this function

untag_resource(Client, ResourceArn, Input0, Options0)

View Source
Link to this function

update_application(Client, ApplicationId, Input)

View Source
Updates an application.
Link to this function

update_application(Client, ApplicationId, Input0, Options0)

View Source
Link to this function

update_configuration_profile(Client, ApplicationId, ConfigurationProfileId, Input)

View Source
Updates a configuration profile.
Link to this function

update_configuration_profile(Client, ApplicationId, ConfigurationProfileId, Input0, Options0)

View Source
Link to this function

update_deployment_strategy(Client, DeploymentStrategyId, Input)

View Source
Updates a deployment strategy.
Link to this function

update_deployment_strategy(Client, DeploymentStrategyId, Input0, Options0)

View Source
Link to this function

update_environment(Client, ApplicationId, EnvironmentId, Input)

View Source
Updates an environment.
Link to this function

update_environment(Client, ApplicationId, EnvironmentId, Input0, Options0)

View Source
Link to this function

update_extension(Client, ExtensionIdentifier, Input)

View Source

Updates an AppConfig extension.

For more information about extensions, see Working with AppConfig extensions: https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html in the AppConfig User Guide.
Link to this function

update_extension(Client, ExtensionIdentifier, Input0, Options0)

View Source
Link to this function

update_extension_association(Client, ExtensionAssociationId, Input)

View Source

Updates an association.

For more information about extensions and associations, see Working with AppConfig extensions: https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html in the AppConfig User Guide.
Link to this function

update_extension_association(Client, ExtensionAssociationId, Input0, Options0)

View Source
Link to this function

validate_configuration(Client, ApplicationId, ConfigurationProfileId, Input)

View Source
Uses the validators in a configuration profile to validate a configuration.
Link to this function

validate_configuration(Client, ApplicationId, ConfigurationProfileId, Input0, Options0)

View Source