@aws-sdk/client-cognito-identity-provider 3.296.0 → 3.298.0

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

@@ -2,6 +2,7 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-cl
 import { CognitoIdentityProviderServiceException as __BaseException } from "./CognitoIdentityProviderServiceException";
 import { AccountRecoverySettingType, AdminCreateUserConfigType, AnalyticsConfigurationType, AnalyticsMetadataType, AttributeType, CodeDeliveryDetailsType, CustomDomainConfigType, DeletionProtectionType, DeviceConfigurationType, DeviceRememberedStatusType, EmailConfigurationType, ExplicitAuthFlowsType, FeedbackValueType, GroupType, IdentityProviderType, LambdaConfigType, OAuthFlowType, PreventUserExistenceErrorTypes, ResourceServerScopeType, ResourceServerType, SmsConfigurationType, TokenValidityUnitsType, UserAttributeUpdateSettingsType, UserContextDataType, UserImportJobType, UserPoolAddOnsType, UserPoolClientType, UserPoolMfaType, UserPoolPolicyType, VerificationMessageTemplateType, VerifiedAttributeType } from "./models_0";
 /**
+ * @public
  * <p>Represents the request to register a user.</p>
  */
 export interface SignUpRequest {
@@ -82,6 +83,7 @@ export interface SignUpRequest {
     ClientMetadata?: Record<string, string>;
 }
 /**
+ * @public
  * <p>The response from the server for a registration request.</p>
  */
 export interface SignUpResponse {
@@ -102,6 +104,7 @@ export interface SignUpResponse {
     UserSub: string | undefined;
 }
 /**
+ * @public
  * <p>Represents the request to start the user import job.</p>
  */
 export interface StartUserImportJobRequest {
@@ -115,6 +118,7 @@ export interface StartUserImportJobRequest {
     JobId: string | undefined;
 }
 /**
+ * @public
  * <p>Represents the response from the server to the request to start the user import
  *             job.</p>
  */
@@ -125,6 +129,7 @@ export interface StartUserImportJobResponse {
     UserImportJob?: UserImportJobType;
 }
 /**
+ * @public
  * <p>Represents the request to stop the user import job.</p>
  */
 export interface StopUserImportJobRequest {
@@ -138,6 +143,7 @@ export interface StopUserImportJobRequest {
     JobId: string | undefined;
 }
 /**
+ * @public
  * <p>Represents the response from the server to the request to stop the user import
  *             job.</p>
  */
@@ -147,6 +153,9 @@ export interface StopUserImportJobResponse {
      */
     UserImportJob?: UserImportJobType;
 }
+/**
+ * @public
+ */
 export interface TagResourceRequest {
     /**
      * <p>The Amazon Resource Name (ARN) of the user pool to assign the tags to.</p>
@@ -157,8 +166,14 @@ export interface TagResourceRequest {
      */
     Tags: Record<string, string> | undefined;
 }
+/**
+ * @public
+ */
 export interface TagResourceResponse {
 }
+/**
+ * @public
+ */
 export interface UntagResourceRequest {
     /**
      * <p>The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.</p>
@@ -169,8 +184,14 @@ export interface UntagResourceRequest {
      */
     TagKeys: string[] | undefined;
 }
+/**
+ * @public
+ */
 export interface UntagResourceResponse {
 }
+/**
+ * @public
+ */
 export interface UpdateAuthEventFeedbackRequest {
     /**
      * <p>The user pool ID.</p>
@@ -193,9 +214,13 @@ export interface UpdateAuthEventFeedbackRequest {
      */
     FeedbackValue: FeedbackValueType | string | undefined;
 }
+/**
+ * @public
+ */
 export interface UpdateAuthEventFeedbackResponse {
 }
 /**
+ * @public
  * <p>Represents the request to update the device status.</p>
  */
 export interface UpdateDeviceStatusRequest {
@@ -214,10 +239,14 @@ export interface UpdateDeviceStatusRequest {
     DeviceRememberedStatus?: DeviceRememberedStatusType | string;
 }
 /**
+ * @public
  * <p>The response to the request to update the device status.</p>
  */
 export interface UpdateDeviceStatusResponse {
 }
+/**
+ * @public
+ */
 export interface UpdateGroupRequest {
     /**
      * <p>The name of the group.</p>
@@ -243,12 +272,18 @@ export interface UpdateGroupRequest {
      */
     Precedence?: number;
 }
+/**
+ * @public
+ */
 export interface UpdateGroupResponse {
     /**
      * <p>The group object for the group.</p>
      */
     Group?: GroupType;
 }
+/**
+ * @public
+ */
 export interface UpdateIdentityProviderRequest {
     /**
      * <p>The user pool ID.</p>
@@ -272,12 +307,18 @@ export interface UpdateIdentityProviderRequest {
      */
     IdpIdentifiers?: string[];
 }
+/**
+ * @public
+ */
 export interface UpdateIdentityProviderResponse {
     /**
      * <p>The identity provider details.</p>
      */
     IdentityProvider: IdentityProviderType | undefined;
 }
+/**
+ * @public
+ */
 export interface UpdateResourceServerRequest {
     /**
      * <p>The user pool ID for the user pool.</p>
@@ -296,6 +337,9 @@ export interface UpdateResourceServerRequest {
      */
     Scopes?: ResourceServerScopeType[];
 }
+/**
+ * @public
+ */
 export interface UpdateResourceServerResponse {
     /**
      * <p>The resource server.</p>
@@ -303,6 +347,7 @@ export interface UpdateResourceServerResponse {
     ResourceServer: ResourceServerType | undefined;
 }
 /**
+ * @public
  * <p>Represents the request to update user attributes.</p>
  */
 export interface UpdateUserAttributesRequest {
@@ -360,6 +405,7 @@ export interface UpdateUserAttributesRequest {
     ClientMetadata?: Record<string, string>;
 }
 /**
+ * @public
  * <p>Represents the response from the server for the request to update user
  *             attributes.</p>
  */
@@ -371,6 +417,7 @@ export interface UpdateUserAttributesResponse {
     CodeDeliveryDetailsList?: CodeDeliveryDetailsType[];
 }
 /**
+ * @public
  * <p>Represents the request to update the user pool.</p>
  */
 export interface UpdateUserPoolRequest {
@@ -497,12 +544,14 @@ export interface UpdateUserPoolRequest {
     AccountRecoverySetting?: AccountRecoverySettingType;
 }
 /**
+ * @public
  * <p>Represents the response from the server when you make a request to update the user
  *             pool.</p>
  */
 export interface UpdateUserPoolResponse {
 }
 /**
+ * @public
  * <p>Represents the request to update the user pool client.</p>
  */
 export interface UpdateUserPoolClientRequest {
@@ -760,6 +809,7 @@ export interface UpdateUserPoolClientRequest {
     AuthSessionValidity?: number;
 }
 /**
+ * @public
  * <p>Represents the response from the server to the request to update the user pool
  *             client.</p>
  */
@@ -771,6 +821,7 @@ export interface UpdateUserPoolClientResponse {
     UserPoolClient?: UserPoolClientType;
 }
 /**
+ * @public
  * <p>The UpdateUserPoolDomain request input.</p>
  */
 export interface UpdateUserPoolDomainRequest {
@@ -794,6 +845,7 @@ export interface UpdateUserPoolDomainRequest {
     CustomDomainConfig: CustomDomainConfigType | undefined;
 }
 /**
+ * @public
  * <p>The UpdateUserPoolDomain response output.</p>
  */
 export interface UpdateUserPoolDomainResponse {
@@ -804,6 +856,7 @@ export interface UpdateUserPoolDomainResponse {
     CloudFrontDomain?: string;
 }
 /**
+ * @public
  * <p>This exception is thrown when there is a code mismatch and the service fails to
  *             configure the software token TOTP multi-factor authentication (MFA).</p>
  */
@@ -815,6 +868,9 @@ export declare class EnableSoftwareTokenMFAException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<EnableSoftwareTokenMFAException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface VerifySoftwareTokenRequest {
     /**
      * <p>A valid access token that Amazon Cognito issued to the user whose software token you want to
@@ -835,10 +891,16 @@ export interface VerifySoftwareTokenRequest {
      */
     FriendlyDeviceName?: string;
 }
+/**
+ * @public
+ */
 export declare enum VerifySoftwareTokenResponseType {
     ERROR = "ERROR",
     SUCCESS = "SUCCESS"
 }
+/**
+ * @public
+ */
 export interface VerifySoftwareTokenResponse {
     /**
      * <p>The status of the verify software token.</p>
@@ -851,6 +913,7 @@ export interface VerifySoftwareTokenResponse {
     Session?: string;
 }
 /**
+ * @public
  * <p>Represents the request to verify user attributes.</p>
  */
 export interface VerifyUserAttributeRequest {
@@ -869,6 +932,7 @@ export interface VerifyUserAttributeRequest {
     Code: string | undefined;
 }
 /**
+ * @public
  * <p>A container representing the response from the server from the request to verify user
  *             attributes.</p>
  */
@@ -878,98 +942,18 @@ export interface VerifyUserAttributeResponse {
  * @internal
  */
 export declare const SignUpRequestFilterSensitiveLog: (obj: SignUpRequest) => any;
-/**
- * @internal
- */
-export declare const SignUpResponseFilterSensitiveLog: (obj: SignUpResponse) => any;
-/**
- * @internal
- */
-export declare const StartUserImportJobRequestFilterSensitiveLog: (obj: StartUserImportJobRequest) => any;
-/**
- * @internal
- */
-export declare const StartUserImportJobResponseFilterSensitiveLog: (obj: StartUserImportJobResponse) => any;
-/**
- * @internal
- */
-export declare const StopUserImportJobRequestFilterSensitiveLog: (obj: StopUserImportJobRequest) => any;
-/**
- * @internal
- */
-export declare const StopUserImportJobResponseFilterSensitiveLog: (obj: StopUserImportJobResponse) => any;
-/**
- * @internal
- */
-export declare const TagResourceRequestFilterSensitiveLog: (obj: TagResourceRequest) => any;
-/**
- * @internal
- */
-export declare const TagResourceResponseFilterSensitiveLog: (obj: TagResourceResponse) => any;
-/**
- * @internal
- */
-export declare const UntagResourceRequestFilterSensitiveLog: (obj: UntagResourceRequest) => any;
-/**
- * @internal
- */
-export declare const UntagResourceResponseFilterSensitiveLog: (obj: UntagResourceResponse) => any;
 /**
  * @internal
  */
 export declare const UpdateAuthEventFeedbackRequestFilterSensitiveLog: (obj: UpdateAuthEventFeedbackRequest) => any;
-/**
- * @internal
- */
-export declare const UpdateAuthEventFeedbackResponseFilterSensitiveLog: (obj: UpdateAuthEventFeedbackResponse) => any;
 /**
  * @internal
  */
 export declare const UpdateDeviceStatusRequestFilterSensitiveLog: (obj: UpdateDeviceStatusRequest) => any;
-/**
- * @internal
- */
-export declare const UpdateDeviceStatusResponseFilterSensitiveLog: (obj: UpdateDeviceStatusResponse) => any;
-/**
- * @internal
- */
-export declare const UpdateGroupRequestFilterSensitiveLog: (obj: UpdateGroupRequest) => any;
-/**
- * @internal
- */
-export declare const UpdateGroupResponseFilterSensitiveLog: (obj: UpdateGroupResponse) => any;
-/**
- * @internal
- */
-export declare const UpdateIdentityProviderRequestFilterSensitiveLog: (obj: UpdateIdentityProviderRequest) => any;
-/**
- * @internal
- */
-export declare const UpdateIdentityProviderResponseFilterSensitiveLog: (obj: UpdateIdentityProviderResponse) => any;
-/**
- * @internal
- */
-export declare const UpdateResourceServerRequestFilterSensitiveLog: (obj: UpdateResourceServerRequest) => any;
-/**
- * @internal
- */
-export declare const UpdateResourceServerResponseFilterSensitiveLog: (obj: UpdateResourceServerResponse) => any;
 /**
  * @internal
  */
 export declare const UpdateUserAttributesRequestFilterSensitiveLog: (obj: UpdateUserAttributesRequest) => any;
-/**
- * @internal
- */
-export declare const UpdateUserAttributesResponseFilterSensitiveLog: (obj: UpdateUserAttributesResponse) => any;
-/**
- * @internal
- */
-export declare const UpdateUserPoolRequestFilterSensitiveLog: (obj: UpdateUserPoolRequest) => any;
-/**
- * @internal
- */
-export declare const UpdateUserPoolResponseFilterSensitiveLog: (obj: UpdateUserPoolResponse) => any;
 /**
  * @internal
  */
@@ -978,27 +962,11 @@ export declare const UpdateUserPoolClientRequestFilterSensitiveLog: (obj: Update
  * @internal
  */
 export declare const UpdateUserPoolClientResponseFilterSensitiveLog: (obj: UpdateUserPoolClientResponse) => any;
-/**
- * @internal
- */
-export declare const UpdateUserPoolDomainRequestFilterSensitiveLog: (obj: UpdateUserPoolDomainRequest) => any;
-/**
- * @internal
- */
-export declare const UpdateUserPoolDomainResponseFilterSensitiveLog: (obj: UpdateUserPoolDomainResponse) => any;
 /**
  * @internal
  */
 export declare const VerifySoftwareTokenRequestFilterSensitiveLog: (obj: VerifySoftwareTokenRequest) => any;
-/**
- * @internal
- */
-export declare const VerifySoftwareTokenResponseFilterSensitiveLog: (obj: VerifySoftwareTokenResponse) => any;
 /**
  * @internal
  */
 export declare const VerifyUserAttributeRequestFilterSensitiveLog: (obj: VerifyUserAttributeRequest) => any;
-/**
- * @internal
- */
-export declare const VerifyUserAttributeResponseFilterSensitiveLog: (obj: VerifyUserAttributeResponse) => any;

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

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { AdminListGroupsForUserCommandInput, AdminListGroupsForUserCommandOutput } from "../commands/AdminListGroupsForUserCommand";
 import { CognitoIdentityProviderPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateAdminListGroupsForUser(config: CognitoIdentityProviderPaginationConfiguration, input: AdminListGroupsForUserCommandInput, ...additionalArguments: any): Paginator<AdminListGroupsForUserCommandOutput>;

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

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { AdminListUserAuthEventsCommandInput, AdminListUserAuthEventsCommandOutput } from "../commands/AdminListUserAuthEventsCommand";
 import { CognitoIdentityProviderPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateAdminListUserAuthEvents(config: CognitoIdentityProviderPaginationConfiguration, input: AdminListUserAuthEventsCommandInput, ...additionalArguments: any): Paginator<AdminListUserAuthEventsCommandOutput>;

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

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

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

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListGroupsCommandInput, ListGroupsCommandOutput } from "../commands/ListGroupsCommand";
 import { CognitoIdentityProviderPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListGroups(config: CognitoIdentityProviderPaginationConfiguration, input: ListGroupsCommandInput, ...additionalArguments: any): Paginator<ListGroupsCommandOutput>;

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

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListIdentityProvidersCommandInput, ListIdentityProvidersCommandOutput } from "../commands/ListIdentityProvidersCommand";
 import { CognitoIdentityProviderPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListIdentityProviders(config: CognitoIdentityProviderPaginationConfiguration, input: ListIdentityProvidersCommandInput, ...additionalArguments: any): Paginator<ListIdentityProvidersCommandOutput>;

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

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListResourceServersCommandInput, ListResourceServersCommandOutput } from "../commands/ListResourceServersCommand";
 import { CognitoIdentityProviderPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListResourceServers(config: CognitoIdentityProviderPaginationConfiguration, input: ListResourceServersCommandInput, ...additionalArguments: any): Paginator<ListResourceServersCommandOutput>;

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

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListUserPoolClientsCommandInput, ListUserPoolClientsCommandOutput } from "../commands/ListUserPoolClientsCommand";
 import { CognitoIdentityProviderPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListUserPoolClients(config: CognitoIdentityProviderPaginationConfiguration, input: ListUserPoolClientsCommandInput, ...additionalArguments: any): Paginator<ListUserPoolClientsCommandOutput>;

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

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListUserPoolsCommandInput, ListUserPoolsCommandOutput } from "../commands/ListUserPoolsCommand";
 import { CognitoIdentityProviderPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListUserPools(config: CognitoIdentityProviderPaginationConfiguration, input: ListUserPoolsCommandInput, ...additionalArguments: any): Paginator<ListUserPoolsCommandOutput>;

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

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListUsersInGroupCommandInput, ListUsersInGroupCommandOutput } from "../commands/ListUsersInGroupCommand";
 import { CognitoIdentityProviderPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListUsersInGroup(config: CognitoIdentityProviderPaginationConfiguration, input: ListUsersInGroupCommandInput, ...additionalArguments: any): Paginator<ListUsersInGroupCommandOutput>;

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

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListUsersCommandInput, ListUsersCommandOutput } from "../commands/ListUsersCommand";
 import { CognitoIdentityProviderPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListUsers(config: CognitoIdentityProviderPaginationConfiguration, input: ListUsersCommandInput, ...additionalArguments: any): Paginator<ListUsersCommandOutput>;