GetConfiguration - AWS AppConfig

GetConfiguration

Receive information about a configuration.

Important

AWS 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 that you include the ClientConfigurationVersion value with every call to GetConfiguration. This value must be saved on your client. Subsequent calls to GetConfiguration must pass this value by using the ClientConfigurationVersion parameter.

Request Syntax

GET /applications/Application/environments/Environment/configurations/Configuration?client_configuration_version=ClientConfigurationVersion&client_id=ClientId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Application

The application to get. Specify either the application name or the application ID.

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: Yes

ClientConfigurationVersion

The configuration version returned in the most recent GetConfiguration response.

Important

AWS 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 that you include the ClientConfigurationVersion value with every call to GetConfiguration. This value must be saved on your client. Subsequent calls to GetConfiguration must pass this value by using the ClientConfigurationVersion parameter.

For more information about working with configurations, see Retrieving the Configuration in the AWS AppConfig User Guide.

Length Constraints: Minimum length of 1. Maximum length of 1024.

ClientId

A unique ID to identify the client for the configuration. This ID enables AppConfig to deploy the configuration in intervals, as defined in the deployment strategy.

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: Yes

Configuration

The configuration to get. Specify either the configuration name or the configuration ID.

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: Yes

Environment

The environment to get. Specify either the environment name or the environment ID.

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Configuration-Version: ConfigurationVersion Content-Type: ContentType Content

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The response returns the following HTTP headers.

ConfigurationVersion

The configuration version.

Length Constraints: Minimum length of 1. Maximum length of 1024.

ContentType

A standard MIME type describing the format of the configuration content. For more information, see Content-Type.

The response returns the following as the HTTP body.

Content

The content of the configuration or the configuration data.

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

InternalServerException

There was an internal failure in the AppConfig service.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource could not be found.

HTTP Status Code: 404

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: