@aws-sdk/client-account 3.379.1 → 3.385.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.
@@ -31,10 +31,12 @@ export type AlternateContactType = (typeof AlternateContactType)[keyof typeof Al
31
31
  */
32
32
  export interface DeleteAlternateContactRequest {
33
33
  /**
34
+ * @public
34
35
  * <p>Specifies which of the alternate contacts to delete. </p>
35
36
  */
36
37
  AlternateContactType: AlternateContactType | string | undefined;
37
38
  /**
39
+ * @public
38
40
  * <p>Specifies the 12 digit account ID number of the Amazon Web Services account that
39
41
  * you want to access or modify with this operation.</p>
40
42
  * <p>If you do not specify this parameter, it defaults to the Amazon Web Services account of the
@@ -104,10 +106,12 @@ export declare class TooManyRequestsException extends __BaseException {
104
106
  */
105
107
  export interface ValidationExceptionField {
106
108
  /**
109
+ * @public
107
110
  * <p>The field name where the invalid entry was detected.</p>
108
111
  */
109
112
  name: string | undefined;
110
113
  /**
114
+ * @public
111
115
  * <p>A message about the validation exception.</p>
112
116
  */
113
117
  message: string | undefined;
@@ -132,10 +136,12 @@ export declare class ValidationException extends __BaseException {
132
136
  readonly name: "ValidationException";
133
137
  readonly $fault: "client";
134
138
  /**
139
+ * @public
135
140
  * <p>The reason that validation failed.</p>
136
141
  */
137
142
  reason?: ValidationExceptionReason | string;
138
143
  /**
144
+ * @public
139
145
  * <p>The field where the invalid entry was detected.</p>
140
146
  */
141
147
  fieldList?: ValidationExceptionField[];
@@ -149,10 +155,12 @@ export declare class ValidationException extends __BaseException {
149
155
  */
150
156
  export interface GetAlternateContactRequest {
151
157
  /**
158
+ * @public
152
159
  * <p>Specifies which alternate contact you want to retrieve.</p>
153
160
  */
154
161
  AlternateContactType: AlternateContactType | string | undefined;
155
162
  /**
163
+ * @public
156
164
  * <p>Specifies the 12 digit account ID number of the Amazon Web Services account that
157
165
  * you want to access or modify with this operation.</p>
158
166
  * <p>If you do not specify this parameter, it defaults to the Amazon Web Services account of the
@@ -181,22 +189,27 @@ export interface GetAlternateContactRequest {
181
189
  */
182
190
  export interface AlternateContact {
183
191
  /**
192
+ * @public
184
193
  * <p>The name associated with this alternate contact.</p>
185
194
  */
186
195
  Name?: string;
187
196
  /**
197
+ * @public
188
198
  * <p>The title associated with this alternate contact.</p>
189
199
  */
190
200
  Title?: string;
191
201
  /**
202
+ * @public
192
203
  * <p>The email address associated with this alternate contact.</p>
193
204
  */
194
205
  EmailAddress?: string;
195
206
  /**
207
+ * @public
196
208
  * <p>The phone number associated with this alternate contact.</p>
197
209
  */
198
210
  PhoneNumber?: string;
199
211
  /**
212
+ * @public
200
213
  * <p>The type of alternate contact.</p>
201
214
  */
202
215
  AlternateContactType?: AlternateContactType | string;
@@ -206,6 +219,7 @@ export interface AlternateContact {
206
219
  */
207
220
  export interface GetAlternateContactResponse {
208
221
  /**
222
+ * @public
209
223
  * <p>A structure that contains the details for the specified alternate contact.</p>
210
224
  */
211
225
  AlternateContact?: AlternateContact;
@@ -215,26 +229,32 @@ export interface GetAlternateContactResponse {
215
229
  */
216
230
  export interface PutAlternateContactRequest {
217
231
  /**
232
+ * @public
218
233
  * <p>Specifies a name for the alternate contact.</p>
219
234
  */
220
235
  Name: string | undefined;
221
236
  /**
237
+ * @public
222
238
  * <p>Specifies a title for the alternate contact.</p>
223
239
  */
224
240
  Title: string | undefined;
225
241
  /**
242
+ * @public
226
243
  * <p>Specifies an email address for the alternate contact. </p>
227
244
  */
228
245
  EmailAddress: string | undefined;
229
246
  /**
247
+ * @public
230
248
  * <p>Specifies a phone number for the alternate contact.</p>
231
249
  */
232
250
  PhoneNumber: string | undefined;
233
251
  /**
252
+ * @public
234
253
  * <p>Specifies which alternate contact you want to create or update.</p>
235
254
  */
236
255
  AlternateContactType: AlternateContactType | string | undefined;
237
256
  /**
257
+ * @public
238
258
  * <p>Specifies the 12 digit account ID number of the Amazon Web Services account that
239
259
  * you want to access or modify with this operation.</p>
240
260
  * <p>If you do not specify this parameter, it defaults to the Amazon Web Services account of the
@@ -261,6 +281,7 @@ export interface PutAlternateContactRequest {
261
281
  */
262
282
  export interface GetContactInformationRequest {
263
283
  /**
284
+ * @public
264
285
  * <p>Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access
265
286
  * or modify with this operation. If you don't specify this parameter, it defaults to the
266
287
  * Amazon Web Services account of the identity used to call the operation. To use this parameter, the
@@ -288,50 +309,62 @@ export interface GetContactInformationRequest {
288
309
  */
289
310
  export interface ContactInformation {
290
311
  /**
312
+ * @public
291
313
  * <p>The full name of the primary contact address.</p>
292
314
  */
293
315
  FullName: string | undefined;
294
316
  /**
317
+ * @public
295
318
  * <p>The first line of the primary contact address.</p>
296
319
  */
297
320
  AddressLine1: string | undefined;
298
321
  /**
322
+ * @public
299
323
  * <p>The second line of the primary contact address, if any.</p>
300
324
  */
301
325
  AddressLine2?: string;
302
326
  /**
327
+ * @public
303
328
  * <p>The third line of the primary contact address, if any.</p>
304
329
  */
305
330
  AddressLine3?: string;
306
331
  /**
332
+ * @public
307
333
  * <p>The city of the primary contact address.</p>
308
334
  */
309
335
  City: string | undefined;
310
336
  /**
337
+ * @public
311
338
  * <p>The state or region of the primary contact address. This field is required in selected countries.</p>
312
339
  */
313
340
  StateOrRegion?: string;
314
341
  /**
342
+ * @public
315
343
  * <p>The district or county of the primary contact address, if any.</p>
316
344
  */
317
345
  DistrictOrCounty?: string;
318
346
  /**
347
+ * @public
319
348
  * <p>The postal code of the primary contact address.</p>
320
349
  */
321
350
  PostalCode: string | undefined;
322
351
  /**
352
+ * @public
323
353
  * <p>The ISO-3166 two-letter country code for the primary contact address.</p>
324
354
  */
325
355
  CountryCode: string | undefined;
326
356
  /**
357
+ * @public
327
358
  * <p>The phone number of the primary contact information. The number will be validated and, in some countries, checked for activation.</p>
328
359
  */
329
360
  PhoneNumber: string | undefined;
330
361
  /**
362
+ * @public
331
363
  * <p>The name of the company associated with the primary contact information, if any.</p>
332
364
  */
333
365
  CompanyName?: string;
334
366
  /**
367
+ * @public
335
368
  * <p>The URL of the website associated with the primary contact information, if any.</p>
336
369
  */
337
370
  WebsiteUrl?: string;
@@ -341,6 +374,7 @@ export interface ContactInformation {
341
374
  */
342
375
  export interface GetContactInformationResponse {
343
376
  /**
377
+ * @public
344
378
  * <p>Contains the details of the primary contact information associated with an Amazon Web Services account.</p>
345
379
  */
346
380
  ContactInformation?: ContactInformation;
@@ -350,10 +384,12 @@ export interface GetContactInformationResponse {
350
384
  */
351
385
  export interface PutContactInformationRequest {
352
386
  /**
387
+ * @public
353
388
  * <p>Contains the details of the primary contact information associated with an Amazon Web Services account.</p>
354
389
  */
355
390
  ContactInformation: ContactInformation | undefined;
356
391
  /**
392
+ * @public
357
393
  * <p>Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access
358
394
  * or modify with this operation. If you don't specify this parameter, it defaults to the
359
395
  * Amazon Web Services account of the identity used to call the operation. To use this parameter, the
@@ -394,6 +430,7 @@ export declare class ConflictException extends __BaseException {
394
430
  */
395
431
  export interface DisableRegionRequest {
396
432
  /**
433
+ * @public
397
434
  * <p>Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access
398
435
  * or modify with this operation. If you don't specify this parameter, it defaults to the
399
436
  * Amazon Web Services account of the identity used to call the operation. To use this parameter, the
@@ -415,6 +452,7 @@ export interface DisableRegionRequest {
415
452
  */
416
453
  AccountId?: string;
417
454
  /**
455
+ * @public
418
456
  * <p>Specifies the Region-code for a given Region name (for example, <code>af-south-1</code>). When
419
457
  * you disable a Region, Amazon Web Services performs actions to deactivate that Region in your account, such
420
458
  * as destroying IAM resources in the Region. This process takes a few minutes for most
@@ -428,6 +466,7 @@ export interface DisableRegionRequest {
428
466
  */
429
467
  export interface EnableRegionRequest {
430
468
  /**
469
+ * @public
431
470
  * <p>Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access
432
471
  * or modify with this operation. If you don't specify this parameter, it defaults to the
433
472
  * Amazon Web Services account of the identity used to call the operation. To use this parameter, the
@@ -449,6 +488,7 @@ export interface EnableRegionRequest {
449
488
  */
450
489
  AccountId?: string;
451
490
  /**
491
+ * @public
452
492
  * <p>Specifies the Region-code for a given Region name (for example, <code>af-south-1</code>). When
453
493
  * you enable a Region, Amazon Web Services performs actions to prepare your account in that Region, such
454
494
  * as distributing your IAM resources to the Region. This process takes a few minutes for
@@ -463,6 +503,7 @@ export interface EnableRegionRequest {
463
503
  */
464
504
  export interface GetRegionOptStatusRequest {
465
505
  /**
506
+ * @public
466
507
  * <p>Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access
467
508
  * or modify with this operation. If you don't specify this parameter, it defaults to the
468
509
  * Amazon Web Services account of the identity used to call the operation. To use this parameter, the
@@ -484,6 +525,7 @@ export interface GetRegionOptStatusRequest {
484
525
  */
485
526
  AccountId?: string;
486
527
  /**
528
+ * @public
487
529
  * <p>Specifies the Region-code for a given Region name (for example, <code>af-south-1</code>). This
488
530
  * function will return the status of whatever Region you pass into this parameter. </p>
489
531
  */
@@ -509,10 +551,12 @@ export type RegionOptStatus = (typeof RegionOptStatus)[keyof typeof RegionOptSta
509
551
  */
510
552
  export interface GetRegionOptStatusResponse {
511
553
  /**
554
+ * @public
512
555
  * <p>The Region code that was passed in.</p>
513
556
  */
514
557
  RegionName?: string;
515
558
  /**
559
+ * @public
516
560
  * <p>One of the potential statuses a Region can undergo (Enabled, Enabling, Disabled,
517
561
  * Disabling, Enabled_By_Default).</p>
518
562
  */
@@ -523,6 +567,7 @@ export interface GetRegionOptStatusResponse {
523
567
  */
524
568
  export interface ListRegionsRequest {
525
569
  /**
570
+ * @public
526
571
  * <p>Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access
527
572
  * or modify with this operation. If you don't specify this parameter, it defaults to the
528
573
  * Amazon Web Services account of the identity used to call the operation. To use this parameter, the
@@ -544,6 +589,7 @@ export interface ListRegionsRequest {
544
589
  */
545
590
  AccountId?: string;
546
591
  /**
592
+ * @public
547
593
  * <p>The total number of items to return in the command’s output. If the total number of
548
594
  * items available is more than the value specified, a <code>NextToken</code> is provided
549
595
  * in the command’s output. To resume pagination, provide the <code>NextToken</code> value
@@ -554,12 +600,14 @@ export interface ListRegionsRequest {
554
600
  */
555
601
  MaxResults?: number;
556
602
  /**
603
+ * @public
557
604
  * <p>A token used to specify where to start paginating. This is the <code>NextToken</code>
558
605
  * from a previously truncated response. For usage examples, see <a href="http://docs.aws.amazon.com/cli/latest/userguide/pagination.html">Pagination</a> in the
559
606
  * <i>Amazon Web Services Command Line Interface User Guide</i>.</p>
560
607
  */
561
608
  NextToken?: string;
562
609
  /**
610
+ * @public
563
611
  * <p>A list of Region statuses (Enabling, Enabled, Disabling, Disabled, Enabled_by_default)
564
612
  * to use to filter the list of Regions for a given account. For example, passing in a
565
613
  * value of ENABLING will only return a list of Regions with a Region status of
@@ -574,10 +622,12 @@ export interface ListRegionsRequest {
574
622
  */
575
623
  export interface Region {
576
624
  /**
625
+ * @public
577
626
  * <p>The Region code of a given Region (for example, <code>us-east-1</code>).</p>
578
627
  */
579
628
  RegionName?: string;
580
629
  /**
630
+ * @public
581
631
  * <p>One of potential statuses a Region can undergo (Enabled, Enabling, Disabled, Disabling,
582
632
  * Enabled_By_Default).</p>
583
633
  */
@@ -588,11 +638,13 @@ export interface Region {
588
638
  */
589
639
  export interface ListRegionsResponse {
590
640
  /**
641
+ * @public
591
642
  * <p>If there is more data to be returned, this will be populated. It should be passed into
592
643
  * the <code>next-token</code> request parameter of <code>list-regions</code>.</p>
593
644
  */
594
645
  NextToken?: string;
595
646
  /**
647
+ * @public
596
648
  * <p>This is a list of Regions for a given account, or if the filtered parameter was used,
597
649
  * a list of Regions that match the filter criteria set in the <code>filter</code>
598
650
  * parameter.</p>
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-account",
3
3
  "description": "AWS SDK for JavaScript Account Client for Node.js, Browser and React Native",
4
- "version": "3.379.1",
4
+ "version": "3.385.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",
@@ -21,15 +21,15 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.379.1",
25
- "@aws-sdk/credential-provider-node": "3.379.1",
24
+ "@aws-sdk/client-sts": "3.385.0",
25
+ "@aws-sdk/credential-provider-node": "3.385.0",
26
26
  "@aws-sdk/middleware-host-header": "3.379.1",
27
27
  "@aws-sdk/middleware-logger": "3.378.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.378.0",
29
29
  "@aws-sdk/middleware-signing": "3.379.1",
30
- "@aws-sdk/middleware-user-agent": "3.379.1",
30
+ "@aws-sdk/middleware-user-agent": "3.382.0",
31
31
  "@aws-sdk/types": "3.378.0",
32
- "@aws-sdk/util-endpoints": "3.378.0",
32
+ "@aws-sdk/util-endpoints": "3.382.0",
33
33
  "@aws-sdk/util-user-agent-browser": "3.378.0",
34
34
  "@aws-sdk/util-user-agent-node": "3.378.0",
35
35
  "@smithy/config-resolver": "^2.0.1",