@aws-sdk/client-appconfigdata

What is @aws-sdk/client-appconfigdata?

@aws-sdk/client-appconfigdata is a part of the AWS SDK for JavaScript, which allows developers to interact with AWS AppConfig Data. AWS AppConfig is a capability of AWS Systems Manager that allows you to create, manage, and quickly deploy application configurations. This package provides methods to retrieve configuration data for your applications.

What are @aws-sdk/client-appconfigdata's main functionalities?

Retrieve Configuration

This feature allows you to retrieve the latest configuration data for your application. You need to provide a configuration token to get the latest configuration.

const { AppConfigDataClient, GetLatestConfigurationCommand } = require('@aws-sdk/client-appconfigdata');

const client = new AppConfigDataClient({ region: 'us-west-2' });

const getConfig = async () => {
  const command = new GetLatestConfigurationCommand({
    ConfigurationToken: 'your-configuration-token'
  });
  const response = await client.send(command);
  console.log(response);
};

getConfig();

Start Configuration Session

This feature allows you to start a configuration session. You need to provide identifiers for the application, environment, and configuration profile.

const { AppConfigDataClient, StartConfigurationSessionCommand } = require('@aws-sdk/client-appconfigdata');

const client = new AppConfigDataClient({ region: 'us-west-2' });

const startSession = async () => {
  const command = new StartConfigurationSessionCommand({
    ApplicationIdentifier: 'your-application-id',
    EnvironmentIdentifier: 'your-environment-id',
    ConfigurationProfileIdentifier: 'your-configuration-profile-id'
  });
  const response = await client.send(command);
  console.log(response);
};

startSession();

Get Configuration

This feature allows you to get a specific configuration for your application. You need to provide identifiers for the application, environment, configuration, and client.

const { AppConfigDataClient, GetConfigurationCommand } = require('@aws-sdk/client-appconfigdata');

const client = new AppConfigDataClient({ region: 'us-west-2' });

const getConfiguration = async () => {
  const command = new GetConfigurationCommand({
    Application: 'your-application-id',
    Environment: 'your-environment-id',
    Configuration: 'your-configuration-id',
    ClientId: 'your-client-id'
  });
  const response = await client.send(command);
  console.log(response);
};

getConfiguration();

Other packages similar to @aws-sdk/client-appconfigdata

config

The 'config' package is a popular Node.js configuration management tool. It allows you to define configuration settings for your application in a variety of formats (JSON, YAML, etc.) and manage them across different environments. Unlike @aws-sdk/client-appconfigdata, it does not provide integration with AWS services but is more focused on local configuration management.

dotenv

The 'dotenv' package loads environment variables from a .env file into process.env. It is a simple and effective way to manage configuration settings for Node.js applications. Unlike @aws-sdk/client-appconfigdata, it does not provide dynamic configuration management or integration with AWS services.

nconf

The 'nconf' package is a hierarchical configuration manager for Node.js. It supports multiple configuration sources such as command-line arguments, environment variables, and configuration files. While it offers more flexibility in managing configurations compared to @aws-sdk/client-appconfigdata, it does not provide direct integration with AWS services.

README

@aws-sdk/client-appconfigdata

Description

AWS SDK for JavaScript AppConfigData Client for Node.js, Browser and React Native.

AppConfig Data provides the data plane APIs your application uses to retrieve configuration data. Here's how it works:

Your application retrieves configuration data by first establishing a configuration session using the AppConfig Data StartConfigurationSession API action. Your session's client then makes periodic calls to GetLatestConfiguration to check for and retrieve the latest data available.

When calling StartConfigurationSession, your code sends the following information:

• Identifiers (ID or name) of an AppConfig application, environment, and configuration profile that the session tracks.

• (Optional) The minimum amount of time the session's client must wait between calls to GetLatestConfiguration.

In response, AppConfig provides an InitialConfigurationToken to be given to the session's client and used the first time it calls GetLatestConfiguration for that session.

This token should only be used once in your first call to GetLatestConfiguration. You must use the new token in the GetLatestConfiguration response (NextPollConfigurationToken) in each subsequent call to GetLatestConfiguration.

When calling GetLatestConfiguration, your client code sends the most recent ConfigurationToken value it has and receives in response:

• NextPollConfigurationToken: the ConfigurationToken value to use on the next call to GetLatestConfiguration.

