@aws-sdk/client-verifiedpermissions 3.799.0 → 3.801.0

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

@@ -27,13 +27,7 @@ declare const UpdatePolicyStoreCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Modifies the validation setting for a policy store.</p>
- *          <note>
- *             <p>Verified Permissions is <i>
- *                   <a href="https://wikipedia.org/wiki/Eventual_consistency">eventually consistent</a>
- *                </i>. It can take a few seconds for a new or changed element to propagate through
- *     the service and be visible in the results of other Verified Permissions operations.</p>
- *          </note>
+ * <p>Modifies the validation setting for a policy store.</p> <note> <p>Verified Permissions is <i> <a href="https://wikipedia.org/wiki/Eventual_consistency">eventually consistent</a> </i>. It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.</p> </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -66,8 +60,7 @@ declare const UpdatePolicyStoreCommand_base: {
  * @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>
+ *  <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>
@@ -82,88 +75,7 @@ declare const UpdatePolicyStoreCommand_base: {
  *  <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>
+ *  <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>

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

@@ -27,19 +27,7 @@ declare const UpdatePolicyTemplateCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Updates the specified policy template. You can update only the description and the some elements
- *             of the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicyTemplate.html#amazonverifiedpermissions-UpdatePolicyTemplate-request-policyBody">policyBody</a>. </p>
- *          <important>
- *             <p>Changes you make to the policy template content are immediately (within the constraints of
- *                 eventual consistency) reflected in authorization decisions that involve all template-linked policies
- *                 instantiated from this template.</p>
- *          </important>
- *          <note>
- *             <p>Verified Permissions is <i>
- *                   <a href="https://wikipedia.org/wiki/Eventual_consistency">eventually consistent</a>
- *                </i>. It can take a few seconds for a new or changed element to propagate through
- *     the service and be visible in the results of other Verified Permissions operations.</p>
- *          </note>
+ * <p>Updates the specified policy template. You can update only the description and the some elements of the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicyTemplate.html#amazonverifiedpermissions-UpdatePolicyTemplate-request-policyBody">policyBody</a>. </p> <important> <p>Changes you make to the policy template content are immediately (within the constraints of eventual consistency) reflected in authorization decisions that involve all template-linked policies instantiated from this template.</p> </important> <note> <p>Verified Permissions is <i> <a href="https://wikipedia.org/wiki/Eventual_consistency">eventually consistent</a> </i>. It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.</p> </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -70,8 +58,7 @@ declare const UpdatePolicyTemplateCommand_base: {
  * @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>
+ *  <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>
@@ -86,88 +73,7 @@ declare const UpdatePolicyTemplateCommand_base: {
  *  <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>
+ *  <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>

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

@@ -20,7 +20,10 @@ export * from "./ListIdentitySourcesCommand";
 export * from "./ListPoliciesCommand";
 export * from "./ListPolicyStoresCommand";
 export * from "./ListPolicyTemplatesCommand";
+export * from "./ListTagsForResourceCommand";
 export * from "./PutSchemaCommand";
+export * from "./TagResourceCommand";
+export * from "./UntagResourceCommand";
 export * from "./UpdateIdentitySourceCommand";
 export * from "./UpdatePolicyCommand";
 export * from "./UpdatePolicyStoreCommand";

package/dist-types/index.d.ts

@@ -1,69 +1,5 @@
 /**
- * <p>Amazon Verified Permissions is a permissions management service from Amazon Web Services. You can use Verified Permissions to manage
- *             permissions for your application, and authorize user access based on those permissions.
- *             Using Verified Permissions, application developers can grant access based on information about the
- *             users, resources, and requested actions. You can also evaluate additional information
- *             like group membership, attributes of the resources, and session context, such as time of
- *             request and IP addresses. Verified Permissions manages these permissions by letting you create and
- *             store authorization policies for your applications, such as consumer-facing web sites
- *             and enterprise business systems.</p>
- *          <p>Verified Permissions uses Cedar as the policy language to express your permission requirements.
- *             Cedar supports both role-based access control (RBAC) and attribute-based access
- *             control (ABAC) authorization models.</p>
- *          <p>For more information about configuring, administering, and using Amazon Verified Permissions in your
- *             applications, see the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/userguide/">Amazon Verified Permissions User Guide</a>.</p>
- *          <p>For more information about the Cedar policy language, see the <a href="https://docs.cedarpolicy.com/">Cedar Policy Language Guide</a>.</p>
- *          <important>
- *             <p>When you write Cedar policies that reference principals, resources and actions,
- *                 you can define the unique identifiers used for each of those elements. We strongly
- *                 recommend that you follow these best practices:</p>
- *             <ul>
- *                <li>
- *                   <p>
- *                      <b>Use values like universally unique identifiers
- *                             (UUIDs) for all principal and resource identifiers.</b>
- *                   </p>
- *                   <p>For example, if user <code>jane</code> leaves the company, and you later
- *                         let someone else use the name <code>jane</code>, then that new user
- *                         automatically gets access to everything granted by policies that still
- *                         reference <code>User::"jane"</code>. Cedar can’t distinguish between the
- *                         new user and the old. This applies to both principal and resource
- *                         identifiers. Always use identifiers that are guaranteed unique and never
- *                         reused to ensure that you don’t unintentionally grant access because of the
- *                         presence of an old identifier in a policy.</p>
- *                   <p>Where you use a UUID for an entity, we recommend that you follow it with
- *                         the // comment specifier and the ‘friendly’ name of your entity. This helps
- *                         to make your policies easier to understand. For example: principal ==
- *                         User::"a1b2c3d4-e5f6-a1b2-c3d4-EXAMPLE11111", // alice</p>
- *                </li>
- *                <li>
- *                   <p>
- *                      <b>Do not include personally identifying, confidential,
- *                             or sensitive information as part of the unique identifier for your
- *                             principals or resources.</b> These identifiers are included in
- *                         log entries shared in CloudTrail trails.</p>
- *                </li>
- *             </ul>
- *          </important>
- *          <p>Several operations return structures that appear similar, but have different purposes.
- *             As new functionality is added to the product, the structure used in a parameter of one
- *             operation might need to change in a way that wouldn't make sense for the same parameter
- *             in a different operation. To help you understand the purpose of each, the following
- *             naming convention is used for the structures:</p>
- *          <ul>
- *             <li>
- *                <p>Parameter type structures that end in <code>Detail</code> are used in
- *                         <code>Get</code> operations.</p>
- *             </li>
- *             <li>
- *                <p>Parameter type structures that end in <code>Item</code> are used in
- *                         <code>List</code> operations.</p>
- *             </li>
- *             <li>
- *                <p>Parameter type structures that use neither suffix are used in the mutating
- *                     (create and update) operations.</p>
- *             </li>
- *          </ul>
+ * <p>Amazon Verified Permissions is a permissions management service from Amazon Web Services. You can use Verified Permissions to manage permissions for your application, and authorize user access based on those permissions. Using Verified Permissions, application developers can grant access based on information about the users, resources, and requested actions. You can also evaluate additional information like group membership, attributes of the resources, and session context, such as time of request and IP addresses. Verified Permissions manages these permissions by letting you create and store authorization policies for your applications, such as consumer-facing web sites and enterprise business systems.</p> <p>Verified Permissions uses Cedar as the policy language to express your permission requirements. Cedar supports both role-based access control (RBAC) and attribute-based access control (ABAC) authorization models.</p> <p>For more information about configuring, administering, and using Amazon Verified Permissions in your applications, see the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/userguide/">Amazon Verified Permissions User Guide</a>.</p> <p>For more information about the Cedar policy language, see the <a href="https://docs.cedarpolicy.com/">Cedar Policy Language Guide</a>.</p> <important> <p>When you write Cedar policies that reference principals, resources and actions, you can define the unique identifiers used for each of those elements. We strongly recommend that you follow these best practices:</p> <ul> <li> <p> <b>Use values like universally unique identifiers (UUIDs) for all principal and resource identifiers.</b> </p> <p>For example, if user <code>jane</code> leaves the company, and you later let someone else use the name <code>jane</code>, then that new user automatically gets access to everything granted by policies that still reference <code>User::"jane"</code>. Cedar can’t distinguish between the new user and the old. This applies to both principal and resource identifiers. Always use identifiers that are guaranteed unique and never reused to ensure that you don’t unintentionally grant access because of the presence of an old identifier in a policy.</p> <p>Where you use a UUID for an entity, we recommend that you follow it with the // comment specifier and the ‘friendly’ name of your entity. This helps to make your policies easier to understand. For example: principal == User::"a1b2c3d4-e5f6-a1b2-c3d4-EXAMPLE11111", // alice</p> </li> <li> <p> <b>Do not include personally identifying, confidential, or sensitive information as part of the unique identifier for your principals or resources.</b> These identifiers are included in log entries shared in CloudTrail trails.</p> </li> </ul> </important> <p>Several operations return structures that appear similar, but have different purposes. As new functionality is added to the product, the structure used in a parameter of one operation might need to change in a way that wouldn't make sense for the same parameter in a different operation. To help you understand the purpose of each, the following naming convention is used for the structures:</p> <ul> <li> <p>Parameter type structures that end in <code>Detail</code> are used in <code>Get</code> operations.</p> </li> <li> <p>Parameter type structures that end in <code>Item</code> are used in <code>List</code> operations.</p> </li> <li> <p>Parameter type structures that use neither suffix are used in the mutating (create and update) operations.</p> </li> </ul>
  *
  * @packageDocumentation
  */