Skip to content

Commit 9ab71e8

Browse files
AllanZhengYPAllanZhengYP
authored
docs(clients): use interface for client input and resolved config (#2270)
1 parent 6efd5cf commit 9ab71e8

File tree

252 files changed

+3286
-504
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

252 files changed

+3286
-504
lines changed

‎clients/client-accessanalyzer/AccessAnalyzerClient.ts

+13-2
Original file line numberDiff line numberDiff line change
@@ -257,23 +257,31 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
257257
defaultUserAgentProvider?: Provider<__UserAgent>;
258258
}
259259

260-
export type AccessAnalyzerClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
260+
type AccessAnalyzerClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
261261
ClientDefaults &
262262
RegionInputConfig &
263263
EndpointsInputConfig &
264264
RetryInputConfig &
265265
HostHeaderInputConfig &
266266
AwsAuthInputConfig &
267267
UserAgentInputConfig;
268+
/**
269+
* The configuration interface of AccessAnalyzerClient class constructor that set the region, credentials and other options.
270+
*/
271+
export interface AccessAnalyzerClientConfig extends AccessAnalyzerClientConfigType {}
268272

269-
export type AccessAnalyzerClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
273+
type AccessAnalyzerClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
270274
Required<ClientDefaults> &
271275
RegionResolvedConfig &
272276
EndpointsResolvedConfig &
273277
RetryResolvedConfig &
274278
HostHeaderResolvedConfig &
275279
AwsAuthResolvedConfig &
276280
UserAgentResolvedConfig;
281+
/**
282+
* The resolved configuration interface of AccessAnalyzerClient class. This is resolved and normalized from the {@link AccessAnalyzerClientConfig | constructor configuration interface}.
283+
*/
284+
export interface AccessAnalyzerClientResolvedConfig extends AccessAnalyzerClientResolvedConfigType {}
277285

278286
/**
279287
* <p>AWS IAM Access Analyzer helps identify potential resource-access risks by enabling you to identify
@@ -292,6 +300,9 @@ export class AccessAnalyzerClient extends __Client<
292300
ServiceOutputTypes,
293301
AccessAnalyzerClientResolvedConfig
294302
> {
303+
/**
304+
* The resolved configuration of AccessAnalyzerClient class. This is resolved and normalized from the {@link AccessAnalyzerClientConfig | constructor configuration interface}.
305+
*/
295306
readonly config: AccessAnalyzerClientResolvedConfig;
296307

297308
constructor(configuration: AccessAnalyzerClientConfig) {

‎clients/client-acm-pca/ACMPCAClient.ts

+13-2
Original file line numberDiff line numberDiff line change
@@ -257,23 +257,31 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
257257
defaultUserAgentProvider?: Provider<__UserAgent>;
258258
}
259259

260-
export type ACMPCAClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
260+
type ACMPCAClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
261261
ClientDefaults &
262262
RegionInputConfig &
263263
EndpointsInputConfig &
264264
RetryInputConfig &
265265
HostHeaderInputConfig &
266266
AwsAuthInputConfig &
267267
UserAgentInputConfig;
268+
/**
269+
* The configuration interface of ACMPCAClient class constructor that set the region, credentials and other options.
270+
*/
271+
export interface ACMPCAClientConfig extends ACMPCAClientConfigType {}
268272

269-
export type ACMPCAClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
273+
type ACMPCAClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
270274
Required<ClientDefaults> &
271275
RegionResolvedConfig &
272276
EndpointsResolvedConfig &
273277
RetryResolvedConfig &
274278
HostHeaderResolvedConfig &
275279
AwsAuthResolvedConfig &
276280
UserAgentResolvedConfig;
281+
/**
282+
* The resolved configuration interface of ACMPCAClient class. This is resolved and normalized from the {@link ACMPCAClientConfig | constructor configuration interface}.
283+
*/
284+
export interface ACMPCAClientResolvedConfig extends ACMPCAClientResolvedConfigType {}
277285

