@aws-sdk/client-verifiedpermissions 3.799.0 → 3.801.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 +1 -1
@@ -27,25 +27,7 @@ declare const BatchIsAuthorizedWithTokenCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Makes a series of decisions about multiple authorization requests for one token. The
31
- * principal in this request comes from an external identity source in the form of an identity or
32
- * access token, formatted as a <a href="https://wikipedia.org/wiki/JSON_Web_Token">JSON
33
- * web token (JWT)</a>. The information in the parameters can also define
34
- * additional context that Verified Permissions can include in the evaluations.</p>
35
- * <p>The request is evaluated against all policies in the specified policy store that match the
36
- * entities that you provide in the entities declaration and in the token. The result of
37
- * the decisions is a series of <code>Allow</code> or <code>Deny</code> responses, along
38
- * with the IDs of the policies that produced each decision.</p>
39
- * <p>The <code>entities</code> of a <code>BatchIsAuthorizedWithToken</code> API request can
40
- * contain up to 100 resources and up to 99 user groups. The <code>requests</code> of a
41
- * <code>BatchIsAuthorizedWithToken</code> API request can contain up to 30
42
- * requests.</p>
43
- * <note>
44
- * <p>The <code>BatchIsAuthorizedWithToken</code> operation doesn't have its own
45
- * IAM permission. To authorize this operation for Amazon Web Services principals, include the
46
- * permission <code>verifiedpermissions:IsAuthorizedWithToken</code> in their IAM
47
- * policies.</p>
48
- * </note>
30
+ * <p>Makes a series of decisions about multiple authorization requests for one token. The principal in this request comes from an external identity source in the form of an identity or access token, formatted as a <a href="https://wikipedia.org/wiki/JSON_Web_Token">JSON web token (JWT)</a>. The information in the parameters can also define additional context that Verified Permissions can include in the evaluations.</p> <p>The request is evaluated against all policies in the specified policy store that match the entities that you provide in the entities declaration and in the token. The result of the decisions is a series of <code>Allow</code> or <code>Deny</code> responses, along with the IDs of the policies that produced each decision.</p> <p>The <code>entities</code> of a <code>BatchIsAuthorizedWithToken</code> API request can contain up to 100 resources and up to 99 user groups. The <code>requests</code> of a <code>BatchIsAuthorizedWithToken</code> API request can contain up to 30 requests.</p> <note> <p>The <code>BatchIsAuthorizedWithToken</code> operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission <code>verifiedpermissions:IsAuthorizedWithToken</code> in their IAM policies.</p> </note>
49
31
  * @example
50
32
  * Use a bare-bones client and the command you need to make an API call.
