docs(client-identitystore): Documentation updates for the Identity Store CLI Reference.

awstools · awstools · commit aa39d68b409d · 2022-09-22T18:23:06.000Z
diff --git a/clients/client-identitystore/src/Identitystore.ts b/clients/client-identitystore/src/Identitystore.ts
@@ -516,10 +516,8 @@ export class Identitystore extends IdentitystoreClient {
   }
 
   /**
-   * <p>Lists the attribute name and value of the group that you specified in the search. We
-   *          only support <code>DisplayName</code> as a valid filter attribute path currently, and
-   *          filter is required. This API returns minimum attributes, including <code>GroupId</code> and
-   *          group <code>DisplayName</code> in the response.</p>
+   * <p>Lists all groups in the identity store. Returns a paginated list of complete <code>Group</code> objects.
+   *          Filtering for a <code>Group</code> by the <code>DisplayName</code> attribute is deprecated. Instead, use the <code>GetGroupId</code> API action.</p>
    */
   public listGroups(args: ListGroupsCommandInput, options?: __HttpHandlerOptions): Promise<ListGroupsCommandOutput>;
   public listGroups(args: ListGroupsCommandInput, cb: (err: any, data?: ListGroupsCommandOutput) => void): void;
@@ -545,10 +543,8 @@ export class Identitystore extends IdentitystoreClient {
   }
 
   /**
-   * <p>Lists the attribute name and value of the user that you specified in the search. We only
-   *          support <code>UserName</code> as a valid filter attribute path currently, and filter is
-   *          required. This API returns minimum attributes, including <code>UserId</code> and
-   *             <code>UserName</code> in the response.</p>
+   * <p>Lists all users in the identity store. Returns a paginated list of complete <code>User</code> objects.
+   *          Filtering for a <code>User</code> by the <code>UserName</code> attribute is deprecated. Instead, use the <code>GetUserId</code> API action.</p>
    */
   public listUsers(args: ListUsersCommandInput, options?: __HttpHandlerOptions): Promise<ListUsersCommandOutput>;
   public listUsers(args: ListUsersCommandInput, cb: (err: any, data?: ListUsersCommandOutput) => void): void;
diff --git a/clients/client-identitystore/src/commands/ListGroupsCommand.ts b/clients/client-identitystore/src/commands/ListGroupsCommand.ts
@@ -28,10 +28,8 @@ export interface ListGroupsCommandInput extends ListGroupsRequest {}
 export interface ListGroupsCommandOutput extends ListGroupsResponse, __MetadataBearer {}
 
 /**
- * <p>Lists the attribute name and value of the group that you specified in the search. We
- *          only support <code>DisplayName</code> as a valid filter attribute path currently, and
- *          filter is required. This API returns minimum attributes, including <code>GroupId</code> and
- *          group <code>DisplayName</code> in the response.</p>
+ * <p>Lists all groups in the identity store. Returns a paginated list of complete <code>Group</code> objects.
+ *          Filtering for a <code>Group</code> by the <code>DisplayName</code> attribute is deprecated. Instead, use the <code>GetGroupId</code> API action.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-identitystore/src/commands/ListUsersCommand.ts b/clients/client-identitystore/src/commands/ListUsersCommand.ts
@@ -25,10 +25,8 @@ export interface ListUsersCommandInput extends ListUsersRequest {}
 export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBearer {}
 
 /**
- * <p>Lists the attribute name and value of the user that you specified in the search. We only
- *          support <code>UserName</code> as a valid filter attribute path currently, and filter is
- *          required. This API returns minimum attributes, including <code>UserId</code> and
- *             <code>UserName</code> in the response.</p>
+ * <p>Lists all users in the identity store. Returns a paginated list of complete <code>User</code> objects.
+ *          Filtering for a <code>User</code> by the <code>UserName</code> attribute is deprecated. Instead, use the <code>GetUserId</code> API action.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
diff --git a/clients/client-identitystore/src/models/models_0.ts b/clients/client-identitystore/src/models/models_0.ts
@@ -118,8 +118,8 @@ export interface UniqueAttribute {
 }
 
 /**
- * <p>A unique identifier for a user or group that is not the its primary identifier. This value can be
- *          an identifier from an external identity provider (IdP) that is associated with the group or a unique attribute. For example, a
+ * <p>A unique identifier for a user or group that is not the primary identifier. This value can be
+ *          an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For example, a
  *          unique <code>GroupDisplayName</code>.</p>
  */
 export type AlternateIdentifier =
