Skip to content

Commit d52f7e6

Browse files
AllanZhengYPAllanZhengYP
authored
docs(clients): update clients input and resolved config to interface (#2304)
This is a follow up to #2270 for the newly generated clients
1 parent 28008c2 commit d52f7e6

File tree

14 files changed

+182
-28
lines changed

14 files changed

+182
-28
lines changed

‎clients/client-amp/AmpClient.ts

+13-2
Original file line numberDiff line numberDiff line change
@@ -167,23 +167,31 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
167167
defaultUserAgentProvider?: Provider<__UserAgent>;
168168
}
169169

170-
export type AmpClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
170+
type AmpClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
171171
ClientDefaults &
172172
RegionInputConfig &
173173
EndpointsInputConfig &
174174
RetryInputConfig &
175175
HostHeaderInputConfig &
176176
AwsAuthInputConfig &
177177
UserAgentInputConfig;
178+
/**
179+
* The configuration interface of AmpClient class constructor that set the region, credentials and other options.
180+
*/
181+
export interface AmpClientConfig extends AmpClientConfigType {}
178182

179-
export type AmpClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
183+
type AmpClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
180184
Required<ClientDefaults> &
181185
RegionResolvedConfig &
182186
EndpointsResolvedConfig &
183187
RetryResolvedConfig &
184188
HostHeaderResolvedConfig &
185189
AwsAuthResolvedConfig &
186190
UserAgentResolvedConfig;
191+
/**
192+
* The resolved configuration interface of AmpClient class. This is resolved and normalized from the {@link AmpClientConfig | constructor configuration interface}.
193+
*/
194+
export interface AmpClientResolvedConfig extends AmpClientResolvedConfigType {}
187195

188196
/**
189197
* Amazon Managed Service for Prometheus
@@ -194,6 +202,9 @@ export class AmpClient extends __Client<
194202
ServiceOutputTypes,
195203
AmpClientResolvedConfig
196204
> {
205+
/**
206+
* The resolved configuration of AmpClient class. This is resolved and normalized from the {@link AmpClientConfig | constructor configuration interface}.
207+
*/
197208
readonly config: AmpClientResolvedConfig;
198209

199210
constructor(configuration: AmpClientConfig) {

‎clients/client-fis/FisClient.ts

+13-2
Original file line numberDiff line numberDiff line change
@@ -209,23 +209,31 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
209209
defaultUserAgentProvider?: Provider<__UserAgent>;
210210
}
211211

212-
export type FisClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
212+
type FisClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
213213
ClientDefaults &
214214
RegionInputConfig &
215215
EndpointsInputConfig &
216216
RetryInputConfig &
217217
HostHeaderInputConfig &
218218
AwsAuthInputConfig &
219219
UserAgentInputConfig;
220+
/**
221+
* The configuration interface of FisClient class constructor that set the region, credentials and other options.
222+
*/
223+
export interface FisClientConfig extends FisClientConfigType {}
220224

221-
export type FisClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
225+
type FisClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
222226
Required<ClientDefaults> &
223227
RegionResolvedConfig &
224228
EndpointsResolvedConfig &
225229
RetryResolvedConfig &
226230
HostHeaderResolvedConfig &
227231
AwsAuthResolvedConfig &
228232
UserAgentResolvedConfig;
233+
/**
234+
* The resolved configuration interface of FisClient class. This is resolved and normalized from the {@link FisClientConfig | constructor configuration interface}.
235+
*/
236+
export interface FisClientResolvedConfig extends FisClientResolvedConfigType {}
229237

230238
/**
231239
* <p>AWS Fault Injection Simulator is a managed service that enables you to perform fault injection
@@ -237,6 +245,9 @@ export class FisClient extends __Client<
237245
ServiceOutputTypes,
238246
FisClientResolvedConfig
239247
> {
248+
/**
249+
* The resolved configuration of FisClient class. This is resolved and normalized from the {@link FisClientConfig | constructor configuration interface}.
250+
*/
240251
readonly config: FisClientResolvedConfig;
241252

242253
constructor(configuration: FisClientConfig) {

‎clients/client-greengrassv2/GreengrassV2Client.ts

+13-2
Original file line numberDiff line numberDiff line change
@@ -230,23 +230,31 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
230230
defaultUserAgentProvider?: Provider<__UserAgent>;
231231
}
232232

233-
export type GreengrassV2ClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
233+
type GreengrassV2ClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
234234
ClientDefaults &
235235
RegionInputConfig &
236236
EndpointsInputConfig &
237237
RetryInputConfig &
238238
HostHeaderInputConfig &
239239
AwsAuthInputConfig &
240240
UserAgentInputConfig;
241+
/**
242+
* The configuration interface of GreengrassV2Client class constructor that set the region, credentials and other options.
243+
*/
244+
export interface GreengrassV2ClientConfig extends GreengrassV2ClientConfigType {}
241245

242-
export type GreengrassV2ClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
246+
type GreengrassV2ClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
243247
Required<ClientDefaults> &
244248
RegionResolvedConfig &
245249
EndpointsResolvedConfig &
246250
RetryResolvedConfig &
247251
HostHeaderResolvedConfig &
248252
AwsAuthResolvedConfig &
249253
UserAgentResolvedConfig;
254+
/**
255+
* The resolved configuration interface of GreengrassV2Client class. This is resolved and normalized from the {@link GreengrassV2ClientConfig | constructor configuration interface}.
256+
*/
257+
export interface GreengrassV2ClientResolvedConfig extends GreengrassV2ClientResolvedConfigType {}
250258

251259
/**
252260
* <p>AWS IoT Greengrass brings local compute, messaging, data management, sync, and ML inference capabilities
@@ -267,6 +275,9 @@ export class GreengrassV2Client extends __Client<
267275
ServiceOutputTypes,
268276
GreengrassV2ClientResolvedConfig
269277
> {
278+
/**
279+
* The resolved configuration of GreengrassV2Client class. This is resolved and normalized from the {@link GreengrassV2ClientConfig | constructor configuration interface}.
280+
*/
270281
readonly config: GreengrassV2ClientResolvedConfig;
271282

272283
constructor(configuration: GreengrassV2ClientConfig) {

‎clients/client-iot-wireless/IoTWirelessClient.ts

+13-2
Original file line numberDiff line numberDiff line change
@@ -410,23 +410,31 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
410410
defaultUserAgentProvider?: Provider<__UserAgent>;
411411
}
412412

413-
export type IoTWirelessClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
413+
type IoTWirelessClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
414414
ClientDefaults &
415415
RegionInputConfig &
416416
EndpointsInputConfig &
417417
RetryInputConfig &
418418
HostHeaderInputConfig &
419419
AwsAuthInputConfig &
420420
UserAgentInputConfig;
421+
/**
422+
* The configuration interface of IoTWirelessClient class constructor that set the region, credentials and other options.
423+
*/
424+
export interface IoTWirelessClientConfig extends IoTWirelessClientConfigType {}
421425

422-
export type IoTWirelessClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
426+
type IoTWirelessClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
423427
Required<ClientDefaults> &
424428
RegionResolvedConfig &
425429
EndpointsResolvedConfig &
426430
RetryResolvedConfig &
427431
HostHeaderResolvedConfig &
428432
AwsAuthResolvedConfig &
429433
UserAgentResolvedConfig;
434+
/**
435+
* The resolved configuration interface of IoTWirelessClient class. This is resolved and normalized from the {@link IoTWirelessClientConfig | constructor configuration interface}.
436+
*/
437+
export interface IoTWirelessClientResolvedConfig extends IoTWirelessClientResolvedConfigType {}
430438

431439
/**
432440
* <p>AWS IoT Wireless API documentation</p>
@@ -437,6 +445,9 @@ export class IoTWirelessClient extends __Client<
437445
ServiceOutputTypes,
438446
IoTWirelessClientResolvedConfig
439447
> {
448+
/**
449+
* The resolved configuration of IoTWirelessClient class. This is resolved and normalized from the {@link IoTWirelessClientConfig | constructor configuration interface}.
450+
*/
440451
readonly config: IoTWirelessClientResolvedConfig;
441452

442453
constructor(configuration: IoTWirelessClientConfig) {

‎clients/client-iotdeviceadvisor/IotDeviceAdvisorClient.ts

+13-2
Original file line numberDiff line numberDiff line change
@@ -203,23 +203,31 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
203203
defaultUserAgentProvider?: Provider<__UserAgent>;
204204
}
205205

206-
export type IotDeviceAdvisorClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
206+
type IotDeviceAdvisorClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
207207
ClientDefaults &
208208
RegionInputConfig &
209209
EndpointsInputConfig &
210210
RetryInputConfig &
211211
HostHeaderInputConfig &
212212
AwsAuthInputConfig &
213213
UserAgentInputConfig;
214+
/**
215+
* The configuration interface of IotDeviceAdvisorClient class constructor that set the region, credentials and other options.
216+
*/
217+
export interface IotDeviceAdvisorClientConfig extends IotDeviceAdvisorClientConfigType {}
214218

215-
export type IotDeviceAdvisorClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
219+
type IotDeviceAdvisorClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
216220
Required<ClientDefaults> &
217221
RegionResolvedConfig &
218222
EndpointsResolvedConfig &
219223
RetryResolvedConfig &
220224
HostHeaderResolvedConfig &
221225
AwsAuthResolvedConfig &
222226
UserAgentResolvedConfig;
227+
/**
228+
* The resolved configuration interface of IotDeviceAdvisorClient class. This is resolved and normalized from the {@link IotDeviceAdvisorClientConfig | constructor configuration interface}.
229+
*/
230+
export interface IotDeviceAdvisorClientResolvedConfig extends IotDeviceAdvisorClientResolvedConfigType {}
223231

224232
/**
225233
* <p>AWS IoT Core Device Advisor is a cloud-based, fully managed test capability for validating IoT devices during device software development. Device Advisor provides pre-built tests that you can use to validate IoT devices for reliable and secure connectivity with AWS IoT Core before deploying devices to production. By using Device Advisor, you can confirm that your devices can connect to AWS IoT Core, follow security best practices and, if applicable, receive software updates from IoT Device Management. You can also download signed qualification reports to submit to the AWS Partner Network to get your device qualified for the AWS Partner Device Catalog without the need to send your device in and wait for it to be tested.</p>
@@ -230,6 +238,9 @@ export class IotDeviceAdvisorClient extends __Client<
230238
ServiceOutputTypes,
231239
IotDeviceAdvisorClientResolvedConfig
232240
> {
241+
/**
242+
* The resolved configuration of IotDeviceAdvisorClient class. This is resolved and normalized from the {@link IotDeviceAdvisorClientConfig | constructor configuration interface}.
243+
*/
233244
readonly config: IotDeviceAdvisorClientResolvedConfig;
234245

235246
constructor(configuration: IotDeviceAdvisorClientConfig) {

‎clients/client-iotfleethub/IoTFleetHubClient.ts

+13-2
Original file line numberDiff line numberDiff line change
@@ -179,23 +179,31 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
179179
defaultUserAgentProvider?: Provider<__UserAgent>;
180180
}
181181

182-
export type IoTFleetHubClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
182+
type IoTFleetHubClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
183183
ClientDefaults &
184184
RegionInputConfig &
185185
EndpointsInputConfig &
186186
RetryInputConfig &
187187
HostHeaderInputConfig &
188188
AwsAuthInputConfig &
189189
UserAgentInputConfig;
190+
/**
191+
* The configuration interface of IoTFleetHubClient class constructor that set the region, credentials and other options.
192+
*/
193+
export interface IoTFleetHubClientConfig extends IoTFleetHubClientConfigType {}
190194

