Amazon Web Services, Inc.

AWS AppConfig Data

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

Data & analytics#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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 .

Endpoints 2

Configuration session

  • POSTStart configuration session/configurationsessionsStarts a configuration session used to retrieve a deployed configuration. For more information about this API action and to view example CLI commands that…
  • GETGet latest configuration/configuration?configuration_token=stringRetrieves the latest deployed configuration. This API may return empty configuration data if the client already has the latest version. For more information…

API details

Base URL
https://appconfigdata.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
2 operations on 2 pathsGET 1POST 1
Main resources
Configuration session 1
Description format
AWS Smithy model, API version 2021-11-11

How to test the AWS AppConfig Data in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS AppConfig Data collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Start configuration session” (POST /configurationsessions), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS AppConfig Data?

AppConfig Data provides the data plane APIs your application uses to retrieve configuration data. Here's how it works: Your application retrieves… It is listed under Data & analytics and has 2 endpoints.

Who publishes the AWS AppConfig Data?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS AppConfig Data?

Requests go to https://appconfigdata.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS AppConfig Data?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS AppConfig Data have?

2 operations on 2 paths (1 GET, 1 POST). The largest groups are Configuration session.

Is forking the AWS AppConfig Data free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.