@aws-sdk/client-verifiedpermissions 3.774.0 → 3.777.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 (34) hide show
  1. package/dist-cjs/auth/httpAuthSchemeProvider.js +1 -3
  2. package/dist-cjs/index.js +17 -18
  3. package/dist-es/VerifiedPermissionsClient.js +2 -1
  4. package/dist-es/auth/httpAuthSchemeProvider.js +1 -3
  5. package/dist-es/endpoint/EndpointParameters.js +2 -3
  6. package/dist-es/runtimeExtensions.js +2 -14
  7. package/dist-types/commands/BatchGetPolicyCommand.d.ts +39 -39
  8. package/dist-types/commands/BatchIsAuthorizedCommand.d.ts +93 -93
  9. package/dist-types/commands/BatchIsAuthorizedWithTokenCommand.d.ts +74 -74
  10. package/dist-types/commands/CreateIdentitySourceCommand.d.ts +14 -14
  11. package/dist-types/commands/CreatePolicyCommand.d.ts +58 -60
  12. package/dist-types/commands/CreatePolicyStoreCommand.d.ts +10 -10
  13. package/dist-types/commands/CreatePolicyTemplateCommand.d.ts +19 -11
  14. package/dist-types/commands/DeleteIdentitySourceCommand.d.ts +8 -5
  15. package/dist-types/commands/DeletePolicyCommand.d.ts +8 -5
  16. package/dist-types/commands/DeletePolicyStoreCommand.d.ts +7 -4
  17. package/dist-types/commands/DeletePolicyTemplateCommand.d.ts +8 -5
  18. package/dist-types/commands/GetIdentitySourceCommand.d.ts +15 -15
  19. package/dist-types/commands/GetPolicyCommand.d.ts +17 -17
  20. package/dist-types/commands/GetPolicyStoreCommand.d.ts +10 -10
  21. package/dist-types/commands/GetPolicyTemplateCommand.d.ts +17 -11
  22. package/dist-types/commands/GetSchemaCommand.d.ts +34 -13
  23. package/dist-types/commands/IsAuthorizedCommand.d.ts +34 -35
  24. package/dist-types/commands/IsAuthorizedWithTokenCommand.d.ts +22 -22
  25. package/dist-types/commands/ListIdentitySourcesCommand.d.ts +15 -15
  26. package/dist-types/commands/ListPoliciesCommand.d.ts +90 -92
  27. package/dist-types/commands/ListPolicyStoresCommand.d.ts +11 -11
  28. package/dist-types/commands/ListPolicyTemplatesCommand.d.ts +15 -15
  29. package/dist-types/commands/PutSchemaCommand.d.ts +15 -15
  30. package/dist-types/commands/UpdateIdentitySourceCommand.d.ts +13 -13
  31. package/dist-types/commands/UpdatePolicyCommand.d.ts +16 -16
  32. package/dist-types/commands/UpdatePolicyStoreCommand.d.ts +10 -10
  33. package/dist-types/commands/UpdatePolicyTemplateCommand.d.ts +24 -16
  34. package/package.json +33 -33