191-
export type IoTFleetHubClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
195+
type IoTFleetHubClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
192196
Required<ClientDefaults> &
193197
RegionResolvedConfig &
194198
EndpointsResolvedConfig &
195199
RetryResolvedConfig &
196200
HostHeaderResolvedConfig &
197201
AwsAuthResolvedConfig &
198202
UserAgentResolvedConfig;
203+
/**
204+
* The resolved configuration interface of IoTFleetHubClient class. This is resolved and normalized from the {@link IoTFleetHubClientConfig | constructor configuration interface}.
205+
*/
206+
export interface IoTFleetHubClientResolvedConfig extends IoTFleetHubClientResolvedConfigType {}
199207

200208
/**
201209
* <p>With Fleet Hub for AWS IoT Device Management you can build stand-alone web applications for monitoring the health of your device fleets.</p>
@@ -209,6 +217,9 @@ export class IoTFleetHubClient extends __Client<
209217
ServiceOutputTypes,
210218
IoTFleetHubClientResolvedConfig
211219
> {
220+
/**
221+
* The resolved configuration of IoTFleetHubClient class. This is resolved and normalized from the {@link IoTFleetHubClientConfig | constructor configuration interface}.
222+
*/
212223
readonly config: IoTFleetHubClientResolvedConfig;
213224

214225
constructor(configuration: IoTFleetHubClientConfig) {

‎clients/client-lex-models-v2/LexModelsV2Client.ts

+13-2
Original file line numberDiff line numberDiff line change
@@ -275,23 +275,31 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
275275
defaultUserAgentProvider?: Provider<__UserAgent>;
276276
}
277277

278-
export type LexModelsV2ClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
278+
type LexModelsV2ClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
279279
ClientDefaults &
280280
RegionInputConfig &
281281
EndpointsInputConfig &
282282
RetryInputConfig &
283283
HostHeaderInputConfig &
284284
AwsAuthInputConfig &
285285
UserAgentInputConfig;
286+
/**
287+
* The configuration interface of LexModelsV2Client class constructor that set the region, credentials and other options.
288+
*/
289+
export interface LexModelsV2ClientConfig extends LexModelsV2ClientConfigType {}
286290

287-
export type LexModelsV2ClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
291+
type LexModelsV2ClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
288292
Required<ClientDefaults> &
289293
RegionResolvedConfig &
290294
EndpointsResolvedConfig &
291295
RetryResolvedConfig &
292296
HostHeaderResolvedConfig &
293297
AwsAuthResolvedConfig &
294298
UserAgentResolvedConfig;
299+
/**
300+
* The resolved configuration interface of LexModelsV2Client class. This is resolved and normalized from the {@link LexModelsV2ClientConfig | constructor configuration interface}.
301+
*/
302+
export interface LexModelsV2ClientResolvedConfig extends LexModelsV2ClientResolvedConfigType {}
295303

296304
/**
297305
* <p></p>
@@ -302,6 +310,9 @@ export class LexModelsV2Client extends __Client<
302310
ServiceOutputTypes,
303311
LexModelsV2ClientResolvedConfig
304312
> {
313+
/**
314+
* The resolved configuration of LexModelsV2Client class. This is resolved and normalized from the {@link LexModelsV2ClientConfig | constructor configuration interface}.
315+
*/
305316
readonly config: LexModelsV2ClientResolvedConfig;
306317

307318
constructor(configuration: LexModelsV2ClientConfig) {

‎clients/client-lex-runtime-v2/LexRuntimeV2Client.ts

+13-2
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
189189
eventStreamSerdeProvider?: __EventStreamSerdeProvider;
190190
}
191191