51
33
  * ```javascript
@@ -205,88 +187,7 @@ declare const BatchIsAuthorizedWithTokenCommand_base: {
205
187
  * <p>The request failed because it exceeded a throttling quota.</p>
206
188
  *
207
189
  * @throws {@link ValidationException} (client fault)
208
- * <p>The request failed because one or more input parameters don't satisfy their constraint
209
- * requirements. The output is provided as a list of fields and a reason for each field that
210
- * isn't valid.</p>
211
- * <p>The possible reasons include the following:</p>
212
- * <ul>
213
- * <li>
214
- * <p>
215
- * <b>UnrecognizedEntityType</b>
216
- * </p>
217
- * <p>The policy includes an entity type that isn't found in the schema.</p>
218
- * </li>
219
- * <li>
220
- * <p>
221
- * <b>UnrecognizedActionId</b>
222
- * </p>
223
- * <p>The policy includes an action id that isn't found in the schema.</p>
224
- * </li>
225
- * <li>
226
- * <p>
227
- * <b>InvalidActionApplication</b>
228
- * </p>
229
- * <p>The policy includes an action that, according to the schema, doesn't support
230
- * the specified principal and resource.</p>
231
- * </li>
232
- * <li>
233
- * <p>
234
- * <b>UnexpectedType</b>
235
- * </p>
236
- * <p>The policy included an operand that isn't a valid type for the specified
237
- * operation.</p>
238
- * </li>
239
- * <li>
240
- * <p>
241
- * <b>IncompatibleTypes</b>
242
- * </p>
243
- * <p>The types of elements included in a <code>set</code>, or the types of
244
- * expressions used in an <code>if...then...else</code> clause aren't compatible in
245
- * this context.</p>
246
- * </li>
247
- * <li>
248
- * <p>
249
- * <b>MissingAttribute</b>
250
- * </p>
251
- * <p>The policy attempts to access a record or entity attribute that isn't
252
- * specified in the schema. Test for the existence of the attribute first before
253
- * 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
254
- * <i>Cedar Policy Language Guide</i>.</p>
255
- * </li>
256
- * <li>
257
- * <p>
258
- * <b>UnsafeOptionalAttributeAccess</b>
259
- * </p>
260
- * <p>The policy attempts to access a record or entity attribute that is optional
261
- * and isn't guaranteed to be present. Test for the existence of the attribute
262
- * first before attempting to access its value. For more information, see the
263
- * <a href="https://docs.cedarpolicy.com/policies/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in the
264
- * <i>Cedar Policy Language Guide</i>.</p>
265
- * </li>
266
- * <li>
267
- * <p>
268
- * <b>ImpossiblePolicy</b>
269
- * </p>
270
- * <p>Cedar has determined that a policy condition always evaluates to false. If
271
- * the policy is always false, it can never apply to any query, and so it can never
272
- * affect an authorization decision.</p>
273
- * </li>
274
- * <li>
275
- * <p>
276
- * <b>WrongNumberArguments</b>
277
- * </p>
278
- * <p>The policy references an extension type with the wrong number of
279
- * arguments.</p>
280
- * </li>
281
- * <li>
282
- * <p>
283
- * <b>FunctionArgumentValidationError</b>
284
- * </p>
285
- * <p>Cedar couldn't parse the argument passed to an extension type. For example,
286
- * a string that is to be parsed as an IPv4 address can contain only digits and the
287
- * period character.</p>
288
- * </li>
289
- * </ul>
190
+ * <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>
290
191
  *
291
192
  * @throws {@link VerifiedPermissionsServiceException}
292
193
  * <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
@@ -27,43 +27,7 @@ declare const CreateIdentitySourceCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Adds an identity source to a policy store–an Amazon Cognito user pool or OpenID Connect
31
- * (OIDC) identity provider (IdP).
32
- * </p>
33
- * <p>After you create an identity source, you can use the identities provided by the IdP as proxies
34
- * for the principal in authorization queries that use the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html">IsAuthorizedWithToken</a> or
35
- * <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_BatchIsAuthorizedWithToken.html">BatchIsAuthorizedWithToken</a> API operations. These identities take the form
36
- * of tokens that contain claims about the user, such as IDs, attributes and group
37
- * memberships. Identity sources provide identity (ID) tokens and access tokens. Verified Permissions
38
- * derives information about your user and session from token claims. Access tokens provide
39
- * action <code>context</code> to your policies, and ID tokens provide principal
40
- * <code>Attributes</code>.</p>
41
- * <important>
42
- * <p>Tokens from an identity source user continue to be usable until they expire.
43
- * Token revocation and resource deletion have no effect on the validity of a token in your policy store</p>
44
- * </important>
45
- * <note>
46
- * <p>To reference a user from this identity source in your Cedar policies, refer to the
47
- * following syntax examples.</p>
48
- * <ul>
49
- * <li>
50
- * <p>Amazon Cognito user pool: <code>Namespace::[Entity type]::[User pool ID]|[user
51
- * principal attribute]</code>, for example
52
- * <code>MyCorp::User::us-east-1_EXAMPLE|a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</code>.</p>
53
- * </li>
54
- * <li>
55
- * <p>OpenID Connect (OIDC) provider: <code>Namespace::[Entity
56
- * type]::[entityIdPrefix]|[user principal attribute]</code>, for example
57
- * <code>MyCorp::User::MyOIDCProvider|a1b2c3d4-5678-90ab-cdef-EXAMPLE22222</code>.</p>
58
- * </li>
59
- * </ul>
60
- * </note>
61
- * <note>
62
- * <p>Verified Permissions is <i>
63
- * <a href="https://wikipedia.org/wiki/Eventual_consistency">eventually consistent</a>
64
- * </i>. It can take a few seconds for a new or changed element to propagate through
65
- * the service and be visible in the results of other Verified Permissions operations.</p>
66
- * </note>
30
+ * <p>Adds an identity source to a policy store–an Amazon Cognito user pool or OpenID Connect (OIDC) identity provider (IdP). </p> <p>After you create an identity source, you can use the identities provided by the IdP as proxies for the principal in authorization queries that use the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html">IsAuthorizedWithToken</a> or <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_BatchIsAuthorizedWithToken.html">BatchIsAuthorizedWithToken</a> API operations. These identities take the form of tokens that contain claims about the user, such as IDs, attributes and group memberships. Identity sources provide identity (ID) tokens and access tokens. Verified Permissions derives information about your user and session from token claims. Access tokens provide action <code>context</code> to your policies, and ID tokens provide principal <code>Attributes</code>.</p> <important> <p>Tokens from an identity source user continue to be usable until they expire. Token revocation and resource deletion have no effect on the validity of a token in your policy store</p> </important> <note> <p>To reference a user from this identity source in your Cedar policies, refer to the following syntax examples.</p> <ul> <li> <p>Amazon Cognito user pool: <code>Namespace::[Entity type]::[User pool ID]|[user principal attribute]</code>, for example <code>MyCorp::User::us-east-1_EXAMPLE|a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</code>.</p> </li> <li> <p>OpenID Connect (OIDC) provider: <code>Namespace::[Entity type]::[entityIdPrefix]|[user principal attribute]</code>, for example <code>MyCorp::User::MyOIDCProvider|a1b2c3d4-5678-90ab-cdef-EXAMPLE22222</code>.</p> </li> </ul> </note> <note> <p>Verified Permissions is <i> <a href="https://wikipedia.org/wiki/Eventual_consistency">eventually consistent</a> </i>. It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.</p> </note>
67
31
  * @example
68
32
  * Use a bare-bones client and the command you need to make an API call.
69
33
  * ```javascript
