-
Notifications
You must be signed in to change notification settings - Fork 593
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(client-verifiedpermissions): Adding BatchGetPolicy API which sup…
…ports the retrieval of multiple policies across multiple policy stores within a single request.
- Loading branch information
awstools
committed
Nov 6, 2024
1 parent
73be619
commit 6860b35
Showing
12 changed files
with
1,205 additions
and
223 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
302 changes: 302 additions & 0 deletions
302
clients/client-verifiedpermissions/src/commands/BatchGetPolicyCommand.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,302 @@ | ||
| // smithy-typescript generated code | ||
| import { getEndpointPlugin } from "@smithy/middleware-endpoint"; | ||
| import { getSerdePlugin } from "@smithy/middleware-serde"; | ||
| import { Command as $Command } from "@smithy/smithy-client"; | ||
| import { MetadataBearer as __MetadataBearer } from "@smithy/types"; | ||
|
|
||
| import { commonParams } from "../endpoint/EndpointParameters"; | ||
| import { BatchGetPolicyInput, BatchGetPolicyOutput, BatchGetPolicyOutputFilterSensitiveLog } from "../models/models_0"; | ||
| import { de_BatchGetPolicyCommand, se_BatchGetPolicyCommand } from "../protocols/Aws_json1_0"; | ||
| import { | ||
| ServiceInputTypes, | ||
| ServiceOutputTypes, | ||
| VerifiedPermissionsClientResolvedConfig, | ||
| } from "../VerifiedPermissionsClient"; | ||
|
|
||
| /** | ||
| * @public | ||
| */ | ||
| export type { __MetadataBearer }; | ||
| export { $Command }; | ||
| /** | ||
| * @public | ||
| * | ||
| * The input for {@link BatchGetPolicyCommand}. | ||
| */ | ||
| export interface BatchGetPolicyCommandInput extends BatchGetPolicyInput {} | ||
| /** | ||
| * @public | ||
| * | ||
| * The output of {@link BatchGetPolicyCommand}. | ||
| */ | ||
| export interface BatchGetPolicyCommandOutput extends BatchGetPolicyOutput, __MetadataBearer {} | ||
|
|
||
| /** | ||
| * <p>Retrieves information about a group (batch) of policies.</p> | ||
| * <note> | ||
| * <p>The <code>BatchGetPolicy</code> operation doesn't have its own IAM | ||
| * permission. To authorize this operation for Amazon Web Services principals, include the permission | ||
| * <code>verifiedpermissions:GetPolicy</code> in their IAM policies.</p> | ||
| * </note> | ||
| * @example | ||
| * Use a bare-bones client and the command you need to make an API call. | ||
| * ```javascript | ||
| * import { VerifiedPermissionsClient, BatchGetPolicyCommand } from "@aws-sdk/client-verifiedpermissions"; // ES Modules import | ||
| * // const { VerifiedPermissionsClient, BatchGetPolicyCommand } = require("@aws-sdk/client-verifiedpermissions"); // CommonJS import | ||
| * const client = new VerifiedPermissionsClient(config); | ||
| * const input = { // BatchGetPolicyInput | ||
| * requests: [ // BatchGetPolicyInputList // required | ||
| * { // BatchGetPolicyInputItem | ||
| * policyStoreId: "STRING_VALUE", // required | ||
| * policyId: "STRING_VALUE", // required | ||
| * }, | ||
| * ], | ||
| * }; | ||
| * const command = new BatchGetPolicyCommand(input); | ||
| * const response = await client.send(command); | ||
| * // { // BatchGetPolicyOutput | ||
| * // results: [ // BatchGetPolicyOutputList // required | ||
| * // { // BatchGetPolicyOutputItem | ||
| * // policyStoreId: "STRING_VALUE", // required | ||
| * // policyId: "STRING_VALUE", // required | ||
| * // policyType: "STATIC" || "TEMPLATE_LINKED", // required | ||
| * // definition: { // PolicyDefinitionDetail Union: only one key present | ||
| * // static: { // StaticPolicyDefinitionDetail | ||
| * // description: "STRING_VALUE", | ||
| * // statement: "STRING_VALUE", // required | ||
| * // }, | ||
| * // templateLinked: { // TemplateLinkedPolicyDefinitionDetail | ||
| * // policyTemplateId: "STRING_VALUE", // required | ||
| * // principal: { // EntityIdentifier | ||
| * // entityType: "STRING_VALUE", // required | ||
| * // entityId: "STRING_VALUE", // required | ||
| * // }, | ||
| * // resource: { | ||
| * // entityType: "STRING_VALUE", // required | ||
| * // entityId: "STRING_VALUE", // required | ||
| * // }, | ||
| * // }, | ||
| * // }, | ||
| * // createdDate: new Date("TIMESTAMP"), // required | ||
| * // lastUpdatedDate: new Date("TIMESTAMP"), // required | ||
| * // }, | ||
| * // ], | ||
| * // errors: [ // BatchGetPolicyErrorList // required | ||
| * // { // BatchGetPolicyErrorItem | ||
| * // code: "POLICY_STORE_NOT_FOUND" || "POLICY_NOT_FOUND", // required | ||
| * // policyStoreId: "STRING_VALUE", // required | ||
| * // policyId: "STRING_VALUE", // required | ||
| * // message: "STRING_VALUE", // required | ||
| * // }, | ||
| * // ], | ||
| * // }; | ||
| * | ||
| * ``` | ||
| * | ||
| * @param BatchGetPolicyCommandInput - {@link BatchGetPolicyCommandInput} | ||
| * @returns {@link BatchGetPolicyCommandOutput} | ||
| * @see {@link BatchGetPolicyCommandInput} for command's `input` shape. | ||
| * @see {@link BatchGetPolicyCommandOutput} for command's `response` shape. | ||
| * @see {@link VerifiedPermissionsClientResolvedConfig | config} for VerifiedPermissionsClient's `config` shape. | ||
| * | ||
| * @throws {@link AccessDeniedException} (client fault) | ||
| * <p>You don't have sufficient access to perform this action.</p> | ||
| * | ||
| * @throws {@link InternalServerException} (server fault) | ||
| * <p>The request failed because of an internal error. Try your request again later</p> | ||
| * | ||
| * @throws {@link ThrottlingException} (client fault) | ||
| * <p>The request failed because it exceeded a throttling quota.</p> | ||
| * | ||
| * @throws {@link ValidationException} (client fault) | ||
| * <p>The request failed because one or more input parameters don't satisfy their constraint | ||
| * requirements. The output is provided as a list of fields and a reason for each field that | ||
| * isn't valid.</p> | ||
| * <p>The possible reasons include the following:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p> | ||
| * <b>UnrecognizedEntityType</b> | ||
| * </p> | ||
| * <p>The policy includes an entity type that isn't found in the schema.</p> | ||
| * </li> | ||
| * <li> | ||
| * <p> | ||
| * <b>UnrecognizedActionId</b> | ||
| * </p> | ||
| * <p>The policy includes an action id that isn't found in the schema.</p> | ||
| * </li> | ||
| * <li> | ||
| * <p> | ||
| * <b>InvalidActionApplication</b> | ||
| * </p> | ||
| * <p>The policy includes an action that, according to the schema, doesn't support | ||
| * the specified principal and resource.</p> | ||
| * </li> | ||
| * <li> | ||
| * <p> | ||
| * <b>UnexpectedType</b> | ||
| * </p> | ||
| * <p>The policy included an operand that isn't a valid type for the specified | ||
| * operation.</p> | ||
| * </li> | ||
| * <li> | ||
| * <p> | ||
| * <b>IncompatibleTypes</b> | ||
| * </p> | ||
| * <p>The types of elements included in a <code>set</code>, or the types of | ||
| * expressions used in an <code>if...then...else</code> clause aren't compatible in | ||
| * this context.</p> | ||
| * </li> | ||
| * <li> | ||
| * <p> | ||
| * <b>MissingAttribute</b> | ||
| * </p> | ||
| * <p>The policy attempts to access a record or entity attribute that isn't | ||
| * specified in the schema. Test for the existence of the attribute first before | ||
| * attempting to access its value. For more information, see the <a href="https://docs.cedarpolicy.com/policies/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in the | ||
| * <i>Cedar Policy Language Guide</i>.</p> | ||
| * </li> | ||
| * <li> | ||
| * <p> | ||
| * <b>UnsafeOptionalAttributeAccess</b> | ||
| * </p> | ||
| * <p>The policy attempts to access a record or entity attribute that is optional | ||
| * and isn't guaranteed to be present. Test for the existence of the attribute | ||
| * first before attempting to access its value. For more information, see the | ||
| * <a href="https://docs.cedarpolicy.com/policies/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in the | ||
| * <i>Cedar Policy Language Guide</i>.</p> | ||
| * </li> | ||
| * <li> | ||
| * <p> | ||
| * <b>ImpossiblePolicy</b> | ||
| * </p> | ||
| * <p>Cedar has determined that a policy condition always evaluates to false. If | ||
| * the policy is always false, it can never apply to any query, and so it can never | ||
| * affect an authorization decision.</p> | ||
| * </li> | ||
| * <li> | ||
| * <p> | ||
| * <b>WrongNumberArguments</b> | ||
| * </p> | ||
| * <p>The policy references an extension type with the wrong number of | ||
| * arguments.</p> | ||
| * </li> | ||
| * <li> | ||
| * <p> | ||
| * <b>FunctionArgumentValidationError</b> | ||
| * </p> | ||
| * <p>Cedar couldn't parse the argument passed to an extension type. For example, | ||
| * a string that is to be parsed as an IPv4 address can contain only digits and the | ||
| * period character.</p> | ||
| * </li> | ||
| * </ul> | ||
| * | ||
| * @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": [ | ||
| * { | ||
| * "policyId": "PWv5M6d5HePx3gVVLKY1nK", | ||
| * "policyStoreId": "ERZeDpRc34dkYZeb6FZRVC" | ||
| * }, | ||
| * { | ||
| * "policyId": "LzFn6KgLWvv4Mbegus35jn", | ||
| * "policyStoreId": "ERZeDpRc34dkYZeb6FZRVC" | ||
| * }, | ||
| * { | ||
| * "policyId": "77gLjer8H5o3mvrnMGrSL5", | ||
| * "policyStoreId": "ERZeDpRc34dkYZeb6FZRVC" | ||
| * } | ||
| * ] | ||
| * }; | ||
| * const command = new BatchGetPolicyCommand(input); | ||
| * const response = await client.send(command); | ||
| * /* response == | ||
| * { | ||
| * "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 };" | ||
| * } | ||
| * }, | ||
| * "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);" | ||
| * } | ||
| * }, | ||
| * "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);" | ||
| * } | ||
| * }, | ||
| * "lastUpdatedDate": "2024-10-18T18:57:48.005343Z", | ||
| * "policyId": "77gLjer8H5o3mvrnMGrSL5", | ||
| * "policyStoreId": "ERZeDpRc34dkYZeb6FZRVC", | ||
| * "policyType": "STATIC" | ||
| * } | ||
| * ] | ||
| * } | ||
| * *\/ | ||
| * // example id: example-1 | ||
| * ``` | ||
| * | ||
| */ | ||
| export class BatchGetPolicyCommand extends $Command | ||
| .classBuilder< | ||
| BatchGetPolicyCommandInput, | ||
| BatchGetPolicyCommandOutput, | ||
| VerifiedPermissionsClientResolvedConfig, | ||
| ServiceInputTypes, | ||
| ServiceOutputTypes | ||
| >() | ||
| .ep(commonParams) | ||
| .m(function (this: any, Command: any, cs: any, config: VerifiedPermissionsClientResolvedConfig, o: any) { | ||
| return [ | ||
| getSerdePlugin(config, this.serialize, this.deserialize), | ||
| getEndpointPlugin(config, Command.getEndpointParameterInstructions()), | ||
| ]; | ||
| }) | ||
| .s("VerifiedPermissions", "BatchGetPolicy", {}) | ||
| .n("VerifiedPermissionsClient", "BatchGetPolicyCommand") | ||
| .f(void 0, BatchGetPolicyOutputFilterSensitiveLog) | ||
| .ser(se_BatchGetPolicyCommand) | ||
| .de(de_BatchGetPolicyCommand) | ||
| .build() { | ||
| /** @internal type navigation helper, not in runtime. */ | ||
| protected declare static __types: { | ||
| api: { | ||
| input: BatchGetPolicyInput; | ||
| output: BatchGetPolicyOutput; | ||
| }; | ||
| sdk: { | ||
| input: BatchGetPolicyCommandInput; | ||
| output: BatchGetPolicyCommandOutput; | ||
| }; | ||
| }; | ||
| } |
Oops, something went wrong.