/applications/{ApplicationId}

Updates an application.

• ApplicationId (path, required) — The application ID.

/applications

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

Lists all applications in your Amazon Web Services account.

• max_results (query, limit) — The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• next_token (query) — A token to start the list. Next token is a pagination token generated by AppConfig to describe what page the previous List call ended on. For the first List request, the nextToken should not be set. On subsequent calls, the nextToken parameter should be set to the previous responses nextToken value. Use this token to get the next set of results.
• MaxResults (query, limit) — Pagination limit
• NextToken (query) — Pagination token

/applications/{ApplicationId}/configurationprofiles

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

• ApplicationId (path, required) — The application ID.

/applications/{ApplicationId}/configurationprofiles

Lists the configuration profiles for an application.

• ApplicationId (path, required) — The application ID.
• max_results (query, limit) — The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• next_token (query) — A token to start the list. Use this token to get the next set of results.
• type (query) — A filter based on the type of configurations that the configuration profile contains. A configuration can be a feature flag or a freeform configuration.
• MaxResults (query, limit) — Pagination limit
• NextToken (query) — Pagination token

/deploymentstrategies

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

Lists deployment strategies.

• max_results (query, limit) — The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• next_token (query) — A token to start the list. Use this token to get the next set of results.
• MaxResults (query, limit) — Pagination limit
• NextToken (query) — Pagination token

/applications/{ApplicationId}/environments

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.

• ApplicationId (path, required) — The application ID.

/applications/{ApplicationId}

Retrieves information about an application.

• ApplicationId (path, required) — The ID of the application you want to get.

/applications/{ApplicationId}/environments

Lists the environments for an application.

• ApplicationId (path, required) — The application ID.
• max_results (query, limit) — The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• next_token (query) — A token to start the list. Use this token to get the next set of results.
• MaxResults (query, limit) — Pagination limit
• NextToken (query) — Pagination token

/extensions

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 Working with AppConfig extensions in the AppConfig User Guide .

• Latest-Version-Number (header) — You can omit this field when you create an extension. When you create a new version, specify the most recent current version number. For example, you create version 3, enter 2 for this field.

/extensions

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

• max_results (query, limit) — The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• next_token (query) — A token to start the list. Use this token to get the next set of results.
• name (query) — The extension name.
• MaxResults (query, limit) — Pagination limit
• NextToken (query) — Pagination token

/extensionassociations

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

/extensionassociations

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

• resource_identifier (query) — The ARN of an application, configuration profile, or environment.
• extension_identifier (query) — The name, the ID, or the Amazon Resource Name (ARN) of the extension.
• extension_version_number (query) — The version number for the extension defined in the association.
• max_results (query, limit) — The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• next_token (query) — A token to start the list. Use this token to get the next set of results or pass null to get the first set of results.
• MaxResults (query, limit) — Pagination limit
• NextToken (query) — Pagination token

/applications/{ApplicationId}/configurationprofiles/{ConfigurationProfileId}/hostedconfigurationversions#Content-Type

Creates a new configuration in the AppConfig hosted configuration store.

• ApplicationId (path, required) — The application ID.
• ConfigurationProfileId (path, required) — The configuration profile ID.
• Description (header) — A description of the configuration.
• Content-Type (header, required) — A standard MIME type describing the format of the configuration content. For more information, see Content-Type .
• Latest-Version-Number (header) — An optional locking token used to prevent race conditions from overwriting configuration updates when creating a new version. To ensure your data is not overwritten when creating multiple hosted configuration versions in rapid succession, specify the version number of the latest hosted configuration version.
• VersionLabel (header) — An optional, user-defined label for the AppConfig hosted configuration version. This value must contain at least one non-numeric character. For example, "v2.2.0".

/applications/{ApplicationId}

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

• ApplicationId (path, required) — The ID of the application to delete.

/applications/{ApplicationId}/configurationprofiles/{ConfigurationProfileId}

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

• ApplicationId (path, required) — The application ID that includes the configuration profile you want to delete.
• ConfigurationProfileId (path, required) — The ID of the configuration profile you want to delete.

/applications/{ApplicationId}/configurationprofiles/{ConfigurationProfileId}

Retrieves information about a configuration profile.

• ApplicationId (path, required) — The ID of the application that includes the configuration profile you want to get.
• ConfigurationProfileId (path, required) — The ID of the configuration profile that you want to get.

/applications/{ApplicationId}/configurationprofiles/{ConfigurationProfileId}

Updates a configuration profile.

• ApplicationId (path, required) — The application ID.
• ConfigurationProfileId (path, required) — The ID of the configuration profile.

/deployementstrategies/{DeploymentStrategyId}

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

• DeploymentStrategyId (path, required) — The ID of the deployment strategy you want to delete.

/applications/{ApplicationId}/environments/{EnvironmentId}

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

• ApplicationId (path, required) — The application ID that includes the environment that you want to delete.
• EnvironmentId (path, required) — The ID of the environment that you want to delete.

/applications/{ApplicationId}/environments/{EnvironmentId}

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.

• ApplicationId (path, required) — The ID of the application that includes the environment you want to get.
• EnvironmentId (path, required) — The ID of the environment that you want to get.

/applications/{ApplicationId}/environments/{EnvironmentId}

Updates an environment.

• ApplicationId (path, required) — The application ID.
• EnvironmentId (path, required) — The environment ID.