278286
/**
279287
* <p>This is the <i>ACM Private CA API Reference</i>. It provides descriptions,
@@ -296,6 +304,9 @@ export class ACMPCAClient extends __Client<
296304
ServiceOutputTypes,
297305
ACMPCAClientResolvedConfig
298306
> {
307+
/**
308+
* The resolved configuration of ACMPCAClient class. This is resolved and normalized from the {@link ACMPCAClientConfig | constructor configuration interface}.
309+
*/
299310
readonly config: ACMPCAClientResolvedConfig;
300311

301312
constructor(configuration: ACMPCAClientConfig) {

‎clients/client-acm/ACMClient.ts

+13-2
Original file line numberDiff line numberDiff line change
@@ -218,23 +218,31 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
218218
defaultUserAgentProvider?: Provider<__UserAgent>;
219219
}
220220

221-
export type ACMClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
221+
type ACMClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
222222
ClientDefaults &
223223
RegionInputConfig &
224224
EndpointsInputConfig &
225225
RetryInputConfig &
226226
HostHeaderInputConfig &
227227
AwsAuthInputConfig &
228228
UserAgentInputConfig;
229+
/**
230+
* The configuration interface of ACMClient class constructor that set the region, credentials and other options.
231+
*/
232+
export interface ACMClientConfig extends ACMClientConfigType {}
229233

230-
export type ACMClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
234+
type ACMClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
231235
Required<ClientDefaults> &
232236
RegionResolvedConfig &
233237
EndpointsResolvedConfig &
234238
RetryResolvedConfig &
235239
HostHeaderResolvedConfig &
236240
AwsAuthResolvedConfig &
237241
UserAgentResolvedConfig;
242+
/**
243+
* The resolved configuration interface of ACMClient class. This is resolved and normalized from the {@link ACMClientConfig | constructor configuration interface}.
244+
*/
245+
export interface ACMClientResolvedConfig extends ACMClientResolvedConfigType {}
238246

239247
/**
240248
* <fullname>AWS Certificate Manager</fullname>
@@ -247,6 +255,9 @@ export class ACMClient extends __Client<
247255
ServiceOutputTypes,
248256
ACMClientResolvedConfig
249257
> {
258+
/**
259+
* The resolved configuration of ACMClient class. This is resolved and normalized from the {@link ACMClientConfig | constructor configuration interface}.
260+
*/
250261
readonly config: ACMClientResolvedConfig;
251262

252263
constructor(configuration: ACMClientConfig) {

‎clients/client-alexa-for-business/AlexaForBusinessClient.ts

+13-2
Original file line numberDiff line numberDiff line change
@@ -545,23 +545,31 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
545545
defaultUserAgentProvider?: Provider<__UserAgent>;
546546
}
547547

548-
export type AlexaForBusinessClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
548+
type AlexaForBusinessClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
549549
ClientDefaults &
550550
RegionInputConfig &
551551
EndpointsInputConfig &
552552
RetryInputConfig &
553553
HostHeaderInputConfig &
554554
AwsAuthInputConfig &
555555
UserAgentInputConfig;
556+
/**
557+
* The configuration interface of AlexaForBusinessClient class constructor that set the region, credentials and other options.
558+
*/
559+
export interface AlexaForBusinessClientConfig extends AlexaForBusinessClientConfigType {}
556560

557-
export type AlexaForBusinessClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
561+
type AlexaForBusinessClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
558562
Required<ClientDefaults> &
559563
RegionResolvedConfig &
560564
EndpointsResolvedConfig &
561565
RetryResolvedConfig &
562566
HostHeaderResolvedConfig &
563567
AwsAuthResolvedConfig &
564568
UserAgentResolvedConfig;
569+
/**
570+
* The resolved configuration interface of AlexaForBusinessClient class. This is resolved and normalized from the {@link AlexaForBusinessClientConfig | constructor configuration interface}.
571+
*/
572+
export interface AlexaForBusinessClientResolvedConfig extends AlexaForBusinessClientResolvedConfigType {}
565573

566574
/**
567575
* <p>Alexa for Business helps you use Alexa in your organization. Alexa for Business provides you with the tools
@@ -579,6 +587,9 @@ export class AlexaForBusinessClient extends __Client<
579587
ServiceOutputTypes,
580588
AlexaForBusinessClientResolvedConfig
581589
> {
590+
/**
591+
* The resolved configuration of AlexaForBusinessClient class. This is resolved and normalized from the {@link AlexaForBusinessClientConfig | constructor configuration interface}.
592+
*/
582593
readonly config: AlexaForBusinessClientResolvedConfig;
583594

584595
constructor(configuration: AlexaForBusinessClientConfig) {

‎clients/client-amplify/AmplifyClient.ts

+13-2
Original file line numberDiff line numberDiff line change
@@ -290,23 +290,31 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
290290
defaultUserAgentProvider?: Provider<__UserAgent>;
291291
}
292292

293-
export type AmplifyClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
293+
type AmplifyClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
294294
ClientDefaults &
295295
RegionInputConfig &
296296
EndpointsInputConfig &
297297
RetryInputConfig &
298298
HostHeaderInputConfig &
299299
AwsAuthInputConfig &
300300
UserAgentInputConfig;
301+
/**
302+
* The configuration interface of AmplifyClient class constructor that set the region, credentials and other options.
303+
*/
304+
export interface AmplifyClientConfig extends AmplifyClientConfigType {}
301305

302-
export type AmplifyClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
306+
type AmplifyClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
303307
Required<ClientDefaults> &
304308
RegionResolvedConfig &
305309
EndpointsResolvedConfig &
306310
RetryResolvedConfig &
307311
HostHeaderResolvedConfig &
308312
AwsAuthResolvedConfig &
309313
UserAgentResolvedConfig;
314+
/**
315+
* The resolved configuration interface of AmplifyClient class. This is resolved and normalized from the {@link AmplifyClientConfig | constructor configuration interface}.
316+
*/
317+
export interface AmplifyClientResolvedConfig extends AmplifyClientResolvedConfigType {}
310318

311319
/**
312320
* <p>Amplify enables developers to develop and deploy cloud-powered mobile and web apps.
@@ -322,6 +330,9 @@ export class AmplifyClient extends __Client<
322330
ServiceOutputTypes,
323331
AmplifyClientResolvedConfig
324332
> {
333+
/**
334+
* The resolved configuration of AmplifyClient class. This is resolved and normalized from the {@link AmplifyClientConfig | constructor configuration interface}.
335+
*/
325336
readonly config: AmplifyClientResolvedConfig;
326337

327338
constructor(configuration: AmplifyClientConfig) {

‎clients/client-amplifybackend/AmplifyBackendClient.ts

+13-2
Original file line numberDiff line numberDiff line change
@@ -236,23 +236,31 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
236236
defaultUserAgentProvider?: Provider<__UserAgent>;
237237
}
238238

239-
export type AmplifyBackendClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
239+
type AmplifyBackendClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
240240
ClientDefaults &
241241
RegionInputConfig &
242242
EndpointsInputConfig &
243243
RetryInputConfig &
244244
HostHeaderInputConfig &
245245
AwsAuthInputConfig &
246246
UserAgentInputConfig;
247+
/**
248+
* The configuration interface of AmplifyBackendClient class constructor that set the region, credentials and other options.
249+
*/
250+
export interface AmplifyBackendClientConfig extends AmplifyBackendClientConfigType {}
247251

248-
export type AmplifyBackendClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
252+
type AmplifyBackendClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
249253
Required<ClientDefaults> &
250254
RegionResolvedConfig &
251255
EndpointsResolvedConfig &
252256
RetryResolvedConfig &
253257
HostHeaderResolvedConfig &
254258
AwsAuthResolvedConfig &
255259
UserAgentResolvedConfig;
260+
/**
261+
* The resolved configuration interface of AmplifyBackendClient class. This is resolved and normalized from the {@link AmplifyBackendClientConfig | constructor configuration interface}.
262+
*/
263+
export interface AmplifyBackendClientResolvedConfig extends AmplifyBackendClientResolvedConfigType {}
256264

257265
/**
258266
* <p>AWS Amplify Admin API</p>
@@ -263,6 +271,9 @@ export class AmplifyBackendClient extends __Client<
263271
ServiceOutputTypes,
264272
AmplifyBackendClientResolvedConfig
265273
> {
274+
/**
275+
* The resolved configuration of AmplifyBackendClient class. This is resolved and normalized from the {@link AmplifyBackendClientConfig | constructor configuration interface}.
276+
*/
266277
readonly config: AmplifyBackendClientResolvedConfig;
267278

268279
constructor(configuration: AmplifyBackendClientConfig) {

‎clients/client-api-gateway/APIGatewayClient.ts

+13-2
Original file line numberDiff line numberDiff line change
@@ -618,23 +618,31 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
618618
defaultUserAgentProvider?: Provider<__UserAgent>;
619619
}
620620

621-
export type APIGatewayClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
621+
type APIGatewayClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
622622
ClientDefaults &
623623
RegionInputConfig &
624624
EndpointsInputConfig &
625625
RetryInputConfig &
626626
HostHeaderInputConfig &
627627
AwsAuthInputConfig &
628628
UserAgentInputConfig;
629+
/**
630+
* The configuration interface of APIGatewayClient class constructor that set the region, credentials and other options.
631+
*/
632+
export interface APIGatewayClientConfig extends APIGatewayClientConfigType {}
629633

630-
export type APIGatewayClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
634+
type APIGatewayClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
631635
Required<ClientDefaults> &
632636
RegionResolvedConfig &
633637
EndpointsResolvedConfig &
634638
RetryResolvedConfig &
635639
HostHeaderResolvedConfig &
636640
AwsAuthResolvedConfig &
637641
UserAgentResolvedConfig;
642+
/**
643+
* The resolved configuration interface of APIGatewayClient class. This is resolved and normalized from the {@link APIGatewayClientConfig | constructor configuration interface}.
644+
*/
645+
export interface APIGatewayClientResolvedConfig extends APIGatewayClientResolvedConfigType {}
638646

639647
/**
640648
* <fullname>Amazon API Gateway</fullname>
@@ -646,6 +654,9 @@ export class APIGatewayClient extends __Client<
646654
ServiceOutputTypes,
647655
APIGatewayClientResolvedConfig
648656
> {
657+
/**
658+
* The resolved configuration of APIGatewayClient class. This is resolved and normalized from the {@link APIGatewayClientConfig | constructor configuration interface}.
659+
*/
649660
readonly config: APIGatewayClientResolvedConfig;
650661

651662
constructor(configuration: APIGatewayClientConfig) {

‎clients/client-apigatewaymanagementapi/ApiGatewayManagementApiClient.ts

+13-2
Original file line numberDiff line numberDiff line change
@@ -155,23 +155,31 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
155155
defaultUserAgentProvider?: Provider<__UserAgent>;
156156
}
157157

158-
export type ApiGatewayManagementApiClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
158+
type ApiGatewayManagementApiClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
159159
ClientDefaults &
160160
RegionInputConfig &
161161
EndpointsInputConfig &
162162
RetryInputConfig &
163163
HostHeaderInputConfig &
164164
AwsAuthInputConfig &
165165
UserAgentInputConfig;
166+
/**
167+
* The configuration interface of ApiGatewayManagementApiClient class constructor that set the region, credentials and other options.
168+
*/
169+
export interface ApiGatewayManagementApiClientConfig extends ApiGatewayManagementApiClientConfigType {}
166170

