feat(client-verifiedpermissions): Improving Amazon Verified Permissio…

…ns Create experience
aws · Oct 19, 2023 · c86d343 · c86d343
1 parent de46ff2
commit c86d343
Show file tree

Hide file tree

Showing 28 changed files with 164 additions and 127 deletions.
diff --git a/clients/client-verifiedpermissions/src/commands/CreateIdentitySourceCommand.ts b/clients/client-verifiedpermissions/src/commands/CreateIdentitySourceCommand.ts
@@ -113,6 +113,10 @@ export interface CreateIdentitySourceCommandOutput extends CreateIdentitySourceO
  * @see {@link CreateIdentitySourceCommandOutput} 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>
  *
@@ -174,7 +178,7 @@ export interface CreateIdentitySourceCommandOutput extends CreateIdentitySourceO
  *                </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/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in the
+ *                     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>
@@ -184,7 +188,7 @@ export interface CreateIdentitySourceCommandOutput extends CreateIdentitySourceO
  *                <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/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in 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>

diff --git a/clients/client-verifiedpermissions/src/commands/CreatePolicyCommand.ts b/clients/client-verifiedpermissions/src/commands/CreatePolicyCommand.ts
@@ -126,6 +126,10 @@ export interface CreatePolicyCommandOutput extends CreatePolicyOutput, __Metadat
  * @see {@link CreatePolicyCommandOutput} 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>
  *
@@ -187,7 +191,7 @@ export interface CreatePolicyCommandOutput extends CreatePolicyOutput, __Metadat
  *                </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/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in the
+ *                     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>
@@ -197,7 +201,7 @@ export interface CreatePolicyCommandOutput extends CreatePolicyOutput, __Metadat
  *                <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/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in 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>

diff --git a/clients/client-verifiedpermissions/src/commands/CreatePolicyStoreCommand.ts b/clients/client-verifiedpermissions/src/commands/CreatePolicyStoreCommand.ts
@@ -43,8 +43,7 @@ export interface CreatePolicyStoreCommandOutput extends CreatePolicyStoreOutput,
  * @public
  * <p>Creates a policy store. A policy store is a container for policy resources.</p>
  *          <note>
- *             <p>Although <a href="https://docs.cedarpolicy.com/schema.html#namespace">Cedar
- *                     supports multiple namespaces</a>, Verified Permissions currently supports only one
+ *             <p>Although <a href="https://docs.cedarpolicy.com/schema/schema.html#namespace">Cedar supports multiple namespaces</a>, Verified Permissions currently supports only one
  *                 namespace per policy store.</p>
  *          </note>
  *          <note>
@@ -82,6 +81,10 @@ export interface CreatePolicyStoreCommandOutput extends CreatePolicyStoreOutput,
  * @see {@link CreatePolicyStoreCommandOutput} 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 ServiceQuotaExceededException} (client fault)
  *  <p>The request failed because it would cause a service quota to be exceeded.</p>
  *
@@ -140,7 +143,7 @@ export interface CreatePolicyStoreCommandOutput extends CreatePolicyStoreOutput,
  *                </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/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in the
+ *                     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>
@@ -150,7 +153,7 @@ export interface CreatePolicyStoreCommandOutput extends CreatePolicyStoreOutput,
  *                <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/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in 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>

diff --git a/clients/client-verifiedpermissions/src/commands/CreatePolicyTemplateCommand.ts b/clients/client-verifiedpermissions/src/commands/CreatePolicyTemplateCommand.ts
@@ -87,6 +87,10 @@ export interface CreatePolicyTemplateCommandOutput extends CreatePolicyTemplateO
  * @see {@link CreatePolicyTemplateCommandOutput} 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>
  *
@@ -148,7 +152,7 @@ export interface CreatePolicyTemplateCommandOutput extends CreatePolicyTemplateO
  *                </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/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in the
+ *                     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>
@@ -158,7 +162,7 @@ export interface CreatePolicyTemplateCommandOutput extends CreatePolicyTemplateO
  *                <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/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in 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>

diff --git a/clients/client-verifiedpermissions/src/commands/DeleteIdentitySourceCommand.ts b/clients/client-verifiedpermissions/src/commands/DeleteIdentitySourceCommand.ts
@@ -129,7 +129,7 @@ export interface DeleteIdentitySourceCommandOutput extends DeleteIdentitySourceO
  *                </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/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in the
+ *                     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>
@@ -139,7 +139,7 @@ export interface DeleteIdentitySourceCommandOutput extends DeleteIdentitySourceO
  *                <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/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in 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>

diff --git a/clients/client-verifiedpermissions/src/commands/DeletePolicyCommand.ts b/clients/client-verifiedpermissions/src/commands/DeletePolicyCommand.ts
@@ -128,7 +128,7 @@ export interface DeletePolicyCommandOutput extends DeletePolicyOutput, __Metadat
  *                </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/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in the
+ *                     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>
@@ -138,7 +138,7 @@ export interface DeletePolicyCommandOutput extends DeletePolicyOutput, __Metadat
  *                <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/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in 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>

diff --git a/clients/client-verifiedpermissions/src/commands/DeletePolicyStoreCommand.ts b/clients/client-verifiedpermissions/src/commands/DeletePolicyStoreCommand.ts
@@ -120,7 +120,7 @@ export interface DeletePolicyStoreCommandOutput extends DeletePolicyStoreOutput,
  *                </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/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in the
+ *                     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>
@@ -130,7 +130,7 @@ export interface DeletePolicyStoreCommandOutput extends DeletePolicyStoreOutput,
  *                <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/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in 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>

diff --git a/clients/client-verifiedpermissions/src/commands/DeletePolicyTemplateCommand.ts b/clients/client-verifiedpermissions/src/commands/DeletePolicyTemplateCommand.ts
@@ -131,7 +131,7 @@ export interface DeletePolicyTemplateCommandOutput extends DeletePolicyTemplateO
  *                </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/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in the
+ *                     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>
@@ -141,7 +141,7 @@ export interface DeletePolicyTemplateCommandOutput extends DeletePolicyTemplateO
  *                <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/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in 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>

diff --git a/clients/client-verifiedpermissions/src/commands/GetIdentitySourceCommand.ts b/clients/client-verifiedpermissions/src/commands/GetIdentitySourceCommand.ts
@@ -140,7 +140,7 @@ export interface GetIdentitySourceCommandOutput extends GetIdentitySourceOutput,
  *                </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/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in the
+ *                     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>
@@ -150,7 +150,7 @@ export interface GetIdentitySourceCommandOutput extends GetIdentitySourceOutput,
  *                <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/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in 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>