@aws-sdk/client-verifiedpermissions 3.352.0

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

@@ -0,0 +1,184 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { CreatePolicyTemplateInput, CreatePolicyTemplateOutput } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, VerifiedPermissionsClientResolvedConfig } from "../VerifiedPermissionsClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link CreatePolicyTemplateCommand}.
+ */
+export interface CreatePolicyTemplateCommandInput extends CreatePolicyTemplateInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link CreatePolicyTemplateCommand}.
+ */
+export interface CreatePolicyTemplateCommandOutput extends CreatePolicyTemplateOutput, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Creates a policy template. A template can use placeholders for the principal and resource. A
+ *             template must be instantiated into a policy by associating it with specific principals
+ *             and resources to use for the placeholders. That instantiated policy can then be
+ *             considered in authorization decisions. The instantiated policy works identically to any
+ *             other policy, except that it is dynamically linked to the template. If the template
+ *             changes, then any policies that are linked to that template are immediately updated as
+ *             well.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { VerifiedPermissionsClient, CreatePolicyTemplateCommand } from "@aws-sdk/client-verifiedpermissions"; // ES Modules import
+ * // const { VerifiedPermissionsClient, CreatePolicyTemplateCommand } = require("@aws-sdk/client-verifiedpermissions"); // CommonJS import
+ * const client = new VerifiedPermissionsClient(config);
+ * const input = { // CreatePolicyTemplateInput
+ *   clientToken: "STRING_VALUE",
+ *   policyStoreId: "STRING_VALUE", // required
+ *   description: "STRING_VALUE",
+ *   statement: "STRING_VALUE", // required
+ * };
+ * const command = new CreatePolicyTemplateCommand(input);
+ * const response = await client.send(command);
+ * // { // CreatePolicyTemplateOutput
+ * //   policyStoreId: "STRING_VALUE", // required
+ * //   policyTemplateId: "STRING_VALUE", // required
+ * //   createdDate: new Date("TIMESTAMP"), // required
+ * //   lastUpdatedDate: new Date("TIMESTAMP"), // required
+ * // };
+ *
+ * ```
+ *
+ * @param CreatePolicyTemplateCommandInput - {@link CreatePolicyTemplateCommandInput}
+ * @returns {@link CreatePolicyTemplateCommandOutput}
+ * @see {@link CreatePolicyTemplateCommandInput} for command's `input` shape.
+ * @see {@link CreatePolicyTemplateCommandOutput} for command's `response` shape.
+ * @see {@link VerifiedPermissionsClientResolvedConfig | config} for VerifiedPermissionsClient's `config` shape.
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The request failed because it references a resource that doesn't exist.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>The request failed because it would cause a service quota to be exceeded.</p>
+ *
+ * @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="docs.cedarpolicy.comsyntax-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="docs.cedarpolicy.comsyntax-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>
+ *
+ */
+export declare class CreatePolicyTemplateCommand extends $Command<CreatePolicyTemplateCommandInput, CreatePolicyTemplateCommandOutput, VerifiedPermissionsClientResolvedConfig> {
+    readonly input: CreatePolicyTemplateCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: CreatePolicyTemplateCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: VerifiedPermissionsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreatePolicyTemplateCommandInput, CreatePolicyTemplateCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,175 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { DeleteIdentitySourceInput, DeleteIdentitySourceOutput } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, VerifiedPermissionsClientResolvedConfig } from "../VerifiedPermissionsClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link DeleteIdentitySourceCommand}.
+ */
+export interface DeleteIdentitySourceCommandInput extends DeleteIdentitySourceInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link DeleteIdentitySourceCommand}.
+ */
+export interface DeleteIdentitySourceCommandOutput extends DeleteIdentitySourceOutput, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Deletes an identity source that references an identity provider (IdP) such as Amazon Cognito. After
+ *             you delete the identity source, you can no longer use tokens for identities from that identity source to
+ *             represent principals in authorization queries made using <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html">IsAuthorizedWithToken</a>.
+ *             operations.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { VerifiedPermissionsClient, DeleteIdentitySourceCommand } from "@aws-sdk/client-verifiedpermissions"; // ES Modules import
+ * // const { VerifiedPermissionsClient, DeleteIdentitySourceCommand } = require("@aws-sdk/client-verifiedpermissions"); // CommonJS import
+ * const client = new VerifiedPermissionsClient(config);
+ * const input = { // DeleteIdentitySourceInput
+ *   policyStoreId: "STRING_VALUE", // required
+ *   identitySourceId: "STRING_VALUE", // required
+ * };
+ * const command = new DeleteIdentitySourceCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param DeleteIdentitySourceCommandInput - {@link DeleteIdentitySourceCommandInput}
+ * @returns {@link DeleteIdentitySourceCommandOutput}
+ * @see {@link DeleteIdentitySourceCommandInput} for command's `input` shape.
+ * @see {@link DeleteIdentitySourceCommandOutput} for command's `response` shape.
+ * @see {@link VerifiedPermissionsClientResolvedConfig | config} for VerifiedPermissionsClient's `config` shape.
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>The request failed because another request to modify a resource occurred at the
+ *             same.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The request failed because it references a resource that doesn't exist.</p>
+ *
+ * @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="docs.cedarpolicy.comsyntax-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="docs.cedarpolicy.comsyntax-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>
+ *
+ */
+export declare class DeleteIdentitySourceCommand extends $Command<DeleteIdentitySourceCommandInput, DeleteIdentitySourceCommandOutput, VerifiedPermissionsClientResolvedConfig> {
+    readonly input: DeleteIdentitySourceCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: DeleteIdentitySourceCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: VerifiedPermissionsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteIdentitySourceCommandInput, DeleteIdentitySourceCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,174 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { DeletePolicyInput, DeletePolicyOutput } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, VerifiedPermissionsClientResolvedConfig } from "../VerifiedPermissionsClient";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link DeletePolicyCommand}.
+ */
+export interface DeletePolicyCommandInput extends DeletePolicyInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link DeletePolicyCommand}.
+ */
+export interface DeletePolicyCommandOutput extends DeletePolicyOutput, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Deletes the specified policy from the policy store.</p>
+ *          <p>This operation is idempotent; if you specify a policy that doesn't
+ *         exist, the request response returns a successful <code>HTTP 200</code> status code.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { VerifiedPermissionsClient, DeletePolicyCommand } from "@aws-sdk/client-verifiedpermissions"; // ES Modules import
+ * // const { VerifiedPermissionsClient, DeletePolicyCommand } = require("@aws-sdk/client-verifiedpermissions"); // CommonJS import
+ * const client = new VerifiedPermissionsClient(config);
+ * const input = { // DeletePolicyInput
+ *   policyStoreId: "STRING_VALUE", // required
+ *   policyId: "STRING_VALUE", // required
+ * };
+ * const command = new DeletePolicyCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param DeletePolicyCommandInput - {@link DeletePolicyCommandInput}
+ * @returns {@link DeletePolicyCommandOutput}
+ * @see {@link DeletePolicyCommandInput} for command's `input` shape.
+ * @see {@link DeletePolicyCommandOutput} for command's `response` shape.
+ * @see {@link VerifiedPermissionsClientResolvedConfig | config} for VerifiedPermissionsClient's `config` shape.
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>The request failed because another request to modify a resource occurred at the
+ *             same.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The request failed because it references a resource that doesn't exist.</p>
+ *
+ * @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="docs.cedarpolicy.comsyntax-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="docs.cedarpolicy.comsyntax-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>
+ *
+ */
+export declare class DeletePolicyCommand extends $Command<DeletePolicyCommandInput, DeletePolicyCommandOutput, VerifiedPermissionsClientResolvedConfig> {
+    readonly input: DeletePolicyCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: DeletePolicyCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: VerifiedPermissionsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeletePolicyCommandInput, DeletePolicyCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}