@aws-sdk/client-identitystore 3.296.0 → 3.298.0

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

@@ -2,6 +2,7 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-cl
 import { DocumentType as __DocumentType } from "@aws-sdk/types";
 import { IdentitystoreServiceException as __BaseException } from "./IdentitystoreServiceException";
 /**
+ * @public
  * <p>You do not have sufficient access to perform this action.</p>
  */
 export declare class AccessDeniedException extends __BaseException {
@@ -20,6 +21,7 @@ export declare class AccessDeniedException extends __BaseException {
     constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
 }
 /**
+ * @public
  * <p>The address associated with the specified user.</p>
  */
 export interface Address {
@@ -65,6 +67,7 @@ export interface Address {
     Primary?: boolean;
 }
 /**
+ * @public
  * <p>The identifier issued to this resource by an external identity provider.</p>
  */
 export interface ExternalId {
@@ -78,6 +81,7 @@ export interface ExternalId {
     Id: string | undefined;
 }
 /**
+ * @public
  * <p>An entity attribute that's unique to a specific entity.</p>
  */
 export interface UniqueAttribute {
@@ -93,11 +97,15 @@ export interface UniqueAttribute {
     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. For example, a
  *          unique <code>GroupDisplayName</code>.</p>
  */
 export type AlternateIdentifier = AlternateIdentifier.ExternalIdMember | AlternateIdentifier.UniqueAttributeMember | AlternateIdentifier.$UnknownMember;
+/**
+ * @public
+ */
 export declare namespace AlternateIdentifier {
     /**
      * <p>The identifier issued to this resource by an external identity provider.</p>
@@ -128,6 +136,7 @@ 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>
  */
 export interface AttributeOperation {
@@ -142,6 +151,9 @@ export interface AttributeOperation {
      */
     AttributeValue?: __DocumentType;
 }
+/**
+ * @public
+ */
 export interface GetGroupIdRequest {
     /**
      * <p>The globally unique identifier for the identity store.</p>
@@ -154,6 +166,9 @@ export interface GetGroupIdRequest {
      */
     AlternateIdentifier: AlternateIdentifier | undefined;
 }
+/**
+ * @public
+ */
 export interface GetGroupIdResponse {
     /**
      * <p>The identifier for a group in the identity store.</p>
@@ -165,6 +180,7 @@ export interface GetGroupIdResponse {
     IdentityStoreId: string | undefined;
 }
 /**
+ * @public
  * <p>The request processing has failed because of an unknown error, exception or failure with an internal server.</p>
  */
 export declare class InternalServerException extends __BaseException {
@@ -187,6 +203,9 @@ export declare class InternalServerException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
 }
+/**
+ * @public
+ */
 export declare enum ResourceType {
     GROUP = "GROUP",
     GROUP_MEMBERSHIP = "GROUP_MEMBERSHIP",
@@ -194,6 +213,7 @@ export declare enum ResourceType {
     USER = "USER"
 }
 /**
+ * @public
  * <p>Indicates that a requested resource is not found.</p>
  */
 export declare class ResourceNotFoundException extends __BaseException {
@@ -220,6 +240,7 @@ 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>
  */
 export declare class ThrottlingException extends __BaseException {
@@ -246,6 +267,7 @@ export declare class ThrottlingException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request failed because it contains a syntax error.</p>
  */
 export declare class ValidationException extends __BaseException {
@@ -264,9 +286,13 @@ export declare class ValidationException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
 }
 /**
+ * @public
  * <p>An object containing the identifier of a group member.</p>
  */
 export type MemberId = MemberId.UserIdMember | MemberId.$UnknownMember;
+/**
+ * @public
+ */
 export declare namespace MemberId {
     /**
      * <p>An object containing the identifiers of resources that can be members.</p>
@@ -285,6 +311,9 @@ export declare namespace MemberId {
     }
     const visit: <T>(value: MemberId, visitor: Visitor<T>) => T;
 }
+/**
+ * @public
+ */
 export interface GetGroupMembershipIdRequest {
     /**
      * <p>The globally unique identifier for the identity store.</p>
@@ -299,6 +328,9 @@ export interface GetGroupMembershipIdRequest {
      */
     MemberId: MemberId | undefined;
 }
+/**
+ * @public
+ */
 export interface GetGroupMembershipIdResponse {
     /**
      * <p>The identifier for a <code>GroupMembership</code> in an identity store.</p>
@@ -309,6 +341,9 @@ export interface GetGroupMembershipIdResponse {
      */
     IdentityStoreId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetUserIdRequest {
     /**
      * <p>The globally unique identifier for the identity store.</p>
@@ -321,6 +356,9 @@ export interface GetUserIdRequest {
      */
     AlternateIdentifier: AlternateIdentifier | undefined;
 }
+/**
+ * @public
+ */
 export interface GetUserIdResponse {
     /**
      * <p>The identifier for a user in the identity store.</p>
@@ -331,11 +369,15 @@ export interface GetUserIdResponse {
      */
     IdentityStoreId: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum ConflictExceptionReason {
     CONCURRENT_MODIFICATION = "CONCURRENT_MODIFICATION",
     UNIQUENESS_CONSTRAINT_VIOLATION = "UNIQUENESS_CONSTRAINT_VIOLATION"
 }
 /**
+ * @public
  * <p>This request cannot be completed for one of the following reasons:</p>
  *          <ul>
  *             <li>
@@ -371,6 +413,9 @@ export declare class ConflictException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface CreateGroupMembershipRequest {
     /**
      * <p>The globally unique identifier for the identity store.</p>
@@ -385,6 +430,9 @@ export interface CreateGroupMembershipRequest {
      */
     MemberId: MemberId | undefined;
 }
+/**
+ * @public
+ */
 export interface CreateGroupMembershipResponse {
     /**
      * <p>The identifier for a newly created <code>GroupMembership</code> in an identity store.</p>
@@ -396,6 +444,7 @@ export interface CreateGroupMembershipResponse {
     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>
  */
 export declare class ServiceQuotaExceededException extends __BaseException {
@@ -411,6 +460,9 @@ export declare class ServiceQuotaExceededException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface DeleteGroupMembershipRequest {
     /**
      * <p>The globally unique identifier for the identity store.</p>
@@ -421,8 +473,14 @@ export interface DeleteGroupMembershipRequest {
      */
     MembershipId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteGroupMembershipResponse {
 }
+/**
+ * @public
+ */
 export interface DescribeGroupMembershipRequest {
     /**
      * <p>The globally unique identifier for the identity store.</p>
@@ -433,6 +491,9 @@ export interface DescribeGroupMembershipRequest {
      */
     MembershipId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeGroupMembershipResponse {
     /**
      * <p>The globally unique identifier for the identity store.</p>
@@ -451,6 +512,9 @@ export interface DescribeGroupMembershipResponse {
      */
     MemberId: MemberId | undefined;
 }
+/**
+ * @public
+ */
 export interface ListGroupMembershipsRequest {
     /**
      * <p>The globally unique identifier for the identity store.</p>
@@ -471,6 +535,7 @@ export interface ListGroupMembershipsRequest {
     NextToken?: string;
 }
 /**
+ * @public
  * <p>Contains the identifiers for a group, a group member, and a <code>GroupMembership</code>
  *          object in the identity store.</p>
  */
@@ -492,6 +557,9 @@ export interface GroupMembership {
      */
     MemberId?: MemberId;
 }
+/**
+ * @public
+ */
 export interface ListGroupMembershipsResponse {
     /**
      * <p>A list of <code>GroupMembership</code> objects in the group.</p>
@@ -502,6 +570,9 @@ export interface ListGroupMembershipsResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface CreateGroupRequest {
     /**
      * <p>The globally unique identifier for the identity store.</p>
@@ -516,6 +587,9 @@ export interface CreateGroupRequest {
      */
     Description?: string;
 }
+/**
+ * @public
+ */
 export interface CreateGroupResponse {
     /**
      * <p>The
@@ -528,6 +602,9 @@ export interface CreateGroupResponse {
      */
     IdentityStoreId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteGroupRequest {
     /**
      * <p>The globally unique identifier for the identity store.</p>
@@ -538,8 +615,14 @@ export interface DeleteGroupRequest {
      */
     GroupId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteGroupResponse {
 }
+/**
+ * @public
+ */
 export interface DescribeGroupRequest {
     /**
      * <p>The globally unique identifier for the identity store, such as
@@ -554,6 +637,9 @@ export interface DescribeGroupRequest {
      */
     GroupId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeGroupResponse {
     /**
      * <p>The identifier for a group in the identity store.</p>
@@ -582,6 +668,7 @@ export interface DescribeGroupResponse {
     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>
  */
@@ -599,6 +686,9 @@ export interface Filter {
      */
     AttributeValue: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListGroupsRequest {
     /**
      * <p>The globally unique identifier for the identity store, such as
@@ -630,6 +720,7 @@ export interface ListGroupsRequest {
     Filters?: Filter[];
 }
 /**
+ * @public
  * <p>A group object that contains a specified group’s metadata and attributes.</p>
  */
 export interface Group {
@@ -658,6 +749,9 @@ export interface Group {
      */
     IdentityStoreId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListGroupsResponse {
     /**
      * <p>A list of <code>Group</code> objects in the identity store.</p>
@@ -671,6 +765,9 @@ export interface ListGroupsResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface UpdateGroupRequest {
     /**
      * <p>The globally unique identifier for the identity store.</p>
@@ -686,8 +783,14 @@ export interface UpdateGroupRequest {
      */
     Operations: AttributeOperation[] | undefined;
 }
+/**
+ * @public
+ */
 export interface UpdateGroupResponse {
 }
+/**
+ * @public
+ */
 export interface IsMemberInGroupsRequest {
     /**
      * <p>The globally unique identifier for the identity store.</p>
@@ -703,6 +806,7 @@ export interface IsMemberInGroupsRequest {
     GroupIds: string[] | undefined;
 }
 /**
+ * @public
  * <p>Indicates whether a resource is a member of a group in the identity store.</p>
  */
 export interface GroupMembershipExistenceResult {
@@ -719,12 +823,18 @@ export interface GroupMembershipExistenceResult {
      */
     MembershipExists?: boolean;
 }
+/**
+ * @public
+ */
 export interface IsMemberInGroupsResponse {
     /**
      * <p>A list containing the results of membership existence checks.</p>
      */
     Results: GroupMembershipExistenceResult[] | undefined;
 }
+/**
+ * @public
+ */
 export interface ListGroupMembershipsForMemberRequest {
     /**
      * <p>The globally unique identifier for the identity store.</p>
@@ -743,6 +853,9 @@ export interface ListGroupMembershipsForMemberRequest {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListGroupMembershipsForMemberResponse {
     /**
      * <p>A list of <code>GroupMembership</code> objects in the group for a specified member.</p>
@@ -755,6 +868,7 @@ export interface ListGroupMembershipsForMemberResponse {
     NextToken?: string;
 }
 /**
+ * @public
  * <p>The email address associated with the user.</p>
  */
 export interface Email {
@@ -777,6 +891,7 @@ export interface Email {
     Primary?: boolean;
 }
 /**
+ * @public
  * <p>The
  *          full name
  *          of the user.</p>
@@ -808,6 +923,7 @@ export interface Name {
     HonorificSuffix?: string;
 }
 /**
+ * @public
  * <p>The phone number associated with the user.</p>
  */
 export interface PhoneNumber {
@@ -830,6 +946,9 @@ export interface PhoneNumber {
      */
     Primary?: boolean;
 }
+/**
+ * @public
+ */
 export interface CreateUserRequest {
     /**
      * <p>The globally unique identifier for the identity store.</p>
@@ -892,6 +1011,9 @@ export interface CreateUserRequest {
      */
     Timezone?: string;
 }
+/**
+ * @public
+ */
 export interface CreateUserResponse {
     /**
      * <p>The identifier of the newly created user in the identity store.</p>
@@ -902,6 +1024,9 @@ export interface CreateUserResponse {
      */
     IdentityStoreId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteUserRequest {
     /**
      * <p>The globally unique identifier for the identity store.</p>
@@ -912,8 +1037,14 @@ export interface DeleteUserRequest {
      */
     UserId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteUserResponse {
 }
+/**
+ * @public
+ */
 export interface DescribeUserRequest {
     /**
      * <p>The globally unique identifier for the identity store, such as
@@ -928,6 +1059,9 @@ export interface DescribeUserRequest {
      */
     UserId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeUserResponse {
     /**
      * <p>A unique string used to identify the user. The length limit is 128 characters. This value can consist of
@@ -997,6 +1131,9 @@ export interface DescribeUserResponse {
      */
     IdentityStoreId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListUsersRequest {
     /**
      * <p>The globally unique identifier for the identity store, such as
@@ -1028,6 +1165,7 @@ export interface ListUsersRequest {
     Filters?: Filter[];
 }
 /**
+ * @public
  * <p>A user object that contains a specified user’s metadata and attributes.</p>
  */
 export interface User {
@@ -1105,6 +1243,9 @@ export interface User {
      */
     IdentityStoreId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListUsersResponse {
     /**
      * <p>A list of <code>User</code> objects in the identity store.</p>
@@ -1118,6 +1259,9 @@ export interface ListUsersResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface UpdateUserRequest {
     /**
      * <p>The globally unique identifier for the identity store.</p>
@@ -1133,6 +1277,9 @@ export interface UpdateUserRequest {
      */
     Operations: AttributeOperation[] | undefined;
 }
+/**
+ * @public
+ */
 export interface UpdateUserResponse {
 }
 /**
@@ -1143,102 +1290,22 @@ export declare const AddressFilterSensitiveLog: (obj: Address) => any;
  * @internal
  */
 export declare const ExternalIdFilterSensitiveLog: (obj: ExternalId) => any;
-/**
- * @internal
- */
-export declare const UniqueAttributeFilterSensitiveLog: (obj: UniqueAttribute) => any;
 /**
  * @internal
  */
 export declare const AlternateIdentifierFilterSensitiveLog: (obj: AlternateIdentifier) => any;
-/**
- * @internal
- */
-export declare const AttributeOperationFilterSensitiveLog: (obj: AttributeOperation) => any;
 /**
  * @internal
  */
 export declare const GetGroupIdRequestFilterSensitiveLog: (obj: GetGroupIdRequest) => any;
-/**
- * @internal
- */
-export declare const GetGroupIdResponseFilterSensitiveLog: (obj: GetGroupIdResponse) => any;
-/**
- * @internal
- */
-export declare const MemberIdFilterSensitiveLog: (obj: MemberId) => any;
-/**
- * @internal
- */
-export declare const GetGroupMembershipIdRequestFilterSensitiveLog: (obj: GetGroupMembershipIdRequest) => any;
-/**
- * @internal
- */
-export declare const GetGroupMembershipIdResponseFilterSensitiveLog: (obj: GetGroupMembershipIdResponse) => any;
 /**
  * @internal
  */
 export declare const GetUserIdRequestFilterSensitiveLog: (obj: GetUserIdRequest) => any;
-/**
- * @internal
- */
-export declare const GetUserIdResponseFilterSensitiveLog: (obj: GetUserIdResponse) => any;
-/**
- * @internal
- */
-export declare const CreateGroupMembershipRequestFilterSensitiveLog: (obj: CreateGroupMembershipRequest) => any;
-/**
- * @internal
- */
-export declare const CreateGroupMembershipResponseFilterSensitiveLog: (obj: CreateGroupMembershipResponse) => any;
-/**
- * @internal
- */
-export declare const DeleteGroupMembershipRequestFilterSensitiveLog: (obj: DeleteGroupMembershipRequest) => any;
-/**
- * @internal
- */
-export declare const DeleteGroupMembershipResponseFilterSensitiveLog: (obj: DeleteGroupMembershipResponse) => any;
-/**
- * @internal
- */
-export declare const DescribeGroupMembershipRequestFilterSensitiveLog: (obj: DescribeGroupMembershipRequest) => any;
-/**
- * @internal
- */
-export declare const DescribeGroupMembershipResponseFilterSensitiveLog: (obj: DescribeGroupMembershipResponse) => any;
-/**
- * @internal
- */
-export declare const ListGroupMembershipsRequestFilterSensitiveLog: (obj: ListGroupMembershipsRequest) => any;
-/**
- * @internal
- */
-export declare const GroupMembershipFilterSensitiveLog: (obj: GroupMembership) => any;
-/**
- * @internal
- */
-export declare const ListGroupMembershipsResponseFilterSensitiveLog: (obj: ListGroupMembershipsResponse) => any;
 /**
  * @internal
  */
 export declare const CreateGroupRequestFilterSensitiveLog: (obj: CreateGroupRequest) => any;
-/**
- * @internal
- */
-export declare const CreateGroupResponseFilterSensitiveLog: (obj: CreateGroupResponse) => any;
-/**
- * @internal
- */
-export declare const DeleteGroupRequestFilterSensitiveLog: (obj: DeleteGroupRequest) => any;
-/**
- * @internal
- */
-export declare const DeleteGroupResponseFilterSensitiveLog: (obj: DeleteGroupResponse) => any;
-/**
- * @internal
- */
-export declare const DescribeGroupRequestFilterSensitiveLog: (obj: DescribeGroupRequest) => any;
 /**
  * @internal
  */
@@ -1259,18 +1326,6 @@ export declare const GroupFilterSensitiveLog: (obj: Group) => any;
  * @internal
  */
 export declare const ListGroupsResponseFilterSensitiveLog: (obj: ListGroupsResponse) => any;
-/**
- * @internal
- */
-export declare const UpdateGroupRequestFilterSensitiveLog: (obj: UpdateGroupRequest) => any;
-/**
- * @internal
- */
-export declare const UpdateGroupResponseFilterSensitiveLog: (obj: UpdateGroupResponse) => any;
-/**
- * @internal
- */
-export declare const IsMemberInGroupsRequestFilterSensitiveLog: (obj: IsMemberInGroupsRequest) => any;
 /**
  * @internal
  */
@@ -1279,14 +1334,6 @@ export declare const GroupMembershipExistenceResultFilterSensitiveLog: (obj: Gro
  * @internal
  */
 export declare const IsMemberInGroupsResponseFilterSensitiveLog: (obj: IsMemberInGroupsResponse) => any;
-/**
- * @internal
- */
-export declare const ListGroupMembershipsForMemberRequestFilterSensitiveLog: (obj: ListGroupMembershipsForMemberRequest) => any;
-/**
- * @internal
- */
-export declare const ListGroupMembershipsForMemberResponseFilterSensitiveLog: (obj: ListGroupMembershipsForMemberResponse) => any;
 /**
  * @internal
  */
@@ -1303,22 +1350,6 @@ export declare const PhoneNumberFilterSensitiveLog: (obj: PhoneNumber) => any;
  * @internal
  */
 export declare const CreateUserRequestFilterSensitiveLog: (obj: CreateUserRequest) => any;
-/**
- * @internal
- */
-export declare const CreateUserResponseFilterSensitiveLog: (obj: CreateUserResponse) => any;
-/**
- * @internal
- */
-export declare const DeleteUserRequestFilterSensitiveLog: (obj: DeleteUserRequest) => any;
-/**
- * @internal
- */
-export declare const DeleteUserResponseFilterSensitiveLog: (obj: DeleteUserResponse) => any;
-/**
- * @internal
- */
-export declare const DescribeUserRequestFilterSensitiveLog: (obj: DescribeUserRequest) => any;
 /**
  * @internal
  */
@@ -1335,11 +1366,3 @@ export declare const UserFilterSensitiveLog: (obj: User) => any;
  * @internal
  */
 export declare const ListUsersResponseFilterSensitiveLog: (obj: ListUsersResponse) => any;
-/**
- * @internal
- */
-export declare const UpdateUserRequestFilterSensitiveLog: (obj: UpdateUserRequest) => any;
-/**
- * @internal
- */
-export declare const UpdateUserResponseFilterSensitiveLog: (obj: UpdateUserResponse) => any;

package/dist-types/pagination/Interfaces.d.ts

@@ -1,5 +1,8 @@
 import { PaginationConfiguration } from "@aws-sdk/types";
 import { IdentitystoreClient } from "../IdentitystoreClient";
+/**
+ * @public
+ */
 export interface IdentitystorePaginationConfiguration extends PaginationConfiguration {
     client: IdentitystoreClient;
 }