@@ -189,8 +189,8 @@ export interface GetGroupIdRequest {
   IdentityStoreId: string | undefined;
 
   /**
-   * <p>A unique identifier for an identity resource that is not the primary identifier. This value can be
-   *          an identifier from an external identity provider (IdP) that is associated with the group or a unique attribute. For example, a
+   * <p>A unique identifier for a user or group that is not the primary identifier. This value can be
+   *          an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For example, a
    *          unique <code>GroupDisplayName</code>.</p>
    */
   AlternateIdentifier: AlternateIdentifier | undefined;
@@ -422,7 +422,9 @@ export interface GetUserIdRequest {
   IdentityStoreId: string | undefined;
 
   /**
-   * <p>A unique identifier for an identity resource that is not the primary identifier.</p>
+   * <p>A unique identifier for a user or group that is not the primary identifier. This value can be
+   *          an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For example, a
+   *          unique <code>UserDisplayName</code>.</p>
    */
   AlternateIdentifier: AlternateIdentifier | undefined;
 }
@@ -726,8 +728,7 @@ export interface DescribeGroupResponse {
   /**
    * <p>The group’s display name value. The length limit is 1,024 characters. This
    *          value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new
-   *          line, carriage return, space, and nonbreaking space in this attribute. The characters
-   *             <code>&lt;&gt;;:%</code> are excluded. This value is specified at the time that the
+   *          line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time that the
    *          group is created and stored as an attribute of the group object in the identity
    *          store.</p>
    */
@@ -816,8 +817,7 @@ export interface Group {
   /**
    * <p>The group’s display name value. The length limit is 1,024 characters. This
    *          value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new
-   *          line, carriage return, space, and nonbreaking space in this attribute. The characters
-   *             <code>&lt;&gt;;:%</code> are excluded. This value is specified at the time the group is
+   *          line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time the group is
    *          created and stored as an attribute of the group object in the identity store.</p>
    */
   DisplayName?: string;
diff --git a/codegen/sdk-codegen/aws-models/identitystore.json b/codegen/sdk-codegen/aws-models/identitystore.json
@@ -164,7 +164,7 @@
         }
       },
       "traits": {
-        "smithy.api#documentation": "<p>A unique identifier for a user or group that is not the its primary identifier. This value can be\n         an identifier from an external identity provider (IdP) that is associated with the group or a unique attribute. For example, a\n         unique <code>GroupDisplayName</code>.</p>"
+        "smithy.api#documentation": "<p>A unique identifier for a user or group that is not the primary identifier. This value can be\n         an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For example, a\n         unique <code>GroupDisplayName</code>.</p>"
       }
     },
     "com.amazonaws.identitystore#AttributeOperation": {
@@ -797,7 +797,7 @@
         "DisplayName": {
           "target": "com.amazonaws.identitystore#GroupDisplayName",
           "traits": {
-            "smithy.api#documentation": "<p>The group’s display name value. The length limit is 1,024 characters. This\n         value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new\n         line, carriage return, space, and nonbreaking space in this attribute. The characters\n            <code>&lt;&gt;;:%</code> are excluded. This value is specified at the time that the\n         group is created and stored as an attribute of the group object in the identity\n         store.</p>"
+            "smithy.api#documentation": "<p>The group’s display name value. The length limit is 1,024 characters. This\n         value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new\n         line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time that the\n         group is created and stored as an attribute of the group object in the identity\n         store.</p>"
           }
         },
         "ExternalIds": {
@@ -1130,7 +1130,7 @@
         "AlternateIdentifier": {
           "target": "com.amazonaws.identitystore#AlternateIdentifier",
           "traits": {
-            "smithy.api#documentation": "<p>A unique identifier for an identity resource that is not the primary identifier. This value can be\n         an identifier from an external identity provider (IdP) that is associated with the group or a unique attribute. For example, a\n         unique <code>GroupDisplayName</code>.</p>",
+            "smithy.api#documentation": "<p>A unique identifier for a user or group that is not the primary identifier. This value can be\n         an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For example, a\n         unique <code>GroupDisplayName</code>.</p>",
             "smithy.api#required": {}
           }
         }
@@ -1255,7 +1255,7 @@
         "AlternateIdentifier": {
           "target": "com.amazonaws.identitystore#AlternateIdentifier",
           "traits": {
-            "smithy.api#documentation": "<p>A unique identifier for an identity resource that is not the primary identifier.</p>",
+            "smithy.api#documentation": "<p>A unique identifier for a user or group that is not the primary identifier. This value can be\n         an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For example, a\n         unique <code>UserDisplayName</code>.</p>",
             "smithy.api#required": {}
           }
         }
@@ -1293,7 +1293,7 @@
         "DisplayName": {
           "target": "com.amazonaws.identitystore#GroupDisplayName",
           "traits": {
-            "smithy.api#documentation": "<p>The group’s display name value. The length limit is 1,024 characters. This\n         value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new\n         line, carriage return, space, and nonbreaking space in this attribute. The characters\n            <code>&lt;&gt;;:%</code> are excluded. This value is specified at the time the group is\n         created and stored as an attribute of the group object in the identity store.</p>"
+            "smithy.api#documentation": "<p>The group’s display name value. The length limit is 1,024 characters. This\n         value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new\n         line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time the group is\n         created and stored as an attribute of the group object in the identity store.</p>"
           }
         },
         "ExternalIds": {
@@ -1742,7 +1742,7 @@
         }
       ],
       "traits": {
-        "smithy.api#documentation": "<p>Lists the attribute name and value of the group that you specified in the search. We\n         only support <code>DisplayName</code> as a valid filter attribute path currently, and\n         filter is required. This API returns minimum attributes, including <code>GroupId</code> and\n         group <code>DisplayName</code> in the response.</p>",
+        "smithy.api#documentation": "<p>Lists all groups in the identity store. Returns a paginated list of complete <code>Group</code> objects. \n         Filtering for a <code>Group</code> by the <code>DisplayName</code> attribute is deprecated. Instead, use the <code>GetGroupId</code> API action.</p>",
         "smithy.api#paginated": {
           "inputToken": "NextToken",
           "items": "Groups",
@@ -1820,7 +1820,7 @@
         }
       ],
       "traits": {
-        "smithy.api#documentation": "<p>Lists the attribute name and value of the user that you specified in the search. We only\n         support <code>UserName</code> as a valid filter attribute path currently, and filter is\n         required. This API returns minimum attributes, including <code>UserId</code> and\n            <code>UserName</code> in the response.</p>",
+        "smithy.api#documentation": "<p>Lists all users in the identity store. Returns a paginated list of complete <code>User</code> objects. \n         Filtering for a <code>User</code> by the <code>UserName</code> attribute is deprecated. Instead, use the <code>GetUserId</code> API action.</p>",
         "smithy.api#paginated": {
           "inputToken": "NextToken",
           "items": "Users",
