@aws-sdk/client-verifiedpermissions 3.799.0 → 3.803.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.
Files changed (54) hide show
  1. package/README.md +25 -65
  2. package/dist-cjs/index.js +158 -0
  3. package/dist-es/VerifiedPermissions.js +6 -0
  4. package/dist-es/commands/ListTagsForResourceCommand.js +22 -0
  5. package/dist-es/commands/TagResourceCommand.js +22 -0
  6. package/dist-es/commands/UntagResourceCommand.js +22 -0
  7. package/dist-es/commands/index.js +3 -0
  8. package/dist-es/models/models_0.js +18 -0
  9. package/dist-es/protocols/Aws_json1_0.js +73 -1
  10. package/dist-types/VerifiedPermissions.d.ts +22 -65
  11. package/dist-types/VerifiedPermissionsClient.d.ts +6 -67
  12. package/dist-types/commands/BatchGetPolicyCommand.d.ts +2 -88
  13. package/dist-types/commands/BatchIsAuthorizedCommand.d.ts +2 -103
  14. package/dist-types/commands/BatchIsAuthorizedWithTokenCommand.d.ts +2 -101
  15. package/dist-types/commands/CreateIdentitySourceCommand.d.ts +3 -121
  16. package/dist-types/commands/CreatePolicyCommand.d.ts +3 -111
  17. package/dist-types/commands/CreatePolicyStoreCommand.d.ts +6 -95
  18. package/dist-types/commands/CreatePolicyTemplateCommand.d.ts +3 -97
  19. package/dist-types/commands/DeleteIdentitySourceCommand.d.ts +3 -88
  20. package/dist-types/commands/DeletePolicyCommand.d.ts +3 -87
  21. package/dist-types/commands/DeletePolicyStoreCommand.d.ts +2 -85
  22. package/dist-types/commands/DeletePolicyTemplateCommand.d.ts +3 -90
  23. package/dist-types/commands/GetIdentitySourceCommand.d.ts +1 -82
  24. package/dist-types/commands/GetPolicyCommand.d.ts +1 -82
  25. package/dist-types/commands/GetPolicyStoreCommand.d.ts +6 -82
  26. package/dist-types/commands/GetPolicyTemplateCommand.d.ts +1 -82
  27. package/dist-types/commands/GetSchemaCommand.d.ts +1 -82
  28. package/dist-types/commands/IsAuthorizedCommand.d.ts +2 -88
  29. package/dist-types/commands/IsAuthorizedWithTokenCommand.d.ts +2 -96
  30. package/dist-types/commands/ListIdentitySourcesCommand.d.ts +1 -82
  31. package/dist-types/commands/ListPoliciesCommand.d.ts +1 -82
  32. package/dist-types/commands/ListPolicyStoresCommand.d.ts +1 -82
  33. package/dist-types/commands/ListPolicyTemplatesCommand.d.ts +1 -82
  34. package/dist-types/commands/ListTagsForResourceCommand.d.ts +107 -0
  35. package/dist-types/commands/PutSchemaCommand.d.ts +3 -95
  36. package/dist-types/commands/TagResourceCommand.d.ts +108 -0
  37. package/dist-types/commands/UntagResourceCommand.d.ts +105 -0
  38. package/dist-types/commands/UpdateIdentitySourceCommand.d.ts +3 -92
  39. package/dist-types/commands/UpdatePolicyCommand.d.ts +3 -135
  40. package/dist-types/commands/UpdatePolicyStoreCommand.d.ts +3 -91
  41. package/dist-types/commands/UpdatePolicyTemplateCommand.d.ts +3 -97
  42. package/dist-types/commands/index.d.ts +3 -0
  43. package/dist-types/index.d.ts +1 -65
  44. package/dist-types/models/models_0.d.ts +385 -1235
  45. package/dist-types/protocols/Aws_json1_0.d.ts +27 -0
  46. package/dist-types/ts3.4/VerifiedPermissions.d.ts +51 -0
  47. package/dist-types/ts3.4/VerifiedPermissionsClient.d.ts +18 -0
  48. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +51 -0
  49. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +47 -0
  50. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +47 -0
  51. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  52. package/dist-types/ts3.4/models/models_0.d.ts +33 -0
  53. package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +36 -0
  54. package/package.json +4 -4
@@ -13,13 +13,7 @@ export declare class AccessDeniedException extends __BaseException {
13
13
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
14
14
  }
15
15
  /**
16
- * <p>Contains information about an action for a request for which an authorization decision
17
- * is made.</p>
18
- * <p>This data type is used as a request parameter to the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html">IsAuthorized</a>, <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_BatchIsAuthorized.html">BatchIsAuthorized</a>, and <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html">IsAuthorizedWithToken</a>
19
- * operations.</p>
20
- * <p>Example: <code>\{ "actionId": "&lt;action name&gt;", "actionType": "Action"
21
- * \}</code>
22
- * </p>
16
+ * <p>Contains information about an action for a request for which an authorization decision is made.</p> <p>This data type is used as a request parameter to the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html">IsAuthorized</a>, <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_BatchIsAuthorized.html">BatchIsAuthorized</a>, and <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html">IsAuthorizedWithToken</a> operations.</p> <p>Example: <code>\{ "actionId": "&lt;action name&gt;", "actionType": "Action" \}</code> </p>
23
17
  * @public
24
18
  */
