@aws-sdk/client-verifiedpermissions 3.1013.0 → 3.1014.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/README.md +28 -0
- package/dist-cjs/index.js +67 -0
- package/dist-cjs/schemas/schemas_0.js +116 -30
- package/dist-es/VerifiedPermissions.js +10 -0
- package/dist-es/commands/CreatePolicyStoreAliasCommand.js +16 -0
- package/dist-es/commands/DeletePolicyStoreAliasCommand.js +16 -0
- package/dist-es/commands/GetPolicyStoreAliasCommand.js +16 -0
- package/dist-es/commands/ListPolicyStoreAliasesCommand.js +16 -0
- package/dist-es/commands/index.js +4 -0
- package/dist-es/models/enums.js +6 -0
- package/dist-es/pagination/ListPolicyStoreAliasesPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/schemas/schemas_0.js +112 -26
- package/dist-types/VerifiedPermissions.d.ts +36 -0
- package/dist-types/VerifiedPermissionsClient.d.ts +6 -2
- package/dist-types/commands/BatchGetPolicyCommand.d.ts +58 -1
- package/dist-types/commands/CreateIdentitySourceCommand.d.ts +1 -1
- package/dist-types/commands/CreatePolicyCommand.d.ts +4 -35
- package/dist-types/commands/CreatePolicyStoreAliasCommand.d.ts +118 -0
- package/dist-types/commands/CreatePolicyStoreCommand.d.ts +1 -1
- package/dist-types/commands/CreatePolicyTemplateCommand.d.ts +3 -1
- package/dist-types/commands/DeleteIdentitySourceCommand.d.ts +1 -1
- package/dist-types/commands/DeletePolicyCommand.d.ts +1 -1
- package/dist-types/commands/DeletePolicyStoreAliasCommand.d.ts +100 -0
- package/dist-types/commands/DeletePolicyTemplateCommand.d.ts +1 -1
- package/dist-types/commands/GetPolicyCommand.d.ts +32 -0
- package/dist-types/commands/GetPolicyStoreAliasCommand.d.ts +112 -0
- package/dist-types/commands/GetPolicyTemplateCommand.d.ts +29 -0
- package/dist-types/commands/ListPoliciesCommand.d.ts +3 -0
- package/dist-types/commands/ListPolicyStoreAliasesCommand.d.ts +166 -0
- package/dist-types/commands/ListPolicyTemplatesCommand.d.ts +3 -0
- package/dist-types/commands/PutSchemaCommand.d.ts +1 -1
- package/dist-types/commands/UpdateIdentitySourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePolicyCommand.d.ts +3 -1
- package/dist-types/commands/UpdatePolicyStoreCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePolicyTemplateCommand.d.ts +3 -1
- package/dist-types/commands/index.d.ts +4 -0
- package/dist-types/models/enums.d.ts +14 -0
- package/dist-types/models/errors.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +250 -33
- package/dist-types/pagination/ListPolicyStoreAliasesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/schemas/schemas_0.d.ts +14 -0
- package/dist-types/ts3.4/VerifiedPermissions.d.ts +76 -0
- package/dist-types/ts3.4/VerifiedPermissionsClient.d.ts +24 -0
- package/dist-types/ts3.4/commands/CreatePolicyStoreAliasCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeletePolicyStoreAliasCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetPolicyStoreAliasCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListPolicyStoreAliasesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +4 -0
- package/dist-types/ts3.4/models/enums.d.ts +7 -0
- package/dist-types/ts3.4/models/models_0.d.ts +53 -0
- package/dist-types/ts3.4/pagination/ListPolicyStoreAliasesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +14 -0
- package/package.json +12 -12
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { BatchGetPolicyErrorCode, CedarVersion, Decision, DeletionProtection, OpenIdIssuer, PolicyEffect, PolicyType, ResourceType, ValidationMode } from "./enums";
|
|
1
|
+
import { AliasState, BatchGetPolicyErrorCode, CedarVersion, Decision, DeletionProtection, OpenIdIssuer, PolicyEffect, PolicyType, ResourceType, ValidationMode } from "./enums";
|
|
2
2
|
/**
|
|
3
3
|
* <p>Contains information about an action for a request for which an authorization decision is made.</p> <p>This data type is used as a request parameter to the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html">IsAuthorized</a>, <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_BatchIsAuthorized.html">BatchIsAuthorized</a>, and <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html">IsAuthorizedWithToken</a> operations.</p> <p>Example: <code>\{ "actionId": "<action name>", "actionType": "Action" \}</code> </p>
|
|
4
4
|
* @public
|
|
@@ -42,7 +42,7 @@ export interface BatchGetPolicyInputItem {
|
|
|
42
42
|
*/
|
|
43
43
|
policyStoreId: string | undefined;
|
|
44
44
|
/**
|
|
45
|
-
* <p>The identifier of the policy you want information about.</p>
|
|
45
|
+
* <p>The identifier of the policy you want information about.</p> <p>You can use the policy name in place of the policy ID. When using a name, prefix it with <code>name/</code>. For example:</p> <ul> <li> <p>ID: <code>SPEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Name: <code>name/example-policy</code> </p> </li> </ul>
|
|
46
46
|
* @public
|
|
47
47
|
*/
|
|
48
48
|
policyId: string | undefined;
|
|
@@ -200,6 +200,11 @@ export interface BatchGetPolicyOutputItem {
|
|
|
200
200
|
* @public
|
|
201
201
|
*/
|
|
202
202
|
lastUpdatedDate: Date | undefined;
|
|
203
|
+
/**
|
|
204
|
+
* <p>The name of the policy, if one was assigned when the policy was created or last updated.</p>
|
|
205
|
+
* @public
|
|
206
|
+
*/
|
|
207
|
+
name?: string | undefined;
|
|
203
208
|
}
|
|
204
209
|
/**
|
|
205
210
|
* @public
|
|
@@ -878,7 +883,7 @@ export interface CreateIdentitySourceInput {
|
|
|
878
883
|
*/
|
|
879
884
|
clientToken?: string | undefined;
|
|
880
885
|
/**
|
|
881
|
-
* <p>Specifies the ID of the policy store in which you want to store this identity source. Only policies and requests made using this policy store can reference identities from the identity provider configured in the new identity source.</p>
|
|
886
|
+
* <p>Specifies the ID of the policy store in which you want to store this identity source. Only policies and requests made using this policy store can reference identities from the identity provider configured in the new identity source.</p> <p>To specify a policy store, use its ID or alias name. When using an alias name, prefix it with <code>policy-store-alias/</code>. For example:</p> <ul> <li> <p>ID: <code>PSEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Alias name: <code>policy-store-alias/example-policy-store</code> </p> </li> </ul> <p>To view aliases, use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStoreAliases.html">ListPolicyStoreAliases</a>.</p>
|
|
882
887
|
* @public
|
|
883
888
|
*/
|
|
884
889
|
policyStoreId: string | undefined;
|
|
@@ -1010,7 +1015,7 @@ export interface CreatePolicyInput {
|
|
|
1010
1015
|
*/
|
|
1011
1016
|
clientToken?: string | undefined;
|
|
1012
1017
|
/**
|
|
1013
|
-
* <p>Specifies the <code>PolicyStoreId</code> of the policy store you want to store the policy in.</p>
|
|
1018
|
+
* <p>Specifies the <code>PolicyStoreId</code> of the policy store you want to store the policy in.</p> <p>To specify a policy store, use its ID or alias name. When using an alias name, prefix it with <code>policy-store-alias/</code>. For example:</p> <ul> <li> <p>ID: <code>PSEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Alias name: <code>policy-store-alias/example-policy-store</code> </p> </li> </ul> <p>To view aliases, use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStoreAliases.html">ListPolicyStoreAliases</a>.</p>
|
|
1014
1019
|
* @public
|
|
1015
1020
|
*/
|
|
1016
1021
|
policyStoreId: string | undefined;
|
|
@@ -1019,6 +1024,11 @@ export interface CreatePolicyInput {
|
|
|
1019
1024
|
* @public
|
|
1020
1025
|
*/
|
|
1021
1026
|
definition: PolicyDefinition | undefined;
|
|
1027
|
+
/**
|
|
1028
|
+
* <p>Specifies a name for the policy that is unique among all policies within the policy store. You can use the name in place of the policy ID in API operations that reference the policy. The name must be prefixed with <code>name/</code>.</p> <p>If you specify a name that is already associated with another policy in the policy store, you receive a <code>ConflictException</code> error.</p>
|
|
1029
|
+
* @public
|
|
1030
|
+
*/
|
|
1031
|
+
name?: string | undefined;
|
|
1022
1032
|
}
|
|
1023
1033
|
/**
|
|
1024
1034
|
* @public
|
|
@@ -1207,6 +1217,46 @@ export interface CreatePolicyStoreOutput {
|
|
|
1207
1217
|
*/
|
|
1208
1218
|
lastUpdatedDate: Date | undefined;
|
|
1209
1219
|
}
|
|
1220
|
+
/**
|
|
1221
|
+
* @public
|
|
1222
|
+
*/
|
|
1223
|
+
export interface CreatePolicyStoreAliasInput {
|
|
1224
|
+
/**
|
|
1225
|
+
* <p>Specifies the name of the policy store alias to create. The name must be unique within your Amazon Web Services account and Amazon Web Services Region.</p> <note> <p>The alias name must always be prefixed with <code>policy-store-alias/</code>.</p> </note>
|
|
1226
|
+
* @public
|
|
1227
|
+
*/
|
|
1228
|
+
aliasName: string | undefined;
|
|
1229
|
+
/**
|
|
1230
|
+
* <p>Specifies the ID of the policy store to associate with the alias.</p> <note> <p>The associated policy store must be specified using its ID. The alias name cannot be used.</p> </note>
|
|
1231
|
+
* @public
|
|
1232
|
+
*/
|
|
1233
|
+
policyStoreId: string | undefined;
|
|
1234
|
+
}
|
|
1235
|
+
/**
|
|
1236
|
+
* @public
|
|
1237
|
+
*/
|
|
1238
|
+
export interface CreatePolicyStoreAliasOutput {
|
|
1239
|
+
/**
|
|
1240
|
+
* <p>The name of the policy store alias.</p>
|
|
1241
|
+
* @public
|
|
1242
|
+
*/
|
|
1243
|
+
aliasName: string | undefined;
|
|
1244
|
+
/**
|
|
1245
|
+
* <p>The ID of the policy store associated with the alias.</p>
|
|
1246
|
+
* @public
|
|
1247
|
+
*/
|
|
1248
|
+
policyStoreId: string | undefined;
|
|
1249
|
+
/**
|
|
1250
|
+
* <p>The Amazon Resource Name (ARN) of the policy store alias.</p>
|
|
1251
|
+
* @public
|
|
1252
|
+
*/
|
|
1253
|
+
aliasArn: string | undefined;
|
|
1254
|
+
/**
|
|
1255
|
+
* <p>The date and time the policy store alias was created.</p>
|
|
1256
|
+
* @public
|
|
1257
|
+
*/
|
|
1258
|
+
createdAt: Date | undefined;
|
|
1259
|
+
}
|
|
1210
1260
|
/**
|
|
1211
1261
|
* @public
|
|
1212
1262
|
*/
|
|
@@ -1217,7 +1267,7 @@ export interface CreatePolicyTemplateInput {
|
|
|
1217
1267
|
*/
|
|
1218
1268
|
clientToken?: string | undefined;
|
|
1219
1269
|
/**
|
|
1220
|
-
* <p>The ID of the policy store in which to create the policy template.</p>
|
|
1270
|
+
* <p>The ID of the policy store in which to create the policy template.</p> <p>To specify a policy store, use its ID or alias name. When using an alias name, prefix it with <code>policy-store-alias/</code>. For example:</p> <ul> <li> <p>ID: <code>PSEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Alias name: <code>policy-store-alias/example-policy-store</code> </p> </li> </ul> <p>To view aliases, use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStoreAliases.html">ListPolicyStoreAliases</a>.</p>
|
|
1221
1271
|
* @public
|
|
1222
1272
|
*/
|
|
1223
1273
|
policyStoreId: string | undefined;
|
|
@@ -1231,6 +1281,11 @@ export interface CreatePolicyTemplateInput {
|
|
|
1231
1281
|
* @public
|
|
1232
1282
|
*/
|
|
1233
1283
|
statement: string | undefined;
|
|
1284
|
+
/**
|
|
1285
|
+
* <p>Specifies a name for the policy template that is unique among all policy templates within the policy store. You can use the name in place of the policy template ID in API operations that reference the policy template. The name must be prefixed with <code>name/</code>.</p> <p>If you specify a name that is already associated with another policy template in the policy store, you receive a <code>ConflictException</code> error.</p>
|
|
1286
|
+
* @public
|
|
1287
|
+
*/
|
|
1288
|
+
name?: string | undefined;
|
|
1234
1289
|
}
|
|
1235
1290
|
/**
|
|
1236
1291
|
* @public
|
|
@@ -1262,7 +1317,7 @@ export interface CreatePolicyTemplateOutput {
|
|
|
1262
1317
|
*/
|
|
1263
1318
|
export interface DeleteIdentitySourceInput {
|
|
1264
1319
|
/**
|
|
1265
|
-
* <p>Specifies the ID of the policy store that contains the identity source that you want to delete.</p>
|
|
1320
|
+
* <p>Specifies the ID of the policy store that contains the identity source that you want to delete.</p> <p>To specify a policy store, use its ID or alias name. When using an alias name, prefix it with <code>policy-store-alias/</code>. For example:</p> <ul> <li> <p>ID: <code>PSEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Alias name: <code>policy-store-alias/example-policy-store</code> </p> </li> </ul> <p>To view aliases, use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStoreAliases.html">ListPolicyStoreAliases</a>.</p>
|
|
1266
1321
|
* @public
|
|
1267
1322
|
*/
|
|
1268
1323
|
policyStoreId: string | undefined;
|
|
@@ -1282,12 +1337,12 @@ export interface DeleteIdentitySourceOutput {
|
|
|
1282
1337
|
*/
|
|
1283
1338
|
export interface DeletePolicyInput {
|
|
1284
1339
|
/**
|
|
1285
|
-
* <p>Specifies the ID of the policy store that contains the policy that you want to delete.</p>
|
|
1340
|
+
* <p>Specifies the ID of the policy store that contains the policy that you want to delete.</p> <p>To specify a policy store, use its ID or alias name. When using an alias name, prefix it with <code>policy-store-alias/</code>. For example:</p> <ul> <li> <p>ID: <code>PSEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Alias name: <code>policy-store-alias/example-policy-store</code> </p> </li> </ul> <p>To view aliases, use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStoreAliases.html">ListPolicyStoreAliases</a>.</p>
|
|
1286
1341
|
* @public
|
|
1287
1342
|
*/
|
|
1288
1343
|
policyStoreId: string | undefined;
|
|
1289
1344
|
/**
|
|
1290
|
-
* <p>Specifies the ID of the policy that you want to delete.</p>
|
|
1345
|
+
* <p>Specifies the ID of the policy that you want to delete.</p> <p>You can use the policy name in place of the policy ID. When using a name, prefix it with <code>name/</code>. For example:</p> <ul> <li> <p>ID: <code>SPEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Name: <code>name/example-policy</code> </p> </li> </ul>
|
|
1291
1346
|
* @public
|
|
1292
1347
|
*/
|
|
1293
1348
|
policyId: string | undefined;
|
|
@@ -1302,7 +1357,7 @@ export interface DeletePolicyOutput {
|
|
|
1302
1357
|
*/
|
|
1303
1358
|
export interface DeletePolicyStoreInput {
|
|
1304
1359
|
/**
|
|
1305
|
-
* <p>Specifies the ID of the policy store that you want to delete.</p>
|
|
1360
|
+
* <p>Specifies the ID of the policy store that you want to delete.</p> <note> <p>To specify a policy store, the alias name cannot be used. Only the ID can be used.</p> </note>
|
|
1306
1361
|
* @public
|
|
1307
1362
|
*/
|
|
1308
1363
|
policyStoreId: string | undefined;
|
|
@@ -1312,17 +1367,32 @@ export interface DeletePolicyStoreInput {
|
|
|
1312
1367
|
*/
|
|
1313
1368
|
export interface DeletePolicyStoreOutput {
|
|
1314
1369
|
}
|
|
1370
|
+
/**
|
|
1371
|
+
* @public
|
|
1372
|
+
*/
|
|
1373
|
+
export interface DeletePolicyStoreAliasInput {
|
|
1374
|
+
/**
|
|
1375
|
+
* <p>Specifies the name of the policy store alias that you want to delete.</p> <note> <p>The alias name must always be prefixed with <code>policy-store-alias/</code>.</p> </note>
|
|
1376
|
+
* @public
|
|
1377
|
+
*/
|
|
1378
|
+
aliasName: string | undefined;
|
|
1379
|
+
}
|
|
1380
|
+
/**
|
|
1381
|
+
* @public
|
|
1382
|
+
*/
|
|
1383
|
+
export interface DeletePolicyStoreAliasOutput {
|
|
1384
|
+
}
|
|
1315
1385
|
/**
|
|
1316
1386
|
* @public
|
|
1317
1387
|
*/
|
|
1318
1388
|
export interface DeletePolicyTemplateInput {
|
|
1319
1389
|
/**
|
|
1320
|
-
* <p>Specifies the ID of the policy store that contains the policy template that you want to delete.</p>
|
|
1390
|
+
* <p>Specifies the ID of the policy store that contains the policy template that you want to delete.</p> <p>To specify a policy store, use its ID or alias name. When using an alias name, prefix it with <code>policy-store-alias/</code>. For example:</p> <ul> <li> <p>ID: <code>PSEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Alias name: <code>policy-store-alias/example-policy-store</code> </p> </li> </ul> <p>To view aliases, use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStoreAliases.html">ListPolicyStoreAliases</a>.</p>
|
|
1321
1391
|
* @public
|
|
1322
1392
|
*/
|
|
1323
1393
|
policyStoreId: string | undefined;
|
|
1324
1394
|
/**
|
|
1325
|
-
* <p>Specifies the ID of the policy template that you want to delete.</p>
|
|
1395
|
+
* <p>Specifies the ID of the policy template that you want to delete.</p> <p>You can use the policy template name in place of the policy template ID. When using a name, prefix it with <code>name/</code>. For example:</p> <ul> <li> <p>ID: <code>PTEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Name: <code>name/example-policy-template</code> </p> </li> </ul>
|
|
1326
1396
|
* @public
|
|
1327
1397
|
*/
|
|
1328
1398
|
policyTemplateId: string | undefined;
|
|
@@ -1443,7 +1513,7 @@ export declare namespace EntityReference {
|
|
|
1443
1513
|
*/
|
|
1444
1514
|
export interface GetIdentitySourceInput {
|
|
1445
1515
|
/**
|
|
1446
|
-
* <p>Specifies the ID of the policy store that contains the identity source you want information about.</p>
|
|
1516
|
+
* <p>Specifies the ID of the policy store that contains the identity source you want information about.</p> <p>To specify a policy store, use its ID or alias name. When using an alias name, prefix it with <code>policy-store-alias/</code>. For example:</p> <ul> <li> <p>ID: <code>PSEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Alias name: <code>policy-store-alias/example-policy-store</code> </p> </li> </ul> <p>To view aliases, use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStoreAliases.html">ListPolicyStoreAliases</a>.</p>
|
|
1447
1517
|
* @public
|
|
1448
1518
|
*/
|
|
1449
1519
|
policyStoreId: string | undefined;
|
|
@@ -1536,12 +1606,12 @@ export interface GetIdentitySourceOutput {
|
|
|
1536
1606
|
*/
|
|
1537
1607
|
export interface GetPolicyInput {
|
|
1538
1608
|
/**
|
|
1539
|
-
* <p>Specifies the ID of the policy store that contains the policy that you want information about.</p>
|
|
1609
|
+
* <p>Specifies the ID of the policy store that contains the policy that you want information about.</p> <p>To specify a policy store, use its ID or alias name. When using an alias name, prefix it with <code>policy-store-alias/</code>. For example:</p> <ul> <li> <p>ID: <code>PSEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Alias name: <code>policy-store-alias/example-policy-store</code> </p> </li> </ul> <p>To view aliases, use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStoreAliases.html">ListPolicyStoreAliases</a>.</p>
|
|
1540
1610
|
* @public
|
|
1541
1611
|
*/
|
|
1542
1612
|
policyStoreId: string | undefined;
|
|
1543
1613
|
/**
|
|
1544
|
-
* <p>Specifies the ID of the policy you want information about.</p>
|
|
1614
|
+
* <p>Specifies the ID of the policy you want information about.</p> <p>You can use the policy name in place of the policy ID. When using a name, prefix it with <code>name/</code>. For example:</p> <ul> <li> <p>ID: <code>SPEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Name: <code>name/example-policy</code> </p> </li> </ul>
|
|
1545
1615
|
* @public
|
|
1546
1616
|
*/
|
|
1547
1617
|
policyId: string | undefined;
|
|
@@ -1600,13 +1670,18 @@ export interface GetPolicyOutput {
|
|
|
1600
1670
|
* @public
|
|
1601
1671
|
*/
|
|
1602
1672
|
effect?: PolicyEffect | undefined;
|
|
1673
|
+
/**
|
|
1674
|
+
* <p>The name of the policy, if one was assigned when the policy was created or last updated.</p>
|
|
1675
|
+
* @public
|
|
1676
|
+
*/
|
|
1677
|
+
name?: string | undefined;
|
|
1603
1678
|
}
|
|
1604
1679
|
/**
|
|
1605
1680
|
* @public
|
|
1606
1681
|
*/
|
|
1607
1682
|
export interface GetPolicyStoreInput {
|
|
1608
1683
|
/**
|
|
1609
|
-
* <p>Specifies the
|
|
1684
|
+
* <p>Specifies the policy store that you want information about.</p> <p>To specify a policy store, use its ID or alias name. When using an alias name, prefix it with <code>policy-store-alias/</code>. For example:</p> <ul> <li> <p>ID: <code>PSEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Alias name: <code>policy-store-alias/example-policy-store</code> </p> </li> </ul> <p>To view aliases, use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStoreAliases.html">ListPolicyStoreAliases</a>.</p>
|
|
1610
1685
|
* @public
|
|
1611
1686
|
*/
|
|
1612
1687
|
policyStoreId: string | undefined;
|
|
@@ -1671,17 +1746,57 @@ export interface GetPolicyStoreOutput {
|
|
|
1671
1746
|
*/
|
|
1672
1747
|
tags?: Record<string, string> | undefined;
|
|
1673
1748
|
}
|
|
1749
|
+
/**
|
|
1750
|
+
* @public
|
|
1751
|
+
*/
|
|
1752
|
+
export interface GetPolicyStoreAliasInput {
|
|
1753
|
+
/**
|
|
1754
|
+
* <p>Specifies the name of the policy store alias that you want information about.</p> <note> <p>The alias name must always be prefixed with <code>policy-store-alias/</code>.</p> </note>
|
|
1755
|
+
* @public
|
|
1756
|
+
*/
|
|
1757
|
+
aliasName: string | undefined;
|
|
1758
|
+
}
|
|
1759
|
+
/**
|
|
1760
|
+
* @public
|
|
1761
|
+
*/
|
|
1762
|
+
export interface GetPolicyStoreAliasOutput {
|
|
1763
|
+
/**
|
|
1764
|
+
* <p>The name of the policy store alias.</p>
|
|
1765
|
+
* @public
|
|
1766
|
+
*/
|
|
1767
|
+
aliasName: string | undefined;
|
|
1768
|
+
/**
|
|
1769
|
+
* <p>The ID of the policy store associated with the alias.</p>
|
|
1770
|
+
* @public
|
|
1771
|
+
*/
|
|
1772
|
+
policyStoreId: string | undefined;
|
|
1773
|
+
/**
|
|
1774
|
+
* <p>The Amazon Resource Name (ARN) of the policy store alias.</p>
|
|
1775
|
+
* @public
|
|
1776
|
+
*/
|
|
1777
|
+
aliasArn: string | undefined;
|
|
1778
|
+
/**
|
|
1779
|
+
* <p>The date and time the policy store alias was created.</p>
|
|
1780
|
+
* @public
|
|
1781
|
+
*/
|
|
1782
|
+
createdAt: Date | undefined;
|
|
1783
|
+
/**
|
|
1784
|
+
* <p>The state of the policy store alias. Policy Store Aliases in the Active state can be used normally. When a policy store alias is deleted, it enters the PendingDeletion state. Policy Store Aliases in the PendingDeletion cannot be used, and creating a policy store alias with the same alias name will fail.</p>
|
|
1785
|
+
* @public
|
|
1786
|
+
*/
|
|
1787
|
+
state: AliasState | undefined;
|
|
1788
|
+
}
|
|
1674
1789
|
/**
|
|
1675
1790
|
* @public
|
|
1676
1791
|
*/
|
|
1677
1792
|
export interface GetPolicyTemplateInput {
|
|
1678
1793
|
/**
|
|
1679
|
-
* <p>Specifies the ID of the policy store that contains the policy template that you want information about.</p>
|
|
1794
|
+
* <p>Specifies the ID of the policy store that contains the policy template that you want information about.</p> <p>To specify a policy store, use its ID or alias name. When using an alias name, prefix it with <code>policy-store-alias/</code>. For example:</p> <ul> <li> <p>ID: <code>PSEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Alias name: <code>policy-store-alias/example-policy-store</code> </p> </li> </ul> <p>To view aliases, use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStoreAliases.html">ListPolicyStoreAliases</a>.</p>
|
|
1680
1795
|
* @public
|
|
1681
1796
|
*/
|
|
1682
1797
|
policyStoreId: string | undefined;
|
|
1683
1798
|
/**
|
|
1684
|
-
* <p>Specifies the ID of the policy template that you want information about.</p>
|
|
1799
|
+
* <p>Specifies the ID of the policy template that you want information about.</p> <p>You can use the policy template name in place of the policy template ID. When using a name, prefix it with <code>name/</code>. For example:</p> <ul> <li> <p>ID: <code>PTEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Name: <code>name/example-policy-template</code> </p> </li> </ul>
|
|
1685
1800
|
* @public
|
|
1686
1801
|
*/
|
|
1687
1802
|
policyTemplateId: string | undefined;
|
|
@@ -1720,13 +1835,18 @@ export interface GetPolicyTemplateOutput {
|
|
|
1720
1835
|
* @public
|
|
1721
1836
|
*/
|
|
1722
1837
|
lastUpdatedDate: Date | undefined;
|
|
1838
|
+
/**
|
|
1839
|
+
* <p>The name of the policy template, if one was assigned when the policy template was created or last updated.</p>
|
|
1840
|
+
* @public
|
|
1841
|
+
*/
|
|
1842
|
+
name?: string | undefined;
|
|
1723
1843
|
}
|
|
1724
1844
|
/**
|
|
1725
1845
|
* @public
|
|
1726
1846
|
*/
|
|
1727
1847
|
export interface GetSchemaInput {
|
|
1728
1848
|
/**
|
|
1729
|
-
* <p>Specifies the ID of the policy store that contains the schema.</p>
|
|
1849
|
+
* <p>Specifies the ID of the policy store that contains the schema.</p> <p>To specify a policy store, use its ID or alias name. When using an alias name, prefix it with <code>policy-store-alias/</code>. For example:</p> <ul> <li> <p>ID: <code>PSEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Alias name: <code>policy-store-alias/example-policy-store</code> </p> </li> </ul> <p>To view aliases, use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStoreAliases.html">ListPolicyStoreAliases</a>.</p>
|
|
1730
1850
|
* @public
|
|
1731
1851
|
*/
|
|
1732
1852
|
policyStoreId: string | undefined;
|
|
@@ -1777,7 +1897,7 @@ export interface IdentitySourceFilter {
|
|
|
1777
1897
|
*/
|
|
1778
1898
|
export interface ListIdentitySourcesInput {
|
|
1779
1899
|
/**
|
|
1780
|
-
* <p>Specifies the ID of the policy store that contains the identity sources that you want to list.</p>
|
|
1900
|
+
* <p>Specifies the ID of the policy store that contains the identity sources that you want to list.</p> <p>To specify a policy store, use its ID or alias name. When using an alias name, prefix it with <code>policy-store-alias/</code>. For example:</p> <ul> <li> <p>ID: <code>PSEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Alias name: <code>policy-store-alias/example-policy-store</code> </p> </li> </ul> <p>To view aliases, use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStoreAliases.html">ListPolicyStoreAliases</a>.</p>
|
|
1781
1901
|
* @public
|
|
1782
1902
|
*/
|
|
1783
1903
|
policyStoreId: string | undefined;
|
|
@@ -2092,7 +2212,7 @@ export declare namespace UpdateConfiguration {
|
|
|
2092
2212
|
*/
|
|
2093
2213
|
export interface UpdateIdentitySourceInput {
|
|
2094
2214
|
/**
|
|
2095
|
-
* <p>Specifies the ID of the policy store that contains the identity source that you want to update.</p>
|
|
2215
|
+
* <p>Specifies the ID of the policy store that contains the identity source that you want to update.</p> <p>To specify a policy store, use its ID or alias name. When using an alias name, prefix it with <code>policy-store-alias/</code>. For example:</p> <ul> <li> <p>ID: <code>PSEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Alias name: <code>policy-store-alias/example-policy-store</code> </p> </li> </ul> <p>To view aliases, use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStoreAliases.html">ListPolicyStoreAliases</a>.</p>
|
|
2096
2216
|
* @public
|
|
2097
2217
|
*/
|
|
2098
2218
|
policyStoreId: string | undefined;
|
|
@@ -2213,7 +2333,7 @@ export interface PolicyFilter {
|
|
|
2213
2333
|
*/
|
|
2214
2334
|
export interface ListPoliciesInput {
|
|
2215
2335
|
/**
|
|
2216
|
-
* <p>Specifies the ID of the policy store you want to list policies from.</p>
|
|
2336
|
+
* <p>Specifies the ID of the policy store you want to list policies from.</p> <p>To specify a policy store, use its ID or alias name. When using an alias name, prefix it with <code>policy-store-alias/</code>. For example:</p> <ul> <li> <p>ID: <code>PSEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Alias name: <code>policy-store-alias/example-policy-store</code> </p> </li> </ul> <p>To view aliases, use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStoreAliases.html">ListPolicyStoreAliases</a>.</p>
|
|
2217
2337
|
* @public
|
|
2218
2338
|
*/
|
|
2219
2339
|
policyStoreId: string | undefined;
|
|
@@ -2365,6 +2485,11 @@ export interface PolicyItem {
|
|
|
2365
2485
|
* @public
|
|
2366
2486
|
*/
|
|
2367
2487
|
effect?: PolicyEffect | undefined;
|
|
2488
|
+
/**
|
|
2489
|
+
* <p>The name of the policy, if one was assigned when the policy was created or last updated.</p>
|
|
2490
|
+
* @public
|
|
2491
|
+
*/
|
|
2492
|
+
name?: string | undefined;
|
|
2368
2493
|
}
|
|
2369
2494
|
/**
|
|
2370
2495
|
* @public
|
|
@@ -2381,6 +2506,83 @@ export interface ListPoliciesOutput {
|
|
|
2381
2506
|
*/
|
|
2382
2507
|
policies: PolicyItem[] | undefined;
|
|
2383
2508
|
}
|
|
2509
|
+
/**
|
|
2510
|
+
* <p>Contains filters for the <code>ListPolicyStoreAliases</code> operation.</p>
|
|
2511
|
+
* @public
|
|
2512
|
+
*/
|
|
2513
|
+
export interface PolicyStoreAliasFilter {
|
|
2514
|
+
/**
|
|
2515
|
+
* <p>The ID of the policy store to filter by. Only policy store aliases associated with this policy store are returned.</p>
|
|
2516
|
+
* @public
|
|
2517
|
+
*/
|
|
2518
|
+
policyStoreId?: string | undefined;
|
|
2519
|
+
}
|
|
2520
|
+
/**
|
|
2521
|
+
* @public
|
|
2522
|
+
*/
|
|
2523
|
+
export interface ListPolicyStoreAliasesInput {
|
|
2524
|
+
/**
|
|
2525
|
+
* <p>Specifies that you want to receive the next page of results. Valid only if you received a <code>NextToken</code> response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's <code>NextToken</code> response to request the next page of results.</p>
|
|
2526
|
+
* @public
|
|
2527
|
+
*/
|
|
2528
|
+
nextToken?: string | undefined;
|
|
2529
|
+
/**
|
|
2530
|
+
* <p>Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the <code>NextToken</code> response element is returned with a value (not null). Include the specified value as the <code>NextToken</code> request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results.</p> <p>If you do not specify this parameter, the operation defaults to 5 policy store aliases per response. You can specify a maximum of 50 policy store aliases per response.</p>
|
|
2531
|
+
* @public
|
|
2532
|
+
*/
|
|
2533
|
+
maxResults?: number | undefined;
|
|
2534
|
+
/**
|
|
2535
|
+
* <p>Specifies a filter to narrow the results. You can filter by <code>policyStoreId</code> to list only the policy store aliases associated with a specific policy store.</p>
|
|
2536
|
+
* @public
|
|
2537
|
+
*/
|
|
2538
|
+
filter?: PolicyStoreAliasFilter | undefined;
|
|
2539
|
+
}
|
|
2540
|
+
/**
|
|
2541
|
+
* <p>Contains information about a policy store alias.</p> <p>This data type is used as a response parameter for the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStoreAliases.html">ListPolicyStoreAliases</a> operation.</p>
|
|
2542
|
+
* @public
|
|
2543
|
+
*/
|
|
2544
|
+
export interface PolicyStoreAliasItem {
|
|
2545
|
+
/**
|
|
2546
|
+
* <p>The name of the policy store alias.</p>
|
|
2547
|
+
* @public
|
|
2548
|
+
*/
|
|
2549
|
+
aliasName: string | undefined;
|
|
2550
|
+
/**
|
|
2551
|
+
* <p>The ID of the policy store associated with the alias.</p>
|
|
2552
|
+
* @public
|
|
2553
|
+
*/
|
|
2554
|
+
policyStoreId: string | undefined;
|
|
2555
|
+
/**
|
|
2556
|
+
* <p>The Amazon Resource Name (ARN) of the policy store alias.</p>
|
|
2557
|
+
* @public
|
|
2558
|
+
*/
|
|
2559
|
+
aliasArn: string | undefined;
|
|
2560
|
+
/**
|
|
2561
|
+
* <p>The date and time the policy store alias was created.</p>
|
|
2562
|
+
* @public
|
|
2563
|
+
*/
|
|
2564
|
+
createdAt: Date | undefined;
|
|
2565
|
+
/**
|
|
2566
|
+
* <p>The state of the policy store alias. Policy Store Aliases in the Active state can be used normally. When a policy store alias is deleted, it enters the PendingDeletion state. Policy Store Aliases in the PendingDeletion state cannot be used, and creating a policy store alias with the same alias name will fail.</p>
|
|
2567
|
+
* @public
|
|
2568
|
+
*/
|
|
2569
|
+
state: AliasState | undefined;
|
|
2570
|
+
}
|
|
2571
|
+
/**
|
|
2572
|
+
* @public
|
|
2573
|
+
*/
|
|
2574
|
+
export interface ListPolicyStoreAliasesOutput {
|
|
2575
|
+
/**
|
|
2576
|
+
* <p>If present, this value indicates that more output is available than is included in the current response. Use this value in the <code>NextToken</code> request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the <code>NextToken</code> response element comes back as <code>null</code>. This indicates that this is the last page of results.</p>
|
|
2577
|
+
* @public
|
|
2578
|
+
*/
|
|
2579
|
+
nextToken?: string | undefined;
|
|
2580
|
+
/**
|
|
2581
|
+
* <p>The list of policy store aliases in the account.</p>
|
|
2582
|
+
* @public
|
|
2583
|
+
*/
|
|
2584
|
+
policyStoreAliases: PolicyStoreAliasItem[] | undefined;
|
|
2585
|
+
}
|
|
2384
2586
|
/**
|
|
2385
2587
|
* @public
|
|
2386
2588
|
*/
|
|
@@ -2447,7 +2649,7 @@ export interface ListPolicyStoresOutput {
|
|
|
2447
2649
|
*/
|
|
2448
2650
|
export interface ListPolicyTemplatesInput {
|
|
2449
2651
|
/**
|
|
2450
|
-
* <p>Specifies the ID of the policy store that contains the policy templates you want to list.</p>
|
|
2652
|
+
* <p>Specifies the ID of the policy store that contains the policy templates you want to list.</p> <p>To specify a policy store, use its ID or alias name. When using an alias name, prefix it with <code>policy-store-alias/</code>. For example:</p> <ul> <li> <p>ID: <code>PSEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Alias name: <code>policy-store-alias/example-policy-store</code> </p> </li> </ul> <p>To view aliases, use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStoreAliases.html">ListPolicyStoreAliases</a>.</p>
|
|
2451
2653
|
* @public
|
|
2452
2654
|
*/
|
|
2453
2655
|
policyStoreId: string | undefined;
|
|
@@ -2492,6 +2694,11 @@ export interface PolicyTemplateItem {
|
|
|
2492
2694
|
* @public
|
|
2493
2695
|
*/
|
|
2494
2696
|
lastUpdatedDate: Date | undefined;
|
|
2697
|
+
/**
|
|
2698
|
+
* <p>The name of the policy template, if one was assigned when the policy template was created or last updated.</p>
|
|
2699
|
+
* @public
|
|
2700
|
+
*/
|
|
2701
|
+
name?: string | undefined;
|
|
2495
2702
|
}
|
|
2496
2703
|
/**
|
|
2497
2704
|
* @public
|
|
@@ -2582,20 +2789,25 @@ export declare namespace UpdatePolicyDefinition {
|
|
|
2582
2789
|
*/
|
|
2583
2790
|
export interface UpdatePolicyInput {
|
|
2584
2791
|
/**
|
|
2585
|
-
* <p>Specifies the ID of the policy store that contains the policy that you want to update.</p>
|
|
2792
|
+
* <p>Specifies the ID of the policy store that contains the policy that you want to update.</p> <p>To specify a policy store, use its ID or alias name. When using an alias name, prefix it with <code>policy-store-alias/</code>. For example:</p> <ul> <li> <p>ID: <code>PSEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Alias name: <code>policy-store-alias/example-policy-store</code> </p> </li> </ul> <p>To view aliases, use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStoreAliases.html">ListPolicyStoreAliases</a>.</p>
|
|
2586
2793
|
* @public
|
|
2587
2794
|
*/
|
|
2588
2795
|
policyStoreId: string | undefined;
|
|
2589
2796
|
/**
|
|
2590
|
-
* <p>Specifies the ID of the policy that you want to update. To find this value, you can use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicies.html">ListPolicies</a>.</p>
|
|
2797
|
+
* <p>Specifies the ID of the policy that you want to update. To find this value, you can use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicies.html">ListPolicies</a>.</p> <p>You can use the policy name in place of the policy ID. When using a name, prefix it with <code>name/</code>. For example:</p> <ul> <li> <p>ID: <code>SPEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Name: <code>name/example-policy</code> </p> </li> </ul>
|
|
2591
2798
|
* @public
|
|
2592
2799
|
*/
|
|
2593
2800
|
policyId: string | undefined;
|
|
2594
2801
|
/**
|
|
2595
|
-
* <p>Specifies the updated policy content that you want to replace on the specified policy. The content must be valid Cedar policy language text.</p> <p>You can change only the following elements from the policy definition:</p> <ul> <li> <p>The <code>action</code> referenced by the policy.</p> </li> <li> <p>Any conditional clauses, such as <code>when</code> or <code>unless</code> clauses.</p> </li> </ul> <p>You <b>can't</b> change the following elements:</p> <ul> <li> <p>Changing from <code>static</code> to <code>templateLinked</code>.</p> </li> <li> <p>Changing the effect of the policy from <code>permit</code> or <code>forbid</code>.</p> </li> <li> <p>The <code>principal</code> referenced by the policy.</p> </li> <li> <p>The <code>resource</code> referenced by the policy.</p> </li> </ul>
|
|
2802
|
+
* <p>Specifies the updated policy content that you want to replace on the specified policy. The content must be valid Cedar policy language text.</p> <p>If you don't specify this parameter, the existing policy definition remains unchanged.</p> <p>You can change only the following elements from the policy definition:</p> <ul> <li> <p>The <code>action</code> referenced by the policy.</p> </li> <li> <p>Any conditional clauses, such as <code>when</code> or <code>unless</code> clauses.</p> </li> </ul> <p>You <b>can't</b> change the following elements:</p> <ul> <li> <p>Changing from <code>static</code> to <code>templateLinked</code>.</p> </li> <li> <p>Changing the effect of the policy from <code>permit</code> or <code>forbid</code>.</p> </li> <li> <p>The <code>principal</code> referenced by the policy.</p> </li> <li> <p>The <code>resource</code> referenced by the policy.</p> </li> </ul>
|
|
2596
2803
|
* @public
|
|
2597
2804
|
*/
|
|
2598
2805
|
definition?: UpdatePolicyDefinition | undefined;
|
|
2806
|
+
/**
|
|
2807
|
+
* <p>Specifies a name for the policy that is unique among all policies within the policy store. You can use the name in place of the policy ID in API operations that reference the policy. The name must be prefixed with <code>name/</code>.</p> <note> <p>If you don't include the name in an update request, the existing name is unchanged. To remove a name, set it to an empty string (<code>""</code>).</p> </note> <p>If you specify a name that is already associated with another policy in the policy store, you receive a <code>ConflictException</code> error.</p>
|
|
2808
|
+
* @public
|
|
2809
|
+
*/
|
|
2810
|
+
name?: string | undefined;
|
|
2599
2811
|
}
|
|
2600
2812
|
/**
|
|
2601
2813
|
* @public
|
|
@@ -2652,12 +2864,12 @@ export interface UpdatePolicyOutput {
|
|
|
2652
2864
|
*/
|
|
2653
2865
|
export interface UpdatePolicyTemplateInput {
|
|
2654
2866
|
/**
|
|
2655
|
-
* <p>Specifies the ID of the policy store that contains the policy template that you want to update.</p>
|
|
2867
|
+
* <p>Specifies the ID of the policy store that contains the policy template that you want to update.</p> <p>To specify a policy store, use its ID or alias name. When using an alias name, prefix it with <code>policy-store-alias/</code>. For example:</p> <ul> <li> <p>ID: <code>PSEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Alias name: <code>policy-store-alias/example-policy-store</code> </p> </li> </ul> <p>To view aliases, use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStoreAliases.html">ListPolicyStoreAliases</a>.</p>
|
|
2656
2868
|
* @public
|
|
2657
2869
|
*/
|
|
2658
2870
|
policyStoreId: string | undefined;
|
|
2659
2871
|
/**
|
|
2660
|
-
* <p>Specifies the ID of the policy template that you want to update.</p>
|
|
2872
|
+
* <p>Specifies the ID of the policy template that you want to update.</p> <p>You can use the policy template name in place of the policy template ID. When using a name, prefix it with <code>name/</code>. For example:</p> <ul> <li> <p>ID: <code>PTEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Name: <code>name/example-policy-template</code> </p> </li> </ul>
|
|
2661
2873
|
* @public
|
|
2662
2874
|
*/
|
|
2663
2875
|
policyTemplateId: string | undefined;
|
|
@@ -2671,6 +2883,11 @@ export interface UpdatePolicyTemplateInput {
|
|
|
2671
2883
|
* @public
|
|
2672
2884
|
*/
|
|
2673
2885
|
statement: string | undefined;
|
|
2886
|
+
/**
|
|
2887
|
+
* <p>Specifies a name for the policy template that is unique among all policy templates within the policy store. You can use the name in place of the policy template ID in API operations that reference the policy template. The name must be prefixed with <code>name/</code>.</p> <note> <p>If you don't include the name in an update request, the existing name is unchanged. To remove a name, set it to an empty string (<code>""</code>).</p> </note> <p>If you specify a name that is already associated with another policy template in the policy store, you receive a <code>ConflictException</code> error.</p>
|
|
2888
|
+
* @public
|
|
2889
|
+
*/
|
|
2890
|
+
name?: string | undefined;
|
|
2674
2891
|
}
|
|
2675
2892
|
/**
|
|
2676
2893
|
* @public
|
|
@@ -2735,7 +2952,7 @@ export declare namespace SchemaDefinition {
|
|
|
2735
2952
|
*/
|
|
2736
2953
|
export interface PutSchemaInput {
|
|
2737
2954
|
/**
|
|
2738
|
-
* <p>Specifies the ID of the policy store in which to place the schema.</p>
|
|
2955
|
+
* <p>Specifies the ID of the policy store in which to place the schema.</p> <p>To specify a policy store, use its ID or alias name. When using an alias name, prefix it with <code>policy-store-alias/</code>. For example:</p> <ul> <li> <p>ID: <code>PSEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Alias name: <code>policy-store-alias/example-policy-store</code> </p> </li> </ul> <p>To view aliases, use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStoreAliases.html">ListPolicyStoreAliases</a>.</p>
|
|
2739
2956
|
* @public
|
|
2740
2957
|
*/
|
|
2741
2958
|
policyStoreId: string | undefined;
|
|
@@ -2775,7 +2992,7 @@ export interface PutSchemaOutput {
|
|
|
2775
2992
|
*/
|
|
2776
2993
|
export interface UpdatePolicyStoreInput {
|
|
2777
2994
|
/**
|
|
2778
|
-
* <p>Specifies the ID of the policy store that you want to update</p>
|
|
2995
|
+
* <p>Specifies the ID of the policy store that you want to update</p> <p>To specify a policy store, use its ID or alias name. When using an alias name, prefix it with <code>policy-store-alias/</code>. For example:</p> <ul> <li> <p>ID: <code>PSEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Alias name: <code>policy-store-alias/example-policy-store</code> </p> </li> </ul> <p>To view aliases, use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStoreAliases.html">ListPolicyStoreAliases</a>.</p>
|
|
2779
2996
|
* @public
|
|
2780
2997
|
*/
|
|
2781
2998
|
policyStoreId: string | undefined;
|
|
@@ -3531,7 +3748,7 @@ export declare namespace EntitiesDefinition {
|
|
|
3531
3748
|
*/
|
|
3532
3749
|
export interface IsAuthorizedInput {
|
|
3533
3750
|
/**
|
|
3534
|
-
* <p>Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization decision for the input.</p>
|
|
3751
|
+
* <p>Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization decision for the input.</p> <p>To specify a policy store, use its ID or alias name. When using an alias name, prefix it with <code>policy-store-alias/</code>. For example:</p> <ul> <li> <p>ID: <code>PSEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Alias name: <code>policy-store-alias/example-policy-store</code> </p> </li> </ul> <p>To view aliases, use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStoreAliases.html">ListPolicyStoreAliases</a>.</p>
|
|
3535
3752
|
* @public
|
|
3536
3753
|
*/
|
|
3537
3754
|
policyStoreId: string | undefined;
|
|
@@ -3566,7 +3783,7 @@ export interface IsAuthorizedInput {
|
|
|
3566
3783
|
*/
|
|
3567
3784
|
export interface IsAuthorizedWithTokenInput {
|
|
3568
3785
|
/**
|
|
3569
|
-
* <p>Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization decision for the input.</p>
|
|
3786
|
+
* <p>Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization decision for the input.</p> <p>To specify a policy store, use its ID or alias name. When using an alias name, prefix it with <code>policy-store-alias/</code>. For example:</p> <ul> <li> <p>ID: <code>PSEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Alias name: <code>policy-store-alias/example-policy-store</code> </p> </li> </ul> <p>To view aliases, use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStoreAliases.html">ListPolicyStoreAliases</a>.</p>
|
|
3570
3787
|
* @public
|
|
3571
3788
|
*/
|
|
3572
3789
|
policyStoreId: string | undefined;
|
|
@@ -3606,7 +3823,7 @@ export interface IsAuthorizedWithTokenInput {
|
|
|
3606
3823
|
*/
|
|
3607
3824
|
export interface BatchIsAuthorizedInput {
|
|
3608
3825
|
/**
|
|
3609
|
-
* <p>Specifies the ID of the policy store. Policies in this policy store will be used to make the authorization decisions for the input.</p>
|
|
3826
|
+
* <p>Specifies the ID of the policy store. Policies in this policy store will be used to make the authorization decisions for the input.</p> <p>To specify a policy store, use its ID or alias name. When using an alias name, prefix it with <code>policy-store-alias/</code>. For example:</p> <ul> <li> <p>ID: <code>PSEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Alias name: <code>policy-store-alias/example-policy-store</code> </p> </li> </ul> <p>To view aliases, use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStoreAliases.html">ListPolicyStoreAliases</a>.</p>
|
|
3610
3827
|
* @public
|
|
3611
3828
|
*/
|
|
3612
3829
|
policyStoreId: string | undefined;
|
|
@@ -3626,7 +3843,7 @@ export interface BatchIsAuthorizedInput {
|
|
|
3626
3843
|
*/
|
|
3627
3844
|
export interface BatchIsAuthorizedWithTokenInput {
|
|
3628
3845
|
/**
|
|
3629
|
-
* <p>Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization decision for the input.</p>
|
|
3846
|
+
* <p>Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization decision for the input.</p> <p>To specify a policy store, use its ID or alias name. When using an alias name, prefix it with <code>policy-store-alias/</code>. For example:</p> <ul> <li> <p>ID: <code>PSEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Alias name: <code>policy-store-alias/example-policy-store</code> </p> </li> </ul> <p>To view aliases, use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStoreAliases.html">ListPolicyStoreAliases</a>.</p>
|
|
3630
3847
|
* @public
|
|
3631
3848
|
*/
|
|
3632
3849
|
policyStoreId: string | undefined;
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type { Paginator } from "@smithy/types";
|
|
2
|
+
import { ListPolicyStoreAliasesCommandInput, ListPolicyStoreAliasesCommandOutput } from "../commands/ListPolicyStoreAliasesCommand";
|
|
3
|
+
import { VerifiedPermissionsPaginationConfiguration } from "./Interfaces";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export declare const paginateListPolicyStoreAliases: (config: VerifiedPermissionsPaginationConfiguration, input: ListPolicyStoreAliasesCommandInput, ...rest: any[]) => Paginator<ListPolicyStoreAliasesCommandOutput>;
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
export * from "./Interfaces";
|
|
2
2
|
export * from "./ListIdentitySourcesPaginator";
|
|
3
3
|
export * from "./ListPoliciesPaginator";
|
|
4
|
+
export * from "./ListPolicyStoreAliasesPaginator";
|
|
4
5
|
export * from "./ListPolicyStoresPaginator";
|
|
5
6
|
export * from "./ListPolicyTemplatesPaginator";
|