192-
export type LexRuntimeV2ClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
192+
type LexRuntimeV2ClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
193193
ClientDefaults &
194194
RegionInputConfig &
195195
EndpointsInputConfig &
@@ -199,8 +199,12 @@ export type LexRuntimeV2ClientConfig = Partial<__SmithyConfiguration<__HttpHandl
199199
EventStreamInputConfig &
200200
UserAgentInputConfig &
201201
EventStreamSerdeInputConfig;
202+
/**
203+
* The configuration interface of LexRuntimeV2Client class constructor that set the region, credentials and other options.
204+
*/
205+
export interface LexRuntimeV2ClientConfig extends LexRuntimeV2ClientConfigType {}
202206

203-
export type LexRuntimeV2ClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
207+
type LexRuntimeV2ClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
204208
Required<ClientDefaults> &
205209
RegionResolvedConfig &
206210
EndpointsResolvedConfig &
@@ -210,6 +214,10 @@ export type LexRuntimeV2ClientResolvedConfig = __SmithyResolvedConfiguration<__H
210214
EventStreamResolvedConfig &
211215
UserAgentResolvedConfig &
212216
EventStreamSerdeResolvedConfig;
217+
/**
218+
* The resolved configuration interface of LexRuntimeV2Client class. This is resolved and normalized from the {@link LexRuntimeV2ClientConfig | constructor configuration interface}.
219+
*/
220+
export interface LexRuntimeV2ClientResolvedConfig extends LexRuntimeV2ClientResolvedConfigType {}
213221

214222
/**
215223
* <p></p>
@@ -220,6 +228,9 @@ export class LexRuntimeV2Client extends __Client<
220228
ServiceOutputTypes,
221229
LexRuntimeV2ClientResolvedConfig
222230
> {
231+
/**
232+
* The resolved configuration of LexRuntimeV2Client class. This is resolved and normalized from the {@link LexRuntimeV2ClientConfig | constructor configuration interface}.
233+
*/
223234
readonly config: LexRuntimeV2ClientResolvedConfig;
224235

225236
constructor(configuration: LexRuntimeV2ClientConfig) {

‎clients/client-location/LocationClient.ts

+13-2
Original file line numberDiff line numberDiff line change
@@ -299,23 +299,31 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
299299
defaultUserAgentProvider?: Provider<__UserAgent>;
300300
}
301301

302-
export type LocationClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
302+
type LocationClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
303303
ClientDefaults &
304304
RegionInputConfig &
305305
EndpointsInputConfig &
306306
RetryInputConfig &
307307
HostHeaderInputConfig &
308308
AwsAuthInputConfig &
309309
UserAgentInputConfig;
310+
/**
311+
* The configuration interface of LocationClient class constructor that set the region, credentials and other options.
312+
*/
313+
export interface LocationClientConfig extends LocationClientConfigType {}
310314

311-
export type LocationClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
315+
type LocationClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
312316
Required<ClientDefaults> &
313317
RegionResolvedConfig &
314318
EndpointsResolvedConfig &
315319
RetryResolvedConfig &
316320
HostHeaderResolvedConfig &
317321
AwsAuthResolvedConfig &
318322
UserAgentResolvedConfig;
323+
/**
324+
* The resolved configuration interface of LocationClient class. This is resolved and normalized from the {@link LocationClientConfig | constructor configuration interface}.
325+
*/
326+
export interface LocationClientResolvedConfig extends LocationClientResolvedConfigType {}
319327

320328
/**
321329
* Suite of geospatial services including Maps, Places, Tracking, and Geofencing
@@ -326,6 +334,9 @@ export class LocationClient extends __Client<
326334
ServiceOutputTypes,
327335
LocationClientResolvedConfig
328336
> {
337+
/**
338+
* The resolved configuration of LocationClient class. This is resolved and normalized from the {@link LocationClientConfig | constructor configuration interface}.
339+
*/
329340
readonly config: LocationClientResolvedConfig;
330341

331342
constructor(configuration: LocationClientConfig) {

0 commit comments

Comments
 (0)