25
19
  export interface ActionIdentifier {
@@ -35,41 +29,28 @@ export interface ActionIdentifier {
35
29
  actionId: string | undefined;
36
30
  }
37
31
  /**
38
- * <p>Contains the identifier of an entity, including its ID and type.</p>
39
- * <p>This data type is used as a request parameter for <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html">IsAuthorized</a> operation, and as a
40
- * response parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html">CreatePolicy</a>, <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetPolicy.html">GetPolicy</a>, and
41
- * <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicy.html">UpdatePolicy</a> operations.</p>
42
- * <p>Example:
43
- * <code>\{"entityId":"<i>string</i>","entityType":"<i>string</i>"\}</code>
44
- * </p>
32
+ * <p>Contains the identifier of an entity, including its ID and type.</p> <p>This data type is used as a request parameter for <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html">IsAuthorized</a> operation, and as a response parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html">CreatePolicy</a>, <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetPolicy.html">GetPolicy</a>, and <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicy.html">UpdatePolicy</a> operations.</p> <p>Example: <code>\{"entityId":"<i>string</i>","entityType":"<i>string</i>"\}</code> </p>
45
33
  * @public
46
34
  */
47
35
  export interface EntityIdentifier {
48
36
  /**
49
- * <p>The type of an entity.</p>
50
- * <p>Example: <code>"entityType":"<i>typeName</i>"</code>
51
- * </p>
37
+ * <p>The type of an entity.</p> <p>Example: <code>"entityType":"<i>typeName</i>"</code> </p>
52
38
  * @public
53
39
  */
54
40
  entityType: string | undefined;
55
41
  /**
56
- * <p>The identifier of an entity.</p>
57
- * <p>
58
- * <code>"entityId":"<i>identifier</i>"</code>
59
- * </p>
42
+ * <p>The identifier of an entity.</p> <p> <code>"entityId":"<i>identifier</i>"</code> </p>
60
43
  * @public
61
44
  */
62
45
  entityId: string | undefined;
63
46
  }
64
47
  /**
65
- * <p>Information about a policy that you include in a <code>BatchGetPolicy</code> API
66
- * request.</p>
48
+ * <p>Information about a policy that you include in a <code>BatchGetPolicy</code> API request.</p>
67
49
  * @public
68
50
  */
69
51
  export interface BatchGetPolicyInputItem {
70
52
  /**
71
- * <p>The identifier of the policy store where the policy you want information about is
72
- * stored.</p>
53
+ * <p>The identifier of the policy store where the policy you want information about is stored.</p>
73
54
  * @public
74
55
  */
75
56
  policyStoreId: string | undefined;
@@ -102,8 +83,7 @@ export declare const BatchGetPolicyErrorCode: {
102
83
  */
103
84
  export type BatchGetPolicyErrorCode = (typeof BatchGetPolicyErrorCode)[keyof typeof BatchGetPolicyErrorCode];
104
85
  /**
105
- * <p>Contains the information about an error resulting from a <code>BatchGetPolicy</code>
106
- * API call.</p>
86
+ * <p>Contains the information about an error resulting from a <code>BatchGetPolicy</code> API call.</p>
107
87
  * @public
108
88
  */
109
89
  export interface BatchGetPolicyErrorItem {
@@ -129,10 +109,7 @@ export interface BatchGetPolicyErrorItem {
129
109
  message: string | undefined;
130
110
  }
131
111
  /**
132
- * <p>A structure that contains details about a static policy. It includes the description and
133
- * policy body.</p>
134
- * <p>This data type is used within a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_PolicyDefinition.html">PolicyDefinition</a> structure as
135
- * part of a request parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html">CreatePolicy</a> operation.</p>
112
+ * <p>A structure that contains details about a static policy. It includes the description and policy body.</p> <p>This data type is used within a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_PolicyDefinition.html">PolicyDefinition</a> structure as part of a request parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html">CreatePolicy</a> operation.</p>
136
113
  * @public
137
114
  */
138
115
  export interface StaticPolicyDefinitionDetail {
@@ -148,8 +125,7 @@ export interface StaticPolicyDefinitionDetail {
148
125
  statement: string | undefined;
149
126
  }
150
127
  /**
151
- * <p>Contains information about a policy that was created by instantiating a policy
152
- * template. </p>
128
+ * <p>Contains information about a policy that was created by instantiating a policy template. </p>
153
129
  * @public
154
130
  */
155
131
  export interface TemplateLinkedPolicyDefinitionDetail {
@@ -159,24 +135,18 @@ export interface TemplateLinkedPolicyDefinitionDetail {
159
135
  */
160
136
  policyTemplateId: string | undefined;
161
137
  /**
162
- * <p>The principal associated with this template-linked policy. Verified Permissions substitutes this principal for the
163
- * <code>?principal</code> placeholder in the policy template when it evaluates an authorization
164
- * request.</p>
138
+ * <p>The principal associated with this template-linked policy. Verified Permissions substitutes this principal for the <code>?principal</code> placeholder in the policy template when it evaluates an authorization request.</p>
165
139
  * @public
166
140
  */
167
141
  principal?: EntityIdentifier | undefined;
168
142
  /**
169
- * <p>The resource associated with this template-linked policy. Verified Permissions substitutes this resource for the
170
- * <code>?resource</code> placeholder in the policy template when it evaluates an authorization
171
- * request.</p>
143
+ * <p>The resource associated with this template-linked policy. Verified Permissions substitutes this resource for the <code>?resource</code> placeholder in the policy template when it evaluates an authorization request.</p>
172
144
  * @public
173
145
  */
174
146
  resource?: EntityIdentifier | undefined;
175
147
  }
176
148
  /**
177
- * <p>A structure that describes a policy definition. It must always have either an
178
- * <code>static</code> or a <code>templateLinked</code> element.</p>
179
- * <p>This data type is used as a response parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetPolicy.html">GetPolicy</a> operation.</p>
149
+ * <p>A structure that describes a policy definition. It must always have either an <code>static</code> or a <code>templateLinked</code> element.</p> <p>This data type is used as a response parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetPolicy.html">GetPolicy</a> operation.</p>
180
150
  * @public
181
151
  */
182
152
  export type PolicyDefinitionDetail = PolicyDefinitionDetail.StaticMember | PolicyDefinitionDetail.TemplateLinkedMember | PolicyDefinitionDetail.$UnknownMember;
@@ -230,14 +200,12 @@ export declare const PolicyType: {
230
200
  */
231
201
  export type PolicyType = (typeof PolicyType)[keyof typeof PolicyType];
232
202
  /**
233
- * <p>Contains information about a policy returned from a <code>BatchGetPolicy</code> API
234
- * request.</p>
203
+ * <p>Contains information about a policy returned from a <code>BatchGetPolicy</code> API request.</p>
235
204
  * @public
236
205
  */
237
206
  export interface BatchGetPolicyOutputItem {
238
207
  /**
239
- * <p>The identifier of the policy store where the policy you want information about is
240
- * stored.</p>
208
+ * <p>The identifier of the policy store where the policy you want information about is stored.</p>
241
209
  * @public
242
210
  */
243
211
  policyStoreId: string | undefined;
@@ -247,19 +215,7 @@ export interface BatchGetPolicyOutputItem {
247
215
  */
248
216
  policyId: string | undefined;
249
217
  /**
250
- * <p>The type of the policy. This is one of the following values:</p>
251
- * <ul>
252
- * <li>
253
- * <p>
254
- * <code>STATIC</code>
255
- * </p>
256
- * </li>
257
- * <li>
258
- * <p>
259
- * <code>TEMPLATE_LINKED</code>
260
- * </p>
261
- * </li>
262
- * </ul>
218
+ * <p>The type of the policy. This is one of the following values:</p> <ul> <li> <p> <code>STATIC</code> </p> </li> <li> <p> <code>TEMPLATE_LINKED</code> </p> </li> </ul>
263
219
  * @public
264
220
  */
265
221
  policyType: PolicyType | undefined;
@@ -349,88 +305,7 @@ export interface ValidationExceptionField {
349
305
  message: string | undefined;
350
306
  }
351
307
  /**
352
- * <p>The request failed because one or more input parameters don't satisfy their constraint
353
- * requirements. The output is provided as a list of fields and a reason for each field that
354
- * isn't valid.</p>
355
- * <p>The possible reasons include the following:</p>
356
- * <ul>
357
- * <li>
358
- * <p>
359
- * <b>UnrecognizedEntityType</b>
360
- * </p>
361
- * <p>The policy includes an entity type that isn't found in the schema.</p>
362
- * </li>
363
- * <li>
364
- * <p>
365
- * <b>UnrecognizedActionId</b>
366
- * </p>
367
- * <p>The policy includes an action id that isn't found in the schema.</p>
368
- * </li>
369
- * <li>
370
- * <p>
371
- * <b>InvalidActionApplication</b>
372
- * </p>
373
- * <p>The policy includes an action that, according to the schema, doesn't support
374
- * the specified principal and resource.</p>
375
- * </li>
376
- * <li>
377
- * <p>
378
- * <b>UnexpectedType</b>
379
- * </p>
380
- * <p>The policy included an operand that isn't a valid type for the specified
381
- * operation.</p>
382
- * </li>
383
- * <li>
384
- * <p>
385
- * <b>IncompatibleTypes</b>
386
- * </p>
387
- * <p>The types of elements included in a <code>set</code>, or the types of
388
- * expressions used in an <code>if...then...else</code> clause aren't compatible in
389
- * this context.</p>
390
- * </li>
391
- * <li>
392
- * <p>
393
- * <b>MissingAttribute</b>
394
- * </p>
395
- * <p>The policy attempts to access a record or entity attribute that isn't
396
- * specified in the schema. Test for the existence of the attribute first before
397
- * attempting to access its value. For more information, see the <a href="https://docs.cedarpolicy.com/policies/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in the
398
- * <i>Cedar Policy Language Guide</i>.</p>
399
- * </li>
400
- * <li>
401
- * <p>
402
- * <b>UnsafeOptionalAttributeAccess</b>
403
- * </p>
404
- * <p>The policy attempts to access a record or entity attribute that is optional
405
- * and isn't guaranteed to be present. Test for the existence of the attribute
406
- * first before attempting to access its value. For more information, see the
407
- * <a href="https://docs.cedarpolicy.com/policies/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in the
408
- * <i>Cedar Policy Language Guide</i>.</p>
409
- * </li>
410
- * <li>
411
- * <p>
412
- * <b>ImpossiblePolicy</b>
413
- * </p>
414
- * <p>Cedar has determined that a policy condition always evaluates to false. If
415
- * the policy is always false, it can never apply to any query, and so it can never
416
- * affect an authorization decision.</p>
417
- * </li>
418
- * <li>
419
- * <p>
420
- * <b>WrongNumberArguments</b>
421
- * </p>
422
- * <p>The policy references an extension type with the wrong number of
423
- * arguments.</p>
424
- * </li>
425
- * <li>
426
- * <p>
427
- * <b>FunctionArgumentValidationError</b>
428
- * </p>
429
- * <p>Cedar couldn't parse the argument passed to an extension type. For example,
430
- * a string that is to be parsed as an IPv4 address can contain only digits and the
431
- * period character.</p>
432
- * </li>
433
- * </ul>
308
+ * <p>The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.</p> <p>The possible reasons include the following:</p> <ul> <li> <p> <b>UnrecognizedEntityType</b> </p> <p>The policy includes an entity type that isn't found in the schema.</p> </li> <li> <p> <b>UnrecognizedActionId</b> </p> <p>The policy includes an action id that isn't found in the schema.</p> </li> <li> <p> <b>InvalidActionApplication</b> </p> <p>The policy includes an action that, according to the schema, doesn't support the specified principal and resource.</p> </li> <li> <p> <b>UnexpectedType</b> </p> <p>The policy included an operand that isn't a valid type for the specified operation.</p> </li> <li> <p> <b>IncompatibleTypes</b> </p> <p>The types of elements included in a <code>set</code>, or the types of expressions used in an <code>if...then...else</code> clause aren't compatible in this context.</p> </li> <li> <p> <b>MissingAttribute</b> </p> <p>The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the <a href="https://docs.cedarpolicy.com/policies/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in the <i>Cedar Policy Language Guide</i>.</p> </li> <li> <p> <b>UnsafeOptionalAttributeAccess</b> </p> <p>The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the <a href="https://docs.cedarpolicy.com/policies/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in the <i>Cedar Policy Language Guide</i>.</p> </li> <li> <p> <b>ImpossiblePolicy</b> </p> <p>Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.</p> </li> <li> <p> <b>WrongNumberArguments</b> </p> <p>The policy references an extension type with the wrong number of arguments.</p> </li> <li> <p> <b>FunctionArgumentValidationError</b> </p> <p>Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.</p> </li> </ul>
434
309
  * @public
435
310
  */
436
311
  export declare class ValidationException extends __BaseException {
@@ -459,26 +334,18 @@ export declare const Decision: {
459
334
  */
460
335
  export type Decision = (typeof Decision)[keyof typeof Decision];
461
336
  /**
462
- * <p>Contains information about one of the policies that determined an authorization
463
- * decision.</p>
464
- * <p>This data type is used as an element in a response parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html">IsAuthorized</a>, <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_BatchIsAuthorized.html">BatchIsAuthorized</a>, and <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html">IsAuthorizedWithToken</a>
465
- * operations.</p>
466
- * <p>Example: <code>"determiningPolicies":[\{"policyId":"SPEXAMPLEabcdefg111111"\}]</code>
467
- * </p>
337
+ * <p>Contains information about one of the policies that determined an authorization decision.</p> <p>This data type is used as an element in a response parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html">IsAuthorized</a>, <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_BatchIsAuthorized.html">BatchIsAuthorized</a>, and <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html">IsAuthorizedWithToken</a> operations.</p> <p>Example: <code>"determiningPolicies":[\{"policyId":"SPEXAMPLEabcdefg111111"\}]</code> </p>
468
338
  * @public
469
339
  */
470
340
  export interface DeterminingPolicyItem {
471
341
  /**
472
- * <p>The Id of a policy that determined to an authorization decision.</p>
473
- * <p>Example: <code>"policyId":"SPEXAMPLEabcdefg111111"</code>
474
- * </p>
342
+ * <p>The Id of a policy that determined to an authorization decision.</p> <p>Example: <code>"policyId":"SPEXAMPLEabcdefg111111"</code> </p>
475
343
  * @public
476
344
  */
477
345
  policyId: string | undefined;
478
346
  }
479
347
  /**
480
- * <p>Contains a description of an evaluation error.</p>
481
- * <p>This data type is a response parameter of the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html">IsAuthorized</a>, <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_BatchIsAuthorized.html">BatchIsAuthorized</a>, and <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html">IsAuthorizedWithToken</a> operations.</p>
348
+ * <p>Contains a description of an evaluation error.</p> <p>This data type is a response parameter of the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html">IsAuthorized</a>, <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_BatchIsAuthorized.html">BatchIsAuthorized</a>, and <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html">IsAuthorizedWithToken</a> operations.</p>
482
349
  * @public
483
350
  */
484
351
  export interface EvaluationErrorItem {
@@ -526,247 +393,173 @@ export declare class ResourceNotFoundException extends __BaseException {
526
393
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
527
394
  }
528
395
  /**
529
- * <p>The type of entity that a policy store maps to groups from an Amazon Cognito user
530
- * pool identity source.</p>
531
- * <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CognitoUserPoolConfiguration.html">CognitoUserPoolConfiguration</a> structure and is a request parameter in <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html">CreateIdentitySource</a>.</p>
396
+ * @public
397
+ * @enum
398
+ */
399
+ export declare const CedarVersion: {
400
+ readonly CEDAR_2: "CEDAR_2";
401
+ readonly CEDAR_4: "CEDAR_4";
402
+ };
403
+ /**
404
+ * @public
405
+ */
406
+ export type CedarVersion = (typeof CedarVersion)[keyof typeof CedarVersion];
407
+ /**
408
+ * <p>The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.</p> <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CognitoUserPoolConfiguration.html">CognitoUserPoolConfiguration</a> structure and is a request parameter in <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html">CreateIdentitySource</a>.</p>
532
409
  * @public
533
410
  */
534
411
  export interface CognitoGroupConfiguration {
535
412
  /**
536
- * <p>The name of the schema entity type that's mapped to the user pool group. Defaults
537
- * to <code>AWS::CognitoGroup</code>.</p>
413
+ * <p>The name of the schema entity type that's mapped to the user pool group. Defaults to <code>AWS::CognitoGroup</code>.</p>
538
414
  * @public
539
415
  */
540
416
  groupEntityType: string | undefined;
541
417
  }
542
418
  /**
543
- * <p>The type of entity that a policy store maps to groups from an Amazon Cognito user
544
- * pool identity source.</p>
545
- * <p>This data type is part of an <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CognitoUserPoolConfigurationItem.html">CognitoUserPoolConfigurationDetail</a> structure and is a response parameter to
546
- * <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html">GetIdentitySource</a>.</p>
419
+ * <p>The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.</p> <p>This data type is part of an <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CognitoUserPoolConfigurationItem.html">CognitoUserPoolConfigurationDetail</a> structure and is a response parameter to <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html">GetIdentitySource</a>.</p>
547
420
  * @public
548
421
  */
549
422
  export interface CognitoGroupConfigurationDetail {
550
423
  /**
551
- * <p>The name of the schema entity type that's mapped to the user pool group. Defaults
552
- * to <code>AWS::CognitoGroup</code>.</p>
424
+ * <p>The name of the schema entity type that's mapped to the user pool group. Defaults to <code>AWS::CognitoGroup</code>.</p>
553
425
  * @public
554
426
  */
555
427
  groupEntityType?: string | undefined;
556
428
  }
557
429
  /**
558
- * <p>The type of entity that a policy store maps to groups from an Amazon Cognito user
559
- * pool identity source.</p>
560
- * <p>This data type is part of an <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CognitoUserPoolConfigurationDetail.html">CognitoUserPoolConfigurationItem</a> structure and is a response parameter to
561
- * <a href="http://forums.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html">ListIdentitySources</a>.</p>
430
+ * <p>The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.</p> <p>This data type is part of an <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CognitoUserPoolConfigurationDetail.html">CognitoUserPoolConfigurationItem</a> structure and is a response parameter to <a href="http://forums.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html">ListIdentitySources</a>.</p>
562
431
  * @public
563
432
  */
564
433
  export interface CognitoGroupConfigurationItem {
565
434
  /**
566
- * <p>The name of the schema entity type that's mapped to the user pool group. Defaults
567
- * to <code>AWS::CognitoGroup</code>.</p>
435
+ * <p>The name of the schema entity type that's mapped to the user pool group. Defaults to <code>AWS::CognitoGroup</code>.</p>
568
436
  * @public
569
437
  */
570
438
  groupEntityType?: string | undefined;
571
439
  }
572
440
  /**
573
- * <p>The configuration for an identity source that represents a connection to an Amazon Cognito user pool used
574
- * as an identity provider for Verified Permissions.</p>
575
- * <p>This data type part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_Configuration.html">Configuration</a> structure that is
576
- * used as a parameter to <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html">CreateIdentitySource</a>.</p>
577
- * <p>Example:<code>"CognitoUserPoolConfiguration":\{"UserPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","ClientIds":
578
- * ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": \{"groupEntityType":
579
- * "MyCorp::Group"\}\}</code>
580
- * </p>
441
+ * <p>The configuration for an identity source that represents a connection to an Amazon Cognito user pool used as an identity provider for Verified Permissions.</p> <p>This data type part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_Configuration.html">Configuration</a> structure that is used as a parameter to <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html">CreateIdentitySource</a>.</p> <p>Example:<code>"CognitoUserPoolConfiguration":\{"UserPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","ClientIds": ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": \{"groupEntityType": "MyCorp::Group"\}\}</code> </p>
581
442
  * @public
582
443
  */
583
444
  export interface CognitoUserPoolConfiguration {
584
445
  /**
585
- * <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
586
- * authorized.</p>
587
- * <p>Example: <code>"UserPoolArn":
588
- * "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"</code>
589
- * </p>
446
+ * <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 authorized.</p> <p>Example: <code>"UserPoolArn": "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"</code> </p>
590
447
  * @public
591
448
  */
592
449
  userPoolArn: string | undefined;
593
450
  /**
594
- * <p>The unique application client IDs that are associated with the specified Amazon Cognito user
595
- * pool.</p>
596
- * <p>Example: <code>"ClientIds": ["&amp;ExampleCogClientId;"]</code>
597
- * </p>
451
+ * <p>The unique application client IDs that are associated with the specified Amazon Cognito user pool.</p> <p>Example: <code>"ClientIds": ["&amp;ExampleCogClientId;"]</code> </p>
598
452
  * @public
599
453
  */
600
454
  clientIds?: string[] | undefined;
601
455
  /**
602
- * <p>The type of entity that a policy store maps to groups from an Amazon Cognito user
603
- * pool identity source.</p>
456
+ * <p>The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.</p>
604
457
  * @public
605
458
  */
606
459
  groupConfiguration?: CognitoGroupConfiguration | undefined;
607
460
  }
608
461
  /**
609
- * <p>The configuration for an identity source that represents a connection to an Amazon Cognito user pool used
610
- * as an identity provider for Verified Permissions.</p>
611
- * <p>This data type is used as a field that is part of an <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ConfigurationDetail.html">ConfigurationDetail</a>
612
- * structure that is part of the response to <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html">GetIdentitySource</a>.</p>
613
- * <p>Example:<code>"CognitoUserPoolConfiguration":\{"UserPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","ClientIds":
614
- * ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": \{"groupEntityType":
615
- * "MyCorp::Group"\}\}</code>
616
- * </p>
462
+ * <p>The configuration for an identity source that represents a connection to an Amazon Cognito user pool used as an identity provider for Verified Permissions.</p> <p>This data type is used as a field that is part of an <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ConfigurationDetail.html">ConfigurationDetail</a> structure that is part of the response to <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html">GetIdentitySource</a>.</p> <p>Example:<code>"CognitoUserPoolConfiguration":\{"UserPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","ClientIds": ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": \{"groupEntityType": "MyCorp::Group"\}\}</code> </p>
617
463
  * @public
618
464
  */
619
465
  export interface CognitoUserPoolConfigurationDetail {
620
466
  /**
621
- * <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
622
- * authorized.</p>
623
- * <p>Example: <code>"userPoolArn":
624
- * "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"</code>
625
- * </p>
467
+ * <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 authorized.</p> <p>Example: <code>"userPoolArn": "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"</code> </p>
626
468
  * @public
627
469
  */
628
470
  userPoolArn: string | undefined;
629
471
  /**
630
- * <p>The unique application client IDs that are associated with the specified Amazon Cognito user
631
- * pool.</p>
632
- * <p>Example: <code>"clientIds": ["&amp;ExampleCogClientId;"]</code>
633
- * </p>
472
+ * <p>The unique application client IDs that are associated with the specified Amazon Cognito user pool.</p> <p>Example: <code>"clientIds": ["&amp;ExampleCogClientId;"]</code> </p>
634
473
  * @public
635
474
  */
636
475
  clientIds: string[] | undefined;
637
476
  /**
638
- * <p>The OpenID Connect (OIDC) <code>issuer</code> ID of the Amazon Cognito user pool that contains
639
- * the identities to be authorized.</p>
640
- * <p>Example: <code>"issuer":
641
- * "https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5"</code>
642
- * </p>
477
+ * <p>The OpenID Connect (OIDC) <code>issuer</code> ID of the Amazon Cognito user pool that contains the identities to be authorized.</p> <p>Example: <code>"issuer": "https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5"</code> </p>
643
478
  * @public
644
479
  */
645
480
  issuer: string | undefined;
646
481
  /**
647
- * <p>The type of entity that a policy store maps to groups from an Amazon Cognito user
648
- * pool identity source.</p>
482
+ * <p>The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.</p>
649
483
  * @public
650
484
  */
651
485
  groupConfiguration?: CognitoGroupConfigurationDetail | undefined;
652
486
  }
653
487
  /**
654
- * <p>The configuration for an identity source that represents a connection to an Amazon Cognito user pool used
655
- * as an identity provider for Verified Permissions.</p>
656
- * <p>This data type is used as a field that is part of the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ConfigurationItem.html">ConfigurationItem</a> structure
657
- * that is part of the response to <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html">ListIdentitySources</a>.</p>
658
- * <p>Example:<code>"CognitoUserPoolConfiguration":\{"UserPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","ClientIds":
659
- * ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": \{"groupEntityType":
660
- * "MyCorp::Group"\}\}</code>
661
- * </p>
488
+ * <p>The configuration for an identity source that represents a connection to an Amazon Cognito user pool used as an identity provider for Verified Permissions.</p> <p>This data type is used as a field that is part of the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ConfigurationItem.html">ConfigurationItem</a> structure that is part of the response to <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html">ListIdentitySources</a>.</p> <p>Example:<code>"CognitoUserPoolConfiguration":\{"UserPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","ClientIds": ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": \{"groupEntityType": "MyCorp::Group"\}\}</code> </p>
662
489
  * @public
663
490
  */
664
491
  export interface CognitoUserPoolConfigurationItem {
665
492
  /**
666
- * <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
667
- * authorized.</p>
668
- * <p>Example: <code>"userPoolArn":
669
- * "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"</code>
670
- * </p>
493
+ * <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 authorized.</p> <p>Example: <code>"userPoolArn": "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"</code> </p>
671
494
  * @public
672
495
  */
673
496
  userPoolArn: string | undefined;
674
497
  /**
675
- * <p>The unique application client IDs that are associated with the specified Amazon Cognito user
676
- * pool.</p>
677
- * <p>Example: <code>"clientIds": ["&amp;ExampleCogClientId;"]</code>
678
- * </p>
498
+ * <p>The unique application client IDs that are associated with the specified Amazon Cognito user pool.</p> <p>Example: <code>"clientIds": ["&amp;ExampleCogClientId;"]</code> </p>
679
499
  * @public
680
500
  */
681
501
  clientIds: string[] | undefined;
682
502
  /**
683
- * <p>The OpenID Connect (OIDC) <code>issuer</code> ID of the Amazon Cognito user pool that contains
684
- * the identities to be authorized.</p>
685
- * <p>Example: <code>"issuer":
686
- * "https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5"</code>
687
- * </p>
503
+ * <p>The OpenID Connect (OIDC) <code>issuer</code> ID of the Amazon Cognito user pool that contains the identities to be authorized.</p> <p>Example: <code>"issuer": "https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5"</code> </p>
688
504
  * @public
689
505
  */
690
506
  issuer: string | undefined;
691
507
  /**
692
- * <p>The type of entity that a policy store maps to groups from an Amazon Cognito user
693
- * pool identity source.</p>
508
+ * <p>The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.</p>
694
509
  * @public
695
510
  */
696
511
  groupConfiguration?: CognitoGroupConfigurationItem | undefined;
697
512
  }
698
513
  /**
699
- * <p>The claim in OIDC identity provider tokens that indicates a user's group membership, and
700
- * the entity type that you want to map it to. For example, this object can map the contents
701
- * of a <code>groups</code> claim to <code>MyCorp::UserGroup</code>.</p>
702
- * <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectConfiguration.html">OpenIdConnectConfiguration</a> structure, which is a parameter of <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html">CreateIdentitySource</a>.</p>
514
+ * <p>The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a <code>groups</code> claim to <code>MyCorp::UserGroup</code>.</p> <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectConfiguration.html">OpenIdConnectConfiguration</a> structure, which is a parameter of <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html">CreateIdentitySource</a>.</p>
703
515
  * @public
704
516
  */
705
517
  export interface OpenIdConnectGroupConfiguration {
706
518
  /**
707
- * <p>The token claim that you want Verified Permissions to interpret as group membership. For example,
708
- * <code>groups</code>.</p>
519
+ * <p>The token claim that you want Verified Permissions to interpret as group membership. For example, <code>groups</code>.</p>
709
520
  * @public
710
521
  */
711
522
  groupClaim: string | undefined;
712
523
  /**
713
- * <p>The policy store entity type that you want to map your users' group claim to. For example,
714
- * <code>MyCorp::UserGroup</code>. A group entity type is an entity that can have a user
715
- * entity type as a member.</p>
524
+ * <p>The policy store entity type that you want to map your users' group claim to. For example, <code>MyCorp::UserGroup</code>. A group entity type is an entity that can have a user entity type as a member.</p>
716
525
  * @public
717
526
  */
718
527
  groupEntityType: string | undefined;
719
528
  }
720
529
  /**
721
- * <p>The configuration of an OpenID Connect (OIDC) identity source for handling access token
722
- * claims. Contains the claim that you want to identify as the principal in an authorization
723
- * request, and the values of the <code>aud</code> claim, or audiences, that you want to
724
- * accept.</p>
725
- * <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectTokenSelection.html">OpenIdConnectTokenSelection</a> structure, which is a parameter of <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html">CreateIdentitySource</a>.</p>
530
+ * <p>The configuration of an OpenID Connect (OIDC) identity source for handling access token claims. Contains the claim that you want to identify as the principal in an authorization request, and the values of the <code>aud</code> claim, or audiences, that you want to accept.</p> <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectTokenSelection.html">OpenIdConnectTokenSelection</a> structure, which is a parameter of <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html">CreateIdentitySource</a>.</p>
726
531
  * @public
727
532
  */
728
533
  export interface OpenIdConnectAccessTokenConfiguration {
729
534
  /**
730
- * <p>The claim that determines the principal in OIDC access tokens. For example,
731
- * <code>sub</code>.</p>
535
+ * <p>The claim that determines the principal in OIDC access tokens. For example, <code>sub</code>.</p>
732
536
  * @public
733
537
  */
734
538
  principalIdClaim?: string | undefined;
735
539
  /**
736
- * <p>The access token <code>aud</code> claim values that you want to accept in your policy
737
- * store. For example, <code>https://myapp.example.com, https://myapp2.example.com</code>.</p>
540
+ * <p>The access token <code>aud</code> claim values that you want to accept in your policy store. For example, <code>https://myapp.example.com, https://myapp2.example.com</code>.</p>
738
541
  * @public
739
542
  */
740
543
  audiences?: string[] | undefined;
741
544
  }
742
545
  /**
743
- * <p>The configuration of an OpenID Connect (OIDC) identity source for handling identity (ID)
744
- * token claims. Contains the claim that you want to identify as the principal in an
745
- * authorization request, and the values of the <code>aud</code> claim, or audiences, that
746
- * you want to accept.</p>
747
- * <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectTokenSelection.html">OpenIdConnectTokenSelection</a> structure, which is a parameter of <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html">CreateIdentitySource</a>.</p>
546
+ * <p>The configuration of an OpenID Connect (OIDC) identity source for handling identity (ID) token claims. Contains the claim that you want to identify as the principal in an authorization request, and the values of the <code>aud</code> claim, or audiences, that you want to accept.</p> <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectTokenSelection.html">OpenIdConnectTokenSelection</a> structure, which is a parameter of <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html">CreateIdentitySource</a>.</p>
748
547
  * @public
749
548
  */
750
549
  export interface OpenIdConnectIdentityTokenConfiguration {
751
550
  /**
752
- * <p>The claim that determines the principal in OIDC access tokens. For example,
753
- * <code>sub</code>.</p>
551
+ * <p>The claim that determines the principal in OIDC access tokens. For example, <code>sub</code>.</p>
754
552
  * @public
755
553
  */
756
554
  principalIdClaim?: string | undefined;
757
555
  /**
758
- * <p>The ID token audience, or client ID, claim values that you want to accept in your policy
759
- * store from an OIDC identity provider. For example, <code>1example23456789,
760
- * 2example10111213</code>.</p>
556
+ * <p>The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider. For example, <code>1example23456789, 2example10111213</code>.</p>
761
557
  * @public
762
558
  */
763
559
  clientIds?: string[] | undefined;
764
560
  }
765
561
  /**
766
- * <p>The token type that you want to process from your OIDC identity provider. Your policy
767
- * store can process either identity (ID) or access tokens from a given OIDC identity
768
- * source.</p>
769
- * <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectConfiguration.html">OpenIdConnectConfiguration</a> structure, which is a parameter of <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html">CreateIdentitySource</a>.</p>
562
+ * <p>The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.</p> <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectConfiguration.html">OpenIdConnectConfiguration</a> structure, which is a parameter of <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html">CreateIdentitySource</a>.</p>
770
563
  * @public
771
564
  */
772
565
  export type OpenIdConnectTokenSelection = OpenIdConnectTokenSelection.AccessTokenOnlyMember | OpenIdConnectTokenSelection.IdentityTokenOnlyMember | OpenIdConnectTokenSelection.$UnknownMember;
@@ -775,9 +568,7 @@ export type OpenIdConnectTokenSelection = OpenIdConnectTokenSelection.AccessToke
775
568
  */
776
569
  export declare namespace OpenIdConnectTokenSelection {
777
570
  /**
778
- * <p>The OIDC configuration for processing access tokens. Contains allowed audience claims,
779
- * for example <code>https://auth.example.com</code>, and the claim that you want to map to the
780
- * principal, for example <code>sub</code>.</p>
571
+ * <p>The OIDC configuration for processing access tokens. Contains allowed audience claims, for example <code>https://auth.example.com</code>, and the claim that you want to map to the principal, for example <code>sub</code>.</p>
781
572
  * @public
782
573
  */
783
574
  interface AccessTokenOnlyMember {
@@ -786,9 +577,7 @@ export declare namespace OpenIdConnectTokenSelection {
786
577
  $unknown?: never;
787
578
  }
788
579
  /**
789
- * <p>The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID
790
- * claims, for example <code>1example23456789</code>, and the claim that you want to map to
791
- * the principal, for example <code>sub</code>.</p>
580
+ * <p>The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID claims, for example <code>1example23456789</code>, and the claim that you want to map to the principal, for example <code>sub</code>.</p>
792
581
  * @public
793
582
  */
794
583
  interface IdentityTokenOnlyMember {
@@ -812,48 +601,33 @@ export declare namespace OpenIdConnectTokenSelection {
812
601
  const visit: <T>(value: OpenIdConnectTokenSelection, visitor: Visitor<T>) => T;
813
602
  }
814
603
  /**
815
- * <p>Contains configuration details of an OpenID Connect (OIDC) identity provider, or
816
- * identity source, that Verified Permissions can use to generate entities from authenticated identities. It
817
- * specifies the issuer URL, token type that you want to use, and policy store entity
818
- * details.</p>
819
- * <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_Configuration.html">Configuration</a> structure, which
820
- * is a parameter to <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html">CreateIdentitySource</a>.</p>
604
+ * <p>Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details.</p> <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_Configuration.html">Configuration</a> structure, which is a parameter to <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html">CreateIdentitySource</a>.</p>
821
605
  * @public
822
606
  */
823
607
  export interface OpenIdConnectConfiguration {
824
608
  /**
825
- * <p>The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery
826
- * endpoint at the path <code>.well-known/openid-configuration</code>.</p>
609
+ * <p>The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path <code>.well-known/openid-configuration</code>.</p>
827
610
  * @public
828
611
  */
829
612
  issuer: string | undefined;
830
613
  /**
831
- * <p>A descriptive string that you want to prefix to user entities from your OIDC identity
832
- * provider. For example, if you set an <code>entityIdPrefix</code> of
833
- * <code>MyOIDCProvider</code>, you can reference principals in your policies in the format
834
- * <code>MyCorp::User::MyOIDCProvider|Carlos</code>.</p>
614
+ * <p>A descriptive string that you want to prefix to user entities from your OIDC identity provider. For example, if you set an <code>entityIdPrefix</code> of <code>MyOIDCProvider</code>, you can reference principals in your policies in the format <code>MyCorp::User::MyOIDCProvider|Carlos</code>.</p>
835
615
  * @public
836
616
  */
837
617
  entityIdPrefix?: string | undefined;
838
618
  /**
839
- * <p>The claim in OIDC identity provider tokens that indicates a user's group membership, and
840
- * the entity type that you want to map it to. For example, this object can map the contents
841
- * of a <code>groups</code> claim to <code>MyCorp::UserGroup</code>.</p>
619
+ * <p>The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a <code>groups</code> claim to <code>MyCorp::UserGroup</code>.</p>
842
620
  * @public
843
621
  */
844
622
  groupConfiguration?: OpenIdConnectGroupConfiguration | undefined;
845
623
  /**
846
- * <p>The token type that you want to process from your OIDC identity provider. Your policy
847
- * store can process either identity (ID) or access tokens from a given OIDC identity
848
- * source.</p>
624
+ * <p>The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.</p>
849
625
  * @public
850
626
  */
851
627
  tokenSelection: OpenIdConnectTokenSelection | undefined;
852
628
  }
853
629
  /**
854
- * <p>Contains configuration information used when creating a new identity source.</p>
855
- * <p>This data type is used as a request parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html">CreateIdentitySource</a>
856
- * operation.</p>
630
+ * <p>Contains configuration information used when creating a new identity source.</p> <p>This data type is used as a request parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreateIdentitySource.html">CreateIdentitySource</a> operation.</p>
857
631
  * @public
858
632
  */
859
633
  export type Configuration = Configuration.CognitoUserPoolConfigurationMember | Configuration.OpenIdConnectConfigurationMember | Configuration.$UnknownMember;
@@ -862,14 +636,7 @@ export type Configuration = Configuration.CognitoUserPoolConfigurationMember | C
862
636
  */
863
637
  export declare namespace Configuration {
864
638
  /**
865
- * <p>Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of
866
- * 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
867
- * and one or more application client IDs.</p>
868
- * <p>Example:
869
- * <code>"configuration":\{"cognitoUserPoolConfiguration":\{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds":
870
- * ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": \{"groupEntityType":
871
- * "MyCorp::Group"\}\}\}</code>
872
- * </p>
639
+ * <p>Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of 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 and one or more application client IDs.</p> <p>Example: <code>"configuration":\{"cognitoUserPoolConfiguration":\{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds": ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": \{"groupEntityType": "MyCorp::Group"\}\}\}</code> </p>
873
640
  * @public
874
641
  */
875
642
  interface CognitoUserPoolConfigurationMember {
@@ -878,12 +645,7 @@ export declare namespace Configuration {
878
645
  $unknown?: never;
879
646
  }
880
647
  /**
881
- * <p>Contains configuration details of an OpenID Connect (OIDC) identity provider, or
882
- * identity source, that Verified Permissions can use to generate entities from authenticated identities. It
883
- * specifies the issuer URL, token type that you want to use, and policy store entity
884
- * details.</p>
885
- * <p>Example:<code>"configuration":\{"openIdConnectConfiguration":\{"issuer":"https://auth.example.com","tokenSelection":\{"accessTokenOnly":\{"audiences":["https://myapp.example.com","https://myapp2.example.com"],"principalIdClaim":"sub"\}\},"entityIdPrefix":"MyOIDCProvider","groupConfiguration":\{"groupClaim":"groups","groupEntityType":"MyCorp::UserGroup"\}\}\}</code>
886
- * </p>
648
+ * <p>Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details.</p> <p>Example:<code>"configuration":\{"openIdConnectConfiguration":\{"issuer":"https://auth.example.com","tokenSelection":\{"accessTokenOnly":\{"audiences":["https://myapp.example.com","https://myapp2.example.com"],"principalIdClaim":"sub"\}\},"entityIdPrefix":"MyOIDCProvider","groupConfiguration":\{"groupClaim":"groups","groupEntityType":"MyCorp::UserGroup"\}\}\}</code> </p>
887
649
  * @public
888
650
  */
889
651
  interface OpenIdConnectConfigurationMember {
@@ -907,77 +669,55 @@ export declare namespace Configuration {
907
669
  const visit: <T>(value: Configuration, visitor: Visitor<T>) => T;
908
670
  }
909
671
  /**
910
- * <p>The claim in OIDC identity provider tokens that indicates a user's group membership, and
911
- * the entity type that you want to map it to. For example, this object can map the contents
912
- * of a <code>groups</code> claim to <code>MyCorp::UserGroup</code>.</p>
913
- * <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectConfigurationDetail.html">OpenIdConnectConfigurationDetail</a> structure, which is a parameter of <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html">GetIdentitySource</a>.</p>
672
+ * <p>The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a <code>groups</code> claim to <code>MyCorp::UserGroup</code>.</p> <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectConfigurationDetail.html">OpenIdConnectConfigurationDetail</a> structure, which is a parameter of <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html">GetIdentitySource</a>.</p>
914
673
  * @public
915
674
  */
916
675
  export interface OpenIdConnectGroupConfigurationDetail {
917
676
  /**
918
- * <p>The token claim that you want Verified Permissions to interpret as group membership. For example,
919
- * <code>groups</code>.</p>
677
+ * <p>The token claim that you want Verified Permissions to interpret as group membership. For example, <code>groups</code>.</p>
920
678
  * @public
921
679
  */
922
680
  groupClaim: string | undefined;
923
681
  /**
924
- * <p>The policy store entity type that you want to map your users' group claim to. For example,
925
- * <code>MyCorp::UserGroup</code>. A group entity type is an entity that can have a user
926
- * entity type as a member.</p>
682
+ * <p>The policy store entity type that you want to map your users' group claim to. For example, <code>MyCorp::UserGroup</code>. A group entity type is an entity that can have a user entity type as a member.</p>
927
683
  * @public
928
684
  */
929
685
  groupEntityType: string | undefined;
930
686
  }
931
687
  /**
932
- * <p>The configuration of an OpenID Connect (OIDC) identity source for handling access token
933
- * claims. Contains the claim that you want to identify as the principal in an authorization
934
- * request, and the values of the <code>aud</code> claim, or audiences, that you want to
935
- * accept.</p>
936
- * <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectTokenSelectionDetail.html">OpenIdConnectTokenSelectionDetail</a> structure, which is a parameter of <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html">GetIdentitySource</a>.</p>
688
+ * <p>The configuration of an OpenID Connect (OIDC) identity source for handling access token claims. Contains the claim that you want to identify as the principal in an authorization request, and the values of the <code>aud</code> claim, or audiences, that you want to accept.</p> <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectTokenSelectionDetail.html">OpenIdConnectTokenSelectionDetail</a> structure, which is a parameter of <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html">GetIdentitySource</a>.</p>
937
689
  * @public
938
690
  */
939
691
  export interface OpenIdConnectAccessTokenConfigurationDetail {
940
692
  /**
941
- * <p>The claim that determines the principal in OIDC access tokens. For example,
942
- * <code>sub</code>.</p>
693
+ * <p>The claim that determines the principal in OIDC access tokens. For example, <code>sub</code>.</p>
943
694
  * @public
944
695
  */
945
696
  principalIdClaim?: string | undefined;
946
697
  /**
947
- * <p>The access token <code>aud</code> claim values that you want to accept in your policy
948
- * store. For example, <code>https://myapp.example.com, https://myapp2.example.com</code>.</p>
698
+ * <p>The access token <code>aud</code> claim values that you want to accept in your policy store. For example, <code>https://myapp.example.com, https://myapp2.example.com</code>.</p>
949
699
  * @public
950
700
  */
951
701
  audiences?: string[] | undefined;
952
702
  }
953
703
  /**
954
- * <p>The configuration of an OpenID Connect (OIDC) identity source for handling identity
955
- * (ID) token claims. Contains the claim that you want to identify as the principal in an
956
- * authorization request, and the values of the <code>aud</code> claim, or audiences, that
957
- * you want to accept.</p>
958
- * <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectTokenSelectionDetail.html">OpenIdConnectTokenSelectionDetail</a> structure, which is a parameter of <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html">GetIdentitySource</a>.</p>
704
+ * <p>The configuration of an OpenID Connect (OIDC) identity source for handling identity (ID) token claims. Contains the claim that you want to identify as the principal in an authorization request, and the values of the <code>aud</code> claim, or audiences, that you want to accept.</p> <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectTokenSelectionDetail.html">OpenIdConnectTokenSelectionDetail</a> structure, which is a parameter of <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html">GetIdentitySource</a>.</p>
959
705
  * @public
960
706
  */
961
707
  export interface OpenIdConnectIdentityTokenConfigurationDetail {
962
708
  /**
963
- * <p>The claim that determines the principal in OIDC access tokens. For example,
964
- * <code>sub</code>.</p>
709
+ * <p>The claim that determines the principal in OIDC access tokens. For example, <code>sub</code>.</p>
965
710
  * @public
966
711
  */
967
712
  principalIdClaim?: string | undefined;
968
713
  /**
969
- * <p>The ID token audience, or client ID, claim values that you want to accept in your policy
970
- * store from an OIDC identity provider. For example, <code>1example23456789,
971
- * 2example10111213</code>.</p>
714
+ * <p>The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider. For example, <code>1example23456789, 2example10111213</code>.</p>
972
715
  * @public
973
716
  */
974
717
  clientIds?: string[] | undefined;
975
718
  }
976
719
  /**
977
- * <p>The token type that you want to process from your OIDC identity provider. Your policy
978
- * store can process either identity (ID) or access tokens from a given OIDC identity
979
- * source.</p>
980
- * <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectConfigurationDetail.html">OpenIdConnectConfigurationDetail</a> structure, which is a parameter of <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html">GetIdentitySource</a>.</p>
720
+ * <p>The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.</p> <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectConfigurationDetail.html">OpenIdConnectConfigurationDetail</a> structure, which is a parameter of <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html">GetIdentitySource</a>.</p>
981
721
  * @public
982
722
  */
983
723
  export type OpenIdConnectTokenSelectionDetail = OpenIdConnectTokenSelectionDetail.AccessTokenOnlyMember | OpenIdConnectTokenSelectionDetail.IdentityTokenOnlyMember | OpenIdConnectTokenSelectionDetail.$UnknownMember;
@@ -986,9 +726,7 @@ export type OpenIdConnectTokenSelectionDetail = OpenIdConnectTokenSelectionDetai
986
726
  */
987
727
  export declare namespace OpenIdConnectTokenSelectionDetail {
988
728
  /**
989
- * <p>The OIDC configuration for processing access tokens. Contains allowed audience claims,
990
- * for example <code>https://auth.example.com</code>, and the claim that you want to map to the
991
- * principal, for example <code>sub</code>.</p>
729
+ * <p>The OIDC configuration for processing access tokens. Contains allowed audience claims, for example <code>https://auth.example.com</code>, and the claim that you want to map to the principal, for example <code>sub</code>.</p>
992
730
  * @public
993
731
  */
994
732
  interface AccessTokenOnlyMember {
@@ -997,9 +735,7 @@ export declare namespace OpenIdConnectTokenSelectionDetail {
997
735
  $unknown?: never;
998
736
  }
999
737
  /**
1000
- * <p>The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID
1001
- * claims, for example <code>1example23456789</code>, and the claim that you want to map to
1002
- * the principal, for example <code>sub</code>.</p>
738
+ * <p>The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID claims, for example <code>1example23456789</code>, and the claim that you want to map to the principal, for example <code>sub</code>.</p>
1003
739
  * @public
1004
740
  */
1005
741
  interface IdentityTokenOnlyMember {
@@ -1023,48 +759,33 @@ export declare namespace OpenIdConnectTokenSelectionDetail {
1023
759
  const visit: <T>(value: OpenIdConnectTokenSelectionDetail, visitor: Visitor<T>) => T;
1024
760
  }
1025
761
  /**
1026
- * <p>Contains configuration details of an OpenID Connect (OIDC) identity provider, or
1027
- * identity source, that Verified Permissions can use to generate entities from authenticated identities. It
1028
- * specifies the issuer URL, token type that you want to use, and policy store entity
1029
- * details.</p>
1030
- * <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ConfigurationDetail.html">ConfigurationDetail</a>
1031
- * structure, which is a parameter to <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html">GetIdentitySource</a>.</p>
762
+ * <p>Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details.</p> <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ConfigurationDetail.html">ConfigurationDetail</a> structure, which is a parameter to <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html">GetIdentitySource</a>.</p>
1032
763
  * @public
1033
764
  */
1034
765
  export interface OpenIdConnectConfigurationDetail {
1035
766
  /**
1036
- * <p>The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery
1037
- * endpoint at the path <code>.well-known/openid-configuration</code>.</p>
767
+ * <p>The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path <code>.well-known/openid-configuration</code>.</p>
1038
768
  * @public
1039
769
  */
1040
770
  issuer: string | undefined;
1041
771
  /**
1042
- * <p>A descriptive string that you want to prefix to user entities from your OIDC identity
1043
- * provider. For example, if you set an <code>entityIdPrefix</code> of
1044
- * <code>MyOIDCProvider</code>, you can reference principals in your policies in the format
1045
- * <code>MyCorp::User::MyOIDCProvider|Carlos</code>.</p>
772
+ * <p>A descriptive string that you want to prefix to user entities from your OIDC identity provider. For example, if you set an <code>entityIdPrefix</code> of <code>MyOIDCProvider</code>, you can reference principals in your policies in the format <code>MyCorp::User::MyOIDCProvider|Carlos</code>.</p>
1046
773
  * @public
1047
774
  */
1048
775
  entityIdPrefix?: string | undefined;
1049
776
  /**
1050
- * <p>The claim in OIDC identity provider tokens that indicates a user's group membership, and
1051
- * the entity type that you want to map it to. For example, this object can map the contents
1052
- * of a <code>groups</code> claim to <code>MyCorp::UserGroup</code>.</p>
777
+ * <p>The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a <code>groups</code> claim to <code>MyCorp::UserGroup</code>.</p>
1053
778
  * @public
1054
779
  */
1055
780
  groupConfiguration?: OpenIdConnectGroupConfigurationDetail | undefined;
1056
781
  /**
1057
- * <p>The token type that you want to process from your OIDC identity provider. Your policy
1058
- * store can process either identity (ID) or access tokens from a given OIDC identity
1059
- * source.</p>
782
+ * <p>The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.</p>
1060
783
  * @public
1061
784
  */
1062
785
  tokenSelection: OpenIdConnectTokenSelectionDetail | undefined;
1063
786
  }
1064
787
  /**
1065
- * <p>Contains configuration information about an identity source.</p>
1066
- * <p>This data type is a response parameter to the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html">GetIdentitySource</a>
1067
- * operation.</p>
788
+ * <p>Contains configuration information about an identity source.</p> <p>This data type is a response parameter to the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html">GetIdentitySource</a> operation.</p>
1068
789
  * @public
1069
790
  */
1070
791
  export type ConfigurationDetail = ConfigurationDetail.CognitoUserPoolConfigurationMember | ConfigurationDetail.OpenIdConnectConfigurationMember | ConfigurationDetail.$UnknownMember;
@@ -1073,15 +794,7 @@ export type ConfigurationDetail = ConfigurationDetail.CognitoUserPoolConfigurati
1073
794
  */
1074
795
  export declare namespace ConfigurationDetail {
1075
796
  /**
1076
- * <p>Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of
1077
- * 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,
1078
- * the policy store entity that you want to assign to user groups, and one or more
1079
- * application client IDs.</p>
1080
- * <p>Example:
1081
- * <code>"configuration":\{"cognitoUserPoolConfiguration":\{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds":
1082
- * ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": \{"groupEntityType":
1083
- * "MyCorp::Group"\}\}\}</code>
1084
- * </p>
797
+ * <p>Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of 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, the policy store entity that you want to assign to user groups, and one or more application client IDs.</p> <p>Example: <code>"configuration":\{"cognitoUserPoolConfiguration":\{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds": ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": \{"groupEntityType": "MyCorp::Group"\}\}\}</code> </p>
1085
798
  * @public
1086
799
  */
1087
800
  interface CognitoUserPoolConfigurationMember {
@@ -1090,12 +803,7 @@ export declare namespace ConfigurationDetail {
1090
803
  $unknown?: never;
1091
804
  }
1092
805
  /**
1093
- * <p>Contains configuration details of an OpenID Connect (OIDC) identity provider, or
1094
- * identity source, that Verified Permissions can use to generate entities from authenticated identities. It
1095
- * specifies the issuer URL, token type that you want to use, and policy store entity
1096
- * details.</p>
1097
- * <p>Example:<code>"configuration":\{"openIdConnectConfiguration":\{"issuer":"https://auth.example.com","tokenSelection":\{"accessTokenOnly":\{"audiences":["https://myapp.example.com","https://myapp2.example.com"],"principalIdClaim":"sub"\}\},"entityIdPrefix":"MyOIDCProvider","groupConfiguration":\{"groupClaim":"groups","groupEntityType":"MyCorp::UserGroup"\}\}\}</code>
1098
- * </p>
806
+ * <p>Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details.</p> <p>Example:<code>"configuration":\{"openIdConnectConfiguration":\{"issuer":"https://auth.example.com","tokenSelection":\{"accessTokenOnly":\{"audiences":["https://myapp.example.com","https://myapp2.example.com"],"principalIdClaim":"sub"\}\},"entityIdPrefix":"MyOIDCProvider","groupConfiguration":\{"groupClaim":"groups","groupEntityType":"MyCorp::UserGroup"\}\}\}</code> </p>
1099
807
  * @public
1100
808
  */
1101
809
  interface OpenIdConnectConfigurationMember {
@@ -1119,77 +827,55 @@ export declare namespace ConfigurationDetail {
1119
827
  const visit: <T>(value: ConfigurationDetail, visitor: Visitor<T>) => T;
1120
828
  }
1121
829
  /**
1122
- * <p>The claim in OIDC identity provider tokens that indicates a user's group membership, and
1123
- * the entity type that you want to map it to. For example, this object can map the contents
1124
- * of a <code>groups</code> claim to <code>MyCorp::UserGroup</code>.</p>
1125
- * <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectConfigurationItem.html">OpenIdConnectConfigurationItem</a> structure, which is a parameter of <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html">ListIdentitySourcea</a>.</p>
830
+ * <p>The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a <code>groups</code> claim to <code>MyCorp::UserGroup</code>.</p> <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectConfigurationItem.html">OpenIdConnectConfigurationItem</a> structure, which is a parameter of <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html">ListIdentitySourcea</a>.</p>
1126
831
  * @public
1127
832
  */
1128
833
  export interface OpenIdConnectGroupConfigurationItem {
1129
834
  /**
1130
- * <p>The token claim that you want Verified Permissions to interpret as group membership. For example,
1131
- * <code>groups</code>.</p>
835
+ * <p>The token claim that you want Verified Permissions to interpret as group membership. For example, <code>groups</code>.</p>
1132
836
  * @public
1133
837
  */
1134
838
  groupClaim: string | undefined;
1135
839
  /**
1136
- * <p>The policy store entity type that you want to map your users' group claim to. For example,
1137
- * <code>MyCorp::UserGroup</code>. A group entity type is an entity that can have a user
1138
- * entity type as a member.</p>
840
+ * <p>The policy store entity type that you want to map your users' group claim to. For example, <code>MyCorp::UserGroup</code>. A group entity type is an entity that can have a user entity type as a member.</p>
1139
841
  * @public
1140
842
  */
1141
843
  groupEntityType: string | undefined;
1142
844
  }
1143
845
  /**
1144
- * <p>The configuration of an OpenID Connect (OIDC) identity source for handling access token
1145
- * claims. Contains the claim that you want to identify as the principal in an authorization
1146
- * request, and the values of the <code>aud</code> claim, or audiences, that you want to
1147
- * accept.</p>
1148
- * <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectTokenSelectionItem.html">OpenIdConnectTokenSelectionItem</a> structure, which is a parameter of <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html">ListIdentitySources</a>.</p>
846
+ * <p>The configuration of an OpenID Connect (OIDC) identity source for handling access token claims. Contains the claim that you want to identify as the principal in an authorization request, and the values of the <code>aud</code> claim, or audiences, that you want to accept.</p> <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectTokenSelectionItem.html">OpenIdConnectTokenSelectionItem</a> structure, which is a parameter of <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html">ListIdentitySources</a>.</p>
1149
847
  * @public
1150
848
  */
1151
849
  export interface OpenIdConnectAccessTokenConfigurationItem {
1152
850
  /**
1153
- * <p>The claim that determines the principal in OIDC access tokens. For example,
1154
- * <code>sub</code>.</p>
851
+ * <p>The claim that determines the principal in OIDC access tokens. For example, <code>sub</code>.</p>
1155
852
  * @public
1156
853
  */
1157
854
  principalIdClaim?: string | undefined;
1158
855
  /**
1159
- * <p>The access token <code>aud</code> claim values that you want to accept in your policy
1160
- * store. For example, <code>https://myapp.example.com, https://myapp2.example.com</code>.</p>
856
+ * <p>The access token <code>aud</code> claim values that you want to accept in your policy store. For example, <code>https://myapp.example.com, https://myapp2.example.com</code>.</p>
1161
857
  * @public
1162
858
  */
1163
859
  audiences?: string[] | undefined;
1164
860
  }
1165
861
  /**
1166
- * <p>The configuration of an OpenID Connect (OIDC) identity source for handling identity
1167
- * (ID) token claims. Contains the claim that you want to identify as the principal in an
1168
- * authorization request, and the values of the <code>aud</code> claim, or audiences, that
1169
- * you want to accept.</p>
1170
- * <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectTokenSelectionItem.html">OpenIdConnectTokenSelectionItem</a> structure, which is a parameter of <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html">ListIdentitySources</a>.</p>
862
+ * <p>The configuration of an OpenID Connect (OIDC) identity source for handling identity (ID) token claims. Contains the claim that you want to identify as the principal in an authorization request, and the values of the <code>aud</code> claim, or audiences, that you want to accept.</p> <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectTokenSelectionItem.html">OpenIdConnectTokenSelectionItem</a> structure, which is a parameter of <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html">ListIdentitySources</a>.</p>
1171
863
  * @public
1172
864
  */
1173
865
  export interface OpenIdConnectIdentityTokenConfigurationItem {
1174
866
  /**
1175
- * <p>The claim that determines the principal in OIDC access tokens. For example,
1176
- * <code>sub</code>.</p>
867
+ * <p>The claim that determines the principal in OIDC access tokens. For example, <code>sub</code>.</p>
1177
868
  * @public
1178
869
  */
1179
870
  principalIdClaim?: string | undefined;
1180
871
  /**
1181
- * <p>The ID token audience, or client ID, claim values that you want to accept in your policy
1182
- * store from an OIDC identity provider. For example, <code>1example23456789,
1183
- * 2example10111213</code>.</p>
872
+ * <p>The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider. For example, <code>1example23456789, 2example10111213</code>.</p>
1184
873
  * @public
1185
874
  */
1186
875
  clientIds?: string[] | undefined;
1187
876
  }
1188
877
  /**
1189
- * <p>The token type that you want to process from your OIDC identity provider. Your policy
1190
- * store can process either identity (ID) or access tokens from a given OIDC identity
1191
- * source.</p>
1192
- * <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectConfigurationItem.html">OpenIdConnectConfigurationItem</a> structure, which is a parameter of <a href="http://amazonaws.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html">ListIdentitySources</a>.</p>
878
+ * <p>The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.</p> <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_OpenIdConnectConfigurationItem.html">OpenIdConnectConfigurationItem</a> structure, which is a parameter of <a href="http://amazonaws.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html">ListIdentitySources</a>.</p>
1193
879
  * @public
1194
880
  */
1195
881
  export type OpenIdConnectTokenSelectionItem = OpenIdConnectTokenSelectionItem.AccessTokenOnlyMember | OpenIdConnectTokenSelectionItem.IdentityTokenOnlyMember | OpenIdConnectTokenSelectionItem.$UnknownMember;
@@ -1198,9 +884,7 @@ export type OpenIdConnectTokenSelectionItem = OpenIdConnectTokenSelectionItem.Ac
1198
884
  */
1199
885
  export declare namespace OpenIdConnectTokenSelectionItem {
1200
886
  /**
1201
- * <p>The OIDC configuration for processing access tokens. Contains allowed audience claims,
1202
- * for example <code>https://auth.example.com</code>, and the claim that you want to map to the
1203
- * principal, for example <code>sub</code>.</p>
887
+ * <p>The OIDC configuration for processing access tokens. Contains allowed audience claims, for example <code>https://auth.example.com</code>, and the claim that you want to map to the principal, for example <code>sub</code>.</p>
1204
888
  * @public
1205
889
  */
1206
890
  interface AccessTokenOnlyMember {
@@ -1209,9 +893,7 @@ export declare namespace OpenIdConnectTokenSelectionItem {
1209
893
  $unknown?: never;
1210
894
  }
1211
895
  /**
1212
- * <p>The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID
1213
- * claims, for example <code>1example23456789</code>, and the claim that you want to map to
1214
- * the principal, for example <code>sub</code>.</p>
896
+ * <p>The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID claims, for example <code>1example23456789</code>, and the claim that you want to map to the principal, for example <code>sub</code>.</p>
1215
897
  * @public
1216
898
  */
1217
899
  interface IdentityTokenOnlyMember {
@@ -1235,48 +917,33 @@ export declare namespace OpenIdConnectTokenSelectionItem {
1235
917
  const visit: <T>(value: OpenIdConnectTokenSelectionItem, visitor: Visitor<T>) => T;
1236
918
  }
1237
919
  /**
1238
- * <p>Contains configuration details of an OpenID Connect (OIDC) identity provider, or
1239
- * identity source, that Verified Permissions can use to generate entities from authenticated identities. It
1240
- * specifies the issuer URL, token type that you want to use, and policy store entity
1241
- * details.</p>
1242
- * <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ConfigurationDetail.html">ConfigurationItem</a>
1243
- * structure, which is a parameter to <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html">ListIdentitySources</a>.</p>
920
+ * <p>Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details.</p> <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ConfigurationDetail.html">ConfigurationItem</a> structure, which is a parameter to <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html">ListIdentitySources</a>.</p>
1244
921
  * @public
1245
922
  */
1246
923
  export interface OpenIdConnectConfigurationItem {
1247
924
  /**
1248
- * <p>The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery
1249
- * endpoint at the path <code>.well-known/openid-configuration</code>.</p>
925
+ * <p>The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path <code>.well-known/openid-configuration</code>.</p>
1250
926
  * @public
1251
927
  */
1252
928
  issuer: string | undefined;
1253
929
  /**
1254
- * <p>A descriptive string that you want to prefix to user entities from your OIDC identity
1255
- * provider. For example, if you set an <code>entityIdPrefix</code> of
1256
- * <code>MyOIDCProvider</code>, you can reference principals in your policies in the format
1257
- * <code>MyCorp::User::MyOIDCProvider|Carlos</code>.</p>
930
+ * <p>A descriptive string that you want to prefix to user entities from your OIDC identity provider. For example, if you set an <code>entityIdPrefix</code> of <code>MyOIDCProvider</code>, you can reference principals in your policies in the format <code>MyCorp::User::MyOIDCProvider|Carlos</code>.</p>
1258
931
  * @public
1259
932
  */
1260
933
  entityIdPrefix?: string | undefined;
1261
934
  /**
1262
- * <p>The claim in OIDC identity provider tokens that indicates a user's group membership, and
1263
- * the entity type that you want to map it to. For example, this object can map the contents
1264
- * of a <code>groups</code> claim to <code>MyCorp::UserGroup</code>.</p>
935
+ * <p>The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a <code>groups</code> claim to <code>MyCorp::UserGroup</code>.</p>
1265
936
  * @public
1266
937
  */
1267
938
  groupConfiguration?: OpenIdConnectGroupConfigurationItem | undefined;
1268
939
  /**
1269
- * <p>The token type that you want to process from your OIDC identity provider. Your policy
1270
- * store can process either identity (ID) or access tokens from a given OIDC identity
1271
- * source.</p>
940
+ * <p>The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.</p>
1272
941
  * @public
1273
942
  */
1274
943
  tokenSelection: OpenIdConnectTokenSelectionItem | undefined;
1275
944
  }
1276
945
  /**
1277
- * <p>Contains configuration information about an identity source.</p>
1278
- * <p>This data type is a response parameter to the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html">ListIdentitySources</a>
1279
- * operation.</p>
946
+ * <p>Contains configuration information about an identity source.</p> <p>This data type is a response parameter to the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html">ListIdentitySources</a> operation.</p>
1280
947
  * @public
1281
948
  */
1282
949
  export type ConfigurationItem = ConfigurationItem.CognitoUserPoolConfigurationMember | ConfigurationItem.OpenIdConnectConfigurationMember | ConfigurationItem.$UnknownMember;
@@ -1285,15 +952,7 @@ export type ConfigurationItem = ConfigurationItem.CognitoUserPoolConfigurationMe
1285
952
  */
1286
953
  export declare namespace ConfigurationItem {
1287
954
  /**
1288
- * <p>Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of
1289
- * 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,
1290
- * the policy store entity that you want to assign to user groups, and one or more
1291
- * application client IDs.</p>
1292
- * <p>Example:
1293
- * <code>"configuration":\{"cognitoUserPoolConfiguration":\{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds":
1294
- * ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": \{"groupEntityType":
1295
- * "MyCorp::Group"\}\}\}</code>
1296
- * </p>
955
+ * <p>Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of 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, the policy store entity that you want to assign to user groups, and one or more application client IDs.</p> <p>Example: <code>"configuration":\{"cognitoUserPoolConfiguration":\{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds": ["a1b2c3d4e5f6g7h8i9j0kalbmc"],"groupConfiguration": \{"groupEntityType": "MyCorp::Group"\}\}\}</code> </p>
1297
956
  * @public
1298
957
  */
1299
958
  interface CognitoUserPoolConfigurationMember {
@@ -1302,12 +961,7 @@ export declare namespace ConfigurationItem {
1302
961
  $unknown?: never;
1303
962
  }
1304
963
  /**
1305
- * <p>Contains configuration details of an OpenID Connect (OIDC) identity provider, or
1306
- * identity source, that Verified Permissions can use to generate entities from authenticated identities. It
1307
- * specifies the issuer URL, token type that you want to use, and policy store entity
1308
- * details.</p>
1309
- * <p>Example:<code>"configuration":\{"openIdConnectConfiguration":\{"issuer":"https://auth.example.com","tokenSelection":\{"accessTokenOnly":\{"audiences":["https://myapp.example.com","https://myapp2.example.com"],"principalIdClaim":"sub"\}\},"entityIdPrefix":"MyOIDCProvider","groupConfiguration":\{"groupClaim":"groups","groupEntityType":"MyCorp::UserGroup"\}\}\}</code>
1310
- * </p>
964
+ * <p>Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details.</p> <p>Example:<code>"configuration":\{"openIdConnectConfiguration":\{"issuer":"https://auth.example.com","tokenSelection":\{"accessTokenOnly":\{"audiences":["https://myapp.example.com","https://myapp2.example.com"],"principalIdClaim":"sub"\}\},"entityIdPrefix":"MyOIDCProvider","groupConfiguration":\{"groupClaim":"groups","groupEntityType":"MyCorp::UserGroup"\}\}\}</code> </p>
1311
965
  * @public
1312
966
  */
1313
967
  interface OpenIdConnectConfigurationMember {
@@ -1347,8 +1001,7 @@ export interface ResourceConflict {
1347
1001
  resourceType: ResourceType | undefined;
1348
1002
  }
1349
1003
  /**
1350
- * <p>The request failed because another request to modify a resource occurred at the
1351
- * same.</p>
1004
+ * <p>The request failed because another request to modify a resource occurred at the same.</p>
1352
1005
  * @public
1353
1006
  */
1354
1007
  export declare class ConflictException extends __BaseException {
@@ -1369,39 +1022,22 @@ export declare class ConflictException extends __BaseException {
1369
1022
  */
1370
1023
  export interface CreateIdentitySourceInput {
1371
1024
  /**
1372
- * <p>Specifies a unique, case-sensitive ID that you provide to
1373
- * ensure the idempotency of the request. This lets you safely retry the request without
1374
- * accidentally performing the same operation a second time. Passing the same value to a
1375
- * later call to an operation requires that you also pass the same value for all other
1376
- * parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of
1377
- * value.</a>.</p>
1378
- * <p>If you don't provide this value, then Amazon Web Services generates a random one for
1379
- * you.</p>
1380
- * <p>If you retry the operation with the same <code>ClientToken</code>, but with
1381
- * different parameters, the retry fails with an <code>ConflictException</code>
1382
- * error.</p>
1383
- * <p>Verified Permissions recognizes a <code>ClientToken</code> for eight hours. After eight hours,
1384
- * the next request with the same parameters performs the operation again regardless of
1385
- * the value of <code>ClientToken</code>.</p>
1025
+ * <p>Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of value.</a>.</p> <p>If you don't provide this value, then Amazon Web Services generates a random one for you.</p> <p>If you retry the operation with the same <code>ClientToken</code>, but with different parameters, the retry fails with an <code>ConflictException</code> error.</p> <p>Verified Permissions recognizes a <code>ClientToken</code> for eight hours. After eight hours, the next request with the same parameters performs the operation again regardless of the value of <code>ClientToken</code>.</p>
1386
1026
  * @public
1387
1027
  */
1388
1028
  clientToken?: string | undefined;
1389
1029
  /**
1390
- * <p>Specifies the ID of the policy store in which you want to store this identity source. Only policies and
1391
- * requests made using this policy store can reference identities from the identity provider
1392
- * configured in the new identity source.</p>
1030
+ * <p>Specifies the ID of the policy store in which you want to store this identity source. Only policies and requests made using this policy store can reference identities from the identity provider configured in the new identity source.</p>
1393
1031
  * @public
1394
1032
  */
1395
1033
  policyStoreId: string | undefined;
1396
1034
  /**
1397
- * <p>Specifies the details required to communicate with the identity provider (IdP)
1398
- * associated with this identity source.</p>
1035
+ * <p>Specifies the details required to communicate with the identity provider (IdP) associated with this identity source.</p>
1399
1036
  * @public
1400
1037
  */
1401
1038
  configuration: Configuration | undefined;
1402
1039
  /**
1403
- * <p>Specifies the namespace and data type of the principals generated for identities
1404
- * authenticated by the new identity source.</p>
1040
+ * <p>Specifies the namespace and data type of the principals generated for identities authenticated by the new identity source.</p>
1405
1041
  * @public
1406
1042
  */
1407
1043
  principalEntityType?: string | undefined;
@@ -1464,9 +1100,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
1464
1100
  constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
1465
1101
  }
1466
1102
  /**
1467
- * <p>Contains information about a static policy.</p>
1468
- * <p>This data type is used as a field that is part of the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_PolicyDefinitionDetail.html">PolicyDefinitionDetail</a>
1469
- * type.</p>
1103
+ * <p>Contains information about a static policy.</p> <p>This data type is used as a field that is part of the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_PolicyDefinitionDetail.html">PolicyDefinitionDetail</a> type.</p>
1470
1104
  * @public
1471
1105
  */
1472
1106
  export interface StaticPolicyDefinition {
@@ -1492,27 +1126,18 @@ export interface TemplateLinkedPolicyDefinition {
1492
1126
  */
1493
1127
  policyTemplateId: string | undefined;
1494
1128
  /**
1495
- * <p>The principal associated with this template-linked policy. Verified Permissions substitutes this principal for the
1496
- * <code>?principal</code> placeholder in the policy template when it evaluates an authorization
1497
- * request.</p>
1129
+ * <p>The principal associated with this template-linked policy. Verified Permissions substitutes this principal for the <code>?principal</code> placeholder in the policy template when it evaluates an authorization request.</p>
1498
1130
  * @public
1499
1131
  */
1500
1132
  principal?: EntityIdentifier | undefined;
1501
1133
  /**
1502
- * <p>The resource associated with this template-linked policy. Verified Permissions substitutes this resource for the
1503
- * <code>?resource</code> placeholder in the policy template when it evaluates an authorization
1504
- * request.</p>
1134
+ * <p>The resource associated with this template-linked policy. Verified Permissions substitutes this resource for the <code>?resource</code> placeholder in the policy template when it evaluates an authorization request.</p>
1505
1135
  * @public
1506
1136
  */
1507
1137
  resource?: EntityIdentifier | undefined;
1508
1138
  }
1509
1139
  /**
1510
- * <p>A structure that contains the details for a Cedar policy definition. It includes the
1511
- * policy type, a description, and a policy body. This is a top level data type used to
1512
- * create a policy.</p>
1513
- * <p>This data type is used as a request parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html">CreatePolicy</a> operation. This
1514
- * structure must always have either an <code>static</code> or a <code>templateLinked</code>
1515
- * element.</p>
1140
+ * <p>A structure that contains the details for a Cedar policy definition. It includes the policy type, a description, and a policy body. This is a top level data type used to create a policy.</p> <p>This data type is used as a request parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html">CreatePolicy</a> operation. This structure must always have either an <code>static</code> or a <code>templateLinked</code> element.</p>
1516
1141
  * @public
1517
1142
  */
1518
1143
  export type PolicyDefinition = PolicyDefinition.StaticMember | PolicyDefinition.TemplateLinkedMember | PolicyDefinition.$UnknownMember;
@@ -1521,8 +1146,7 @@ export type PolicyDefinition = PolicyDefinition.StaticMember | PolicyDefinition.
1521
1146
  */
1522
1147
  export declare namespace PolicyDefinition {
1523
1148
  /**
1524
- * <p>A structure that describes a static policy. An static policy doesn't use a template or allow
1525
- * placeholders for entities.</p>
1149
+ * <p>A structure that describes a static policy. An static policy doesn't use a template or allow placeholders for entities.</p>
1526
1150
  * @public
1527
1151
  */
1528
1152
  interface StaticMember {
@@ -1531,10 +1155,7 @@ export declare namespace PolicyDefinition {
1531
1155
  $unknown?: never;
1532
1156
  }
1533
1157
  /**
1534
- * <p>A structure that describes a policy that was instantiated from a template. The
1535
- * template can specify placeholders for <code>principal</code> and <code>resource</code>.
1536
- * 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
1537
- * principal and resource to use for the instantiated policy.</p>
1158
+ * <p>A structure that describes a policy that was instantiated from a template. The template can specify placeholders for <code>principal</code> and <code>resource</code>. 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 principal and resource to use for the instantiated policy.</p>
1538
1159
  * @public
1539
1160
  */
1540
1161
  interface TemplateLinkedMember {
@@ -1562,33 +1183,17 @@ export declare namespace PolicyDefinition {
1562
1183
  */
1563
1184
  export interface CreatePolicyInput {
1564
1185
  /**
1565
- * <p>Specifies a unique, case-sensitive ID that you provide to
1566
- * ensure the idempotency of the request. This lets you safely retry the request without
1567
- * accidentally performing the same operation a second time. Passing the same value to a
1568
- * later call to an operation requires that you also pass the same value for all other
1569
- * parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of
1570
- * value.</a>.</p>
1571
- * <p>If you don't provide this value, then Amazon Web Services generates a random one for
1572
- * you.</p>
1573
- * <p>If you retry the operation with the same <code>ClientToken</code>, but with
1574
- * different parameters, the retry fails with an <code>ConflictException</code>
1575
- * error.</p>
1576
- * <p>Verified Permissions recognizes a <code>ClientToken</code> for eight hours. After eight hours,
1577
- * the next request with the same parameters performs the operation again regardless of
1578
- * the value of <code>ClientToken</code>.</p>
1186
+ * <p>Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of value.</a>.</p> <p>If you don't provide this value, then Amazon Web Services generates a random one for you.</p> <p>If you retry the operation with the same <code>ClientToken</code>, but with different parameters, the retry fails with an <code>ConflictException</code> error.</p> <p>Verified Permissions recognizes a <code>ClientToken</code> for eight hours. After eight hours, the next request with the same parameters performs the operation again regardless of the value of <code>ClientToken</code>.</p>
1579
1187
  * @public
1580
1188
  */
1581
1189
  clientToken?: string | undefined;
1582
1190
  /**
1583
- * <p>Specifies the <code>PolicyStoreId</code> of the policy store you want to store the policy
1584
- * in.</p>
1191
+ * <p>Specifies the <code>PolicyStoreId</code> of the policy store you want to store the policy in.</p>
1585
1192
  * @public
1586
1193
  */
1587
1194
  policyStoreId: string | undefined;
1588
1195
  /**
1589
- * <p>A structure that specifies the policy type and content to use for the new policy. You
1590
- * must include either a static or a templateLinked element. The policy content must be written
1591
- * in the Cedar policy language.</p>
1196
+ * <p>A structure that specifies the policy type and content to use for the new policy. You must include either a static or a templateLinked element. The policy content must be written in the Cedar policy language.</p>
1592
1197
  * @public
1593
1198
  */
1594
1199
  definition: PolicyDefinition | undefined;
@@ -1625,21 +1230,17 @@ export interface CreatePolicyOutput {
1625
1230
  */
1626
1231
  policyType: PolicyType | undefined;
1627
1232
  /**
1628
- * <p>The principal specified in the new policy's scope. This response element isn't present
1629
- * when <code>principal</code> isn't specified in the policy content.</p>
1233
+ * <p>The principal specified in the new policy's scope. This response element isn't present when <code>principal</code> isn't specified in the policy content.</p>
1630
1234
  * @public
1631
1235
  */
1632
1236
  principal?: EntityIdentifier | undefined;
1633
1237
  /**
1634
- * <p>The resource specified in the new policy's scope. This response element isn't present
1635
- * when the <code>resource</code> isn't specified in the policy content.</p>
1238
+ * <p>The resource specified in the new policy's scope. This response element isn't present when the <code>resource</code> isn't specified in the policy content.</p>
1636
1239
  * @public
1637
1240
  */
1638
1241
  resource?: EntityIdentifier | undefined;
1639
1242
  /**
1640
- * <p>The action that a policy permits or forbids. For example,
1641
- * <code>\{"actions": [\{"actionId": "ViewPhoto", "actionType": "PhotoFlash::Action"\}, \{"entityID": "SharePhoto",
1642
- * "entityType": "PhotoFlash::Action"\}]\}</code>.</p>
1243
+ * <p>The action that a policy permits or forbids. For example, <code>\{"actions": [\{"actionId": "ViewPhoto", "actionType": "PhotoFlash::Action"\}, \{"entityID": "SharePhoto", "entityType": "PhotoFlash::Action"\}]\}</code>.</p>
1643
1244
  * @public
1644
1245
  */
1645
1246
  actions?: ActionIdentifier[] | undefined;
@@ -1654,8 +1255,7 @@ export interface CreatePolicyOutput {
1654
1255
  */
1655
1256
  lastUpdatedDate: Date | undefined;
1656
1257
  /**
1657
- * <p>The effect of the decision that a policy returns to an authorization
1658
- * request. For example, <code>"effect": "Permit"</code>.</p>
1258
+ * <p>The effect of the decision that a policy returns to an authorization request. For example, <code>"effect": "Permit"</code>.</p>
1659
1259
  * @public
1660
1260
  */
1661
1261
  effect?: PolicyEffect | undefined;
@@ -1685,35 +1285,12 @@ export declare const ValidationMode: {
1685
1285
  */
1686
1286
  export type ValidationMode = (typeof ValidationMode)[keyof typeof ValidationMode];
1687
1287
  /**
1688
- * <p>A structure that contains Cedar policy validation settings for the policy store. The
1689
- * validation mode determines which validation failures that Cedar considers serious
1690
- * enough to block acceptance of a new or edited static policy or policy template. </p>
1691
- * <p>This data type is used as a request parameter in the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicyStore.html">CreatePolicyStore</a> and <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicyStore.html">UpdatePolicyStore</a> operations.</p>
1288
+ * <p>A structure that contains Cedar policy validation settings for the policy store. The validation mode determines which validation failures that Cedar considers serious enough to block acceptance of a new or edited static policy or policy template. </p> <p>This data type is used as a request parameter in the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicyStore.html">CreatePolicyStore</a> and <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicyStore.html">UpdatePolicyStore</a> operations.</p>
1692
1289
  * @public
1693
1290
  */
1694
1291
  export interface ValidationSettings {
1695
1292
  /**
1696
- * <p>The validation mode currently configured for this policy store. The valid values are:</p>
1697
- * <ul>
1698
- * <li>
1699
- * <p>
1700
- * <b>OFF</b> – Neither Verified Permissions nor Cedar
1701
- * perform any validation on policies. No validation errors are reported by either
1702
- * service.</p>
1703
- * </li>
1704
- * <li>
1705
- * <p>
1706
- * <b>STRICT</b> – Requires a schema to be
1707
- * present in the policy store. Cedar performs validation on all submitted new or updated
1708
- * static policies and policy templates. Any that fail validation are rejected and Cedar doesn't store
1709
- * them in the policy store.</p>
1710
- * </li>
1711
- * </ul>
1712
- * <important>
1713
- * <p>If <code>Mode=STRICT</code> and the policy store doesn't contain a schema, Verified Permissions rejects
1714
- * all static policies and policy templates because there is no schema to validate against. </p>
1715
- * <p>To submit a static policy or policy template without a schema, you must turn off validation.</p>
1716
- * </important>
1293
+ * <p>The validation mode currently configured for this policy store. The valid values are:</p> <ul> <li> <p> <b>OFF</b> – Neither Verified Permissions nor Cedar perform any validation on policies. No validation errors are reported by either service.</p> </li> <li> <p> <b>STRICT</b> – Requires a schema to be present in the policy store. Cedar performs validation on all submitted new or updated static policies and policy templates. Any that fail validation are rejected and Cedar doesn't store them in the policy store.</p> </li> </ul> <important> <p>If <code>Mode=STRICT</code> and the policy store doesn't contain a schema, Verified Permissions rejects all static policies and policy templates because there is no schema to validate against. </p> <p>To submit a static policy or policy template without a schema, you must turn off validation.</p> </important>
1717
1294
  * @public
1718
1295
  */
1719
1296
  mode: ValidationMode | undefined;
@@ -1723,47 +1300,30 @@ export interface ValidationSettings {
1723
1300
  */
1724
1301
  export interface CreatePolicyStoreInput {
1725
1302
  /**
1726
- * <p>Specifies a unique, case-sensitive ID that you provide to
1727
- * ensure the idempotency of the request. This lets you safely retry the request without
1728
- * accidentally performing the same operation a second time. Passing the same value to a
1729
- * later call to an operation requires that you also pass the same value for all other
1730
- * parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of
1731
- * value.</a>.</p>
1732
- * <p>If you don't provide this value, then Amazon Web Services generates a random one for
1733
- * you.</p>
1734
- * <p>If you retry the operation with the same <code>ClientToken</code>, but with
1735
- * different parameters, the retry fails with an <code>ConflictException</code>
1736
- * error.</p>
1737
- * <p>Verified Permissions recognizes a <code>ClientToken</code> for eight hours. After eight hours,
1738
- * the next request with the same parameters performs the operation again regardless of
1739
- * the value of <code>ClientToken</code>.</p>
1303
+ * <p>Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of value.</a>.</p> <p>If you don't provide this value, then Amazon Web Services generates a random one for you.</p> <p>If you retry the operation with the same <code>ClientToken</code>, but with different parameters, the retry fails with an <code>ConflictException</code> error.</p> <p>Verified Permissions recognizes a <code>ClientToken</code> for eight hours. After eight hours, the next request with the same parameters performs the operation again regardless of the value of <code>ClientToken</code>.</p>
1740
1304
  * @public
1741
1305
  */
1742
1306
  clientToken?: string | undefined;
1743
1307
  /**
1744
- * <p>Specifies the validation setting for this policy store.</p>
1745
- * <p>Currently, the only valid and required value is <code>Mode</code>.</p>
1746
- * <important>
1747
- * <p>We recommend that you turn on <code>STRICT</code> mode only after you define a
1748
- * schema. If a schema doesn't exist, then <code>STRICT</code> mode causes any policy
1749
- * to fail validation, and Verified Permissions rejects the policy. You can turn off validation by
1750
- * using the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicyStore">UpdatePolicyStore</a>. Then, when you have a schema defined, use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicyStore">UpdatePolicyStore</a> again to turn validation back on.</p>
1751
- * </important>
1308
+ * <p>Specifies the validation setting for this policy store.</p> <p>Currently, the only valid and required value is <code>Mode</code>.</p> <important> <p>We recommend that you turn on <code>STRICT</code> mode only after you define a schema. If a schema doesn't exist, then <code>STRICT</code> mode causes any policy to fail validation, and Verified Permissions rejects the policy. You can turn off validation by using the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicyStore">UpdatePolicyStore</a>. Then, when you have a schema defined, use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicyStore">UpdatePolicyStore</a> again to turn validation back on.</p> </important>
1752
1309
  * @public
1753
1310
  */
1754
1311
  validationSettings: ValidationSettings | undefined;
1755
1312
  /**
1756
- * <p>Descriptive text that you can provide to help with identification
1757
- * of the current policy store.</p>
1313
+ * <p>Descriptive text that you can provide to help with identification of the current policy store.</p>
1758
1314
  * @public
1759
1315
  */
1760
1316
  description?: string | undefined;
1761
1317
  /**
1762
- * <p>Specifies whether the policy store can be deleted. If enabled, the policy store can't be deleted.</p>
1763
- * <p>The default state is <code>DISABLED</code>.</p>
1318
+ * <p>Specifies whether the policy store can be deleted. If enabled, the policy store can't be deleted.</p> <p>The default state is <code>DISABLED</code>.</p>
1764
1319
  * @public
1765
1320
  */
1766
1321
  deletionProtection?: DeletionProtection | undefined;
1322
+ /**
1323
+ * <p>The list of key-value pairs to associate with the policy store.</p>
1324
+ * @public
1325
+ */
1326
+ tags?: Record<string, string> | undefined;
1767
1327
  }
1768
1328
  /**
1769
1329
  * @public
@@ -1795,20 +1355,7 @@ export interface CreatePolicyStoreOutput {
1795
1355
  */
1796
1356
  export interface CreatePolicyTemplateInput {
1797
1357
  /**
1798
- * <p>Specifies a unique, case-sensitive ID that you provide to
1799
- * ensure the idempotency of the request. This lets you safely retry the request without
1800
- * accidentally performing the same operation a second time. Passing the same value to a
1801
- * later call to an operation requires that you also pass the same value for all other
1802
- * parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of
1803
- * value.</a>.</p>
1804
- * <p>If you don't provide this value, then Amazon Web Services generates a random one for
1805
- * you.</p>
1806
- * <p>If you retry the operation with the same <code>ClientToken</code>, but with
1807
- * different parameters, the retry fails with an <code>ConflictException</code>
1808
- * error.</p>
1809
- * <p>Verified Permissions recognizes a <code>ClientToken</code> for eight hours. After eight hours,
1810
- * the next request with the same parameters performs the operation again regardless of
1811
- * the value of <code>ClientToken</code>.</p>
1358
+ * <p>Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of value.</a>.</p> <p>If you don't provide this value, then Amazon Web Services generates a random one for you.</p> <p>If you retry the operation with the same <code>ClientToken</code>, but with different parameters, the retry fails with an <code>ConflictException</code> error.</p> <p>Verified Permissions recognizes a <code>ClientToken</code> for eight hours. After eight hours, the next request with the same parameters performs the operation again regardless of the value of <code>ClientToken</code>.</p>
1812
1359
  * @public
1813
1360
  */
1814
1361
  clientToken?: string | undefined;
@@ -1823,8 +1370,7 @@ export interface CreatePolicyTemplateInput {
1823
1370
  */
1824
1371
  description?: string | undefined;
1825
1372
  /**
1826
- * <p>Specifies the content that you want to use for the new policy template, written in the Cedar
1827
- * policy language.</p>
1373
+ * <p>Specifies the content that you want to use for the new policy template, written in the Cedar policy language.</p>
1828
1374
  * @public
1829
1375
  */
1830
1376
  statement: string | undefined;
@@ -1942,10 +1488,7 @@ export interface DeletePolicyTemplateInput {
1942
1488
  export interface DeletePolicyTemplateOutput {
1943
1489
  }
1944
1490
  /**
1945
- * <p>Contains information about a principal or resource that can be referenced in a Cedar
1946
- * policy.</p>
1947
- * <p>This data type is used as part of the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_PolicyFilter.html">PolicyFilter</a> structure that is
1948
- * used as a request parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicies.html">ListPolicies</a> operation..</p>
1491
+ * <p>Contains information about a principal or resource that can be referenced in a Cedar policy.</p> <p>This data type is used as part of the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_PolicyFilter.html">PolicyFilter</a> structure that is used as a request parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicies.html">ListPolicies</a> operation..</p>
1949
1492
  * @public
1950
1493
  */
1951
1494
  export type EntityReference = EntityReference.IdentifierMember | EntityReference.UnspecifiedMember | EntityReference.$UnknownMember;
@@ -1954,9 +1497,7 @@ export type EntityReference = EntityReference.IdentifierMember | EntityReference
1954
1497
  */
1955
1498
  export declare namespace EntityReference {
1956
1499
  /**
1957
- * <p>Used to indicate that a principal or resource is not specified. This can be used to
1958
- * search for policies that are not associated with a specific principal or
1959
- * resource.</p>
1500
+ * <p>Used to indicate that a principal or resource is not specified. This can be used to search for policies that are not associated with a specific principal or resource.</p>
1960
1501
  * @public
1961
1502
  */
1962
1503
  interface UnspecifiedMember {
@@ -1965,8 +1506,7 @@ export declare namespace EntityReference {
1965
1506
  $unknown?: never;
1966
1507
  }
1967
1508
  /**
1968
- * <p>The identifier of the entity. It can consist of either an EntityType and EntityId, a
1969
- * principal, or a resource.</p>
1509
+ * <p>The identifier of the entity. It can consist of either an EntityType and EntityId, a principal, or a resource.</p>
1970
1510
  * @public
1971
1511
  */
1972
1512
  interface IdentifierMember {
@@ -2016,46 +1556,35 @@ export declare const OpenIdIssuer: {
2016
1556
  */
2017
1557
  export type OpenIdIssuer = (typeof OpenIdIssuer)[keyof typeof OpenIdIssuer];
2018
1558
  /**
2019
- * <p>A structure that contains configuration of the identity source.</p>
2020
- * <p>This data type was a response parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html">GetIdentitySource</a> operation.
2021
- * Replaced by <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ConfigurationDetail.html">ConfigurationDetail</a>.</p>
1559
+ * <p>A structure that contains configuration of the identity source.</p> <p>This data type was a response parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_GetIdentitySource.html">GetIdentitySource</a> operation. Replaced by <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ConfigurationDetail.html">ConfigurationDetail</a>.</p>
2022
1560
  *
2023
1561
  * @deprecated This shape has been replaced by ConfigurationDetail
2024
1562
  * @public
2025
1563
  */
2026
1564
  export interface IdentitySourceDetails {
2027
1565
  /**
2028
- * <p>The application client IDs associated with the specified Amazon Cognito user pool that are
2029
- * enabled for this identity source.</p>
1566
+ * <p>The application client IDs associated with the specified Amazon Cognito user pool that are enabled for this identity source.</p>
2030
1567
  *
2031
1568
  * @deprecated
2032
1569
  * @public
2033
1570
  */
2034
1571
  clientIds?: string[] | undefined;
2035
1572
  /**
2036
- * <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
2037
- * policy store.</p>
1573
+ * <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 policy store.</p>
2038
1574
  *
2039
1575
  * @deprecated
2040
1576
  * @public
2041
1577
  */
2042
1578
  userPoolArn?: string | undefined;
2043
1579
  /**
2044
- * <p>The well-known URL that points to this user pool's OIDC discovery endpoint. This is a
2045
- * URL string in the following format. This URL replaces the placeholders for both the
2046
- * Amazon Web Services Region and the user pool identifier with those appropriate for this user
2047
- * pool.</p>
2048
- * <p>
2049
- * <code>https://cognito-idp.<i>&lt;region&gt;</i>.amazonaws.com/<i>&lt;user-pool-id&gt;</i>/.well-known/openid-configuration</code>
2050
- * </p>
1580
+ * <p>The well-known URL that points to this user pool's OIDC discovery endpoint. This is a URL string in the following format. This URL replaces the placeholders for both the Amazon Web Services Region and the user pool identifier with those appropriate for this user pool.</p> <p> <code>https://cognito-idp.<i>&lt;region&gt;</i>.amazonaws.com/<i>&lt;user-pool-id&gt;</i>/.well-known/openid-configuration</code> </p>
2051
1581
  *
2052
1582
  * @deprecated
2053
1583
  * @public
2054
1584
  */
2055
1585
  discoveryUrl?: string | undefined;
2056
1586
  /**
2057
- * <p>A string that identifies the type of OIDC service represented by this identity source. </p>
2058
- * <p>At this time, the only valid value is <code>cognito</code>.</p>
1587
+ * <p>A string that identifies the type of OIDC service represented by this identity source. </p> <p>At this time, the only valid value is <code>cognito</code>.</p>
2059
1588
  *
2060
1589
  * @deprecated
2061
1590
  * @public
@@ -2094,8 +1623,7 @@ export interface GetIdentitySourceOutput {
2094
1623
  */
2095
1624
  policyStoreId: string | undefined;
2096
1625
  /**
2097
- * <p>The data type of principals generated for identities authenticated by this
2098
- * identity source.</p>
1626
+ * <p>The data type of principals generated for identities authenticated by this identity source.</p>
2099
1627
  * @public
2100
1628
  */
2101
1629
  principalEntityType: string | undefined;
@@ -2110,8 +1638,7 @@ export interface GetIdentitySourceOutput {
2110
1638
  */
2111
1639
  export interface GetPolicyInput {
2112
1640
  /**
2113
- * <p>Specifies the ID of the policy store that contains the policy that you want information
2114
- * about.</p>
1641
+ * <p>Specifies the ID of the policy store that contains the policy that you want information about.</p>
2115
1642
  * @public
2116
1643
  */
2117
1644
  policyStoreId: string | undefined;
@@ -2141,21 +1668,17 @@ export interface GetPolicyOutput {
2141
1668
  */
2142
1669
  policyType: PolicyType | undefined;
2143
1670
  /**
2144
- * <p>The principal specified in the policy's scope. This element isn't included in the
2145
- * response when <code>Principal</code> isn't present in the policy content.</p>
1671
+ * <p>The principal specified in the policy's scope. This element isn't included in the response when <code>Principal</code> isn't present in the policy content.</p>
2146
1672
  * @public
2147
1673
  */
2148
1674
  principal?: EntityIdentifier | undefined;
2149
1675
  /**
2150
- * <p>The resource specified in the policy's scope. This element isn't included in the
2151
- * response when <code>Resource</code> isn't present in the policy content.</p>
1676
+ * <p>The resource specified in the policy's scope. This element isn't included in the response when <code>Resource</code> isn't present in the policy content.</p>
2152
1677
  * @public
2153
1678
  */
2154
1679
  resource?: EntityIdentifier | undefined;
2155
1680
  /**
2156
- * <p>The action that a policy permits or forbids. For example,
2157
- * <code>\{"actions": [\{"actionId": "ViewPhoto", "actionType": "PhotoFlash::Action"\}, \{"entityID": "SharePhoto",
2158
- * "entityType": "PhotoFlash::Action"\}]\}</code>.</p>
1681
+ * <p>The action that a policy permits or forbids. For example, <code>\{"actions": [\{"actionId": "ViewPhoto", "actionType": "PhotoFlash::Action"\}, \{"entityID": "SharePhoto", "entityType": "PhotoFlash::Action"\}]\}</code>.</p>
2159
1682
  * @public
2160
1683
  */
2161
1684
  actions?: ActionIdentifier[] | undefined;
@@ -2175,8 +1698,7 @@ export interface GetPolicyOutput {
2175
1698
  */
2176
1699
  lastUpdatedDate: Date | undefined;
2177
1700
  /**
2178
- * <p>The effect of the decision that a policy returns to an authorization
2179
- * request. For example, <code>"effect": "Permit"</code>.</p>
1701
+ * <p>The effect of the decision that a policy returns to an authorization request. For example, <code>"effect": "Permit"</code>.</p>
2180
1702
  * @public
2181
1703
  */
2182
1704
  effect?: PolicyEffect | undefined;
@@ -2190,6 +1712,11 @@ export interface GetPolicyStoreInput {
2190
1712
  * @public
2191
1713
  */
2192
1714
  policyStoreId: string | undefined;
1715
+ /**
1716
+ * <p>Specifies whether to return the tags that are attached to the policy store. If this parameter is included in the API call, the tags are returned, otherwise they are not returned.</p> <note> <p>If this parameter is included in the API call but there are no tags attached to the policy store, the <code>tags</code> response parameter is omitted from the response.</p> </note>
1717
+ * @public
1718
+ */
1719
+ tags?: boolean | undefined;
2193
1720
  }
2194
1721
  /**
2195
1722
  * @public
@@ -2221,25 +1748,32 @@ export interface GetPolicyStoreOutput {
2221
1748
  */
2222
1749
  lastUpdatedDate: Date | undefined;
2223
1750
  /**
2224
- * <p>Descriptive text that you can provide to help with identification
2225
- * of the current policy store.</p>
1751
+ * <p>Descriptive text that you can provide to help with identification of the current policy store.</p>
2226
1752
  * @public
2227
1753
  */
2228
1754
  description?: string | undefined;
2229
1755
  /**
2230
- * <p>Specifies whether the policy store can be deleted. If enabled, the policy store can't be deleted.</p>
2231
- * <p>The default state is <code>DISABLED</code>.</p>
1756
+ * <p>Specifies whether the policy store can be deleted. If enabled, the policy store can't be deleted.</p> <p>The default state is <code>DISABLED</code>.</p>
2232
1757
  * @public
2233
1758
  */
2234
1759
  deletionProtection?: DeletionProtection | undefined;
1760
+ /**
1761
+ * <p>The version of the Cedar language used with policies, policy templates, and schemas in this policy store. For more information, see <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/userguide/cedar4-faq.html">Amazon Verified Permissions upgrade to Cedar v4 FAQ</a>.</p>
1762
+ * @public
1763
+ */
1764
+ cedarVersion?: CedarVersion | undefined;
1765
+ /**
1766
+ * <p>The list of tags associated with the policy store.</p>
1767
+ * @public
1768
+ */
1769
+ tags?: Record<string, string> | undefined;
2235
1770
  }
2236
1771
  /**
2237
1772
  * @public
2238
1773
  */
2239
1774
  export interface GetPolicyTemplateInput {
2240
1775
  /**
2241
- * <p>Specifies the ID of the policy store that contains the policy template that you want information
2242
- * about.</p>
1776
+ * <p>Specifies the ID of the policy store that contains the policy template that you want information about.</p>
2243
1777
  * @public
2244
1778
  */
2245
1779
  policyStoreId: string | undefined;
@@ -2325,16 +1859,12 @@ export interface GetSchemaOutput {
2325
1859
  namespaces?: string[] | undefined;
2326
1860
  }
2327
1861
  /**
2328
- * <p>A structure that defines characteristics of an identity source that you can use to
2329
- * filter.</p>
2330
- * <p>This data type is a request parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentityStores.html">ListIdentityStores</a>
2331
- * operation.</p>
1862
+ * <p>A structure that defines characteristics of an identity source that you can use to filter.</p> <p>This data type is a request parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentityStores.html">ListIdentityStores</a> operation.</p>
2332
1863
  * @public
2333
1864
  */
2334
1865
  export interface IdentitySourceFilter {
2335
1866
  /**
2336
- * <p>The Cedar entity type of the principals returned by the identity provider (IdP)
2337
- * associated with this identity source.</p>
1867
+ * <p>The Cedar entity type of the principals returned by the identity provider (IdP) associated with this identity source.</p>
2338
1868
  * @public
2339
1869
  */
2340
1870
  principalEntityType?: string | undefined;
@@ -2349,47 +1879,30 @@ export interface ListIdentitySourcesInput {
2349
1879
  */
2350
1880
  policyStoreId: string | undefined;
2351
1881
  /**
2352
- * <p>Specifies that you want to receive the next page of results. Valid
2353
- * only if you received a <code>NextToken</code> response in the previous request. If you
2354
- * did, it indicates that more output is available. Set this parameter to the value
2355
- * provided by the previous call's <code>NextToken</code> response to request the
2356
- * next page of results.</p>
1882
+ * <p>Specifies that you want to receive the next page of results. Valid only if you received a <code>NextToken</code> response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's <code>NextToken</code> response to request the next page of results.</p>
2357
1883
  * @public
2358
1884
  */
2359
1885
  nextToken?: string | undefined;
2360
1886
  /**
2361
- * <p>Specifies the total number of results that you want included in each
2362
- * response. If additional items exist beyond the number you specify, the
2363
- * <code>NextToken</code> response element is returned with a value (not null). Include the
2364
- * specified value as the <code>NextToken</code> request parameter in the next call to the
2365
- * operation to get the next set of results. Note that the service might return fewer
2366
- * results than the maximum even when there are more results available. You should check
2367
- * <code>NextToken</code> after every operation to ensure that you receive all of the
2368
- * results.</p>
2369
- * <p>If you do not specify this parameter, the operation defaults to 10 identity sources per response.
2370
- * You can specify a maximum of 50 identity sources per response.</p>
1887
+ * <p>Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the <code>NextToken</code> response element is returned with a value (not null). Include the specified value as the <code>NextToken</code> request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results.</p> <p>If you do not specify this parameter, the operation defaults to 10 identity sources per response. You can specify a maximum of 50 identity sources per response.</p>
2371
1888
  * @public
2372
1889
  */
2373
1890
  maxResults?: number | undefined;
2374
1891
  /**
2375
- * <p>Specifies characteristics of an identity source that you can use to limit the output to matching
2376
- * identity sources.</p>
1892
+ * <p>Specifies characteristics of an identity source that you can use to limit the output to matching identity sources.</p>
2377
1893
  * @public
2378
1894
  */
2379
1895
  filters?: IdentitySourceFilter[] | undefined;
2380
1896
  }
2381
1897
  /**
2382
- * <p>A structure that contains configuration of the identity source.</p>
2383
- * <p>This data type was a response parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html">ListIdentitySources</a>
2384
- * operation. Replaced by <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ConfigurationItem.html">ConfigurationItem</a>.</p>
1898
+ * <p>A structure that contains configuration of the identity source.</p> <p>This data type was a response parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html">ListIdentitySources</a> operation. Replaced by <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ConfigurationItem.html">ConfigurationItem</a>.</p>
2385
1899
  *
2386
1900
  * @deprecated This shape has been replaced by ConfigurationItem
2387
1901
  * @public
2388
1902
  */
2389
1903
  export interface IdentitySourceItemDetails {
2390
1904
  /**
2391
- * <p>The application client IDs associated with the specified Amazon Cognito user pool that are
2392
- * enabled for this identity source.</p>
1905
+ * <p>The application client IDs associated with the specified Amazon Cognito user pool that are enabled for this identity source.</p>
2393
1906
  *
2394
1907
  * @deprecated
2395
1908
  * @public
@@ -2403,21 +1916,14 @@ export interface IdentitySourceItemDetails {
2403
1916
  */
2404
1917
  userPoolArn?: string | undefined;
2405
1918
  /**
2406
- * <p>The well-known URL that points to this user pool's OIDC discovery endpoint. This is a
2407
- * URL string in the following format. This URL replaces the placeholders for both the
2408
- * Amazon Web Services Region and the user pool identifier with those appropriate for this user
2409
- * pool.</p>
2410
- * <p>
2411
- * <code>https://cognito-idp.<i>&lt;region&gt;</i>.amazonaws.com/<i>&lt;user-pool-id&gt;</i>/.well-known/openid-configuration</code>
2412
- * </p>
1919
+ * <p>The well-known URL that points to this user pool's OIDC discovery endpoint. This is a URL string in the following format. This URL replaces the placeholders for both the Amazon Web Services Region and the user pool identifier with those appropriate for this user pool.</p> <p> <code>https://cognito-idp.<i>&lt;region&gt;</i>.amazonaws.com/<i>&lt;user-pool-id&gt;</i>/.well-known/openid-configuration</code> </p>
2413
1920
  *
2414
1921
  * @deprecated
2415
1922
  * @public
2416
1923
  */
2417
1924
  discoveryUrl?: string | undefined;
2418
1925
  /**
2419
- * <p>A string that identifies the type of OIDC service represented by this identity source. </p>
2420
- * <p>At this time, the only valid value is <code>cognito</code>.</p>
1926
+ * <p>A string that identifies the type of OIDC service represented by this identity source. </p> <p>At this time, the only valid value is <code>cognito</code>.</p>
2421
1927
  *
2422
1928
  * @deprecated
2423
1929
  * @public
@@ -2425,9 +1931,7 @@ export interface IdentitySourceItemDetails {
2425
1931
  openIdIssuer?: OpenIdIssuer | undefined;
2426
1932
  }
2427
1933
  /**
2428
- * <p>A structure that defines an identity source.</p>
2429
- * <p>This data type is a response parameter to the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html">ListIdentitySources</a>
2430
- * operation.</p>
1934
+ * <p>A structure that defines an identity source.</p> <p>This data type is a response parameter to the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListIdentitySources.html">ListIdentitySources</a> operation.</p>
2431
1935
  * @public
2432
1936
  */
2433
1937
  export interface IdentitySourceItem {
@@ -2437,8 +1941,7 @@ export interface IdentitySourceItem {
2437
1941
  */
2438
1942
  createdDate: Date | undefined;
2439
1943
  /**
2440
- * <p>A structure that contains the details of the associated identity provider
2441
- * (IdP).</p>
1944
+ * <p>A structure that contains the details of the associated identity provider (IdP).</p>
2442
1945
  *
2443
1946
  * @deprecated
2444
1947
  * @public
@@ -2460,8 +1963,7 @@ export interface IdentitySourceItem {
2460
1963
  */
2461
1964
  policyStoreId: string | undefined;
2462
1965
  /**
2463
- * <p>The Cedar entity type of the principals returned from the IdP associated with this
2464
- * identity source.</p>
1966
+ * <p>The Cedar entity type of the principals returned from the IdP associated with this identity source.</p>
2465
1967
  * @public
2466
1968
  */
2467
1969
  principalEntityType: string | undefined;
@@ -2476,11 +1978,7 @@ export interface IdentitySourceItem {
2476
1978
  */
2477
1979
  export interface ListIdentitySourcesOutput {
2478
1980
  /**
2479
- * <p>If present, this value indicates that more output is available than
2480
- * is included in the current response. Use this value in the <code>NextToken</code>
2481
- * request parameter in a subsequent call to the operation to get the next part of the
2482
- * output. You should repeat this until the <code>NextToken</code> response element comes
2483
- * back as <code>null</code>. This indicates that this is the last page of results.</p>
1981
+ * <p>If present, this value indicates that more output is available than is included in the current response. Use this value in the <code>NextToken</code> request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the <code>NextToken</code> response element comes back as <code>null</code>. This indicates that this is the last page of results.</p>
2484
1982
  * @public
2485
1983
  */
2486
1984
  nextToken?: string | undefined;
@@ -2496,8 +1994,7 @@ export interface ListIdentitySourcesOutput {
2496
1994
  */
2497
1995
  export interface UpdateCognitoGroupConfiguration {
2498
1996
  /**
2499
- * <p>The name of the schema entity type that's mapped to the user pool group. Defaults
2500
- * to <code>AWS::CognitoGroup</code>.</p>
1997
+ * <p>The name of the schema entity type that's mapped to the user pool group. Defaults to <code>AWS::CognitoGroup</code>.</p>
2501
1998
  * @public
2502
1999
  */
2503
2000
  groupEntityType: string | undefined;
@@ -2513,90 +2010,66 @@ export interface UpdateCognitoUserPoolConfiguration {
2513
2010
  */
2514
2011
  userPoolArn: string | undefined;
2515
2012
  /**
2516
- * <p>The client ID of an app client that is configured for the specified Amazon Cognito user
2517
- * pool.</p>
2013
+ * <p>The client ID of an app client that is configured for the specified Amazon Cognito user pool.</p>
2518
2014
  * @public
2519
2015
  */
2520
2016
  clientIds?: string[] | undefined;
2521
2017
  /**
2522
- * <p>The configuration of the user groups from an Amazon Cognito user pool identity
2523
- * source.</p>
2018
+ * <p>The configuration of the user groups from an Amazon Cognito user pool identity source.</p>
2524
2019
  * @public
2525
2020
  */
2526
2021
  groupConfiguration?: UpdateCognitoGroupConfiguration | undefined;
2527
2022
  }
2528
2023
  /**
2529
- * <p>The claim in OIDC identity provider tokens that indicates a user's group membership, and
2530
- * the entity type that you want to map it to. For example, this object can map the contents
2531
- * of a <code>groups</code> claim to <code>MyCorp::UserGroup</code>.</p>
2532
- * <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdateOpenIdConnectConfiguration.html">UpdateOpenIdConnectConfiguration</a> structure, which is a parameter to <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdateIdentitySource.html">UpdateIdentitySource</a>.</p>
2024
+ * <p>The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a <code>groups</code> claim to <code>MyCorp::UserGroup</code>.</p> <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdateOpenIdConnectConfiguration.html">UpdateOpenIdConnectConfiguration</a> structure, which is a parameter to <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdateIdentitySource.html">UpdateIdentitySource</a>.</p>
2533
2025
  * @public
2534
2026
  */
2535
2027
  export interface UpdateOpenIdConnectGroupConfiguration {
2536
2028
  /**
2537
- * <p>The token claim that you want Verified Permissions to interpret as group membership. For example,
2538
- * <code>groups</code>.</p>
2029
+ * <p>The token claim that you want Verified Permissions to interpret as group membership. For example, <code>groups</code>.</p>
2539
2030
  * @public
2540
2031
  */
2541
2032
  groupClaim: string | undefined;
2542
2033
  /**
2543
- * <p>The policy store entity type that you want to map your users' group claim to. For example,
2544
- * <code>MyCorp::UserGroup</code>. A group entity type is an entity that can have a user
2545
- * entity type as a member.</p>
2034
+ * <p>The policy store entity type that you want to map your users' group claim to. For example, <code>MyCorp::UserGroup</code>. A group entity type is an entity that can have a user entity type as a member.</p>
2546
2035
  * @public
2547
2036
  */
2548
2037
  groupEntityType: string | undefined;
2549
2038
  }
2550
2039
  /**
2551
- * <p>The configuration of an OpenID Connect (OIDC) identity source for handling access token
2552
- * claims. Contains the claim that you want to identify as the principal in an authorization
2553
- * request, and the values of the <code>aud</code> claim, or audiences, that you want to
2554
- * accept.</p>
2555
- * <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdateOpenIdConnectTokenSelection.html">UpdateOpenIdConnectTokenSelection</a> structure, which is a parameter to <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdateIdentitySource.html">UpdateIdentitySource</a>.</p>
2040
+ * <p>The configuration of an OpenID Connect (OIDC) identity source for handling access token claims. Contains the claim that you want to identify as the principal in an authorization request, and the values of the <code>aud</code> claim, or audiences, that you want to accept.</p> <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdateOpenIdConnectTokenSelection.html">UpdateOpenIdConnectTokenSelection</a> structure, which is a parameter to <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdateIdentitySource.html">UpdateIdentitySource</a>.</p>
2556
2041
  * @public
2557
2042
  */
2558
2043
  export interface UpdateOpenIdConnectAccessTokenConfiguration {
2559
2044
  /**
2560
- * <p>The claim that determines the principal in OIDC access tokens. For example,
2561
- * <code>sub</code>.</p>
2045
+ * <p>The claim that determines the principal in OIDC access tokens. For example, <code>sub</code>.</p>
2562
2046
  * @public
2563
2047
  */
2564
2048
  principalIdClaim?: string | undefined;
2565
2049
  /**
2566
- * <p>The access token <code>aud</code> claim values that you want to accept in your policy
2567
- * store. For example, <code>https://myapp.example.com, https://myapp2.example.com</code>.</p>
2050
+ * <p>The access token <code>aud</code> claim values that you want to accept in your policy store. For example, <code>https://myapp.example.com, https://myapp2.example.com</code>.</p>
2568
2051
  * @public
2569
2052
  */
2570
2053
  audiences?: string[] | undefined;
2571
2054
  }
2572
2055
  /**
2573
- * <p>The configuration of an OpenID Connect (OIDC) identity source for handling identity (ID)
2574
- * token claims. Contains the claim that you want to identify as the principal in an
2575
- * authorization request, and the values of the <code>aud</code> claim, or audiences, that
2576
- * you want to accept.</p>
2577
- * <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdateOpenIdConnectTokenSelection.html">UpdateOpenIdConnectTokenSelection</a> structure, which is a parameter to <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdateIdentitySource.html">UpdateIdentitySource</a>.</p>
2056
+ * <p>The configuration of an OpenID Connect (OIDC) identity source for handling identity (ID) token claims. Contains the claim that you want to identify as the principal in an authorization request, and the values of the <code>aud</code> claim, or audiences, that you want to accept.</p> <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdateOpenIdConnectTokenSelection.html">UpdateOpenIdConnectTokenSelection</a> structure, which is a parameter to <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdateIdentitySource.html">UpdateIdentitySource</a>.</p>
2578
2057
  * @public
2579
2058
  */
2580
2059
  export interface UpdateOpenIdConnectIdentityTokenConfiguration {
2581
2060
  /**
2582
- * <p>The claim that determines the principal in OIDC access tokens. For example,
2583
- * <code>sub</code>.</p>
2061
+ * <p>The claim that determines the principal in OIDC access tokens. For example, <code>sub</code>.</p>
2584
2062
  * @public
2585
2063
  */
2586
2064
  principalIdClaim?: string | undefined;
2587
2065
  /**
2588
- * <p>The ID token audience, or client ID, claim values that you want to accept in your policy
2589
- * store from an OIDC identity provider. For example, <code>1example23456789,
2590
- * 2example10111213</code>.</p>
2066
+ * <p>The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider. For example, <code>1example23456789, 2example10111213</code>.</p>
2591
2067
  * @public
2592
2068
  */
2593
2069
  clientIds?: string[] | undefined;
2594
2070
  }
2595
2071
  /**
2596
- * <p>The token type that you want to process from your OIDC identity provider. Your policy
2597
- * store can process either identity (ID) or access tokens from a given OIDC identity
2598
- * source.</p>
2599
- * <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdateOpenIdConnectConfiguration.html">UpdateOpenIdConnectConfiguration</a> structure, which is a parameter to <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdateIdentitySource.html">UpdateIdentitySource</a>.</p>
2072
+ * <p>The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.</p> <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdateOpenIdConnectConfiguration.html">UpdateOpenIdConnectConfiguration</a> structure, which is a parameter to <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdateIdentitySource.html">UpdateIdentitySource</a>.</p>
2600
2073
  * @public
2601
2074
  */
2602
2075
  export type UpdateOpenIdConnectTokenSelection = UpdateOpenIdConnectTokenSelection.AccessTokenOnlyMember | UpdateOpenIdConnectTokenSelection.IdentityTokenOnlyMember | UpdateOpenIdConnectTokenSelection.$UnknownMember;
@@ -2605,9 +2078,7 @@ export type UpdateOpenIdConnectTokenSelection = UpdateOpenIdConnectTokenSelectio
2605
2078
  */
2606
2079
  export declare namespace UpdateOpenIdConnectTokenSelection {
2607
2080
  /**
2608
- * <p>The OIDC configuration for processing access tokens. Contains allowed audience claims,
2609
- * for example <code>https://auth.example.com</code>, and the claim that you want to map to the
2610
- * principal, for example <code>sub</code>.</p>
2081
+ * <p>The OIDC configuration for processing access tokens. Contains allowed audience claims, for example <code>https://auth.example.com</code>, and the claim that you want to map to the principal, for example <code>sub</code>.</p>
2611
2082
  * @public
2612
2083
  */
2613
2084
  interface AccessTokenOnlyMember {
@@ -2616,9 +2087,7 @@ export declare namespace UpdateOpenIdConnectTokenSelection {
2616
2087
  $unknown?: never;
2617
2088
  }
2618
2089
  /**
2619
- * <p>The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID
2620
- * claims, for example <code>1example23456789</code>, and the claim that you want to map to
2621
- * the principal, for example <code>sub</code>.</p>
2090
+ * <p>The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID claims, for example <code>1example23456789</code>, and the claim that you want to map to the principal, for example <code>sub</code>.</p>
2622
2091
  * @public
2623
2092
  */
2624
2093
  interface IdentityTokenOnlyMember {
@@ -2642,40 +2111,27 @@ export declare namespace UpdateOpenIdConnectTokenSelection {
2642
2111
  const visit: <T>(value: UpdateOpenIdConnectTokenSelection, visitor: Visitor<T>) => T;
2643
2112
  }
2644
2113
  /**
2645
- * <p>Contains configuration details of an OpenID Connect (OIDC) identity provider, or
2646
- * identity source, that Verified Permissions can use to generate entities from authenticated identities. It
2647
- * specifies the issuer URL, token type that you want to use, and policy store entity
2648
- * details.</p>
2649
- * <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdateConfiguration.html">UpdateConfiguration</a>
2650
- * structure, which is a parameter to <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdateIdentitySource.html">UpdateIdentitySource</a>.</p>
2114
+ * <p>Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details.</p> <p>This data type is part of a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdateConfiguration.html">UpdateConfiguration</a> structure, which is a parameter to <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdateIdentitySource.html">UpdateIdentitySource</a>.</p>
2651
2115
  * @public
2652
2116
  */
2653
2117
  export interface UpdateOpenIdConnectConfiguration {
2654
2118
  /**
2655
- * <p>The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery
2656
- * endpoint at the path <code>.well-known/openid-configuration</code>.</p>
2119
+ * <p>The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path <code>.well-known/openid-configuration</code>.</p>
2657
2120
  * @public
2658
2121
  */
2659
2122
  issuer: string | undefined;
2660
2123
  /**
2661
- * <p>A descriptive string that you want to prefix to user entities from your OIDC identity
2662
- * provider. For example, if you set an <code>entityIdPrefix</code> of
2663
- * <code>MyOIDCProvider</code>, you can reference principals in your policies in the format
2664
- * <code>MyCorp::User::MyOIDCProvider|Carlos</code>.</p>
2124
+ * <p>A descriptive string that you want to prefix to user entities from your OIDC identity provider. For example, if you set an <code>entityIdPrefix</code> of <code>MyOIDCProvider</code>, you can reference principals in your policies in the format <code>MyCorp::User::MyOIDCProvider|Carlos</code>.</p>
2665
2125
  * @public
2666
2126
  */
2667
2127
  entityIdPrefix?: string | undefined;
2668
2128
  /**
2669
- * <p>The claim in OIDC identity provider tokens that indicates a user's group membership, and
2670
- * the entity type that you want to map it to. For example, this object can map the contents
2671
- * of a <code>groups</code> claim to <code>MyCorp::UserGroup</code>.</p>
2129
+ * <p>The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a <code>groups</code> claim to <code>MyCorp::UserGroup</code>.</p>
2672
2130
  * @public
2673
2131
  */
2674
2132
  groupConfiguration?: UpdateOpenIdConnectGroupConfiguration | undefined;
2675
2133
  /**
2676
- * <p>The token type that you want to process from your OIDC identity provider. Your policy
2677
- * store can process either identity (ID) or access tokens from a given OIDC identity
2678
- * source.</p>
2134
+ * <p>The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.</p>
2679
2135
  * @public
2680
2136
  */
2681
2137
  tokenSelection: UpdateOpenIdConnectTokenSelection | undefined;
@@ -2699,10 +2155,7 @@ export declare namespace UpdateConfiguration {
2699
2155
  $unknown?: never;
2700
2156
  }
2701
2157
  /**
2702
- * <p>Contains configuration details of an OpenID Connect (OIDC) identity provider, or
2703
- * identity source, that Verified Permissions can use to generate entities from authenticated identities. It
2704
- * specifies the issuer URL, token type that you want to use, and policy store entity
2705
- * details.</p>
2158
+ * <p>Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details.</p>
2706
2159
  * @public
2707
2160
  */
2708
2161
  interface OpenIdConnectConfigurationMember {
@@ -2740,14 +2193,12 @@ export interface UpdateIdentitySourceInput {
2740
2193
  */
2741
2194
  identitySourceId: string | undefined;
2742
2195
  /**
2743
- * <p>Specifies the details required to communicate with the identity provider (IdP)
2744
- * associated with this identity source.</p>
2196
+ * <p>Specifies the details required to communicate with the identity provider (IdP) associated with this identity source.</p>
2745
2197
  * @public
2746
2198
  */
2747
2199
  updateConfiguration: UpdateConfiguration | undefined;
2748
2200
  /**
2749
- * <p>Specifies the data type of principals generated for identities authenticated by the
2750
- * identity source.</p>
2201
+ * <p>Specifies the data type of principals generated for identities authenticated by the identity source.</p>
2751
2202
  * @public
2752
2203
  */
2753
2204
  principalEntityType?: string | undefined;
@@ -2782,24 +2233,17 @@ export interface UpdateIdentitySourceOutput {
2782
2233
  */
2783
2234
  export interface IsAuthorizedOutput {
2784
2235
  /**
2785
- * <p>An authorization decision that indicates if the authorization request should be
2786
- * allowed or denied.</p>
2236
+ * <p>An authorization decision that indicates if the authorization request should be allowed or denied.</p>
2787
2237
  * @public
2788
2238
  */
2789
2239
  decision: Decision | undefined;
2790
2240
  /**
2791
- * <p>The list of determining policies used to make the authorization decision. For example,
2792
- * if there are two matching policies, where one is a forbid and the other is a permit,
2793
- * then the forbid policy will be the determining policy. In the case of multiple matching
2794
- * permit policies then there would be multiple determining policies. In the case that no
2795
- * policies match, and hence the response is DENY, there would be no determining
2796
- * policies.</p>
2241
+ * <p>The list of determining policies used to make the authorization decision. For example, if there are two matching policies, where one is a forbid and the other is a permit, then the forbid policy will be the determining policy. In the case of multiple matching permit policies then there would be multiple determining policies. In the case that no policies match, and hence the response is DENY, there would be no determining policies.</p>
2797
2242
  * @public
2798
2243
  */
2799
2244
  determiningPolicies: DeterminingPolicyItem[] | undefined;
2800
2245
  /**
2801
- * <p>Errors that occurred while making an authorization decision, for example, a policy
2802
- * references an Entity or entity Attribute that does not exist in the slice.</p>
2246
+ * <p>Errors that occurred while making an authorization decision, for example, a policy references an Entity or entity Attribute that does not exist in the slice.</p>
2803
2247
  * @public
2804
2248
  */
2805
2249
  errors: EvaluationErrorItem[] | undefined;
@@ -2809,24 +2253,17 @@ export interface IsAuthorizedOutput {
2809
2253
  */
2810
2254
  export interface IsAuthorizedWithTokenOutput {
2811
2255
  /**
2812
- * <p>An authorization decision that indicates if the authorization request should be
2813
- * allowed or denied.</p>
2256
+ * <p>An authorization decision that indicates if the authorization request should be allowed or denied.</p>
2814
2257
  * @public
2815
2258
  */
2816
2259
  decision: Decision | undefined;
2817
2260
  /**
2818
- * <p>The list of determining policies used to make the authorization decision. For example,
2819
- * if there are multiple matching policies, where at least one is a forbid policy, then
2820
- * because forbid always overrides permit the forbid policies are the determining policies.
2821
- * If all matching policies are permit policies, then those policies are the determining
2822
- * policies. When no policies match and the response is the default DENY, there are no
2823
- * determining policies.</p>
2261
+ * <p>The list of determining policies used to make the authorization decision. For example, if there are multiple matching policies, where at least one is a forbid policy, then because forbid always overrides permit the forbid policies are the determining policies. If all matching policies are permit policies, then those policies are the determining policies. When no policies match and the response is the default DENY, there are no determining policies.</p>
2824
2262
  * @public
2825
2263
  */
2826
2264
  determiningPolicies: DeterminingPolicyItem[] | undefined;
2827
2265
  /**
2828
- * <p>Errors that occurred while making an authorization decision. For example, a policy
2829
- * references an entity or entity attribute that does not exist in the slice.</p>
2266
+ * <p>Errors that occurred while making an authorization decision. For example, a policy references an entity or entity attribute that does not exist in the slice.</p>
2830
2267
  * @public
2831
2268
  */
2832
2269
  errors: EvaluationErrorItem[] | undefined;
@@ -2837,8 +2274,7 @@ export interface IsAuthorizedWithTokenOutput {
2837
2274
  principal?: EntityIdentifier | undefined;
2838
2275
  }
2839
2276
  /**
2840
- * <p>Contains information about a filter to refine policies returned in a query.</p>
2841
- * <p>This data type is used as a response parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicies.html">ListPolicies</a> operation.</p>
2277
+ * <p>Contains information about a filter to refine policies returned in a query.</p> <p>This data type is used as a response parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicies.html">ListPolicies</a> operation.</p>
2842
2278
  * @public
2843
2279
  */
2844
2280
  export interface PolicyFilter {
@@ -2858,8 +2294,7 @@ export interface PolicyFilter {
2858
2294
  */
2859
2295
  policyType?: PolicyType | undefined;
2860
2296
  /**
2861
- * <p>Filters the output to only template-linked policies that were instantiated from the specified
2862
- * policy template.</p>
2297
+ * <p>Filters the output to only template-linked policies that were instantiated from the specified policy template.</p>
2863
2298
  * @public
2864
2299
  */
2865
2300
  policyTemplateId?: string | undefined;
@@ -2874,41 +2309,23 @@ export interface ListPoliciesInput {
2874
2309
  */
2875
2310
  policyStoreId: string | undefined;
2876
2311
  /**
2877
- * <p>Specifies that you want to receive the next page of results. Valid
2878
- * only if you received a <code>NextToken</code> response in the previous request. If you
2879
- * did, it indicates that more output is available. Set this parameter to the value
2880
- * provided by the previous call's <code>NextToken</code> response to request the
2881
- * next page of results.</p>
2312
+ * <p>Specifies that you want to receive the next page of results. Valid only if you received a <code>NextToken</code> response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's <code>NextToken</code> response to request the next page of results.</p>
2882
2313
  * @public
2883
2314
  */
2884
2315
  nextToken?: string | undefined;
2885
2316
  /**
2886
- * <p>Specifies the total number of results that you want included in each
2887
- * response. If additional items exist beyond the number you specify, the
2888
- * <code>NextToken</code> response element is returned with a value (not null). Include the
2889
- * specified value as the <code>NextToken</code> request parameter in the next call to the
2890
- * operation to get the next set of results. Note that the service might return fewer
2891
- * results than the maximum even when there are more results available. You should check
2892
- * <code>NextToken</code> after every operation to ensure that you receive all of the
2893
- * results.</p>
2894
- * <p>If you do not specify this parameter, the operation defaults to 10 policies per
2895
- * response. You can specify a maximum of 50 policies per response.</p>
2317
+ * <p>Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the <code>NextToken</code> response element is returned with a value (not null). Include the specified value as the <code>NextToken</code> request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results.</p> <p>If you do not specify this parameter, the operation defaults to 10 policies per response. You can specify a maximum of 50 policies per response.</p>
2896
2318
  * @public
2897
2319
  */
2898
2320
  maxResults?: number | undefined;
2899
2321
  /**
2900
- * <p>Specifies a filter that limits the response to only policies that match the specified
2901
- * criteria. For example, you list only the policies that reference a specified
2902
- * principal.</p>
2322
+ * <p>Specifies a filter that limits the response to only policies that match the specified criteria. For example, you list only the policies that reference a specified principal.</p>
2903
2323
  * @public
2904
2324
  */
2905
2325
  filter?: PolicyFilter | undefined;
2906
2326
  }
2907
2327
  /**
2908
- * <p>A structure that contains details about a static policy. It includes the description and
2909
- * policy statement.</p>
2910
- * <p>This data type is used within a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_PolicyDefinition.html">PolicyDefinition</a> structure as
2911
- * part of a request parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html">CreatePolicy</a> operation.</p>
2328
+ * <p>A structure that contains details about a static policy. It includes the description and policy statement.</p> <p>This data type is used within a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_PolicyDefinition.html">PolicyDefinition</a> structure as part of a request parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html">CreatePolicy</a> operation.</p>
2912
2329
  * @public
2913
2330
  */
2914
2331
  export interface StaticPolicyDefinitionItem {
@@ -2919,8 +2336,7 @@ export interface StaticPolicyDefinitionItem {
2919
2336
  description?: string | undefined;
2920
2337
  }
2921
2338
  /**
2922
- * <p>Contains information about a policy created by instantiating a policy template. </p>
2923
- * <p>This </p>
2339
+ * <p>Contains information about a policy created by instantiating a policy template. </p> <p>This </p>
2924
2340
  * @public
2925
2341
  */
2926
2342
  export interface TemplateLinkedPolicyDefinitionItem {
@@ -2930,26 +2346,18 @@ export interface TemplateLinkedPolicyDefinitionItem {
2930
2346
  */
2931
2347
  policyTemplateId: string | undefined;
2932
2348
  /**
2933
- * <p>The principal associated with this template-linked policy. Verified Permissions substitutes this principal for the
2934
- * <code>?principal</code> placeholder in the policy template when it evaluates an authorization
2935
- * request.</p>
2349
+ * <p>The principal associated with this template-linked policy. Verified Permissions substitutes this principal for the <code>?principal</code> placeholder in the policy template when it evaluates an authorization request.</p>
2936
2350
  * @public
2937
2351
  */
2938
2352
  principal?: EntityIdentifier | undefined;
2939
2353
  /**
2940
- * <p>The resource associated with this template-linked policy. Verified Permissions substitutes this resource for the
2941
- * <code>?resource</code> placeholder in the policy template when it evaluates an authorization
2942
- * request.</p>
2354
+ * <p>The resource associated with this template-linked policy. Verified Permissions substitutes this resource for the <code>?resource</code> placeholder in the policy template when it evaluates an authorization request.</p>
2943
2355
  * @public
2944
2356
  */
2945
2357
  resource?: EntityIdentifier | undefined;
2946
2358
  }
2947
2359
  /**
2948
- * <p>A structure that describes a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_PolicyDefinintion.html">PolicyDefinintion</a>. It will
2949
- * always have either an <code>StaticPolicy</code> or a <code>TemplateLinkedPolicy</code>
2950
- * element.</p>
2951
- * <p>This data type is used as a response parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html">CreatePolicy</a> and <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicies.html">ListPolicies</a>
2952
- * operations. </p>
2360
+ * <p>A structure that describes a <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_PolicyDefinintion.html">PolicyDefinintion</a>. It will always have either an <code>StaticPolicy</code> or a <code>TemplateLinkedPolicy</code> element.</p> <p>This data type is used as a response parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html">CreatePolicy</a> and <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicies.html">ListPolicies</a> operations. </p>
2953
2361
  * @public
2954
2362
  */
2955
2363
  export type PolicyDefinitionItem = PolicyDefinitionItem.StaticMember | PolicyDefinitionItem.TemplateLinkedMember | PolicyDefinitionItem.$UnknownMember;
@@ -2991,14 +2399,12 @@ export declare namespace PolicyDefinitionItem {
2991
2399
  const visit: <T>(value: PolicyDefinitionItem, visitor: Visitor<T>) => T;
2992
2400
  }
2993
2401
  /**
2994
- * <p>Contains information about a policy.</p>
2995
- * <p>This data type is used as a response parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicies.html">ListPolicies</a> operation.</p>
2402
+ * <p>Contains information about a policy.</p> <p>This data type is used as a response parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicies.html">ListPolicies</a> operation.</p>
2996
2403
  * @public
2997
2404
  */
2998
2405
  export interface PolicyItem {
2999
2406
  /**
3000
- * <p>The identifier of the policy store where the policy you want information about is
3001
- * stored.</p>
2407
+ * <p>The identifier of the policy store where the policy you want information about is stored.</p>
3002
2408
  * @public
3003
2409
  */
3004
2410
  policyStoreId: string | undefined;
@@ -3008,19 +2414,7 @@ export interface PolicyItem {
3008
2414
  */
3009
2415
  policyId: string | undefined;
3010
2416
  /**
3011
- * <p>The type of the policy. This is one of the following values:</p>
3012
- * <ul>
3013
- * <li>
3014
- * <p>
3015
- * <code>STATIC</code>
3016
- * </p>
3017
- * </li>
3018
- * <li>
3019
- * <p>
3020
- * <code>TEMPLATE_LINKED</code>
3021
- * </p>
3022
- * </li>
3023
- * </ul>
2417
+ * <p>The type of the policy. This is one of the following values:</p> <ul> <li> <p> <code>STATIC</code> </p> </li> <li> <p> <code>TEMPLATE_LINKED</code> </p> </li> </ul>
3024
2418
  * @public
3025
2419
  */
3026
2420
  policyType: PolicyType | undefined;
@@ -3035,9 +2429,7 @@ export interface PolicyItem {
3035
2429
  */
3036
2430
  resource?: EntityIdentifier | undefined;
3037
2431
  /**
3038
- * <p>The action that a policy permits or forbids. For example,
3039
- * <code>\{"actions": [\{"actionId": "ViewPhoto", "actionType": "PhotoFlash::Action"\}, \{"entityID": "SharePhoto",
3040
- * "entityType": "PhotoFlash::Action"\}]\}</code>.</p>
2432
+ * <p>The action that a policy permits or forbids. For example, <code>\{"actions": [\{"actionId": "ViewPhoto", "actionType": "PhotoFlash::Action"\}, \{"entityID": "SharePhoto", "entityType": "PhotoFlash::Action"\}]\}</code>.</p>
3041
2433
  * @public
3042
2434
  */
3043
2435
  actions?: ActionIdentifier[] | undefined;
@@ -3057,8 +2449,7 @@ export interface PolicyItem {
3057
2449
  */
3058
2450
  lastUpdatedDate: Date | undefined;
3059
2451
  /**
3060
- * <p>The effect of the decision that a policy returns to an authorization
3061
- * request. For example, <code>"effect": "Permit"</code>.</p>
2452
+ * <p>The effect of the decision that a policy returns to an authorization request. For example, <code>"effect": "Permit"</code>.</p>
3062
2453
  * @public
3063
2454
  */
3064
2455
  effect?: PolicyEffect | undefined;
@@ -3068,11 +2459,7 @@ export interface PolicyItem {
3068
2459
  */
3069
2460
  export interface ListPoliciesOutput {
3070
2461
  /**
3071
- * <p>If present, this value indicates that more output is available than
3072
- * is included in the current response. Use this value in the <code>NextToken</code>
3073
- * request parameter in a subsequent call to the operation to get the next part of the
3074
- * output. You should repeat this until the <code>NextToken</code> response element comes
3075
- * back as <code>null</code>. This indicates that this is the last page of results.</p>
2462
+ * <p>If present, this value indicates that more output is available than is included in the current response. Use this value in the <code>NextToken</code> request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the <code>NextToken</code> response element comes back as <code>null</code>. This indicates that this is the last page of results.</p>
3076
2463
  * @public
3077
2464
  */
3078
2465
  nextToken?: string | undefined;
@@ -3087,33 +2474,18 @@ export interface ListPoliciesOutput {
3087
2474
  */
3088
2475
  export interface ListPolicyStoresInput {
3089
2476
  /**
3090
- * <p>Specifies that you want to receive the next page of results. Valid
3091
- * only if you received a <code>NextToken</code> response in the previous request. If you
3092
- * did, it indicates that more output is available. Set this parameter to the value
3093
- * provided by the previous call's <code>NextToken</code> response to request the
3094
- * next page of results.</p>
2477
+ * <p>Specifies that you want to receive the next page of results. Valid only if you received a <code>NextToken</code> response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's <code>NextToken</code> response to request the next page of results.</p>
3095
2478
  * @public
3096
2479
  */
3097
2480
  nextToken?: string | undefined;
3098
2481
  /**
3099
- * <p>Specifies the total number of results that you want included in each
3100
- * response. If additional items exist beyond the number you specify, the
3101
- * <code>NextToken</code> response element is returned with a value (not null). Include the
3102
- * specified value as the <code>NextToken</code> request parameter in the next call to the
3103
- * operation to get the next set of results. Note that the service might return fewer
3104
- * results than the maximum even when there are more results available. You should check
3105
- * <code>NextToken</code> after every operation to ensure that you receive all of the
3106
- * results.</p>
3107
- * <p>If you do not specify this parameter, the operation defaults to 10 policy stores per response.
3108
- * You can specify a maximum of 50 policy stores per response.</p>
2482
+ * <p>Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the <code>NextToken</code> response element is returned with a value (not null). Include the specified value as the <code>NextToken</code> request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results.</p> <p>If you do not specify this parameter, the operation defaults to 10 policy stores per response. You can specify a maximum of 50 policy stores per response.</p>
3109
2483
  * @public
3110
2484
  */
3111
2485
  maxResults?: number | undefined;
3112
2486
  }
3113
2487
  /**
3114
- * <p>Contains information about a policy store.</p>
3115
- * <p>This data type is used as a response parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStores.html">ListPolicyStores</a>
3116
- * operation.</p>
2488
+ * <p>Contains information about a policy store.</p> <p>This data type is used as a response parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStores.html">ListPolicyStores</a> operation.</p>
3117
2489
  * @public
3118
2490
  */
3119
2491
  export interface PolicyStoreItem {
@@ -3138,8 +2510,7 @@ export interface PolicyStoreItem {
3138
2510
  */
3139
2511
  lastUpdatedDate?: Date | undefined;
3140
2512
  /**
3141
- * <p>Descriptive text that you can provide to help with identification
3142
- * of the current policy store.</p>
2513
+ * <p>Descriptive text that you can provide to help with identification of the current policy store.</p>
3143
2514
  * @public
3144
2515
  */
3145
2516
  description?: string | undefined;
@@ -3149,11 +2520,7 @@ export interface PolicyStoreItem {
3149
2520
  */
3150
2521
  export interface ListPolicyStoresOutput {
3151
2522
  /**
3152
- * <p>If present, this value indicates that more output is available than
3153
- * is included in the current response. Use this value in the <code>NextToken</code>
3154
- * request parameter in a subsequent call to the operation to get the next part of the
3155
- * output. You should repeat this until the <code>NextToken</code> response element comes
3156
- * back as <code>null</code>. This indicates that this is the last page of results.</p>
2523
+ * <p>If present, this value indicates that more output is available than is included in the current response. Use this value in the <code>NextToken</code> request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the <code>NextToken</code> response element comes back as <code>null</code>. This indicates that this is the last page of results.</p>
3157
2524
  * @public
3158
2525
  */
3159
2526
  nextToken?: string | undefined;
@@ -3173,33 +2540,18 @@ export interface ListPolicyTemplatesInput {
3173
2540
  */
3174
2541
  policyStoreId: string | undefined;
3175
2542
  /**
3176
- * <p>Specifies that you want to receive the next page of results. Valid
3177
- * only if you received a <code>NextToken</code> response in the previous request. If you
3178
- * did, it indicates that more output is available. Set this parameter to the value
3179
- * provided by the previous call's <code>NextToken</code> response to request the
3180
- * next page of results.</p>
2543
+ * <p>Specifies that you want to receive the next page of results. Valid only if you received a <code>NextToken</code> response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's <code>NextToken</code> response to request the next page of results.</p>
3181
2544
  * @public
3182
2545
  */
3183
2546
  nextToken?: string | undefined;
3184
2547
  /**
3185
- * <p>Specifies the total number of results that you want included in each
3186
- * response. If additional items exist beyond the number you specify, the
3187
- * <code>NextToken</code> response element is returned with a value (not null). Include the
3188
- * specified value as the <code>NextToken</code> request parameter in the next call to the
3189
- * operation to get the next set of results. Note that the service might return fewer
3190
- * results than the maximum even when there are more results available. You should check
3191
- * <code>NextToken</code> after every operation to ensure that you receive all of the
3192
- * results.</p>
3193
- * <p>If you do not specify this parameter, the operation defaults to 10 policy templates per response.
3194
- * You can specify a maximum of 50 policy templates per response.</p>
2548
+ * <p>Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the <code>NextToken</code> response element is returned with a value (not null). Include the specified value as the <code>NextToken</code> request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results.</p> <p>If you do not specify this parameter, the operation defaults to 10 policy templates per response. You can specify a maximum of 50 policy templates per response.</p>
3195
2549
  * @public
3196
2550
  */
3197
2551
  maxResults?: number | undefined;
3198
2552
  }
3199
2553
  /**
3200
- * <p>Contains details about a policy template</p>
3201
- * <p>This data type is used as a response parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyTemplates.html">ListPolicyTemplates</a>
3202
- * operation.</p>
2554
+ * <p>Contains details about a policy template</p> <p>This data type is used as a response parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyTemplates.html">ListPolicyTemplates</a> operation.</p>
3203
2555
  * @public
3204
2556
  */
3205
2557
  export interface PolicyTemplateItem {
@@ -3234,11 +2586,7 @@ export interface PolicyTemplateItem {
3234
2586
  */
3235
2587
  export interface ListPolicyTemplatesOutput {
3236
2588
  /**
3237
- * <p>If present, this value indicates that more output is available than
3238
- * is included in the current response. Use this value in the <code>NextToken</code>
3239
- * request parameter in a subsequent call to the operation to get the next part of the
3240
- * output. You should repeat this until the <code>NextToken</code> response element comes
3241
- * back as <code>null</code>. This indicates that this is the last page of results.</p>
2589
+ * <p>If present, this value indicates that more output is available than is included in the current response. Use this value in the <code>NextToken</code> request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the <code>NextToken</code> response element comes back as <code>null</code>. This indicates that this is the last page of results.</p>
3242
2590
  * @public
3243
2591
  */
3244
2592
  nextToken?: string | undefined;
@@ -3248,6 +2596,26 @@ export interface ListPolicyTemplatesOutput {
3248
2596
  */
3249
2597
  policyTemplates: PolicyTemplateItem[] | undefined;
3250
2598
  }
2599
+ /**
2600
+ * @public
2601
+ */
2602
+ export interface ListTagsForResourceInput {
2603
+ /**
2604
+ * <p>The ARN of the resource for which you want to view tags.</p>
2605
+ * @public
2606
+ */
2607
+ resourceArn: string | undefined;
2608
+ }
2609
+ /**
2610
+ * @public
2611
+ */
2612
+ export interface ListTagsForResourceOutput {
2613
+ /**
2614
+ * <p>The list of tags associated with the resource.</p>
2615
+ * @public
2616
+ */
2617
+ tags?: Record<string, string> | undefined;
2618
+ }
3251
2619
  /**
3252
2620
  * <p>Contains information about an update to a static policy.</p>
3253
2621
  * @public
@@ -3259,43 +2627,13 @@ export interface UpdateStaticPolicyDefinition {
3259
2627
  */
3260
2628
  description?: string | undefined;
3261
2629
  /**
3262
- * <p>Specifies the Cedar policy language text to be added to or replaced on the static policy.</p>
3263
- * <important>
3264
- * <p>You can change only the following elements from the original content:</p>
3265
- * <ul>
3266
- * <li>
3267
- * <p>The <code>action</code> referenced by the policy.</p>
3268
- * </li>
3269
- * <li>
3270
- * <p>Any conditional clauses, such as <code>when</code> or <code>unless</code>
3271
- * clauses.</p>
3272
- * </li>
3273
- * </ul>
3274
- * <p>You <b>can't</b> change the following elements:</p>
3275
- * <ul>
3276
- * <li>
3277
- * <p>Changing from <code>StaticPolicy</code> to
3278
- * <code>TemplateLinkedPolicy</code>.</p>
3279
- * </li>
3280
- * <li>
3281
- * <p>The effect (<code>permit</code> or <code>forbid</code>) of the
3282
- * policy.</p>
3283
- * </li>
3284
- * <li>
3285
- * <p>The <code>principal</code> referenced by the policy.</p>
3286
- * </li>
3287
- * <li>
3288
- * <p>The <code>resource</code> referenced by the policy.</p>
3289
- * </li>
3290
- * </ul>
3291
- * </important>
2630
+ * <p>Specifies the Cedar policy language text to be added to or replaced on the static policy.</p> <important> <p>You can change only the following elements from the original content:</p> <ul> <li> <p>The <code>action</code> referenced by the policy.</p> </li> <li> <p>Any conditional clauses, such as <code>when</code> or <code>unless</code> clauses.</p> </li> </ul> <p>You <b>can't</b> change the following elements:</p> <ul> <li> <p>Changing from <code>StaticPolicy</code> to <code>TemplateLinkedPolicy</code>.</p> </li> <li> <p>The effect (<code>permit</code> or <code>forbid</code>) of the policy.</p> </li> <li> <p>The <code>principal</code> referenced by the policy.</p> </li> <li> <p>The <code>resource</code> referenced by the policy.</p> </li> </ul> </important>
3292
2631
  * @public
3293
2632
  */
3294
2633
  statement: string | undefined;
3295
2634
  }
3296
2635
  /**
3297
- * <p>Contains information about updates to be applied to a policy.</p>
3298
- * <p>This data type is used as a request parameter in the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicy.html">UpdatePolicy</a> operation.</p>
2636
+ * <p>Contains information about updates to be applied to a policy.</p> <p>This data type is used as a request parameter in the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicy.html">UpdatePolicy</a> operation.</p>
3299
2637
  * @public
3300
2638
  */
3301
2639
  export type UpdatePolicyDefinition = UpdatePolicyDefinition.StaticMember | UpdatePolicyDefinition.$UnknownMember;
@@ -3334,40 +2672,12 @@ export interface UpdatePolicyInput {
3334
2672
  */
3335
2673
  policyStoreId: string | undefined;
3336
2674
  /**
3337
- * <p>Specifies the ID of the policy that you want to update. To find this value, you can
3338
- * use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicies.html">ListPolicies</a>.</p>
2675
+ * <p>Specifies the ID of the policy that you want to update. To find this value, you can use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicies.html">ListPolicies</a>.</p>
3339
2676
  * @public
3340
2677
  */
3341
2678
  policyId: string | undefined;
3342
2679
  /**
3343
- * <p>Specifies the updated policy content that you want to replace on the specified policy.
3344
- * The content must be valid Cedar policy language text.</p>
3345
- * <p>You can change only the following elements from the policy definition:</p>
3346
- * <ul>
3347
- * <li>
3348
- * <p>The <code>action</code> referenced by the policy.</p>
3349
- * </li>
3350
- * <li>
3351
- * <p>Any conditional clauses, such as <code>when</code> or <code>unless</code>
3352
- * clauses.</p>
3353
- * </li>
3354
- * </ul>
3355
- * <p>You <b>can't</b> change the following elements:</p>
3356
- * <ul>
3357
- * <li>
3358
- * <p>Changing from <code>static</code> to <code>templateLinked</code>.</p>
3359
- * </li>
3360
- * <li>
3361
- * <p>Changing the effect of the policy from <code>permit</code> or
3362
- * <code>forbid</code>.</p>
3363
- * </li>
3364
- * <li>
3365
- * <p>The <code>principal</code> referenced by the policy.</p>
3366
- * </li>
3367
- * <li>
3368
- * <p>The <code>resource</code> referenced by the policy.</p>
3369
- * </li>
3370
- * </ul>
2680
+ * <p>Specifies the updated policy content that you want to replace on the specified policy. The content must be valid Cedar policy language text.</p> <p>You can change only the following elements from the policy definition:</p> <ul> <li> <p>The <code>action</code> referenced by the policy.</p> </li> <li> <p>Any conditional clauses, such as <code>when</code> or <code>unless</code> clauses.</p> </li> </ul> <p>You <b>can't</b> change the following elements:</p> <ul> <li> <p>Changing from <code>static</code> to <code>templateLinked</code>.</p> </li> <li> <p>Changing the effect of the policy from <code>permit</code> or <code>forbid</code>.</p> </li> <li> <p>The <code>principal</code> referenced by the policy.</p> </li> <li> <p>The <code>resource</code> referenced by the policy.</p> </li> </ul>
3371
2681
  * @public
3372
2682
  */
3373
2683
  definition: UpdatePolicyDefinition | undefined;
@@ -3392,21 +2702,17 @@ export interface UpdatePolicyOutput {
3392
2702
  */
3393
2703
  policyType: PolicyType | undefined;
3394
2704
  /**
3395
- * <p>The principal specified in the policy's scope. This element isn't included in the
3396
- * response when <code>Principal</code> isn't present in the policy content.</p>
2705
+ * <p>The principal specified in the policy's scope. This element isn't included in the response when <code>Principal</code> isn't present in the policy content.</p>
3397
2706
  * @public
3398
2707
  */
3399
2708
  principal?: EntityIdentifier | undefined;
3400
2709
  /**
3401
- * <p>The resource specified in the policy's scope. This element isn't included in the
3402
- * response when <code>Resource</code> isn't present in the policy content.</p>
2710
+ * <p>The resource specified in the policy's scope. This element isn't included in the response when <code>Resource</code> isn't present in the policy content.</p>
3403
2711
  * @public
3404
2712
  */
3405
2713
  resource?: EntityIdentifier | undefined;
3406
2714
  /**
3407
- * <p>The action that a policy permits or forbids. For example,
3408
- * <code>\{"actions": [\{"actionId": "ViewPhoto", "actionType": "PhotoFlash::Action"\}, \{"entityID": "SharePhoto",
3409
- * "entityType": "PhotoFlash::Action"\}]\}</code>.</p>
2715
+ * <p>The action that a policy permits or forbids. For example, <code>\{"actions": [\{"actionId": "ViewPhoto", "actionType": "PhotoFlash::Action"\}, \{"entityID": "SharePhoto", "entityType": "PhotoFlash::Action"\}]\}</code>.</p>
3410
2716
  * @public
3411
2717
  */
3412
2718
  actions?: ActionIdentifier[] | undefined;
@@ -3421,8 +2727,7 @@ export interface UpdatePolicyOutput {
3421
2727
  */
3422
2728
  lastUpdatedDate: Date | undefined;
3423
2729
  /**
3424
- * <p>The effect of the decision that a policy returns to an authorization
3425
- * request. For example, <code>"effect": "Permit"</code>.</p>
2730
+ * <p>The effect of the decision that a policy returns to an authorization request. For example, <code>"effect": "Permit"</code>.</p>
3426
2731
  * @public
3427
2732
  */
3428
2733
  effect?: PolicyEffect | undefined;
@@ -3447,30 +2752,7 @@ export interface UpdatePolicyTemplateInput {
3447
2752
  */
3448
2753
  description?: string | undefined;
3449
2754
  /**
3450
- * <p>Specifies new statement content written in Cedar policy language to replace the
3451
- * current body of the policy template.</p>
3452
- * <p>You can change only the following elements of the policy body:</p>
3453
- * <ul>
3454
- * <li>
3455
- * <p>The <code>action</code> referenced by the policy template.</p>
3456
- * </li>
3457
- * <li>
3458
- * <p>Any conditional clauses, such as <code>when</code> or <code>unless</code>
3459
- * clauses.</p>
3460
- * </li>
3461
- * </ul>
3462
- * <p>You <b>can't</b> change the following elements:</p>
3463
- * <ul>
3464
- * <li>
3465
- * <p>The effect (<code>permit</code> or <code>forbid</code>) of the policy template.</p>
3466
- * </li>
3467
- * <li>
3468
- * <p>The <code>principal</code> referenced by the policy template.</p>
3469
- * </li>
3470
- * <li>
3471
- * <p>The <code>resource</code> referenced by the policy template.</p>
3472
- * </li>
3473
- * </ul>
2755
+ * <p>Specifies new statement content written in Cedar policy language to replace the current body of the policy template.</p> <p>You can change only the following elements of the policy body:</p> <ul> <li> <p>The <code>action</code> referenced by the policy template.</p> </li> <li> <p>Any conditional clauses, such as <code>when</code> or <code>unless</code> clauses.</p> </li> </ul> <p>You <b>can't</b> change the following elements:</p> <ul> <li> <p>The effect (<code>permit</code> or <code>forbid</code>) of the policy template.</p> </li> <li> <p>The <code>principal</code> referenced by the policy template.</p> </li> <li> <p>The <code>resource</code> referenced by the policy template.</p> </li> </ul>
3474
2756
  * @public
3475
2757
  */
3476
2758
  statement: string | undefined;
@@ -3501,10 +2783,7 @@ export interface UpdatePolicyTemplateOutput {
3501
2783
  lastUpdatedDate: Date | undefined;
3502
2784
  }
3503
2785
  /**
3504
- * <p>Contains a list of principal types, resource types, and actions that can be specified
3505
- * in policies stored in the same policy store. If the validation mode for the policy store is set to
3506
- * <code>STRICT</code>, then policies that can't be validated by this schema are
3507
- * rejected by Verified Permissions and can't be stored in the policy store.</p>
2786
+ * <p>Contains a list of principal types, resource types, and actions that can be specified in policies stored in the same policy store. If the validation mode for the policy store is set to <code>STRICT</code>, then policies that can't be validated by this schema are rejected by Verified Permissions and can't be stored in the policy store.</p>
3508
2787
  * @public
3509
2788
  */
3510
2789
  export type SchemaDefinition = SchemaDefinition.CedarJsonMember | SchemaDefinition.$UnknownMember;
@@ -3513,10 +2792,7 @@ export type SchemaDefinition = SchemaDefinition.CedarJsonMember | SchemaDefiniti
3513
2792
  */
3514
2793
  export declare namespace SchemaDefinition {
3515
2794
  /**
3516
- * <p>A JSON string representation of the schema supported by applications that use this
3517
- * policy store. To delete the schema, run <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_PutSchema.html">PutSchema</a> with <code>\{\}</code> for
3518
- * this parameter. For more information, see <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/userguide/schema.html">Policy store schema</a> in the
3519
- * <i>Amazon Verified Permissions User Guide</i>.</p>
2795
+ * <p>A JSON string representation of the schema supported by applications that use this policy store. To delete the schema, run <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_PutSchema.html">PutSchema</a> with <code>\{\}</code> for this parameter. For more information, see <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/userguide/schema.html">Policy store schema</a> in the <i>Amazon Verified Permissions User Guide</i>.</p>
3520
2796
  * @public
3521
2797
  */
3522
2798
  interface CedarJsonMember {
@@ -3546,8 +2822,7 @@ export interface PutSchemaInput {
3546
2822
  */
3547
2823
  policyStoreId: string | undefined;
3548
2824
  /**
3549
- * <p>Specifies the definition of the schema to be stored. The schema definition must be
3550
- * written in Cedar schema JSON.</p>
2825
+ * <p>Specifies the definition of the schema to be stored. The schema definition must be written in Cedar schema JSON.</p>
3551
2826
  * @public
3552
2827
  */
3553
2828
  definition: SchemaDefinition | undefined;
@@ -3587,20 +2862,17 @@ export interface UpdatePolicyStoreInput {
3587
2862
  */
3588
2863
  policyStoreId: string | undefined;
3589
2864
  /**
3590
- * <p>A structure that defines the validation settings that want to enable for the
3591
- * policy store.</p>
2865
+ * <p>A structure that defines the validation settings that want to enable for the policy store.</p>
3592
2866
  * @public
3593
2867
  */
3594
2868
  validationSettings: ValidationSettings | undefined;
3595
2869
  /**
3596
- * <p>Specifies whether the policy store can be deleted. If enabled, the policy store can't be deleted.</p>
3597
- * <p>When you call <code>UpdatePolicyStore</code>, this parameter is unchanged unless explicitly included in the call.</p>
2870
+ * <p>Specifies whether the policy store can be deleted. If enabled, the policy store can't be deleted.</p> <p>When you call <code>UpdatePolicyStore</code>, this parameter is unchanged unless explicitly included in the call.</p>
3598
2871
  * @public
3599
2872
  */
3600
2873
  deletionProtection?: DeletionProtection | undefined;
3601
2874
  /**
3602
- * <p>Descriptive text that you can provide to help with identification
3603
- * of the current policy store.</p>
2875
+ * <p>Descriptive text that you can provide to help with identification of the current policy store.</p>
3604
2876
  * @public
3605
2877
  */
3606
2878
  description?: string | undefined;
@@ -3631,12 +2903,64 @@ export interface UpdatePolicyStoreOutput {
3631
2903
  lastUpdatedDate: Date | undefined;
3632
2904
  }
3633
2905
  /**
3634
- * <p>The value of an attribute.</p>
3635
- * <p>Contains information about the runtime context for a request for which an
3636
- * authorization decision is made. </p>
3637
- * <p>This data type is used as a member of the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ContextDefinition.html">ContextDefinition</a> structure
3638
- * which is uses as a request parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html">IsAuthorized</a>, <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_BatchIsAuthorized.html">BatchIsAuthorized</a>, and <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html">IsAuthorizedWithToken</a>
3639
- * operations.</p>
2906
+ * @public
2907
+ */
2908
+ export interface TagResourceInput {
2909
+ /**
2910
+ * <p>The ARN of the resource that you're adding tags to.</p>
2911
+ * @public
2912
+ */
2913
+ resourceArn: string | undefined;
2914
+ /**
2915
+ * <p>The list of key-value pairs to associate with the resource.</p>
2916
+ * @public
2917
+ */
2918
+ tags: Record<string, string> | undefined;
2919
+ }
2920
+ /**
2921
+ * @public
2922
+ */
2923
+ export interface TagResourceOutput {
2924
+ }
2925
+ /**
2926
+ * <p>No more tags be added because the limit (50) has been reached. To add new tags, use <code>UntagResource</code> to remove existing tags.</p>
2927
+ * @public
2928
+ */
2929
+ export declare class TooManyTagsException extends __BaseException {
2930
+ readonly name: "TooManyTagsException";
2931
+ readonly $fault: "client";
2932
+ /**
2933
+ * An Amazon Resource Name (ARN) uniquely identifies an AWS resource.
2934
+ * @public
2935
+ */
2936
+ resourceName?: string | undefined;
2937
+ /**
2938
+ * @internal
2939
+ */
2940
+ constructor(opts: __ExceptionOptionType<TooManyTagsException, __BaseException>);
2941
+ }
2942
+ /**
2943
+ * @public
2944
+ */
2945
+ export interface UntagResourceInput {
2946
+ /**
2947
+ * <p>The ARN of the resource from which you are removing tags.</p>
2948
+ * @public
2949
+ */
2950
+ resourceArn: string | undefined;
2951
+ /**
2952
+ * <p>The list of tag keys to remove from the resource.</p>
2953
+ * @public
2954
+ */
2955
+ tagKeys: string[] | undefined;
2956
+ }
2957
+ /**
2958
+ * @public
2959
+ */
2960
+ export interface UntagResourceOutput {
2961
+ }
2962
+ /**
2963
+ * <p>The value of an attribute.</p> <p>Contains information about the runtime context for a request for which an authorization decision is made. </p> <p>This data type is used as a member of the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ContextDefinition.html">ContextDefinition</a> structure which is uses as a request parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html">IsAuthorized</a>, <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_BatchIsAuthorized.html">BatchIsAuthorized</a>, and <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html">IsAuthorizedWithToken</a> operations.</p>
3640
2964
  * @public
3641
2965
  */
3642
2966
  export type AttributeValue = AttributeValue.BooleanMember | AttributeValue.DecimalMember | AttributeValue.EntityIdentifierMember | AttributeValue.IpaddrMember | AttributeValue.LongMember | AttributeValue.RecordMember | AttributeValue.SetMember | AttributeValue.StringMember | AttributeValue.$UnknownMember;
@@ -3645,10 +2969,7 @@ export type AttributeValue = AttributeValue.BooleanMember | AttributeValue.Decim
3645
2969
  */
3646
2970
  export declare namespace AttributeValue {
3647
2971
  /**
3648
- * <p>An attribute value of <a href="https://docs.cedarpolicy.com/policies/syntax-datatypes.html#boolean">Boolean</a>
3649
- * type.</p>
3650
- * <p>Example: <code>\{"boolean": true\}</code>
3651
- * </p>
2972
+ * <p>An attribute value of <a href="https://docs.cedarpolicy.com/policies/syntax-datatypes.html#boolean">Boolean</a> type.</p> <p>Example: <code>\{"boolean": true\}</code> </p>
3652
2973
  * @public
3653
2974
  */
3654
2975
  interface BooleanMember {
@@ -3663,10 +2984,7 @@ export declare namespace AttributeValue {
3663
2984
  $unknown?: never;
3664
2985
  }
3665
2986
  /**
3666
- * <p>An attribute value of type <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_EntityIdentifier.html">EntityIdentifier</a>.</p>
3667
- * <p>Example: <code>"entityIdentifier": \{ "entityId": "&lt;id&gt;", "entityType":
3668
- * "&lt;entity type&gt;"\}</code>
3669
- * </p>
2987
+ * <p>An attribute value of type <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_EntityIdentifier.html">EntityIdentifier</a>.</p> <p>Example: <code>"entityIdentifier": \{ "entityId": "&lt;id&gt;", "entityType": "&lt;entity type&gt;"\}</code> </p>
3670
2988
  * @public
3671
2989
  */
3672
2990
  interface EntityIdentifierMember {
@@ -3681,9 +2999,7 @@ export declare namespace AttributeValue {
3681
2999
  $unknown?: never;
3682
3000
  }
3683
3001
  /**
3684
- * <p>An attribute value of <a href="https://docs.cedarpolicy.com/policies/syntax-datatypes.html#long">Long</a> type.</p>
3685
- * <p>Example: <code>\{"long": 0\}</code>
3686
- * </p>
3002
+ * <p>An attribute value of <a href="https://docs.cedarpolicy.com/policies/syntax-datatypes.html#long">Long</a> type.</p> <p>Example: <code>\{"long": 0\}</code> </p>
3687
3003
  * @public
3688
3004
  */
3689
3005
  interface LongMember {
@@ -3698,10 +3014,7 @@ export declare namespace AttributeValue {
3698
3014
  $unknown?: never;
3699
3015
  }
3700
3016
  /**
3701
- * <p>An attribute value of <a href="https://docs.cedarpolicy.com/policies/syntax-datatypes.html#string">String</a>
3702
- * type.</p>
3703
- * <p>Example: <code>\{"string": "abc"\}</code>
3704
- * </p>
3017
+ * <p>An attribute value of <a href="https://docs.cedarpolicy.com/policies/syntax-datatypes.html#string">String</a> type.</p> <p>Example: <code>\{"string": "abc"\}</code> </p>
3705
3018
  * @public
3706
3019
  */
3707
3020
  interface StringMember {
@@ -3716,9 +3029,7 @@ export declare namespace AttributeValue {
3716
3029
  $unknown?: never;
3717
3030
  }
3718
3031
  /**
3719
- * <p>An attribute value of <a href="https://docs.cedarpolicy.com/policies/syntax-datatypes.html#set">Set</a> type.</p>
3720
- * <p>Example: <code>\{"set": [ \{\} ] \}</code>
3721
- * </p>
3032
+ * <p>An attribute value of <a href="https://docs.cedarpolicy.com/policies/syntax-datatypes.html#set">Set</a> type.</p> <p>Example: <code>\{"set": [ \{\} ] \}</code> </p>
3722
3033
  * @public
3723
3034
  */
3724
3035
  interface SetMember {
@@ -3733,10 +3044,7 @@ export declare namespace AttributeValue {
3733
3044
  $unknown?: never;
3734
3045
  }
3735
3046
  /**
3736
- * <p>An attribute value of <a href="https://docs.cedarpolicy.com/policies/syntax-datatypes.html#record">Record</a>
3737
- * type.</p>
3738
- * <p>Example: <code>\{"record": \{ "keyName": \{\} \} \}</code>
3739
- * </p>
3047
+ * <p>An attribute value of <a href="https://docs.cedarpolicy.com/policies/syntax-datatypes.html#record">Record</a> type.</p> <p>Example: <code>\{"record": \{ "keyName": \{\} \} \}</code> </p>
3740
3048
  * @public
3741
3049
  */
3742
3050
  interface RecordMember {
@@ -3751,10 +3059,7 @@ export declare namespace AttributeValue {
3751
3059
  $unknown?: never;
3752
3060
  }
3753
3061
  /**
3754
- * <p>An attribute value of <a href="https://docs.cedarpolicy.com/policies/syntax-datatypes.html#datatype-ipaddr">ipaddr</a>
3755
- * type.</p>
3756
- * <p>Example: <code>\{"ip": "192.168.1.100"\}</code>
3757
- * </p>
3062
+ * <p>An attribute value of <a href="https://docs.cedarpolicy.com/policies/syntax-datatypes.html#datatype-ipaddr">ipaddr</a> type.</p> <p>Example: <code>\{"ip": "192.168.1.100"\}</code> </p>
3758
3063
  * @public
3759
3064
  */
3760
3065
  interface IpaddrMember {
@@ -3769,9 +3074,7 @@ export declare namespace AttributeValue {
3769
3074
  $unknown?: never;
3770
3075
  }
3771
3076
  /**
3772
- * <p>An attribute value of <a href="https://docs.cedarpolicy.com/policies/syntax-datatypes.html#datatype-decimal">decimal</a> type.</p>
3773
- * <p>Example: <code>\{"decimal": "1.1"\}</code>
3774
- * </p>
3077
+ * <p>An attribute value of <a href="https://docs.cedarpolicy.com/policies/syntax-datatypes.html#datatype-decimal">decimal</a> type.</p> <p>Example: <code>\{"decimal": "1.1"\}</code> </p>
3775
3078
  * @public
3776
3079
  */
3777
3080
  interface DecimalMember {
@@ -3813,18 +3116,7 @@ export declare namespace AttributeValue {
3813
3116
  const visit: <T>(value: AttributeValue, visitor: Visitor<T>) => T;
3814
3117
  }
3815
3118
  /**
3816
- * <p>Contains additional details about the context of the request. Verified Permissions evaluates this
3817
- * information in an authorization request as part of the <code>when</code> and
3818
- * <code>unless</code> clauses in a policy.</p>
3819
- * <p>This data type is used as a request parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html">IsAuthorized</a>, <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_BatchIsAuthorized.html">BatchIsAuthorized</a>, and <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html">IsAuthorizedWithToken</a>
3820
- * operations.</p>
3821
- * <p>If you're passing context as part of the request, exactly one instance of
3822
- * <code>context</code> must be passed. If you don't want to pass context, omit the
3823
- * <code>context</code> parameter from your request rather than sending <code>context
3824
- * \{\}</code>.</p>
3825
- * <p>Example:
3826
- * <code>"context":\{"contextMap":\{"&lt;KeyName1&gt;":\{"boolean":true\},"&lt;KeyName2&gt;":\{"long":1234\}\}\}</code>
3827
- * </p>
3119
+ * <p>Contains additional details about the context of the request. Verified Permissions evaluates this information in an authorization request as part of the <code>when</code> and <code>unless</code> clauses in a policy.</p> <p>This data type is used as a request parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html">IsAuthorized</a>, <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_BatchIsAuthorized.html">BatchIsAuthorized</a>, and <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html">IsAuthorizedWithToken</a> operations.</p> <p>If you're passing context as part of the request, exactly one instance of <code>context</code> must be passed. If you don't want to pass context, omit the <code>context</code> parameter from your request rather than sending <code>context \{\}</code>.</p> <p>Example: <code>"context":\{"contextMap":\{"&lt;KeyName1&gt;":\{"boolean":true\},"&lt;KeyName2&gt;":\{"long":1234\}\}\}</code> </p>
3828
3120
  * @public
3829
3121
  */
3830
3122
  export type ContextDefinition = ContextDefinition.CedarJsonMember | ContextDefinition.ContextMapMember | ContextDefinition.$UnknownMember;
@@ -3833,12 +3125,7 @@ export type ContextDefinition = ContextDefinition.CedarJsonMember | ContextDefin
3833
3125
  */
3834
3126
  export declare namespace ContextDefinition {
3835
3127
  /**
3836
- * <p>An list of attributes that are needed to successfully evaluate an authorization
3837
- * request. Each attribute in this array must include a map of a data type and its
3838
- * value.</p>
3839
- * <p>Example:
3840
- * <code>"contextMap":\{"&lt;KeyName1&gt;":\{"boolean":true\},"&lt;KeyName2&gt;":\{"long":1234\}\}</code>
3841
- * </p>
3128
+ * <p>An list of attributes that are needed to successfully evaluate an authorization request. Each attribute in this array must include a map of a data type and its value.</p> <p>Example: <code>"contextMap":\{"&lt;KeyName1&gt;":\{"boolean":true\},"&lt;KeyName2&gt;":\{"long":1234\}\}</code> </p>
3842
3129
  * @public
3843
3130
  */
3844
3131
  interface ContextMapMember {
@@ -3847,11 +3134,7 @@ export declare namespace ContextDefinition {
3847
3134
  $unknown?: never;
3848
3135
  }
3849
3136
  /**
3850
- * <p>A Cedar JSON string representation of the context needed to successfully evaluate an authorization
3851
- * request.</p>
3852
- * <p>Example:
3853
- * <code>\{"cedarJson":"\{\"&lt;KeyName1&gt;\": true, \"&lt;KeyName2&gt;\": 1234\}" \}</code>
3854
- * </p>
3137
+ * <p>A Cedar JSON string representation of the context needed to successfully evaluate an authorization request.</p> <p>Example: <code>\{"cedarJson":"\{\"&lt;KeyName1&gt;\": true, \"&lt;KeyName2&gt;\": 1234\}" \}</code> </p>
3855
3138
  * @public
3856
3139
  */
3857
3140
  interface CedarJsonMember {
@@ -3875,15 +3158,7 @@ export declare namespace ContextDefinition {
3875
3158
  const visit: <T>(value: ContextDefinition, visitor: Visitor<T>) => T;
3876
3159
  }
3877
3160
  /**
3878
- * <p>Contains information about an entity that can be referenced in a Cedar
3879
- * policy.</p>
3880
- * <p>This data type is used as one of the fields in the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_EntitiesDefinition.html">EntitiesDefinition</a>
3881
- * structure.</p>
3882
- * <p>
3883
- * <code>\{ "identifier": \{ "entityType": "Photo", "entityId": "VacationPhoto94.jpg" \},
3884
- * "attributes": \{\}, "parents": [ \{ "entityType": "Album", "entityId": "alice_folder" \}
3885
- * ] \}</code>
3886
- * </p>
3161
+ * <p>Contains information about an entity that can be referenced in a Cedar policy.</p> <p>This data type is used as one of the fields in the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_EntitiesDefinition.html">EntitiesDefinition</a> structure.</p> <p> <code>\{ "identifier": \{ "entityType": "Photo", "entityId": "VacationPhoto94.jpg" \}, "attributes": \{\}, "parents": [ \{ "entityType": "Album", "entityId": "alice_folder" \} ] \}</code> </p>
3887
3162
  * @public
3888
3163
  */
3889
3164
  export interface EntityItem {
@@ -3898,20 +3173,13 @@ export interface EntityItem {
3898
3173
  */
3899
3174
  attributes?: Record<string, AttributeValue> | undefined;
3900
3175
  /**
3901
- * <p>The parent entities in the hierarchy that contains the entity. A principal or resource
3902
- * entity can be defined with at most 99 <i>transitive parents</i> per
3903
- * authorization request. </p>
3904
- * <p>A transitive parent is an entity in the hierarchy of entities including all direct
3905
- * parents, and parents of parents. For example, a user can be a member of 91 groups if one
3906
- * of those groups is a member of eight groups, for a total of 100: one entity, 91 entity
3907
- * parents, and eight parents of parents. </p>
3176
+ * <p>The parent entities in the hierarchy that contains the entity. A principal or resource entity can be defined with at most 99 <i>transitive parents</i> per authorization request. </p> <p>A transitive parent is an entity in the hierarchy of entities including all direct parents, and parents of parents. For example, a user can be a member of 91 groups if one of those groups is a member of eight groups, for a total of 100: one entity, 91 entity parents, and eight parents of parents. </p>
3908
3177
  * @public
3909
3178
  */
3910
3179
  parents?: EntityIdentifier[] | undefined;
3911
3180
  }
3912
3181
  /**
3913
- * <p>An authorization request that you include in a <code>BatchIsAuthorized</code> API
3914
- * request.</p>
3182
+ * <p>An authorization request that you include in a <code>BatchIsAuthorized</code> API request.</p>
3915
3183
  * @public
3916
3184
  */
3917
3185
  export interface BatchIsAuthorizedInputItem {
@@ -3921,52 +3189,44 @@ export interface BatchIsAuthorizedInputItem {
3921
3189
  */
3922
3190
  principal?: EntityIdentifier | undefined;
3923
3191
  /**
3924
- * <p>Specifies the requested action to be authorized. For example,
3925
- * <code>PhotoFlash::ReadPhoto</code>.</p>
3192
+ * <p>Specifies the requested action to be authorized. For example, <code>PhotoFlash::ReadPhoto</code>.</p>
3926
3193
  * @public
3927
3194
  */
3928
3195
  action?: ActionIdentifier | undefined;
3929
3196
  /**
3930
- * <p>Specifies the resource that you want an authorization decision for. For example,
3931
- * <code>PhotoFlash::Photo</code>.</p>
3197
+ * <p>Specifies the resource that you want an authorization decision for. For example, <code>PhotoFlash::Photo</code>.</p>
3932
3198
  * @public
3933
3199
  */
3934
3200
  resource?: EntityIdentifier | undefined;
3935
3201
  /**
3936
- * <p>Specifies additional context that can be used to make more granular authorization
3937
- * decisions.</p>
3202
+ * <p>Specifies additional context that can be used to make more granular authorization decisions.</p>
3938
3203
  * @public
3939
3204
  */
3940
3205
  context?: ContextDefinition | undefined;
3941
3206
  }
3942
3207
  /**
3943
- * <p>An authorization request that you include in a <code>BatchIsAuthorizedWithToken</code>
3944
- * API request.</p>
3208
+ * <p>An authorization request that you include in a <code>BatchIsAuthorizedWithToken</code> API request.</p>
3945
3209
  * @public
3946
3210
  */
3947
3211
  export interface BatchIsAuthorizedWithTokenInputItem {
3948
3212
  /**
3949
- * <p>Specifies the requested action to be authorized. For example,
3950
- * <code>PhotoFlash::ReadPhoto</code>.</p>
3213
+ * <p>Specifies the requested action to be authorized. For example, <code>PhotoFlash::ReadPhoto</code>.</p>
3951
3214
  * @public
3952
3215
  */
3953
3216
  action?: ActionIdentifier | undefined;
3954
3217
  /**
3955
- * <p>Specifies the resource that you want an authorization decision for. For example,
3956
- * <code>PhotoFlash::Photo</code>.</p>
3218
+ * <p>Specifies the resource that you want an authorization decision for. For example, <code>PhotoFlash::Photo</code>.</p>
3957
3219
  * @public
3958
3220
  */
3959
3221
  resource?: EntityIdentifier | undefined;
3960
3222
  /**
3961
- * <p>Specifies additional context that can be used to make more granular authorization
3962
- * decisions.</p>
3223
+ * <p>Specifies additional context that can be used to make more granular authorization decisions.</p>
3963
3224
  * @public
3964
3225
  */
3965
3226
  context?: ContextDefinition | undefined;
3966
3227
  }
3967
3228
  /**
3968
- * <p>The decision, based on policy evaluation, from an individual authorization request in
3969
- * a <code>BatchIsAuthorized</code> API request.</p>
3229
+ * <p>The decision, based on policy evaluation, from an individual authorization request in a <code>BatchIsAuthorized</code> API request.</p>
3970
3230
  * @public
3971
3231
  */
3972
3232
  export interface BatchIsAuthorizedOutputItem {
@@ -3976,31 +3236,23 @@ export interface BatchIsAuthorizedOutputItem {
3976
3236
  */
3977
3237
  request: BatchIsAuthorizedInputItem | undefined;
3978
3238
  /**
3979
- * <p>An authorization decision that indicates if the authorization request should be
3980
- * allowed or denied.</p>
3239
+ * <p>An authorization decision that indicates if the authorization request should be allowed or denied.</p>
3981
3240
  * @public
3982
3241
  */
3983
3242
  decision: Decision | undefined;
3984
3243
  /**
3985
- * <p>The list of determining policies used to make the authorization decision. For example,
3986
- * if there are two matching policies, where one is a forbid and the other is a permit,
3987
- * then the forbid policy will be the determining policy. In the case of multiple matching
3988
- * permit policies then there would be multiple determining policies. In the case that no
3989
- * policies match, and hence the response is DENY, there would be no determining
3990
- * policies.</p>
3244
+ * <p>The list of determining policies used to make the authorization decision. For example, if there are two matching policies, where one is a forbid and the other is a permit, then the forbid policy will be the determining policy. In the case of multiple matching permit policies then there would be multiple determining policies. In the case that no policies match, and hence the response is DENY, there would be no determining policies.</p>
3991
3245
  * @public
3992
3246
  */
3993
3247
  determiningPolicies: DeterminingPolicyItem[] | undefined;
3994
3248
  /**
3995
- * <p>Errors that occurred while making an authorization decision. For example, a policy
3996
- * might reference an entity or attribute that doesn't exist in the request.</p>
3249
+ * <p>Errors that occurred while making an authorization decision. For example, a policy might reference an entity or attribute that doesn't exist in the request.</p>
3997
3250
  * @public
3998
3251
  */
3999
3252
  errors: EvaluationErrorItem[] | undefined;
4000
3253
  }
4001
3254
  /**
4002
- * <p>The decision, based on policy evaluation, from an individual authorization request in
4003
- * a <code>BatchIsAuthorizedWithToken</code> API request.</p>
3255
+ * <p>The decision, based on policy evaluation, from an individual authorization request in a <code>BatchIsAuthorizedWithToken</code> API request.</p>
4004
3256
  * @public
4005
3257
  */
4006
3258
  export interface BatchIsAuthorizedWithTokenOutputItem {
@@ -4010,34 +3262,23 @@ export interface BatchIsAuthorizedWithTokenOutputItem {
4010
3262
  */
4011
3263
  request: BatchIsAuthorizedWithTokenInputItem | undefined;
4012
3264
  /**
4013
- * <p>An authorization decision that indicates if the authorization request should be
4014
- * allowed or denied.</p>
3265
+ * <p>An authorization decision that indicates if the authorization request should be allowed or denied.</p>
4015
3266
  * @public
4016
3267
  */
4017
3268
  decision: Decision | undefined;
4018
3269
  /**
4019
- * <p>The list of determining policies used to make the authorization decision. For example,
4020
- * if there are two matching policies, where one is a forbid and the other is a permit,
4021
- * then the forbid policy will be the determining policy. In the case of multiple matching
4022
- * permit policies then there would be multiple determining policies. In the case that no
4023
- * policies match, and hence the response is DENY, there would be no determining
4024
- * policies.</p>
3270
+ * <p>The list of determining policies used to make the authorization decision. For example, if there are two matching policies, where one is a forbid and the other is a permit, then the forbid policy will be the determining policy. In the case of multiple matching permit policies then there would be multiple determining policies. In the case that no policies match, and hence the response is DENY, there would be no determining policies.</p>
4025
3271
  * @public
4026
3272
  */
4027
3273
  determiningPolicies: DeterminingPolicyItem[] | undefined;
4028
3274
  /**
4029
- * <p>Errors that occurred while making an authorization decision. For example, a policy
4030
- * might reference an entity or attribute that doesn't exist in the request.</p>
3275
+ * <p>Errors that occurred while making an authorization decision. For example, a policy might reference an entity or attribute that doesn't exist in the request.</p>
4031
3276
  * @public
4032
3277
  */
4033
3278
  errors: EvaluationErrorItem[] | undefined;
4034
3279
  }
4035
3280
  /**
4036
- * <p>Contains the list of entities to be considered during an authorization request. This
4037
- * includes all principals, resources, and actions required to successfully evaluate the
4038
- * request.</p>
4039
- * <p>This data type is used as a field in the response parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html">IsAuthorized</a>
4040
- * and <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html">IsAuthorizedWithToken</a> operations.</p>
3281
+ * <p>Contains the list of entities to be considered during an authorization request. This includes all principals, resources, and actions required to successfully evaluate the request.</p> <p>This data type is used as a field in the response parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html">IsAuthorized</a> and <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html">IsAuthorizedWithToken</a> operations.</p>
4041
3282
  * @public
4042
3283
  */
4043
3284
  export type EntitiesDefinition = EntitiesDefinition.CedarJsonMember | EntitiesDefinition.EntityListMember | EntitiesDefinition.$UnknownMember;
@@ -4046,13 +3287,7 @@ export type EntitiesDefinition = EntitiesDefinition.CedarJsonMember | EntitiesDe
4046
3287
  */
4047
3288
  export declare namespace EntitiesDefinition {
4048
3289
  /**
4049
- * <p>An array of entities that are needed to successfully evaluate an authorization
4050
- * request. Each entity in this array must include an identifier for the entity, the
4051
- * attributes of the entity, and a list of any parent entities.</p>
4052
- * <note>
4053
- * <p>If you include multiple entities with the same <code>identifier</code>, only the
4054
- * last one is processed in the request.</p>
4055
- * </note>
3290
+ * <p>An array of entities that are needed to successfully evaluate an authorization request. Each entity in this array must include an identifier for the entity, the attributes of the entity, and a list of any parent entities.</p> <note> <p>If you include multiple entities with the same <code>identifier</code>, only the last one is processed in the request.</p> </note>
4056
3291
  * @public
4057
3292
  */
4058
3293
  interface EntityListMember {
@@ -4061,11 +3296,7 @@ export declare namespace EntitiesDefinition {
4061
3296
  $unknown?: never;
4062
3297
  }
4063
3298
  /**
4064
- * <p>A Cedar JSON string representation of the entities needed to successfully evaluate an authorization
4065
- * request.</p>
4066
- * <p>Example:
4067
- * <code>\{"cedarJson": "[\{\"uid\":\{\"type\":\"Photo\",\"id\":\"VacationPhoto94.jpg\"\},\"attrs\":\{\"accessLevel\":\"public\"\},\"parents\":[]\}]"\}</code>
4068
- * </p>
3299
+ * <p>A Cedar JSON string representation of the entities needed to successfully evaluate an authorization request.</p> <p>Example: <code>\{"cedarJson": "[\{\"uid\":\{\"type\":\"Photo\",\"id\":\"VacationPhoto94.jpg\"\},\"attrs\":\{\"accessLevel\":\"public\"\},\"parents\":[]\}]"\}</code> </p>
4069
3300
  * @public
4070
3301
  */
4071
3302
  interface CedarJsonMember {
@@ -4093,8 +3324,7 @@ export declare namespace EntitiesDefinition {
4093
3324
  */
4094
3325
  export interface BatchIsAuthorizedOutput {
4095
3326
  /**
4096
- * <p>A series of <code>Allow</code> or <code>Deny</code> decisions for each request, and
4097
- * the policies that produced them. These results are returned in the order they were requested.</p>
3327
+ * <p>A series of <code>Allow</code> or <code>Deny</code> decisions for each request, and the policies that produced them. These results are returned in the order they were requested.</p>
4098
3328
  * @public
4099
3329
  */
4100
3330
  results: BatchIsAuthorizedOutputItem[] | undefined;
@@ -4109,8 +3339,7 @@ export interface BatchIsAuthorizedWithTokenOutput {
4109
3339
  */
4110
3340
  principal?: EntityIdentifier | undefined;
4111
3341
  /**
4112
- * <p>A series of <code>Allow</code> or <code>Deny</code> decisions for each request, and
4113
- * the policies that produced them. These results are returned in the order they were requested.</p>
3342
+ * <p>A series of <code>Allow</code> or <code>Deny</code> decisions for each request, and the policies that produced them. These results are returned in the order they were requested.</p>
4114
3343
  * @public
4115
3344
  */
4116
3345
  results: BatchIsAuthorizedWithTokenOutputItem[] | undefined;
@@ -4120,8 +3349,7 @@ export interface BatchIsAuthorizedWithTokenOutput {
4120
3349
  */
4121
3350
  export interface IsAuthorizedInput {
4122
3351
  /**
4123
- * <p>Specifies the ID of the policy store. Policies in this policy store will be used to make an
4124
- * authorization decision for the input.</p>
3352
+ * <p>Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization decision for the input.</p>
4125
3353
  * @public
4126
3354
  */
4127
3355
  policyStoreId: string | undefined;
@@ -4131,8 +3359,7 @@ export interface IsAuthorizedInput {
4131
3359
  */
4132
3360
  principal?: EntityIdentifier | undefined;
4133
3361
  /**
4134
- * <p>Specifies the requested action to be authorized. For example, is the principal
4135
- * authorized to perform this action on the resource?</p>
3362
+ * <p>Specifies the requested action to be authorized. For example, is the principal authorized to perform this action on the resource?</p>
4136
3363
  * @public
4137
3364
  */
4138
3365
  action?: ActionIdentifier | undefined;
@@ -4142,18 +3369,12 @@ export interface IsAuthorizedInput {
4142
3369
  */
4143
3370
  resource?: EntityIdentifier | undefined;
4144
3371
  /**
4145
- * <p>Specifies additional context that can be used to make more granular authorization
4146
- * decisions.</p>
3372
+ * <p>Specifies additional context that can be used to make more granular authorization decisions.</p>
4147
3373
  * @public
4148
3374
  */
4149
3375
  context?: ContextDefinition | undefined;
4150
3376
  /**
4151
- * <p>Specifies the list of resources and principals and their associated attributes that
4152
- * Verified Permissions can examine when evaluating the policies. </p>
4153
- * <note>
4154
- * <p>You can include only principal and resource entities in this parameter; you can't
4155
- * include actions. You must specify actions in the schema.</p>
4156
- * </note>
3377
+ * <p>(Optional) Specifies the list of resources and principals and their associated attributes that Verified Permissions can examine when evaluating the policies. These additional entities and their attributes can be referenced and checked by conditional elements in the policies in the specified policy store.</p> <note> <p>You can include only principal and resource entities in this parameter; you can't include actions. You must specify actions in the schema.</p> </note>
4157
3378
  * @public
4158
3379
  */
4159
3380
  entities?: EntitiesDefinition | undefined;
@@ -4163,71 +3384,37 @@ export interface IsAuthorizedInput {
4163
3384
  */
4164
3385
  export interface IsAuthorizedWithTokenInput {
4165
3386
  /**
4166
- * <p>Specifies the ID of the policy store. Policies in this policy store will be used to make an
4167
- * authorization decision for the input.</p>
3387
+ * <p>Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization decision for the input.</p>
4168
3388
  * @public
4169
3389
  */
4170
3390
  policyStoreId: string | undefined;
4171
3391
  /**
4172
- * <p>Specifies an identity token for the principal to be authorized. This token is provided
4173
- * to you by the identity provider (IdP) associated with the specified identity source. You must
4174
- * specify either an <code>accessToken</code>, an <code>identityToken</code>, or
4175
- * both.</p>
4176
- * <p>Must be an ID token. Verified Permissions returns an error if the <code>token_use</code> claim in the
4177
- * submitted token isn't <code>id</code>.</p>
3392
+ * <p>Specifies an identity token for the principal to be authorized. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an <code>accessToken</code>, an <code>identityToken</code>, or both.</p> <p>Must be an ID token. Verified Permissions returns an error if the <code>token_use</code> claim in the submitted token isn't <code>id</code>.</p>
4178
3393
  * @public
4179
3394
  */
4180
3395
  identityToken?: string | undefined;
4181
3396
  /**
4182
- * <p>Specifies an access token for the principal to be authorized. This token is provided
4183
- * to you by the identity provider (IdP) associated with the specified identity source. You must
4184
- * specify either an <code>accessToken</code>, an <code>identityToken</code>, or
4185
- * both.</p>
4186
- * <p>Must be an access token. Verified Permissions returns an error if the <code>token_use</code> claim in
4187
- * the submitted token isn't <code>access</code>.</p>
3397
+ * <p>Specifies an access token for the principal to be authorized. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an <code>accessToken</code>, an <code>identityToken</code>, or both.</p> <p>Must be an access token. Verified Permissions returns an error if the <code>token_use</code> claim in the submitted token isn't <code>access</code>.</p>
4188
3398
  * @public
4189
3399
  */
4190
3400
  accessToken?: string | undefined;
4191
3401
  /**
4192
- * <p>Specifies the requested action to be authorized. Is the specified principal authorized
4193
- * to perform this action on the specified resource.</p>
3402
+ * <p>Specifies the requested action to be authorized. Is the specified principal authorized to perform this action on the specified resource.</p>
4194
3403
  * @public
4195
3404
  */
4196
3405
  action?: ActionIdentifier | undefined;
4197
3406
  /**
4198
- * <p>Specifies the resource for which the authorization decision is made. For example, is
4199
- * the principal allowed to perform the action on the resource?</p>
3407
+ * <p>Specifies the resource for which the authorization decision is made. For example, is the principal allowed to perform the action on the resource?</p>
4200
3408
  * @public
4201
3409
  */
4202
3410
  resource?: EntityIdentifier | undefined;
4203
3411
  /**
4204
- * <p>Specifies additional context that can be used to make more granular authorization
4205
- * decisions.</p>
3412
+ * <p>Specifies additional context that can be used to make more granular authorization decisions.</p>
4206
3413
  * @public
4207
3414
  */
4208
3415
  context?: ContextDefinition | undefined;
4209
3416
  /**
4210
- * <p>Specifies the list of resources and their associated attributes that Verified Permissions can examine
4211
- * when evaluating the policies. </p>
4212
- * <important>
4213
- * <p>You can't include principals in this parameter, only resource and action entities.
4214
- * This parameter can't include any entities of a type that matches the user or group
4215
- * entity types that you defined in your identity source.</p>
4216
- * <ul>
4217
- * <li>
4218
- * <p>The <code>IsAuthorizedWithToken</code> operation takes principal
4219
- * attributes from <b>
4220
- * <i>only</i>
4221
- * </b>
4222
- * the <code>identityToken</code> or <code>accessToken</code> passed to the
4223
- * operation.</p>
4224
- * </li>
4225
- * <li>
4226
- * <p>For action entities, you can include only their <code>Identifier</code>
4227
- * and <code>EntityType</code>. </p>
4228
- * </li>
4229
- * </ul>
4230
- * </important>
3417
+ * <p>(Optional) Specifies the list of resources and their associated attributes that Verified Permissions can examine when evaluating the policies. These additional entities and their attributes can be referenced and checked by conditional elements in the policies in the specified policy store.</p> <important> <p>You can't include principals in this parameter, only resource and action entities. This parameter can't include any entities of a type that matches the user or group entity types that you defined in your identity source.</p> <ul> <li> <p>The <code>IsAuthorizedWithToken</code> operation takes principal attributes from <b> <i>only</i> </b> the <code>identityToken</code> or <code>accessToken</code> passed to the operation.</p> </li> <li> <p>For action entities, you can include only their <code>Identifier</code> and <code>EntityType</code>. </p> </li> </ul> </important>
4231
3418
  * @public
4232
3419
  */
4233
3420
  entities?: EntitiesDefinition | undefined;
@@ -4237,18 +3424,12 @@ export interface IsAuthorizedWithTokenInput {
4237
3424
  */
4238
3425
  export interface BatchIsAuthorizedInput {
4239
3426
  /**
4240
- * <p>Specifies the ID of the policy store. Policies in this policy store will be used to make the
4241
- * authorization decisions for the input.</p>
3427
+ * <p>Specifies the ID of the policy store. Policies in this policy store will be used to make the authorization decisions for the input.</p>
4242
3428
  * @public
4243
3429
  */
4244
3430
  policyStoreId: string | undefined;
4245
3431
  /**
4246
- * <p>Specifies the list of resources and principals and their associated attributes that
4247
- * Verified Permissions can examine when evaluating the policies. </p>
4248
- * <note>
4249
- * <p>You can include only principal and resource entities in this parameter; you can't
4250
- * include actions. You must specify actions in the schema.</p>
4251
- * </note>
3432
+ * <p>(Optional) Specifies the list of resources and principals and their associated attributes that Verified Permissions can examine when evaluating the policies. These additional entities and their attributes can be referenced and checked by conditional elements in the policies in the specified policy store.</p> <note> <p>You can include only principal and resource entities in this parameter; you can't include actions. You must specify actions in the schema.</p> </note>
4252
3433
  * @public
4253
3434
  */
4254
3435
  entities?: EntitiesDefinition | undefined;
@@ -4263,53 +3444,22 @@ export interface BatchIsAuthorizedInput {
4263
3444
  */
4264
3445
  export interface BatchIsAuthorizedWithTokenInput {
4265
3446
  /**
4266
- * <p>Specifies the ID of the policy store. Policies in this policy store will be used to make an
4267
- * authorization decision for the input.</p>
3447
+ * <p>Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization decision for the input.</p>
4268
3448
  * @public
4269
3449
  */
4270
3450
  policyStoreId: string | undefined;
4271
3451
  /**
4272
- * <p>Specifies an identity (ID) token for the principal that you want to authorize in each
4273
- * request. This token is provided to you by the identity provider (IdP) associated with
4274
- * the specified identity source. You must specify either an <code>accessToken</code>, an
4275
- * <code>identityToken</code>, or both.</p>
4276
- * <p>Must be an ID token. Verified Permissions returns an error if the <code>token_use</code> claim in the
4277
- * submitted token isn't <code>id</code>.</p>
3452
+ * <p>Specifies an identity (ID) token for the principal that you want to authorize in each request. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an <code>accessToken</code>, an <code>identityToken</code>, or both.</p> <p>Must be an ID token. Verified Permissions returns an error if the <code>token_use</code> claim in the submitted token isn't <code>id</code>.</p>
4278
3453
  * @public
4279
3454
  */
4280
3455
  identityToken?: string | undefined;
4281
3456
  /**
4282
- * <p>Specifies an access token for the principal that you want to authorize in each
4283
- * request. This token is provided to you by the identity provider (IdP) associated with
4284
- * the specified identity source. You must specify either an <code>accessToken</code>, an
4285
- * <code>identityToken</code>, or both.</p>
4286
- * <p>Must be an access token. Verified Permissions returns an error if the <code>token_use</code> claim in
4287
- * the submitted token isn't <code>access</code>.</p>
3457
+ * <p>Specifies an access token for the principal that you want to authorize in each request. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an <code>accessToken</code>, an <code>identityToken</code>, or both.</p> <p>Must be an access token. Verified Permissions returns an error if the <code>token_use</code> claim in the submitted token isn't <code>access</code>.</p>
4288
3458
  * @public
4289
3459
  */
4290
3460
  accessToken?: string | undefined;
4291
3461
  /**
4292
- * <p>Specifies the list of resources and their associated attributes that Verified Permissions can examine
4293
- * when evaluating the policies. </p>
4294
- * <important>
4295
- * <p>You can't include principals in this parameter, only resource and action entities.
4296
- * This parameter can't include any entities of a type that matches the user or group
4297
- * entity types that you defined in your identity source.</p>
4298
- * <ul>
4299
- * <li>
4300
- * <p>The <code>BatchIsAuthorizedWithToken</code> operation takes principal
4301
- * attributes from <b>
4302
- * <i>only</i>
4303
- * </b>
4304
- * the <code>identityToken</code> or <code>accessToken</code> passed to the
4305
- * operation.</p>
4306
- * </li>
4307
- * <li>
4308
- * <p>For action entities, you can include only their <code>Identifier</code>
4309
- * and <code>EntityType</code>. </p>
4310
- * </li>
4311
- * </ul>
4312
- * </important>
3462
+ * <p>(Optional) Specifies the list of resources and their associated attributes that Verified Permissions can examine when evaluating the policies. These additional entities and their attributes can be referenced and checked by conditional elements in the policies in the specified policy store.</p> <important> <p>You can't include principals in this parameter, only resource and action entities. This parameter can't include any entities of a type that matches the user or group entity types that you defined in your identity source.</p> <ul> <li> <p>The <code>BatchIsAuthorizedWithToken</code> operation takes principal attributes from <b> <i>only</i> </b> the <code>identityToken</code> or <code>accessToken</code> passed to the operation.</p> </li> <li> <p>For action entities, you can include only their <code>Identifier</code> and <code>EntityType</code>. </p> </li> </ul> </important>
4313
3463
  * @public
4314
3464
  */
4315
3465
  entities?: EntitiesDefinition | undefined;