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

Author: awstools

clients/client-identitystore/README.md

@@ -9,10 +9,19 @@
 
 AWS SDK for JavaScript Identitystore Client for Node.js, Browser and React Native.
 
-<p>The AWS Single Sign-On (SSO) Identity Store service provides a single place to retrieve all of your
-identities (users and groups). For more information about AWS, see the <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">AWS Single Sign-On User
+<p>The Identity Store service used by AWS IAM Identity Center (successor to AWS Single Sign-On) provides a single place to retrieve all of
+your identities (users and groups). For more information, see the <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">IAM Identity Center User
 Guide</a>.</p>
 
+<note>
+<p>Although AWS Single Sign-On was renamed, the <code>sso</code> and
+<code>identitystore</code> API namespaces will continue to retain their original name for
+backward compatibility purposes. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed">IAM Identity Center rename</a>.</p>
+</note>
+
+<p>This reference guide describes the identity store operations that you can call
+programatically and includes detailed information on data types and errors.</p>
+
 ## Installing
 
 To install the this package, simply type add or install @aws-sdk/client-identitystore

clients/client-identitystore/src/Identitystore.ts

@@ -59,9 +59,18 @@ import { UpdateUserCommand, UpdateUserCommandInput, UpdateUserCommandOutput } fr
 import { IdentitystoreClient } from "./IdentitystoreClient";
 
 /**
- * <p>The AWS Single Sign-On (SSO) Identity Store service provides a single place to retrieve all of your
- *          identities (users and groups). For more information about AWS, see the <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">AWS Single Sign-On User
+ * <p>The Identity Store service used by AWS IAM Identity Center (successor to AWS Single Sign-On) provides a single place to retrieve all of
+ *          your identities (users and groups). For more information, see the <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">IAM Identity Center User
  *             Guide</a>.</p>
+ *
+ *          <note>
+ *             <p>Although AWS Single Sign-On was renamed, the <code>sso</code> and
+ *             <code>identitystore</code> API namespaces will continue to retain their original name for
+ *             backward compatibility purposes. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed">IAM Identity Center rename</a>.</p>
+ *          </note>
+ *
+ *          <p>This reference guide describes the identity store operations that you can call
+ *          programatically and includes detailed information on data types and errors.</p>
  */
 export class Identitystore extends IdentitystoreClient {
   /**
@@ -233,7 +242,8 @@ export class Identitystore extends IdentitystoreClient {
   }
 
   /**
-   * <p>Retrieves the group metadata and attributes from <code>GroupId</code> in an identity store.</p>
+   * <p>Retrieves the group metadata and attributes from <code>GroupId</code> in an identity
+   *          store.</p>
    */
   public describeGroup(
     args: DescribeGroupCommandInput,
@@ -265,7 +275,7 @@ export class Identitystore extends IdentitystoreClient {
   }
 
   /**
-   * <p>Retrieves membership metadata and attributes from <code>MembershipId</code> in a group.</p>
+   * <p>Retrieves membership metadata and attributes from <code>MembershipId</code> in an identity store.</p>
    */
   public describeGroupMembership(
     args: DescribeGroupMembershipCommandInput,
@@ -352,7 +362,7 @@ export class Identitystore extends IdentitystoreClient {
   }
 
   /**
-   * <p>Retrieves the <code>MembershipId</code> in a group.</p>
+   * <p>Retrieves the <code>MembershipId</code> in an identity store.</p>
    */
   public getGroupMembershipId(
     args: GetGroupMembershipIdCommandInput,
@@ -410,7 +420,7 @@ export class Identitystore extends IdentitystoreClient {
   }
 
   /**
-   * <p>Returns if a member exists in specified groups.</p>
+   * <p>Checks the user's membership in all requested groups and returns if the member exists in all queried groups.</p>
    */
   public isMemberInGroups(
     args: IsMemberInGroupsCommandInput,
@@ -506,10 +516,10 @@ export class Identitystore extends IdentitystoreClient {
   }
 
   /**
-   * <p>
-   *             <i>Filtering for a group by the group <code>DisplayName</code> attribute is deprecated. Instead, use the <code>GetGroupId</code> API action.</i>
-   *          </p>
-   *          <p>Lists all groups in the identity store. Returns a paginated list of complete <code>Group</code> objects.</p>
+   * <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>
    */
   public listGroups(args: ListGroupsCommandInput, options?: __HttpHandlerOptions): Promise<ListGroupsCommandOutput>;
   public listGroups(args: ListGroupsCommandInput, cb: (err: any, data?: ListGroupsCommandOutput) => void): void;
@@ -535,10 +545,10 @@ export class Identitystore extends IdentitystoreClient {
   }
 
   /**
-   * <p>
-   *             <i>Filtering for a user by the <code>UserName</code> attribute is deprecated. Instead, use the <code>GetUserId</code> API action.</i>
-   *          </p>
-   *          <p>Lists all users in the identity store. Returns a paginated list of complete <code>User</code> objects.</p>
+   * <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>
    */
   public listUsers(args: ListUsersCommandInput, options?: __HttpHandlerOptions): Promise<ListUsersCommandOutput>;
   public listUsers(args: ListUsersCommandInput, cb: (err: any, data?: ListUsersCommandOutput) => void): void;

clients/client-identitystore/src/IdentitystoreClient.ts

@@ -288,9 +288,18 @@ type IdentitystoreClientResolvedConfigType = __SmithyResolvedConfiguration<__Htt
 export interface IdentitystoreClientResolvedConfig extends IdentitystoreClientResolvedConfigType {}
 
 /**
- * <p>The AWS Single Sign-On (SSO) Identity Store service provides a single place to retrieve all of your
- *          identities (users and groups). For more information about AWS, see the <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">AWS Single Sign-On User
+ * <p>The Identity Store service used by AWS IAM Identity Center (successor to AWS Single Sign-On) provides a single place to retrieve all of
+ *          your identities (users and groups). For more information, see the <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">IAM Identity Center User
  *             Guide</a>.</p>
+ *
+ *          <note>
+ *             <p>Although AWS Single Sign-On was renamed, the <code>sso</code> and
+ *             <code>identitystore</code> API namespaces will continue to retain their original name for
+ *             backward compatibility purposes. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed">IAM Identity Center rename</a>.</p>
+ *          </note>
+ *
+ *          <p>This reference guide describes the identity store operations that you can call
+ *          programatically and includes detailed information on data types and errors.</p>
  */
 export class IdentitystoreClient extends __Client<
   __HttpHandlerOptions,

clients/client-identitystore/src/commands/DescribeGroupCommand.ts

@@ -28,7 +28,8 @@ export interface DescribeGroupCommandInput extends DescribeGroupRequest {}
 export interface DescribeGroupCommandOutput extends DescribeGroupResponse, __MetadataBearer {}
 
 /**
- * <p>Retrieves the group metadata and attributes from <code>GroupId</code> in an identity store.</p>
+ * <p>Retrieves the group metadata and attributes from <code>GroupId</code> in an identity
+ *          store.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-identitystore/src/commands/DescribeGroupMembershipCommand.ts

@@ -28,7 +28,7 @@ export interface DescribeGroupMembershipCommandInput extends DescribeGroupMember
 export interface DescribeGroupMembershipCommandOutput extends DescribeGroupMembershipResponse, __MetadataBearer {}
 
 /**
- * <p>Retrieves membership metadata and attributes from <code>MembershipId</code> in a group.</p>
+ * <p>Retrieves membership metadata and attributes from <code>MembershipId</code> in an identity store.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-identitystore/src/commands/GetGroupMembershipIdCommand.ts

@@ -28,7 +28,7 @@ export interface GetGroupMembershipIdCommandInput extends GetGroupMembershipIdRe
 export interface GetGroupMembershipIdCommandOutput extends GetGroupMembershipIdResponse, __MetadataBearer {}
 
 /**
- * <p>Retrieves the <code>MembershipId</code> in a group.</p>
+ * <p>Retrieves the <code>MembershipId</code> in an identity store.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-identitystore/src/commands/IsMemberInGroupsCommand.ts

@@ -28,7 +28,7 @@ export interface IsMemberInGroupsCommandInput extends IsMemberInGroupsRequest {}
 export interface IsMemberInGroupsCommandOutput extends IsMemberInGroupsResponse, __MetadataBearer {}
 
 /**
- * <p>Returns if a member exists in specified groups.</p>
+ * <p>Checks the user's membership in all requested groups and returns if the member exists in all queried groups.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-identitystore/src/commands/ListGroupsCommand.ts

@@ -28,10 +28,10 @@ export interface ListGroupsCommandInput extends ListGroupsRequest {}
 export interface ListGroupsCommandOutput extends ListGroupsResponse, __MetadataBearer {}
 
 /**
- * <p>
- *             <i>Filtering for a group by the group <code>DisplayName</code> attribute is deprecated. Instead, use the <code>GetGroupId</code> API action.</i>
- *          </p>
- *          <p>Lists all groups in the identity store. Returns a paginated list of complete <code>Group</code> objects.</p>
+ * <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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-identitystore/src/commands/ListUsersCommand.ts

@@ -25,10 +25,10 @@ export interface ListUsersCommandInput extends ListUsersRequest {}
 export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBearer {}
 
 /**
- * <p>
- *             <i>Filtering for a user by the <code>UserName</code> attribute is deprecated. Instead, use the <code>GetUserId</code> API action.</i>
- *          </p>
- *          <p>Lists all users in the identity store. Returns a paginated list of complete <code>User</code> objects.</p>
+ * <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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript