@aws-sdk/client-verifiedpermissions 3.774.0 → 3.777.0

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

@@ -195,36 +195,36 @@ declare const GetIdentitySourceCommand_base: {
  * @throws {@link VerifiedPermissionsServiceException}
  * <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
  *
- * @public
+ *
  * @example To retrieve details about an identity source
  * ```javascript
  * // The following example retrieves the details for the specified identity source.
  * const input = {
- *   "identitySourceId": "ISEXAMPLEabcdefg111111",
- *   "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a"
+ *   identitySourceId: "ISEXAMPLEabcdefg111111",
+ *   policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a"
  * };
  * const command = new GetIdentitySourceCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "createdDate": "2024-08-12T18:20:50.99Z",
- *   "details": {
- *     "clientIds": [
+ *   createdDate: "2024-08-12T18:20:50.99Z",
+ *   details: {
+ *     clientIds: [
  *       "a1b2c3d4e5f6g7h8i9j0kalbmc"
  *     ],
- *     "discoveryUrl": "https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5",
- *     "openIdIssuer": "COGNITO",
- *     "userPoolArn": "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"
+ *     discoveryUrl: "https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5",
+ *     openIdIssuer: "COGNITO",
+ *     userPoolArn: "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"
  *   },
- *   "identitySourceId": "ISEXAMPLEabcdefg111111",
- *   "lastUpdatedDate": "2024-08-12T18:20:50.99Z",
- *   "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a",
- *   "principalEntityType": "AWS::Cognito"
+ *   identitySourceId: "ISEXAMPLEabcdefg111111",
+ *   lastUpdatedDate: "2024-08-12T18:20:50.99Z",
+ *   policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
+ *   principalEntityType: "AWS::Cognito"
  * }
  * *\/
- * // example id: example-1
  * ```
  *
+ * @public
  */
 export declare class GetIdentitySourceCommand extends GetIdentitySourceCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -187,38 +187,38 @@ declare const GetPolicyCommand_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 = {
- *   "policyId": "9wYixMplbbZQb5fcZHyJhY",
- *   "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a"
+ *   policyId: "9wYixMplbbZQb5fcZHyJhY",
+ *   policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a"
  * };
  * const command = new GetPolicyCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "createdDate": "2024-08-12T18:20:50.99Z",
- *   "definition": {
- *     "static": {
- *       "description": "Grant everyone of janeFriends UserGroup access to the vacationFolder Album",
- *       "statement": "permit(principal, action, resource in Album::\"publicFolder\");"
+ *   createdDate: "2024-08-12T18:20:50.99Z",
+ *   definition: {
+ *     static: {
+ *       description: "Grant everyone of janeFriends UserGroup access to the vacationFolder Album",
+ *       statement: `permit(principal, action, resource in Album::"publicFolder");`
  *     }
  *   },
- *   "lastUpdatedDate": "2024-08-12T18:20:50.99Z",
- *   "policyId": "9wYxMpljbbZQb5fcZHyJhY",
- *   "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a",
- *   "policyType": "STATIC",
- *   "resource": {
- *     "entityId": "publicFolder",
- *     "entityType": "Album"
+ *   lastUpdatedDate: "2024-08-12T18:20:50.99Z",
+ *   policyId: "9wYxMpljbbZQb5fcZHyJhY",
+ *   policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
+ *   policyType: "STATIC",
+ *   resource: {
+ *     entityId: "publicFolder",
+ *     entityType: "Album"
  *   }
  * }
  * *\/
- * // example id: example-1
  * ```
  *
+ * @public
  */
 export declare class GetPolicyCommand extends GetPolicyCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -157,29 +157,29 @@ declare const GetPolicyStoreCommand_base: {
  * @throws {@link VerifiedPermissionsServiceException}
  * <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
  *
- * @public
+ *
  * @example GetPolicyStore
  * ```javascript
  * // The following example retrieves details about the specified policy store.
  * const input = {
- *   "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a"
+ *   policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a"
  * };
  * const command = new GetPolicyStoreCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "arn": "arn:aws:verifiedpermissions::123456789012:policy-store/C7v5xMplfFH3i3e4Jrzb1a",
- *   "createdDate": "2024-08-12T18:20:50.99Z",
- *   "lastUpdatedDate": "2024-08-12T18:20:50.99Z",
- *   "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a",
- *   "validationSettings": {
- *     "mode": "STRICT"
+ *   arn: "arn:aws:verifiedpermissions::123456789012:policy-store/C7v5xMplfFH3i3e4Jrzb1a",
+ *   createdDate: "2024-08-12T18:20:50.99Z",
+ *   lastUpdatedDate: "2024-08-12T18:20:50.99Z",
+ *   policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
+ *   validationSettings: {
+ *     mode: "STRICT"
  *   }
  * }
  * *\/
- * // example id: example-1
  * ```
  *
+ * @public
  */
 export declare class GetPolicyStoreCommand extends GetPolicyStoreCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -156,29 +156,35 @@ declare const GetPolicyTemplateCommand_base: {
  * @throws {@link VerifiedPermissionsServiceException}
  * <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
  *
- * @public
+ *
  * @example GetPolicyTemplate
  * ```javascript
  * // The following example displays the details of the specified policy template.
  * const input = {
- *   "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a",
- *   "policyTemplateId": "PTEXAMPLEabcdefg111111"
+ *   policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
+ *   policyTemplateId: "PTEXAMPLEabcdefg111111"
  * };
  * const command = new GetPolicyTemplateCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "createdDate": "2024-08-12T18:20:50.99Z",
- *   "description": "Template for research dept",
- *   "lastUpdatedDate": "2024-08-12T18:20:50.99Z",
- *   "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a",
- *   "policyTemplateId": "PTEXAMPLEabcdefg111111",
- *   "statement": "permit(\n  principal ?principal,\n  action == Action::\"view\",\n  resource in ?resource\n) when {\n  principal has department && principal.department == \"research\" \n};"
+ *   createdDate: "2024-08-12T18:20:50.99Z",
+ *   description: "Template for research dept",
+ *   lastUpdatedDate: "2024-08-12T18:20:50.99Z",
+ *   policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
+ *   policyTemplateId: "PTEXAMPLEabcdefg111111",
+ *   statement: `permit(
+ *   principal ?principal,
+ *   action == Action::"view",
+ *   resource in ?resource
+ * ) when {
+ *   principal has department && principal.department == "research"
+ * };`
  * }
  * *\/
- * // example id: example-1
  * ```
  *
+ * @public
  */
 export declare class GetPolicyTemplateCommand extends GetPolicyTemplateCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -156,31 +156,52 @@ declare const GetSchemaCommand_base: {
  * @throws {@link VerifiedPermissionsServiceException}
  * <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
  *
- * @public
+ *
  * @example GetSchema
  * ```javascript
  * // The following example retrieves the current schema stored in the specified policy store.
- * //
- * // Note
- * // 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.
- * //
- * // Example strings might be displayed wrapped across multiple lines here for readability, but the operation requires the parameters be submitted as single line strings.
+ *
+ * Note
+ * 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.
+ *
+ * Example strings might be displayed wrapped across multiple lines here for readability, but the operation requires the parameters be submitted as single line strings.
  * const input = {
- *   "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a"
+ *   policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a"
  * };
  * const command = new GetSchemaCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "createdDate": "2024-08-12T18:20:50.99Z",
- *   "lastUpdatedDate": "2024-08-12T18:20:50.99Z",
- *   "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a",
- *   "schema": "{\n\"My::Application\": {\n\"actions\": {\n\"remoteAccess\": {\n\"appliesTo\": {\n\"principalTypes\":   [\"Employee\"]\n}\n}\n},\n\"entityTypes\":   {\n\"Employee\": {\n\"shape\": {\n\"attributes\": {\n\"jobLevel\": { \"type\": \"Long\" },\n\"name\": { \"type\":\"String\" }\n},\n\"type\": \"Record\"\n}\n}\n}\n}\n  }"
+ *   createdDate: "2024-08-12T18:20:50.99Z",
+ *   lastUpdatedDate: "2024-08-12T18:20:50.99Z",
+ *   policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
+ *   schema: `{
+ * "My::Application": {
+ * "actions": {
+ * "remoteAccess": {
+ * "appliesTo": {
+ * "principalTypes":   ["Employee"]
+ * }
+ * }
+ * },
+ * "entityTypes":   {
+ * "Employee": {
+ * "shape": {
+ * "attributes": {
+ * "jobLevel": { "type": "Long" },
+ * "name": { "type":"String" }
+ * },
+ * "type": "Record"
+ * }
+ * }
+ * }
+ * }
+ *   }`
  * }
  * *\/
- * // example id: example-1
  * ```
  *
+ * @public
  */
 export declare class GetSchemaCommand extends GetSchemaCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -226,73 +226,72 @@ declare const IsAuthorizedCommand_base: {
  * @throws {@link VerifiedPermissionsServiceException}
  * <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
  *
- * @public
+ *
  * @example IsAuthorized - Example 1
  * ```javascript
  * // The following example requests an authorization decision for a principal of type User named Alice, who wants to perform the updatePhoto operation, on a resource of type Photo named VacationPhoto94.jpg.
- * //
- * // The response shows that the request was allowed by one policy.
+ *
+ * The response shows that the request was allowed by one policy.
  * const input = {
- *   "action": {
- *     "actionId": "view",
- *     "actionType": "Action"
+ *   action: {
+ *     actionId: "view",
+ *     actionType: "Action"
  *   },
- *   "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a",
- *   "principal": {
- *     "entityId": "alice",
- *     "entityType": "User"
+ *   policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
+ *   principal: {
+ *     entityId: "alice",
+ *     entityType: "User"
  *   },
- *   "resource": {
- *     "entityId": "VacationPhoto94.jpg",
- *     "entityType": "Photo"
+ *   resource: {
+ *     entityId: "VacationPhoto94.jpg",
+ *     entityType: "Photo"
  *   }
  * };
  * const command = new IsAuthorizedCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "errors": [],
- *   "decision": "ALLOW",
- *   "determiningPolicies": [
+ *   decision: "ALLOW",
+ *   determiningPolicies: [
  *     {
- *       "policyId": "9wYxMpljbbZQb5fcZHyJhY"
+ *       policyId: "9wYxMpljbbZQb5fcZHyJhY"
  *     }
- *   ]
+ *   ],
+ *   errors:   []
  * }
  * *\/
- * // example id: example-1
  * ```
  *
  * @example IsAuthorized - Example 2
  * ```javascript
  * // The following example is the same as the previous example, except that the principal is User::"bob", and the policy store doesn't contain any policy that allows that user access to Album::"alice_folder". The output infers that the Deny was implicit because the list of DeterminingPolicies is empty.
  * const input = {
- *   "action": {
- *     "actionId": "view",
- *     "actionType": "Action"
+ *   action: {
+ *     actionId: "view",
+ *     actionType: "Action"
  *   },
- *   "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a",
- *   "principal": {
- *     "entityId": "bob",
- *     "entityType": "User"
+ *   policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
+ *   principal: {
+ *     entityId: "bob",
+ *     entityType: "User"
  *   },
- *   "resource": {
- *     "entityId": "VacationPhoto94.jpg",
- *     "entityType": "Photo"
+ *   resource: {
+ *     entityId: "VacationPhoto94.jpg",
+ *     entityType: "Photo"
  *   }
  * };
  * const command = new IsAuthorizedCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "errors": [],
- *   "decision": "DENY",
- *   "determiningPolicies": []
+ *   decision: "DENY",
+ *   determiningPolicies:   [],
+ *   errors:   []
  * }
  * *\/
- * // example id: example-2
  * ```
  *
+ * @public
  */
 export declare class IsAuthorizedCommand extends IsAuthorizedCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -236,44 +236,44 @@ declare const IsAuthorizedWithTokenCommand_base: {
  * @throws {@link VerifiedPermissionsServiceException}
  * <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
  *
- * @public
+ *
  * @example IsAuthorizedWithToken - Example 1
  * ```javascript
  * // The following example requests an authorization decision for a user who was authenticated by Amazon Cognito. The request uses the identity token provided by Amazon Cognito instead of the access token. In this example, the specified information store is configured to return principals as entities of type CognitoUser. The policy store contains a policy with the following statement.
- * //
- * // permit(
- * //     principal == CognitoUser::"us-east-1_1a2b3c4d5|a1b2c3d4e5f6g7h8i9j0kalbmc",
- * //     action,
- * //     resource == Photo::"VacationPhoto94.jpg"
- * // );
+ *
+ * permit(
+ *     principal == CognitoUser::"us-east-1_1a2b3c4d5|a1b2c3d4e5f6g7h8i9j0kalbmc",
+ *     action,
+ *     resource == Photo::"VacationPhoto94.jpg"
+ * );
  * const input = {
- *   "action": {
- *     "actionId": "View",
- *     "actionType": "Action"
+ *   action: {
+ *     actionId: "View",
+ *     actionType: "Action"
  *   },
- *   "identityToken": "EgZjxMPlbWUyBggAEEUYOdIBCDM3NDlqMGo3qAIAsAIA",
- *   "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a",
- *   "resource": {
- *     "entityId": "vacationPhoto94.jpg",
- *     "entityType": "Photo"
+ *   identityToken: "EgZjxMPlbWUyBggAEEUYOdIBCDM3NDlqMGo3qAIAsAIA",
+ *   policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
+ *   resource: {
+ *     entityId: "vacationPhoto94.jpg",
+ *     entityType: "Photo"
  *   }
  * };
  * const command = new IsAuthorizedWithTokenCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "errors": [],
- *   "decision": "ALLOW",
- *   "determiningPolicies": [
+ *   decision: "ALLOW",
+ *   determiningPolicies: [
  *     {
- *       "policyId": "9wYxMpljbbZQb5fcZHyJhY"
+ *       policyId: "9wYxMpljbbZQb5fcZHyJhY"
  *     }
- *   ]
+ *   ],
+ *   errors:   []
  * }
  * *\/
- * // example id: example-1
  * ```
  *
+ * @public
  */
 export declare class IsAuthorizedWithTokenCommand extends IsAuthorizedWithTokenCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -206,39 +206,39 @@ declare const ListIdentitySourcesCommand_base: {
  * @throws {@link VerifiedPermissionsServiceException}
  * <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
  *
- * @public
+ *
  * @example ListIdentitySources
  * ```javascript
  * // The following example request creates lists the identity sources currently defined in the specified policy store.
  * const input = {
- *   "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a"
+ *   policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a"
  * };
  * const command = new ListIdentitySourcesCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "identitySources": [
+ *   identitySources: [
  *     {
- *       "createdDate": "2023-05-19T20:29:23.66812Z",
- *       "details": {
- *         "clientIds": [
+ *       createdDate: "2023-05-19T20:29:23.66812Z",
+ *       details: {
+ *         clientIds: [
  *           "a1b2c3d4e5f6g7h8i9j0kalbmc"
  *         ],
- *         "discoveryUrl": "https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5",
- *         "openIdIssuer": "COGNITO",
- *         "userPoolArn": "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"
+ *         discoveryUrl: "https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5",
+ *         openIdIssuer: "COGNITO",
+ *         userPoolArn: "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"
  *       },
- *       "identitySourceId": "ISEXAMPLEabcdefg111111",
- *       "lastUpdatedDate": "2023-05-19T20:29:23.66812Z",
- *       "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a",
- *       "principalEntityType": "User"
+ *       identitySourceId: "ISEXAMPLEabcdefg111111",
+ *       lastUpdatedDate: "2023-05-19T20:29:23.66812Z",
+ *       policyStoreId: "C7v5xMplfFH3i3e4Jrzb1a",
+ *       principalEntityType: "User"
  *     }
  *   ]
  * }
  * *\/
- * // example id: example-1
  * ```
  *
+ * @public
  */
 export declare class ListIdentitySourcesCommand extends ListIdentitySourcesCommand_base {
     /** @internal type navigation helper, not in runtime. */