/extensions/{ExtensionIdentifier}

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

• ExtensionIdentifier (path, required) — The name, ID, or Amazon Resource Name (ARN) of the extension you want to delete.
• version (query) — A specific version of an extension to delete. If omitted, the highest version is deleted.

/extensions/{ExtensionIdentifier}

Returns information about an AppConfig extension.

• ExtensionIdentifier (path, required) — The name, the ID, or the Amazon Resource Name (ARN) of the extension.
• version_number (query) — The extension version number. If no version number was defined, AppConfig uses the highest version.

/extensions/{ExtensionIdentifier}

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

• ExtensionIdentifier (path, required) — The name, the ID, or the Amazon Resource Name (ARN) of the extension.

/extensionassociations/{ExtensionAssociationId}

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

• ExtensionAssociationId (path, required) — The ID of the extension association to delete.

/extensionassociations/{ExtensionAssociationId}

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

• ExtensionAssociationId (path, required) — The extension association ID to get.

/extensionassociations/{ExtensionAssociationId}

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

• ExtensionAssociationId (path, required) — The system-generated ID for the association.

/applications/{ApplicationId}/configurationprofiles/{ConfigurationProfileId}/hostedconfigurationversions/{VersionNumber}

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

• ApplicationId (path, required) — The application ID.
• ConfigurationProfileId (path, required) — The configuration profile ID.
• VersionNumber (path, required) — The versions number to delete.

/applications/{ApplicationId}/configurationprofiles/{ConfigurationProfileId}/hostedconfigurationversions/{VersionNumber}

Retrieves information about a specific configuration version.

• ApplicationId (path, required) — The application ID.
• ConfigurationProfileId (path, required) — The configuration profile ID.
• VersionNumber (path, required) — The version.

/applications/{Application}/environments/{Environment}/configurations/{Configuration}#client_id

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

• Application (path, required) — The application to get. Specify either the application name or the application ID.
• Environment (path, required) — The environment to get. Specify either the environment name or the environment ID.
• Configuration (path, required) — The configuration to get. Specify either the configuration name or the configuration ID.
• client_id (query, required) — 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.
• client_configuration_version (query) — 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 the Configuration in the AppConfig User Guide .

/applications/{ApplicationId}/environments/{EnvironmentId}/deployments/{DeploymentNumber}

Retrieves information about a configuration deployment.

• ApplicationId (path, required) — The ID of the application that includes the deployment you want to get.
• EnvironmentId (path, required) — The ID of the environment that includes the deployment you want to get.
• DeploymentNumber (path, required) — The sequence number of the deployment.

/applications/{ApplicationId}/environments/{EnvironmentId}/deployments/{DeploymentNumber}

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 .

• ApplicationId (path, required) — The application ID.
• EnvironmentId (path, required) — The environment ID.
• DeploymentNumber (path, required) — The sequence number of the deployment.

/deploymentstrategies/{DeploymentStrategyId}

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.

• DeploymentStrategyId (path, required) — The ID of the deployment strategy to get.

/deploymentstrategies/{DeploymentStrategyId}

Updates a deployment strategy.

• DeploymentStrategyId (path, required) — The deployment strategy ID.

/applications/{ApplicationId}/environments/{EnvironmentId}/deployments

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

• ApplicationId (path, required) — The application ID.
• EnvironmentId (path, required) — The environment ID.
• max_results (query, limit) — The maximum number of items that may be returned for this call. If there are items that have not yet been returned, the response will include a non-null NextToken that you can provide in a subsequent call to get the next set of results.
• next_token (query) — The token returned by a prior call to this operation indicating the next set of results to be returned. If not specified, the operation will return the first set of results.
• MaxResults (query, limit) — Pagination limit
• NextToken (query) — Pagination token

/applications/{ApplicationId}/environments/{EnvironmentId}/deployments

Starts a deployment.

• ApplicationId (path, required) — The application ID.
• EnvironmentId (path, required) — The environment ID.

/applications/{ApplicationId}/configurationprofiles/{ConfigurationProfileId}/hostedconfigurationversions

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

• ApplicationId (path, required) — The application ID.
• ConfigurationProfileId (path, required) — The configuration profile ID.
• max_results (query, limit) — The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
• next_token (query) — A token to start the list. Use this token to get the next set of results.
• version_label (query) — An optional filter that can be used to specify the version label of an AppConfig hosted configuration version. This parameter supports filtering by prefix using a wildcard, for example "v2*". If you don't specify an asterisk at the end of the value, only an exact match is returned.
• MaxResults (query, limit) — Pagination limit
• NextToken (query) — Pagination token

/tags/{ResourceArn}

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

• ResourceArn (path, required) — The resource ARN.

/tags/{ResourceArn}

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.

• ResourceArn (path, required) — The ARN of the resource for which to retrieve tags.

/tags/{ResourceArn}#tagKeys

Deletes a tag key and value from an AppConfig resource.

• ResourceArn (path, required) — The ARN of the resource for which to remove tags.
• tagKeys (query, required) — The tag keys to delete.

/applications/{ApplicationId}/configurationprofiles/{ConfigurationProfileId}/validators#configuration_version

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

• ApplicationId (path, required) — The application ID.
• ConfigurationProfileId (path, required) — The configuration profile ID.
• configuration_version (query, required) — The version of the configuration to validate.