@aws-sdk/client-appconfigdata 3.267.0 → 3.270.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -9,12 +9,12 @@
9
9
 
10
10
  AWS SDK for JavaScript AppConfigData Client for Node.js, Browser and React Native.
11
11
 
12
- <p>AppConfig Data provides the data plane APIs your application uses to retrieve configuration data.
13
- Here's how it works:</p>
12
+ <p>AppConfig Data provides the data plane APIs your application uses to retrieve
13
+ configuration data. Here's how it works:</p>
14
14
  <p>Your application retrieves configuration data by first establishing a configuration
15
- session using the AppConfig Data <a>StartConfigurationSession</a> API action. Your session's
16
- client then makes periodic calls to <a>GetLatestConfiguration</a> to check for
17
- and retrieve the latest data available.</p>
15
+ session using the AppConfig Data <a>StartConfigurationSession</a> API action.
16
+ Your session's client then makes periodic calls to <a>GetLatestConfiguration</a>
17
+ to check for and retrieve the latest data available.</p>
18
18
  <p>When calling <code>StartConfigurationSession</code>, your code sends the following
19
19
  information:</p>
20
20
  <ul>
@@ -30,6 +30,13 @@ to <code>GetLatestConfiguration</code>.</p>
30
30
  <p>In response, AppConfig provides an <code>InitialConfigurationToken</code> to be given to
31
31
  the session's client and used the first time it calls <code>GetLatestConfiguration</code>
32
32
  for that session.</p>
33
+ <important>
34
+ <p>This token should only be used once in your first call to
35
+ <code>GetLatestConfiguration</code>. You <i>must</i> use the new token
36
+ in the <code>GetLatestConfiguration</code> response
37
+ (<code>NextPollConfigurationToken</code>) in each subsequent call to
38
+ <code>GetLatestConfiguration</code>.</p>
39
+ </important>
33
40
  <p>When calling <code>GetLatestConfiguration</code>, your client code sends the most recent
34
41
  <code>ConfigurationToken</code> value it has and receives in response:</p>
35
42
  <ul>
@@ -50,9 +57,16 @@ over the course of the session, so it should be used instead of the value sent o
50
57
  the client already has the latest version of the configuration.</p>
51
58
  </li>
52
59
  </ul>
60
+ <important>
61
+ <p>The <code>InitialConfigurationToken</code> and
62
+ <code>NextPollConfigurationToken</code> should only be used once. To support long poll
63
+ use cases, the tokens are valid for up to 24 hours. If a
64
+ <code>GetLatestConfiguration</code> call uses an expired token, the system returns
65
+ <code>BadRequestException</code>.</p>
66
+ </important>
53
67
  <p>For more information and to view example CLI commands that show how to retrieve a
54
68
  configuration using the AppConfig Data <code>StartConfigurationSession</code> and
55
- <code>GetLatestConfiguration</code> API actions, see <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration">Receiving the
69
+ <code>GetLatestConfiguration</code> API actions, see <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration">Retrieving the
56
70
  configuration</a> in the <i>AppConfig User Guide</i>.</p>
57
71
 
58
72
  ## Installing
