@aws-sdk/client-appconfigdata 3.295.0 → 3.297.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.
Files changed (7) hide show
  1. package/dist-types/AppConfigData.d.ts +3 -0
  2. package/dist-types/AppConfigDataClient.d.ts +24 -4
  3. package/dist-types/commands/GetLatestConfigurationCommand.d.ts +16 -0
  4. package/dist-types/commands/StartConfigurationSessionCommand.d.ts +16 -0
  5. package/dist-types/models/AppConfigDataServiceException.d.ts +2 -0
  6. package/dist-types/models/models_0.d.ts +30 -0
  7. package/package.json +29 -29
package/dist-types/AppConfigData.d.ts CHANGED
@@ -3,6 +3,7 @@ import { AppConfigDataClient } from "./AppConfigDataClient";
3
3
  import { GetLatestConfigurationCommandInput, GetLatestConfigurationCommandOutput } from "./commands/GetLatestConfigurationCommand";
4
4
  import { StartConfigurationSessionCommandInput, StartConfigurationSessionCommandOutput } from "./commands/StartConfigurationSessionCommand";
5
5
  /**
6
+ * @public
6
7
  * <p>AppConfig Data provides the data plane APIs your application uses to retrieve
7
8
  * configuration data. Here's how it works:</p>
8
9
  * <p>Your application retrieves configuration data by first establishing a configuration
@@ -65,6 +66,7 @@ import { StartConfigurationSessionCommandInput, StartConfigurationSessionCommand
65
66
  */
66
67
  export declare class AppConfigData extends AppConfigDataClient {
67
68
  /**
69
+ * @public
68
70
  * <p>Retrieves the latest deployed configuration. This API may return empty configuration
69
71
  * data if the client already has the latest version. For more information about this API
70
72
  * 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
@@ -91,6 +93,7 @@ export declare class AppConfigData extends AppConfigDataClient {
91
93
  getLatestConfiguration(args: GetLatestConfigurationCommandInput, cb: (err: any, data?: GetLatestConfigurationCommandOutput) => void): void;
92
94
  getLatestConfiguration(args: GetLatestConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLatestConfigurationCommandOutput) => void): void;
93
95
  /**
96
+ * @public
94
97
  * <p>Starts a configuration session used to retrieve a deployed configuration. For more
95
98
  * information about this API action and to view example CLI commands that show how to use
96
99
  * 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
package/dist-types/AppConfigDataClient.d.ts CHANGED
@@ -10,15 +10,24 @@ import { BodyLengthCalculator as __BodyLengthCalculator, ChecksumConstructor as
10
10
  import { GetLatestConfigurationCommandInput, GetLatestConfigurationCommandOutput } from "./commands/GetLatestConfigurationCommand";
11
11
  import { StartConfigurationSessionCommandInput, StartConfigurationSessionCommandOutput } from "./commands/StartConfigurationSessionCommand";
12
12
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
13
+ /**
14
+ * @public
15
+ */
13
16
  export type ServiceInputTypes = GetLatestConfigurationCommandInput | StartConfigurationSessionCommandInput;
17
+ /**
18
+ * @public
19
+ */
14
20
  export type ServiceOutputTypes = GetLatestConfigurationCommandOutput | StartConfigurationSessionCommandOutput;
21
+ /**
22
+ * @public
23
+ */
15
24
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
16
25
  /**
17
26
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
18
27
  */
19
28
  requestHandler?: __HttpHandler;
20
29
  /**
21
- * A constructor for a class implementing the {@link __Checksum} interface
30
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
22
31
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
23
32
  * @internal
24
33
  */
@@ -108,23 +117,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
108
117
  */
109
118
  logger?: __Logger;
110
119
  /**
111
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
120
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
112
121
  */
113
122
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
114
123
  }
124
+ /**
125
+ * @public
126
+ */
115
127
  type AppConfigDataClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
116
128
  /**
117
- * The configuration interface of AppConfigDataClient class constructor that set the region, credentials and other options.
129
+ * @public
130
+ *
131
+ * The configuration interface of AppConfigDataClient class constructor that set the region, credentials and other options.
118
132
  */
119
133
  export interface AppConfigDataClientConfig extends AppConfigDataClientConfigType {
120
134
  }
135
+ /**
136
+ * @public
137
+ */
121
138
  type AppConfigDataClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
122
139
  /**
123
- * The resolved configuration interface of AppConfigDataClient class. This is resolved and normalized from the {@link AppConfigDataClientConfig | constructor configuration interface}.
140
+ * @public
141
+ *
142
+ * The resolved configuration interface of AppConfigDataClient class. This is resolved and normalized from the {@link AppConfigDataClientConfig | constructor configuration interface}.
124
143
  */
