docs(client-verifiedpermissions): Added improved descriptions and new…

… code samples to SDK documentation.

clients/client-verifiedpermissions/README.md

@@ -59,16 +59,16 @@ in a different operation. To help you understand the purpose of each, the follow
 naming convention is used for the structures:</p>
 <ul>
 <li>
-<p>Parameters that end in <code>Detail</code> are used in <code>Get</code>
-operations.</p>
+<p>Parameter type structures that end in <code>Detail</code> are used in
+<code>Get</code> operations.</p>
 </li>
 <li>
-<p>Parameters that end in <code>Item</code> are used in <code>List</code>
-operations.</p>
+<p>Parameter type structures that end in <code>Item</code> are used in
+<code>List</code> operations.</p>
 </li>
 <li>
-<p>Parameters that use neither suffix are used in the mutating (create and
-update) operations.</p>
+<p>Parameter type structures that use neither suffix are used in the mutating
+(create and update) operations.</p>
 </li>
 </ul>
 

clients/client-verifiedpermissions/src/VerifiedPermissions.ts

@@ -553,16 +553,16 @@ export interface VerifiedPermissions {
  * naming convention is used for the structures:</p>
  * <ul>
  * <li>
- * <p>Parameters that end in <code>Detail</code> are used in <code>Get</code>
- * operations.</p>
+ * <p>Parameter type structures that end in <code>Detail</code> are used in
+ *  <code>Get</code> operations.</p>
  * </li>
  * <li>
- * <p>Parameters that end in <code>Item</code> are used in <code>List</code>
- * operations.</p>
+ * <p>Parameter type structures that end in <code>Item</code> are used in
+ *  <code>List</code> operations.</p>
  * </li>
  * <li>
- * <p>Parameters that use neither suffix are used in the mutating (create and
- * update) operations.</p>
+ * <p>Parameter type structures that use neither suffix are used in the mutating
+ * (create and update) operations.</p>
  * </li>
  * </ul>
  */

clients/client-verifiedpermissions/src/VerifiedPermissionsClient.ts

@@ -387,16 +387,16 @@ export interface VerifiedPermissionsClientResolvedConfig extends VerifiedPermiss
  * naming convention is used for the structures:</p>
  * <ul>
  * <li>
- * <p>Parameters that end in <code>Detail</code> are used in <code>Get</code>
- * operations.</p>
+ * <p>Parameter type structures that end in <code>Detail</code> are used in
+ *  <code>Get</code> operations.</p>
  * </li>
  * <li>
- * <p>Parameters that end in <code>Item</code> are used in <code>List</code>
- * operations.</p>
+ * <p>Parameter type structures that end in <code>Item</code> are used in
+ *  <code>List</code> operations.</p>
  * </li>
  * <li>
- * <p>Parameters that use neither suffix are used in the mutating (create and
- * update) operations.</p>
+ * <p>Parameter type structures that use neither suffix are used in the mutating
+ * (create and update) operations.</p>
  * </li>
  * </ul>
  */

clients/client-verifiedpermissions/src/commands/CreatePolicyStoreCommand.ts

@@ -41,6 +41,11 @@ 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
+ * namespace per policy store.</p>
+ * </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-verifiedpermissions/src/index.ts

@@ -54,16 +54,16 @@
  * naming convention is used for the structures:</p>
  * <ul>
  * <li>
- * <p>Parameters that end in <code>Detail</code> are used in <code>Get</code>
- * operations.</p>
+ * <p>Parameter type structures that end in <code>Detail</code> are used in
+ *  <code>Get</code> operations.</p>
  * </li>
  * <li>
- * <p>Parameters that end in <code>Item</code> are used in <code>List</code>
- * operations.</p>
+ * <p>Parameter type structures that end in <code>Item</code> are used in
+ *  <code>List</code> operations.</p>
  * </li>
  * <li>
- * <p>Parameters that use neither suffix are used in the mutating (create and
- * update) operations.</p>
+ * <p>Parameter type structures that use neither suffix are used in the mutating
+ * (create and update) operations.</p>
  * </li>
  * </ul>
  *

clients/client-verifiedpermissions/src/models/models_0.ts

@@ -77,7 +77,7 @@ export interface EntityIdentifier {
  * as an identity provider for Verified Permissions.</p>
  * <p>This data type is used as a field that is part of an <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_Configuration.html">Configuration</a> structure that is
  * used as a parameter to the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_Configuration.html">Configuration</a>.</p>
- * <p>Example:<code>"CognitoUserPoolConfiguration":\{"UserPoolArn":"cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","ClientIds":
+ * <p>Example:<code>"CognitoUserPoolConfiguration":\{"UserPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","ClientIds":
  * ["a1b2c3d4e5f6g7h8i9j0kalbmc"]\}</code>
  * </p>
  */
@@ -86,7 +86,7 @@ export interface CognitoUserPoolConfiguration {
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the Amazon Cognito user pool that contains the identities to be
  * authorized.</p>
  * <p>Example: <code>"UserPoolArn":
- * "cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"</code>
+ * "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"</code>
  * </p>
  */
  userPoolArn: string | undefined;
@@ -123,7 +123,7 @@ export namespace Configuration {
  * authenticated identities as entities. It specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of a Amazon Cognito user pool
  * and one or more application client IDs.</p>
  * <p>Example:
- * <code>"configuration":\{"cognitoUserPoolConfiguration":\{"userPoolArn":"cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds":
+ * <code>"configuration":\{"cognitoUserPoolConfiguration":\{"userPoolArn":"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5","clientIds":
  * ["a1b2c3d4e5f6g7h8i9j0kalbmc"]\}\}</code>
  * </p>
  */
@@ -2838,8 +2838,12 @@ export interface IsAuthorizedInput {
  context?: ContextDefinition;
 
  /**
- * <p>Specifies the list of entities and their associated attributes that Verified Permissions can examine
- * when evaluating the policies.</p>
+ * <p>Specifies the list of resources and principals and their associated attributes that
+ * Verified Permissions can examine when evaluating the policies. </p>
+ * <note>
+ * <p>You can include only principal and resource entities in this parameter; you can't
+ * include actions. You must specify actions in the schema.</p>
+ * </note>
  */
  entities?: EntitiesDefinition;
 }
@@ -2889,8 +2893,12 @@ export interface IsAuthorizedWithTokenInput {
  context?: ContextDefinition;
 
  /**
- * <p>Specifies the list of entities and their associated attributes that Verified Permissions can examine
- * when evaluating the policies.</p>
+ * <p>Specifies the list of resources and principals and their associated attributes that
+ * Verified Permissions can examine when evaluating the policies. </p>
+ * <note>
+ * <p>You can include only principal and resource entities in this parameter; you can't
+ * include actions. You must specify actions in the schema.</p>
+ * </note>
  */
  entities?: EntitiesDefinition;
 }