@aws-sdk/client-verifiedpermissions 3.661.0 → 3.664.0

package/dist-cjs/runtimeConfig.js

@@ -44,6 +44,7 @@ const getRuntimeConfig = (config) => {
         streamCollector: config?.streamCollector ?? node_http_handler_1.streamCollector,
         useDualstackEndpoint: config?.useDualstackEndpoint ?? (0, node_config_provider_1.loadConfig)(config_resolver_1.NODE_USE_DUALSTACK_ENDPOINT_CONFIG_OPTIONS),
         useFipsEndpoint: config?.useFipsEndpoint ?? (0, node_config_provider_1.loadConfig)(config_resolver_1.NODE_USE_FIPS_ENDPOINT_CONFIG_OPTIONS),
+        userAgentAppId: config?.userAgentAppId ?? (0, node_config_provider_1.loadConfig)(util_user_agent_node_1.NODE_APP_ID_CONFIG_OPTIONS),
     };
 };
 exports.getRuntimeConfig = getRuntimeConfig;

package/dist-es/runtimeConfig.js

@@ -1,7 +1,7 @@
 import packageInfo from "../package.json";
 import { emitWarningIfUnsupportedVersion as awsCheckVersion } from "@aws-sdk/core";
 import { defaultProvider as credentialDefaultProvider } from "@aws-sdk/credential-provider-node";
-import { defaultUserAgent } from "@aws-sdk/util-user-agent-node";
+import { NODE_APP_ID_CONFIG_OPTIONS, defaultUserAgent } from "@aws-sdk/util-user-agent-node";
 import { NODE_REGION_CONFIG_FILE_OPTIONS, NODE_REGION_CONFIG_OPTIONS, NODE_USE_DUALSTACK_ENDPOINT_CONFIG_OPTIONS, NODE_USE_FIPS_ENDPOINT_CONFIG_OPTIONS, } from "@smithy/config-resolver";
 import { Hash } from "@smithy/hash-node";
 import { NODE_MAX_ATTEMPT_CONFIG_OPTIONS, NODE_RETRY_MODE_CONFIG_OPTIONS } from "@smithy/middleware-retry";
@@ -40,5 +40,6 @@ export const getRuntimeConfig = (config) => {
         streamCollector: config?.streamCollector ?? streamCollector,
         useDualstackEndpoint: config?.useDualstackEndpoint ?? loadNodeConfig(NODE_USE_DUALSTACK_ENDPOINT_CONFIG_OPTIONS),
         useFipsEndpoint: config?.useFipsEndpoint ?? loadNodeConfig(NODE_USE_FIPS_ENDPOINT_CONFIG_OPTIONS),
+        userAgentAppId: config?.userAgentAppId ?? loadNodeConfig(NODE_APP_ID_CONFIG_OPTIONS),
     };
 };

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

@@ -285,6 +285,167 @@ declare const BatchIsAuthorizedCommand_base: {
  * <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": [
+ *       {
+ *         "attributes": {
+ *           "Account": {
+ *             "entityIdentifier": {
+ *               "entityId": "1234",
+ *               "entityType": "PhotoFlash::Account"
+ *             }
+ *           },
+ *           "Email": {
+ *             "string": ""
+ *           }
+ *         },
+ *         "identifier": {
+ *           "entityId": "Alice",
+ *           "entityType": "PhotoFlash::User"
+ *         },
+ *         "parents": []
+ *       },
+ *       {
+ *         "attributes": {
+ *           "Account": {
+ *             "entityIdentifier": {
+ *               "entityId": "5678",
+ *               "entityType": "PhotoFlash::Account"
+ *             }
+ *           },
+ *           "Email": {
+ *             "string": ""
+ *           }
+ *         },
+ *         "identifier": {
+ *           "entityId": "Annalisa",
+ *           "entityType": "PhotoFlash::User"
+ *         },
+ *         "parents": []
+ *       },
+ *       {
+ *         "attributes": {
+ *           "IsPrivate": {
+ *             "boolean": false
+ *           },
+ *           "Name": {
+ *             "string": ""
+ *           }
+ *         },
+ *         "identifier": {
+ *           "entityId": "VacationPhoto94.jpg",
+ *           "entityType": "PhotoFlash::Photo"
+ *         },
+ *         "parents": [
+ *           {
+ *             "entityId": "1234",
+ *             "entityType": "PhotoFlash::Account"
+ *           }
+ *         ]
+ *       },
+ *       {
+ *         "attributes": {
+ *           "Name": {
+ *             "string": ""
+ *           }
+ *         },
+ *         "identifier": {
+ *           "entityId": "1234",
+ *           "entityType": "PhotoFlash::Account"
+ *         },
+ *         "parents": []
+ *       }
+ *     ]
+ *   },
+ *   "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a",
+ *   "requests": [
+ *     {
+ *       "action": {
+ *         "actionId": "ViewPhoto",
+ *         "actionType": "PhotoFlash::Action"
+ *       },
+ *       "principal": {
+ *         "entityId": "Alice",
+ *         "entityType": "PhotoFlash::User"
+ *       },
+ *       "resource": {
+ *         "entityId": "VacationPhoto94.jpg",
+ *         "entityType": "PhotoFlash::Photo"
+ *       }
+ *     },
+ *     {
+ *       "action": {
+ *         "actionId": "DeletePhoto",
+ *         "actionType": "PhotoFlash::Action"
+ *       },
+ *       "principal": {
+ *         "entityId": "Annalisa",
+ *         "entityType": "PhotoFlash::User"
+ *       },
+ *       "resource": {
+ *         "entityId": "VacationPhoto94.jpg",
+ *         "entityType": "PhotoFlash::Photo"
+ *       }
+ *     }
+ *   ]
+ * };
+ * const command = new BatchIsAuthorizedCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "results": [
+ *     {
+ *       "errors": [],
+ *       "decision": "ALLOW",
+ *       "determiningPolicies": [
+ *         {
+ *           "policyId": "9wYxMpljbbZQb5fcZHyJhY"
+ *         }
+ *       ],
+ *       "request": {
+ *         "action": {
+ *           "actionId": "ViewPhoto",
+ *           "actionType": "PhotoFlash::Action"
+ *         },
+ *         "principal": {
+ *           "entityId": "alice",
+ *           "entityType": "PhotoFlash::User"
+ *         },
+ *         "resource": {
+ *           "entityId": "VacationPhoto94.jpg",
+ *           "entityType": "PhotoFlash::Photo"
+ *         }
+ *       }
+ *     },
+ *     {
+ *       "errors": [],
+ *       "decision": "DENY",
+ *       "determiningPolicies": [],
+ *       "request": {
+ *         "action": {
+ *           "actionId": "DeletePhoto",
+ *           "actionType": "PhotoFlash::Action"
+ *         },
+ *         "principal": {
+ *           "entityId": "annalisa",
+ *           "entityType": "PhotoFlash::User"
+ *         },
+ *         "resource": {
+ *           "entityId": "VacationPhoto94.jpg",
+ *           "entityType": "PhotoFlash::Photo"
+ *         }
+ *       }
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class BatchIsAuthorizedCommand extends BatchIsAuthorizedCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -281,6 +281,141 @@ declare const BatchIsAuthorizedWithTokenCommand_base: {
  * <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": [
+ *       {
+ *         "identifier": {
+ *           "entityId": "VacationPhoto94.jpg",
+ *           "entityType": "PhotoFlash::Photo"
+ *         },
+ *         "parents": [
+ *           {
+ *             "entityId": "MyExampleAlbum1",
+ *             "entityType": "PhotoFlash::Album"
+ *           }
+ *         ]
+ *       },
+ *       {
+ *         "identifier": {
+ *           "entityId": "OfficePhoto94.jpg",
+ *           "entityType": "PhotoFlash::Photo"
+ *         },
+ *         "parents": [
+ *           {
+ *             "entityId": "MyExampleAlbum2",
+ *             "entityType": "PhotoFlash::Album"
+ *           }
+ *         ]
+ *       }
+ *     ]
+ *   },
+ *   "identityToken": "eyJra12345EXAMPLE",
+ *   "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a",
+ *   "requests": [
+ *     {
+ *       "action": {
+ *         "actionId": "ViewPhoto",
+ *         "actionType": "PhotoFlash::Action"
+ *       },
+ *       "resource": {
+ *         "entityId": "VacationPhoto94.jpg",
+ *         "entityType": "PhotoFlash::Photo"
+ *       }
+ *     },
+ *     {
+ *       "action": {
+ *         "actionId": "SharePhoto",
+ *         "actionType": "PhotoFlash::Action"
+ *       },
+ *       "resource": {
+ *         "entityId": "VacationPhoto94.jpg",
+ *         "entityType": "PhotoFlash::Photo"
+ *       }
+ *     },
+ *     {
+ *       "action": {
+ *         "actionId": "ViewPhoto",
+ *         "actionType": "PhotoFlash::Action"
+ *       },
+ *       "resource": {
+ *         "entityId": "OfficePhoto94.jpg",
+ *         "entityType": "PhotoFlash::Photo"
+ *       }
+ *     }
+ *   ]
+ * };
+ * const command = new BatchIsAuthorizedWithTokenCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "principal": {
+ *     "entityId": "us-east-1_EXAMPLE|a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
+ *     "entityType": "PhotoFlash::User"
+ *   },
+ *   "results": [
+ *     {
+ *       "errors": [],
+ *       "decision": "ALLOW",
+ *       "determiningPolicies": [
+ *         {
+ *           "policyId": "9wYixMplbbZQb5fcZHyJhY"
+ *         }
+ *       ],
+ *       "request": {
+ *         "action": {
+ *           "actionId": "ViewPhoto",
+ *           "actionType": "PhotoFlash::Action"
+ *         },
+ *         "resource": {
+ *           "entityId": "VacationPhoto94.jpg",
+ *           "entityType": "PhotoFlash::Photo"
+ *         }
+ *       }
+ *     },
+ *     {
+ *       "errors": [],
+ *       "decision": "ALLOW",
+ *       "determiningPolicies": [
+ *         {
+ *           "policyId": "9wYixMplbbZQb5fcZHyJhY"
+ *         }
+ *       ],
+ *       "request": {
+ *         "action": {
+ *           "actionId": "SharePhoto",
+ *           "actionType": "PhotoFlash::Action"
+ *         },
+ *         "resource": {
+ *           "entityId": "VacationPhoto94.jpg",
+ *           "entityType": "PhotoFlash::Photo"
+ *         }
+ *       }
+ *     },
+ *     {
+ *       "errors": [],
+ *       "decision": "DENY",
+ *       "determiningPolicies": [],
+ *       "request": {
+ *         "action": {
+ *           "actionId": "ViewPhoto",
+ *           "actionType": "PhotoFlash::Action"
+ *         },
+ *         "resource": {
+ *           "entityId": "OfficePhoto94.jpg",
+ *           "entityType": "PhotoFlash::Photo"
+ *         }
+ *       }
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class BatchIsAuthorizedWithTokenCommand extends BatchIsAuthorizedWithTokenCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -232,6 +232,35 @@ declare const CreateIdentitySourceCommand_base: {
  * <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": [
+ *         "a1b2c3d4e5f6g7h8i9j0kalbmc"
+ *       ],
+ *       "userPoolArn": "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"
+ *     }
+ *   },
+ *   "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a",
+ *   "principalEntityType": "User"
+ * };
+ * const command = new CreateIdentitySourceCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "createdDate": "2024-08-12T18:20:50.99Z",
+ *   "identitySourceId": "ISEXAMPLEabcdefg111111",
+ *   "lastUpdatedDate": "2024-08-12T18:20:50.99Z",
+ *   "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a"
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class CreateIdentitySourceCommand extends CreateIdentitySourceCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -221,6 +221,114 @@ declare const CreatePolicyCommand_base: {
  * <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
  *
  * @public
+ * @example To create a static policy
+ * ```javascript
+ * // 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.
+ * const input = {
+ *   "clientToken": "a1b2c3d4-e5f6-a1b2-c3d4-TOKEN1111111",
+ *   "definition": {
+ *     "static": {
+ *       "description": "Grant members of janeFriends UserGroup access to the vacationFolder Album",
+ *       "statement": "permit( principal in UserGroup::\"janeFriends\", action, resource in Album::\"vacationFolder\" );"
+ *     }
+ *   },
+ *   "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a"
+ * };
+ * const command = new CreatePolicyCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "createdDate": "2024-08-12T18:20:50.99Z",
+ *   "lastUpdatedDate": "2024-08-12T18:20:50.99Z",
+ *   "policyId": "9wYxMpljbbZQb5fcZHyJhY",
+ *   "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a",
+ *   "policyType": "STATIC",
+ *   "principal": {
+ *     "entityId": "janeFriends",
+ *     "entityType": "UserGroup"
+ *   },
+ *   "resource": {
+ *     "entityId": "vacationFolder",
+ *     "entityType": "Album"
+ *   }
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
+ * @example To create a static policy
+ * ```javascript
+ * // 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.
+ * const input = {
+ *   "clientToken": "a1b2c3d4-e5f6-a1b2-c3d4-TOKEN1111111",
+ *   "definition": {
+ *     "static": {
+ *       "description": "Grant members of janeFriends UserGroup access to the vacationFolder Album",
+ *       "statement": "permit( principal in UserGroup::\"janeFriends\", action, resource in Album::\"vacationFolder\" );"
+ *     }
+ *   },
+ *   "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a"
+ * };
+ * const command = new CreatePolicyCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "createdDate": "2024-08-12T18:20:50.99Z",
+ *   "lastUpdatedDate": "2024-08-12T18:20:50.99Z",
+ *   "policyId": "9wYxMpljbbZQb5fcZHyJhY",
+ *   "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a",
+ *   "policyType": "STATIC",
+ *   "principal": {
+ *     "entityId": "janeFriends",
+ *     "entityType": "UserGroup"
+ *   },
+ *   "resource": {
+ *     "entityId": "vacationFolder",
+ *     "entityType": "Album"
+ *   }
+ * }
+ * *\/
+ * // example id: example-2
+ * ```
+ *
+ * @example To create a template-linked policy
+ * ```javascript
+ * // 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.
+ * const input = {
+ *   "clientToken": "a1b2c3d4-e5f6-a1b2-c3d4-TOKEN1111111",
+ *   "definition": {
+ *     "templateLinked": {
+ *       "policyTemplateId": "PTEXAMPLEabcdefg111111",
+ *       "principal": {
+ *         "entityId": "alice",
+ *         "entityType": "User"
+ *       }
+ *     }
+ *   },
+ *   "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a"
+ * };
+ * const command = new CreatePolicyCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "createdDate": "2024-08-12T18:20:50.99Z",
+ *   "lastUpdatedDate": "2024-08-12T18:20:50.99Z",
+ *   "policyId": "Et9KxMplyaDdyurDw8TeFa",
+ *   "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a",
+ *   "policyType": "TEMPLATE_LINKED",
+ *   "principal": {
+ *     "entityId": "alice",
+ *     "entityType": "User"
+ *   },
+ *   "resource": {
+ *     "entityId": "VacationPhoto94.jpg",
+ *     "entityType": "Photo"
+ *   }
+ * }
+ * *\/
+ * // example id: example-3
+ * ```
+ *
  */
 export declare class CreatePolicyCommand extends CreatePolicyCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -172,6 +172,28 @@ declare const CreatePolicyStoreCommand_base: {
  * <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
  *
  * @public
+ * @example To create policy store
+ * ```javascript
+ * // The following example creates a new policy store with strict validation turned on.
+ * const input = {
+ *   "clientToken": "a1b2c3d4-e5f6-a1b2-c3d4-TOKEN1111111",
+ *   "validationSettings": {
+ *     "mode": "STRICT"
+ *   }
+ * };
+ * const command = new CreatePolicyStoreCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "arn": "arn:aws:verifiedpermissions::123456789012:policy-store/C7v5xMplfFH3i3e4Jrzb1a",
+ *   "createdDate": "2024-08-12T18:20:50.99Z",
+ *   "lastUpdatedDate": "2024-08-12T18:20:50.99Z",
+ *   "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a"
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class CreatePolicyStoreCommand extends CreatePolicyStoreCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -176,6 +176,28 @@ declare const CreatePolicyTemplateCommand_base: {
  * <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
  *
  * @public
+ * @example To create a policy template
+ * ```javascript
+ * // The following example creates a policy template that has a placeholder for the principal.
+ * const input = {
+ *   "clientToken": "a1b2c3d4-e5f6-a1b2-c3d4-TOKEN1111111",
+ *   "description": "Template for research dept",
+ *   "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a",
+ *   "statement": "\"AccessVacation\"\npermit(\n    principal in ?principal,\n    action == Action::\"view\",\n    resource == Photo::\"VacationPhoto94.jpg\"\n)\nwhen {\n    principal has department && principal.department == \"research\"\n};"
+ * };
+ * const command = new CreatePolicyTemplateCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "createdDate": "2024-08-12T18:20:50.99Z",
+ *   "lastUpdatedDate": "2024-08-12T18:20:50.99Z",
+ *   "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a",
+ *   "policyTemplateId": "PTEXAMPLEabcdefg111111"
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class CreatePolicyTemplateCommand extends CreatePolicyTemplateCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -157,6 +157,18 @@ declare const DeleteIdentitySourceCommand_base: {
  * <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
  *
  * @public
+ * @example To delete an identity source
+ * ```javascript
+ * // The following example request deletes the specified identity source.
+ * const input = {
+ *   "identitySourceId": "ISEXAMPLEabcdefg111111",
+ *   "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a"
+ * };
+ * const command = new DeleteIdentitySourceCommand(input);
+ * await client.send(command);
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class DeleteIdentitySourceCommand extends DeleteIdentitySourceCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -156,6 +156,18 @@ declare const DeletePolicyCommand_base: {
  * <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
  *
  * @public
+ * @example To delete a policy
+ * ```javascript
+ * // The following example deletes the specified policy from its policy store.
+ * const input = {
+ *   "policyId": "9wYxMpljbbZQb5fcZHyJhY",
+ *   "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a"
+ * };
+ * const command = new DeletePolicyCommand(input);
+ * await client.send(command);
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class DeletePolicyCommand extends DeletePolicyCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -148,6 +148,17 @@ declare const DeletePolicyStoreCommand_base: {
  * <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
  *
  * @public
+ * @example To delete a policy store
+ * ```javascript
+ * // The following example deletes the specified policy store.
+ * const input = {
+ *   "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a"
+ * };
+ * const command = new DeletePolicyStoreCommand(input);
+ * await client.send(command);
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class DeletePolicyStoreCommand extends DeletePolicyStoreCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -159,6 +159,18 @@ declare const DeletePolicyTemplateCommand_base: {
  * <p>Base exception class for all service exceptions from VerifiedPermissions service.</p>
  *
  * @public
+ * @example To delete a policy template
+ * ```javascript
+ * // 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.
+ * const input = {
+ *   "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a",
+ *   "policyTemplateId": "PTEXAMPLEabcdefg111111"
+ * };
+ * const command = new DeletePolicyTemplateCommand(input);
+ * await client.send(command);
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class DeletePolicyTemplateCommand extends DeletePolicyTemplateCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -196,6 +196,35 @@ declare const GetIdentitySourceCommand_base: {
  * <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"
+ * };
+ * const command = new GetIdentitySourceCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "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"
+ *   },
+ *   "identitySourceId": "ISEXAMPLEabcdefg111111",
+ *   "lastUpdatedDate": "2024-08-12T18:20:50.99Z",
+ *   "policyStoreId": "C7v5xMplfFH3i3e4Jrzb1a",
+ *   "principalEntityType": "AWS::Cognito"
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class GetIdentitySourceCommand extends GetIdentitySourceCommand_base {
     /** @internal type navigation helper, not in runtime. */