Skip to content

Commit 1be1832

Browse files
kuhekuhe
authored
docs: codegen for release tags in shape members (#5041)
1 parent 84ee148 commit 1be1832

File tree

409 files changed

+141545
-0
lines changed

Some content is hidden

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

409 files changed

+141545
-0
lines changed

‎clients/client-accessanalyzer/src/models/models_0.ts

Lines changed: 339 additions & 0 deletions
Large diffs are not rendered by default.

‎clients/client-account/src/models/models_0.ts

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,13 @@ export type AlternateContactType = (typeof AlternateContactType)[keyof typeof Al
4444
*/
4545
export interface DeleteAlternateContactRequest {
4646
/**
47+
* @public
4748
* <p>Specifies which of the alternate contacts to delete. </p>
4849
*/
4950
AlternateContactType: AlternateContactType | string | undefined;
5051

5152
/**
53+
* @public
5254
* <p>Specifies the 12 digit account ID number of the Amazon Web Services account that
5355
* you want to access or modify with this operation.</p>
5456
* <p>If you do not specify this parameter, it defaults to the Amazon Web Services account of the
@@ -143,11 +145,13 @@ export class TooManyRequestsException extends __BaseException {
143145
*/
144146
export interface ValidationExceptionField {
145147
/**
148+
* @public
146149
* <p>The field name where the invalid entry was detected.</p>
147150
*/
148151
name: string | undefined;
149152

150153
/**
154+
* @public
151155
* <p>A message about the validation exception.</p>
152156
*/
153157
message: string | undefined;
@@ -175,11 +179,13 @@ export class ValidationException extends __BaseException {
175179
readonly name: "ValidationException" = "ValidationException";
176180
readonly $fault: "client" = "client";
177181
/**
182+
* @public
178183
* <p>The reason that validation failed.</p>
179184
*/
180185
reason?: ValidationExceptionReason | string;
181186

182187
/**
188+
* @public
183189
* <p>The field where the invalid entry was detected.</p>
184190
*/
185191
fieldList?: ValidationExceptionField[];
@@ -204,11 +210,13 @@ export class ValidationException extends __BaseException {
204210
*/
205211
export interface GetAlternateContactRequest {
206212
/**
213+
* @public
207214
* <p>Specifies which alternate contact you want to retrieve.</p>
208215
*/
209216
AlternateContactType: AlternateContactType | string | undefined;
210217

211218
/**
219+
* @public
212220
* <p>Specifies the 12 digit account ID number of the Amazon Web Services account that
213221
* you want to access or modify with this operation.</p>
214222
* <p>If you do not specify this parameter, it defaults to the Amazon Web Services account of the
@@ -238,26 +246,31 @@ export interface GetAlternateContactRequest {
238246
*/
239247
export interface AlternateContact {
240248
/**
249+
* @public
241250
* <p>The name associated with this alternate contact.</p>
242251
*/
243252
Name?: string;
244253

245254
/**
255+
* @public
246256
* <p>The title associated with this alternate contact.</p>
247257
*/
248258
Title?: string;
249259

250260
/**
261+
* @public
251262
* <p>The email address associated with this alternate contact.</p>
252263
*/
253264
EmailAddress?: string;
254265

255266
/**
267+
* @public
256268
* <p>The phone number associated with this alternate contact.</p>
257269
*/
258270
PhoneNumber?: string;
259271

260272
/**
273+
* @public
261274
* <p>The type of alternate contact.</p>
262275
*/
263276
AlternateContactType?: AlternateContactType | string;
@@ -268,6 +281,7 @@ export interface AlternateContact {
268281
*/
269282
export interface GetAlternateContactResponse {
270283
/**
284+
* @public
271285
* <p>A structure that contains the details for the specified alternate contact.</p>
272286
*/
273287
AlternateContact?: AlternateContact;
@@ -278,31 +292,37 @@ export interface GetAlternateContactResponse {
278292
*/
279293
export interface PutAlternateContactRequest {
280294
/**
295+
* @public
281296
* <p>Specifies a name for the alternate contact.</p>
282297
*/
283298
Name: string | undefined;
284299

285300
/**
301+
* @public
286302
* <p>Specifies a title for the alternate contact.</p>
287303
*/
288304
Title: string | undefined;
289305

290306
/**
307+
* @public
291308
* <p>Specifies an email address for the alternate contact. </p>
292309
*/
293310
EmailAddress: string | undefined;
294311

295312
/**
313+
* @public
296314
* <p>Specifies a phone number for the alternate contact.</p>
297315
*/
298316
PhoneNumber: string | undefined;
299317

300318
/**
319+
* @public
301320
* <p>Specifies which alternate contact you want to create or update.</p>
302321
*/
303322
AlternateContactType: AlternateContactType | string | undefined;
304323

305324
/**
325+
* @public
306326
* <p>Specifies the 12 digit account ID number of the Amazon Web Services account that
307327
* you want to access or modify with this operation.</p>
308328
* <p>If you do not specify this parameter, it defaults to the Amazon Web Services account of the
@@ -330,6 +350,7 @@ export interface PutAlternateContactRequest {
330350
*/
331351
export interface GetContactInformationRequest {
332352
/**
353+
* @public
333354
* <p>Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access
334355
* or modify with this operation. If you don't specify this parameter, it defaults to the
335356
* Amazon Web Services account of the identity used to call the operation. To use this parameter, the
@@ -358,61 +379,73 @@ export interface GetContactInformationRequest {
358379
*/
359380
export interface ContactInformation {
360381
/**
382+
* @public
361383
* <p>The full name of the primary contact address.</p>
362384
*/
363385
FullName: string | undefined;
364386

365387
/**
388+
* @public
366389
* <p>The first line of the primary contact address.</p>
367390
*/
368391
AddressLine1: string | undefined;
369392

370393
/**
394+
* @public
371395
* <p>The second line of the primary contact address, if any.</p>
372396
*/
373397
AddressLine2?: string;
374398

375399
/**
400+
* @public
376401
* <p>The third line of the primary contact address, if any.</p>
377402
*/
378403
AddressLine3?: string;
379404

380405
/**
406+
* @public
381407
* <p>The city of the primary contact address.</p>
382408
*/
383409
City: string | undefined;
384410

385411
/**
412+
* @public
386413
* <p>The state or region of the primary contact address. This field is required in selected countries.</p>
387414
*/
388415
StateOrRegion?: string;
389416

390417
/**
418+
* @public
391419
* <p>The district or county of the primary contact address, if any.</p>
392420
*/
393421
DistrictOrCounty?: string;
394422

395423
/**
424+
* @public
396425
* <p>The postal code of the primary contact address.</p>
397426
*/
398427
PostalCode: string | undefined;
399428

400429
/**
430+
* @public
401431
* <p>The ISO-3166 two-letter country code for the primary contact address.</p>
402432
*/
403433
CountryCode: string | undefined;
404434

405435
/**
436+
* @public
406437
* <p>The phone number of the primary contact information. The number will be validated and, in some countries, checked for activation.</p>
407438
*/
408439
PhoneNumber: string | undefined;
409440

410441
/**
442+
* @public
411443
* <p>The name of the company associated with the primary contact information, if any.</p>
412444
*/
413445
CompanyName?: string;
414446

415447
/**
448+
* @public
416449
* <p>The URL of the website associated with the primary contact information, if any.</p>
417450
*/
418451
WebsiteUrl?: string;
@@ -423,6 +456,7 @@ export interface ContactInformation {
423456
*/
424457
export interface GetContactInformationResponse {
425458
/**
459+
* @public
426460
* <p>Contains the details of the primary contact information associated with an Amazon Web Services account.</p>
427461
*/
428462
ContactInformation?: ContactInformation;
@@ -433,11 +467,13 @@ export interface GetContactInformationResponse {
433467
*/
434468
export interface PutContactInformationRequest {
435469
/**
470+
* @public
436471
* <p>Contains the details of the primary contact information associated with an Amazon Web Services account.</p>
437472
*/
438473
ContactInformation: ContactInformation | undefined;
439474

440475
/**
476+
* @public
441477
* <p>Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access
442478
* or modify with this operation. If you don't specify this parameter, it defaults to the
443479
* Amazon Web Services account of the identity used to call the operation. To use this parameter, the
@@ -487,6 +523,7 @@ export class ConflictException extends __BaseException {
487523
*/
488524
export interface DisableRegionRequest {
489525
/**
526+
* @public
490527
* <p>Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access
491528
* or modify with this operation. If you don't specify this parameter, it defaults to the
492529
* Amazon Web Services account of the identity used to call the operation. To use this parameter, the
@@ -509,6 +546,7 @@ export interface DisableRegionRequest {
509546
AccountId?: string;
510547

511548
/**
549+
* @public
512550
* <p>Specifies the Region-code for a given Region name (for example, <code>af-south-1</code>). When
513551
* you disable a Region, Amazon Web Services performs actions to deactivate that Region in your account, such
514552
* as destroying IAM resources in the Region. This process takes a few minutes for most
@@ -523,6 +561,7 @@ export interface DisableRegionRequest {
523561
*/
524562
export interface EnableRegionRequest {
525563
/**
564+
* @public
526565
* <p>Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access
527566
* or modify with this operation. If you don't specify this parameter, it defaults to the
528567
* Amazon Web Services account of the identity used to call the operation. To use this parameter, the
@@ -545,6 +584,7 @@ export interface EnableRegionRequest {
545584
AccountId?: string;
546585

547586
/**
587+
* @public
548588
* <p>Specifies the Region-code for a given Region name (for example, <code>af-south-1</code>). When
549589
* you enable a Region, Amazon Web Services performs actions to prepare your account in that Region, such
550590
* as distributing your IAM resources to the Region. This process takes a few minutes for
@@ -560,6 +600,7 @@ export interface EnableRegionRequest {
560600
*/
561601
export interface GetRegionOptStatusRequest {
562602
/**
603+
* @public
563604
* <p>Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access
564605
* or modify with this operation. If you don't specify this parameter, it defaults to the
565606
* Amazon Web Services account of the identity used to call the operation. To use this parameter, the
@@ -582,6 +623,7 @@ export interface GetRegionOptStatusRequest {
582623
AccountId?: string;
583624

584625
/**
626+
* @public
585627
* <p>Specifies the Region-code for a given Region name (for example, <code>af-south-1</code>). This
586628
* function will return the status of whatever Region you pass into this parameter. </p>
587629
*/
@@ -610,11 +652,13 @@ export type RegionOptStatus = (typeof RegionOptStatus)[keyof typeof RegionOptSta
610652
*/
611653
export interface GetRegionOptStatusResponse {
612654
/**
655+
* @public
613656
* <p>The Region code that was passed in.</p>
614657
*/
615658
RegionName?: string;
616659

617660
/**
661+
* @public
618662
* <p>One of the potential statuses a Region can undergo (Enabled, Enabling, Disabled,
619663
* Disabling, Enabled_By_Default).</p>
620664
*/
@@ -626,6 +670,7 @@ export interface GetRegionOptStatusResponse {
626670
*/
627671
export interface ListRegionsRequest {
628672
/**
673+
* @public
629674
* <p>Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access
630675
* or modify with this operation. If you don't specify this parameter, it defaults to the
631676
* Amazon Web Services account of the identity used to call the operation. To use this parameter, the
@@ -648,6 +693,7 @@ export interface ListRegionsRequest {
648693
AccountId?: string;
649694

650695
/**
696+
* @public
651697
* <p>The total number of items to return in the command’s output. If the total number of
652698
* items available is more than the value specified, a <code>NextToken</code> is provided
653699
* in the command’s output. To resume pagination, provide the <code>NextToken</code> value
@@ -659,13 +705,15 @@ export interface ListRegionsRequest {
659705
MaxResults?: number;
660706

661707
/**
708+
* @public
662709
* <p>A token used to specify where to start paginating. This is the <code>NextToken</code>
663710
* 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
664711
* <i>Amazon Web Services Command Line Interface User Guide</i>.</p>
665712
*/
666713
NextToken?: string;
667714

668715
/**
716+
* @public
669717
* <p>A list of Region statuses (Enabling, Enabled, Disabling, Disabled, Enabled_by_default)
670718
* to use to filter the list of Regions for a given account. For example, passing in a
671719
* value of ENABLING will only return a list of Regions with a Region status of
@@ -681,11 +729,13 @@ export interface ListRegionsRequest {
681729
*/
682730
export interface Region {
683731
/**
732+
* @public
684733
* <p>The Region code of a given Region (for example, <code>us-east-1</code>).</p>
685734
*/
686735
RegionName?: string;
687736

688737
/**
738+
* @public
689739
* <p>One of potential statuses a Region can undergo (Enabled, Enabling, Disabled, Disabling,
690740
* Enabled_By_Default).</p>
691741
*/
@@ -697,12 +747,14 @@ export interface Region {
697747
*/
698748
export interface ListRegionsResponse {
699749
/**
750+
* @public
700751
* <p>If there is more data to be returned, this will be populated. It should be passed into
701752
* the <code>next-token</code> request parameter of <code>list-regions</code>.</p>
702753
*/
703754
NextToken?: string;
704755

705756
/**
757+
* @public
706758
* <p>This is a list of Regions for a given account, or if the filtered parameter was used,
707759
* a list of Regions that match the filter criteria set in the <code>filter</code>
708760
* parameter.</p>

0 commit comments

Comments
 (0)