@aws-sdk/client-sso-admin 3.378.0 → 3.382.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.
@@ -1,4 +1,7 @@
1
1
  import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
2
+ /**
3
+ * @public
4
+ */
2
5
  export interface ClientInputEndpointParameters {
3
6
  region?: string | Provider<string>;
4
7
  useDualstackEndpoint?: boolean | Provider<boolean>;
@@ -26,6 +26,7 @@
26
26
  */
27
27
  export * from "./SSOAdminClient";
28
28
  export * from "./SSOAdmin";
29
+ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
29
30
  export * from "./commands";
30
31
  export * from "./pagination";
31
32
  export * from "./models";
@@ -8,6 +8,7 @@ import { SSOAdminServiceException as __BaseException } from "./SSOAdminServiceEx
8
8
  */
9
9
  export interface AccessControlAttributeValue {
10
10
  /**
11
+ * @public
11
12
  * <p>The identity source to use when mapping a specified attribute to IAM Identity Center.</p>
12
13
  */
13
14
  Source: string[] | undefined;
@@ -22,12 +23,14 @@ export interface AccessControlAttributeValue {
22
23
  */
23
24
  export interface AccessControlAttribute {
24
25
  /**
26
+ * @public
25
27
  * <p>The name of the attribute associated with your identities in your identity source. This is
26
28
  * used to map a specified attribute in your identity source with an attribute in
27
29
  * IAM Identity Center.</p>
28
30
  */
29
31
  Key: string | undefined;
30
32
  /**
33
+ * @public
31
34
  * <p>The value used for mapping a specified attribute to an identity source.</p>
32
35
  */
33
36
  Value: AccessControlAttributeValue | undefined;
@@ -68,19 +71,23 @@ export type PrincipalType = (typeof PrincipalType)[keyof typeof PrincipalType];
68
71
  */
69
72
  export interface AccountAssignment {
70
73
  /**
74
+ * @public
71
75
  * <p>The identifier of the AWS account.</p>
72
76
  */
73
77
  AccountId?: string;
74
78
  /**
79
+ * @public
75
80
  * <p>The ARN of the permission set. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource
76
81
  * Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>
77
82
  */
78
83
  PermissionSetArn?: string;
79
84
  /**
85
+ * @public
80
86
  * <p>The entity type for which the assignment will be created.</p>
81
87
  */
82
88
  PrincipalType?: PrincipalType | string;
83
89
  /**
90
+ * @public
84
91
  * <p>An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the <a href="/singlesignon/latest/IdentityStoreAPIReference/welcome.html">IAM Identity Center Identity Store API Reference</a>.</p>
85
92
  */
86
93
  PrincipalId?: string;
@@ -116,40 +123,49 @@ export type TargetType = (typeof TargetType)[keyof typeof TargetType];
116
123
  */
117
124
  export interface AccountAssignmentOperationStatus {
118
125
  /**
126
+ * @public
119
127
  * <p>The status of the permission set provisioning process.</p>
120
128
  */
121
129
  Status?: StatusValues | string;
122
130
  /**
131
+ * @public
123
132
  * <p>The identifier for tracking the request operation that is generated by the universally
124
133
  * unique identifier (UUID) workflow.</p>
125
134
  */
126
135
  RequestId?: string;
127
136
  /**
137
+ * @public
128
138
  * <p>The message that contains an error or exception in case of an operation failure.</p>
129
139
  */
130
140
  FailureReason?: string;
131
141
  /**
142
+ * @public
132
143
  * <p>TargetID is an AWS account identifier, typically a 10-12 digit string (For example, 123456789012).</p>
133
144
  */
134
145
  TargetId?: string;
135
146
  /**
147
+ * @public
136
148
  * <p>The entity type for which the assignment will be created.</p>
137
149
  */
138
150
  TargetType?: TargetType | string;
139
151
  /**
152
+ * @public
140
153
  * <p>The ARN of the permission set. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource
141
154
  * Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>
142
155
  */
143
156
  PermissionSetArn?: string;
144
157
  /**
158
+ * @public
145
159
  * <p>The entity type for which the assignment will be created.</p>
146
160
  */
147
161
  PrincipalType?: PrincipalType | string;
148
162
  /**
163
+ * @public
149
164
  * <p>An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the <a href="/singlesignon/latest/IdentityStoreAPIReference/welcome.html">IAM Identity Center Identity Store API Reference</a>.</p>
150
165
  */
151
166
  PrincipalId?: string;
152
167
  /**
168
+ * @public
153
169
  * <p>The date that the permission set was created.</p>
154
170
  */
155
171
  CreatedDate?: Date;
@@ -161,15 +177,18 @@ export interface AccountAssignmentOperationStatus {
161
177
  */
162
178
  export interface AccountAssignmentOperationStatusMetadata {
163
179
  /**
180
+ * @public
164
181
  * <p>The status of the permission set provisioning process.</p>
165
182
  */
166
183
  Status?: StatusValues | string;
167
184
  /**
185
+ * @public
168
186
  * <p>The identifier for tracking the request operation that is generated by the universally
169
187
  * unique identifier (UUID) workflow.</p>
170
188
  */
171
189
  RequestId?: string;
172
190
  /**
191
+ * @public
173
192
  * <p>The date that the permission set was created.</p>
174
193
  */
175
194
  CreatedDate?: Date;
@@ -180,10 +199,12 @@ export interface AccountAssignmentOperationStatusMetadata {
180
199
  */
181
200
  export interface CustomerManagedPolicyReference {
182
201
  /**
202
+ * @public
183
203
  * <p>The name of the IAM policy that you have configured in each account where you want to deploy your permission set.</p>
184
204
  */
185
205
  Name: string | undefined;
186
206
  /**
207
+ * @public
187
208
  * <p>The path to the IAM policy that you have configured in each account where you want to deploy your permission set. The default is <code>/</code>. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names">Friendly
188
209
  * names and paths</a> in the <i>IAM User Guide</i>.</p>
189
210
  */
@@ -194,14 +215,17 @@ export interface CustomerManagedPolicyReference {
194
215
  */
195
216
  export interface AttachCustomerManagedPolicyReferenceToPermissionSetRequest {
196
217
  /**
218
+ * @public
197
219
  * <p>The ARN of the IAM Identity Center instance under which the operation will be executed. </p>
198
220
  */
199
221
  InstanceArn: string | undefined;
200
222
  /**
223
+ * @public
201
224
  * <p>The ARN of the <code>PermissionSet</code>.</p>
202
225
  */
203
226
  PermissionSetArn: string | undefined;
204
227
  /**
228
+ * @public
205
229
  * <p>Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each AWS account where you want to deploy your permission set.</p>
206
230
  */
207
231
  CustomerManagedPolicyReference: CustomerManagedPolicyReference | undefined;
@@ -301,10 +325,12 @@ export declare class ValidationException extends __BaseException {
301
325
  */
302
326
  export interface AttachedManagedPolicy {
303
327
  /**
328
+ * @public
304
329
  * <p>The name of the AWS managed policy.</p>
305
330
  */
306
331
  Name?: string;
307
332
  /**
333
+ * @public
308
334
  * <p>The ARN of the AWS managed policy. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource
309
335
  * Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>
310
336
  */
@@ -315,16 +341,19 @@ export interface AttachedManagedPolicy {
315
341
  */
316
342
  export interface AttachManagedPolicyToPermissionSetRequest {
317
343
  /**
344
+ * @public
318
345
  * <p>The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource
319
346
  * Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>
320
347
  */
321
348
  InstanceArn: string | undefined;
322
349
  /**
350
+ * @public
323
351
  * <p>The ARN of the <a>PermissionSet</a> that the managed policy should be attached
324
352
  * to.</p>
325
353
  */
326
354
  PermissionSetArn: string | undefined;
327
355
  /**
356
+ * @public
328
357
  * <p>The AWS managed policy ARN to be attached to a permission set.</p>
329
358
  */
330
359
  ManagedPolicyArn: string | undefined;
@@ -339,28 +368,34 @@ export interface AttachManagedPolicyToPermissionSetResponse {
339
368
  */
340
369
  export interface CreateAccountAssignmentRequest {
341
370
  /**
371
+ * @public
342
372
  * <p>The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource
343
373
  * Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>
344
374
  */
345
375
  InstanceArn: string | undefined;
346
376
  /**
377
+ * @public
347
378
  * <p>TargetID is an AWS account identifier, typically a 10-12 digit string (For example, 123456789012).</p>
348
379
  */
349
380
  TargetId: string | undefined;
350
381
  /**
382
+ * @public
351
383
  * <p>The entity type for which the assignment will be created.</p>
352
384
  */
353
385
  TargetType: TargetType | string | undefined;
354
386
  /**
387
+ * @public
355
388
  * <p>The ARN of the permission set that the admin wants to grant the principal access
356
389
  * to.</p>
357
390
  */
358
391
  PermissionSetArn: string | undefined;
359
392
  /**
393
+ * @public
360
394
  * <p>The entity type for which the assignment will be created.</p>
361
395
  */
362
396
  PrincipalType: PrincipalType | string | undefined;
363
397
  /**
398
+ * @public
364
399
  * <p>An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the <a href="/singlesignon/latest/IdentityStoreAPIReference/welcome.html">IAM Identity Center Identity Store API Reference</a>.</p>
365
400
  */
366
401
  PrincipalId: string | undefined;
@@ -370,6 +405,7 @@ export interface CreateAccountAssignmentRequest {
370
405
  */
371
406
  export interface CreateAccountAssignmentResponse {
372
407
  /**
408
+ * @public
373
409
  * <p>The status object for the account assignment creation operation.</p>
374
410
  */
375
411
  AccountAssignmentCreationStatus?: AccountAssignmentOperationStatus;
@@ -381,6 +417,7 @@ export interface CreateAccountAssignmentResponse {
381
417
  */
382
418
  export interface InstanceAccessControlAttributeConfiguration {
383
419
  /**
420
+ * @public
384
421
  * <p>Lists the attributes that are configured for ABAC in the specified IAM Identity Center
385
422
  * instance.</p>
386
423
  */
@@ -391,10 +428,12 @@ export interface InstanceAccessControlAttributeConfiguration {
391
428
  */
392
429
  export interface CreateInstanceAccessControlAttributeConfigurationRequest {
393
430
  /**
431
+ * @public
394
432
  * <p>The ARN of the IAM Identity Center instance under which the operation will be executed.</p>
395
433
  */
396
434
  InstanceArn: string | undefined;
397
435
  /**
436
+ * @public
398
437
  * <p>Specifies the IAM Identity Center identity store attributes to add to your ABAC configuration. When
399
438
  * using an external identity provider as an identity source, you can pass attributes through the
400
439
  * SAML assertion. Doing so provides an alternative to configuring attributes from the IAM Identity Center
@@ -416,10 +455,12 @@ export interface CreateInstanceAccessControlAttributeConfigurationResponse {
416
455
  */
417
456
  export interface Tag {
418
457
  /**
458
+ * @public
419
459
  * <p>The key for the tag.</p>
420
460
  */
421
461
  Key: string | undefined;
422
462
  /**
463
+ * @public
423
464
  * <p>The value of the tag.</p>
424
465
  */
425
466
  Value: string | undefined;
@@ -429,29 +470,35 @@ export interface Tag {
429
470
  */
430
471
  export interface CreatePermissionSetRequest {
431
472
  /**
473
+ * @public
432
474
  * <p>The name of the <a>PermissionSet</a>.</p>
433
475
  */
434
476
  Name: string | undefined;
435
477
  /**
478
+ * @public
436
479
  * <p>The description of the <a>PermissionSet</a>.</p>
437
480
  */
438
481
  Description?: string;
439
482
  /**
483
+ * @public
440
484
  * <p>The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource
441
485
  * Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>
442
486
  */
443
487
  InstanceArn: string | undefined;
444
488
  /**
489
+ * @public
445
490
  * <p>The length of time that the application user sessions are valid in the ISO-8601
446
491
  * standard.</p>
447
492
  */
448
493
  SessionDuration?: string;
449
494
  /**
495
+ * @public
450
496
  * <p>Used to redirect users within the application during the federation authentication
451
497
  * process.</p>
452
498
  */
453
499
  RelayState?: string;
454
500
  /**
501
+ * @public
455
502
  * <p>The tags to attach to the new <a>PermissionSet</a>.</p>
456
503
  */
457
504
  Tags?: Tag[];
@@ -462,28 +509,34 @@ export interface CreatePermissionSetRequest {
462
509
  */
463
510
  export interface PermissionSet {
464
511
  /**
512
+ * @public
465
513
  * <p>The name of the permission set.</p>
466
514
  */
467
515
  Name?: string;
468
516
  /**
517
+ * @public
469
518
  * <p>The ARN of the permission set. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource
470
519
  * Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>
471
520
  */
472
521
  PermissionSetArn?: string;
473
522
  /**
523
+ * @public
474
524
  * <p>The description of the <a>PermissionSet</a>.</p>
475
525
  */
476
526
  Description?: string;
477
527
  /**
528
+ * @public
478
529
  * <p>The date that the permission set was created.</p>
479
530
  */
480
531
  CreatedDate?: Date;
481
532
  /**
533
+ * @public
482
534
  * <p>The length of time that the application user sessions are valid for in the ISO-8601
483
535
  * standard.</p>
484
536
  */
485
537
  SessionDuration?: string;
486
538
  /**
539
+ * @public
487
540
  * <p>Used to redirect users within the application during the federation authentication
488
541
  * process.</p>
489
542
  */
@@ -494,6 +547,7 @@ export interface PermissionSet {
494
547
  */
495
548
  export interface CreatePermissionSetResponse {
496
549
  /**
550
+ * @public
497
551
  * <p>Defines the level of access on an AWS account.</p>
498
552
  */
499
553
  PermissionSet?: PermissionSet;
@@ -503,27 +557,33 @@ export interface CreatePermissionSetResponse {
503
557
  */
504
558
  export interface DeleteAccountAssignmentRequest {
505
559
  /**
560
+ * @public
506
561
  * <p>The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource
507
562
  * Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>
508
563
  */
509
564
  InstanceArn: string | undefined;
510
565
  /**
566
+ * @public
511
567
  * <p>TargetID is an AWS account identifier, typically a 10-12 digit string (For example, 123456789012).</p>
512
568
  */
513
569
  TargetId: string | undefined;
514
570
  /**
571
+ * @public
515
572
  * <p>The entity type for which the assignment will be deleted.</p>
516
573
  */
517
574
  TargetType: TargetType | string | undefined;
518
575
  /**
576
+ * @public
519
577
  * <p>The ARN of the permission set that will be used to remove access.</p>
520
578
  */
521
579
  PermissionSetArn: string | undefined;
522
580
  /**
581
+ * @public
523
582
  * <p>The entity type for which the assignment will be deleted.</p>
524
583
  */
525
584
  PrincipalType: PrincipalType | string | undefined;
526
585
  /**
586
+ * @public
527
587
  * <p>An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the <a href="/singlesignon/latest/IdentityStoreAPIReference/welcome.html">IAM Identity Center Identity Store API Reference</a>.</p>
528
588
  */
529
589
  PrincipalId: string | undefined;
@@ -533,6 +593,7 @@ export interface DeleteAccountAssignmentRequest {
533
593
  */
534
594
  export interface DeleteAccountAssignmentResponse {
535
595
  /**
596
+ * @public
536
597
  * <p>The status object for the account assignment deletion operation.</p>
537
598
  */
538
599
  AccountAssignmentDeletionStatus?: AccountAssignmentOperationStatus;
@@ -542,11 +603,13 @@ export interface DeleteAccountAssignmentResponse {
542
603
  */
543
604
  export interface DeleteInlinePolicyFromPermissionSetRequest {
544
605
  /**
606
+ * @public
545
607
  * <p>The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource
546
608
  * Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>
547
609
  */
548
610
  InstanceArn: string | undefined;
549
611
  /**
612
+ * @public
550
613
  * <p>The ARN of the permission set that will be used to remove access.</p>
551
614
  */
552
615
  PermissionSetArn: string | undefined;
@@ -561,6 +624,7 @@ export interface DeleteInlinePolicyFromPermissionSetResponse {
561
624
  */
562
625
  export interface DeleteInstanceAccessControlAttributeConfigurationRequest {
563
626
  /**
627
+ * @public
564
628
  * <p>The ARN of the IAM Identity Center instance under which the operation will be executed.</p>
565
629
  */
566
630
  InstanceArn: string | undefined;
@@ -575,10 +639,12 @@ export interface DeleteInstanceAccessControlAttributeConfigurationResponse {
575
639
  */
576
640
  export interface DeletePermissionsBoundaryFromPermissionSetRequest {
577
641
  /**
642
+ * @public
578
643
  * <p>The ARN of the IAM Identity Center instance under which the operation will be executed. </p>
579
644
  */
580
645
  InstanceArn: string | undefined;
581
646
  /**
647
+ * @public
582
648
  * <p>The ARN of the <code>PermissionSet</code>.</p>
583
649
  */
584
650
  PermissionSetArn: string | undefined;
@@ -593,11 +659,13 @@ export interface DeletePermissionsBoundaryFromPermissionSetResponse {
593
659
  */
594
660
  export interface DeletePermissionSetRequest {
595
661
  /**
662
+ * @public
596
663
  * <p>The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource
597
664
  * Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>
598
665
  */
599
666
  InstanceArn: string | undefined;
600
667
  /**
668
+ * @public
601
669
  * <p>The ARN of the permission set that should be deleted.</p>
602
670
  */
603
671
  PermissionSetArn: string | undefined;
@@ -612,11 +680,13 @@ export interface DeletePermissionSetResponse {
612
680
  */
613
681
  export interface DescribeAccountAssignmentCreationStatusRequest {
614
682
  /**
683
+ * @public
615
684
  * <p>The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource
616
685
  * Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>
617
686
  */
618
687
  InstanceArn: string | undefined;
619
688
  /**
689
+ * @public
620
690
  * <p>The identifier that is used to track the request operation progress.</p>
621
691
  */
622
692
  AccountAssignmentCreationRequestId: string | undefined;
@@ -626,6 +696,7 @@ export interface DescribeAccountAssignmentCreationStatusRequest {
626
696
  */
627
697
  export interface DescribeAccountAssignmentCreationStatusResponse {
628
698
  /**
699
+ * @public
629
700
  * <p>The status object for the account assignment creation operation.</p>
630
701
  */
631
702
  AccountAssignmentCreationStatus?: AccountAssignmentOperationStatus;
@@ -635,11 +706,13 @@ export interface DescribeAccountAssignmentCreationStatusResponse {
635
706
  */
636
707
  export interface DescribeAccountAssignmentDeletionStatusRequest {
637
708
  /**
709
+ * @public
638
710
  * <p>The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource
639
711
  * Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>
640
712
  */
641
713
  InstanceArn: string | undefined;
642
714
  /**
715
+ * @public
643
716
  * <p>The identifier that is used to track the request operation progress.</p>
644
717
  */
645
718
  AccountAssignmentDeletionRequestId: string | undefined;
@@ -649,6 +722,7 @@ export interface DescribeAccountAssignmentDeletionStatusRequest {
649
722
  */
650
723
  export interface DescribeAccountAssignmentDeletionStatusResponse {
651
724
  /**
725
+ * @public
652
726
  * <p>The status object for the account assignment deletion operation.</p>
653
727
  */
654
728
  AccountAssignmentDeletionStatus?: AccountAssignmentOperationStatus;
@@ -658,6 +732,7 @@ export interface DescribeAccountAssignmentDeletionStatusResponse {
658
732
  */
659
733
  export interface DescribeInstanceAccessControlAttributeConfigurationRequest {
660
734
  /**
735
+ * @public
661
736
  * <p>The ARN of the IAM Identity Center instance under which the operation will be executed.</p>
662
737
  */
663
738
  InstanceArn: string | undefined;
@@ -680,14 +755,17 @@ export type InstanceAccessControlAttributeConfigurationStatus = (typeof Instance
680
755
  */
681
756
  export interface DescribeInstanceAccessControlAttributeConfigurationResponse {
682
757
  /**
758
+ * @public
683
759
  * <p>The status of the attribute configuration process.</p>
684
760
  */
685
761
  Status?: InstanceAccessControlAttributeConfigurationStatus | string;
686
762
  /**
763
+ * @public
687
764
  * <p>Provides more details about the current status of the specified attribute.</p>
688
765
  */
689
766
  StatusReason?: string;
690
767
  /**
768
+ * @public
691
769
  * <p>Gets the list of IAM Identity Center identity store attributes that have been added to your ABAC
692
770
  * configuration.</p>
693
771
  */
@@ -698,11 +776,13 @@ export interface DescribeInstanceAccessControlAttributeConfigurationResponse {
698
776
  */
699
777
  export interface DescribePermissionSetRequest {
700
778
  /**
779
+ * @public
701
780
  * <p>The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource
702
781
  * Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>
703
782
  */
704
783
  InstanceArn: string | undefined;
705
784
  /**
785
+ * @public
706
786
  * <p>The ARN of the permission set. </p>
707
787
  */
708
788
  PermissionSetArn: string | undefined;
@@ -712,6 +792,7 @@ export interface DescribePermissionSetRequest {
712
792
  */
713
793
  export interface DescribePermissionSetResponse {
714
794
  /**
795
+ * @public
715
796
  * <p>Describes the level of access on an AWS account.</p>
716
797
  */
717
798
  PermissionSet?: PermissionSet;
@@ -721,11 +802,13 @@ export interface DescribePermissionSetResponse {
721
802
  */
722
803
  export interface DescribePermissionSetProvisioningStatusRequest {
723
804
  /**
805
+ * @public
724
806
  * <p>The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource
725
807
  * Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>
726
808
  */
727
809
  InstanceArn: string | undefined;
728
810
  /**
811
+ * @public
729
812
  * <p>The identifier that is provided by the <a>ProvisionPermissionSet</a> call to
730
813
  * retrieve the current status of the provisioning workflow.</p>
731
814
  */
@@ -738,28 +821,34 @@ export interface DescribePermissionSetProvisioningStatusRequest {
738
821
  */
739
822
  export interface PermissionSetProvisioningStatus {
740
823
  /**
824
+ * @public
741
825
  * <p>The status of the permission set provisioning process.</p>
742
826
  */
743
827
  Status?: StatusValues | string;
744
828
  /**
829
+ * @public
745
830
  * <p>The identifier for tracking the request operation that is generated by the universally
746
831
  * unique identifier (UUID) workflow.</p>
747
832
  */
748
833
  RequestId?: string;
749
834
  /**
835
+ * @public
750
836
  * <p>The identifier of the AWS account from which to list the assignments.</p>
751
837
  */
752
838
  AccountId?: string;
753
839
  /**
840
+ * @public
754
841
  * <p>The ARN of the permission set that is being provisioned. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource
755
842
  * Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>
756
843
  */
757
844
  PermissionSetArn?: string;
758
845
  /**
846
+ * @public
759
847
  * <p>The message that contains an error or exception in case of an operation failure.</p>
760
848
  */
761
849
  FailureReason?: string;
762
850
  /**
851
+ * @public
763
852
  * <p>The date that the permission set was created.</p>
764
853
  */
765
854
  CreatedDate?: Date;
@@ -769,6 +858,7 @@ export interface PermissionSetProvisioningStatus {
769
858
  */
770
859
  export interface DescribePermissionSetProvisioningStatusResponse {
771
860
  /**
861
+ * @public
772
862
  * <p>The status object for the permission set provisioning operation.</p>
773
863
  */
774
864
  PermissionSetProvisioningStatus?: PermissionSetProvisioningStatus;
@@ -778,14 +868,17 @@ export interface DescribePermissionSetProvisioningStatusResponse {
778
868
  */
779
869
  export interface DetachCustomerManagedPolicyReferenceFromPermissionSetRequest {
780
870
  /**
871
+ * @public
781
872
  * <p>The ARN of the IAM Identity Center instance under which the operation will be executed. </p>
782
873
  */
783
874
  InstanceArn: string | undefined;
784
875
  /**
876
+ * @public
785
877
  * <p>The ARN of the <code>PermissionSet</code>.</p>
786
878
  */
787
879
  PermissionSetArn: string | undefined;
788
880
  /**
881
+ * @public
789
882
  * <p>Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each AWS account where you want to deploy your permission set.</p>
790
883
  */
791
884
  CustomerManagedPolicyReference: CustomerManagedPolicyReference | undefined;
@@ -800,16 +893,19 @@ export interface DetachCustomerManagedPolicyReferenceFromPermissionSetResponse {
800
893
  */
801
894
  export interface DetachManagedPolicyFromPermissionSetRequest {
802
895
  /**
896
+ * @public
803
897
  * <p>The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource
804
898
  * Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>
805
899
  */
806
900
  InstanceArn: string | undefined;
807
901
  /**
902
+ * @public
808
903
  * <p>The ARN of the <a>PermissionSet</a> from which the policy should be
809
904
  * detached.</p>
810
905
  */
811
906
  PermissionSetArn: string | undefined;
812
907
  /**
908
+ * @public
813
909
  * <p>The AWS managed policy ARN to be detached from a permission set.</p>
814
910
  */
815
911
  ManagedPolicyArn: string | undefined;
@@ -824,11 +920,13 @@ export interface DetachManagedPolicyFromPermissionSetResponse {
824
920
  */
825
921
  export interface GetInlinePolicyForPermissionSetRequest {
826
922
  /**
923
+ * @public
827
924
  * <p>The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource
828
925
  * Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>
829
926
  */
830
927
  InstanceArn: string | undefined;
831
928
  /**
929
+ * @public
832
930
  * <p>The ARN of the permission set.</p>
833
931
  */
834
932
  PermissionSetArn: string | undefined;
@@ -838,6 +936,7 @@ export interface GetInlinePolicyForPermissionSetRequest {
838
936
  */
839
937
  export interface GetInlinePolicyForPermissionSetResponse {
840
938
  /**
939
+ * @public
841
940
  * <p>The inline policy that is attached to the permission set.</p>
842
941
  */
843
942
  InlinePolicy?: string;
@@ -847,10 +946,12 @@ export interface GetInlinePolicyForPermissionSetResponse {
847
946
  */
848
947
  export interface GetPermissionsBoundaryForPermissionSetRequest {
849
948
  /**
949
+ * @public
850
950
  * <p>The ARN of the IAM Identity Center instance under which the operation will be executed. </p>
851
951
  */
852
952
  InstanceArn: string | undefined;
853
953
  /**
954
+ * @public
854
955
  * <p>The ARN of the <code>PermissionSet</code>.</p>
855
956
  */
856
957
  PermissionSetArn: string | undefined;
@@ -872,10 +973,12 @@ export interface GetPermissionsBoundaryForPermissionSetRequest {
872
973
  */
873
974
  export interface PermissionsBoundary {
874
975
  /**
976
+ * @public
875
977
  * <p>Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each AWS account where you want to deploy your permission set.</p>
876
978
  */
877
979
  CustomerManagedPolicyReference?: CustomerManagedPolicyReference;
878
980
  /**
981
+ * @public
879
982
  * <p>The AWS managed policy ARN that you want to attach to a permission set as a permissions
880
983
  * boundary.</p>
881
984
  */
@@ -886,6 +989,7 @@ export interface PermissionsBoundary {
886
989
  */
887
990
  export interface GetPermissionsBoundaryForPermissionSetResponse {
888
991
  /**
992
+ * @public
889
993
  * <p>The permissions boundary attached to the specified permission set.</p>
890
994
  */
891
995
  PermissionsBoundary?: PermissionsBoundary;
@@ -896,11 +1000,13 @@ export interface GetPermissionsBoundaryForPermissionSetResponse {
896
1000
  */
897
1001
  export interface InstanceMetadata {
898
1002
  /**
1003
+ * @public
899
1004
  * <p>The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource
900
1005
  * Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>
901
1006
  */
902
1007
  InstanceArn?: string;
903
1008
  /**
1009
+ * @public
904
1010
  * <p>The identifier of the identity store that is connected to the IAM Identity Center instance.</p>
905
1011
  */
906
1012
  IdentityStoreId?: string;
@@ -911,6 +1017,7 @@ export interface InstanceMetadata {
911
1017
  */
912
1018
  export interface OperationStatusFilter {
913
1019
  /**
1020
+ * @public
914
1021
  * <p>Filters the list operations result based on the status attribute.</p>
915
1022
  */
916
1023
  Status?: StatusValues | string;
@@ -920,19 +1027,23 @@ export interface OperationStatusFilter {
920
1027
  */
921
1028
  export interface ListAccountAssignmentCreationStatusRequest {
922
1029
  /**
1030
+ * @public
923
1031
  * <p>The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource
924
1032
  * Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>
925
1033
  */
926
1034
  InstanceArn: string | undefined;
927
1035
  /**
1036
+ * @public
928
1037
  * <p>The maximum number of results to display for the assignment.</p>
929
1038
  */
930
1039
  MaxResults?: number;
931
1040
  /**
1041
+ * @public
932
1042
  * <p>The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.</p>
933
1043
  */
934
1044
  NextToken?: string;
935
1045
  /**
1046
+ * @public
936
1047
  * <p>Filters results based on the passed attribute value.</p>
937
1048
  */
938
1049
  Filter?: OperationStatusFilter;
@@ -942,10 +1053,12 @@ export interface ListAccountAssignmentCreationStatusRequest {
942
1053
  */
943
1054
  export interface ListAccountAssignmentCreationStatusResponse {
944
1055
  /**
1056
+ * @public
945
1057
  * <p>The status object for the account assignment creation operation.</p>
946
1058
  */
947
1059
  AccountAssignmentsCreationStatus?: AccountAssignmentOperationStatusMetadata[];
948
1060
  /**
1061
+ * @public
949
1062
  * <p>The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.</p>
950
1063
  */
951
1064
  NextToken?: string;
@@ -955,19 +1068,23 @@ export interface ListAccountAssignmentCreationStatusResponse {
955
1068
  */
956
1069
  export interface ListAccountAssignmentDeletionStatusRequest {
957
1070
  /**
1071
+ * @public
958
1072
  * <p>The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource
959
1073
  * Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>
960
1074
  */
961
1075
  InstanceArn: string | undefined;
962
1076
  /**
1077
+ * @public
963
1078
  * <p>The maximum number of results to display for the assignment.</p>
964
1079
  */
965
1080
  MaxResults?: number;
966
1081
  /**
1082
+ * @public
967
1083
  * <p>The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.</p>
968
1084
  */
969
1085
  NextToken?: string;
970
1086
  /**
1087
+ * @public
971
1088
  * <p>Filters results based on the passed attribute value.</p>
972
1089
  */
973
1090
  Filter?: OperationStatusFilter;
@@ -977,10 +1094,12 @@ export interface ListAccountAssignmentDeletionStatusRequest {
977
1094
  */
978
1095
  export interface ListAccountAssignmentDeletionStatusResponse {
979
1096
  /**
1097
+ * @public
980
1098
  * <p>The status object for the account assignment deletion operation.</p>
981
1099
  */
982
1100
  AccountAssignmentsDeletionStatus?: AccountAssignmentOperationStatusMetadata[];
983
1101
  /**
1102
+ * @public
984
1103
  * <p>The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.</p>
985
1104
  */
986
1105
  NextToken?: string;
@@ -990,23 +1109,28 @@ export interface ListAccountAssignmentDeletionStatusResponse {
990
1109
  */
991
1110
  export interface ListAccountAssignmentsRequest {
992
1111
  /**
1112
+ * @public
993
1113
  * <p>The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource
994
1114
  * Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>
995
1115
  */
996
1116
  InstanceArn: string | undefined;
997
1117
  /**
1118
+ * @public
998
1119
  * <p>The identifier of the AWS account from which to list the assignments.</p>
999
1120
  */
1000
1121
  AccountId: string | undefined;
1001
1122
  /**
1123
+ * @public
1002
1124
  * <p>The ARN of the permission set from which to list assignments.</p>
1003
1125
  */
1004
1126
  PermissionSetArn: string | undefined;
1005
1127
  /**
1128
+ * @public
1006
1129
  * <p>The maximum number of results to display for the assignment.</p>
1007
1130
  */
1008
1131
  MaxResults?: number;
1009
1132
  /**
1133
+ * @public
1010
1134
  * <p>The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.</p>
1011
1135
  */
1012
1136
  NextToken?: string;
@@ -1016,10 +1140,12 @@ export interface ListAccountAssignmentsRequest {
1016
1140
  */
1017
1141
  export interface ListAccountAssignmentsResponse {
1018
1142
  /**
1143
+ * @public
1019
1144
  * <p>The list of assignments that match the input AWS account and permission set.</p>
1020
1145
  */
1021
1146
  AccountAssignments?: AccountAssignment[];
1022
1147
  /**
1148
+ * @public
1023
1149
  * <p>The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.</p>
1024
1150
  */
1025
1151
  NextToken?: string;
@@ -1041,24 +1167,29 @@ export type ProvisioningStatus = (typeof ProvisioningStatus)[keyof typeof Provis
1041
1167
  */
1042
1168
  export interface ListAccountsForProvisionedPermissionSetRequest {
1043
1169
  /**
1170
+ * @public
1044
1171
  * <p>The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource
1045
1172
  * Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>
1046
1173
  */
1047
1174
  InstanceArn: string | undefined;
1048
1175
  /**
1176
+ * @public
1049
1177
  * <p>The ARN of the <a>PermissionSet</a> from which the associated AWS accounts
1050
1178
  * will be listed.</p>
1051
1179
  */
1052
1180
  PermissionSetArn: string | undefined;
1053
1181
  /**
1182
+ * @public
1054
1183
  * <p>The permission set provisioning status for an AWS account.</p>
1055
1184
  */
1056
1185
  ProvisioningStatus?: ProvisioningStatus | string;
1057
1186
  /**
1187
+ * @public
1058
1188
  * <p>The maximum number of results to display for the <a>PermissionSet</a>.</p>
1059
1189
  */
1060
1190
  MaxResults?: number;
1061
1191
  /**
1192
+ * @public
1062
1193
  * <p>The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.</p>
1063
1194
  */
1064
1195
  NextToken?: string;
@@ -1068,10 +1199,12 @@ export interface ListAccountsForProvisionedPermissionSetRequest {
1068
1199
  */
1069
1200
  export interface ListAccountsForProvisionedPermissionSetResponse {
1070
1201
  /**
1202
+ * @public
1071
1203
  * <p>The list of AWS <code>AccountIds</code>.</p>
1072
1204
  */
1073
1205
  AccountIds?: string[];
1074
1206
  /**
1207
+ * @public
1075
1208
  * <p>The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.</p>
1076
1209
  */
1077
1210
  NextToken?: string;
@@ -1081,18 +1214,22 @@ export interface ListAccountsForProvisionedPermissionSetResponse {
1081
1214
  */
1082
1215
  export interface ListCustomerManagedPolicyReferencesInPermissionSetRequest {
1083
1216
  /**
1217
+ * @public
1084
1218
  * <p>The ARN of the IAM Identity Center instance under which the operation will be executed. </p>
1085
1219
  */
1086
1220
  InstanceArn: string | undefined;
1087
1221
  /**
1222
+ * @public
1088
1223
  * <p>The ARN of the <code>PermissionSet</code>. </p>
1089
1224
  */
1090
1225
  PermissionSetArn: string | undefined;
1091
1226
  /**
1227
+ * @public
1092
1228
  * <p>The maximum number of results to display for the list call.</p>
1093
1229
  */
1094
1230
  MaxResults?: number;
1095
1231
  /**
1232
+ * @public
1096
1233
  * <p>The pagination token for the list API. Initially the value is null. Use the output of
1097
1234
  * previous API calls to make subsequent calls.</p>
1098
1235
  */
@@ -1103,11 +1240,13 @@ export interface ListCustomerManagedPolicyReferencesInPermissionSetRequest {
1103
1240
  */
1104
1241
  export interface ListCustomerManagedPolicyReferencesInPermissionSetResponse {
1105
1242
  /**
1243
+ * @public
1106
1244
  * <p>Specifies the names and paths of the customer managed policies that you have attached to
1107
1245
  * your permission set.</p>
1108
1246
  */
1109
1247
  CustomerManagedPolicyReferences?: CustomerManagedPolicyReference[];
1110
1248
  /**
1249
+ * @public
1111
1250
  * <p>The pagination token for the list API. Initially the value is null. Use the output of
1112
1251
  * previous API calls to make subsequent calls.</p>
1113
1252
  */
@@ -1118,10 +1257,12 @@ export interface ListCustomerManagedPolicyReferencesInPermissionSetResponse {
1118
1257
  */
1119
1258
  export interface ListInstancesRequest {
1120
1259
  /**
1260
+ * @public
1121
1261
  * <p>The maximum number of results to display for the instance.</p>
1122
1262
  */
1123
1263
  MaxResults?: number;
1124
1264
  /**
1265
+ * @public
1125
1266
  * <p>The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.</p>
1126
1267
  */
1127
1268
  NextToken?: string;
@@ -1131,10 +1272,12 @@ export interface ListInstancesRequest {
1131
1272
  */
1132
1273
  export interface ListInstancesResponse {
1133
1274
  /**
1275
+ * @public
1134
1276
  * <p>Lists the IAM Identity Center instances that the caller has access to.</p>
1135
1277
  */
1136
1278
  Instances?: InstanceMetadata[];
1137
1279
  /**
1280
+ * @public
1138
1281
  * <p>The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.</p>
1139
1282
  */
1140
1283
  NextToken?: string;
@@ -1144,20 +1287,24 @@ export interface ListInstancesResponse {
1144
1287
  */
1145
1288
  export interface ListManagedPoliciesInPermissionSetRequest {
1146
1289
  /**
1290
+ * @public
1147
1291
  * <p>The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource
1148
1292
  * Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>
1149
1293
  */
1150
1294
  InstanceArn: string | undefined;
1151
1295
  /**
1296
+ * @public
1152
1297
  * <p>The ARN of the <a>PermissionSet</a> whose managed policies will be
1153
1298
  * listed.</p>
1154
1299
  */
1155
1300
  PermissionSetArn: string | undefined;
1156
1301
  /**
1302
+ * @public
1157
1303
  * <p>The maximum number of results to display for the <a>PermissionSet</a>.</p>
1158
1304
  */
1159
1305
  MaxResults?: number;
1160
1306
  /**
1307
+ * @public
1161
1308
  * <p>The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.</p>
1162
1309
  */
1163
1310
  NextToken?: string;
@@ -1167,10 +1314,12 @@ export interface ListManagedPoliciesInPermissionSetRequest {
1167
1314
  */
1168
1315
  export interface ListManagedPoliciesInPermissionSetResponse {
1169
1316
  /**
1317
+ * @public
1170
1318
  * <p>An array of the <a>AttachedManagedPolicy</a> data type object.</p>
1171
1319
  */
1172
1320
  AttachedManagedPolicies?: AttachedManagedPolicy[];
1173
1321
  /**
1322
+ * @public
1174
1323
  * <p>The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.</p>
1175
1324
  */
1176
1325
  NextToken?: string;
@@ -1180,19 +1329,23 @@ export interface ListManagedPoliciesInPermissionSetResponse {
1180
1329
  */
1181
1330
  export interface ListPermissionSetProvisioningStatusRequest {
1182
1331
  /**
1332
+ * @public
1183
1333
  * <p>The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource
1184
1334
  * Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>
1185
1335
  */
1186
1336
  InstanceArn: string | undefined;
1187
1337
  /**
1338
+ * @public
1188
1339
  * <p>The maximum number of results to display for the assignment.</p>
1189
1340
  */
1190
1341
  MaxResults?: number;
1191
1342
  /**
1343
+ * @public
1192
1344
  * <p>The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.</p>
1193
1345
  */
1194
1346
  NextToken?: string;
1195
1347
  /**
1348
+ * @public
1196
1349
  * <p>Filters results based on the passed attribute value.</p>
1197
1350
  */
1198
1351
  Filter?: OperationStatusFilter;
@@ -1203,15 +1356,18 @@ export interface ListPermissionSetProvisioningStatusRequest {
1203
1356
  */
1204
1357
  export interface PermissionSetProvisioningStatusMetadata {
1205
1358
  /**
1359
+ * @public
1206
1360
  * <p>The status of the permission set provisioning process.</p>
1207
1361
  */
1208
1362
  Status?: StatusValues | string;
1209
1363
  /**
1364
+ * @public
1210
1365
  * <p>The identifier for tracking the request operation that is generated by the universally
1211
1366
  * unique identifier (UUID) workflow.</p>
1212
1367
  */
1213
1368
  RequestId?: string;
1214
1369
  /**
1370
+ * @public
1215
1371
  * <p>The date that the permission set was created.</p>
1216
1372
  */
1217
1373
  CreatedDate?: Date;
@@ -1221,10 +1377,12 @@ export interface PermissionSetProvisioningStatusMetadata {
1221
1377
  */
1222
1378
  export interface ListPermissionSetProvisioningStatusResponse {
1223
1379
  /**
1380
+ * @public
1224
1381
  * <p>The status object for the permission set provisioning operation.</p>
1225
1382
  */
1226
1383
  PermissionSetsProvisioningStatus?: PermissionSetProvisioningStatusMetadata[];
1227
1384
  /**
1385
+ * @public
1228
1386
  * <p>The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.</p>
1229
1387
  */
1230
1388
  NextToken?: string;
@@ -1234,15 +1392,18 @@ export interface ListPermissionSetProvisioningStatusResponse {
1234
1392
  */
1235
1393
  export interface ListPermissionSetsRequest {
1236
1394
  /**
1395
+ * @public
1237
1396
  * <p>The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource
1238
1397
  * Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>
1239
1398
  */
1240
1399
  InstanceArn: string | undefined;
1241
1400
  /**
1401
+ * @public
1242
1402
  * <p>The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.</p>
1243
1403
  */
1244
1404
  NextToken?: string;
1245
1405
  /**
1406
+ * @public
1246
1407
  * <p>The maximum number of results to display for the assignment.</p>
1247
1408
  */
1248
1409
  MaxResults?: number;
@@ -1252,10 +1413,12 @@ export interface ListPermissionSetsRequest {
1252
1413
  */
1253
1414
  export interface ListPermissionSetsResponse {
1254
1415
  /**
1416
+ * @public
1255
1417
  * <p>Defines the level of access on an AWS account.</p>
1256
1418
  */
1257
1419
  PermissionSets?: string[];
1258
1420
  /**
1421
+ * @public
1259
1422
  * <p>The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.</p>
1260
1423
  */
1261
1424
  NextToken?: string;
@@ -1265,23 +1428,28 @@ export interface ListPermissionSetsResponse {
1265
1428
  */
1266
1429
  export interface ListPermissionSetsProvisionedToAccountRequest {
1267
1430
  /**
1431
+ * @public
1268
1432
  * <p>The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource
1269
1433
  * Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>
1270
1434
  */
1271
1435
  InstanceArn: string | undefined;
1272
1436
  /**
1437
+ * @public
1273
1438
  * <p>The identifier of the AWS account from which to list the assignments.</p>
1274
1439
  */
1275
1440
  AccountId: string | undefined;
1276
1441
  /**
1442
+ * @public
1277
1443
  * <p>The status object for the permission set provisioning operation.</p>
1278
1444
  */
1279
1445
  ProvisioningStatus?: ProvisioningStatus | string;
1280
1446
  /**
1447
+ * @public
1281
1448
  * <p>The maximum number of results to display for the assignment.</p>
1282
1449
  */
1283
1450
  MaxResults?: number;
1284
1451
  /**
1452
+ * @public
1285
1453
  * <p>The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.</p>
1286
1454
  */
1287
1455
  NextToken?: string;
@@ -1291,10 +1459,12 @@ export interface ListPermissionSetsProvisionedToAccountRequest {
1291
1459
  */
1292
1460
  export interface ListPermissionSetsProvisionedToAccountResponse {
1293
1461
  /**
1462
+ * @public
1294
1463
  * <p>The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.</p>
1295
1464
  */
1296
1465
  NextToken?: string;
1297
1466
  /**
1467
+ * @public
1298
1468
  * <p>Defines the level of access that an AWS account has.</p>
1299
1469
  */
1300
1470
  PermissionSets?: string[];
@@ -1304,15 +1474,18 @@ export interface ListPermissionSetsProvisionedToAccountResponse {
1304
1474
  */
1305
1475
  export interface ListTagsForResourceRequest {
1306
1476
  /**
1477
+ * @public
1307
1478
  * <p>The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource
1308
1479
  * Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>
1309
1480
  */
1310
1481
  InstanceArn: string | undefined;
1311
1482
  /**
1483
+ * @public
1312
1484
  * <p>The ARN of the resource with the tags to be listed.</p>
1313
1485
  */
1314
1486
  ResourceArn: string | undefined;
1315
1487
  /**
1488
+ * @public
1316
1489
  * <p>The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.</p>
1317
1490
  */
1318
1491
  NextToken?: string;
@@ -1322,10 +1495,12 @@ export interface ListTagsForResourceRequest {
1322
1495
  */
1323
1496
  export interface ListTagsForResourceResponse {
1324
1497
  /**
1498
+ * @public
1325
1499
  * <p>A set of key-value pairs that are used to manage the resource.</p>
1326
1500
  */
1327
1501
  Tags?: Tag[];
1328
1502
  /**
1503
+ * @public
1329
1504
  * <p>The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.</p>
1330
1505
  */
1331
1506
  NextToken?: string;
@@ -1347,19 +1522,23 @@ export type ProvisionTargetType = (typeof ProvisionTargetType)[keyof typeof Prov
1347
1522
  */
1348
1523
  export interface ProvisionPermissionSetRequest {
1349
1524
  /**
1525
+ * @public
1350
1526
  * <p>The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource
1351
1527
  * Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>
1352
1528
  */
1353
1529
  InstanceArn: string | undefined;
1354
1530
  /**
1531
+ * @public
1355
1532
  * <p>The ARN of the permission set.</p>
1356
1533
  */
1357
1534
  PermissionSetArn: string | undefined;
1358
1535
  /**
1536
+ * @public
1359
1537
  * <p>TargetID is an AWS account identifier, typically a 10-12 digit string (For example, 123456789012).</p>
1360
1538
  */
1361
1539
  TargetId?: string;
1362
1540
  /**
1541
+ * @public
1363
1542
  * <p>The entity type for which the assignment will be created.</p>
1364
1543
  */
1365
1544
  TargetType: ProvisionTargetType | string | undefined;
@@ -1369,6 +1548,7 @@ export interface ProvisionPermissionSetRequest {
1369
1548
  */
1370
1549
  export interface ProvisionPermissionSetResponse {
1371
1550
  /**
1551
+ * @public
1372
1552
  * <p>The status object for the permission set provisioning operation.</p>
1373
1553
  */
1374
1554
  PermissionSetProvisioningStatus?: PermissionSetProvisioningStatus;
@@ -1378,15 +1558,18 @@ export interface ProvisionPermissionSetResponse {
1378
1558
  */
1379
1559
  export interface PutInlinePolicyToPermissionSetRequest {
1380
1560
  /**
1561
+ * @public
1381
1562
  * <p>The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource
1382
1563
  * Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>
1383
1564
  */
1384
1565
  InstanceArn: string | undefined;
1385
1566
  /**
1567
+ * @public
1386
1568
  * <p>The ARN of the permission set.</p>
1387
1569
  */
1388
1570
  PermissionSetArn: string | undefined;
1389
1571
  /**
1572
+ * @public
1390
1573
  * <p>The inline policy to attach to a <a>PermissionSet</a>.</p>
1391
1574
  */
1392
1575
  InlinePolicy: string | undefined;
@@ -1401,14 +1584,17 @@ export interface PutInlinePolicyToPermissionSetResponse {
1401
1584
  */
1402
1585
  export interface PutPermissionsBoundaryToPermissionSetRequest {
1403
1586
  /**
1587
+ * @public
1404
1588
  * <p>The ARN of the IAM Identity Center instance under which the operation will be executed. </p>
1405
1589
  */
1406
1590
  InstanceArn: string | undefined;
1407
1591
  /**
1592
+ * @public
1408
1593
  * <p>The ARN of the <code>PermissionSet</code>.</p>
1409
1594
  */
1410
1595
  PermissionSetArn: string | undefined;
1411
1596
  /**
1597
+ * @public
1412
1598
  * <p>The permissions boundary that you want to attach to a <code>PermissionSet</code>.</p>
1413
1599
  */
1414
1600
  PermissionsBoundary: PermissionsBoundary | undefined;
@@ -1423,15 +1609,18 @@ export interface PutPermissionsBoundaryToPermissionSetResponse {
1423
1609
  */
1424
1610
  export interface TagResourceRequest {
1425
1611
  /**
1612
+ * @public
1426
1613
  * <p>The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource
1427
1614
  * Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>
1428
1615
  */
1429
1616
  InstanceArn: string | undefined;
1430
1617
  /**
1618
+ * @public
1431
1619
  * <p>The ARN of the resource with the tags to be listed.</p>
1432
1620
  */
1433
1621
  ResourceArn: string | undefined;
1434
1622
  /**
1623
+ * @public
1435
1624
  * <p>A set of key-value pairs that are used to manage the resource.</p>
1436
1625
  */
1437
1626
  Tags: Tag[] | undefined;
@@ -1446,15 +1635,18 @@ export interface TagResourceResponse {
1446
1635
  */
1447
1636
  export interface UntagResourceRequest {
1448
1637
  /**
1638
+ * @public
1449
1639
  * <p>The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource
1450
1640
  * Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>
1451
1641
  */
1452
1642
  InstanceArn: string | undefined;
1453
1643
  /**
1644
+ * @public
1454
1645
  * <p>The ARN of the resource with the tags to be listed.</p>
1455
1646
  */
1456
1647
  ResourceArn: string | undefined;
1457
1648
  /**
1649
+ * @public
1458
1650
  * <p>The keys of tags that are attached to the resource.</p>
1459
1651
  */
1460
1652
  TagKeys: string[] | undefined;
@@ -1469,10 +1661,12 @@ export interface UntagResourceResponse {
1469
1661
  */
1470
1662
  export interface UpdateInstanceAccessControlAttributeConfigurationRequest {
1471
1663
  /**
1664
+ * @public
1472
1665
  * <p>The ARN of the IAM Identity Center instance under which the operation will be executed.</p>
1473
1666
  */
1474
1667
  InstanceArn: string | undefined;
1475
1668
  /**
1669
+ * @public
1476
1670
  * <p>Updates the attributes for your ABAC configuration.</p>
1477
1671
  */
1478
1672
  InstanceAccessControlAttributeConfiguration: InstanceAccessControlAttributeConfiguration | undefined;
@@ -1487,24 +1681,29 @@ export interface UpdateInstanceAccessControlAttributeConfigurationResponse {
1487
1681
  */
1488
1682
  export interface UpdatePermissionSetRequest {
1489
1683
  /**
1684
+ * @public
1490
1685
  * <p>The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource
1491
1686
  * Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>
1492
1687
  */
1493
1688
  InstanceArn: string | undefined;
1494
1689
  /**
1690
+ * @public
1495
1691
  * <p>The ARN of the permission set.</p>
1496
1692
  */
1497
1693
  PermissionSetArn: string | undefined;
1498
1694
  /**
1695
+ * @public
1499
1696
  * <p>The description of the <a>PermissionSet</a>.</p>
1500
1697
  */
1501
1698
  Description?: string;
1502
1699
  /**
1700
+ * @public
1503
1701
  * <p>The length of time that the application user sessions are valid for in the ISO-8601
1504
1702
  * standard.</p>
1505
1703
  */
1506
1704
  SessionDuration?: string;
1507
1705
  /**
1706
+ * @public
1508
1707
  * <p>Used to redirect users within the application during the federation authentication
1509
1708
  * process.</p>
1510
1709
  */
@@ -1,5 +1,6 @@
1
1
  export * from "./SSOAdminClient";
2
2
  export * from "./SSOAdmin";
3
+ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
3
4
  export * from "./commands";
4
5
  export * from "./pagination";
5
6
  export * from "./models";
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-sso-admin",
3
3
  "description": "AWS SDK for JavaScript Sso Admin Client for Node.js, Browser and React Native",
4
- "version": "3.378.0",
4
+ "version": "3.382.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.378.0",
25
- "@aws-sdk/credential-provider-node": "3.378.0",
26
- "@aws-sdk/middleware-host-header": "3.378.0",
24
+ "@aws-sdk/client-sts": "3.382.0",
25
+ "@aws-sdk/credential-provider-node": "3.382.0",
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
- "@aws-sdk/middleware-signing": "3.378.0",
30
- "@aws-sdk/middleware-user-agent": "3.378.0",
29
+ "@aws-sdk/middleware-signing": "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",