@aws-sdk/client-verifiedpermissions 3.775.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.
- package/dist-types/commands/BatchGetPolicyCommand.d.ts +39 -39
- package/dist-types/commands/BatchIsAuthorizedCommand.d.ts +93 -93
- package/dist-types/commands/BatchIsAuthorizedWithTokenCommand.d.ts +74 -74
- package/dist-types/commands/CreateIdentitySourceCommand.d.ts +14 -14
- package/dist-types/commands/CreatePolicyCommand.d.ts +58 -60
- package/dist-types/commands/CreatePolicyStoreCommand.d.ts +10 -10
- package/dist-types/commands/CreatePolicyTemplateCommand.d.ts +19 -11
- package/dist-types/commands/DeleteIdentitySourceCommand.d.ts +8 -5
- package/dist-types/commands/DeletePolicyCommand.d.ts +8 -5
- package/dist-types/commands/DeletePolicyStoreCommand.d.ts +7 -4
- package/dist-types/commands/DeletePolicyTemplateCommand.d.ts +8 -5
- package/dist-types/commands/GetIdentitySourceCommand.d.ts +15 -15
- package/dist-types/commands/GetPolicyCommand.d.ts +17 -17
- package/dist-types/commands/GetPolicyStoreCommand.d.ts +10 -10
- package/dist-types/commands/GetPolicyTemplateCommand.d.ts +17 -11
- package/dist-types/commands/GetSchemaCommand.d.ts +34 -13
- package/dist-types/commands/IsAuthorizedCommand.d.ts +34 -35
- package/dist-types/commands/IsAuthorizedWithTokenCommand.d.ts +22 -22
- package/dist-types/commands/ListIdentitySourcesCommand.d.ts +15 -15
- package/dist-types/commands/ListPoliciesCommand.d.ts +90 -92
- package/dist-types/commands/ListPolicyStoresCommand.d.ts +11 -11
- package/dist-types/commands/ListPolicyTemplatesCommand.d.ts +15 -15
- package/dist-types/commands/PutSchemaCommand.d.ts +15 -15
- package/dist-types/commands/UpdateIdentitySourceCommand.d.ts +13 -13
- package/dist-types/commands/UpdatePolicyCommand.d.ts +16 -16
- package/dist-types/commands/UpdatePolicyStoreCommand.d.ts +10 -10
- package/dist-types/commands/UpdatePolicyTemplateCommand.d.ts +24 -16
- package/package.json +2 -2
|
@@ -220,115 +220,113 @@ declare const CreatePolicyCommand_base: {
|
|
|
220
220
|
* @throws {@link VerifiedPermissionsServiceException}
|
|
221
221
|
* <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
|
|
222
222
|
*
|
|
223
|
-
*
|
|
223
|
+
*
|
|
224
224
|
* @example To create a static policy
|
|
225
225
|
* ```javascript
|
|
226
226
|
* // The following example request creates a static policy with a policy scope that specifies both a principal and a resource. The response includes both the Principal and Resource elements because both were specified in the request policy scope.
|
|
227
227
|
* const input = {
|
|
228
|
-
*
|
|
229
|
-
*
|
|
230
|
-
*
|
|
231
|
-
*
|
|
232
|
-
*
|
|
228
|
+
* clientToken: "a1b2c3d4-e5f6-a1b2-c3d4-TOKEN1111111",
|
|
229
|
+
* definition: {
|
|
230
|
+
* static: {
|
|
231
|
+
* description: "Grant members of janeFriends UserGroup access to the vacationFolder Album",
|
|
232
|
+
* statement: `permit( principal in UserGroup::"janeFriends", action, resource in Album::"vacationFolder" );`
|
|
233
233
|
* }
|
|
234
234
|
* },
|
|
235
|
-
*
|
|
235
|
+
* policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a"
|
|
236
236
|
* };
|
|
237
237
|
* const command = new CreatePolicyCommand(input);
|
|
238
238
|
* const response = await client.send(command);
|
|
239
|
-
* /* response
|
|
239
|
+
* /* response is
|
|
240
240
|
* {
|
|
241
|
-
*
|
|
242
|
-
*
|
|
243
|
-
*
|
|
244
|
-
*
|
|
245
|
-
*
|
|
246
|
-
*
|
|
247
|
-
*
|
|
248
|
-
*
|
|
241
|
+
* createdDate: "2024-08-12T18:20:50.99Z",
|
|
242
|
+
* lastUpdatedDate: "2024-08-12T18:20:50.99Z",
|
|
243
|
+
* policyId: "9wYxMpljbbZQb5fcZHyJhY",
|
|
244
|
+
* policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
|
|
245
|
+
* policyType: "STATIC",
|
|
246
|
+
* principal: {
|
|
247
|
+
* entityId: "janeFriends",
|
|
248
|
+
* entityType: "UserGroup"
|
|
249
249
|
* },
|
|
250
|
-
*
|
|
251
|
-
*
|
|
252
|
-
*
|
|
250
|
+
* resource: {
|
|
251
|
+
* entityId: "vacationFolder",
|
|
252
|
+
* entityType: "Album"
|
|
253
253
|
* }
|
|
254
254
|
* }
|
|
255
255
|
* *\/
|
|
256
|
-
* // example id: example-1
|
|
257
256
|
* ```
|
|
258
257
|
*
|
|
259
258
|
* @example To create a static policy
|
|
260
259
|
* ```javascript
|
|
261
260
|
* // The following example request creates a static policy with a policy scope that specifies both a principal and a resource. The response includes both the Principal and Resource elements because both were specified in the request policy scope.
|
|
262
261
|
* const input = {
|
|
263
|
-
*
|
|
264
|
-
*
|
|
265
|
-
*
|
|
266
|
-
*
|
|
267
|
-
*
|
|
262
|
+
* clientToken: "a1b2c3d4-e5f6-a1b2-c3d4-TOKEN1111111",
|
|
263
|
+
* definition: {
|
|
264
|
+
* static: {
|
|
265
|
+
* description: "Grant members of janeFriends UserGroup access to the vacationFolder Album",
|
|
266
|
+
* statement: `permit( principal in UserGroup::"janeFriends", action, resource in Album::"vacationFolder" );`
|
|
268
267
|
* }
|
|
269
268
|
* },
|
|
270
|
-
*
|
|
269
|
+
* policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a"
|
|
271
270
|
* };
|
|
272
271
|
* const command = new CreatePolicyCommand(input);
|
|
273
272
|
* const response = await client.send(command);
|
|
274
|
-
* /* response
|
|
273
|
+
* /* response is
|
|
275
274
|
* {
|
|
276
|
-
*
|
|
277
|
-
*
|
|
278
|
-
*
|
|
279
|
-
*
|
|
280
|
-
*
|
|
281
|
-
*
|
|
282
|
-
*
|
|
283
|
-
*
|
|
275
|
+
* createdDate: "2024-08-12T18:20:50.99Z",
|
|
276
|
+
* lastUpdatedDate: "2024-08-12T18:20:50.99Z",
|
|
277
|
+
* policyId: "9wYxMpljbbZQb5fcZHyJhY",
|
|
278
|
+
* policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
|
|
279
|
+
* policyType: "STATIC",
|
|
280
|
+
* principal: {
|
|
281
|
+
* entityId: "janeFriends",
|
|
282
|
+
* entityType: "UserGroup"
|
|
284
283
|
* },
|
|
285
|
-
*
|
|
286
|
-
*
|
|
287
|
-
*
|
|
284
|
+
* resource: {
|
|
285
|
+
* entityId: "vacationFolder",
|
|
286
|
+
* entityType: "Album"
|
|
288
287
|
* }
|
|
289
288
|
* }
|
|
290
289
|
* *\/
|
|
291
|
-
* // example id: example-2
|
|
292
290
|
* ```
|
|
293
291
|
*
|
|
294
292
|
* @example To create a template-linked policy
|
|
295
293
|
* ```javascript
|
|
296
294
|
* // The following example creates a template-linked policy using the specified policy template and associates the specified principal to use with the new template-linked policy.
|
|
297
295
|
* const input = {
|
|
298
|
-
*
|
|
299
|
-
*
|
|
300
|
-
*
|
|
301
|
-
*
|
|
302
|
-
*
|
|
303
|
-
*
|
|
304
|
-
*
|
|
296
|
+
* clientToken: "a1b2c3d4-e5f6-a1b2-c3d4-TOKEN1111111",
|
|
297
|
+
* definition: {
|
|
298
|
+
* templateLinked: {
|
|
299
|
+
* policyTemplateId: "PTEXAMPLEabcdefg111111",
|
|
300
|
+
* principal: {
|
|
301
|
+
* entityId: "alice",
|
|
302
|
+
* entityType: "User"
|
|
305
303
|
* }
|
|
306
304
|
* }
|
|
307
305
|
* },
|
|
308
|
-
*
|
|
306
|
+
* policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a"
|
|
309
307
|
* };
|
|
310
308
|
* const command = new CreatePolicyCommand(input);
|
|
311
309
|
* const response = await client.send(command);
|
|
312
|
-
* /* response
|
|
310
|
+
* /* response is
|
|
313
311
|
* {
|
|
314
|
-
*
|
|
315
|
-
*
|
|
316
|
-
*
|
|
317
|
-
*
|
|
318
|
-
*
|
|
319
|
-
*
|
|
320
|
-
*
|
|
321
|
-
*
|
|
312
|
+
* createdDate: "2024-08-12T18:20:50.99Z",
|
|
313
|
+
* lastUpdatedDate: "2024-08-12T18:20:50.99Z",
|
|
314
|
+
* policyId: "Et9KxMplyaDdyurDw8TeFa",
|
|
315
|
+
* policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
|
|
316
|
+
* policyType: "TEMPLATE_LINKED",
|
|
317
|
+
* principal: {
|
|
318
|
+
* entityId: "alice",
|
|
319
|
+
* entityType: "User"
|
|
322
320
|
* },
|
|
323
|
-
*
|
|
324
|
-
*
|
|
325
|
-
*
|
|
321
|
+
* resource: {
|
|
322
|
+
* entityId: "VacationPhoto94.jpg",
|
|
323
|
+
* entityType: "Photo"
|
|
326
324
|
* }
|
|
327
325
|
* }
|
|
328
326
|
* *\/
|
|
329
|
-
* // example id: example-3
|
|
330
327
|
* ```
|
|
331
328
|
*
|
|
329
|
+
* @public
|
|
332
330
|
*/
|
|
333
331
|
export declare class CreatePolicyCommand extends CreatePolicyCommand_base {
|
|
334
332
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -171,29 +171,29 @@ declare const CreatePolicyStoreCommand_base: {
|
|
|
171
171
|
* @throws {@link VerifiedPermissionsServiceException}
|
|
172
172
|
* <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
|
|
173
173
|
*
|
|
174
|
-
*
|
|
174
|
+
*
|
|
175
175
|
* @example To create policy store
|
|
176
176
|
* ```javascript
|
|
177
177
|
* // The following example creates a new policy store with strict validation turned on.
|
|
178
178
|
* const input = {
|
|
179
|
-
*
|
|
180
|
-
*
|
|
181
|
-
*
|
|
179
|
+
* clientToken: "a1b2c3d4-e5f6-a1b2-c3d4-TOKEN1111111",
|
|
180
|
+
* validationSettings: {
|
|
181
|
+
* mode: "STRICT"
|
|
182
182
|
* }
|
|
183
183
|
* };
|
|
184
184
|
* const command = new CreatePolicyStoreCommand(input);
|
|
185
185
|
* const response = await client.send(command);
|
|
186
|
-
* /* response
|
|
186
|
+
* /* response is
|
|
187
187
|
* {
|
|
188
|
-
*
|
|
189
|
-
*
|
|
190
|
-
*
|
|
191
|
-
*
|
|
188
|
+
* arn: "arn:aws:verifiedpermissions::123456789012:policy-store/C7v5xMplfFH3i3e4Jrzb1a",
|
|
189
|
+
* createdDate: "2024-08-12T18:20:50.99Z",
|
|
190
|
+
* lastUpdatedDate: "2024-08-12T18:20:50.99Z",
|
|
191
|
+
* policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a"
|
|
192
192
|
* }
|
|
193
193
|
* *\/
|
|
194
|
-
* // example id: example-1
|
|
195
194
|
* ```
|
|
196
195
|
*
|
|
196
|
+
* @public
|
|
197
197
|
*/
|
|
198
198
|
export declare class CreatePolicyStoreCommand extends CreatePolicyStoreCommand_base {
|
|
199
199
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -175,29 +175,37 @@ declare const CreatePolicyTemplateCommand_base: {
|
|
|
175
175
|
* @throws {@link VerifiedPermissionsServiceException}
|
|
176
176
|
* <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
|
|
177
177
|
*
|
|
178
|
-
*
|
|
178
|
+
*
|
|
179
179
|
* @example To create a policy template
|
|
180
180
|
* ```javascript
|
|
181
181
|
* // The following example creates a policy template that has a placeholder for the principal.
|
|
182
182
|
* const input = {
|
|
183
|
-
*
|
|
184
|
-
*
|
|
185
|
-
*
|
|
186
|
-
*
|
|
183
|
+
* clientToken: "a1b2c3d4-e5f6-a1b2-c3d4-TOKEN1111111",
|
|
184
|
+
* description: "Template for research dept",
|
|
185
|
+
* policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
|
|
186
|
+
* statement: `"AccessVacation"
|
|
187
|
+
* permit(
|
|
188
|
+
* principal in ?principal,
|
|
189
|
+
* action == Action::"view",
|
|
190
|
+
* resource == Photo::"VacationPhoto94.jpg"
|
|
191
|
+
* )
|
|
192
|
+
* when {
|
|
193
|
+
* principal has department && principal.department == "research"
|
|
194
|
+
* };`
|
|
187
195
|
* };
|
|
188
196
|
* const command = new CreatePolicyTemplateCommand(input);
|
|
189
197
|
* const response = await client.send(command);
|
|
190
|
-
* /* response
|
|
198
|
+
* /* response is
|
|
191
199
|
* {
|
|
192
|
-
*
|
|
193
|
-
*
|
|
194
|
-
*
|
|
195
|
-
*
|
|
200
|
+
* createdDate: "2024-08-12T18:20:50.99Z",
|
|
201
|
+
* lastUpdatedDate: "2024-08-12T18:20:50.99Z",
|
|
202
|
+
* policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
|
|
203
|
+
* policyTemplateId: "PTEXAMPLEabcdefg111111"
|
|
196
204
|
* }
|
|
197
205
|
* *\/
|
|
198
|
-
* // example id: example-1
|
|
199
206
|
* ```
|
|
200
207
|
*
|
|
208
|
+
* @public
|
|
201
209
|
*/
|
|
202
210
|
export declare class CreatePolicyTemplateCommand extends CreatePolicyTemplateCommand_base {
|
|
203
211
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -156,19 +156,22 @@ declare const DeleteIdentitySourceCommand_base: {
|
|
|
156
156
|
* @throws {@link VerifiedPermissionsServiceException}
|
|
157
157
|
* <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
|
|
158
158
|
*
|
|
159
|
-
*
|
|
159
|
+
*
|
|
160
160
|
* @example To delete an identity source
|
|
161
161
|
* ```javascript
|
|
162
162
|
* // The following example request deletes the specified identity source.
|
|
163
163
|
* const input = {
|
|
164
|
-
*
|
|
165
|
-
*
|
|
164
|
+
* identitySourceId: "ISEXAMPLEabcdefg111111",
|
|
165
|
+
* policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a"
|
|
166
166
|
* };
|
|
167
167
|
* const command = new DeleteIdentitySourceCommand(input);
|
|
168
|
-
* await client.send(command);
|
|
169
|
-
*
|
|
168
|
+
* const response = await client.send(command);
|
|
169
|
+
* /* response is
|
|
170
|
+
* { /* empty *\/ }
|
|
171
|
+
* *\/
|
|
170
172
|
* ```
|
|
171
173
|
*
|
|
174
|
+
* @public
|
|
172
175
|
*/
|
|
173
176
|
export declare class DeleteIdentitySourceCommand extends DeleteIdentitySourceCommand_base {
|
|
174
177
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -155,19 +155,22 @@ declare const DeletePolicyCommand_base: {
|
|
|
155
155
|
* @throws {@link VerifiedPermissionsServiceException}
|
|
156
156
|
* <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
|
|
157
157
|
*
|
|
158
|
-
*
|
|
158
|
+
*
|
|
159
159
|
* @example To delete a policy
|
|
160
160
|
* ```javascript
|
|
161
161
|
* // The following example deletes the specified policy from its policy store.
|
|
162
162
|
* const input = {
|
|
163
|
-
*
|
|
164
|
-
*
|
|
163
|
+
* policyId: "9wYxMpljbbZQb5fcZHyJhY",
|
|
164
|
+
* policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a"
|
|
165
165
|
* };
|
|
166
166
|
* const command = new DeletePolicyCommand(input);
|
|
167
|
-
* await client.send(command);
|
|
168
|
-
*
|
|
167
|
+
* const response = await client.send(command);
|
|
168
|
+
* /* response is
|
|
169
|
+
* { /* empty *\/ }
|
|
170
|
+
* *\/
|
|
169
171
|
* ```
|
|
170
172
|
*
|
|
173
|
+
* @public
|
|
171
174
|
*/
|
|
172
175
|
export declare class DeletePolicyCommand extends DeletePolicyCommand_base {
|
|
173
176
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -147,18 +147,21 @@ declare const DeletePolicyStoreCommand_base: {
|
|
|
147
147
|
* @throws {@link VerifiedPermissionsServiceException}
|
|
148
148
|
* <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
|
|
149
149
|
*
|
|
150
|
-
*
|
|
150
|
+
*
|
|
151
151
|
* @example To delete a policy store
|
|
152
152
|
* ```javascript
|
|
153
153
|
* // The following example deletes the specified policy store.
|
|
154
154
|
* const input = {
|
|
155
|
-
*
|
|
155
|
+
* policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a"
|
|
156
156
|
* };
|
|
157
157
|
* const command = new DeletePolicyStoreCommand(input);
|
|
158
|
-
* await client.send(command);
|
|
159
|
-
*
|
|
158
|
+
* const response = await client.send(command);
|
|
159
|
+
* /* response is
|
|
160
|
+
* { /* empty *\/ }
|
|
161
|
+
* *\/
|
|
160
162
|
* ```
|
|
161
163
|
*
|
|
164
|
+
* @public
|
|
162
165
|
*/
|
|
163
166
|
export declare class DeletePolicyStoreCommand extends DeletePolicyStoreCommand_base {
|
|
164
167
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -158,19 +158,22 @@ declare const DeletePolicyTemplateCommand_base: {
|
|
|
158
158
|
* @throws {@link VerifiedPermissionsServiceException}
|
|
159
159
|
* <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
|
|
160
160
|
*
|
|
161
|
-
*
|
|
161
|
+
*
|
|
162
162
|
* @example To delete a policy template
|
|
163
163
|
* ```javascript
|
|
164
164
|
* // The following example deletes a policy template. Before you can perform this operation, you must first delete any template-linked policies that were instantiated from this policy template. To delete them, use DeletePolicy.
|
|
165
165
|
* const input = {
|
|
166
|
-
*
|
|
167
|
-
*
|
|
166
|
+
* policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
|
|
167
|
+
* policyTemplateId: "PTEXAMPLEabcdefg111111"
|
|
168
168
|
* };
|
|
169
169
|
* const command = new DeletePolicyTemplateCommand(input);
|
|
170
|
-
* await client.send(command);
|
|
171
|
-
*
|
|
170
|
+
* const response = await client.send(command);
|
|
171
|
+
* /* response is
|
|
172
|
+
* { /* empty *\/ }
|
|
173
|
+
* *\/
|
|
172
174
|
* ```
|
|
173
175
|
*
|
|
176
|
+
* @public
|
|
174
177
|
*/
|
|
175
178
|
export declare class DeletePolicyTemplateCommand extends DeletePolicyTemplateCommand_base {
|
|
176
179
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -195,36 +195,36 @@ declare const GetIdentitySourceCommand_base: {
|
|
|
195
195
|
* @throws {@link VerifiedPermissionsServiceException}
|
|
196
196
|
* <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
|
|
197
197
|
*
|
|
198
|
-
*
|
|
198
|
+
*
|
|
199
199
|
* @example To retrieve details about an identity source
|
|
200
200
|
* ```javascript
|
|
201
201
|
* // The following example retrieves the details for the specified identity source.
|
|
202
202
|
* const input = {
|
|
203
|
-
*
|
|
204
|
-
*
|
|
203
|
+
* identitySourceId: "ISEXAMPLEabcdefg111111",
|
|
204
|
+
* policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a"
|
|
205
205
|
* };
|
|
206
206
|
* const command = new GetIdentitySourceCommand(input);
|
|
207
207
|
* const response = await client.send(command);
|
|
208
|
-
* /* response
|
|
208
|
+
* /* response is
|
|
209
209
|
* {
|
|
210
|
-
*
|
|
211
|
-
*
|
|
212
|
-
*
|
|
210
|
+
* createdDate: "2024-08-12T18:20:50.99Z",
|
|
211
|
+
* details: {
|
|
212
|
+
* clientIds: [
|
|
213
213
|
* "a1b2c3d4e5f6g7h8i9j0kalbmc"
|
|
214
214
|
* ],
|
|
215
|
-
*
|
|
216
|
-
*
|
|
217
|
-
*
|
|
215
|
+
* discoveryUrl: "https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5",
|
|
216
|
+
* openIdIssuer: "COGNITO",
|
|
217
|
+
* userPoolArn: "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"
|
|
218
218
|
* },
|
|
219
|
-
*
|
|
220
|
-
*
|
|
221
|
-
*
|
|
222
|
-
*
|
|
219
|
+
* identitySourceId: "ISEXAMPLEabcdefg111111",
|
|
220
|
+
* lastUpdatedDate: "2024-08-12T18:20:50.99Z",
|
|
221
|
+
* policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
|
|
222
|
+
* principalEntityType: "AWS::Cognito"
|
|
223
223
|
* }
|
|
224
224
|
* *\/
|
|
225
|
-
* // example id: example-1
|
|
226
225
|
* ```
|
|
227
226
|
*
|
|
227
|
+
* @public
|
|
228
228
|
*/
|
|
229
229
|
export declare class GetIdentitySourceCommand extends GetIdentitySourceCommand_base {
|
|
230
230
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -187,38 +187,38 @@ declare const GetPolicyCommand_base: {
|
|
|
187
187
|
* @throws {@link VerifiedPermissionsServiceException}
|
|
188
188
|
* <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
|
|
189
189
|
*
|
|
190
|
-
*
|
|
190
|
+
*
|
|
191
191
|
* @example To retrieve details about a policy
|
|
192
192
|
* ```javascript
|
|
193
193
|
* // The following example retrieves information about the specified policy contained in the specified policy store. In this example, the requested policy is a template-linked policy, so it returns the ID of the policy template, and the specific principal and resource used by this policy.
|
|
194
194
|
* const input = {
|
|
195
|
-
*
|
|
196
|
-
*
|
|
195
|
+
* policyId: "9wYixMplbbZQb5fcZHyJhY",
|
|
196
|
+
* policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a"
|
|
197
197
|
* };
|
|
198
198
|
* const command = new GetPolicyCommand(input);
|
|
199
199
|
* const response = await client.send(command);
|
|
200
|
-
* /* response
|
|
200
|
+
* /* response is
|
|
201
201
|
* {
|
|
202
|
-
*
|
|
203
|
-
*
|
|
204
|
-
*
|
|
205
|
-
*
|
|
206
|
-
*
|
|
202
|
+
* createdDate: "2024-08-12T18:20:50.99Z",
|
|
203
|
+
* definition: {
|
|
204
|
+
* static: {
|
|
205
|
+
* description: "Grant everyone of janeFriends UserGroup access to the vacationFolder Album",
|
|
206
|
+
* statement: `permit(principal, action, resource in Album::"publicFolder");`
|
|
207
207
|
* }
|
|
208
208
|
* },
|
|
209
|
-
*
|
|
210
|
-
*
|
|
211
|
-
*
|
|
212
|
-
*
|
|
213
|
-
*
|
|
214
|
-
*
|
|
215
|
-
*
|
|
209
|
+
* lastUpdatedDate: "2024-08-12T18:20:50.99Z",
|
|
210
|
+
* policyId: "9wYxMpljbbZQb5fcZHyJhY",
|
|
211
|
+
* policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
|
|
212
|
+
* policyType: "STATIC",
|
|
213
|
+
* resource: {
|
|
214
|
+
* entityId: "publicFolder",
|
|
215
|
+
* entityType: "Album"
|
|
216
216
|
* }
|
|
217
217
|
* }
|
|
218
218
|
* *\/
|
|
219
|
-
* // example id: example-1
|
|
220
219
|
* ```
|
|
221
220
|
*
|
|
221
|
+
* @public
|
|
222
222
|
*/
|
|
223
223
|
export declare class GetPolicyCommand extends GetPolicyCommand_base {
|
|
224
224
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -157,29 +157,29 @@ declare const GetPolicyStoreCommand_base: {
|
|
|
157
157
|
* @throws {@link VerifiedPermissionsServiceException}
|
|
158
158
|
* <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
|
|
159
159
|
*
|
|
160
|
-
*
|
|
160
|
+
*
|
|
161
161
|
* @example GetPolicyStore
|
|
162
162
|
* ```javascript
|
|
163
163
|
* // The following example retrieves details about the specified policy store.
|
|
164
164
|
* const input = {
|
|
165
|
-
*
|
|
165
|
+
* policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a"
|
|
166
166
|
* };
|
|
167
167
|
* const command = new GetPolicyStoreCommand(input);
|
|
168
168
|
* const response = await client.send(command);
|
|
169
|
-
* /* response
|
|
169
|
+
* /* response is
|
|
170
170
|
* {
|
|
171
|
-
*
|
|
172
|
-
*
|
|
173
|
-
*
|
|
174
|
-
*
|
|
175
|
-
*
|
|
176
|
-
*
|
|
171
|
+
* arn: "arn:aws:verifiedpermissions::123456789012:policy-store/C7v5xMplfFH3i3e4Jrzb1a",
|
|
172
|
+
* createdDate: "2024-08-12T18:20:50.99Z",
|
|
173
|
+
* lastUpdatedDate: "2024-08-12T18:20:50.99Z",
|
|
174
|
+
* policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
|
|
175
|
+
* validationSettings: {
|
|
176
|
+
* mode: "STRICT"
|
|
177
177
|
* }
|
|
178
178
|
* }
|
|
179
179
|
* *\/
|
|
180
|
-
* // example id: example-1
|
|
181
180
|
* ```
|
|
182
181
|
*
|
|
182
|
+
* @public
|
|
183
183
|
*/
|
|
184
184
|
export declare class GetPolicyStoreCommand extends GetPolicyStoreCommand_base {
|
|
185
185
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -156,29 +156,35 @@ declare const GetPolicyTemplateCommand_base: {
|
|
|
156
156
|
* @throws {@link VerifiedPermissionsServiceException}
|
|
157
157
|
* <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
|
|
158
158
|
*
|
|
159
|
-
*
|
|
159
|
+
*
|
|
160
160
|
* @example GetPolicyTemplate
|
|
161
161
|
* ```javascript
|
|
162
162
|
* // The following example displays the details of the specified policy template.
|
|
163
163
|
* const input = {
|
|
164
|
-
*
|
|
165
|
-
*
|
|
164
|
+
* policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
|
|
165
|
+
* policyTemplateId: "PTEXAMPLEabcdefg111111"
|
|
166
166
|
* };
|
|
167
167
|
* const command = new GetPolicyTemplateCommand(input);
|
|
168
168
|
* const response = await client.send(command);
|
|
169
|
-
* /* response
|
|
169
|
+
* /* response is
|
|
170
170
|
* {
|
|
171
|
-
*
|
|
172
|
-
*
|
|
173
|
-
*
|
|
174
|
-
*
|
|
175
|
-
*
|
|
176
|
-
*
|
|
171
|
+
* createdDate: "2024-08-12T18:20:50.99Z",
|
|
172
|
+
* description: "Template for research dept",
|
|
173
|
+
* lastUpdatedDate: "2024-08-12T18:20:50.99Z",
|
|
174
|
+
* policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
|
|
175
|
+
* policyTemplateId: "PTEXAMPLEabcdefg111111",
|
|
176
|
+
* statement: `permit(
|
|
177
|
+
* principal ?principal,
|
|
178
|
+
* action == Action::"view",
|
|
179
|
+
* resource in ?resource
|
|
180
|
+
* ) when {
|
|
181
|
+
* principal has department && principal.department == "research"
|
|
182
|
+
* };`
|
|
177
183
|
* }
|
|
178
184
|
* *\/
|
|
179
|
-
* // example id: example-1
|
|
180
185
|
* ```
|
|
181
186
|
*
|
|
187
|
+
* @public
|
|
182
188
|
*/
|
|
183
189
|
export declare class GetPolicyTemplateCommand extends GetPolicyTemplateCommand_base {
|
|
184
190
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -156,31 +156,52 @@ declare const GetSchemaCommand_base: {
|
|
|
156
156
|
* @throws {@link VerifiedPermissionsServiceException}
|
|
157
157
|
* <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
|
|
158
158
|
*
|
|
159
|
-
*
|
|
159
|
+
*
|
|
160
160
|
* @example GetSchema
|
|
161
161
|
* ```javascript
|
|
162
162
|
* // The following example retrieves the current schema stored in the specified policy store.
|
|
163
|
-
*
|
|
164
|
-
*
|
|
165
|
-
*
|
|
166
|
-
*
|
|
167
|
-
*
|
|
163
|
+
*
|
|
164
|
+
* Note
|
|
165
|
+
* 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.
|
|
166
|
+
*
|
|
167
|
+
* Example strings might be displayed wrapped across multiple lines here for readability, but the operation requires the parameters be submitted as single line strings.
|
|
168
168
|
* const input = {
|
|
169
|
-
*
|
|
169
|
+
* policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a"
|
|
170
170
|
* };
|
|
171
171
|
* const command = new GetSchemaCommand(input);
|
|
172
172
|
* const response = await client.send(command);
|
|
173
|
-
* /* response
|
|
173
|
+
* /* response is
|
|
174
174
|
* {
|
|
175
|
-
*
|
|
176
|
-
*
|
|
177
|
-
*
|
|
178
|
-
*
|
|
175
|
+
* createdDate: "2024-08-12T18:20:50.99Z",
|
|
176
|
+
* lastUpdatedDate: "2024-08-12T18:20:50.99Z",
|
|
177
|
+
* policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
|
|
178
|
+
* schema: `{
|
|
179
|
+
* "My::Application": {
|
|
180
|
+
* "actions": {
|
|
181
|
+
* "remoteAccess": {
|
|
182
|
+
* "appliesTo": {
|
|
183
|
+
* "principalTypes": ["Employee"]
|
|
184
|
+
* }
|
|
185
|
+
* }
|
|
186
|
+
* },
|
|
187
|
+
* "entityTypes": {
|
|
188
|
+
* "Employee": {
|
|
189
|
+
* "shape": {
|
|
190
|
+
* "attributes": {
|
|
191
|
+
* "jobLevel": { "type": "Long" },
|
|
192
|
+
* "name": { "type":"String" }
|
|
193
|
+
* },
|
|
194
|
+
* "type": "Record"
|
|
195
|
+
* }
|
|
196
|
+
* }
|
|
197
|
+
* }
|
|
198
|
+
* }
|
|
199
|
+
* }`
|
|
179
200
|
* }
|
|
180
201
|
* *\/
|
|
181
|
-
* // example id: example-1
|
|
182
202
|
* ```
|
|
183
203
|
*
|
|
204
|
+
* @public
|
|
184
205
|
*/
|
|
185
206
|
export declare class GetSchemaCommand extends GetSchemaCommand_base {
|
|
186
207
|
/** @internal type navigation helper, not in runtime. */
|