@@ -210,171 +210,169 @@ declare const ListPoliciesCommand_base: {
210
210
  * @throws {@link VerifiedPermissionsServiceException}
211
211
  * <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
212
212
  *
213
- * @public
213
+ *
214
214
  * @example ListPolicies - Example 1
215
215
  * ```javascript
216
216
  * // The following example lists all policies in the policy store.
217
217
  * const input = {
218
- * "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a"
218
+ * policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a"
219
219
  * };
220
220
  * const command = new ListPoliciesCommand(input);
221
221
  * const response = await client.send(command);
222
- * /* response ==
222
+ * /* response is
223
223
  * {
224
- * "policies": [
224
+ * policies: [
225
225
  * {
226
- * "createdDate": "2024-08-12T18:20:50.99Z",
227
- * "definition": {
228
- * "static": {
229
- * "description": "Grant members of janeFriends UserGroup access to the vacationFolder Album"
226
+ * createdDate: "2024-08-12T18:20:50.99Z",
227
+ * definition: {
228
+ * static: {
229
+ * description: "Grant members of janeFriends UserGroup access to the vacationFolder Album"
230
230
  * }
231
231
  * },
232
- * "lastUpdatedDate": "2024-08-12T18:20:50.99Z",
233
- * "policyId": "9wYxMpljbbZQb5fcZHyJhY",
234
- * "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a",
235
- * "policyType": "STATIC",
236
- * "principal": {
237
- * "entityId": "janeFriends",
238
- * "entityType": "UserGroup"
232
+ * lastUpdatedDate: "2024-08-12T18:20:50.99Z",
233
+ * policyId: "9wYxMpljbbZQb5fcZHyJhY",
234
+ * policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
235
+ * policyType: "STATIC",
236
+ * principal: {
237
+ * entityId: "janeFriends",
238
+ * entityType: "UserGroup"
239
239
  * },
240
- * "resource": {
241
- * "entityId": "vacationFolder",
242
- * "entityType": "Album"
240
+ * resource: {
241
+ * entityId: "vacationFolder",
242
+ * entityType: "Album"
243
243
  * }
244
244
  * },
245
245
  * {
246
- * "createdDate": "2024-08-12T18:20:50.99Z",
247
- * "definition": {
248
- * "static": {
249
- * "description": "Grant everyone access to the publicFolder Album"
246
+ * createdDate: "2024-08-12T18:20:50.99Z",
247
+ * definition: {
248
+ * static: {
249
+ * description: "Grant everyone access to the publicFolder Album"
250
250
  * }
251
251
  * },
252
- * "lastUpdatedDate": "2024-08-12T18:20:50.99Z",
253
- * "policyId": "Et9KxMplyaDdyurDw8TeFa",
254
- * "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a",
255
- * "policyType": "STATIC",
256
- * "resource": {
257
- * "entityId": "publicFolder",
258
- * "entityType": "Album"
252
+ * lastUpdatedDate: "2024-08-12T18:20:50.99Z",
253
+ * policyId: "Et9KxMplyaDdyurDw8TeFa",
254
+ * policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
255
+ * policyType: "STATIC",
256
+ * resource: {
257
+ * entityId: "publicFolder",
258
+ * entityType: "Album"
259
259
  * }
260
260
  * }
261
261
  * ]
262
262
  * }
263
263
  * *\/
264
- * // example id: example-1
265
264
  * ```
266
265
  *
267
266
  * @example ListPolicies - Example 2
268
267
  * ```javascript
269
268
  * // The following example lists all policies for a specified principal.
270
269
  * const input = {
271
- * "filter": {
272
- * "principal": {
273
- * "identifier": {
274
- * "entityId": "alice",
275
- * "entityType": "User"
270
+ * filter: {
271
+ * principal: {
272
+ * identifier: {
273
+ * entityId: "alice",
274
+ * entityType: "User"
276
275
  * }
277
276
  * }
278
277
  * },
279
- * "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a"
278
+ * policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a"
280
279
  * };
281
280
  * const command = new ListPoliciesCommand(input);
282
281
  * const response = await client.send(command);
283
- * /* response ==
282
+ * /* response is
284
283
  * {
285
- * "policies": [
284
+ * policies: [
286
285
  * {
287
- * "createdDate": "2022-12-09T22:55:16.067533Z",
288
- * "definition": {
289
- * "static": {
290
- * "description": "An example policy"
286
+ * createdDate: "2022-12-09T22:55:16.067533Z",
287
+ * definition: {
288
+ * static: {
289
+ * description: "An example policy"
291
290
  * }
292
291
  * },
293
- * "lastUpdatedDate": "2022-12-09T22:55:16.067533Z",
294
- * "policyId": "Et9KxMplyaDdyurDw8TeFa",
295
- * "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a",
296
- * "policyType": "STATIC",
297
- * "principal": {
298
- * "entityId": "alice",
299
- * "entityType": "User"
292
+ * lastUpdatedDate: "2022-12-09T22:55:16.067533Z",
293
+ * policyId: "Et9KxMplyaDdyurDw8TeFa",
294
+ * policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
295
+ * policyType: "STATIC",
296
+ * principal: {
297
+ * entityId: "alice",
298
+ * entityType: "User"
300
299
  * },
301
- * "resource": {
302
- * "entityId": "bob_folder",
303
- * "entityType": "Album"
300
+ * resource: {
301
+ * entityId: "bob_folder",
302
+ * entityType: "Album"
304
303
  * }
305
304
  * },
306
305
  * {
307
- * "createdDate": "2022-12-09T23:00:24.66266Z",
308
- * "definition": {
309
- * "static": {}
306
+ * createdDate: "2022-12-09T23:00:24.66266Z",
307
+ * definition: {
308
+ * static: { /* empty *\/ }
310
309
  * },
311
- * "lastUpdatedDate": "2022-12-09T23:00:24.66266Z",
312
- * "policyId": "9wYxMpljbbZQb5fcZHyJhY",
313
- * "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a",
314
- * "policyType": "STATIC",
315
- * "principal": {
316
- * "entityId": "alice",
317
- * "entityType": "User"
310
+ * lastUpdatedDate: "2022-12-09T23:00:24.66266Z",
311
+ * policyId: "9wYxMpljbbZQb5fcZHyJhY",
312
+ * policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
313
+ * policyType: "STATIC",
314
+ * principal: {
315
+ * entityId: "alice",
316
+ * entityType: "User"
318
317
  * },
319
- * "resource": {
320
- * "entityId": "alice_folder",
321
- * "entityType": "Album"
318
+ * resource: {
319
+ * entityId: "alice_folder",
320
+ * entityType: "Album"
322
321
  * }
323
322
  * }
324
323
  * ]
325
324
  * }
326
325
  * *\/
327
- * // example id: example-2
328
326
  * ```
329
327
  *
330
328
  * @example ListPolicies - Example 3
331
329
  * ```javascript
332
330
  * // The following example uses the Filter parameter to list only the template-linked policies in the specified policy store.
333
331
  * const input = {
334
- * "filter": {
335
- * "policyType": "TEMPLATE_LINKED"
332
+ * filter: {
333
+ * policyType: "TEMPLATE_LINKED"
336
334
  * },
337
- * "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a"
335
+ * policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a"
338
336
  * };
339
337
  * const command = new ListPoliciesCommand(input);
340
338
  * const response = await client.send(command);
341
- * /* response ==
339
+ * /* response is
342
340
  * {
343
- * "policies": [
341
+ * policies: [
344
342
  * {
345
- * "createdDate": "2023-06-13T16:03:07.620867Z",
346
- * "definition": {
347
- * "templateLinked": {
348
- * "policyTemplateId": "PTEXAMPLEabcdefg111111",
349
- * "principal": {
350
- * "entityId": "alice",
351
- * "entityType": "User"
343
+ * createdDate: "2023-06-13T16:03:07.620867Z",
344
+ * definition: {
345
+ * templateLinked: {
346
+ * policyTemplateId: "PTEXAMPLEabcdefg111111",
347
+ * principal: {
348
+ * entityId: "alice",
349
+ * entityType: "User"
352
350
  * },
353
- * "resource": {
354
- * "entityId": "pic.jpg",
355
- * "entityType": "Photo"
351
+ * resource: {
352
+ * entityId: "pic.jpg",
353
+ * entityType: "Photo"
356
354
  * }
357
355
  * }
358
356
  * },
359
- * "lastUpdatedDate": "2023-06-13T16:03:07.620867Z",
360
- * "policyId": "9wYxMpljbbZQb5fcZHyJhY",
361
- * "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a",
362
- * "policyType": "TEMPLATE_LINKED",
363
- * "principal": {
364
- * "entityId": "alice",
365
- * "entityType": "User"
357
+ * lastUpdatedDate: "2023-06-13T16:03:07.620867Z",
358
+ * policyId: "9wYxMpljbbZQb5fcZHyJhY",
359
+ * policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
360
+ * policyType: "TEMPLATE_LINKED",
361
+ * principal: {
362
+ * entityId: "alice",
363
+ * entityType: "User"
366
364
  * },
367
- * "resource": {
368
- * "entityId": "pic.jpg",
369
- * "entityType": "Photo"
365
+ * resource: {
366
+ * entityId: "pic.jpg",
367
+ * entityType: "Photo"
370
368
  * }
371
369
  * }
372
370
  * ]
373
371
  * }
374
372
  * *\/
375
- * // example id: example-3
376
373
  * ```
377
374
  *
375
+ * @public
378
376
  */
379
377
  export declare class ListPoliciesCommand extends ListPoliciesCommand_base {
380
378
  /** @internal type navigation helper, not in runtime. */
@@ -157,32 +157,32 @@ declare const ListPolicyStoresCommand_base: {
157
157
  * @throws {@link VerifiedPermissionsServiceException}
158
158
  * <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
159
159
  *
160
- * @public
160
+ *
161
161
  * @example ListPolicyStores
162
162
  * ```javascript
163
163
  * // The following example lists all policy stores in the AWS account in the AWS Region in which you call the operation.
164
- * const input = {};
164
+ * const input = { /* empty *\/ };
165
165
  * const command = new ListPolicyStoresCommand(input);
166
166
  * const response = await client.send(command);
167
- * /* response ==
167
+ * /* response is
168
168
  * {
169
- * "policyStores": [
169
+ * policyStores: [
170
170
  * {
171
- * "arn": "arn:aws:verifiedpermissions::123456789012:policy-store/C7v5xMplfFH3i3e4Jrzb1a",
172
- * "createdDate": "2023-05-16T17:41:29.103459Z",
173
- * "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a"
171
+ * arn: "arn:aws:verifiedpermissions::123456789012:policy-store/C7v5xMplfFH3i3e4Jrzb1a",
172
+ * createdDate: "2023-05-16T17:41:29.103459Z",
173
+ * policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a"
174
174
  * },
175
175
  * {
176
- * "arn": "arn:aws:verifiedpermissions::123456789012:policy-store/PSEXAMPLEabcdefg222222",
177
- * "createdDate": "2023-05-16T18:23:04.985521Z",
178
- * "policyStoreId": "PSEXAMPLEabcdefg222222"
176
+ * arn: "arn:aws:verifiedpermissions::123456789012:policy-store/PSEXAMPLEabcdefg222222",
177
+ * createdDate: "2023-05-16T18:23:04.985521Z",
178
+ * policyStoreId: "PSEXAMPLEabcdefg222222"
179
179
  * }
180
180
  * ]
181
181
  * }
182
182
  * *\/
183
- * // example id: example-1
184
183
  * ```
185
184
  *
185
+ * @public
186
186
  */
187
187
  export declare class ListPolicyStoresCommand extends ListPolicyStoresCommand_base {
188
188
  /** @internal type navigation helper, not in runtime. */
@@ -161,38 +161,38 @@ declare const ListPolicyTemplatesCommand_base: {
161
161
  * @throws {@link VerifiedPermissionsServiceException}
162
162
  * <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
163
163
  *
164
- * @public
164
+ *
165
165
  * @example ListPolicyTemplates
166
166
  * ```javascript
167
167
  * // The following example retrieves a list of all of the policy templates in the specified policy store.
168
168
  * const input = {
169
- * "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a"
169
+ * policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a"
170
170
  * };
171
171
  * const command = new ListPolicyTemplatesCommand(input);
172
172
  * const response = await client.send(command);
173
- * /* response ==
173
+ * /* response is
174
174
  * {
175
- * "policyTemplates": [
175
+ * policyTemplates: [
176
176
  * {
177
- * "createdDate": "2024-08-12T18:20:50.99Z",
178
- * "description": "Generic template",
179
- * "lastUpdatedDate": "2024-08-12T18:20:50.99Z",
180
- * "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a",
181
- * "policyTemplateId": "PTEXAMPLEabcdefg111111"
177
+ * createdDate: "2024-08-12T18:20:50.99Z",
178
+ * description: "Generic template",
179
+ * lastUpdatedDate: "2024-08-12T18:20:50.99Z",
180
+ * policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
181
+ * policyTemplateId: "PTEXAMPLEabcdefg111111"
182
182
  * },
183
183
  * {
184
- * "createdDate": "2024-08-12T18:20:50.99Z",
185
- * "description": "Template for research dept",
186
- * "lastUpdatedDate": "2024-08-12T18:20:50.99Z",
187
- * "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a",
188
- * "policyTemplateId": "PTEXAMPLEabcdefg222222"
184
+ * createdDate: "2024-08-12T18:20:50.99Z",
185
+ * description: "Template for research dept",
186
+ * lastUpdatedDate: "2024-08-12T18:20:50.99Z",
187
+ * policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
188
+ * policyTemplateId: "PTEXAMPLEabcdefg222222"
189
189
  * }
190
190
  * ]
191
191
  * }
192
192
  * *\/
193
- * // example id: example-1
194
193
  * ```
195
194
  *
195
+ * @public
196
196
  */
197
197
  export declare class ListPolicyTemplatesCommand extends ListPolicyTemplatesCommand_base {
198
198
  /** @internal type navigation helper, not in runtime. */
@@ -175,36 +175,36 @@ declare const PutSchemaCommand_base: {
175
175
  * @throws {@link VerifiedPermissionsServiceException}
176
176
  * <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
177
177
  *
178
- * @public
178
+ *
179
179
  * @example PutSchema
180
180
  * ```javascript
181
181
  * // The following example creates a new schema, or updates an existing schema, in the specified policy store. Note that the schema text is shown line wrapped for readability. You should submit the entire schema text as a single line of text.
182
- * //
183
- * // Note
184
- * // The JSON in the parameters of this operation are strings that can contain embedded quotation marks (") within the outermost quotation mark pair. This requires that you stringify the JSON object by preceding all embedded quotation marks with a backslash character ( \" ) and combining all lines into a single text line with no line breaks.
185
- * //
186
- * // Example strings might be displayed wrapped across multiple lines here for readability, but the operation requires the parameters be submitted as single line strings.
182
+ *
183
+ * Note
184
+ * The JSON in the parameters of this operation are strings that can contain embedded quotation marks (") within the outermost quotation mark pair. This requires that you stringify the JSON object by preceding all embedded quotation marks with a backslash character ( \" ) and combining all lines into a single text line with no line breaks.
185
+ *
186
+ * Example strings might be displayed wrapped across multiple lines here for readability, but the operation requires the parameters be submitted as single line strings.
187
187
  * const input = {
188
- * "definition": {
189
- * "cedarJson": "{\"MySampleNamespace\": {\"actions\": {\"remoteAccess\": {\"appliesTo\": {\"principalTypes\": [\"Employee\"]}}},\"entityTypes\": {\"Employee\": {\"shape\": {\"attributes\": {\"jobLevel\": {\"type\": \"Long\"},\"name\": {\"type\": \"String\"}},\"type\": \"Record\"}}}}}"
188
+ * definition: {
189
+ * cedarJson: `{"MySampleNamespace": {"actions": {"remoteAccess": {"appliesTo": {"principalTypes": ["Employee"]}}},"entityTypes": {"Employee": {"shape": {"attributes": {"jobLevel": {"type": "Long"},"name": {"type": "String"}},"type": "Record"}}}}}`
190
190
  * },
191
- * "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a"
191
+ * policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a"
192
192
  * };
193
193
  * const command = new PutSchemaCommand(input);
194
194
  * const response = await client.send(command);
195
- * /* response ==
195
+ * /* response is
196
196
  * {
197
- * "createdDate": "2023-06-13T19:28:06.003726Z",
198
- * "lastUpdatedDate": "2023-06-13T19:28:06.003726Z",
199
- * "namespaces": [
197
+ * createdDate: "2023-06-13T19:28:06.003726Z",
198
+ * lastUpdatedDate: "2023-06-13T19:28:06.003726Z",
199
+ * namespaces: [
200
200
  * "My::Sample::Namespace"
201
201
  * ],
202
- * "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a"
202
+ * policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a"
203
203
  * }
204
204
  * *\/
205
- * // example id: example-1
206
205
  * ```
207
206
  *
207
+ * @public
208
208
  */
209
209
  export declare class PutSchemaCommand extends PutSchemaCommand_base {
210
210
  /** @internal type navigation helper, not in runtime. */
@@ -199,35 +199,35 @@ declare const UpdateIdentitySourceCommand_base: {
199
199
  * @throws {@link VerifiedPermissionsServiceException}
200
200
  * <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
201
201
  *
202
- * @public
202
+ *
203
203
  * @example UpdateIdentitySource
204
204
  * ```javascript
205
205
  * // The following example updates the configuration of the specified identity source with a new configuration.
206
206
  * const input = {
207
- * "identitySourceId": "ISEXAMPLEabcdefg111111",
208
- * "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a",
209
- * "updateConfiguration": {
210
- * "cognitoUserPoolConfiguration": {
211
- * "clientIds": [
207
+ * identitySourceId: "ISEXAMPLEabcdefg111111",
208
+ * policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
209
+ * updateConfiguration: {
210
+ * cognitoUserPoolConfiguration: {
211
+ * clientIds: [
212
212
  * "a1b2c3d4e5f6g7h8i9j0kalbmc"
213
213
  * ],
214
- * "userPoolArn": "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"
214
+ * userPoolArn: "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"
215
215
  * }
216
216
  * }
217
217
  * };
218
218
  * const command = new UpdateIdentitySourceCommand(input);
219
219
  * const response = await client.send(command);
220
- * /* response ==
220
+ * /* response is
221
221
  * {
222
- * "createdDate": "2023-05-19T20:30:28.173926Z",
223
- * "identitySourceId": "ISEXAMPLEabcdefg111111",
224
- * "lastUpdatedDate": "2023-05-22T20:45:59.962216Z",
225
- * "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a"
222
+ * createdDate: "2023-05-19T20:30:28.173926Z",
223
+ * identitySourceId: "ISEXAMPLEabcdefg111111",
224
+ * lastUpdatedDate: "2023-05-22T20:45:59.962216Z",
225
+ * policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a"
226
226
  * }
227
227
  * *\/
228
- * // example id: example-1
229
228
  * ```
230
229
  *
230
+ * @public
231
231
  */
232
232
  export declare class UpdateIdentitySourceCommand extends UpdateIdentitySourceCommand_base {
233
233
  /** @internal type navigation helper, not in runtime. */
@@ -233,37 +233,37 @@ declare const UpdatePolicyCommand_base: {
233
233
  * @throws {@link VerifiedPermissionsServiceException}
234
234
  * <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
235
235
  *
236
- * @public
236
+ *
237
237
  * @example UpdatePolicy
238
238
  * ```javascript
239
239
  * // The following example replaces the definition of the specified static policy with a new one.
240
240
  * const input = {
241
- * "definition": {
242
- * "static": {
243
- * "statement": "permit(principal, action, resource in Album::\"public_folder\");"
241
+ * definition: {
242
+ * static: {
243
+ * statement: `permit(principal, action, resource in Album::"public_folder");`
244
244
  * }
245
245
  * },
246
- * "policyId": "9wYxMpljbbZQb5fcZHyJhY",
247
- * "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a"
246
+ * policyId: "9wYxMpljbbZQb5fcZHyJhY",
247
+ * policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a"
248
248
  * };
249
249
  * const command = new UpdatePolicyCommand(input);
250
250
  * const response = await client.send(command);
251
- * /* response ==
251
+ * /* response is
252
252
  * {
253
- * "createdDate": "2024-08-12T18:20:50.99Z",
254
- * "lastUpdatedDate": "2024-08-12T18:20:50.99Z",
255
- * "policyId": "9wYxMpljbbZQb5fcZHyJhY",
256
- * "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a",
257
- * "policyType": "STATIC",
258
- * "resource": {
259
- * "entityId": "public_folder",
260
- * "entityType": "Album"
253
+ * createdDate: "2024-08-12T18:20:50.99Z",
254
+ * lastUpdatedDate: "2024-08-12T18:20:50.99Z",
255
+ * policyId: "9wYxMpljbbZQb5fcZHyJhY",
256
+ * policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
257
+ * policyType: "STATIC",
258
+ * resource: {
259
+ * entityId: "public_folder",
260
+ * entityType: "Album"
261
261
  * }
262
262
  * }
263
263
  * *\/
264
- * // example id: example-1
265
264
  * ```
266
265
  *
266
+ * @public
267
267
  */
268
268
  export declare class UpdatePolicyCommand extends UpdatePolicyCommand_base {
269
269
  /** @internal type navigation helper, not in runtime. */
@@ -167,29 +167,29 @@ declare const UpdatePolicyStoreCommand_base: {
167
167
  * @throws {@link VerifiedPermissionsServiceException}
168
168
  * <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
169
169
  *
170
- * @public
170
+ *
171
171
  * @example UpdatePolicyStore
172
172
  * ```javascript
173
173
  * // The following example turns off the validation settings for a policy store.
174
174
  * const input = {
175
- * "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a",
176
- * "validationSettings": {
177
- * "mode": "OFF"
175
+ * policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
176
+ * validationSettings: {
177
+ * mode: "OFF"
178
178
  * }
179
179
  * };
180
180
  * const command = new UpdatePolicyStoreCommand(input);
181
181
  * const response = await client.send(command);
182
- * /* response ==
182
+ * /* response is
183
183
  * {
184
- * "arn": "arn:aws:verifiedpermissions::123456789012:policy-store/C7v5xMplfFH3i3e4Jrzb1a",
185
- * "createdDate": "2023-05-17T18:36:10.134448Z",
186
- * "lastUpdatedDate": "2023-05-23T18:18:12.443083Z",
187
- * "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a"
184
+ * arn: "arn:aws:verifiedpermissions::123456789012:policy-store/C7v5xMplfFH3i3e4Jrzb1a",
185
+ * createdDate: "2023-05-17T18:36:10.134448Z",
186
+ * lastUpdatedDate: "2023-05-23T18:18:12.443083Z",
187
+ * policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a"
188
188
  * }
189
189
  * *\/
190
- * // example id: example-1
191
190
  * ```
192
191
  *
192
+ * @public
193
193
  */
194
194
  export declare class UpdatePolicyStoreCommand extends UpdatePolicyStoreCommand_base {
195
195
  /** @internal type navigation helper, not in runtime. */
@@ -172,34 +172,42 @@ declare const UpdatePolicyTemplateCommand_base: {
172
172
  * @throws {@link VerifiedPermissionsServiceException}
173
173
  * <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
174
174
  *
175
- * @public
175
+ *
176
176
  * @example UpdatePolicyTemplate
177
177
  * ```javascript
178
178
  * // The following example updates a policy template with both a new description and a new policy body. The effect, principal, and resource are the same as the original policy template. Only the action in the head, and the when and unless clauses can be different.
179
- * //
180
- * // Note
181
- * // The JSON in the parameters of this operation are strings that can contain embedded quotation marks (") within the outermost quotation mark pair. This requires that you stringify the JSON object by preceding all embedded quotation marks with a backslash character ( \" ) and combining all lines into a single text line with no line breaks.
182
- * //
183
- * // Example strings might be displayed wrapped across multiple lines here for readability, but the operation requires the parameters be submitted as single line strings.
179
+ *
180
+ * Note
181
+ * The JSON in the parameters of this operation are strings that can contain embedded quotation marks (") within the outermost quotation mark pair. This requires that you stringify the JSON object by preceding all embedded quotation marks with a backslash character ( \" ) and combining all lines into a single text line with no line breaks.
182
+ *
183
+ * Example strings might be displayed wrapped across multiple lines here for readability, but the operation requires the parameters be submitted as single line strings.
184
184
  * const input = {
185
- * "description": "My updated template description",
186
- * "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a",
187
- * "policyTemplateId": "PTEXAMPLEabcdefg111111",
188
- * "statement": "\"ResearchAccess\"\npermit(\nprincipal in ?principal,\naction == Action::\"view\",\nresource in ?resource\"\n)\nwhen {\nprincipal has department && principal.department == \"research\"\n};"
185
+ * description: "My updated template description",
186
+ * policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
187
+ * policyTemplateId: "PTEXAMPLEabcdefg111111",
188
+ * statement: `"ResearchAccess"
189
+ * permit(
190
+ * principal in ?principal,
191
+ * action == Action::"view",
192
+ * resource in ?resource"
193
+ * )
194
+ * when {
195
+ * principal has department && principal.department == "research"
196
+ * };`
189
197
  * };
190
198
  * const command = new UpdatePolicyTemplateCommand(input);
191
199
  * const response = await client.send(command);
192
- * /* response ==
200
+ * /* response is
193
201
  * {
194
- * "createdDate": "2023-05-17T18:58:48.795411Z",
195
- * "lastUpdatedDate": "2023-05-17T19:18:48.870209Z",
196
- * "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a",
197
- * "policyTemplateId": "PTEXAMPLEabcdefg111111"
202
+ * createdDate: "2023-05-17T18:58:48.795411Z",
203
+ * lastUpdatedDate: "2023-05-17T19:18:48.870209Z",
204
+ * policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
205
+ * policyTemplateId: "PTEXAMPLEabcdefg111111"
198
206
  * }
199
207
  * *\/
200
- * // example id: example-1
201
208
  * ```
202
209
  *
210
+ * @public
203
211
  */
204
212
  export declare class UpdatePolicyTemplateCommand extends UpdatePolicyTemplateCommand_base {
205
213
  /** @internal type navigation helper, not in runtime. */