• NextPollIntervalInSeconds: the duration the client should wait before making its next call to GetLatestConfiguration. This duration may vary over the course of the session, so it should be used instead of the value sent on the StartConfigurationSession call.

• The configuration: the latest data intended for the session. This may be empty if the client already has the latest version of the configuration.

The InitialConfigurationToken and NextPollConfigurationToken should only be used once. To support long poll use cases, the tokens are valid for up to 24 hours. If a GetLatestConfiguration call uses an expired token, the system returns BadRequestException.

For more information and to view example CLI commands that show how to retrieve a configuration using the AppConfig Data StartConfigurationSession and GetLatestConfiguration API actions, see Retrieving the configuration in the AppConfig User Guide.

Installing

To install this package, simply type add or install @aws-sdk/client-appconfigdata using your favorite package manager:

• npm install @aws-sdk/client-appconfigdata
• yarn add @aws-sdk/client-appconfigdata
• pnpm add @aws-sdk/client-appconfigdata

Getting Started

Import

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the AppConfigDataClient and the commands you need, for example GetLatestConfigurationCommand:

// ES5 example
const { AppConfigDataClient, GetLatestConfigurationCommand } = require("@aws-sdk/client-appconfigdata");

// ES6+ example
import { AppConfigDataClient, GetLatestConfigurationCommand } from "@aws-sdk/client-appconfigdata";

Usage

To send a request, you:

• Initiate client with configuration (e.g. credentials, region).
• Initiate command with input parameters.
• Call send operation on client with command object as input.
• If you are using a custom http handler, you may call destroy() to close open connections.

// a client can be shared by different commands.
const client = new AppConfigDataClient({ region: "REGION" });

const params = {
  /** input parameters */
};
const command = new GetLatestConfigurationCommand(params);

Async/await

We recommend using await operator to wait for the promise returned by send operation as follows:

// async/await.
try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  // error handling.
} finally {
  // finally.
}

Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.

Promises

You can also use Promise chaining to execute send operation.

client.send(command).then(
  (data) => {
    // process data.
  },
  (error) => {
    // error handling.
  }
);

Promises can also be called using .catch() and .finally() as follows:

client
  .send(command)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  })
  .finally(() => {
    // finally.
  });

Callbacks

We do not recommend using callbacks because of callback hell, but they are supported by the send operation.

// callbacks.
client.send(command, (err, data) => {
  // process err and data.
});

v2 compatible style

The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript

import * as AWS from "@aws-sdk/client-appconfigdata";
const client = new AWS.AppConfigData({ region: "REGION" });

// async/await.
try {
  const data = await client.getLatestConfiguration(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .getLatestConfiguration(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks.
client.getLatestConfiguration(params, (err, data) => {
  // process err and data.
});

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  const { requestId, cfId, extendedRequestId } = error.$metadata;
  console.log({ requestId, cfId, extendedRequestId });
  /**
   * The keys within exceptions are also parsed.
   * You can access them by specifying exception names:
   * if (error.name === 'SomeServiceException') {
   *     const value = error.specialKeyInException;
   * }
   */
}

Getting Help

Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

• Visit Developer Guide or API Reference.
• Check out the blog posts tagged with aws-sdk-js on AWS Developer Blog.
• Ask a question on StackOverflow and tag it with aws-sdk-js.
• Join the AWS JavaScript community on gitter.
• If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-appconfigdata package is updated. To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

Client Commands (Operations List)

GetLatestConfiguration

Command API Reference / Input / Output

StartConfigurationSession

Command API Reference / Input / Output

Changelog

3.744.0 (2025-02-07)

Features

• client-ecr: Adds support to handle the new basic scanning daily quota. (07297d3)
• client-eks: Introduce versionStatus field to take place of status field in EKS DescribeClusterVersions API (5b42130)
• client-mediaconvert: This release adds support for Animated GIF output, forced chroma sample positioning metadata, and Extensible Wave Container format (5f0e21d)
• client-pi: Adds documentation for dimension groups and dimensions to analyze locks for Database Insights. (94f7ccb)
• client-transcribe-streaming: This release adds support for the Clinical Note Template Customization feature for the AWS HealthScribe Streaming APIs within Amazon Transcribe. (d338b70)
• client-transcribe: This release adds support for the Clinical Note Template Customization feature for the AWS HealthScribe APIs within Amazon Transcribe. (91fce74)
• clients: update client endpoints as of 2025-02-07 (abfb6ea)