GetConfigurationCommand

Suggest an Edit
  • This API has been deprecated in favor of the GetLatestConfiguration API used in conjunction with StartConfigurationSession.

(Deprecated) Retrieves the latest deployed configuration.

Note the following important information.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { AppConfigClient, GetConfigurationCommand } from "@aws-sdk/client-appconfig"; // ES Modules import
// const { AppConfigClient, GetConfigurationCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import
const client = new AppConfigClient(config);
const input = { // GetConfigurationRequest
  Application: "STRING_VALUE", // required
  Environment: "STRING_VALUE", // required
  Configuration: "STRING_VALUE", // required
  ClientId: "STRING_VALUE", // required
  ClientConfigurationVersion: "STRING_VALUE",
};
const command = new GetConfigurationCommand(input);
const response = await client.send(command);
// { // Configuration
//   Content: new Uint8Array(),
//   ConfigurationVersion: "STRING_VALUE",
//   ContentType: "STRING_VALUE",
// };

Example Usage

 There was an error loading the code editor. Retry

GetConfigurationCommand Input

See GetConfigurationCommandInput for more details

Parameter
Type
Description
Application
Required
string | undefined

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

ClientId
Required
string | undefined

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.

Configuration
Required
string | undefined

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

Environment
Required
string | undefined

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

ClientConfigurationVersion
string | undefined

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 feature flags and configuration data in AppConfig  in the AppConfig User Guide.

GetConfigurationCommand Output

See GetConfigurationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
BadRequestException
client

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException
server

There was an internal failure in the AppConfig service.

ResourceNotFoundException
client

The requested resource could not be found.

AppConfigServiceException
Base exception class for all service exceptions from AppConfig service.