@aws-sdk/client-verifiedpermissions 3.775.0 → 3.777.0

package/dist-types/commands/BatchGetPolicyCommand.d.ts

@@ -190,77 +190,77 @@ declare const BatchGetPolicyCommand_base: {
  * @throws {@link VerifiedPermissionsServiceException}
  * <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
  *
- * @public
+ *
  * @example To retrieve details about a policy
  * ```javascript
  * // 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.
  * const input = {
- *   "requests": [
+ *   requests: [
  *     {
- *       "policyId": "PWv5M6d5HePx3gVVLKY1nK",
- *       "policyStoreId": "ERZeDpRc34dkYZeb6FZRVC"
+ *       policyId: "PWv5M6d5HePx3gVVLKY1nK",
+ *       policyStoreId: "ERZeDpRc34dkYZeb6FZRVC"
  *     },
  *     {
- *       "policyId": "LzFn6KgLWvv4Mbegus35jn",
- *       "policyStoreId": "ERZeDpRc34dkYZeb6FZRVC"
+ *       policyId: "LzFn6KgLWvv4Mbegus35jn",
+ *       policyStoreId: "ERZeDpRc34dkYZeb6FZRVC"
  *     },
  *     {
- *       "policyId": "77gLjer8H5o3mvrnMGrSL5",
- *       "policyStoreId": "ERZeDpRc34dkYZeb6FZRVC"
+ *       policyId: "77gLjer8H5o3mvrnMGrSL5",
+ *       policyStoreId: "ERZeDpRc34dkYZeb6FZRVC"
  *     }
  *   ]
  * };
  * const command = new BatchGetPolicyCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "errors": [],
- *   "results": [
+ *   errors:   [],
+ *   results: [
  *     {
- *       "createdDate": "2024-10-18T18:53:39.258153Z",
- *       "definition": {
- *         "static": {
- *           "description": "Users can manage account resources in any account they own",
- *           "statement": "permit (principal, action in PhotoFlash::Action::\"ManageAccount\",resource) when { resource in principal.Account };"
+ *       createdDate: "2024-10-18T18:53:39.258153Z",
+ *       definition: {
+ *         static: {
+ *           description: "Users can manage account resources in any account they own",
+ *           statement: `permit (principal, action in PhotoFlash::Action::"ManageAccount",resource) when { resource in principal.Account };`
  *         }
  *       },
- *       "lastUpdatedDate": "2024-10-18T18:53:39.258153Z",
- *       "policyId": "PWv5M6d5HePx3gVVLKY1nK",
- *       "policyStoreId": "ERZeDpRc34dkYZeb6FZRVC",
- *       "policyType": "STATIC"
+ *       lastUpdatedDate: "2024-10-18T18:53:39.258153Z",
+ *       policyId: "PWv5M6d5HePx3gVVLKY1nK",
+ *       policyStoreId: "ERZeDpRc34dkYZeb6FZRVC",
+ *       policyType: "STATIC"
  *     },
  *     {
- *       "createdDate": "2024-10-18T18:57:03.305027Z",
- *       "definition": {
- *         "static": {
- *           "description": "User alice can't delete any photos.",
- *           "statement": "forbid (principal == PhotoFlash::User::\"alice\", action in [PhotoFlash::Action::\"DeletePhoto\"], resource);"
+ *       createdDate: "2024-10-18T18:57:03.305027Z",
+ *       definition: {
+ *         static: {
+ *           description: "User alice can't delete any photos.",
+ *           statement: `forbid (principal == PhotoFlash::User::"alice", action in [PhotoFlash::Action::"DeletePhoto"], resource);`
  *         }
  *       },
- *       "lastUpdatedDate": "2024-10-18T18:57:03.305027Z",
- *       "policyId": "LzFn6KgLWvv4Mbegus35jn",
- *       "policyStoreId": "ERZeDpRc34dkYZeb6FZRVC",
- *       "policyType": "STATIC"
+ *       lastUpdatedDate: "2024-10-18T18:57:03.305027Z",
+ *       policyId: "LzFn6KgLWvv4Mbegus35jn",
+ *       policyStoreId: "ERZeDpRc34dkYZeb6FZRVC",
+ *       policyType: "STATIC"
  *     },
  *     {
- *       "createdDate": "2024-10-18T18:57:48.005343Z",
- *       "definition": {
- *         "static": {
- *           "description": "User alice can view and delete photos.",
- *           "statement": "permit (principal == PhotoFlash::User::\"alice\", action in [PhotoFlash::Action::\"DeletePhoto\", PhotoFlash::Action::\"ViewPhoto\"], resource);"
+ *       createdDate: "2024-10-18T18:57:48.005343Z",
+ *       definition: {
+ *         static: {
+ *           description: "User alice can view and delete photos.",
+ *           statement: `permit (principal == PhotoFlash::User::"alice", action in [PhotoFlash::Action::"DeletePhoto", PhotoFlash::Action::"ViewPhoto"], resource);`
  *         }
  *       },
- *       "lastUpdatedDate": "2024-10-18T18:57:48.005343Z",
- *       "policyId": "77gLjer8H5o3mvrnMGrSL5",
- *       "policyStoreId": "ERZeDpRc34dkYZeb6FZRVC",
- *       "policyType": "STATIC"
+ *       lastUpdatedDate: "2024-10-18T18:57:48.005343Z",
+ *       policyId: "77gLjer8H5o3mvrnMGrSL5",
+ *       policyStoreId: "ERZeDpRc34dkYZeb6FZRVC",
+ *       policyType: "STATIC"
  *     }
  *   ]
  * }
  * *\/
- * // example id: example-1
  * ```
  *
+ * @public
  */
 export declare class BatchGetPolicyCommand extends BatchGetPolicyCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/BatchIsAuthorizedCommand.d.ts

@@ -295,168 +295,168 @@ declare const BatchIsAuthorizedCommand_base: {
  * @throws {@link VerifiedPermissionsServiceException}
  * <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
  *
- * @public
+ *
  * @example Batch - Example 1
  * ```javascript
  * // The following example requests two authorization decisions for two principals                     of type Usernamed Alice and Annalisa.
  * const input = {
- *   "entities": {
- *     "entityList": [
+ *   entities: {
+ *     entityList: [
  *       {
- *         "attributes": {
- *           "Account": {
- *             "entityIdentifier": {
- *               "entityId": "1234",
- *               "entityType": "PhotoFlash::Account"
+ *         attributes: {
+ *           Account: {
+ *             entityIdentifier: {
+ *               entityId: "1234",
+ *               entityType: "PhotoFlash::Account"
  *             }
  *           },
- *           "Email": {
- *             "string": ""
+ *           Email: {
+ *             string: ""
  *           }
  *         },
- *         "identifier": {
- *           "entityId": "Alice",
- *           "entityType": "PhotoFlash::User"
+ *         identifier: {
+ *           entityId: "Alice",
+ *           entityType: "PhotoFlash::User"
  *         },
- *         "parents": []
+ *         parents:         []
  *       },
  *       {
- *         "attributes": {
- *           "Account": {
- *             "entityIdentifier": {
- *               "entityId": "5678",
- *               "entityType": "PhotoFlash::Account"
+ *         attributes: {
+ *           Account: {
+ *             entityIdentifier: {
+ *               entityId: "5678",
+ *               entityType: "PhotoFlash::Account"
  *             }
  *           },
- *           "Email": {
- *             "string": ""
+ *           Email: {
+ *             string: ""
  *           }
  *         },
- *         "identifier": {
- *           "entityId": "Annalisa",
- *           "entityType": "PhotoFlash::User"
+ *         identifier: {
+ *           entityId: "Annalisa",
+ *           entityType: "PhotoFlash::User"
  *         },
- *         "parents": []
+ *         parents:         []
  *       },
  *       {
- *         "attributes": {
- *           "IsPrivate": {
- *             "boolean": false
+ *         attributes: {
+ *           IsPrivate: {
+ *             boolean: false
  *           },
- *           "Name": {
- *             "string": ""
+ *           Name: {
+ *             string: ""
  *           }
  *         },
- *         "identifier": {
- *           "entityId": "VacationPhoto94.jpg",
- *           "entityType": "PhotoFlash::Photo"
+ *         identifier: {
+ *           entityId: "VacationPhoto94.jpg",
+ *           entityType: "PhotoFlash::Photo"
  *         },
- *         "parents": [
+ *         parents: [
  *           {
- *             "entityId": "1234",
- *             "entityType": "PhotoFlash::Account"
+ *             entityId: "1234",
+ *             entityType: "PhotoFlash::Account"
  *           }
  *         ]
  *       },
  *       {
- *         "attributes": {
- *           "Name": {
- *             "string": ""
+ *         attributes: {
+ *           Name: {
+ *             string: ""
  *           }
  *         },
- *         "identifier": {
- *           "entityId": "1234",
- *           "entityType": "PhotoFlash::Account"
+ *         identifier: {
+ *           entityId: "1234",
+ *           entityType: "PhotoFlash::Account"
  *         },
- *         "parents": []
+ *         parents:         []
  *       }
  *     ]
  *   },
- *   "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a",
- *   "requests": [
+ *   policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
+ *   requests: [
  *     {
- *       "action": {
- *         "actionId": "ViewPhoto",
- *         "actionType": "PhotoFlash::Action"
+ *       action: {
+ *         actionId: "ViewPhoto",
+ *         actionType: "PhotoFlash::Action"
  *       },
- *       "principal": {
- *         "entityId": "Alice",
- *         "entityType": "PhotoFlash::User"
+ *       principal: {
+ *         entityId: "Alice",
+ *         entityType: "PhotoFlash::User"
  *       },
- *       "resource": {
- *         "entityId": "VacationPhoto94.jpg",
- *         "entityType": "PhotoFlash::Photo"
+ *       resource: {
+ *         entityId: "VacationPhoto94.jpg",
+ *         entityType: "PhotoFlash::Photo"
  *       }
  *     },
  *     {
- *       "action": {
- *         "actionId": "DeletePhoto",
- *         "actionType": "PhotoFlash::Action"
+ *       action: {
+ *         actionId: "DeletePhoto",
+ *         actionType: "PhotoFlash::Action"
  *       },
- *       "principal": {
- *         "entityId": "Annalisa",
- *         "entityType": "PhotoFlash::User"
+ *       principal: {
+ *         entityId: "Annalisa",
+ *         entityType: "PhotoFlash::User"
  *       },
- *       "resource": {
- *         "entityId": "VacationPhoto94.jpg",
- *         "entityType": "PhotoFlash::Photo"
+ *       resource: {
+ *         entityId: "VacationPhoto94.jpg",
+ *         entityType: "PhotoFlash::Photo"
  *       }
  *     }
  *   ]
  * };
  * const command = new BatchIsAuthorizedCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "results": [
+ *   results: [
  *     {
- *       "errors": [],
- *       "decision": "ALLOW",
- *       "determiningPolicies": [
+ *       decision: "ALLOW",
+ *       determiningPolicies: [
  *         {
- *           "policyId": "9wYxMpljbbZQb5fcZHyJhY"
+ *           policyId: "9wYxMpljbbZQb5fcZHyJhY"
  *         }
  *       ],
- *       "request": {
- *         "action": {
- *           "actionId": "ViewPhoto",
- *           "actionType": "PhotoFlash::Action"
+ *       errors:       [],
+ *       request: {
+ *         action: {
+ *           actionId: "ViewPhoto",
+ *           actionType: "PhotoFlash::Action"
  *         },
- *         "principal": {
- *           "entityId": "alice",
- *           "entityType": "PhotoFlash::User"
+ *         principal: {
+ *           entityId: "alice",
+ *           entityType: "PhotoFlash::User"
  *         },
- *         "resource": {
- *           "entityId": "VacationPhoto94.jpg",
- *           "entityType": "PhotoFlash::Photo"
+ *         resource: {
+ *           entityId: "VacationPhoto94.jpg",
+ *           entityType: "PhotoFlash::Photo"
  *         }
  *       }
  *     },
  *     {
- *       "errors": [],
- *       "decision": "DENY",
- *       "determiningPolicies": [],
- *       "request": {
- *         "action": {
- *           "actionId": "DeletePhoto",
- *           "actionType": "PhotoFlash::Action"
+ *       decision: "DENY",
+ *       determiningPolicies:       [],
+ *       errors:       [],
+ *       request: {
+ *         action: {
+ *           actionId: "DeletePhoto",
+ *           actionType: "PhotoFlash::Action"
  *         },
- *         "principal": {
- *           "entityId": "annalisa",
- *           "entityType": "PhotoFlash::User"
+ *         principal: {
+ *           entityId: "annalisa",
+ *           entityType: "PhotoFlash::User"
  *         },
- *         "resource": {
- *           "entityId": "VacationPhoto94.jpg",
- *           "entityType": "PhotoFlash::Photo"
+ *         resource: {
+ *           entityId: "VacationPhoto94.jpg",
+ *           entityType: "PhotoFlash::Photo"
  *         }
  *       }
  *     }
  *   ]
  * }
  * *\/
- * // example id: example-1
  * ```
  *
+ * @public
  */
 export declare class BatchIsAuthorizedCommand extends BatchIsAuthorizedCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/BatchIsAuthorizedWithTokenCommand.d.ts

@@ -291,142 +291,142 @@ declare const BatchIsAuthorizedWithTokenCommand_base: {
  * @throws {@link VerifiedPermissionsServiceException}
  * <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
  *
- * @public
+ *
  * @example Batch - Example 1
  * ```javascript
  * // The following example requests three authorization decisions for two resources                     and two actions in different photo albums.
  * const input = {
- *   "entities": {
- *     "entityList": [
+ *   entities: {
+ *     entityList: [
  *       {
- *         "identifier": {
- *           "entityId": "VacationPhoto94.jpg",
- *           "entityType": "PhotoFlash::Photo"
+ *         identifier: {
+ *           entityId: "VacationPhoto94.jpg",
+ *           entityType: "PhotoFlash::Photo"
  *         },
- *         "parents": [
+ *         parents: [
  *           {
- *             "entityId": "MyExampleAlbum1",
- *             "entityType": "PhotoFlash::Album"
+ *             entityId: "MyExampleAlbum1",
+ *             entityType: "PhotoFlash::Album"
  *           }
  *         ]
  *       },
  *       {
- *         "identifier": {
- *           "entityId": "OfficePhoto94.jpg",
- *           "entityType": "PhotoFlash::Photo"
+ *         identifier: {
+ *           entityId: "OfficePhoto94.jpg",
+ *           entityType: "PhotoFlash::Photo"
  *         },
- *         "parents": [
+ *         parents: [
  *           {
- *             "entityId": "MyExampleAlbum2",
- *             "entityType": "PhotoFlash::Album"
+ *             entityId: "MyExampleAlbum2",
+ *             entityType: "PhotoFlash::Album"
  *           }
  *         ]
  *       }
  *     ]
  *   },
- *   "identityToken": "eyJra12345EXAMPLE",
- *   "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a",
- *   "requests": [
+ *   identityToken: "eyJra12345EXAMPLE",
+ *   policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
+ *   requests: [
  *     {
- *       "action": {
- *         "actionId": "ViewPhoto",
- *         "actionType": "PhotoFlash::Action"
+ *       action: {
+ *         actionId: "ViewPhoto",
+ *         actionType: "PhotoFlash::Action"
  *       },
- *       "resource": {
- *         "entityId": "VacationPhoto94.jpg",
- *         "entityType": "PhotoFlash::Photo"
+ *       resource: {
+ *         entityId: "VacationPhoto94.jpg",
+ *         entityType: "PhotoFlash::Photo"
  *       }
  *     },
  *     {
- *       "action": {
- *         "actionId": "SharePhoto",
- *         "actionType": "PhotoFlash::Action"
+ *       action: {
+ *         actionId: "SharePhoto",
+ *         actionType: "PhotoFlash::Action"
  *       },
- *       "resource": {
- *         "entityId": "VacationPhoto94.jpg",
- *         "entityType": "PhotoFlash::Photo"
+ *       resource: {
+ *         entityId: "VacationPhoto94.jpg",
+ *         entityType: "PhotoFlash::Photo"
  *       }
  *     },
  *     {
- *       "action": {
- *         "actionId": "ViewPhoto",
- *         "actionType": "PhotoFlash::Action"
+ *       action: {
+ *         actionId: "ViewPhoto",
+ *         actionType: "PhotoFlash::Action"
  *       },
- *       "resource": {
- *         "entityId": "OfficePhoto94.jpg",
- *         "entityType": "PhotoFlash::Photo"
+ *       resource: {
+ *         entityId: "OfficePhoto94.jpg",
+ *         entityType: "PhotoFlash::Photo"
  *       }
  *     }
  *   ]
  * };
  * const command = new BatchIsAuthorizedWithTokenCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "principal": {
- *     "entityId": "us-east-1_EXAMPLE|a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
- *     "entityType": "PhotoFlash::User"
+ *   principal: {
+ *     entityId: "us-east-1_EXAMPLE|a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
+ *     entityType: "PhotoFlash::User"
  *   },
- *   "results": [
+ *   results: [
  *     {
- *       "errors": [],
- *       "decision": "ALLOW",
- *       "determiningPolicies": [
+ *       decision: "ALLOW",
+ *       determiningPolicies: [
  *         {
- *           "policyId": "9wYixMplbbZQb5fcZHyJhY"
+ *           policyId: "9wYixMplbbZQb5fcZHyJhY"
  *         }
  *       ],
- *       "request": {
- *         "action": {
- *           "actionId": "ViewPhoto",
- *           "actionType": "PhotoFlash::Action"
+ *       errors:       [],
+ *       request: {
+ *         action: {
+ *           actionId: "ViewPhoto",
+ *           actionType: "PhotoFlash::Action"
  *         },
- *         "resource": {
- *           "entityId": "VacationPhoto94.jpg",
- *           "entityType": "PhotoFlash::Photo"
+ *         resource: {
+ *           entityId: "VacationPhoto94.jpg",
+ *           entityType: "PhotoFlash::Photo"
  *         }
  *       }
  *     },
  *     {
- *       "errors": [],
- *       "decision": "ALLOW",
- *       "determiningPolicies": [
+ *       decision: "ALLOW",
+ *       determiningPolicies: [
  *         {
- *           "policyId": "9wYixMplbbZQb5fcZHyJhY"
+ *           policyId: "9wYixMplbbZQb5fcZHyJhY"
  *         }
  *       ],
- *       "request": {
- *         "action": {
- *           "actionId": "SharePhoto",
- *           "actionType": "PhotoFlash::Action"
+ *       errors:       [],
+ *       request: {
+ *         action: {
+ *           actionId: "SharePhoto",
+ *           actionType: "PhotoFlash::Action"
  *         },
- *         "resource": {
- *           "entityId": "VacationPhoto94.jpg",
- *           "entityType": "PhotoFlash::Photo"
+ *         resource: {
+ *           entityId: "VacationPhoto94.jpg",
+ *           entityType: "PhotoFlash::Photo"
  *         }
  *       }
  *     },
  *     {
- *       "errors": [],
- *       "decision": "DENY",
- *       "determiningPolicies": [],
- *       "request": {
- *         "action": {
- *           "actionId": "ViewPhoto",
- *           "actionType": "PhotoFlash::Action"
+ *       decision: "DENY",
+ *       determiningPolicies:       [],
+ *       errors:       [],
+ *       request: {
+ *         action: {
+ *           actionId: "ViewPhoto",
+ *           actionType: "PhotoFlash::Action"
  *         },
- *         "resource": {
- *           "entityId": "OfficePhoto94.jpg",
- *           "entityType": "PhotoFlash::Photo"
+ *         resource: {
+ *           entityId: "OfficePhoto94.jpg",
+ *           entityType: "PhotoFlash::Photo"
  *         }
  *       }
  *     }
  *   ]
  * }
  * *\/
- * // example id: example-1
  * ```
  *
+ * @public
  */
 export declare class BatchIsAuthorizedWithTokenCommand extends BatchIsAuthorizedWithTokenCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/CreateIdentitySourceCommand.d.ts

@@ -231,36 +231,36 @@ declare const CreateIdentitySourceCommand_base: {
  * @throws {@link VerifiedPermissionsServiceException}
  * <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
  *
- * @public
+ *
  * @example To create an identity source
  * ```javascript
  * // The following ``create-identity-source`` example creates an identity source that lets you reference identities stored in the specified Amazon Cognito user pool. Those identities are available in Verified Permissions as entities of type ``User``.
  * const input = {
- *   "clientToken": "a1b2c3d4-e5f6-a1b2-c3d4-TOKEN1111111",
- *   "configuration": {
- *     "cognitoUserPoolConfiguration": {
- *       "clientIds": [
+ *   clientToken: "a1b2c3d4-e5f6-a1b2-c3d4-TOKEN1111111",
+ *   configuration: {
+ *     cognitoUserPoolConfiguration: {
+ *       clientIds: [
  *         "a1b2c3d4e5f6g7h8i9j0kalbmc"
  *       ],
- *       "userPoolArn": "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"
+ *       userPoolArn: "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"
  *     }
  *   },
- *   "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a",
- *   "principalEntityType": "User"
+ *   policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
+ *   principalEntityType: "User"
  * };
  * const command = new CreateIdentitySourceCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "createdDate": "2024-08-12T18:20:50.99Z",
- *   "identitySourceId": "ISEXAMPLEabcdefg111111",
- *   "lastUpdatedDate": "2024-08-12T18:20:50.99Z",
- *   "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a"
+ *   createdDate: "2024-08-12T18:20:50.99Z",
+ *   identitySourceId: "ISEXAMPLEabcdefg111111",
+ *   lastUpdatedDate: "2024-08-12T18:20:50.99Z",
+ *   policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a"
  * }
  * *\/
- * // example id: example-1
  * ```
  *
+ * @public
  */
 export declare class CreateIdentitySourceCommand extends CreateIdentitySourceCommand_base {
     /** @internal type navigation helper, not in runtime. */