167-
export type ApiGatewayManagementApiClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
171+
type ApiGatewayManagementApiClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
168172
Required<ClientDefaults> &
169173
RegionResolvedConfig &
170174
EndpointsResolvedConfig &
171175
RetryResolvedConfig &
172176
HostHeaderResolvedConfig &
173177
AwsAuthResolvedConfig &
174178
UserAgentResolvedConfig;
179+
/**
180+
* The resolved configuration interface of ApiGatewayManagementApiClient class. This is resolved and normalized from the {@link ApiGatewayManagementApiClientConfig | constructor configuration interface}.
181+
*/
182+
export interface ApiGatewayManagementApiClientResolvedConfig extends ApiGatewayManagementApiClientResolvedConfigType {}
175183

176184
/**
177185
* <p>The Amazon API Gateway Management API allows you to directly manage runtime aspects of your deployed APIs. To use it, you must explicitly set the SDK's endpoint to point to the endpoint of your deployed API. The endpoint will be of the form https://{api-id}.execute-api.{region}.amazonaws.com/{stage}, or will be the endpoint corresponding to your API's custom domain and base path, if applicable.</p>
@@ -182,6 +190,9 @@ export class ApiGatewayManagementApiClient extends __Client<
182190
ServiceOutputTypes,
183191
ApiGatewayManagementApiClientResolvedConfig
184192
> {
193+
/**
194+
* The resolved configuration of ApiGatewayManagementApiClient class. This is resolved and normalized from the {@link ApiGatewayManagementApiClientConfig | constructor configuration interface}.
195+
*/
185196
readonly config: ApiGatewayManagementApiClientResolvedConfig;
186197

187198
constructor(configuration: ApiGatewayManagementApiClientConfig) {

‎clients/client-apigatewayv2/ApiGatewayV2Client.ts

+13-2
Original file line numberDiff line numberDiff line change
@@ -404,23 +404,31 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
404404
defaultUserAgentProvider?: Provider<__UserAgent>;
405405
}
406406

407-
export type ApiGatewayV2ClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
407+
type ApiGatewayV2ClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
408408
ClientDefaults &
409409
RegionInputConfig &
410410
EndpointsInputConfig &
411411
RetryInputConfig &
412412
HostHeaderInputConfig &
413413
AwsAuthInputConfig &
414414
UserAgentInputConfig;
415+
/**
416+
* The configuration interface of ApiGatewayV2Client class constructor that set the region, credentials and other options.
417+
*/
418+
export interface ApiGatewayV2ClientConfig extends ApiGatewayV2ClientConfigType {}
415419

416-
export type ApiGatewayV2ClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
420+
type ApiGatewayV2ClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
417421
Required<ClientDefaults> &
418422
RegionResolvedConfig &
419423
EndpointsResolvedConfig &
420424
RetryResolvedConfig &
421425
HostHeaderResolvedConfig &
422426
AwsAuthResolvedConfig &
423427
UserAgentResolvedConfig;
428+
/**
429+
* The resolved configuration interface of ApiGatewayV2Client class. This is resolved and normalized from the {@link ApiGatewayV2ClientConfig | constructor configuration interface}.
430+
*/
431+
export interface ApiGatewayV2ClientResolvedConfig extends ApiGatewayV2ClientResolvedConfigType {}
424432

425433
/**
426434
* <p>Amazon API Gateway V2</p>
@@ -431,6 +439,9 @@ export class ApiGatewayV2Client extends __Client<
431439
ServiceOutputTypes,
432440
ApiGatewayV2ClientResolvedConfig
433441
> {
442+
/**
443+
* The resolved configuration of ApiGatewayV2Client class. This is resolved and normalized from the {@link ApiGatewayV2ClientConfig | constructor configuration interface}.
444+
*/
434445
readonly config: ApiGatewayV2ClientResolvedConfig;
435446

436447
constructor(configuration: ApiGatewayV2ClientConfig) {

0 commit comments

Comments
 (0)