125
144
  export interface AppConfigDataClientResolvedConfig extends AppConfigDataClientResolvedConfigType {
126
145
  }
127
146
  /**
147
+ * @public
128
148
  * <p>AppConfig Data provides the data plane APIs your application uses to retrieve
129
149
  * configuration data. Here's how it works:</p>
130
150
  * <p>Your application retrieves configuration data by first establishing a configuration
package/dist-types/commands/GetLatestConfigurationCommand.d.ts CHANGED
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AppConfigDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppConfigDataClient";
5
5
  import { GetLatestConfigurationRequest, GetLatestConfigurationResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetLatestConfigurationCommand}.
8
10
  */
9
11
  export interface GetLatestConfigurationCommandInput extends GetLatestConfigurationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetLatestConfigurationCommand}.
13
17
  */
14
18
  export interface GetLatestConfigurationCommandOutput extends GetLatestConfigurationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the latest deployed configuration. This API may return empty configuration
18
23
  * data if the client already has the latest version. For more information about this API
19
24
  * 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
@@ -45,6 +50,8 @@ export interface GetLatestConfigurationCommandOutput extends GetLatestConfigurat
45
50
  * const response = await client.send(command);
46
51
  * ```
47
52
  *
53
+ * @param GetLatestConfigurationCommandInput - {@link GetLatestConfigurationCommandInput}
54
+ * @returns {@link GetLatestConfigurationCommandOutput}
48
55
  * @see {@link GetLatestConfigurationCommandInput} for command's `input` shape.
49
56
  * @see {@link GetLatestConfigurationCommandOutput} for command's `response` shape.
50
57
  * @see {@link AppConfigDataClientResolvedConfig | config} for AppConfigDataClient's `config` shape.
@@ -66,11 +73,20 @@ export interface GetLatestConfigurationCommandOutput extends GetLatestConfigurat
66
73
  export declare class GetLatestConfigurationCommand extends $Command<GetLatestConfigurationCommandInput, GetLatestConfigurationCommandOutput, AppConfigDataClientResolvedConfig> {
67
74
  readonly input: GetLatestConfigurationCommandInput;
68
75
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
76
+ /**
77
+ * @public
78
+ */
69
79
  constructor(input: GetLatestConfigurationCommandInput);
70
80
  /**
71
81
  * @internal
72
82
  */
73
83
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AppConfigDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetLatestConfigurationCommandInput, GetLatestConfigurationCommandOutput>;
84
+ /**
85
+ * @internal
86
+ */
74
87
  private serialize;
88
+ /**
89
+ * @internal
90
+ */
75
91
  private deserialize;
76
92
  }
package/dist-types/commands/StartConfigurationSessionCommand.d.ts CHANGED
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AppConfigDataClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AppConfigDataClient";
5
5
  import { StartConfigurationSessionRequest, StartConfigurationSessionResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StartConfigurationSessionCommand}.
8
10
  */
9
11
  export interface StartConfigurationSessionCommandInput extends StartConfigurationSessionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StartConfigurationSessionCommand}.
13
17
  */
14
18
  export interface StartConfigurationSessionCommandOutput extends StartConfigurationSessionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Starts a configuration session used to retrieve a deployed configuration. For more
18
23
  * information about this API action and to view example CLI commands that show how to use
19
24
  * 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
@@ -28,6 +33,8 @@ export interface StartConfigurationSessionCommandOutput extends StartConfigurati
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param StartConfigurationSessionCommandInput - {@link StartConfigurationSessionCommandInput}
37
+ * @returns {@link StartConfigurationSessionCommandOutput}
31
38
  * @see {@link StartConfigurationSessionCommandInput} for command's `input` shape.
32
39
  * @see {@link StartConfigurationSessionCommandOutput} for command's `response` shape.
33
40
  * @see {@link AppConfigDataClientResolvedConfig | config} for AppConfigDataClient's `config` shape.
@@ -49,11 +56,20 @@ export interface StartConfigurationSessionCommandOutput extends StartConfigurati
49
56
  export declare class StartConfigurationSessionCommand extends $Command<StartConfigurationSessionCommandInput, StartConfigurationSessionCommandOutput, AppConfigDataClientResolvedConfig> {
50
57
  readonly input: StartConfigurationSessionCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: StartConfigurationSessionCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AppConfigDataClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartConfigurationSessionCommandInput, StartConfigurationSessionCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
package/dist-types/models/AppConfigDataServiceException.d.ts CHANGED
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from AppConfigData service.
4
6
  */
5
7
  export declare class AppConfigDataServiceException extends __ServiceException {
package/dist-types/models/models_0.d.ts CHANGED
@@ -1,5 +1,8 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { AppConfigDataServiceException as __BaseException } from "./AppConfigDataServiceException";
3
+ /**
4
+ * @public
5
+ */
3
6
  export declare enum InvalidParameterProblem {
4
7
  /**
5
8
  * The parameter was corrupted and could not be understood by the service.
@@ -15,6 +18,7 @@ export declare enum InvalidParameterProblem {
15
18
  POLL_INTERVAL_NOT_SATISFIED = "PollIntervalNotSatisfied"
16
19
  }
17
20
  /**
21
+ * @public
18
22
  * <p>Information about an invalid parameter.</p>
19
23
  */
20
24
  export interface InvalidParameterDetail {
@@ -24,10 +28,14 @@ export interface InvalidParameterDetail {
24
28
  Problem?: InvalidParameterProblem | string;
25
29
  }
26
30
  /**
31
+ * @public
27
32
  * <p>Detailed information about the input that failed to satisfy the constraints specified by
28
33
  * a call.</p>
29
34
  */
30
35
  export type BadRequestDetails = BadRequestDetails.InvalidParametersMember | BadRequestDetails.$UnknownMember;
36
+ /**
37
+ * @public
38
+ */
31
39
  export declare namespace BadRequestDetails {
32
40
  /**
33
41
  * <p>One or more specified parameters are not valid for the call.</p>
@@ -46,6 +54,9 @@ export declare namespace BadRequestDetails {
46
54
  }
47
55
  const visit: <T>(value: BadRequestDetails, visitor: Visitor<T>) => T;
48
56
  }
57
+ /**
58
+ * @public
59
+ */
49
60
  export declare enum BadRequestReason {
50
61
  /**
51
62
  * Indicates there was a problem with one or more of the parameters.
@@ -54,6 +65,7 @@ export declare enum BadRequestReason {
54
65
  INVALID_PARAMETERS = "InvalidParameters"
55
66
  }
56
67
  /**
68
+ * @public
57
69
  * <p>The input fails to satisfy the constraints specified by the service.</p>
58
70
  */
59
71
  export declare class BadRequestException extends __BaseException {
@@ -74,6 +86,7 @@ export declare class BadRequestException extends __BaseException {
74
86
  constructor(opts: __ExceptionOptionType<BadRequestException, __BaseException>);
75
87
  }
76
88
  /**
89
+ * @public
77
90
  * <p>There was an internal failure in the service.</p>
78
91
  */
79
92
  export declare class InternalServerException extends __BaseException {
@@ -85,6 +98,9 @@ export declare class InternalServerException extends __BaseException {
85
98
  */
86
99
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
87
100
  }
101
+ /**
102
+ * @public
103
+ */
88
104
  export declare enum ResourceType {
89
105
  /**
90
106
  * Resource type value for the Application resource.
@@ -108,6 +124,7 @@ export declare enum ResourceType {
108
124
  ENVIRONMENT = "Environment"
109
125
  }
110
126
  /**
127
+ * @public
111
128
  * <p>The requested resource could not be found.</p>
112
129
  */
113
130
  export declare class ResourceNotFoundException extends __BaseException {
@@ -128,6 +145,9 @@ export declare class ResourceNotFoundException extends __BaseException {
128
145
  */
129
146
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
130
147
  }
148
+ /**
149
+ * @public
150
+ */
131
151
  export interface StartConfigurationSessionRequest {
132
152
  /**
133
153
  * <p>The application ID or the application name.</p>
@@ -148,6 +168,9 @@ export interface StartConfigurationSessionRequest {
148
168
  */
149
169
  RequiredMinimumPollIntervalInSeconds?: number;
150
170
  }
171
+ /**
172
+ * @public
173
+ */
151
174
  export interface StartConfigurationSessionResponse {
152
175
  /**
153
176
  * <p>Token encapsulating state about the configuration session. Provide this token to the
@@ -168,6 +191,7 @@ export interface StartConfigurationSessionResponse {
168
191
  InitialConfigurationToken?: string;
169
192
  }
170
193
  /**
194
+ * @public
171
195
  * <p>The request was denied due to request throttling.</p>
172
196
  */
173
197
  export declare class ThrottlingException extends __BaseException {
@@ -179,6 +203,9 @@ export declare class ThrottlingException extends __BaseException {
179
203
  */
180
204
  constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
181
205
  }
206
+ /**
207
+ * @public
208
+ */
182
209
  export interface GetLatestConfigurationRequest {
183
210
  /**
184
211
  * <p>Token describing the current state of the configuration session. To obtain a token,
@@ -195,6 +222,9 @@ export interface GetLatestConfigurationRequest {
195
222
  */
196
223
  ConfigurationToken: string | undefined;
197
224
  }
225
+ /**
226
+ * @public
227
+ */
198
228
  export interface GetLatestConfigurationResponse {
199
229
  /**
200
230
  * <p>The latest token describing the current state of the configuration session. This
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.295.0",
4
+ "version": "3.297.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",
@@ -20,37 +20,37 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.295.0",
24
- "@aws-sdk/config-resolver": "3.295.0",
25
- "@aws-sdk/credential-provider-node": "3.295.0",
26
- "@aws-sdk/fetch-http-handler": "3.295.0",
27
- "@aws-sdk/hash-node": "3.295.0",
28
- "@aws-sdk/invalid-dependency": "3.295.0",
29
- "@aws-sdk/middleware-content-length": "3.295.0",
30
- "@aws-sdk/middleware-endpoint": "3.295.0",
31
- "@aws-sdk/middleware-host-header": "3.295.0",
32
- "@aws-sdk/middleware-logger": "3.295.0",
33
- "@aws-sdk/middleware-recursion-detection": "3.295.0",
34
- "@aws-sdk/middleware-retry": "3.295.0",
35
- "@aws-sdk/middleware-serde": "3.295.0",
36
- "@aws-sdk/middleware-signing": "3.295.0",
37
- "@aws-sdk/middleware-stack": "3.295.0",
38
- "@aws-sdk/middleware-user-agent": "3.295.0",
39
- "@aws-sdk/node-config-provider": "3.295.0",
40
- "@aws-sdk/node-http-handler": "3.295.0",
41
- "@aws-sdk/protocol-http": "3.295.0",
42
- "@aws-sdk/smithy-client": "3.295.0",
43
- "@aws-sdk/types": "3.295.0",
44
- "@aws-sdk/url-parser": "3.295.0",
23
+ "@aws-sdk/client-sts": "3.297.0",
24
+ "@aws-sdk/config-resolver": "3.296.0",
25
+ "@aws-sdk/credential-provider-node": "3.297.0",
26
+ "@aws-sdk/fetch-http-handler": "3.296.0",
27
+ "@aws-sdk/hash-node": "3.296.0",
28
+ "@aws-sdk/invalid-dependency": "3.296.0",
29
+ "@aws-sdk/middleware-content-length": "3.296.0",
30
+ "@aws-sdk/middleware-endpoint": "3.296.0",
31
+ "@aws-sdk/middleware-host-header": "3.296.0",
32
+ "@aws-sdk/middleware-logger": "3.296.0",
33
+ "@aws-sdk/middleware-recursion-detection": "3.296.0",
34
+ "@aws-sdk/middleware-retry": "3.296.0",
35
+ "@aws-sdk/middleware-serde": "3.296.0",
36
+ "@aws-sdk/middleware-signing": "3.296.0",
37
+ "@aws-sdk/middleware-stack": "3.296.0",
38
+ "@aws-sdk/middleware-user-agent": "3.296.0",
39
+ "@aws-sdk/node-config-provider": "3.296.0",
40
+ "@aws-sdk/node-http-handler": "3.296.0",
41
+ "@aws-sdk/protocol-http": "3.296.0",
42
+ "@aws-sdk/smithy-client": "3.296.0",
43
+ "@aws-sdk/types": "3.296.0",
44
+ "@aws-sdk/url-parser": "3.296.0",
45
45
  "@aws-sdk/util-base64": "3.295.0",
46
46
  "@aws-sdk/util-body-length-browser": "3.295.0",
47
47
  "@aws-sdk/util-body-length-node": "3.295.0",
48
- "@aws-sdk/util-defaults-mode-browser": "3.295.0",
49
- "@aws-sdk/util-defaults-mode-node": "3.295.0",
50
- "@aws-sdk/util-endpoints": "3.295.0",
51
- "@aws-sdk/util-retry": "3.295.0",
52
- "@aws-sdk/util-user-agent-browser": "3.295.0",
53
- "@aws-sdk/util-user-agent-node": "3.295.0",
48
+ "@aws-sdk/util-defaults-mode-browser": "3.296.0",
49
+ "@aws-sdk/util-defaults-mode-node": "3.296.0",
50
+ "@aws-sdk/util-endpoints": "3.296.0",
51
+ "@aws-sdk/util-retry": "3.296.0",
52
+ "@aws-sdk/util-user-agent-browser": "3.296.0",
53
+ "@aws-sdk/util-user-agent-node": "3.296.0",
54
54
  "@aws-sdk/util-utf8": "3.295.0",
55
55
  "tslib": "^2.5.0"
56
56
  },