@aws-sdk/client-identitystore 3.529.1 → 3.535.0

package/dist-types/models/models_0.d.ts

@@ -2,18 +2,18 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-cli
 import { DocumentType as __DocumentType } from "@smithy/types";
 import { IdentitystoreServiceException as __BaseException } from "./IdentitystoreServiceException";
 /**
- * @public
  * <p>You do not have sufficient access to perform this action.</p>
+ * @public
  */
 export declare class AccessDeniedException extends __BaseException {
     readonly name: "AccessDeniedException";
     readonly $fault: "client";
     Message?: string;
     /**
-     * @public
      * <p>The identifier for each request. This value is a globally unique ID that is generated by
      *          the identity store service for each sent request, and is then returned inside the exception
      *          if the request fails.</p>
+     * @public
      */
     RequestId?: string;
     /**
@@ -22,94 +22,94 @@ export declare class AccessDeniedException extends __BaseException {
     constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
 }
 /**
- * @public
  * <p>The address associated with the specified user.</p>
+ * @public
  */
 export interface Address {
     /**
-     * @public
      * <p>The
      *          street
      *          of the address.</p>
+     * @public
      */
     StreetAddress?: string;
     /**
-     * @public
      * <p>A string of the address locality.</p>
+     * @public
      */
     Locality?: string;
     /**
-     * @public
      * <p>The
      *          region
      *          of the address.</p>
+     * @public
      */
     Region?: string;
     /**
-     * @public
      * <p>The postal code of the address.</p>
+     * @public
      */
     PostalCode?: string;
     /**
-     * @public
      * <p>The country of the address.</p>
+     * @public
      */
     Country?: string;
     /**
-     * @public
      * <p>A string containing a formatted version of the address for display.</p>
+     * @public
      */
     Formatted?: string;
     /**
-     * @public
      * <p>A string representing the type of address. For example, "Home."</p>
+     * @public
      */
     Type?: string;
     /**
-     * @public
      * <p>A Boolean value representing whether this is the primary address for the associated
      *          resource.</p>
+     * @public
      */
     Primary?: boolean;
 }
 /**
- * @public
  * <p>The identifier issued to this resource by an external identity provider.</p>
+ * @public
  */
 export interface ExternalId {
     /**
-     * @public
      * <p>The issuer for an external identifier.</p>
+     * @public
      */
     Issuer: string | undefined;
     /**
-     * @public
      * <p>The identifier issued to this resource by an external identity provider.</p>
+     * @public
      */
     Id: string | undefined;
 }
 /**
- * @public
  * <p>An entity attribute that's unique to a specific entity.</p>
+ * @public
  */
 export interface UniqueAttribute {
     /**
-     * @public
      * <p>A string representation of the path to a given attribute or sub-attribute. Supports
      *          JMESPath.</p>
+     * @public
      */
     AttributePath: string | undefined;
     /**
-     * @public
      * <p>The value of the attribute. This is a <code>Document</code> type.
      *          This type is not supported by Java V1, Go V1, and older versions of the CLI.</p>
+     * @public
      */
     AttributeValue: __DocumentType | undefined;
 }
 /**
- * @public
  * <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.</p>
+ * @public
  */
 export type AlternateIdentifier = AlternateIdentifier.ExternalIdMember | AlternateIdentifier.UniqueAttributeMember | AlternateIdentifier.$UnknownMember;
 /**
@@ -117,8 +117,8 @@ export type AlternateIdentifier = AlternateIdentifier.ExternalIdMember | Alterna
  */
 export declare namespace AlternateIdentifier {
     /**
-     * @public
      * <p>The identifier issued to this resource by an external identity provider.</p>
+     * @public
      */
     interface ExternalIdMember {
         ExternalId: ExternalId;
@@ -126,8 +126,8 @@ export declare namespace AlternateIdentifier {
         $unknown?: never;
     }
     /**
-     * @public
      * <p>An entity attribute that's unique to a specific entity.</p>
+     * @public
      */
     interface UniqueAttributeMember {
         ExternalId?: never;
@@ -150,20 +150,20 @@ export declare namespace AlternateIdentifier {
     const visit: <T>(value: AlternateIdentifier, visitor: Visitor<T>) => T;
 }
 /**
- * @public
  * <p>An operation that applies to the requested group. This operation might add, replace, or remove an attribute.</p>
+ * @public
  */
 export interface AttributeOperation {
     /**
-     * @public
      * <p>A string representation of the path to a given attribute or sub-attribute. Supports
      *          JMESPath.</p>
+     * @public
      */
     AttributePath: string | undefined;
     /**
-     * @public
      * <p>The value of the attribute. This is a <code>Document</code> type.
      *          This type is not supported by Java V1, Go V1, and older versions of the CLI.</p>
+     * @public
      */
     AttributeValue?: __DocumentType;
 }
@@ -172,14 +172,14 @@ export interface AttributeOperation {
  */
 export interface GetGroupIdRequest {
     /**
-     * @public
      * <p>The globally unique identifier for the identity store.</p>
+     * @public
      */
     IdentityStoreId: string | undefined;
     /**
-     * @public
      * <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 the unique attribute, the only valid path is <code>displayName</code>.</p>
+     * @public
      */
     AlternateIdentifier: AlternateIdentifier | undefined;
 }
@@ -188,19 +188,19 @@ export interface GetGroupIdRequest {
  */
 export interface GetGroupIdResponse {
     /**
-     * @public
      * <p>The identifier for a group in the identity store.</p>
+     * @public
      */
     GroupId: string | undefined;
     /**
-     * @public
      * <p>The globally unique identifier for the identity store.</p>
+     * @public
      */
     IdentityStoreId: string | undefined;
 }
 /**
- * @public
  * <p>The request processing has failed because of an unknown error, exception or failure with an internal server.</p>
+ * @public
  */
 export declare class InternalServerException extends __BaseException {
     readonly name: "InternalServerException";
@@ -208,15 +208,15 @@ export declare class InternalServerException extends __BaseException {
     $retryable: {};
     Message?: string;
     /**
-     * @public
      * <p>The identifier for each request. This value is a globally unique ID that is generated by
      *          the identity store service for each sent request, and is then returned inside the exception
      *          if the request fails.</p>
+     * @public
      */
     RequestId?: string;
     /**
-     * @public
      * <p>The number of seconds to wait before retrying the next request.</p>
+     * @public
      */
     RetryAfterSeconds?: number;
     /**
@@ -239,28 +239,28 @@ export declare const ResourceType: {
  */
 export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
 /**
- * @public
  * <p>Indicates that a requested resource is not found.</p>
+ * @public
  */
 export declare class ResourceNotFoundException extends __BaseException {
     readonly name: "ResourceNotFoundException";
     readonly $fault: "client";
     /**
-     * @public
      * <p>An enum object indicating the type of resource in the identity store service. Valid values include USER, GROUP, and IDENTITY_STORE.</p>
+     * @public
      */
     ResourceType?: ResourceType;
     /**
-     * @public
      * <p>The identifier for a resource in the identity store that can be used as <code>UserId</code> or <code>GroupId</code>. The format for <code>ResourceId</code> is either <code>UUID</code> or <code>1234567890-UUID</code>, where <code>UUID</code> is a randomly generated value for each resource when it is created and <code>1234567890</code> represents the <code>IdentityStoreId</code> string value. In the case that the identity store is migrated from a legacy SSO identity store, the <code>ResourceId</code> for that identity store will be in the format of <code>UUID</code>. Otherwise, it will be in the <code>1234567890-UUID</code> format.</p>
+     * @public
      */
     ResourceId?: string;
     Message?: string;
     /**
-     * @public
      * <p>The identifier for each request. This value is a globally unique ID that is generated by
      *          the identity store service for each sent request, and is then returned inside the exception
      *          if the request fails.</p>
+     * @public
      */
     RequestId?: string;
     /**
@@ -269,8 +269,8 @@ export declare class ResourceNotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
 /**
- * @public
  * <p>Indicates that the principal has crossed the throttling limits of the API operations.</p>
+ * @public
  */
 export declare class ThrottlingException extends __BaseException {
     readonly name: "ThrottlingException";
@@ -280,15 +280,15 @@ export declare class ThrottlingException extends __BaseException {
     };
     Message?: string;
     /**
-     * @public
      * <p>The identifier for each request. This value is a globally unique ID that is generated by
      *          the identity store service for each sent request, and is then returned inside the exception
      *          if the request fails.</p>
+     * @public
      */
     RequestId?: string;
     /**
-     * @public
      * <p>The number of seconds to wait before retrying the next request.</p>
+     * @public
      */
     RetryAfterSeconds?: number;
     /**
@@ -297,18 +297,18 @@ export declare class ThrottlingException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
 }
 /**
- * @public
  * <p>The request failed because it contains a syntax error.</p>
+ * @public
  */
 export declare class ValidationException extends __BaseException {
     readonly name: "ValidationException";
     readonly $fault: "client";
     Message?: string;
     /**
-     * @public
      * <p>The identifier for each request. This value is a globally unique ID that is generated by
      *          the identity store service for each sent request, and is then returned inside the exception
      *          if the request fails.</p>
+     * @public
      */
     RequestId?: string;
     /**
@@ -317,8 +317,8 @@ export declare class ValidationException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
 }
 /**
- * @public
  * <p>An object containing the identifier of a group member.</p>
+ * @public
  */
 export type MemberId = MemberId.UserIdMember | MemberId.$UnknownMember;
 /**
@@ -326,8 +326,8 @@ export type MemberId = MemberId.UserIdMember | MemberId.$UnknownMember;
  */
 export declare namespace MemberId {
     /**
-     * @public
      * <p>An object containing the identifiers of resources that can be members.</p>
+     * @public
      */
     interface UserIdMember {
         UserId: string;
@@ -351,18 +351,18 @@ export declare namespace MemberId {
  */
 export interface GetGroupMembershipIdRequest {
     /**
-     * @public
      * <p>The globally unique identifier for the identity store.</p>
+     * @public
      */
     IdentityStoreId: string | undefined;
     /**
-     * @public
      * <p>The identifier for a group in the identity store.</p>
+     * @public
      */
     GroupId: string | undefined;
     /**
-     * @public
      * <p>An object that contains the identifier of a group member. Setting the <code>UserID</code> field to the specific identifier for a user indicates that the user is a member of the group.</p>
+     * @public
      */
     MemberId: MemberId | undefined;
 }
@@ -371,13 +371,13 @@ export interface GetGroupMembershipIdRequest {
  */
 export interface GetGroupMembershipIdResponse {
     /**
-     * @public
      * <p>The identifier for a <code>GroupMembership</code> in an identity store.</p>
+     * @public
      */
     MembershipId: string | undefined;
     /**
-     * @public
      * <p>The globally unique identifier for the identity store.</p>
+     * @public
      */
     IdentityStoreId: string | undefined;
 }
@@ -386,14 +386,14 @@ export interface GetGroupMembershipIdResponse {
  */
 export interface GetUserIdRequest {
     /**
-     * @public
      * <p>The globally unique identifier for the identity store.</p>
+     * @public
      */
     IdentityStoreId: string | undefined;
     /**
-     * @public
      * <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 the unique attribute, the only valid paths are <code>userName</code> and <code>emails.value</code>.</p>
+     * @public
      */
     AlternateIdentifier: AlternateIdentifier | undefined;
 }
@@ -402,13 +402,13 @@ export interface GetUserIdRequest {
  */
 export interface GetUserIdResponse {
     /**
-     * @public
      * <p>The identifier for a user in the identity store.</p>
+     * @public
      */
     UserId: string | undefined;
     /**
-     * @public
      * <p>The globally unique identifier for the identity store.</p>
+     * @public
      */
     IdentityStoreId: string | undefined;
 }
@@ -425,7 +425,6 @@ export declare const ConflictExceptionReason: {
  */
 export type ConflictExceptionReason = (typeof ConflictExceptionReason)[keyof typeof ConflictExceptionReason];
 /**
- * @public
  * <p>This request cannot be completed for one of the following reasons:</p>
  *          <ul>
  *             <li>
@@ -435,18 +434,18 @@ export type ConflictExceptionReason = (typeof ConflictExceptionReason)[keyof typ
  *                <p>The requested resource was being concurrently modified by another request.</p>
  *             </li>
  *          </ul>
+ * @public
  */
 export declare class ConflictException extends __BaseException {
     readonly name: "ConflictException";
     readonly $fault: "client";
     Message?: string;
     /**
-     * @public
      * <p>The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.</p>
+     * @public
      */
     RequestId?: string;
     /**
-     * @public
      * <p>This request cannot be completed for one of the following reasons:</p>
      *          <ul>
      *             <li>
@@ -456,6 +455,7 @@ export declare class ConflictException extends __BaseException {
      *                <p>The requested resource was being concurrently modified by another request.</p>
      *             </li>
      *          </ul>
+     * @public
      */
     Reason?: ConflictExceptionReason;
     /**
@@ -468,18 +468,18 @@ export declare class ConflictException extends __BaseException {
  */
 export interface CreateGroupMembershipRequest {
     /**
-     * @public
      * <p>The globally unique identifier for the identity store.</p>
+     * @public
      */
     IdentityStoreId: string | undefined;
     /**
-     * @public
      * <p>The identifier for a group in the identity store.</p>
+     * @public
      */
     GroupId: string | undefined;
     /**
-     * @public
      * <p>An object that contains the identifier of a group member. Setting the <code>UserID</code> field to the specific identifier for a user indicates that the user is a member of the group.</p>
+     * @public
      */
     MemberId: MemberId | undefined;
 }
@@ -488,28 +488,28 @@ export interface CreateGroupMembershipRequest {
  */
 export interface CreateGroupMembershipResponse {
     /**
-     * @public
      * <p>The identifier for a newly created <code>GroupMembership</code> in an identity
      *          store.</p>
+     * @public
      */
     MembershipId: string | undefined;
     /**
-     * @public
      * <p>The globally unique identifier for the identity store.</p>
+     * @public
      */
     IdentityStoreId: string | undefined;
 }
 /**
- * @public
  * <p>The request would cause the number of users or groups in the identity store to exceed the maximum allowed.</p>
+ * @public
  */
 export declare class ServiceQuotaExceededException extends __BaseException {
     readonly name: "ServiceQuotaExceededException";
     readonly $fault: "client";
     Message?: string;
     /**
-     * @public
      * <p>The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.</p>
+     * @public
      */
     RequestId?: string;
     /**
@@ -522,13 +522,13 @@ export declare class ServiceQuotaExceededException extends __BaseException {
  */
 export interface DeleteGroupMembershipRequest {
     /**
-     * @public
      * <p>The globally unique identifier for the identity store.</p>
+     * @public
      */
     IdentityStoreId: string | undefined;
     /**
-     * @public
      * <p>The identifier for a <code>GroupMembership</code> in an identity store.</p>
+     * @public
      */
     MembershipId: string | undefined;
 }
@@ -542,13 +542,13 @@ export interface DeleteGroupMembershipResponse {
  */
 export interface DescribeGroupMembershipRequest {
     /**
-     * @public
      * <p>The globally unique identifier for the identity store.</p>
+     * @public
      */
     IdentityStoreId: string | undefined;
     /**
-     * @public
      * <p>The identifier for a <code>GroupMembership</code> in an identity store.</p>
+     * @public
      */
     MembershipId: string | undefined;
 }
@@ -557,23 +557,23 @@ export interface DescribeGroupMembershipRequest {
  */
 export interface DescribeGroupMembershipResponse {
     /**
-     * @public
      * <p>The globally unique identifier for the identity store.</p>
+     * @public
      */
     IdentityStoreId: string | undefined;
     /**
-     * @public
      * <p>The identifier for a <code>GroupMembership</code> in an identity store.</p>
+     * @public
      */
     MembershipId: string | undefined;
     /**
-     * @public
      * <p>The identifier for a group in the identity store.</p>
+     * @public
      */
     GroupId: string | undefined;
     /**
-     * @public
      * <p>An object containing the identifier of a group member.</p>
+     * @public
      */
     MemberId: MemberId | undefined;
 }
@@ -582,51 +582,51 @@ export interface DescribeGroupMembershipResponse {
  */
 export interface ListGroupMembershipsRequest {
     /**
-     * @public
      * <p>The globally unique identifier for the identity store.</p>
+     * @public
      */
     IdentityStoreId: string | undefined;
     /**
-     * @public
      * <p>The identifier for a group in the identity store.</p>
+     * @public
      */
     GroupId: string | undefined;
     /**
-     * @public
      * <p>The maximum number of results to be returned per request. This parameter is used in all
      *             <code>List</code> requests to specify how many results to return in one page.</p>
+     * @public
      */
     MaxResults?: number;
     /**
-     * @public
      * <p>The pagination token used for the <code>ListUsers</code>, <code>ListGroups</code> and <code>ListGroupMemberships</code> API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.</p>
+     * @public
      */
     NextToken?: string;
 }
 /**
- * @public
  * <p>Contains the identifiers for a group, a group member, and a <code>GroupMembership</code>
  *          object in the identity store.</p>
+ * @public
  */
 export interface GroupMembership {
     /**
-     * @public
      * <p>The globally unique identifier for the identity store.</p>
+     * @public
      */
     IdentityStoreId: string | undefined;
     /**
-     * @public
      * <p>The identifier for a <code>GroupMembership</code> object in an identity store.</p>
+     * @public
      */
     MembershipId?: string;
     /**
-     * @public
      * <p>The identifier for a group in the identity store.</p>
+     * @public
      */
     GroupId?: string;
     /**
-     * @public
      * <p>An object that contains the identifier of a group member. Setting the <code>UserID</code> field to the specific identifier for a user indicates that the user is a member of the group.</p>
+     * @public
      */
     MemberId?: MemberId;
 }
@@ -635,13 +635,13 @@ export interface GroupMembership {
  */
 export interface ListGroupMembershipsResponse {
     /**
-     * @public
      * <p>A list of <code>GroupMembership</code> objects in the group.</p>
+     * @public
      */
     GroupMemberships: GroupMembership[] | undefined;
     /**
-     * @public
      * <p>The pagination token used for the <code>ListUsers</code>, <code>ListGroups</code>, and <code>ListGroupMemberships</code> API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.</p>
+     * @public
      */
     NextToken?: string;
 }
@@ -650,20 +650,20 @@ export interface ListGroupMembershipsResponse {
  */
 export interface CreateGroupRequest {
     /**
-     * @public
      * <p>The globally unique identifier for the identity store.</p>
+     * @public
      */
     IdentityStoreId: string | undefined;
     /**
-     * @public
      * <p>A string containing the name of the group. This value is commonly displayed when the
      *          group is referenced. <code>Administrator</code> and <code>AWSAdministrators</code> are
      *          reserved names and can't be used for users or groups.</p>
+     * @public
      */
     DisplayName?: string;
     /**
-     * @public
      * <p>A string containing the description of the group.</p>
+     * @public
      */
     Description?: string;
 }
@@ -672,15 +672,15 @@ export interface CreateGroupRequest {
  */
 export interface CreateGroupResponse {
     /**
-     * @public
      * <p>The
      *          identifier
      *          of the newly created group in the identity store.</p>
+     * @public
      */
     GroupId: string | undefined;
     /**
-     * @public
      * <p>The globally unique identifier for the identity store.</p>
+     * @public
      */
     IdentityStoreId: string | undefined;
 }
@@ -689,13 +689,13 @@ export interface CreateGroupResponse {
  */
 export interface DeleteGroupRequest {
     /**
-     * @public
      * <p>The globally unique identifier for the identity store.</p>
+     * @public
      */
     IdentityStoreId: string | undefined;
     /**
-     * @public
      * <p>The identifier for a group in the identity store.</p>
+     * @public
      */
     GroupId: string | undefined;
 }
@@ -709,17 +709,17 @@ export interface DeleteGroupResponse {
  */
 export interface DescribeGroupRequest {
     /**
-     * @public
      * <p>The globally unique identifier for the identity store, such as
      *          <code>d-1234567890</code>. In this example, <code>d-</code> is a fixed prefix, and
      *             <code>1234567890</code> is a randomly generated string that contains numbers and lower
      *          case letters. This value is generated at the time that a new identity store is
      *          created.</p>
+     * @public
      */
     IdentityStoreId: string | undefined;
     /**
-     * @public
      * <p>The identifier for a group in the identity store.</p>
+     * @public
      */
     GroupId: string | undefined;
 }
@@ -728,54 +728,54 @@ export interface DescribeGroupRequest {
  */
 export interface DescribeGroupResponse {
     /**
-     * @public
      * <p>The identifier for a group in the identity store.</p>
+     * @public
      */
     GroupId: string | undefined;
     /**
-     * @public
      * <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. 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>
+     * @public
      */
     DisplayName?: string;
     /**
-     * @public
      * <p>A list of <code>ExternalId</code> objects that contains the identifiers issued to this
      *          resource by an external identity provider.</p>
+     * @public
      */
     ExternalIds?: ExternalId[];
     /**
-     * @public
      * <p>A string containing a description of the group.</p>
+     * @public
      */
     Description?: string;
     /**
-     * @public
      * <p>The globally unique identifier for the identity store.</p>
+     * @public
      */
     IdentityStoreId: string | undefined;
 }
 /**
- * @public
  * <p>A query filter used by <code>ListUsers</code> and <code>ListGroups</code>. This filter
  *          object provides the attribute name and attribute value to search users or groups.</p>
+ * @public
  */
 export interface Filter {
     /**
-     * @public
      * <p>The attribute path that is used to specify which attribute name to search. Length limit
      *          is 255 characters. For example, <code>UserName</code> is a valid attribute path for the
      *             <code>ListUsers</code> API, and <code>DisplayName</code> is a valid attribute path for
      *          the <code>ListGroups</code> API.</p>
+     * @public
      */
     AttributePath: string | undefined;
     /**
-     * @public
      * <p>Represents the data for an attribute. Each attribute value is described as a name-value
      *          pair. </p>
+     * @public
      */
     AttributeValue: string | undefined;
 }
@@ -784,71 +784,71 @@ export interface Filter {
  */
 export interface ListGroupsRequest {
     /**
-     * @public
      * <p>The globally unique identifier for the identity store, such as
      *          <code>d-1234567890</code>. In this example, <code>d-</code> is a fixed prefix, and
      *             <code>1234567890</code> is a randomly generated string that contains numbers and lower
      *          case letters. This value is generated at the time that a new identity store is
      *          created.</p>
+     * @public
      */
     IdentityStoreId: string | undefined;
     /**
-     * @public
      * <p>The maximum number of results to be returned per request. This parameter is used in the
      *             <code>ListUsers</code> and <code>ListGroups</code> requests to specify how many results
      *          to return in one page. The length limit is 50 characters.</p>
+     * @public
      */
     MaxResults?: number;
     /**
-     * @public
      * <p>The pagination token used for the <code>ListUsers</code> and <code>ListGroups</code> API
      *          operations. This value is generated by the identity store service. It is returned in the
      *          API response if the total results are more than the size of one page. This token is also
      *          returned when it is used in the API request to search for the next page.</p>
+     * @public
      */
     NextToken?: string;
     /**
-     * @public
      * @deprecated
      *
      * <p>A list of <code>Filter</code> objects, which is used in the <code>ListUsers</code> and
      *             <code>ListGroups</code> requests.</p>
+     * @public
      */
     Filters?: Filter[];
 }
 /**
- * @public
  * <p>A group object that contains the metadata and attributes for a specified group.</p>
+ * @public
  */
 export interface Group {
     /**
-     * @public
      * <p>The identifier for a group in the identity store.</p>
+     * @public
      */
     GroupId: string | undefined;
     /**
-     * @public
      * <p>The display name value for the group. 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. 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>
+     * @public
      */
     DisplayName?: string;
     /**
-     * @public
      * <p>A list of <code>ExternalId</code> objects that contains the identifiers issued to this
      *          resource by an external identity provider.</p>
+     * @public
      */
     ExternalIds?: ExternalId[];
     /**
-     * @public
      * <p>A string containing a description of the specified group.</p>
+     * @public
      */
     Description?: string;
     /**
-     * @public
      * <p>The globally unique identifier for the identity store.</p>
+     * @public
      */
     IdentityStoreId: string | undefined;
 }
@@ -857,16 +857,16 @@ export interface Group {
  */
 export interface ListGroupsResponse {
     /**
-     * @public
      * <p>A list of <code>Group</code> objects in the identity store.</p>
+     * @public
      */
     Groups: Group[] | undefined;
     /**
-     * @public
      * <p>The pagination token used for the <code>ListUsers</code> and <code>ListGroups</code> API
      *          operations. This value is generated by the identity store service. It is returned in the
      *          API response if the total results are more than the size of one page. This token is also
      *          returned when it1 is used in the API request to search for the next page.</p>
+     * @public
      */
     NextToken?: string;
 }
@@ -875,19 +875,19 @@ export interface ListGroupsResponse {
  */
 export interface UpdateGroupRequest {
     /**
-     * @public
      * <p>The globally unique identifier for the identity store.</p>
+     * @public
      */
     IdentityStoreId: string | undefined;
     /**
-     * @public
      * <p>The identifier for a group in the identity store.</p>
+     * @public
      */
     GroupId: string | undefined;
     /**
-     * @public
      * <p>A list of <code>AttributeOperation</code> objects to apply to the requested group. These
      *          operations might add, replace, or remove an attribute.</p>
+     * @public
      */
     Operations: AttributeOperation[] | undefined;
 }
@@ -901,39 +901,39 @@ export interface UpdateGroupResponse {
  */
 export interface IsMemberInGroupsRequest {
     /**
-     * @public
      * <p>The globally unique identifier for the identity store.</p>
+     * @public
      */
     IdentityStoreId: string | undefined;
     /**
-     * @public
      * <p>An object containing the identifier of a group member.</p>
+     * @public
      */
     MemberId: MemberId | undefined;
     /**
-     * @public
      * <p>A list of identifiers for groups in the identity store.</p>
+     * @public
      */
     GroupIds: string[] | undefined;
 }
 /**
- * @public
  * <p>Indicates whether a resource is a member of a group in the identity store.</p>
+ * @public
  */
 export interface GroupMembershipExistenceResult {
     /**
-     * @public
      * <p>The identifier for a group in the identity store.</p>
+     * @public
      */
     GroupId?: string;
     /**
-     * @public
      * <p>An object that contains the identifier of a group member. Setting the <code>UserID</code> field to the specific identifier for a user indicates that the user is a member of the group.</p>
+     * @public
      */
     MemberId?: MemberId;
     /**
-     * @public
      * <p>Indicates whether a membership relation exists or not.</p>
+     * @public
      */
     MembershipExists?: boolean;
 }
@@ -942,8 +942,8 @@ export interface GroupMembershipExistenceResult {
  */
 export interface IsMemberInGroupsResponse {
     /**
-     * @public
      * <p>A list containing the results of membership existence checks.</p>
+     * @public
      */
     Results: GroupMembershipExistenceResult[] | undefined;
 }
@@ -952,23 +952,23 @@ export interface IsMemberInGroupsResponse {
  */
 export interface ListGroupMembershipsForMemberRequest {
     /**
-     * @public
      * <p>The globally unique identifier for the identity store.</p>
+     * @public
      */
     IdentityStoreId: string | undefined;
     /**
-     * @public
      * <p>An object that contains the identifier of a group member. Setting the <code>UserID</code> field to the specific identifier for a user indicates that the user is a member of the group.</p>
+     * @public
      */
     MemberId: MemberId | undefined;
     /**
-     * @public
      * <p>The maximum number of results to be returned per request. This parameter is used in the <code>ListUsers</code> and <code>ListGroups</code> requests to specify how many results to return in one page. The length limit is 50 characters.</p>
+     * @public
      */
     MaxResults?: number;
     /**
-     * @public
      * <p>The pagination token used for the <code>ListUsers</code>, <code>ListGroups</code>, and <code>ListGroupMemberships</code> API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.</p>
+     * @public
      */
     NextToken?: string;
 }
@@ -977,98 +977,98 @@ export interface ListGroupMembershipsForMemberRequest {
  */
 export interface ListGroupMembershipsForMemberResponse {
     /**
-     * @public
      * <p>A list of <code>GroupMembership</code> objects in the group for a specified member.</p>
+     * @public
      */
     GroupMemberships: GroupMembership[] | undefined;
     /**
-     * @public
      * <p>The pagination token used for the <code>ListUsers</code>, <code>ListGroups</code>, and <code>ListGroupMemberships</code> API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.
      *          </p>
+     * @public
      */
     NextToken?: string;
 }
 /**
- * @public
  * <p>The email address associated with the user.</p>
+ * @public
  */
 export interface Email {
     /**
-     * @public
      * <p>A string containing an email address. For example, "johndoe@amazon.com."</p>
+     * @public
      */
     Value?: string;
     /**
-     * @public
      * <p>A string representing the type of address. For example, "Work."</p>
+     * @public
      */
     Type?: string;
     /**
-     * @public
      * <p>A Boolean value representing whether this is the primary email address for the
      *          associated resource.</p>
+     * @public
      */
     Primary?: boolean;
 }
 /**
- * @public
  * <p>The
  *          full name
  *          of the user.</p>
+ * @public
  */
 export interface Name {
     /**
-     * @public
      * <p>A string containing a formatted version of the name for display.</p>
+     * @public
      */
     Formatted?: string;
     /**
-     * @public
      * <p>The family name of the user.</p>
+     * @public
      */
     FamilyName?: string;
     /**
-     * @public
      * <p>The given name of the user.</p>
+     * @public
      */
     GivenName?: string;
     /**
-     * @public
      * <p>The middle name of the user.</p>
+     * @public
      */
     MiddleName?: string;
     /**
-     * @public
      * <p>The honorific prefix of the user. For example, "Dr."</p>
+     * @public
      */
     HonorificPrefix?: string;
     /**
-     * @public
      * <p>The honorific suffix of the user. For example, "M.D."</p>
+     * @public
      */
     HonorificSuffix?: string;
 }
 /**
- * @public
  * <p>The phone number associated with the user.</p>
+ * @public
  */
 export interface PhoneNumber {
     /**
-     * @public
      * <p>A string containing a phone number. For example,
      *          "8675309"
      *          or "+1 (800) 123-4567".</p>
+     * @public
      */
     Value?: string;
     /**
-     * @public
      * <p>A string representing the type of a phone number. For example, "Mobile."</p>
+     * @public
      */
     Type?: string;
     /**
-     * @public
      * <p>A Boolean value representing whether this is the primary phone number for the associated
      *          resource.</p>
+     * @public
      */
     Primary?: boolean;
 }
@@ -1077,81 +1077,81 @@ export interface PhoneNumber {
  */
 export interface CreateUserRequest {
     /**
-     * @public
      * <p>The globally unique identifier for the identity store.</p>
+     * @public
      */
     IdentityStoreId: string | undefined;
     /**
-     * @public
      * <p>A unique string used to identify the user. The length limit is 128 characters. This
      *          value can consist of letters, accented characters, symbols, numbers, and punctuation. This
      *          value is specified at the time the user is created and stored as an attribute of the user
      *          object in the identity store. <code>Administrator</code> and <code>AWSAdministrators</code>
      *          are reserved names and can't be used for users or groups.</p>
+     * @public
      */
     UserName?: string;
     /**
-     * @public
      * <p>An object containing the name of the user.</p>
+     * @public
      */
     Name?: Name;
     /**
-     * @public
      * <p>A string containing the name of the user. This value is typically formatted for display
      *          when the user is referenced. For example, "John Doe." </p>
+     * @public
      */
     DisplayName?: string;
     /**
-     * @public
      * <p>A string containing an alternate name for the user.</p>
+     * @public
      */
     NickName?: string;
     /**
-     * @public
      * <p>A string containing a URL that might be associated with the user.</p>
+     * @public
      */
     ProfileUrl?: string;
     /**
-     * @public
      * <p>A list of <code>Email</code> objects containing email addresses associated with the user.</p>
+     * @public
      */
     Emails?: Email[];
     /**
-     * @public
      * <p>A list of <code>Address</code> objects containing addresses associated with the user.</p>
+     * @public
      */
     Addresses?: Address[];
     /**
-     * @public
      * <p>A list of <code>PhoneNumber</code> objects containing phone numbers associated with the user.</p>
+     * @public
      */
     PhoneNumbers?: PhoneNumber[];
     /**
-     * @public
      * <p>A string indicating the type of user. Possible values are left unspecified. The value
      *          can vary based on your specific use case.</p>
+     * @public
      */
     UserType?: string;
     /**
-     * @public
      * <p>A string containing the title of the user. Possible values are left unspecified. The
      *          value can vary based on your specific use case.</p>
+     * @public
      */
     Title?: string;
     /**
-     * @public
      * <p>A string containing the preferred language of the user. For example, "American English"
      *          or "en-us."</p>
+     * @public
      */
     PreferredLanguage?: string;
     /**
-     * @public
      * <p>A string containing the geographical region or location of the user.</p>
+     * @public
      */
     Locale?: string;
     /**
-     * @public
      * <p>A string containing the time zone of the user.</p>
+     * @public
      */
     Timezone?: string;
 }
@@ -1160,13 +1160,13 @@ export interface CreateUserRequest {
  */
 export interface CreateUserResponse {
     /**
-     * @public
      * <p>The identifier of the newly created user in the identity store.</p>
+     * @public
      */
     UserId: string | undefined;
     /**
-     * @public
      * <p>The globally unique identifier for the identity store.</p>
+     * @public
      */
     IdentityStoreId: string | undefined;
 }
@@ -1175,13 +1175,13 @@ export interface CreateUserResponse {
  */
 export interface DeleteUserRequest {
     /**
-     * @public
      * <p>The globally unique identifier for the identity store.</p>
+     * @public
      */
     IdentityStoreId: string | undefined;
     /**
-     * @public
      * <p>The identifier for a user in the identity store.</p>
+     * @public
      */
     UserId: string | undefined;
 }
@@ -1195,17 +1195,17 @@ export interface DeleteUserResponse {
  */
 export interface DescribeUserRequest {
     /**
-     * @public
      * <p>The globally unique identifier for the identity store, such as
      *          <code>d-1234567890</code>. In this example, <code>d-</code> is a fixed prefix, and
      *             <code>1234567890</code> is a randomly generated string that contains numbers and lower
      *          case letters. This value is generated at the time that a new identity store is
      *          created.</p>
+     * @public
      */
     IdentityStoreId: string | undefined;
     /**
-     * @public
      * <p>The identifier for a user in the identity store.</p>
+     * @public
      */
     UserId: string | undefined;
 }
@@ -1214,86 +1214,86 @@ export interface DescribeUserRequest {
  */
 export interface DescribeUserResponse {
     /**
-     * @public
      * <p>A unique string used to identify the user. The length limit is 128 characters. This value can consist of
      *          letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is
      *          created and stored as an attribute of the user object in the identity store.</p>
+     * @public
      */
     UserName?: string;
     /**
-     * @public
      * <p>The identifier for a user in the identity store.</p>
+     * @public
      */
     UserId: string | undefined;
     /**
-     * @public
      * <p>A list of <code>ExternalId</code> objects that contains the identifiers issued to this
      *          resource by an external identity provider.</p>
+     * @public
      */
     ExternalIds?: ExternalId[];
     /**
-     * @public
      * <p>The name of the user.</p>
+     * @public
      */
     Name?: Name;
     /**
-     * @public
      * <p>The display name of the user.</p>
+     * @public
      */
     DisplayName?: string;
     /**
-     * @public
      * <p>An alternative descriptive name for the user.</p>
+     * @public
      */
     NickName?: string;
     /**
-     * @public
      * <p>A URL link for the user's profile.</p>
+     * @public
      */
     ProfileUrl?: string;
     /**
-     * @public
      * <p>The email address of the user.</p>
+     * @public
      */
     Emails?: Email[];
     /**
-     * @public
      * <p>The physical address of the user.</p>
+     * @public
      */
     Addresses?: Address[];
     /**
-     * @public
      * <p>A list of <code>PhoneNumber</code> objects associated with a user.</p>
+     * @public
      */
     PhoneNumbers?: PhoneNumber[];
     /**
-     * @public
      * <p>A string indicating the type of user.</p>
+     * @public
      */
     UserType?: string;
     /**
-     * @public
      * <p>A string containing the title of the user.</p>
+     * @public
      */
     Title?: string;
     /**
-     * @public
      * <p>The preferred language of the user.</p>
+     * @public
      */
     PreferredLanguage?: string;
     /**
-     * @public
      * <p>A string containing the geographical region or location of the user.</p>
+     * @public
      */
     Locale?: string;
     /**
-     * @public
      * <p>The time zone for a user.</p>
+     * @public
      */
     Timezone?: string;
     /**
-     * @public
      * <p>The globally unique identifier for the identity store.</p>
+     * @public
      */
     IdentityStoreId: string | undefined;
 }
@@ -1302,128 +1302,128 @@ export interface DescribeUserResponse {
  */
 export interface ListUsersRequest {
     /**
-     * @public
      * <p>The globally unique identifier for the identity store, such as
      *          <code>d-1234567890</code>. In this example, <code>d-</code> is a fixed prefix, and
      *             <code>1234567890</code> is a randomly generated string that contains numbers and lower
      *          case letters. This value is generated at the time that a new identity store is
      *          created.</p>
+     * @public
      */
     IdentityStoreId: string | undefined;
     /**
-     * @public
      * <p>The maximum number of results to be returned per request. This parameter is used in the
      *             <code>ListUsers</code> and <code>ListGroups</code> requests to specify how many results
      *          to return in one page. The length limit is 50 characters.</p>
+     * @public
      */
     MaxResults?: number;
     /**
-     * @public
      * <p>The pagination token used for the <code>ListUsers</code> and <code>ListGroups</code> API
      *          operations. This value is generated by the identity store service. It is returned in the
      *          API response if the total results are more than the size of one page. This token is also
      *          returned when it is used in the API request to search for the next page.</p>
+     * @public
      */
     NextToken?: string;
     /**
-     * @public
      * @deprecated
      *
      * <p>A list of <code>Filter</code> objects, which is used in the <code>ListUsers</code> and
      *             <code>ListGroups</code> requests. </p>
+     * @public
      */
     Filters?: Filter[];
 }
 /**
- * @public
  * <p>A user object that contains the metadata and attributes for a specified user.</p>
+ * @public
  */
 export interface User {
     /**
-     * @public
      * <p>A unique string used to identify the user. The length limit is 128 characters. This value can
      *          consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is
      *          created and stored as an attribute of the user object in the identity store.</p>
+     * @public
      */
     UserName?: string;
     /**
-     * @public
      * <p>The identifier for a user in the identity store.</p>
+     * @public
      */
     UserId: string | undefined;
     /**
-     * @public
      * <p>A list of <code>ExternalId</code> objects that contains the identifiers issued to this
      *          resource by an external identity provider.</p>
+     * @public
      */
     ExternalIds?: ExternalId[];
     /**
-     * @public
      * <p>An object containing the name of the user.</p>
+     * @public
      */
     Name?: Name;
     /**
-     * @public
      * <p>A string containing the  name of the user that is formatted for display when the user is
      *          referenced. For example, "John Doe."</p>
+     * @public
      */
     DisplayName?: string;
     /**
-     * @public
      * <p>A string containing an alternate name for the user.</p>
+     * @public
      */
     NickName?: string;
     /**
-     * @public
      * <p>A string containing a URL that might be associated with the user.</p>
+     * @public
      */
     ProfileUrl?: string;
     /**
-     * @public
      * <p>A list of <code>Email</code> objects containing email addresses associated with the user.</p>
+     * @public
      */
     Emails?: Email[];
     /**
-     * @public
      * <p>A list of <code>Address</code> objects containing addresses associated with the user.</p>
+     * @public
      */
     Addresses?: Address[];
     /**
-     * @public
      * <p>A list of <code>PhoneNumber</code> objects containing phone numbers associated with the user.</p>
+     * @public
      */
     PhoneNumbers?: PhoneNumber[];
     /**
-     * @public
      * <p>A string indicating the type of user. Possible values are left unspecified. The value
      *          can vary based on your specific use case.</p>
+     * @public
      */
     UserType?: string;
     /**
-     * @public
      * <p>A string containing the title of the user. Possible values are left unspecified. The
      *          value can vary based on your specific use case.</p>
+     * @public
      */
     Title?: string;
     /**
-     * @public
      * <p>A string containing the preferred language of the user. For example, "American English"
      *          or "en-us."</p>
+     * @public
      */
     PreferredLanguage?: string;
     /**
-     * @public
      * <p>A string containing the geographical region or location of the user.</p>
+     * @public
      */
     Locale?: string;
     /**
-     * @public
      * <p>A string containing the time zone of the user.</p>
+     * @public
      */
     Timezone?: string;
     /**
-     * @public
      * <p>The globally unique identifier for the identity store.</p>
+     * @public
      */
     IdentityStoreId: string | undefined;
 }
@@ -1432,16 +1432,16 @@ export interface User {
  */
 export interface ListUsersResponse {
     /**
-     * @public
      * <p>A list of <code>User</code> objects in the identity store.</p>
+     * @public
      */
     Users: User[] | undefined;
     /**
-     * @public
      * <p>The pagination token used for the <code>ListUsers</code> and <code>ListGroups</code> API
      *          operations. This value is generated by the identity store service. It is returned in the
      *          API response if the total results are more than the size of one page. This token is also
      *          returned when it is used in the API request to search for the next page.</p>
+     * @public
      */
     NextToken?: string;
 }
@@ -1450,19 +1450,19 @@ export interface ListUsersResponse {
  */
 export interface UpdateUserRequest {
     /**
-     * @public
      * <p>The globally unique identifier for the identity store.</p>
+     * @public
      */
     IdentityStoreId: string | undefined;
     /**
-     * @public
      * <p>The identifier for a user in the identity store.</p>
+     * @public
      */
     UserId: string | undefined;
     /**
-     * @public
      * <p>A list of <code>AttributeOperation</code> objects to apply to the requested user. These
      *          operations might add, replace, or remove an attribute.</p>
+     * @public
      */
     Operations: AttributeOperation[] | undefined;
 }