@@ -1,7 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.ruleSet = void 0;
4
- const p = "required", q = "fn", r = "argv", s = "ref";
5
- const a = "PartitionResult", b = "tree", c = "error", d = "endpoint", e = { [p]: false, "type": "String" }, f = { [p]: true, "default": false, "type": "Boolean" }, g = { [s]: "Endpoint" }, h = { [q]: "booleanEquals", [r]: [{ [s]: "UseFIPS" }, true] }, i = { [q]: "booleanEquals", [r]: [{ [s]: "UseDualStack" }, true] }, j = {}, k = { [q]: "booleanEquals", [r]: [true, { [q]: "getAttr", [r]: [{ [s]: a }, "supportsFIPS"] }] }, l = { [q]: "booleanEquals", [r]: [true, { [q]: "getAttr", [r]: [{ [s]: a }, "supportsDualStack"] }] }, m = [g], n = [h], o = [i];
6
- const _data = { version: "1.0", parameters: { Region: e, UseDualStack: f, UseFIPS: f, Endpoint: e }, rules: [{ conditions: [{ [q]: "aws.partition", [r]: [{ [s]: "Region" }], assign: a }], type: b, rules: [{ conditions: [{ [q]: "isSet", [r]: m }, { [q]: "parseURL", [r]: m, assign: "url" }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { type: b, rules: [{ conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: g, properties: j, headers: j }, type: d }] }] }, { conditions: [h, i], type: b, rules: [{ conditions: [k, l], type: b, rules: [{ endpoint: { url: "https://appconfigdata-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: j, headers: j }, type: d }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [k], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://appconfigdata-fips.{Region}.{PartitionResult#dnsSuffix}", properties: j, headers: j }, type: d }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [l], type: b, rules: [{ endpoint: { url: "https://appconfigdata.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: j, headers: j }, type: d }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { endpoint: { url: "https://appconfigdata.{Region}.{PartitionResult#dnsSuffix}", properties: j, headers: j }, type: d }] }] };
4
+ const q = "required", r = "fn", s = "argv", t = "ref";
5
+ const a = "isSet", b = "tree", c = "error", d = "endpoint", e = "PartitionResult", f = { [q]: false, "type": "String" }, g = { [q]: true, "default": false, "type": "Boolean" }, h = { [t]: "Endpoint" }, i = { [r]: "booleanEquals", [s]: [{ [t]: "UseFIPS" }, true] }, j = { [r]: "booleanEquals", [s]: [{ [t]: "UseDualStack" }, true] }, k = {}, l = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsFIPS"] }] }, m = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsDualStack"] }] }, n = [i], o = [j], p = [{ [t]: "Region" }];
6
+ const _data = { version: "1.0", parameters: { Region: f, UseDualStack: g, UseFIPS: g, Endpoint: f }, rules: [{ conditions: [{ [r]: a, [s]: [h] }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { type: b, rules: [{ conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: h, properties: k, headers: k }, type: d }] }] }, { type: b, rules: [{ conditions: [{ [r]: a, [s]: p }], type: b, rules: [{ conditions: [{ [r]: "aws.partition", [s]: p, assign: e }], type: b, rules: [{ conditions: [i, j], type: b, rules: [{ conditions: [l, m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://appconfigdata-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [l], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://appconfigdata-fips.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://appconfigdata.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { type: b, rules: [{ endpoint: { url: "https://appconfigdata.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] }] };
7
7
  exports.ruleSet = _data;
@@ -65,6 +65,7 @@ const deserializeAws_restJson1GetLatestConfigurationCommand = async (output, con
65
65
  () => (0, smithy_client_1.strictParseInt32)(output.headers["next-poll-interval-in-seconds"]),
66
66
  ],
67
67
  ContentType: [, output.headers["content-type"]],
68
+ VersionLabel: [, output.headers["version-label"]],
68
69
  });
69
70
  const data = await collectBody(output.body, context);
70
71
  contents.Configuration = data;
@@ -1,4 +1,4 @@
1
- const p = "required", q = "fn", r = "argv", s = "ref";
2
- const a = "PartitionResult", b = "tree", c = "error", d = "endpoint", e = { [p]: false, "type": "String" }, f = { [p]: true, "default": false, "type": "Boolean" }, g = { [s]: "Endpoint" }, h = { [q]: "booleanEquals", [r]: [{ [s]: "UseFIPS" }, true] }, i = { [q]: "booleanEquals", [r]: [{ [s]: "UseDualStack" }, true] }, j = {}, k = { [q]: "booleanEquals", [r]: [true, { [q]: "getAttr", [r]: [{ [s]: a }, "supportsFIPS"] }] }, l = { [q]: "booleanEquals", [r]: [true, { [q]: "getAttr", [r]: [{ [s]: a }, "supportsDualStack"] }] }, m = [g], n = [h], o = [i];
3
- const _data = { version: "1.0", parameters: { Region: e, UseDualStack: f, UseFIPS: f, Endpoint: e }, rules: [{ conditions: [{ [q]: "aws.partition", [r]: [{ [s]: "Region" }], assign: a }], type: b, rules: [{ conditions: [{ [q]: "isSet", [r]: m }, { [q]: "parseURL", [r]: m, assign: "url" }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { type: b, rules: [{ conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: g, properties: j, headers: j }, type: d }] }] }, { conditions: [h, i], type: b, rules: [{ conditions: [k, l], type: b, rules: [{ endpoint: { url: "https://appconfigdata-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: j, headers: j }, type: d }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [k], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://appconfigdata-fips.{Region}.{PartitionResult#dnsSuffix}", properties: j, headers: j }, type: d }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [l], type: b, rules: [{ endpoint: { url: "https://appconfigdata.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: j, headers: j }, type: d }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { endpoint: { url: "https://appconfigdata.{Region}.{PartitionResult#dnsSuffix}", properties: j, headers: j }, type: d }] }] };
1
+ const q = "required", r = "fn", s = "argv", t = "ref";
2
+ const a = "isSet", b = "tree", c = "error", d = "endpoint", e = "PartitionResult", f = { [q]: false, "type": "String" }, g = { [q]: true, "default": false, "type": "Boolean" }, h = { [t]: "Endpoint" }, i = { [r]: "booleanEquals", [s]: [{ [t]: "UseFIPS" }, true] }, j = { [r]: "booleanEquals", [s]: [{ [t]: "UseDualStack" }, true] }, k = {}, l = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsFIPS"] }] }, m = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsDualStack"] }] }, n = [i], o = [j], p = [{ [t]: "Region" }];
3
+ const _data = { version: "1.0", parameters: { Region: f, UseDualStack: g, UseFIPS: g, Endpoint: f }, rules: [{ conditions: [{ [r]: a, [s]: [h] }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { type: b, rules: [{ conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: h, properties: k, headers: k }, type: d }] }] }, { type: b, rules: [{ conditions: [{ [r]: a, [s]: p }], type: b, rules: [{ conditions: [{ [r]: "aws.partition", [s]: p, assign: e }], type: b, rules: [{ conditions: [i, j], type: b, rules: [{ conditions: [l, m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://appconfigdata-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [l], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://appconfigdata-fips.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://appconfigdata.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { type: b, rules: [{ endpoint: { url: "https://appconfigdata.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] }] };
4
4
  export const ruleSet = _data;
@@ -60,6 +60,7 @@ export const deserializeAws_restJson1GetLatestConfigurationCommand = async (outp
60
60
  () => __strictParseInt32(output.headers["next-poll-interval-in-seconds"]),
61
61
  ],
62
62
  ContentType: [, output.headers["content-type"]],
63
+ VersionLabel: [, output.headers["version-label"]],
63
64
  });
64
65
  const data = await collectBody(output.body, context);
65
66
  contents.Configuration = data;
@@ -3,12 +3,12 @@ import { AppConfigDataClient } from "./AppConfigDataClient";
3
3
  import { GetLatestConfigurationCommandInput, GetLatestConfigurationCommandOutput } from "./commands/GetLatestConfigurationCommand";
4
4
  import { StartConfigurationSessionCommandInput, StartConfigurationSessionCommandOutput } from "./commands/StartConfigurationSessionCommand";
5
5
  /**
6
- * <p>AppConfig Data provides the data plane APIs your application uses to retrieve configuration data.
7
- * Here's how it works:</p>
6
+ * <p>AppConfig Data provides the data plane APIs your application uses to retrieve
7
+ * configuration data. Here's how it works:</p>
8
8
  * <p>Your application retrieves configuration data by first establishing a configuration
9
- * session using the AppConfig Data <a>StartConfigurationSession</a> API action. Your session's
10
- * client then makes periodic calls to <a>GetLatestConfiguration</a> to check for
11
- * and retrieve the latest data available.</p>
9
+ * session using the AppConfig Data <a>StartConfigurationSession</a> API action.
10
+ * Your session's client then makes periodic calls to <a>GetLatestConfiguration</a>
11
+ * to check for and retrieve the latest data available.</p>
12
12
  * <p>When calling <code>StartConfigurationSession</code>, your code sends the following
13
13
  * information:</p>
14
14
  * <ul>
@@ -24,6 +24,13 @@ import { StartConfigurationSessionCommandInput, StartConfigurationSessionCommand
24
24
  * <p>In response, AppConfig provides an <code>InitialConfigurationToken</code> to be given to
25
25
  * the session's client and used the first time it calls <code>GetLatestConfiguration</code>
26
26
  * for that session.</p>
27
+ * <important>
28
+ * <p>This token should only be used once in your first call to
29
+ * <code>GetLatestConfiguration</code>. You <i>must</i> use the new token
30
+ * in the <code>GetLatestConfiguration</code> response
31
+ * (<code>NextPollConfigurationToken</code>) in each subsequent call to
32
+ * <code>GetLatestConfiguration</code>.</p>
33
+ * </important>
27
34
  * <p>When calling <code>GetLatestConfiguration</code>, your client code sends the most recent
28
35
  * <code>ConfigurationToken</code> value it has and receives in response:</p>
29
36
  * <ul>
@@ -44,25 +51,33 @@ import { StartConfigurationSessionCommandInput, StartConfigurationSessionCommand
44
51
  * the client already has the latest version of the configuration.</p>
45
52
  * </li>
46
53
  * </ul>
54
+ * <important>
55
+ * <p>The <code>InitialConfigurationToken</code> and
56
+ * <code>NextPollConfigurationToken</code> should only be used once. To support long poll
57
+ * use cases, the tokens are valid for up to 24 hours. If a
58
+ * <code>GetLatestConfiguration</code> call uses an expired token, the system returns
59
+ * <code>BadRequestException</code>.</p>
60
+ * </important>
47
61
  * <p>For more information and to view example CLI commands that show how to retrieve a
48
62
  * configuration using the AppConfig Data <code>StartConfigurationSession</code> and
49
- * <code>GetLatestConfiguration</code> API actions, see <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration">Receiving the
63
+ * <code>GetLatestConfiguration</code> API actions, see <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration">Retrieving the
50
64
  * configuration</a> in the <i>AppConfig User Guide</i>.</p>
51
65
  */
52
66
  export declare class AppConfigData extends AppConfigDataClient {
53
67
  /**
54
68
  * <p>Retrieves the latest deployed configuration. This API may return empty configuration
55
69
  * data if the client already has the latest version. For more information about this API
56
- * action and to view example CLI commands that show how to use it with the <a>StartConfigurationSession</a> API action, see <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration">Receiving the
70
+ * action and to view example CLI commands that show how to use it with the <a>StartConfigurationSession</a> API action, see <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration">Retrieving the
57
71
  * configuration</a> in the <i>AppConfig User Guide</i>. </p>
58
72
  * <important>
59
73
  * <p>Note the following important information.</p>
60
74
  * <ul>
61
75
  * <li>
62
- * <p>Each configuration token is only valid for one call to <code>GetLatestConfiguration</code>.
63
- * The <code>GetLatestConfiguration</code> response includes a <code>NextPollConfigurationToken</code> that
64
- * should always replace the token used for the just-completed call in preparation
65
- * for the next one. </p>
76
+ * <p>Each configuration token is only valid for one call to
77
+ * <code>GetLatestConfiguration</code>. The <code>GetLatestConfiguration</code>
78
+ * response includes a <code>NextPollConfigurationToken</code> that should always
79
+ * replace the token used for the just-completed call in preparation for the next
80
+ * one. </p>
66
81
  * </li>
67
82
  * <li>
68
83
  * <p>
@@ -78,7 +93,7 @@ export declare class AppConfigData extends AppConfigDataClient {
78
93
  /**
79
94
  * <p>Starts a configuration session used to retrieve a deployed configuration. For more
80
95
  * information about this API action and to view example CLI commands that show how to use
81
- * it with the <a>GetLatestConfiguration</a> API action, see <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration">Receiving the
96
+ * it with the <a>GetLatestConfiguration</a> API action, see <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration">Retrieving the
82
97
  * configuration</a> in the <i>AppConfig User Guide</i>. </p>
83
98
  */
84
99
  startConfigurationSession(args: StartConfigurationSessionCommandInput, options?: __HttpHandlerOptions): Promise<StartConfigurationSessionCommandOutput>;
@@ -125,12 +125,12 @@ declare type AppConfigDataClientResolvedConfigType = __SmithyResolvedConfigurati
125
125
  export interface AppConfigDataClientResolvedConfig extends AppConfigDataClientResolvedConfigType {
126
126
  }
127
127
  /**
128
- * <p>AppConfig Data provides the data plane APIs your application uses to retrieve configuration data.
129
- * Here's how it works:</p>
128
+ * <p>AppConfig Data provides the data plane APIs your application uses to retrieve
129
+ * configuration data. Here's how it works:</p>
130
130
  * <p>Your application retrieves configuration data by first establishing a configuration
131
- * session using the AppConfig Data <a>StartConfigurationSession</a> API action. Your session's
132
- * client then makes periodic calls to <a>GetLatestConfiguration</a> to check for
133
- * and retrieve the latest data available.</p>
131
+ * session using the AppConfig Data <a>StartConfigurationSession</a> API action.
132
+ * Your session's client then makes periodic calls to <a>GetLatestConfiguration</a>
133
+ * to check for and retrieve the latest data available.</p>
134
134
  * <p>When calling <code>StartConfigurationSession</code>, your code sends the following
135
135
  * information:</p>
136
136
  * <ul>
@@ -146,6 +146,13 @@ export interface AppConfigDataClientResolvedConfig extends AppConfigDataClientRe
146
146
  * <p>In response, AppConfig provides an <code>InitialConfigurationToken</code> to be given to
147
147
  * the session's client and used the first time it calls <code>GetLatestConfiguration</code>
148
148
  * for that session.</p>
149
+ * <important>
150
+ * <p>This token should only be used once in your first call to
151
+ * <code>GetLatestConfiguration</code>. You <i>must</i> use the new token
152
+ * in the <code>GetLatestConfiguration</code> response
153
+ * (<code>NextPollConfigurationToken</code>) in each subsequent call to
154
+ * <code>GetLatestConfiguration</code>.</p>
155
+ * </important>
149
156
  * <p>When calling <code>GetLatestConfiguration</code>, your client code sends the most recent
150
157
  * <code>ConfigurationToken</code> value it has and receives in response:</p>
151
158
  * <ul>
@@ -166,9 +173,16 @@ export interface AppConfigDataClientResolvedConfig extends AppConfigDataClientRe
166
173
  * the client already has the latest version of the configuration.</p>
167
174
  * </li>
168
175
  * </ul>
176
+ * <important>
177
+ * <p>The <code>InitialConfigurationToken</code> and
178
+ * <code>NextPollConfigurationToken</code> should only be used once. To support long poll
179
+ * use cases, the tokens are valid for up to 24 hours. If a
180
+ * <code>GetLatestConfiguration</code> call uses an expired token, the system returns
181
+ * <code>BadRequestException</code>.</p>
182
+ * </important>
169
183
  * <p>For more information and to view example CLI commands that show how to retrieve a
170
184
  * configuration using the AppConfig Data <code>StartConfigurationSession</code> and
171
- * <code>GetLatestConfiguration</code> API actions, see <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration">Receiving the
185
+ * <code>GetLatestConfiguration</code> API actions, see <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration">Retrieving the
172
186
  * configuration</a> in the <i>AppConfig User Guide</i>.</p>
173
187
  */
174
188
  export declare class AppConfigDataClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, AppConfigDataClientResolvedConfig> {
@@ -10,16 +10,17 @@ export interface GetLatestConfigurationCommandOutput extends GetLatestConfigurat
10
10
  /**
11
11
  * <p>Retrieves the latest deployed configuration. This API may return empty configuration
12
12
  * data if the client already has the latest version. For more information about this API
13
- * action and to view example CLI commands that show how to use it with the <a>StartConfigurationSession</a> API action, see <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration">Receiving the
13
+ * action and to view example CLI commands that show how to use it with the <a>StartConfigurationSession</a> API action, see <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration">Retrieving the
14
14
  * configuration</a> in the <i>AppConfig User Guide</i>. </p>
15
15
  * <important>
16
16
  * <p>Note the following important information.</p>
17
17
  * <ul>
18
18
  * <li>
19
- * <p>Each configuration token is only valid for one call to <code>GetLatestConfiguration</code>.
20
- * The <code>GetLatestConfiguration</code> response includes a <code>NextPollConfigurationToken</code> that
21
- * should always replace the token used for the just-completed call in preparation
22
- * for the next one. </p>
19
+ * <p>Each configuration token is only valid for one call to
20
+ * <code>GetLatestConfiguration</code>. The <code>GetLatestConfiguration</code>
21
+ * response includes a <code>NextPollConfigurationToken</code> that should always
22
+ * replace the token used for the just-completed call in preparation for the next
23
+ * one. </p>
23
24
  * </li>
24
25
  * <li>
25
26
  * <p>
@@ -10,7 +10,7 @@ export interface StartConfigurationSessionCommandOutput extends StartConfigurati
10
10
  /**
11
11
  * <p>Starts a configuration session used to retrieve a deployed configuration. For more
12
12
  * information about this API action and to view example CLI commands that show how to use
13
- * it with the <a>GetLatestConfiguration</a> API action, see <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration">Receiving the
13
+ * it with the <a>GetLatestConfiguration</a> API action, see <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration">Retrieving the
14
14
  * configuration</a> in the <i>AppConfig User Guide</i>. </p>
15
15
  * @example
16
16
  * Use a bare-bones client and the command you need to make an API call.
@@ -119,7 +119,8 @@ export declare class ResourceNotFoundException extends __BaseException {
119
119
  */
120
120
  ResourceType?: ResourceType | string;
121
121
  /**
122
- * <p>A map indicating which parameters in the request reference the resource that was not found.</p>
122
+ * <p>A map indicating which parameters in the request reference the resource that was not
123
+ * found.</p>
123
124
  */
124
125
  ReferencedBy?: Record<string, string>;
125
126
  /**
@@ -143,7 +144,7 @@ export interface StartConfigurationSessionRequest {
143
144
  /**
144
145
  * <p>Sets a constraint on a session. If you specify a value of, for example, 60 seconds, then
145
146
  * the client that established the session can't call <a>GetLatestConfiguration</a>
146
- * more frequently then every 60 seconds.</p>
147
+ * more frequently than every 60 seconds.</p>
147
148
  */
148
149
  RequiredMinimumPollIntervalInSeconds?: number;
149
150
  }
@@ -153,10 +154,15 @@ export interface StartConfigurationSessionResponse {
153
154
  * <code>GetLatestConfiguration</code> API to retrieve configuration data.</p>
154
155
  * <important>
155
156
  * <p>This token should only be used once in your first call to
156
- * <code>GetLatestConfiguration</code>. You MUST use the new token in the
157
- * <code>GetLatestConfiguration</code> response
158
- * (<code>NextPollConfigurationToken</code>) in each subsequent call to
157
+ * <code>GetLatestConfiguration</code>. You <i>must</i> use the new token
158
+ * in the <code>GetLatestConfiguration</code> response
159
+ * (<code>NextPollConfigurationToken</code>) in each subsequent call to
159
160
  * <code>GetLatestConfiguration</code>.</p>
161
+ * <p>The <code>InitialConfigurationToken</code> and
162
+ * <code>NextPollConfigurationToken</code> should only be used once. To support long poll
163
+ * use cases, the tokens are valid for up to 24 hours. If a
164
+ * <code>GetLatestConfiguration</code> call uses an expired token, the system returns
165
+ * <code>BadRequestException</code>.</p>
160
166
  * </important>
161
167
  */
162
168
  InitialConfigurationToken?: string;
@@ -178,16 +184,29 @@ export interface GetLatestConfigurationRequest {
178
184
  * <p>Token describing the current state of the configuration session. To obtain a token,
179
185
  * first call the <a>StartConfigurationSession</a> API. Note that every call to
180
186
  * <code>GetLatestConfiguration</code> will return a new <code>ConfigurationToken</code>
181
- * (<code>NextPollConfigurationToken</code> in the response) and MUST be provided to
182
- * subsequent <code>GetLatestConfiguration</code> API calls.</p>
187
+ * (<code>NextPollConfigurationToken</code> in the response) and <i>must</i>
188
+ * be provided to subsequent <code>GetLatestConfiguration</code> API calls.</p>
189
+ * <important>
190
+ * <p>This token should only be used once. To support long poll
191
+ * use cases, the token is valid for up to 24 hours. If a
192
+ * <code>GetLatestConfiguration</code> call uses an expired token, the system returns
193
+ * <code>BadRequestException</code>.</p>
194
+ * </important>
183
195
  */
184
196
  ConfigurationToken: string | undefined;
185
197
  }
186
198
  export interface GetLatestConfigurationResponse {
187
199
  /**
188
- * <p>The latest token describing the current state of the configuration session. This MUST be
189
- * provided to the next call to <code>GetLatestConfiguration.</code>
200
+ * <p>The latest token describing the current state of the configuration session. This
201
+ * <i>must</i> be provided to the next call to
202
+ * <code>GetLatestConfiguration.</code>
190
203
  * </p>
204
+ * <important>
205
+ * <p>This token should only be used once. To support long poll
206
+ * use cases, the token is valid for up to 24 hours. If a
207
+ * <code>GetLatestConfiguration</code> call uses an expired token, the system returns
208
+ * <code>BadRequestException</code>.</p>
209
+ * </important>
191
210
  */
192
211
  NextPollConfigurationToken?: string;
193
212
  /**
@@ -205,6 +224,10 @@ export interface GetLatestConfigurationResponse {
205
224
  * version of configuration.</p>
206
225
  */
207
226
  Configuration?: Uint8Array;
227
+ /**
228
+ * <p>The user-defined label for the AppConfig hosted configuration version. This attribute doesn't apply if the configuration is not from an AppConfig hosted configuration version. If the client already has the latest version of the configuration data, this value is empty.</p>
229
+ */
230
+ VersionLabel?: string;
208
231
  }
209
232
  /**
210
233
  * @internal
@@ -89,6 +89,7 @@ export interface GetLatestConfigurationResponse {
89
89
  NextPollIntervalInSeconds?: number;
90
90
  ContentType?: string;
91
91
  Configuration?: Uint8Array;
92
+ VersionLabel?: string;
92
93
  }
93
94
  export declare const InvalidParameterDetailFilterSensitiveLog: (
94
95
  obj: InvalidParameterDetail
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-appconfigdata",
3
3
  "description": "AWS SDK for JavaScript Appconfigdata Client for Node.js, Browser and React Native",
4
- "version": "3.267.0",
4
+ "version": "3.270.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",