@@ -126,8 +90,7 @@ declare const CreateIdentitySourceCommand_base: {
126
90
  * @see {@link VerifiedPermissionsClientResolvedConfig | config} for VerifiedPermissionsClient's `config` shape.
127
91
  *
128
92
  * @throws {@link ConflictException} (client fault)
129
- * <p>The request failed because another request to modify a resource occurred at the
130
- * same.</p>
93
+ * <p>The request failed because another request to modify a resource occurred at the same.</p>
131
94
  *
132
95
  * @throws {@link ResourceNotFoundException} (client fault)
133
96
  * <p>The request failed because it references a resource that doesn't exist.</p>
@@ -145,88 +108,7 @@ declare const CreateIdentitySourceCommand_base: {
145
108
  * <p>The request failed because it exceeded a throttling quota.</p>
146
109
  *
147
110
  * @throws {@link ValidationException} (client fault)
148
- * <p>The request failed because one or more input parameters don't satisfy their constraint
149
- * requirements. The output is provided as a list of fields and a reason for each field that
150
- * isn't valid.</p>
151
- * <p>The possible reasons include the following:</p>
152
- * <ul>
153
- * <li>
154
- * <p>
155
- * <b>UnrecognizedEntityType</b>
156
- * </p>
157
- * <p>The policy includes an entity type that isn't found in the schema.</p>
158
- * </li>
159
- * <li>
160
- * <p>
161
- * <b>UnrecognizedActionId</b>
162
- * </p>
163
- * <p>The policy includes an action id that isn't found in the schema.</p>
164
- * </li>
165
- * <li>
166
- * <p>
167
- * <b>InvalidActionApplication</b>
168
- * </p>
169
- * <p>The policy includes an action that, according to the schema, doesn't support
170
- * the specified principal and resource.</p>
171
- * </li>
172
- * <li>
173
- * <p>
174
- * <b>UnexpectedType</b>
175
- * </p>
176
- * <p>The policy included an operand that isn't a valid type for the specified
177
- * operation.</p>
178
- * </li>
179
- * <li>
180
- * <p>
181
- * <b>IncompatibleTypes</b>
182
- * </p>
183
- * <p>The types of elements included in a <code>set</code>, or the types of
184
- * expressions used in an <code>if...then...else</code> clause aren't compatible in
185
- * this context.</p>
186
- * </li>
187
- * <li>
188
- * <p>
189
- * <b>MissingAttribute</b>
190
- * </p>
191
- * <p>The policy attempts to access a record or entity attribute that isn't
192
- * specified in the schema. Test for the existence of the attribute first before
193
- * 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
194
- * <i>Cedar Policy Language Guide</i>.</p>
195
- * </li>
196
- * <li>
197
- * <p>
198
- * <b>UnsafeOptionalAttributeAccess</b>
199
- * </p>
200
- * <p>The policy attempts to access a record or entity attribute that is optional
201
- * and isn't guaranteed to be present. Test for the existence of the attribute
202
- * first before attempting to access its value. For more information, see the
203
- * <a href="https://docs.cedarpolicy.com/policies/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in the
204
- * <i>Cedar Policy Language Guide</i>.</p>
205
- * </li>
206
- * <li>
207
- * <p>
208
- * <b>ImpossiblePolicy</b>
209
- * </p>
210
- * <p>Cedar has determined that a policy condition always evaluates to false. If
211
- * the policy is always false, it can never apply to any query, and so it can never
212
- * affect an authorization decision.</p>
213
- * </li>
214
- * <li>
215
- * <p>
216
- * <b>WrongNumberArguments</b>
217
- * </p>
218
- * <p>The policy references an extension type with the wrong number of
219
- * arguments.</p>
220
- * </li>
221
- * <li>
222
- * <p>
223
- * <b>FunctionArgumentValidationError</b>
224
- * </p>
225
- * <p>Cedar couldn't parse the argument passed to an extension type. For example,
226
- * a string that is to be parsed as an IPv4 address can contain only digits and the
227
- * period character.</p>
228
- * </li>
229
- * </ul>
111
+ * <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>
230
112
  *
231
113
  * @throws {@link VerifiedPermissionsServiceException}
232
114
  * <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
@@ -27,33 +27,7 @@ declare const CreatePolicyCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a Cedar policy and saves it in the specified policy store. You can create either a
31
- * static policy or a policy linked to a policy template.</p>
32
- * <ul>
33
- * <li>
34
- * <p>To create a static policy, provide the Cedar policy text in the
35
- * <code>StaticPolicy</code> section of the
36
- * <code>PolicyDefinition</code>.</p>
37
- * </li>
38
- * <li>
39
- * <p>To create a policy that is dynamically linked to a policy template, specify the policy template ID
40
- * and the principal and resource to associate with this policy in the
41
- * <code>templateLinked</code> section of the <code>PolicyDefinition</code>. If the
42
- * policy template is ever updated, any policies linked to the policy template automatically use the
43
- * updated template.</p>
44
- * </li>
45
- * </ul>
46
- * <note>
47
- * <p>Creating a policy causes it to be validated against the schema in the policy store. If the
48
- * policy doesn't pass validation, the operation fails and the policy isn't
49
- * stored.</p>
50
- * </note>
51
- * <note>
52
- * <p>Verified Permissions is <i>
53
- * <a href="https://wikipedia.org/wiki/Eventual_consistency">eventually consistent</a>
54
- * </i>. It can take a few seconds for a new or changed element to propagate through
55
- * the service and be visible in the results of other Verified Permissions operations.</p>
56
- * </note>
30
+ * <p>Creates a Cedar policy and saves it in the specified policy store. You can create either a static policy or a policy linked to a policy template.</p> <ul> <li> <p>To create a static policy, provide the Cedar policy text in the <code>StaticPolicy</code> section of the <code>PolicyDefinition</code>.</p> </li> <li> <p>To create a policy that is dynamically linked to a policy template, specify the policy template ID and the principal and resource to associate with this policy in the <code>templateLinked</code> section of the <code>PolicyDefinition</code>. If the policy template is ever updated, any policies linked to the policy template automatically use the updated template.</p> </li> </ul> <note> <p>Creating a policy causes it to be validated against the schema in the policy store. If the policy doesn't pass validation, the operation fails and the policy isn't stored.</p> </note> <note> <p>Verified Permissions is <i> <a href="https://wikipedia.org/wiki/Eventual_consistency">eventually consistent</a> </i>. It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.</p> </note>
57
31
  * @example
58
32
  * Use a bare-bones client and the command you need to make an API call.
59
33
  * ```javascript
@@ -115,8 +89,7 @@ declare const CreatePolicyCommand_base: {
115
89
  * @see {@link VerifiedPermissionsClientResolvedConfig | config} for VerifiedPermissionsClient's `config` shape.
116
90
  *
117
91
  * @throws {@link ConflictException} (client fault)
118
- * <p>The request failed because another request to modify a resource occurred at the
119
- * same.</p>
92
+ * <p>The request failed because another request to modify a resource occurred at the same.</p>
120
93
  *
121
94
  * @throws {@link ResourceNotFoundException} (client fault)
122
95
  * <p>The request failed because it references a resource that doesn't exist.</p>
@@ -134,88 +107,7 @@ declare const CreatePolicyCommand_base: {
134
107
  * <p>The request failed because it exceeded a throttling quota.</p>
135
108
  *
136
109
  * @throws {@link ValidationException} (client fault)
137
- * <p>The request failed because one or more input parameters don't satisfy their constraint
138
- * requirements. The output is provided as a list of fields and a reason for each field that
139
- * isn't valid.</p>
140
- * <p>The possible reasons include the following:</p>
141
- * <ul>
142
- * <li>
143
- * <p>
144
- * <b>UnrecognizedEntityType</b>
145
- * </p>
146
- * <p>The policy includes an entity type that isn't found in the schema.</p>
147
- * </li>
148
- * <li>
149
- * <p>
150
- * <b>UnrecognizedActionId</b>
151
- * </p>
152
- * <p>The policy includes an action id that isn't found in the schema.</p>
153
- * </li>
154
- * <li>
155
- * <p>
156
- * <b>InvalidActionApplication</b>
157
- * </p>
158
- * <p>The policy includes an action that, according to the schema, doesn't support
159
- * the specified principal and resource.</p>
160
- * </li>
161
- * <li>
162
- * <p>
163
- * <b>UnexpectedType</b>
164
- * </p>
165
- * <p>The policy included an operand that isn't a valid type for the specified
166
- * operation.</p>
167
- * </li>
168
- * <li>
169
- * <p>
170
- * <b>IncompatibleTypes</b>
171
- * </p>
172
- * <p>The types of elements included in a <code>set</code>, or the types of
173
- * expressions used in an <code>if...then...else</code> clause aren't compatible in
174
- * this context.</p>
175
- * </li>
176
- * <li>
177
- * <p>
178
- * <b>MissingAttribute</b>
179
- * </p>
180
- * <p>The policy attempts to access a record or entity attribute that isn't
181
- * specified in the schema. Test for the existence of the attribute first before
182
- * 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
183
- * <i>Cedar Policy Language Guide</i>.</p>
184
- * </li>
185
- * <li>
186
- * <p>
187
- * <b>UnsafeOptionalAttributeAccess</b>
188
- * </p>
189
- * <p>The policy attempts to access a record or entity attribute that is optional
190
- * and isn't guaranteed to be present. Test for the existence of the attribute
191
- * first before attempting to access its value. For more information, see the
192
- * <a href="https://docs.cedarpolicy.com/policies/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in the
193
- * <i>Cedar Policy Language Guide</i>.</p>
194
- * </li>
195
- * <li>
196
- * <p>
197
- * <b>ImpossiblePolicy</b>
198
- * </p>
199
- * <p>Cedar has determined that a policy condition always evaluates to false. If
200
- * the policy is always false, it can never apply to any query, and so it can never
201
- * affect an authorization decision.</p>
202
- * </li>
203
- * <li>
204
- * <p>
205
- * <b>WrongNumberArguments</b>
206
- * </p>
207
- * <p>The policy references an extension type with the wrong number of
208
- * arguments.</p>
209
- * </li>
210
- * <li>
211
- * <p>
212
- * <b>FunctionArgumentValidationError</b>
213
- * </p>
214
- * <p>Cedar couldn't parse the argument passed to an extension type. For example,
215
- * a string that is to be parsed as an IPv4 address can contain only digits and the
216
- * period character.</p>
217
- * </li>
218
- * </ul>
110
+ * <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>
219
111
  *
220
112
  * @throws {@link VerifiedPermissionsServiceException}
221
113
  * <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
@@ -27,17 +27,7 @@ declare const CreatePolicyStoreCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a policy store. A policy store is a container for policy resources.</p>
31
- * <note>
32
- * <p>Although <a href="https://docs.cedarpolicy.com/schema/schema.html#namespace">Cedar supports multiple namespaces</a>, Verified Permissions currently supports only one
33
- * namespace per policy store.</p>
34
- * </note>
35
- * <note>
36
- * <p>Verified Permissions is <i>
37
- * <a href="https://wikipedia.org/wiki/Eventual_consistency">eventually consistent</a>
38
- * </i>. It can take a few seconds for a new or changed element to propagate through
39
- * the service and be visible in the results of other Verified Permissions operations.</p>
40
- * </note>
30
+ * <p>Creates a policy store. A policy store is a container for policy resources.</p> <note> <p>Although <a href="https://docs.cedarpolicy.com/schema/schema.html#namespace">Cedar supports multiple namespaces</a>, Verified Permissions currently supports only one namespace per policy store.</p> </note> <note> <p>Verified Permissions is <i> <a href="https://wikipedia.org/wiki/Eventual_consistency">eventually consistent</a> </i>. It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.</p> </note>
41
31
  * @example
42
32
  * Use a bare-bones client and the command you need to make an API call.
43
33
  * ```javascript
@@ -51,6 +41,9 @@ declare const CreatePolicyStoreCommand_base: {
51
41
  * },
52
42
  * description: "STRING_VALUE",
53
43
  * deletionProtection: "ENABLED" || "DISABLED",
44
+ * tags: { // TagMap
45
+ * "<keys>": "STRING_VALUE",
46
+ * },
54
47
  * };
55
48
  * const command = new CreatePolicyStoreCommand(input);
56
49
  * const response = await client.send(command);
@@ -70,8 +63,7 @@ declare const CreatePolicyStoreCommand_base: {
70
63
  * @see {@link VerifiedPermissionsClientResolvedConfig | config} for VerifiedPermissionsClient's `config` shape.
71
64
  *
72
65
  * @throws {@link ConflictException} (client fault)
73
- * <p>The request failed because another request to modify a resource occurred at the
74
- * same.</p>
66
+ * <p>The request failed because another request to modify a resource occurred at the same.</p>
75
67
  *
76
68
  * @throws {@link ServiceQuotaExceededException} (client fault)
77
69
  * <p>The request failed because it would cause a service quota to be exceeded.</p>
@@ -86,88 +78,7 @@ declare const CreatePolicyStoreCommand_base: {
86
78
  * <p>The request failed because it exceeded a throttling quota.</p>
87
79
  *
88
80
  * @throws {@link ValidationException} (client fault)
89
- * <p>The request failed because one or more input parameters don't satisfy their constraint
90
- * requirements. The output is provided as a list of fields and a reason for each field that
91
- * isn't valid.</p>
92
- * <p>The possible reasons include the following:</p>
93
- * <ul>
94
- * <li>
95
- * <p>
96
- * <b>UnrecognizedEntityType</b>
97
- * </p>
98
- * <p>The policy includes an entity type that isn't found in the schema.</p>
99
- * </li>
100
- * <li>
101
- * <p>
102
- * <b>UnrecognizedActionId</b>
103
- * </p>
104
- * <p>The policy includes an action id that isn't found in the schema.</p>
105
- * </li>
106
- * <li>
107
- * <p>
108
- * <b>InvalidActionApplication</b>
109
- * </p>
110
- * <p>The policy includes an action that, according to the schema, doesn't support
111
- * the specified principal and resource.</p>
112
- * </li>
113
- * <li>
114
- * <p>
115
- * <b>UnexpectedType</b>
116
- * </p>
117
- * <p>The policy included an operand that isn't a valid type for the specified
118
- * operation.</p>
119
- * </li>
120
- * <li>
121
- * <p>
122
- * <b>IncompatibleTypes</b>
123
- * </p>
124
- * <p>The types of elements included in a <code>set</code>, or the types of
125
- * expressions used in an <code>if...then...else</code> clause aren't compatible in
126
- * this context.</p>
127
- * </li>
128
- * <li>
129
- * <p>
130
- * <b>MissingAttribute</b>
131
- * </p>
132
- * <p>The policy attempts to access a record or entity attribute that isn't
133
- * specified in the schema. Test for the existence of the attribute first before
134
- * 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
135
- * <i>Cedar Policy Language Guide</i>.</p>
136
- * </li>
137
- * <li>
138
- * <p>
139
- * <b>UnsafeOptionalAttributeAccess</b>
140
- * </p>
141
- * <p>The policy attempts to access a record or entity attribute that is optional
142
- * and isn't guaranteed to be present. Test for the existence of the attribute
143
- * first before attempting to access its value. For more information, see the
144
- * <a href="https://docs.cedarpolicy.com/policies/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in the
145
- * <i>Cedar Policy Language Guide</i>.</p>
146
- * </li>
147
- * <li>
148
- * <p>
149
- * <b>ImpossiblePolicy</b>
150
- * </p>
151
- * <p>Cedar has determined that a policy condition always evaluates to false. If
152
- * the policy is always false, it can never apply to any query, and so it can never
153
- * affect an authorization decision.</p>
154
- * </li>
155
- * <li>
156
- * <p>
157
- * <b>WrongNumberArguments</b>
158
- * </p>
159
- * <p>The policy references an extension type with the wrong number of
160
- * arguments.</p>
161
- * </li>
162
- * <li>
163
- * <p>
164
- * <b>FunctionArgumentValidationError</b>
165
- * </p>
166
- * <p>Cedar couldn't parse the argument passed to an extension type. For example,
167
- * a string that is to be parsed as an IPv4 address can contain only digits and the
168
- * period character.</p>
169
- * </li>
170
- * </ul>
81
+ * <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>
171
82
  *
172
83
  * @throws {@link VerifiedPermissionsServiceException}
173
84
  * <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>