@aws-sdk/client-verifiedpermissions 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.
@@ -23,10 +23,12 @@ export declare class AccessDeniedException extends __BaseException {
23
23
  */
24
24
  export interface ActionIdentifier {
25
25
  /**
26
+ * @public
26
27
  * <p>The type of an action.</p>
27
28
  */
28
29
  actionType: string | undefined;
29
30
  /**
31
+ * @public
30
32
  * <p>The ID of an action.</p>
31
33
  */
32
34
  actionId: string | undefined;
@@ -43,12 +45,14 @@ export interface ActionIdentifier {
43
45
  */
44
46
  export interface EntityIdentifier {
45
47
  /**
48
+ * @public
46
49
  * <p>The type of an entity.</p>
47
50
  * <p>Example: <code>"entityType":"<i>typeName</i>"</code>
48
51
  * </p>
49
52
  */
50
53
  entityType: string | undefined;
51
54
  /**
55
+ * @public
52
56
  * <p>The identifier of an entity.</p>
53
57
  * <p>
54
58
  * <code>"entityId":"<i>identifier</i>"</code>
@@ -68,6 +72,7 @@ export interface EntityIdentifier {
68
72
  */
69
73
  export interface CognitoUserPoolConfiguration {
70
74
  /**
75
+ * @public
71
76
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the Amazon Cognito user pool that contains the identities to be
72
77
  * authorized.</p>
73
78
  * <p>Example: <code>"UserPoolArn":
@@ -76,6 +81,7 @@ export interface CognitoUserPoolConfiguration {
76
81
  */
77
82
  userPoolArn: string | undefined;
78
83
  /**
84
+ * @public
79
85
  * <p>The unique application client IDs that are associated with the specified Amazon Cognito user
80
86
  * pool.</p>
81
87
  * <p>Example: <code>"ClientIds": ["&amp;ExampleCogClientId;"]</code>
@@ -101,6 +107,7 @@ export type Configuration = Configuration.CognitoUserPoolConfigurationMember | C
101
107
  */
102
108
  export declare namespace Configuration {
103
109
  /**
110
+ * @public
104
111
  * <p>Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of
105
112
  * authenticated identities as entities. It specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of a Amazon Cognito user pool
106
113
  * and one or more application client IDs.</p>
@@ -113,6 +120,9 @@ export declare namespace Configuration {
113
120
  cognitoUserPoolConfiguration: CognitoUserPoolConfiguration;
114
121
  $unknown?: never;
115
122
  }
123
+ /**
124
+ * @public
125
+ */
116
126
  interface $UnknownMember {
117
127
  cognitoUserPoolConfiguration?: never;
118
128
  $unknown: [string, any];
@@ -144,10 +154,12 @@ export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
144
154
  */
145
155
  export interface ResourceConflict {
146
156
  /**
157
+ * @public
147
158
  * <p>The unique identifier of the resource involved in a conflict.</p>
148
159
  */
149
160
  resourceId: string | undefined;
150
161
  /**
162
+ * @public
151
163
  * <p>The type of the resource involved in a conflict.</p>
152
164
  */
153
165
  resourceType: ResourceType | string | undefined;
@@ -161,6 +173,7 @@ export declare class ConflictException extends __BaseException {
161
173
  readonly name: "ConflictException";
162
174
  readonly $fault: "client";
163
175
  /**
176
+ * @public
164
177
  * <p>The list of resources referenced with this failed request.</p>
165
178
  */
166
179
  resources: ResourceConflict[] | undefined;
@@ -174,6 +187,7 @@ export declare class ConflictException extends __BaseException {
174
187
  */
175
188
  export interface CreateIdentitySourceInput {
176
189
  /**
190
+ * @public
177
191
  * <p>Specifies a unique, case-sensitive ID that you provide to
178
192
  * ensure the idempotency of the request. This lets you safely retry the request without
179
193
  * accidentally performing the same operation a second time. Passing the same value to a
@@ -188,12 +202,14 @@ export interface CreateIdentitySourceInput {
188
202
  */
189
203
  clientToken?: string;
190
204
  /**
205
+ * @public
191
206
  * <p>Specifies the ID of the policy store in which you want to store this identity source. Only policies and
192
207
  * requests made using this policy store can reference identities from the identity provider
193
208
  * configured in the new identity source.</p>
194
209
  */
195
210
  policyStoreId: string | undefined;
196
211
  /**
212
+ * @public
197
213
  * <p>Specifies the details required to communicate with the identity provider (IdP)
198
214
  * associated with this identity source.</p>
199
215
  * <note>
@@ -205,6 +221,7 @@ export interface CreateIdentitySourceInput {
205
221
  */
206
222
  configuration: Configuration | undefined;
207
223
  /**
224
+ * @public
208
225
  * <p>Specifies the namespace and data type of the principals generated for identities
209
226
  * authenticated by the new identity source.</p>
210
227
  */
@@ -215,18 +232,22 @@ export interface CreateIdentitySourceInput {
215
232
  */
216
233
  export interface CreateIdentitySourceOutput {
217
234
  /**
235
+ * @public
218
236
  * <p>The date and time the identity source was originally created.</p>
219
237
  */
220
238
  createdDate: Date | undefined;
221
239
  /**
240
+ * @public
222
241
  * <p>The unique ID of the new identity source.</p>
223
242
  */
224
243
  identitySourceId: string | undefined;
225
244
  /**
245
+ * @public
226
246
  * <p>The date and time the identity source was most recently updated.</p>
227
247
  */
228
248
  lastUpdatedDate: Date | undefined;
229
249
  /**
250
+ * @public
230
251
  * <p>The ID of the policy store that contains the identity source.</p>
231
252
  */
232
253
  policyStoreId: string | undefined;
@@ -252,10 +273,12 @@ export declare class ResourceNotFoundException extends __BaseException {
252
273
  readonly name: "ResourceNotFoundException";
253
274
  readonly $fault: "client";
254
275
  /**
276
+ * @public
255
277
  * <p>The unique ID of the resource referenced in the failed request.</p>
256
278
  */
257
279
  resourceId: string | undefined;
258
280
  /**
281
+ * @public
259
282
  * <p>The resource type of the resource referenced in the failed request.</p>
260
283
  */
261
284
  resourceType: ResourceType | string | undefined;
@@ -272,18 +295,22 @@ export declare class ServiceQuotaExceededException extends __BaseException {
272
295
  readonly name: "ServiceQuotaExceededException";
273
296
  readonly $fault: "client";
274
297
  /**
298
+ * @public
275
299
  * <p>The unique ID of the resource referenced in the failed request.</p>
276
300
  */
277
301
  resourceId?: string;
278
302
  /**
303
+ * @public
279
304
  * <p>The resource type of the resource referenced in the failed request.</p>
280
305
  */
281
306
  resourceType: ResourceType | string | undefined;
282
307
  /**
308
+ * @public
283
309
  * <p>The code for the Amazon Web Service that owns the quota.</p>
284
310
  */
285
311
  serviceCode?: string;
286
312
  /**
313
+ * @public
287
314
  * <p>The quota code recognized by the Amazon Web Services Service Quotas service.</p>
288
315
  */
289
316
  quotaCode?: string;
@@ -303,10 +330,12 @@ export declare class ThrottlingException extends __BaseException {
303
330
  throttling: boolean;
304
331
  };
305
332
  /**
333
+ * @public
306
334
  * <p>The code for the Amazon Web Service that owns the quota.</p>
307
335
  */
308
336
  serviceCode?: string;
309
337
  /**
338
+ * @public
310
339
  * <p>The quota code recognized by the Amazon Web Services Service Quotas service.</p>
311
340
  */
312
341
  quotaCode?: string;
@@ -321,10 +350,12 @@ export declare class ThrottlingException extends __BaseException {
321
350
  */
322
351
  export interface ValidationExceptionField {
323
352
  /**
353
+ * @public
324
354
  * <p>The path to the specific element that Verified Permissions found to be not valid.</p>
325
355
  */
326
356
  path: string | undefined;
327
357
  /**
358
+ * @public
328
359
  * <p>Describes the policy validation error.</p>
329
360
  */
330
361
  message: string | undefined;
@@ -418,6 +449,7 @@ export declare class ValidationException extends __BaseException {
418
449
  readonly name: "ValidationException";
419
450
  readonly $fault: "client";
420
451
  /**
452
+ * @public
421
453
  * <p>The list of fields that aren't valid.</p>
422
454
  */
423
455
  fieldList?: ValidationExceptionField[];
@@ -434,10 +466,12 @@ export declare class ValidationException extends __BaseException {
434
466
  */
435
467
  export interface StaticPolicyDefinition {
436
468
  /**
469
+ * @public
437
470
  * <p>The description of the static policy.</p>
438
471
  */
439
472
  description?: string;
440
473
  /**
474
+ * @public
441
475
  * <p>The policy content of the static policy, written in the Cedar policy language.</p>
442
476
  */
443
477
  statement: string | undefined;
@@ -448,16 +482,19 @@ export interface StaticPolicyDefinition {
448
482
  */
449
483
  export interface TemplateLinkedPolicyDefinition {
450
484
  /**
485
+ * @public
451
486
  * <p>The unique identifier of the policy template used to create this policy.</p>
452
487
  */
453
488
  policyTemplateId: string | undefined;
454
489
  /**
490
+ * @public
455
491
  * <p>The principal associated with this template-linked policy. Verified Permissions substitutes this principal for the
456
492
  * <code>?principal</code> placeholder in the policy template when it evaluates an authorization
457
493
  * request.</p>
458
494
  */
459
495
  principal?: EntityIdentifier;
460
496
  /**
497
+ * @public
461
498
  * <p>The resource associated with this template-linked policy. Verified Permissions substitutes this resource for the
462
499
  * <code>?resource</code> placeholder in the policy template when it evaluates an authorization
463
500
  * request.</p>
@@ -479,6 +516,7 @@ export type PolicyDefinition = PolicyDefinition.StaticMember | PolicyDefinition.
479
516
  */
480
517
  export declare namespace PolicyDefinition {
481
518
  /**
519
+ * @public
482
520
  * <p>A structure that describes a static policy. An static policy doesn't use a template or allow
483
521
  * placeholders for entities.</p>
484
522
  */
@@ -488,6 +526,7 @@ export declare namespace PolicyDefinition {
488
526
  $unknown?: never;
489
527
  }
490
528
  /**
529
+ * @public
491
530
  * <p>A structure that describes a policy that was instantiated from a template. The
492
531
  * template can specify placeholders for <code>principal</code> and <code>resource</code>.
493
532
  * When you use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html">CreatePolicy</a> to create a policy from a template, you specify the exact
@@ -498,6 +537,9 @@ export declare namespace PolicyDefinition {
498
537
  templateLinked: TemplateLinkedPolicyDefinition;
499
538
  $unknown?: never;
500
539
  }
540
+ /**
541
+ * @public
542
+ */
501
543
  interface $UnknownMember {
502
544
  static?: never;
503
545
  templateLinked?: never;
@@ -515,6 +557,7 @@ export declare namespace PolicyDefinition {
515
557
  */
516
558
  export interface CreatePolicyInput {
517
559
  /**
560
+ * @public
518
561
  * <p>Specifies a unique, case-sensitive ID that you provide to
519
562
  * ensure the idempotency of the request. This lets you safely retry the request without
520
563
  * accidentally performing the same operation a second time. Passing the same value to a
@@ -529,11 +572,13 @@ export interface CreatePolicyInput {
529
572
  */
530
573
  clientToken?: string;
531
574
  /**
575
+ * @public
532
576
  * <p>Specifies the <code>PolicyStoreId</code> of the policy store you want to store the policy
533
577
  * in.</p>
534
578
  */
535
579
  policyStoreId: string | undefined;
536
580
  /**
581
+ * @public
537
582
  * <p>A structure that specifies the policy type and content to use for the new policy. You
538
583
  * must include either a static or a templateLinked element. The policy content must be written
539
584
  * in the Cedar policy language.</p>
@@ -557,32 +602,39 @@ export type PolicyType = (typeof PolicyType)[keyof typeof PolicyType];
557
602
  */
558
603
  export interface CreatePolicyOutput {
559
604
  /**
605
+ * @public
560
606
  * <p>The ID of the policy store that contains the new policy.</p>
561
607
  */
562
608
  policyStoreId: string | undefined;
563
609
  /**
610
+ * @public
564
611
  * <p>The unique ID of the new policy.</p>
565
612
  */
566
613
  policyId: string | undefined;
567
614
  /**
615
+ * @public
568
616
  * <p>The policy type of the new policy.</p>
569
617
  */
570
618
  policyType: PolicyType | string | undefined;
571
619
  /**
620
+ * @public
572
621
  * <p>The principal specified in the new policy's scope. This response element isn't present
573
622
  * when <code>principal</code> isn't specified in the policy content.</p>
574
623
  */
575
624
  principal?: EntityIdentifier;
576
625
  /**
626
+ * @public
577
627
  * <p>The resource specified in the new policy's scope. This response element isn't present
578
628
  * when the <code>resource</code> isn't specified in the policy content.</p>
579
629
  */
580
630
  resource?: EntityIdentifier;
581
631
  /**
632
+ * @public
582
633
  * <p>The date and time the policy was originally created.</p>
583
634
  */
584
635
  createdDate: Date | undefined;
585
636
  /**
637
+ * @public
586
638
  * <p>The date and time the policy was last updated.</p>
587
639
  */
588
640
  lastUpdatedDate: Date | undefined;
@@ -608,6 +660,7 @@ export type ValidationMode = (typeof ValidationMode)[keyof typeof ValidationMode
608
660
  */
609
661
  export interface ValidationSettings {
610
662
  /**
663
+ * @public
611
664
  * <p>The validation mode currently configured for this policy store. The valid values are:</p>
612
665
  * <ul>
613
666
  * <li>
@@ -637,6 +690,7 @@ export interface ValidationSettings {
637
690
  */
638
691
  export interface CreatePolicyStoreInput {
639
692
  /**
693
+ * @public
640
694
  * <p>Specifies a unique, case-sensitive ID that you provide to
641
695
  * ensure the idempotency of the request. This lets you safely retry the request without
642
696
  * accidentally performing the same operation a second time. Passing the same value to a
@@ -651,6 +705,7 @@ export interface CreatePolicyStoreInput {
651
705
  */
652
706
  clientToken?: string;
653
707
  /**
708
+ * @public
654
709
  * <p>Specifies the validation setting for this policy store.</p>
655
710
  * <p>Currently, the only valid and required value is <code>Mode</code>.</p>
656
711
  * <important>
@@ -667,18 +722,22 @@ export interface CreatePolicyStoreInput {
667
722
  */
668
723
  export interface CreatePolicyStoreOutput {
669
724
  /**
725
+ * @public
670
726
  * <p>The unique ID of the new policy store.</p>
671
727
  */
672
728
  policyStoreId: string | undefined;
673
729
  /**
730
+ * @public
674
731
  * <p>The Amazon Resource Name (ARN) of the new policy store.</p>
675
732
  */
676
733
  arn: string | undefined;
677
734
  /**
735
+ * @public
678
736
  * <p>The date and time the policy store was originally created.</p>
679
737
  */
680
738
  createdDate: Date | undefined;
681
739
  /**
740
+ * @public
682
741
  * <p>The date and time the policy store was last updated.</p>
683
742
  */
684
743
  lastUpdatedDate: Date | undefined;
@@ -688,6 +747,7 @@ export interface CreatePolicyStoreOutput {
688
747
  */
689
748
  export interface CreatePolicyTemplateInput {
690
749
  /**
750
+ * @public
691
751
  * <p>Specifies a unique, case-sensitive ID that you provide to
692
752
  * ensure the idempotency of the request. This lets you safely retry the request without
693
753
  * accidentally performing the same operation a second time. Passing the same value to a
@@ -702,14 +762,17 @@ export interface CreatePolicyTemplateInput {
702
762
  */
703
763
  clientToken?: string;
704
764
  /**
765
+ * @public
705
766
  * <p>The ID of the policy store in which to create the policy template.</p>
706
767
  */
707
768
  policyStoreId: string | undefined;
708
769
  /**
770
+ * @public
709
771
  * <p>Specifies a description for the policy template.</p>
710
772
  */
711
773
  description?: string;
712
774
  /**
775
+ * @public
713
776
  * <p>Specifies the content that you want to use for the new policy template, written in the Cedar
714
777
  * policy language.</p>
715
778
  */
@@ -720,18 +783,22 @@ export interface CreatePolicyTemplateInput {
720
783
  */
721
784
  export interface CreatePolicyTemplateOutput {
722
785
  /**
786
+ * @public
723
787
  * <p>The ID of the policy store that contains the policy template.</p>
724
788
  */
725
789
  policyStoreId: string | undefined;
726
790
  /**
791
+ * @public
727
792
  * <p>The unique ID of the new policy template.</p>
728
793
  */
729
794
  policyTemplateId: string | undefined;
730
795
  /**
796
+ * @public
731
797
  * <p>The date and time the policy template was originally created.</p>
732
798
  */
733
799
  createdDate: Date | undefined;
734
800
  /**
801
+ * @public
735
802
  * <p>The date and time the policy template was most recently updated.</p>
736
803
  */
737
804
  lastUpdatedDate: Date | undefined;
@@ -753,10 +820,12 @@ export type Decision = (typeof Decision)[keyof typeof Decision];
753
820
  */
754
821
  export interface DeleteIdentitySourceInput {
755
822
  /**
823
+ * @public
756
824
  * <p>Specifies the ID of the policy store that contains the identity source that you want to delete.</p>
757
825
  */
758
826
  policyStoreId: string | undefined;
759
827
  /**
828
+ * @public
760
829
  * <p>Specifies the ID of the identity source that you want to delete.</p>
761
830
  */
762
831
  identitySourceId: string | undefined;
@@ -771,10 +840,12 @@ export interface DeleteIdentitySourceOutput {
771
840
  */
772
841
  export interface DeletePolicyInput {
773
842
  /**
843
+ * @public
774
844
  * <p>Specifies the ID of the policy store that contains the policy that you want to delete.</p>
775
845
  */
776
846
  policyStoreId: string | undefined;
777
847
  /**
848
+ * @public
778
849
  * <p>Specifies the ID of the policy that you want to delete.</p>
779
850
  */
780
851
  policyId: string | undefined;
@@ -789,6 +860,7 @@ export interface DeletePolicyOutput {
789
860
  */
790
861
  export interface DeletePolicyStoreInput {
791
862
  /**
863
+ * @public
792
864
  * <p>Specifies the ID of the policy store that you want to delete.</p>
793
865
  */
794
866
  policyStoreId: string | undefined;
@@ -803,10 +875,12 @@ export interface DeletePolicyStoreOutput {
803
875
  */
804
876
  export interface DeletePolicyTemplateInput {
805
877
  /**
878
+ * @public
806
879
  * <p>Specifies the ID of the policy store that contains the policy template that you want to delete.</p>
807
880
  */
808
881
  policyStoreId: string | undefined;
809
882
  /**
883
+ * @public
810
884
  * <p>Specifies the ID of the policy template that you want to delete.</p>
811
885
  */
812
886
  policyTemplateId: string | undefined;
@@ -827,6 +901,7 @@ export interface DeletePolicyTemplateOutput {
827
901
  */
828
902
  export interface DeterminingPolicyItem {
829
903
  /**
904
+ * @public
830
905
  * <p>The Id of a policy that determined to an authorization decision.</p>
831
906
  * <p>Example: <code>"policyId":"SPEXAMPLEabcdefg111111"</code>
832
907
  * </p>
@@ -846,6 +921,7 @@ export type EntityReference = EntityReference.IdentifierMember | EntityReference
846
921
  */
847
922
  export declare namespace EntityReference {
848
923
  /**
924
+ * @public
849
925
  * <p>Used to indicate that a principal or resource is not specified. This can be used to
850
926
  * search for policies that are not associated with a specific principal or
851
927
  * resource.</p>
@@ -856,6 +932,7 @@ export declare namespace EntityReference {
856
932
  $unknown?: never;
857
933
  }
858
934
  /**
935
+ * @public
859
936
  * <p>The identifier of the entity. It can consist of either an EntityType and EntityId, a
860
937
  * principal, or a resource.</p>
861
938
  */
@@ -864,6 +941,9 @@ export declare namespace EntityReference {
864
941
  identifier: EntityIdentifier;
865
942
  $unknown?: never;
866
943
  }
944
+ /**
945
+ * @public
946
+ */
867
947
  interface $UnknownMember {
868
948
  unspecified?: never;
869
949
  identifier?: never;
@@ -883,6 +963,7 @@ export declare namespace EntityReference {
883
963
  */
884
964
  export interface EvaluationErrorItem {
885
965
  /**
966
+ * @public
886
967
  * <p>The error description.</p>
887
968
  */
888
969
  errorDescription: string | undefined;
@@ -892,10 +973,12 @@ export interface EvaluationErrorItem {
892
973
  */
893
974
  export interface GetIdentitySourceInput {
894
975
  /**
976
+ * @public
895
977
  * <p>Specifies the ID of the policy store that contains the identity source you want information about.</p>
896
978
  */
897
979
  policyStoreId: string | undefined;
898
980
  /**
981
+ * @public
899
982
  * <p>Specifies the ID of the identity source you want information about.</p>
900
983
  */
901
984
  identitySourceId: string | undefined;
@@ -919,16 +1002,19 @@ export type OpenIdIssuer = (typeof OpenIdIssuer)[keyof typeof OpenIdIssuer];
919
1002
  */
920
1003
  export interface IdentitySourceDetails {
921
1004
  /**
1005
+ * @public
922
1006
  * <p>The application client IDs associated with the specified Amazon Cognito user pool that are
923
1007
  * enabled for this identity source.</p>
924
1008
  */
925
1009
  clientIds?: string[];
926
1010
  /**
1011
+ * @public
927
1012
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the Amazon Cognito user pool whose identities are accessible to this Verified Permissions
928
1013
  * policy store.</p>
929
1014
  */
930
1015
  userPoolArn?: string;
931
1016
  /**
1017
+ * @public
932
1018
  * <p>The well-known URL that points to this user pool's OIDC discovery endpoint. This is a
933
1019
  * URL string in the following format. This URL replaces the placeholders for both the
934
1020
  * Amazon Web Services Region and the user pool identifier with those appropriate for this user
@@ -939,6 +1025,7 @@ export interface IdentitySourceDetails {
939
1025
  */
940
1026
  discoveryUrl?: string;
941
1027
  /**
1028
+ * @public
942
1029
  * <p>A string that identifies the type of OIDC service represented by this identity source. </p>
943
1030
  * <p>At this time, the only valid value is <code>cognito</code>.</p>
944
1031
  */
@@ -949,26 +1036,32 @@ export interface IdentitySourceDetails {
949
1036
  */
950
1037
  export interface GetIdentitySourceOutput {
951
1038
  /**
1039
+ * @public
952
1040
  * <p>The date and time that the identity source was originally created.</p>
953
1041
  */
954
1042
  createdDate: Date | undefined;
955
1043
  /**
1044
+ * @public
956
1045
  * <p>A structure that describes the configuration of the identity source.</p>
957
1046
  */
958
1047
  details: IdentitySourceDetails | undefined;
959
1048
  /**
1049
+ * @public
960
1050
  * <p>The ID of the identity source.</p>
961
1051
  */
962
1052
  identitySourceId: string | undefined;
963
1053
  /**
1054
+ * @public
964
1055
  * <p>The date and time that the identity source was most recently updated.</p>
965
1056
  */
966
1057
  lastUpdatedDate: Date | undefined;
967
1058
  /**
1059
+ * @public
968
1060
  * <p>The ID of the policy store that contains the identity source.</p>
969
1061
  */
970
1062
  policyStoreId: string | undefined;
971
1063
  /**
1064
+ * @public
972
1065
  * <p>The data type of principals generated for identities authenticated by this
973
1066
  * identity source.</p>
974
1067
  */
@@ -979,11 +1072,13 @@ export interface GetIdentitySourceOutput {
979
1072
  */
980
1073
  export interface GetPolicyInput {
981
1074
  /**
1075
+ * @public
982
1076
  * <p>Specifies the ID of the policy store that contains the policy that you want information
983
1077
  * about.</p>
984
1078
  */
985
1079
  policyStoreId: string | undefined;
986
1080
  /**
1081
+ * @public
987
1082
  * <p>Specifies the ID of the policy you want information about.</p>
988
1083
  */
989
1084
  policyId: string | undefined;
@@ -997,10 +1092,12 @@ export interface GetPolicyInput {
997
1092
  */
998
1093
  export interface StaticPolicyDefinitionDetail {
999
1094
  /**
1095
+ * @public
1000
1096
  * <p>A description of the static policy.</p>
1001
1097
  */
1002
1098
  description?: string;
1003
1099
  /**
1100
+ * @public
1004
1101
  * <p>The content of the static policy written in the Cedar policy language.</p>
1005
1102
  */
1006
1103
  statement: string | undefined;
@@ -1014,16 +1111,19 @@ export interface StaticPolicyDefinitionDetail {
1014
1111
  */
1015
1112
  export interface TemplateLinkedPolicyDefinitionDetail {
1016
1113
  /**
1114
+ * @public
1017
1115
  * <p>The unique identifier of the policy template used to create this policy.</p>
1018
1116
  */
1019
1117
  policyTemplateId: string | undefined;
1020
1118
  /**
1119
+ * @public
1021
1120
  * <p>The principal associated with this template-linked policy. Verified Permissions substitutes this principal for the
1022
1121
  * <code>?principal</code> placeholder in the policy template when it evaluates an authorization
1023
1122
  * request.</p>
1024
1123
  */
1025
1124
  principal?: EntityIdentifier;
1026
1125
  /**
1126
+ * @public
1027
1127
  * <p>The resource associated with this template-linked policy. Verified Permissions substitutes this resource for the
1028
1128
  * <code>?resource</code> placeholder in the policy template when it evaluates an authorization
1029
1129
  * request.</p>
@@ -1042,6 +1142,7 @@ export type PolicyDefinitionDetail = PolicyDefinitionDetail.StaticMember | Polic
1042
1142
  */
1043
1143
  export declare namespace PolicyDefinitionDetail {
1044
1144
  /**
1145
+ * @public
1045
1146
  * <p>Information about a static policy that wasn't created with a policy template.</p>
1046
1147
  */
1047
1148
  interface StaticMember {
@@ -1050,6 +1151,7 @@ export declare namespace PolicyDefinitionDetail {
1050
1151
  $unknown?: never;
1051
1152
  }
1052
1153
  /**
1154
+ * @public
1053
1155
  * <p>Information about a template-linked policy that was created by instantiating a policy template.</p>
1054
1156
  */
1055
1157
  interface TemplateLinkedMember {
@@ -1057,6 +1159,9 @@ export declare namespace PolicyDefinitionDetail {
1057
1159
  templateLinked: TemplateLinkedPolicyDefinitionDetail;
1058
1160
  $unknown?: never;
1059
1161
  }
1162
+ /**
1163
+ * @public
1164
+ */
1060
1165
  interface $UnknownMember {
1061
1166
  static?: never;
1062
1167
  templateLinked?: never;
@@ -1074,36 +1179,44 @@ export declare namespace PolicyDefinitionDetail {
1074
1179
  */
1075
1180
  export interface GetPolicyOutput {
1076
1181
  /**
1182
+ * @public
1077
1183
  * <p>The ID of the policy store that contains the policy that you want information about.</p>
1078
1184
  */
1079
1185
  policyStoreId: string | undefined;
1080
1186
  /**
1187
+ * @public
1081
1188
  * <p>The unique ID of the policy that you want information about.</p>
1082
1189
  */
1083
1190
  policyId: string | undefined;
1084
1191
  /**
1192
+ * @public
1085
1193
  * <p>The type of the policy.</p>
1086
1194
  */
1087
1195
  policyType: PolicyType | string | undefined;
1088
1196
  /**
1197
+ * @public
1089
1198
  * <p>The principal specified in the policy's scope. This element isn't included in the
1090
1199
  * response when <code>Principal</code> isn't present in the policy content.</p>
1091
1200
  */
1092
1201
  principal?: EntityIdentifier;
1093
1202
  /**
1203
+ * @public
1094
1204
  * <p>The resource specified in the policy's scope. This element isn't included in the
1095
1205
  * response when <code>Resource</code> isn't present in the policy content.</p>
1096
1206
  */
1097
1207
  resource?: EntityIdentifier;
1098
1208
  /**
1209
+ * @public
1099
1210
  * <p>The definition of the requested policy.</p>
1100
1211
  */
1101
1212
  definition: PolicyDefinitionDetail | undefined;
1102
1213
  /**
1214
+ * @public
1103
1215
  * <p>The date and time that the policy was originally created.</p>
1104
1216
  */
1105
1217
  createdDate: Date | undefined;
1106
1218
  /**
1219
+ * @public
1107
1220
  * <p>The date and time that the policy was last updated.</p>
1108
1221
  */
1109
1222
  lastUpdatedDate: Date | undefined;
@@ -1113,6 +1226,7 @@ export interface GetPolicyOutput {
1113
1226
  */
1114
1227
  export interface GetPolicyStoreInput {
1115
1228
  /**
1229
+ * @public
1116
1230
  * <p>Specifies the ID of the policy store that you want information about.</p>
1117
1231
  */
1118
1232
  policyStoreId: string | undefined;
@@ -1122,22 +1236,27 @@ export interface GetPolicyStoreInput {
1122
1236
  */
1123
1237
  export interface GetPolicyStoreOutput {
1124
1238
  /**
1239
+ * @public
1125
1240
  * <p>The ID of the policy store;</p>
1126
1241
  */
1127
1242
  policyStoreId: string | undefined;
1128
1243
  /**
1244
+ * @public
1129
1245
  * <p>The Amazon Resource Name (ARN) of the policy store.</p>
1130
1246
  */
1131
1247
  arn: string | undefined;
1132
1248
  /**
1249
+ * @public
1133
1250
  * <p>The current validation settings for the policy store.</p>
1134
1251
  */
1135
1252
  validationSettings: ValidationSettings | undefined;
1136
1253
  /**
1254
+ * @public
1137
1255
  * <p>The date and time that the policy store was originally created.</p>
1138
1256
  */
1139
1257
  createdDate: Date | undefined;
1140
1258
  /**
1259
+ * @public
1141
1260
  * <p>The date and time that the policy store was last updated.</p>
1142
1261
  */
1143
1262
  lastUpdatedDate: Date | undefined;
@@ -1147,11 +1266,13 @@ export interface GetPolicyStoreOutput {
1147
1266
  */
1148
1267
  export interface GetPolicyTemplateInput {
1149
1268
  /**
1269
+ * @public
1150
1270
  * <p>Specifies the ID of the policy store that contains the policy template that you want information
1151
1271
  * about.</p>
1152
1272
  */
1153
1273
  policyStoreId: string | undefined;
1154
1274
  /**
1275
+ * @public
1155
1276
  * <p>Specifies the ID of the policy template that you want information about.</p>
1156
1277
  */
1157
1278
  policyTemplateId: string | undefined;
@@ -1161,26 +1282,32 @@ export interface GetPolicyTemplateInput {
1161
1282
  */
1162
1283
  export interface GetPolicyTemplateOutput {
1163
1284
  /**
1285
+ * @public
1164
1286
  * <p>The ID of the policy store that contains the policy template.</p>
1165
1287
  */
1166
1288
  policyStoreId: string | undefined;
1167
1289
  /**
1290
+ * @public
1168
1291
  * <p>The ID of the policy template.</p>
1169
1292
  */
1170
1293
  policyTemplateId: string | undefined;
1171
1294
  /**
1295
+ * @public
1172
1296
  * <p>The description of the policy template.</p>
1173
1297
  */
1174
1298
  description?: string;
1175
1299
  /**
1300
+ * @public
1176
1301
  * <p>The content of the body of the policy template written in the Cedar policy language.</p>
1177
1302
  */
1178
1303
  statement: string | undefined;
1179
1304
  /**
1305
+ * @public
1180
1306
  * <p>The date and time that the policy template was originally created.</p>
1181
1307
  */
1182
1308
  createdDate: Date | undefined;
1183
1309
  /**
1310
+ * @public
1184
1311
  * <p>The date and time that the policy template was most recently updated.</p>
1185
1312
  */
1186
1313
  lastUpdatedDate: Date | undefined;
@@ -1190,6 +1317,7 @@ export interface GetPolicyTemplateOutput {
1190
1317
  */
1191
1318
  export interface GetSchemaInput {
1192
1319
  /**
1320
+ * @public
1193
1321
  * <p>Specifies the ID of the policy store that contains the schema.</p>
1194
1322
  */
1195
1323
  policyStoreId: string | undefined;
@@ -1199,18 +1327,22 @@ export interface GetSchemaInput {
1199
1327
  */
1200
1328
  export interface GetSchemaOutput {
1201
1329
  /**
1330
+ * @public
1202
1331
  * <p>The ID of the policy store that contains the schema.</p>
1203
1332
  */
1204
1333
  policyStoreId: string | undefined;
1205
1334
  /**
1335
+ * @public
1206
1336
  * <p>The body of the schema, written in Cedar schema JSON.</p>
1207
1337
  */
1208
1338
  schema: string | undefined;
1209
1339
  /**
1340
+ * @public
1210
1341
  * <p>The date and time that the schema was originally created.</p>
1211
1342
  */
1212
1343
  createdDate: Date | undefined;
1213
1344
  /**
1345
+ * @public
1214
1346
  * <p>The date and time that the schema was most recently updated.</p>
1215
1347
  */
1216
1348
  lastUpdatedDate: Date | undefined;
@@ -1224,6 +1356,7 @@ export interface GetSchemaOutput {
1224
1356
  */
1225
1357
  export interface IdentitySourceFilter {
1226
1358
  /**
1359
+ * @public
1227
1360
  * <p>The Cedar entity type of the principals returned by the identity provider (IdP)
1228
1361
  * associated with this identity source.</p>
1229
1362
  */
@@ -1234,10 +1367,12 @@ export interface IdentitySourceFilter {
1234
1367
  */
1235
1368
  export interface ListIdentitySourcesInput {
1236
1369
  /**
1370
+ * @public
1237
1371
  * <p>Specifies the ID of the policy store that contains the identity sources that you want to list.</p>
1238
1372
  */
1239
1373
  policyStoreId: string | undefined;
1240
1374
  /**
1375
+ * @public
1241
1376
  * <p>Specifies that you want to receive the next page of results. Valid
1242
1377
  * only if you received a <code>NextToken</code> response in the previous request. If you
1243
1378
  * did, it indicates that more output is available. Set this parameter to the value
@@ -1246,6 +1381,7 @@ export interface ListIdentitySourcesInput {
1246
1381
  */
1247
1382
  nextToken?: string;
1248
1383
  /**
1384
+ * @public
1249
1385
  * <p>Specifies the total number of results that you want included on each page
1250
1386
  * of the response. If you do not include this parameter, it defaults to a value that is
1251
1387
  * specific to the operation. If additional items exist beyond the number you specify, the
@@ -1258,6 +1394,7 @@ export interface ListIdentitySourcesInput {
1258
1394
  */
1259
1395
  maxResults?: number;
1260
1396
  /**
1397
+ * @public
1261
1398
  * <p>Specifies characteristics of an identity source that you can use to limit the output to matching
1262
1399
  * identity sources.</p>
1263
1400
  */
@@ -1271,15 +1408,18 @@ export interface ListIdentitySourcesInput {
1271
1408
  */
1272
1409
  export interface IdentitySourceItemDetails {
1273
1410
  /**
1411
+ * @public
1274
1412
  * <p>The application client IDs associated with the specified Amazon Cognito user pool that are
1275
1413
  * enabled for this identity source.</p>
1276
1414
  */
1277
1415
  clientIds?: string[];
1278
1416
  /**
1417
+ * @public
1279
1418
  * <p>The Amazon Cognito user pool whose identities are accessible to this Verified Permissions policy store.</p>
1280
1419
  */
1281
1420
  userPoolArn?: string;
1282
1421
  /**
1422
+ * @public
1283
1423
  * <p>The well-known URL that points to this user pool's OIDC discovery endpoint. This is a
1284
1424
  * URL string in the following format. This URL replaces the placeholders for both the
1285
1425
  * Amazon Web Services Region and the user pool identifier with those appropriate for this user
@@ -1290,6 +1430,7 @@ export interface IdentitySourceItemDetails {
1290
1430
  */
1291
1431
  discoveryUrl?: string;
1292
1432
  /**
1433
+ * @public
1293
1434
  * <p>A string that identifies the type of OIDC service represented by this identity source. </p>
1294
1435
  * <p>At this time, the only valid value is <code>cognito</code>.</p>
1295
1436
  */
@@ -1303,27 +1444,33 @@ export interface IdentitySourceItemDetails {
1303
1444
  */
1304
1445
  export interface IdentitySourceItem {
1305
1446
  /**
1447
+ * @public
1306
1448
  * <p>The date and time the identity source was originally created.</p>
1307
1449
  */
1308
1450
  createdDate: Date | undefined;
1309
1451
  /**
1452
+ * @public
1310
1453
  * <p>A structure that contains the details of the associated identity provider
1311
1454
  * (IdP).</p>
1312
1455
  */
1313
1456
  details: IdentitySourceItemDetails | undefined;
1314
1457
  /**
1458
+ * @public
1315
1459
  * <p>The unique identifier of the identity source.</p>
1316
1460
  */
1317
1461
  identitySourceId: string | undefined;
1318
1462
  /**
1463
+ * @public
1319
1464
  * <p>The date and time the identity source was most recently updated.</p>
1320
1465
  */
1321
1466
  lastUpdatedDate: Date | undefined;
1322
1467
  /**
1468
+ * @public
1323
1469
  * <p>The identifier of the policy store that contains the identity source.</p>
1324
1470
  */
1325
1471
  policyStoreId: string | undefined;
1326
1472
  /**
1473
+ * @public
1327
1474
  * <p>The Cedar entity type of the principals returned from the IdP associated with this
1328
1475
  * identity source.</p>
1329
1476
  */
@@ -1334,6 +1481,7 @@ export interface IdentitySourceItem {
1334
1481
  */
1335
1482
  export interface ListIdentitySourcesOutput {
1336
1483
  /**
1484
+ * @public
1337
1485
  * <p>If present, this value indicates that more output is available than
1338
1486
  * is included in the current response. Use this value in the <code>NextToken</code>
1339
1487
  * request parameter in a subsequent call to the operation to get the next part of the
@@ -1342,6 +1490,7 @@ export interface ListIdentitySourcesOutput {
1342
1490
  */
1343
1491
  nextToken?: string;
1344
1492
  /**
1493
+ * @public
1345
1494
  * <p>The list of identity sources stored in the specified policy store.</p>
1346
1495
  */
1347
1496
  identitySources: IdentitySourceItem[] | undefined;
@@ -1352,10 +1501,12 @@ export interface ListIdentitySourcesOutput {
1352
1501
  */
1353
1502
  export interface UpdateCognitoUserPoolConfiguration {
1354
1503
  /**
1504
+ * @public
1355
1505
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the Amazon Cognito user pool associated with this identity source.</p>
1356
1506
  */
1357
1507
  userPoolArn: string | undefined;
1358
1508
  /**
1509
+ * @public
1359
1510
  * <p>The client ID of an app client that is configured for the specified Amazon Cognito user
1360
1511
  * pool.</p>
1361
1512
  */
@@ -1378,12 +1529,16 @@ export type UpdateConfiguration = UpdateConfiguration.CognitoUserPoolConfigurati
1378
1529
  */
1379
1530
  export declare namespace UpdateConfiguration {
1380
1531
  /**
1532
+ * @public
1381
1533
  * <p>Contains configuration details of a Amazon Cognito user pool.</p>
1382
1534
  */
1383
1535
  interface CognitoUserPoolConfigurationMember {
1384
1536
  cognitoUserPoolConfiguration: UpdateCognitoUserPoolConfiguration;
1385
1537
  $unknown?: never;
1386
1538
  }
1539
+ /**
1540
+ * @public
1541
+ */
1387
1542
  interface $UnknownMember {
1388
1543
  cognitoUserPoolConfiguration?: never;
1389
1544
  $unknown: [string, any];
@@ -1399,14 +1554,17 @@ export declare namespace UpdateConfiguration {
1399
1554
  */
1400
1555
  export interface UpdateIdentitySourceInput {
1401
1556
  /**
1557
+ * @public
1402
1558
  * <p>Specifies the ID of the policy store that contains the identity source that you want to update.</p>
1403
1559
  */
1404
1560
  policyStoreId: string | undefined;
1405
1561
  /**
1562
+ * @public
1406
1563
  * <p>Specifies the ID of the identity source that you want to update.</p>
1407
1564
  */
1408
1565
  identitySourceId: string | undefined;
1409
1566
  /**
1567
+ * @public
1410
1568
  * <p>Specifies the details required to communicate with the identity provider (IdP)
1411
1569
  * associated with this identity source.</p>
1412
1570
  * <note>
@@ -1418,6 +1576,7 @@ export interface UpdateIdentitySourceInput {
1418
1576
  */
1419
1577
  updateConfiguration: UpdateConfiguration | undefined;
1420
1578
  /**
1579
+ * @public
1421
1580
  * <p>Specifies the data type of principals generated for identities authenticated by the
1422
1581
  * identity source.</p>
1423
1582
  */
@@ -1428,18 +1587,22 @@ export interface UpdateIdentitySourceInput {
1428
1587
  */
1429
1588
  export interface UpdateIdentitySourceOutput {
1430
1589
  /**
1590
+ * @public
1431
1591
  * <p>The date and time that the updated identity source was originally created.</p>
1432
1592
  */
1433
1593
  createdDate: Date | undefined;
1434
1594
  /**
1595
+ * @public
1435
1596
  * <p>The ID of the updated identity source.</p>
1436
1597
  */
1437
1598
  identitySourceId: string | undefined;
1438
1599
  /**
1600
+ * @public
1439
1601
  * <p>The date and time that the identity source was most recently updated.</p>
1440
1602
  */
1441
1603
  lastUpdatedDate: Date | undefined;
1442
1604
  /**
1605
+ * @public
1443
1606
  * <p>The ID of the policy store that contains the updated identity source.</p>
1444
1607
  */
1445
1608
  policyStoreId: string | undefined;
@@ -1449,11 +1612,13 @@ export interface UpdateIdentitySourceOutput {
1449
1612
  */
1450
1613
  export interface IsAuthorizedOutput {
1451
1614
  /**
1615
+ * @public
1452
1616
  * <p>An authorization decision that indicates if the authorization request should be
1453
1617
  * allowed or denied.</p>
1454
1618
  */
1455
1619
  decision: Decision | string | undefined;
1456
1620
  /**
1621
+ * @public
1457
1622
  * <p>The list of determining policies used to make the authorization decision. For example,
1458
1623
  * if there are two matching policies, where one is a forbid and the other is a permit,
1459
1624
  * then the forbid policy will be the determining policy. In the case of multiple matching
@@ -1463,6 +1628,7 @@ export interface IsAuthorizedOutput {
1463
1628
  */
1464
1629
  determiningPolicies: DeterminingPolicyItem[] | undefined;
1465
1630
  /**
1631
+ * @public
1466
1632
  * <p>Errors that occurred while making an authorization decision, for example, a policy
1467
1633
  * references an Entity or entity Attribute that does not exist in the slice.</p>
1468
1634
  */
@@ -1473,11 +1639,13 @@ export interface IsAuthorizedOutput {
1473
1639
  */
1474
1640
  export interface IsAuthorizedWithTokenOutput {
1475
1641
  /**
1642
+ * @public
1476
1643
  * <p>An authorization decision that indicates if the authorization request should be
1477
1644
  * allowed or denied.</p>
1478
1645
  */
1479
1646
  decision: Decision | string | undefined;
1480
1647
  /**
1648
+ * @public
1481
1649
  * <p>The list of determining policies used to make the authorization decision. For example,
1482
1650
  * if there are multiple matching policies, where at least one is a forbid policy, then
1483
1651
  * because forbid always overrides permit the forbid policies are the determining policies.
@@ -1487,6 +1655,7 @@ export interface IsAuthorizedWithTokenOutput {
1487
1655
  */
1488
1656
  determiningPolicies: DeterminingPolicyItem[] | undefined;
1489
1657
  /**
1658
+ * @public
1490
1659
  * <p>Errors that occurred while making an authorization decision. For example, a policy
1491
1660
  * references an entity or entity attribute that does not exist in the slice.</p>
1492
1661
  */
@@ -1499,18 +1668,22 @@ export interface IsAuthorizedWithTokenOutput {
1499
1668
  */
1500
1669
  export interface PolicyFilter {
1501
1670
  /**
1671
+ * @public
1502
1672
  * <p>Filters the output to only policies that reference the specified principal.</p>
1503
1673
  */
1504
1674
  principal?: EntityReference;
1505
1675
  /**
1676
+ * @public
1506
1677
  * <p>Filters the output to only policies that reference the specified resource.</p>
1507
1678
  */
1508
1679
  resource?: EntityReference;
1509
1680
  /**
1681
+ * @public
1510
1682
  * <p>Filters the output to only policies of the specified type.</p>
1511
1683
  */
1512
1684
  policyType?: PolicyType | string;
1513
1685
  /**
1686
+ * @public
1514
1687
  * <p>Filters the output to only template-linked policies that were instantiated from the specified
1515
1688
  * policy template.</p>
1516
1689
  */
@@ -1521,10 +1694,12 @@ export interface PolicyFilter {
1521
1694
  */
1522
1695
  export interface ListPoliciesInput {
1523
1696
  /**
1697
+ * @public
1524
1698
  * <p>Specifies the ID of the policy store you want to list policies from.</p>
1525
1699
  */
1526
1700
  policyStoreId: string | undefined;
1527
1701
  /**
1702
+ * @public
1528
1703
  * <p>Specifies that you want to receive the next page of results. Valid
1529
1704
  * only if you received a <code>NextToken</code> response in the previous request. If you
1530
1705
  * did, it indicates that more output is available. Set this parameter to the value
@@ -1533,6 +1708,7 @@ export interface ListPoliciesInput {
1533
1708
  */
1534
1709
  nextToken?: string;
1535
1710
  /**
1711
+ * @public
1536
1712
  * <p>Specifies the total number of results that you want included on each page
1537
1713
  * of the response. If you do not include this parameter, it defaults to a value that is
1538
1714
  * specific to the operation. If additional items exist beyond the number you specify, the
@@ -1545,6 +1721,7 @@ export interface ListPoliciesInput {
1545
1721
  */
1546
1722
  maxResults?: number;
1547
1723
  /**
1724
+ * @public
1548
1725
  * <p>Specifies a filter that limits the response to only policies that match the specified
1549
1726
  * criteria. For example, you list only the policies that reference a specified
1550
1727
  * principal.</p>
@@ -1560,6 +1737,7 @@ export interface ListPoliciesInput {
1560
1737
  */
1561
1738
  export interface StaticPolicyDefinitionItem {
1562
1739
  /**
1740
+ * @public
1563
1741
  * <p>A description of the static policy.</p>
1564
1742
  */
1565
1743
  description?: string;
@@ -1571,16 +1749,19 @@ export interface StaticPolicyDefinitionItem {
1571
1749
  */
1572
1750
  export interface TemplateLinkedPolicyDefinitionItem {
1573
1751
  /**
1752
+ * @public
1574
1753
  * <p>The unique identifier of the policy template used to create this policy.</p>
1575
1754
  */
1576
1755
  policyTemplateId: string | undefined;
1577
1756
  /**
1757
+ * @public
1578
1758
  * <p>The principal associated with this template-linked policy. Verified Permissions substitutes this principal for the
1579
1759
  * <code>?principal</code> placeholder in the policy template when it evaluates an authorization
1580
1760
  * request.</p>
1581
1761
  */
1582
1762
  principal?: EntityIdentifier;
1583
1763
  /**
1764
+ * @public
1584
1765
  * <p>The resource associated with this template-linked policy. Verified Permissions substitutes this resource for the
1585
1766
  * <code>?resource</code> placeholder in the policy template when it evaluates an authorization
1586
1767
  * request.</p>
@@ -1601,6 +1782,7 @@ export type PolicyDefinitionItem = PolicyDefinitionItem.StaticMember | PolicyDef
1601
1782
  */
1602
1783
  export declare namespace PolicyDefinitionItem {
1603
1784
  /**
1785
+ * @public
1604
1786
  * <p>Information about a static policy that wasn't created with a policy template.</p>
1605
1787
  */
1606
1788
  interface StaticMember {
@@ -1609,6 +1791,7 @@ export declare namespace PolicyDefinitionItem {
1609
1791
  $unknown?: never;
1610
1792
  }
1611
1793
  /**
1794
+ * @public
1612
1795
  * <p>Information about a template-linked policy that was created by instantiating a policy template.</p>
1613
1796
  */
1614
1797
  interface TemplateLinkedMember {
@@ -1616,6 +1799,9 @@ export declare namespace PolicyDefinitionItem {
1616
1799
  templateLinked: TemplateLinkedPolicyDefinitionItem;
1617
1800
  $unknown?: never;
1618
1801
  }
1802
+ /**
1803
+ * @public
1804
+ */
1619
1805
  interface $UnknownMember {
1620
1806
  static?: never;
1621
1807
  templateLinked?: never;
@@ -1635,15 +1821,18 @@ export declare namespace PolicyDefinitionItem {
1635
1821
  */
1636
1822
  export interface PolicyItem {
1637
1823
  /**
1824
+ * @public
1638
1825
  * <p>The identifier of the PolicyStore where the policy you want information about is
1639
1826
  * stored.</p>
1640
1827
  */
1641
1828
  policyStoreId: string | undefined;
1642
1829
  /**
1830
+ * @public
1643
1831
  * <p>The identifier of the policy you want information about.</p>
1644
1832
  */
1645
1833
  policyId: string | undefined;
1646
1834
  /**
1835
+ * @public
1647
1836
  * <p>The type of the policy. This is one of the following values:</p>
1648
1837
  * <ul>
1649
1838
  * <li>
@@ -1660,22 +1849,27 @@ export interface PolicyItem {
1660
1849
  */
1661
1850
  policyType: PolicyType | string | undefined;
1662
1851
  /**
1852
+ * @public
1663
1853
  * <p>The principal associated with the policy.</p>
1664
1854
  */
1665
1855
  principal?: EntityIdentifier;
1666
1856
  /**
1857
+ * @public
1667
1858
  * <p>The resource associated with the policy.</p>
1668
1859
  */
1669
1860
  resource?: EntityIdentifier;
1670
1861
  /**
1862
+ * @public
1671
1863
  * <p>The policy definition of an item in the list of policies returned.</p>
1672
1864
  */
1673
1865
  definition: PolicyDefinitionItem | undefined;
1674
1866
  /**
1867
+ * @public
1675
1868
  * <p>The date and time the policy was created.</p>
1676
1869
  */
1677
1870
  createdDate: Date | undefined;
1678
1871
  /**
1872
+ * @public
1679
1873
  * <p>The date and time the policy was most recently updated.</p>
1680
1874
  */
1681
1875
  lastUpdatedDate: Date | undefined;
@@ -1685,6 +1879,7 @@ export interface PolicyItem {
1685
1879
  */
1686
1880
  export interface ListPoliciesOutput {
1687
1881
  /**
1882
+ * @public
1688
1883
  * <p>If present, this value indicates that more output is available than
1689
1884
  * is included in the current response. Use this value in the <code>NextToken</code>
1690
1885
  * request parameter in a subsequent call to the operation to get the next part of the
@@ -1693,6 +1888,7 @@ export interface ListPoliciesOutput {
1693
1888
  */
1694
1889
  nextToken?: string;
1695
1890
  /**
1891
+ * @public
1696
1892
  * <p>Lists all policies that are available in the specified policy store.</p>
1697
1893
  */
1698
1894
  policies: PolicyItem[] | undefined;
@@ -1702,6 +1898,7 @@ export interface ListPoliciesOutput {
1702
1898
  */
1703
1899
  export interface ListPolicyStoresInput {
1704
1900
  /**
1901
+ * @public
1705
1902
  * <p>Specifies that you want to receive the next page of results. Valid
1706
1903
  * only if you received a <code>NextToken</code> response in the previous request. If you
1707
1904
  * did, it indicates that more output is available. Set this parameter to the value
@@ -1710,6 +1907,7 @@ export interface ListPolicyStoresInput {
1710
1907
  */
1711
1908
  nextToken?: string;
1712
1909
  /**
1910
+ * @public
1713
1911
  * <p>Specifies the total number of results that you want included on each page
1714
1912
  * of the response. If you do not include this parameter, it defaults to a value that is
1715
1913
  * specific to the operation. If additional items exist beyond the number you specify, the
@@ -1730,14 +1928,17 @@ export interface ListPolicyStoresInput {
1730
1928
  */
1731
1929
  export interface PolicyStoreItem {
1732
1930
  /**
1931
+ * @public
1733
1932
  * <p>The unique identifier of the policy store.</p>
1734
1933
  */
1735
1934
  policyStoreId: string | undefined;
1736
1935
  /**
1936
+ * @public
1737
1937
  * <p>The Amazon Resource Name (ARN) of the policy store.</p>
1738
1938
  */
1739
1939
  arn: string | undefined;
1740
1940
  /**
1941
+ * @public
1741
1942
  * <p>The date and time the policy was created.</p>
1742
1943
  */
1743
1944
  createdDate: Date | undefined;
@@ -1747,6 +1948,7 @@ export interface PolicyStoreItem {
1747
1948
  */
1748
1949
  export interface ListPolicyStoresOutput {
1749
1950
  /**
1951
+ * @public
1750
1952
  * <p>If present, this value indicates that more output is available than
1751
1953
  * is included in the current response. Use this value in the <code>NextToken</code>
1752
1954
  * request parameter in a subsequent call to the operation to get the next part of the
@@ -1755,6 +1957,7 @@ export interface ListPolicyStoresOutput {
1755
1957
  */
1756
1958
  nextToken?: string;
1757
1959
  /**
1960
+ * @public
1758
1961
  * <p>The list of policy stores in the account.</p>
1759
1962
  */
1760
1963
  policyStores: PolicyStoreItem[] | undefined;
@@ -1764,10 +1967,12 @@ export interface ListPolicyStoresOutput {
1764
1967
  */
1765
1968
  export interface ListPolicyTemplatesInput {
1766
1969
  /**
1970
+ * @public
1767
1971
  * <p>Specifies the ID of the policy store that contains the policy templates you want to list.</p>
1768
1972
  */
1769
1973
  policyStoreId: string | undefined;
1770
1974
  /**
1975
+ * @public
1771
1976
  * <p>Specifies that you want to receive the next page of results. Valid
1772
1977
  * only if you received a <code>NextToken</code> response in the previous request. If you
1773
1978
  * did, it indicates that more output is available. Set this parameter to the value
@@ -1776,6 +1981,7 @@ export interface ListPolicyTemplatesInput {
1776
1981
  */
1777
1982
  nextToken?: string;
1778
1983
  /**
1984
+ * @public
1779
1985
  * <p>Specifies the total number of results that you want included on each page
1780
1986
  * of the response. If you do not include this parameter, it defaults to a value that is
1781
1987
  * specific to the operation. If additional items exist beyond the number you specify, the
@@ -1796,22 +2002,27 @@ export interface ListPolicyTemplatesInput {
1796
2002
  */
1797
2003
  export interface PolicyTemplateItem {
1798
2004
  /**
2005
+ * @public
1799
2006
  * <p>The unique identifier of the policy store that contains the template.</p>
1800
2007
  */
1801
2008
  policyStoreId: string | undefined;
1802
2009
  /**
2010
+ * @public
1803
2011
  * <p>The unique identifier of the policy template.</p>
1804
2012
  */
1805
2013
  policyTemplateId: string | undefined;
1806
2014
  /**
2015
+ * @public
1807
2016
  * <p>The description attached to the policy template.</p>
1808
2017
  */
1809
2018
  description?: string;
1810
2019
  /**
2020
+ * @public
1811
2021
  * <p>The date and time that the policy template was created.</p>
1812
2022
  */
1813
2023
  createdDate: Date | undefined;
1814
2024
  /**
2025
+ * @public
1815
2026
  * <p>The date and time that the policy template was most recently updated.</p>
1816
2027
  */
1817
2028
  lastUpdatedDate: Date | undefined;
@@ -1821,6 +2032,7 @@ export interface PolicyTemplateItem {
1821
2032
  */
1822
2033
  export interface ListPolicyTemplatesOutput {
1823
2034
  /**
2035
+ * @public
1824
2036
  * <p>If present, this value indicates that more output is available than
1825
2037
  * is included in the current response. Use this value in the <code>NextToken</code>
1826
2038
  * request parameter in a subsequent call to the operation to get the next part of the
@@ -1829,6 +2041,7 @@ export interface ListPolicyTemplatesOutput {
1829
2041
  */
1830
2042
  nextToken?: string;
1831
2043
  /**
2044
+ * @public
1832
2045
  * <p>The list of the policy templates in the specified policy store.</p>
1833
2046
  */
1834
2047
  policyTemplates: PolicyTemplateItem[] | undefined;
@@ -1839,10 +2052,12 @@ export interface ListPolicyTemplatesOutput {
1839
2052
  */
1840
2053
  export interface UpdateStaticPolicyDefinition {
1841
2054
  /**
2055
+ * @public
1842
2056
  * <p>Specifies the description to be added to or replaced on the static policy.</p>
1843
2057
  */
1844
2058
  description?: string;
1845
2059
  /**
2060
+ * @public
1846
2061
  * <p>Specifies the Cedar policy language text to be added to or replaced on the static policy.</p>
1847
2062
  * <important>
1848
2063
  * <p>You can change only the following elements from the original content:</p>
@@ -1887,12 +2102,16 @@ export type UpdatePolicyDefinition = UpdatePolicyDefinition.StaticMember | Updat
1887
2102
  */
1888
2103
  export declare namespace UpdatePolicyDefinition {
1889
2104
  /**
2105
+ * @public
1890
2106
  * <p>Contains details about the updates to be applied to a static policy.</p>
1891
2107
  */
1892
2108
  interface StaticMember {
1893
2109
  static: UpdateStaticPolicyDefinition;
1894
2110
  $unknown?: never;
1895
2111
  }
2112
+ /**
2113
+ * @public
2114
+ */
1896
2115
  interface $UnknownMember {
1897
2116
  static?: never;
1898
2117
  $unknown: [string, any];
@@ -1908,15 +2127,18 @@ export declare namespace UpdatePolicyDefinition {
1908
2127
  */
1909
2128
  export interface UpdatePolicyInput {
1910
2129
  /**
2130
+ * @public
1911
2131
  * <p>Specifies the ID of the policy store that contains the policy that you want to update.</p>
1912
2132
  */
1913
2133
  policyStoreId: string | undefined;
1914
2134
  /**
2135
+ * @public
1915
2136
  * <p>Specifies the ID of the policy that you want to update. To find this value, you can
1916
2137
  * use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicies.html">ListPolicies</a>.</p>
1917
2138
  */
1918
2139
  policyId: string | undefined;
1919
2140
  /**
2141
+ * @public
1920
2142
  * <p>Specifies the updated policy content that you want to replace on the specified policy.
1921
2143
  * The content must be valid Cedar policy language text.</p>
1922
2144
  * <p>You can change only the following elements from the policy definition:</p>
@@ -1953,32 +2175,39 @@ export interface UpdatePolicyInput {
1953
2175
  */
1954
2176
  export interface UpdatePolicyOutput {
1955
2177
  /**
2178
+ * @public
1956
2179
  * <p>The ID of the policy store that contains the policy that was updated.</p>
1957
2180
  */
1958
2181
  policyStoreId: string | undefined;
1959
2182
  /**
2183
+ * @public
1960
2184
  * <p>The ID of the policy that was updated.</p>
1961
2185
  */
1962
2186
  policyId: string | undefined;
1963
2187
  /**
2188
+ * @public
1964
2189
  * <p>The type of the policy that was updated.</p>
1965
2190
  */
1966
2191
  policyType: PolicyType | string | undefined;
1967
2192
  /**
2193
+ * @public
1968
2194
  * <p>The principal specified in the policy's scope. This element isn't included in the
1969
2195
  * response when <code>Principal</code> isn't present in the policy content.</p>
1970
2196
  */
1971
2197
  principal?: EntityIdentifier;
1972
2198
  /**
2199
+ * @public
1973
2200
  * <p>The resource specified in the policy's scope. This element isn't included in the
1974
2201
  * response when <code>Resource</code> isn't present in the policy content.</p>
1975
2202
  */
1976
2203
  resource?: EntityIdentifier;
1977
2204
  /**
2205
+ * @public
1978
2206
  * <p>The date and time that the policy was originally created.</p>
1979
2207
  */
1980
2208
  createdDate: Date | undefined;
1981
2209
  /**
2210
+ * @public
1982
2211
  * <p>The date and time that the policy was most recently updated.</p>
1983
2212
  */
1984
2213
  lastUpdatedDate: Date | undefined;
@@ -1988,18 +2217,22 @@ export interface UpdatePolicyOutput {
1988
2217
  */
1989
2218
  export interface UpdatePolicyTemplateInput {
1990
2219
  /**
2220
+ * @public
1991
2221
  * <p>Specifies the ID of the policy store that contains the policy template that you want to update.</p>
1992
2222
  */
1993
2223
  policyStoreId: string | undefined;
1994
2224
  /**
2225
+ * @public
1995
2226
  * <p>Specifies the ID of the policy template that you want to update.</p>
1996
2227
  */
1997
2228
  policyTemplateId: string | undefined;
1998
2229
  /**
2230
+ * @public
1999
2231
  * <p>Specifies a new description to apply to the policy template.</p>
2000
2232
  */
2001
2233
  description?: string;
2002
2234
  /**
2235
+ * @public
2003
2236
  * <p>Specifies new statement content written in Cedar policy language to replace the
2004
2237
  * current body of the policy template.</p>
2005
2238
  * <p>You can change only the following elements of the policy body:</p>
@@ -2032,18 +2265,22 @@ export interface UpdatePolicyTemplateInput {
2032
2265
  */
2033
2266
  export interface UpdatePolicyTemplateOutput {
2034
2267
  /**
2268
+ * @public
2035
2269
  * <p>The ID of the policy store that contains the updated policy template.</p>
2036
2270
  */
2037
2271
  policyStoreId: string | undefined;
2038
2272
  /**
2273
+ * @public
2039
2274
  * <p>The ID of the updated policy template.</p>
2040
2275
  */
2041
2276
  policyTemplateId: string | undefined;
2042
2277
  /**
2278
+ * @public
2043
2279
  * <p>The date and time that the policy template was originally created.</p>
2044
2280
  */
2045
2281
  createdDate: Date | undefined;
2046
2282
  /**
2283
+ * @public
2047
2284
  * <p>The date and time that the policy template was most recently updated.</p>
2048
2285
  */
2049
2286
  lastUpdatedDate: Date | undefined;
@@ -2061,6 +2298,7 @@ export type SchemaDefinition = SchemaDefinition.CedarJsonMember | SchemaDefiniti
2061
2298
  */
2062
2299
  export declare namespace SchemaDefinition {
2063
2300
  /**
2301
+ * @public
2064
2302
  * <p>A JSON string representation of the schema supported by applications that use this
2065
2303
  * policy store. For more information, see <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/userguide/schema.html">Policy store schema</a> in the
2066
2304
  * <i>Amazon Verified Permissions User Guide</i>.</p>
@@ -2069,6 +2307,9 @@ export declare namespace SchemaDefinition {
2069
2307
  cedarJson: string;
2070
2308
  $unknown?: never;
2071
2309
  }
2310
+ /**
2311
+ * @public
2312
+ */
2072
2313
  interface $UnknownMember {
2073
2314
  cedarJson?: never;
2074
2315
  $unknown: [string, any];
@@ -2084,10 +2325,12 @@ export declare namespace SchemaDefinition {
2084
2325
  */
2085
2326
  export interface PutSchemaInput {
2086
2327
  /**
2328
+ * @public
2087
2329
  * <p>Specifies the ID of the policy store in which to place the schema.</p>
2088
2330
  */
2089
2331
  policyStoreId: string | undefined;
2090
2332
  /**
2333
+ * @public
2091
2334
  * <p>Specifies the definition of the schema to be stored. The schema definition must be
2092
2335
  * written in Cedar schema JSON.</p>
2093
2336
  */
@@ -2098,18 +2341,22 @@ export interface PutSchemaInput {
2098
2341
  */
2099
2342
  export interface PutSchemaOutput {
2100
2343
  /**
2344
+ * @public
2101
2345
  * <p>The unique ID of the policy store that contains the schema.</p>
2102
2346
  */
2103
2347
  policyStoreId: string | undefined;
2104
2348
  /**
2349
+ * @public
2105
2350
  * <p>Identifies the namespaces of the entities referenced by this schema.</p>
2106
2351
  */
2107
2352
  namespaces: string[] | undefined;
2108
2353
  /**
2354
+ * @public
2109
2355
  * <p>The date and time that the schema was originally created.</p>
2110
2356
  */
2111
2357
  createdDate: Date | undefined;
2112
2358
  /**
2359
+ * @public
2113
2360
  * <p>The date and time that the schema was last updated.</p>
2114
2361
  */
2115
2362
  lastUpdatedDate: Date | undefined;
@@ -2119,10 +2366,12 @@ export interface PutSchemaOutput {
2119
2366
  */
2120
2367
  export interface UpdatePolicyStoreInput {
2121
2368
  /**
2369
+ * @public
2122
2370
  * <p>Specifies the ID of the policy store that you want to update</p>
2123
2371
  */
2124
2372
  policyStoreId: string | undefined;
2125
2373
  /**
2374
+ * @public
2126
2375
  * <p>A structure that defines the validation settings that want to enable for the
2127
2376
  * policy store.</p>
2128
2377
  */
@@ -2133,18 +2382,22 @@ export interface UpdatePolicyStoreInput {
2133
2382
  */
2134
2383
  export interface UpdatePolicyStoreOutput {
2135
2384
  /**
2385
+ * @public
2136
2386
  * <p>The ID of the updated policy store.</p>
2137
2387
  */
2138
2388
  policyStoreId: string | undefined;
2139
2389
  /**
2390
+ * @public
2140
2391
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the updated policy store.</p>
2141
2392
  */
2142
2393
  arn: string | undefined;
2143
2394
  /**
2395
+ * @public
2144
2396
  * <p>The date and time that the policy store was originally created.</p>
2145
2397
  */
2146
2398
  createdDate: Date | undefined;
2147
2399
  /**
2400
+ * @public
2148
2401
  * <p>The date and time that the policy store was most recently updated.</p>
2149
2402
  */
2150
2403
  lastUpdatedDate: Date | undefined;
@@ -2163,6 +2416,7 @@ export type AttributeValue = AttributeValue.BooleanMember | AttributeValue.Entit
2163
2416
  */
2164
2417
  export declare namespace AttributeValue {
2165
2418
  /**
2419
+ * @public
2166
2420
  * <p>An attribute value of <a href="https://docs.cedarpolicy.com/syntax-datatypes.html#boolean">Boolean</a> type.</p>
2167
2421
  * <p>Example: <code>\{"boolean": true\}</code>
2168
2422
  * </p>
@@ -2177,6 +2431,7 @@ export declare namespace AttributeValue {
2177
2431
  $unknown?: never;
2178
2432
  }
2179
2433
  /**
2434
+ * @public
2180
2435
  * <p>An attribute value of type <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_EntityIdentifier.html">EntityIdentifier</a>.</p>
2181
2436
  * <p>Example: <code>"entityIdentifier": \{ "entityId": "&lt;id&gt;", "entityType":
2182
2437
  * "&lt;entity type&gt;"\}</code>
@@ -2192,6 +2447,7 @@ export declare namespace AttributeValue {
2192
2447
  $unknown?: never;
2193
2448
  }
2194
2449
  /**
2450
+ * @public
2195
2451
  * <p>An attribute value of <a href="https://docs.cedarpolicy.com/syntax-datatypes.html#long">Long</a> type.</p>
2196
2452
  * <p>Example: <code>\{"long": 0\}</code>
2197
2453
  * </p>
@@ -2206,6 +2462,7 @@ export declare namespace AttributeValue {
2206
2462
  $unknown?: never;
2207
2463
  }
2208
2464
  /**
2465
+ * @public
2209
2466
  * <p>An attribute value of <a href="https://docs.cedarpolicy.com/syntax-datatypes.html#string">String</a> type.</p>
2210
2467
  * <p>Example: <code>\{"string": "abc"\}</code>
2211
2468
  * </p>
@@ -2220,6 +2477,7 @@ export declare namespace AttributeValue {
2220
2477
  $unknown?: never;
2221
2478
  }
2222
2479
  /**
2480
+ * @public
2223
2481
  * <p>An attribute value of <a href="https://docs.cedarpolicy.com/syntax-datatypes.html#set">Set</a> type.</p>
2224
2482
  * <p>Example: <code>\{"set": [ \{\} ] \}</code>
2225
2483
  * </p>
@@ -2234,6 +2492,7 @@ export declare namespace AttributeValue {
2234
2492
  $unknown?: never;
2235
2493
  }
2236
2494
  /**
2495
+ * @public
2237
2496
  * <p>An attribute value of <a href="https://docs.cedarpolicy.com/syntax-datatypes.html#record">Record</a> type.</p>
2238
2497
  * <p>Example: <code>\{"record": \{ "keyName": \{\} \} \}</code>
2239
2498
  * </p>
@@ -2247,6 +2506,9 @@ export declare namespace AttributeValue {
2247
2506
  record: Record<string, AttributeValue>;
2248
2507
  $unknown?: never;
2249
2508
  }
2509
+ /**
2510
+ * @public
2511
+ */
2250
2512
  interface $UnknownMember {
2251
2513
  boolean?: never;
2252
2514
  entityIdentifier?: never;
@@ -2283,6 +2545,7 @@ export type ContextDefinition = ContextDefinition.ContextMapMember | ContextDefi
2283
2545
  */
2284
2546
  export declare namespace ContextDefinition {
2285
2547
  /**
2548
+ * @public
2286
2549
  * <p>An list of attributes that are needed to successfully evaluate an authorization
2287
2550
  * request. Each attribute in this array must include a map of a data type and its
2288
2551
  * value.</p>
@@ -2294,6 +2557,9 @@ export declare namespace ContextDefinition {
2294
2557
  contextMap: Record<string, AttributeValue>;
2295
2558
  $unknown?: never;
2296
2559
  }
2560
+ /**
2561
+ * @public
2562
+ */
2297
2563
  interface $UnknownMember {
2298
2564
  contextMap?: never;
2299
2565
  $unknown: [string, any];
@@ -2318,14 +2584,17 @@ export declare namespace ContextDefinition {
2318
2584
  */
2319
2585
  export interface EntityItem {
2320
2586
  /**
2587
+ * @public
2321
2588
  * <p>The identifier of the entity.</p>
2322
2589
  */
2323
2590
  identifier: EntityIdentifier | undefined;
2324
2591
  /**
2592
+ * @public
2325
2593
  * <p>A list of attributes for the entity.</p>
2326
2594
  */
2327
2595
  attributes?: Record<string, AttributeValue>;
2328
2596
  /**
2597
+ * @public
2329
2598
  * <p>The parents in the hierarchy that contains the entity.</p>
2330
2599
  */
2331
2600
  parents?: EntityIdentifier[];
@@ -2344,6 +2613,7 @@ export type EntitiesDefinition = EntitiesDefinition.EntityListMember | EntitiesD
2344
2613
  */
2345
2614
  export declare namespace EntitiesDefinition {
2346
2615
  /**
2616
+ * @public
2347
2617
  * <p>An array of entities that are needed to successfully evaluate an authorization
2348
2618
  * request. Each entity in this array must include an identifier for the entity, the
2349
2619
  * attributes of the entity, and a list of any parent entities.</p>
@@ -2352,6 +2622,9 @@ export declare namespace EntitiesDefinition {
2352
2622
  entityList: EntityItem[];
2353
2623
  $unknown?: never;
2354
2624
  }
2625
+ /**
2626
+ * @public
2627
+ */
2355
2628
  interface $UnknownMember {
2356
2629
  entityList?: never;
2357
2630
  $unknown: [string, any];
@@ -2367,29 +2640,35 @@ export declare namespace EntitiesDefinition {
2367
2640
  */
2368
2641
  export interface IsAuthorizedInput {
2369
2642
  /**
2643
+ * @public
2370
2644
  * <p>Specifies the ID of the policy store. Policies in this policy store will be used to make an
2371
2645
  * authorization decision for the input.</p>
2372
2646
  */
2373
2647
  policyStoreId: string | undefined;
2374
2648
  /**
2649
+ * @public
2375
2650
  * <p>Specifies the principal for which the authorization decision is to be made.</p>
2376
2651
  */
2377
2652
  principal?: EntityIdentifier;
2378
2653
  /**
2654
+ * @public
2379
2655
  * <p>Specifies the requested action to be authorized. For example, is the principal
2380
2656
  * authorized to perform this action on the resource?</p>
2381
2657
  */
2382
2658
  action?: ActionIdentifier;
2383
2659
  /**
2660
+ * @public
2384
2661
  * <p>Specifies the resource for which the authorization decision is to be made.</p>
2385
2662
  */
2386
2663
  resource?: EntityIdentifier;
2387
2664
  /**
2665
+ * @public
2388
2666
  * <p>Specifies additional context that can be used to make more granular authorization
2389
2667
  * decisions.</p>
2390
2668
  */
2391
2669
  context?: ContextDefinition;
2392
2670
  /**
2671
+ * @public
2393
2672
  * <p>Specifies the list of resources and principals and their associated attributes that
2394
2673
  * Verified Permissions can examine when evaluating the policies. </p>
2395
2674
  * <note>
@@ -2404,11 +2683,13 @@ export interface IsAuthorizedInput {
2404
2683
  */
2405
2684
  export interface IsAuthorizedWithTokenInput {
2406
2685
  /**
2686
+ * @public
2407
2687
  * <p>Specifies the ID of the policy store. Policies in this policy store will be used to make an
2408
2688
  * authorization decision for the input.</p>
2409
2689
  */
2410
2690
  policyStoreId: string | undefined;
2411
2691
  /**
2692
+ * @public
2412
2693
  * <p>Specifies an identity token for the principal to be authorized. This token is provided
2413
2694
  * to you by the identity provider (IdP) associated with the specified identity source. You must
2414
2695
  * specify either an <code>AccessToken</code> or an <code>IdentityToken</code>, but not
@@ -2416,6 +2697,7 @@ export interface IsAuthorizedWithTokenInput {
2416
2697
  */
2417
2698
  identityToken?: string;
2418
2699
  /**
2700
+ * @public
2419
2701
  * <p>Specifies an access token for the principal to be authorized. This token is provided
2420
2702
  * to you by the identity provider (IdP) associated with the specified identity source. You must
2421
2703
  * specify either an <code>AccessToken</code> or an <code>IdentityToken</code>, but not
@@ -2423,21 +2705,25 @@ export interface IsAuthorizedWithTokenInput {
2423
2705
  */
2424
2706
  accessToken?: string;
2425
2707
  /**
2708
+ * @public
2426
2709
  * <p>Specifies the requested action to be authorized. Is the specified principal authorized
2427
2710
  * to perform this action on the specified resource.</p>
2428
2711
  */
2429
2712
  action?: ActionIdentifier;
2430
2713
  /**
2714
+ * @public
2431
2715
  * <p>Specifies the resource for which the authorization decision is made. For example, is
2432
2716
  * the principal allowed to perform the action on the resource?</p>
2433
2717
  */
2434
2718
  resource?: EntityIdentifier;
2435
2719
  /**
2720
+ * @public
2436
2721
  * <p>Specifies additional context that can be used to make more granular authorization
2437
2722
  * decisions.</p>
2438
2723
  */
2439
2724
  context?: ContextDefinition;
2440
2725
  /**
2726
+ * @public
2441
2727
  * <p>Specifies the list of resources and principals and their associated attributes that
2442
2728
  * Verified Permissions can examine when evaluating the policies. </p>
2443
2729
  * <note>