@aws-sdk/client-cognito-identity-provider 3.321.1 → 3.326.0

package/dist-types/commands/DescribeIdentityProviderCommand.d.ts

@@ -32,6 +32,25 @@ export interface DescribeIdentityProviderCommandOutput extends DescribeIdentityP
  * };
  * const command = new DescribeIdentityProviderCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeIdentityProviderResponse
+ * //   IdentityProvider: { // IdentityProviderType
+ * //     UserPoolId: "STRING_VALUE",
+ * //     ProviderName: "STRING_VALUE",
+ * //     ProviderType: "SAML" || "Facebook" || "Google" || "LoginWithAmazon" || "SignInWithApple" || "OIDC",
+ * //     ProviderDetails: { // ProviderDetailsType
+ * //       "<keys>": "STRING_VALUE",
+ * //     },
+ * //     AttributeMapping: { // AttributeMappingType
+ * //       "<keys>": "STRING_VALUE",
+ * //     },
+ * //     IdpIdentifiers: [ // IdpIdentifiersListType
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     LastModifiedDate: new Date("TIMESTAMP"),
+ * //     CreationDate: new Date("TIMESTAMP"),
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribeIdentityProviderCommandInput - {@link DescribeIdentityProviderCommandInput}
@@ -58,6 +77,8 @@ export interface DescribeIdentityProviderCommandOutput extends DescribeIdentityP
  *  <p>This exception is thrown when the user has made too many requests for a given
  *             operation.</p>
  *
+ * @throws {@link CognitoIdentityProviderServiceException}
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
  *
  */
 export declare class DescribeIdentityProviderCommand extends $Command<DescribeIdentityProviderCommandInput, DescribeIdentityProviderCommandOutput, CognitoIdentityProviderClientResolvedConfig> {

package/dist-types/commands/DescribeResourceServerCommand.d.ts

@@ -32,6 +32,20 @@ export interface DescribeResourceServerCommandOutput extends DescribeResourceSer
  * };
  * const command = new DescribeResourceServerCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeResourceServerResponse
+ * //   ResourceServer: { // ResourceServerType
+ * //     UserPoolId: "STRING_VALUE",
+ * //     Identifier: "STRING_VALUE",
+ * //     Name: "STRING_VALUE",
+ * //     Scopes: [ // ResourceServerScopeListType
+ * //       { // ResourceServerScopeType
+ * //         ScopeName: "STRING_VALUE", // required
+ * //         ScopeDescription: "STRING_VALUE", // required
+ * //       },
+ * //     ],
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribeResourceServerCommandInput - {@link DescribeResourceServerCommandInput}
@@ -58,6 +72,8 @@ export interface DescribeResourceServerCommandOutput extends DescribeResourceSer
  *  <p>This exception is thrown when the user has made too many requests for a given
  *             operation.</p>
  *
+ * @throws {@link CognitoIdentityProviderServiceException}
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
  *
  */
 export declare class DescribeResourceServerCommand extends $Command<DescribeResourceServerCommandInput, DescribeResourceServerCommandOutput, CognitoIdentityProviderClientResolvedConfig> {

package/dist-types/commands/DescribeRiskConfigurationCommand.d.ts

@@ -32,6 +32,66 @@ export interface DescribeRiskConfigurationCommandOutput extends DescribeRiskConf
  * };
  * const command = new DescribeRiskConfigurationCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeRiskConfigurationResponse
+ * //   RiskConfiguration: { // RiskConfigurationType
+ * //     UserPoolId: "STRING_VALUE",
+ * //     ClientId: "STRING_VALUE",
+ * //     CompromisedCredentialsRiskConfiguration: { // CompromisedCredentialsRiskConfigurationType
+ * //       EventFilter: [ // EventFiltersType
+ * //         "SIGN_IN" || "PASSWORD_CHANGE" || "SIGN_UP",
+ * //       ],
+ * //       Actions: { // CompromisedCredentialsActionsType
+ * //         EventAction: "BLOCK" || "NO_ACTION", // required
+ * //       },
+ * //     },
+ * //     AccountTakeoverRiskConfiguration: { // AccountTakeoverRiskConfigurationType
+ * //       NotifyConfiguration: { // NotifyConfigurationType
+ * //         From: "STRING_VALUE",
+ * //         ReplyTo: "STRING_VALUE",
+ * //         SourceArn: "STRING_VALUE", // required
+ * //         BlockEmail: { // NotifyEmailType
+ * //           Subject: "STRING_VALUE", // required
+ * //           HtmlBody: "STRING_VALUE",
+ * //           TextBody: "STRING_VALUE",
+ * //         },
+ * //         NoActionEmail: {
+ * //           Subject: "STRING_VALUE", // required
+ * //           HtmlBody: "STRING_VALUE",
+ * //           TextBody: "STRING_VALUE",
+ * //         },
+ * //         MfaEmail: {
+ * //           Subject: "STRING_VALUE", // required
+ * //           HtmlBody: "STRING_VALUE",
+ * //           TextBody: "STRING_VALUE",
+ * //         },
+ * //       },
+ * //       Actions: { // AccountTakeoverActionsType
+ * //         LowAction: { // AccountTakeoverActionType
+ * //           Notify: true || false, // required
+ * //           EventAction: "BLOCK" || "MFA_IF_CONFIGURED" || "MFA_REQUIRED" || "NO_ACTION", // required
+ * //         },
+ * //         MediumAction: {
+ * //           Notify: true || false, // required
+ * //           EventAction: "BLOCK" || "MFA_IF_CONFIGURED" || "MFA_REQUIRED" || "NO_ACTION", // required
+ * //         },
+ * //         HighAction: {
+ * //           Notify: true || false, // required
+ * //           EventAction: "BLOCK" || "MFA_IF_CONFIGURED" || "MFA_REQUIRED" || "NO_ACTION", // required
+ * //         },
+ * //       },
+ * //     },
+ * //     RiskExceptionConfiguration: { // RiskExceptionConfigurationType
+ * //       BlockedIPRangeList: [ // BlockedIPRangeListType
+ * //         "STRING_VALUE",
+ * //       ],
+ * //       SkippedIPRangeList: [ // SkippedIPRangeListType
+ * //         "STRING_VALUE",
+ * //       ],
+ * //     },
+ * //     LastModifiedDate: new Date("TIMESTAMP"),
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribeRiskConfigurationCommandInput - {@link DescribeRiskConfigurationCommandInput}
@@ -61,6 +121,8 @@ export interface DescribeRiskConfigurationCommandOutput extends DescribeRiskConf
  * @throws {@link UserPoolAddOnNotEnabledException} (client fault)
  *  <p>This exception is thrown when user pool add-ons aren't enabled.</p>
  *
+ * @throws {@link CognitoIdentityProviderServiceException}
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
  *
  */
 export declare class DescribeRiskConfigurationCommand extends $Command<DescribeRiskConfigurationCommandInput, DescribeRiskConfigurationCommandOutput, CognitoIdentityProviderClientResolvedConfig> {

package/dist-types/commands/DescribeUserImportJobCommand.d.ts

@@ -32,6 +32,24 @@ export interface DescribeUserImportJobCommandOutput extends DescribeUserImportJo
  * };
  * const command = new DescribeUserImportJobCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeUserImportJobResponse
+ * //   UserImportJob: { // UserImportJobType
+ * //     JobName: "STRING_VALUE",
+ * //     JobId: "STRING_VALUE",
+ * //     UserPoolId: "STRING_VALUE",
+ * //     PreSignedUrl: "STRING_VALUE",
+ * //     CreationDate: new Date("TIMESTAMP"),
+ * //     StartDate: new Date("TIMESTAMP"),
+ * //     CompletionDate: new Date("TIMESTAMP"),
+ * //     Status: "Created" || "Pending" || "InProgress" || "Stopping" || "Expired" || "Stopped" || "Failed" || "Succeeded",
+ * //     CloudWatchLogsRoleArn: "STRING_VALUE",
+ * //     ImportedUsers: Number("long"),
+ * //     SkippedUsers: Number("long"),
+ * //     FailedUsers: Number("long"),
+ * //     CompletionMessage: "STRING_VALUE",
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribeUserImportJobCommandInput - {@link DescribeUserImportJobCommandInput}
@@ -58,6 +76,8 @@ export interface DescribeUserImportJobCommandOutput extends DescribeUserImportJo
  *  <p>This exception is thrown when the user has made too many requests for a given
  *             operation.</p>
  *
+ * @throws {@link CognitoIdentityProviderServiceException}
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
  *
  */
 export declare class DescribeUserImportJobCommand extends $Command<DescribeUserImportJobCommandInput, DescribeUserImportJobCommandOutput, CognitoIdentityProviderClientResolvedConfig> {

package/dist-types/commands/DescribeUserPoolClientCommand.d.ts

@@ -33,6 +33,62 @@ export interface DescribeUserPoolClientCommandOutput extends DescribeUserPoolCli
  * };
  * const command = new DescribeUserPoolClientCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeUserPoolClientResponse
+ * //   UserPoolClient: { // UserPoolClientType
+ * //     UserPoolId: "STRING_VALUE",
+ * //     ClientName: "STRING_VALUE",
+ * //     ClientId: "STRING_VALUE",
+ * //     ClientSecret: "STRING_VALUE",
+ * //     LastModifiedDate: new Date("TIMESTAMP"),
+ * //     CreationDate: new Date("TIMESTAMP"),
+ * //     RefreshTokenValidity: Number("int"),
+ * //     AccessTokenValidity: Number("int"),
+ * //     IdTokenValidity: Number("int"),
+ * //     TokenValidityUnits: { // TokenValidityUnitsType
+ * //       AccessToken: "seconds" || "minutes" || "hours" || "days",
+ * //       IdToken: "seconds" || "minutes" || "hours" || "days",
+ * //       RefreshToken: "seconds" || "minutes" || "hours" || "days",
+ * //     },
+ * //     ReadAttributes: [ // ClientPermissionListType
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     WriteAttributes: [
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     ExplicitAuthFlows: [ // ExplicitAuthFlowsListType
+ * //       "ADMIN_NO_SRP_AUTH" || "CUSTOM_AUTH_FLOW_ONLY" || "USER_PASSWORD_AUTH" || "ALLOW_ADMIN_USER_PASSWORD_AUTH" || "ALLOW_CUSTOM_AUTH" || "ALLOW_USER_PASSWORD_AUTH" || "ALLOW_USER_SRP_AUTH" || "ALLOW_REFRESH_TOKEN_AUTH",
+ * //     ],
+ * //     SupportedIdentityProviders: [ // SupportedIdentityProvidersListType
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     CallbackURLs: [ // CallbackURLsListType
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     LogoutURLs: [ // LogoutURLsListType
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     DefaultRedirectURI: "STRING_VALUE",
+ * //     AllowedOAuthFlows: [ // OAuthFlowsType
+ * //       "code" || "implicit" || "client_credentials",
+ * //     ],
+ * //     AllowedOAuthScopes: [ // ScopeListType
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     AllowedOAuthFlowsUserPoolClient: true || false,
+ * //     AnalyticsConfiguration: { // AnalyticsConfigurationType
+ * //       ApplicationId: "STRING_VALUE",
+ * //       ApplicationArn: "STRING_VALUE",
+ * //       RoleArn: "STRING_VALUE",
+ * //       ExternalId: "STRING_VALUE",
+ * //       UserDataShared: true || false,
+ * //     },
+ * //     PreventUserExistenceErrors: "LEGACY" || "ENABLED",
+ * //     EnableTokenRevocation: true || false,
+ * //     EnablePropagateAdditionalUserContextData: true || false,
+ * //     AuthSessionValidity: Number("int"),
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribeUserPoolClientCommandInput - {@link DescribeUserPoolClientCommandInput}
@@ -59,6 +115,8 @@ export interface DescribeUserPoolClientCommandOutput extends DescribeUserPoolCli
  *  <p>This exception is thrown when the user has made too many requests for a given
  *             operation.</p>
  *
+ * @throws {@link CognitoIdentityProviderServiceException}
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
  *
  */
 export declare class DescribeUserPoolClientCommand extends $Command<DescribeUserPoolClientCommandInput, DescribeUserPoolClientCommandOutput, CognitoIdentityProviderClientResolvedConfig> {

package/dist-types/commands/DescribeUserPoolCommand.d.ts

@@ -31,6 +31,140 @@ export interface DescribeUserPoolCommandOutput extends DescribeUserPoolResponse,
  * };
  * const command = new DescribeUserPoolCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeUserPoolResponse
+ * //   UserPool: { // UserPoolType
+ * //     Id: "STRING_VALUE",
+ * //     Name: "STRING_VALUE",
+ * //     Policies: { // UserPoolPolicyType
+ * //       PasswordPolicy: { // PasswordPolicyType
+ * //         MinimumLength: Number("int"),
+ * //         RequireUppercase: true || false,
+ * //         RequireLowercase: true || false,
+ * //         RequireNumbers: true || false,
+ * //         RequireSymbols: true || false,
+ * //         TemporaryPasswordValidityDays: Number("int"),
+ * //       },
+ * //     },
+ * //     DeletionProtection: "ACTIVE" || "INACTIVE",
+ * //     LambdaConfig: { // LambdaConfigType
+ * //       PreSignUp: "STRING_VALUE",
+ * //       CustomMessage: "STRING_VALUE",
+ * //       PostConfirmation: "STRING_VALUE",
+ * //       PreAuthentication: "STRING_VALUE",
+ * //       PostAuthentication: "STRING_VALUE",
+ * //       DefineAuthChallenge: "STRING_VALUE",
+ * //       CreateAuthChallenge: "STRING_VALUE",
+ * //       VerifyAuthChallengeResponse: "STRING_VALUE",
+ * //       PreTokenGeneration: "STRING_VALUE",
+ * //       UserMigration: "STRING_VALUE",
+ * //       CustomSMSSender: { // CustomSMSLambdaVersionConfigType
+ * //         LambdaVersion: "V1_0", // required
+ * //         LambdaArn: "STRING_VALUE", // required
+ * //       },
+ * //       CustomEmailSender: { // CustomEmailLambdaVersionConfigType
+ * //         LambdaVersion: "V1_0", // required
+ * //         LambdaArn: "STRING_VALUE", // required
+ * //       },
+ * //       KMSKeyID: "STRING_VALUE",
+ * //     },
+ * //     Status: "Enabled" || "Disabled",
+ * //     LastModifiedDate: new Date("TIMESTAMP"),
+ * //     CreationDate: new Date("TIMESTAMP"),
+ * //     SchemaAttributes: [ // SchemaAttributesListType
+ * //       { // SchemaAttributeType
+ * //         Name: "STRING_VALUE",
+ * //         AttributeDataType: "String" || "Number" || "DateTime" || "Boolean",
+ * //         DeveloperOnlyAttribute: true || false,
+ * //         Mutable: true || false,
+ * //         Required: true || false,
+ * //         NumberAttributeConstraints: { // NumberAttributeConstraintsType
+ * //           MinValue: "STRING_VALUE",
+ * //           MaxValue: "STRING_VALUE",
+ * //         },
+ * //         StringAttributeConstraints: { // StringAttributeConstraintsType
+ * //           MinLength: "STRING_VALUE",
+ * //           MaxLength: "STRING_VALUE",
+ * //         },
+ * //       },
+ * //     ],
+ * //     AutoVerifiedAttributes: [ // VerifiedAttributesListType
+ * //       "phone_number" || "email",
+ * //     ],
+ * //     AliasAttributes: [ // AliasAttributesListType
+ * //       "phone_number" || "email" || "preferred_username",
+ * //     ],
+ * //     UsernameAttributes: [ // UsernameAttributesListType
+ * //       "phone_number" || "email",
+ * //     ],
+ * //     SmsVerificationMessage: "STRING_VALUE",
+ * //     EmailVerificationMessage: "STRING_VALUE",
+ * //     EmailVerificationSubject: "STRING_VALUE",
+ * //     VerificationMessageTemplate: { // VerificationMessageTemplateType
+ * //       SmsMessage: "STRING_VALUE",
+ * //       EmailMessage: "STRING_VALUE",
+ * //       EmailSubject: "STRING_VALUE",
+ * //       EmailMessageByLink: "STRING_VALUE",
+ * //       EmailSubjectByLink: "STRING_VALUE",
+ * //       DefaultEmailOption: "CONFIRM_WITH_LINK" || "CONFIRM_WITH_CODE",
+ * //     },
+ * //     SmsAuthenticationMessage: "STRING_VALUE",
+ * //     UserAttributeUpdateSettings: { // UserAttributeUpdateSettingsType
+ * //       AttributesRequireVerificationBeforeUpdate: [ // AttributesRequireVerificationBeforeUpdateType
+ * //         "phone_number" || "email",
+ * //       ],
+ * //     },
+ * //     MfaConfiguration: "OFF" || "ON" || "OPTIONAL",
+ * //     DeviceConfiguration: { // DeviceConfigurationType
+ * //       ChallengeRequiredOnNewDevice: true || false,
+ * //       DeviceOnlyRememberedOnUserPrompt: true || false,
+ * //     },
+ * //     EstimatedNumberOfUsers: Number("int"),
+ * //     EmailConfiguration: { // EmailConfigurationType
+ * //       SourceArn: "STRING_VALUE",
+ * //       ReplyToEmailAddress: "STRING_VALUE",
+ * //       EmailSendingAccount: "COGNITO_DEFAULT" || "DEVELOPER",
+ * //       From: "STRING_VALUE",
+ * //       ConfigurationSet: "STRING_VALUE",
+ * //     },
+ * //     SmsConfiguration: { // SmsConfigurationType
+ * //       SnsCallerArn: "STRING_VALUE", // required
+ * //       ExternalId: "STRING_VALUE",
+ * //       SnsRegion: "STRING_VALUE",
+ * //     },
+ * //     UserPoolTags: { // UserPoolTagsType
+ * //       "<keys>": "STRING_VALUE",
+ * //     },
+ * //     SmsConfigurationFailure: "STRING_VALUE",
+ * //     EmailConfigurationFailure: "STRING_VALUE",
+ * //     Domain: "STRING_VALUE",
+ * //     CustomDomain: "STRING_VALUE",
+ * //     AdminCreateUserConfig: { // AdminCreateUserConfigType
+ * //       AllowAdminCreateUserOnly: true || false,
+ * //       UnusedAccountValidityDays: Number("int"),
+ * //       InviteMessageTemplate: { // MessageTemplateType
+ * //         SMSMessage: "STRING_VALUE",
+ * //         EmailMessage: "STRING_VALUE",
+ * //         EmailSubject: "STRING_VALUE",
+ * //       },
+ * //     },
+ * //     UserPoolAddOns: { // UserPoolAddOnsType
+ * //       AdvancedSecurityMode: "OFF" || "AUDIT" || "ENFORCED", // required
+ * //     },
+ * //     UsernameConfiguration: { // UsernameConfigurationType
+ * //       CaseSensitive: true || false, // required
+ * //     },
+ * //     Arn: "STRING_VALUE",
+ * //     AccountRecoverySetting: { // AccountRecoverySettingType
+ * //       RecoveryMechanisms: [ // RecoveryMechanismsType
+ * //         { // RecoveryOptionType
+ * //           Priority: Number("int"), // required
+ * //           Name: "verified_email" || "verified_phone_number" || "admin_only", // required
+ * //         },
+ * //       ],
+ * //     },
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribeUserPoolCommandInput - {@link DescribeUserPoolCommandInput}
@@ -60,6 +194,8 @@ export interface DescribeUserPoolCommandOutput extends DescribeUserPoolResponse,
  * @throws {@link UserPoolTaggingException} (client fault)
  *  <p>This exception is thrown when a user pool tag can't be set or updated.</p>
  *
+ * @throws {@link CognitoIdentityProviderServiceException}
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
  *
  */
 export declare class DescribeUserPoolCommand extends $Command<DescribeUserPoolCommandInput, DescribeUserPoolCommandOutput, CognitoIdentityProviderClientResolvedConfig> {

package/dist-types/commands/DescribeUserPoolDomainCommand.d.ts

@@ -31,6 +31,21 @@ export interface DescribeUserPoolDomainCommandOutput extends DescribeUserPoolDom
  * };
  * const command = new DescribeUserPoolDomainCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeUserPoolDomainResponse
+ * //   DomainDescription: { // DomainDescriptionType
+ * //     UserPoolId: "STRING_VALUE",
+ * //     AWSAccountId: "STRING_VALUE",
+ * //     Domain: "STRING_VALUE",
+ * //     S3Bucket: "STRING_VALUE",
+ * //     CloudFrontDistribution: "STRING_VALUE",
+ * //     Version: "STRING_VALUE",
+ * //     Status: "CREATING" || "DELETING" || "UPDATING" || "ACTIVE" || "FAILED",
+ * //     CustomDomainConfig: { // CustomDomainConfigType
+ * //       CertificateArn: "STRING_VALUE", // required
+ * //     },
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribeUserPoolDomainCommandInput - {@link DescribeUserPoolDomainCommandInput}
@@ -53,6 +68,8 @@ export interface DescribeUserPoolDomainCommandOutput extends DescribeUserPoolDom
  *  <p>This exception is thrown when the Amazon Cognito service can't find the requested
  *             resource.</p>
  *
+ * @throws {@link CognitoIdentityProviderServiceException}
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
  *
  */
 export declare class DescribeUserPoolDomainCommand extends $Command<DescribeUserPoolDomainCommandInput, DescribeUserPoolDomainCommandOutput, CognitoIdentityProviderClientResolvedConfig> {

package/dist-types/commands/ForgetDeviceCommand.d.ts

@@ -32,6 +32,8 @@ export interface ForgetDeviceCommandOutput extends __MetadataBearer {
  * };
  * const command = new ForgetDeviceCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param ForgetDeviceCommandInput - {@link ForgetDeviceCommandInput}
@@ -73,6 +75,8 @@ export interface ForgetDeviceCommandOutput extends __MetadataBearer {
  * @throws {@link UserNotFoundException} (client fault)
  *  <p>This exception is thrown when a user isn't found.</p>
  *
+ * @throws {@link CognitoIdentityProviderServiceException}
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
  *
  */
 export declare class ForgetDeviceCommand extends $Command<ForgetDeviceCommandInput, ForgetDeviceCommandOutput, CognitoIdentityProviderClientResolvedConfig> {

package/dist-types/commands/ForgotPasswordCommand.d.ts

@@ -68,6 +68,14 @@ export interface ForgotPasswordCommandOutput extends ForgotPasswordResponse, __M
  * };
  * const command = new ForgotPasswordCommand(input);
  * const response = await client.send(command);
+ * // { // ForgotPasswordResponse
+ * //   CodeDeliveryDetails: { // CodeDeliveryDetailsType
+ * //     Destination: "STRING_VALUE",
+ * //     DeliveryMedium: "SMS" || "EMAIL",
+ * //     AttributeName: "STRING_VALUE",
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param ForgotPasswordCommandInput - {@link ForgotPasswordCommandInput}
@@ -133,6 +141,8 @@ export interface ForgotPasswordCommandOutput extends ForgotPasswordResponse, __M
  * @throws {@link UserNotFoundException} (client fault)
  *  <p>This exception is thrown when a user isn't found.</p>
  *
+ * @throws {@link CognitoIdentityProviderServiceException}
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
  *
  */
 export declare class ForgotPasswordCommand extends $Command<ForgotPasswordCommandInput, ForgotPasswordCommandOutput, CognitoIdentityProviderClientResolvedConfig> {

package/dist-types/commands/GetCSVHeaderCommand.d.ts

@@ -32,6 +32,13 @@ export interface GetCSVHeaderCommandOutput extends GetCSVHeaderResponse, __Metad
  * };
  * const command = new GetCSVHeaderCommand(input);
  * const response = await client.send(command);
+ * // { // GetCSVHeaderResponse
+ * //   UserPoolId: "STRING_VALUE",
+ * //   CSVHeader: [ // ListOfStringTypes
+ * //     "STRING_VALUE",
+ * //   ],
+ * // };
+ *
  * ```
  *
  * @param GetCSVHeaderCommandInput - {@link GetCSVHeaderCommandInput}
@@ -58,6 +65,8 @@ export interface GetCSVHeaderCommandOutput extends GetCSVHeaderResponse, __Metad
  *  <p>This exception is thrown when the user has made too many requests for a given
  *             operation.</p>
  *
+ * @throws {@link CognitoIdentityProviderServiceException}
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
  *
  */
 export declare class GetCSVHeaderCommand extends $Command<GetCSVHeaderCommandInput, GetCSVHeaderCommandOutput, CognitoIdentityProviderClientResolvedConfig> {

package/dist-types/commands/GetDeviceCommand.d.ts

@@ -32,6 +32,21 @@ export interface GetDeviceCommandOutput extends GetDeviceResponse, __MetadataBea
  * };
  * const command = new GetDeviceCommand(input);
  * const response = await client.send(command);
+ * // { // GetDeviceResponse
+ * //   Device: { // DeviceType
+ * //     DeviceKey: "STRING_VALUE",
+ * //     DeviceAttributes: [ // AttributeListType
+ * //       { // AttributeType
+ * //         Name: "STRING_VALUE", // required
+ * //         Value: "STRING_VALUE",
+ * //       },
+ * //     ],
+ * //     DeviceCreateDate: new Date("TIMESTAMP"),
+ * //     DeviceLastModifiedDate: new Date("TIMESTAMP"),
+ * //     DeviceLastAuthenticatedDate: new Date("TIMESTAMP"),
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param GetDeviceCommandInput - {@link GetDeviceCommandInput}
@@ -73,6 +88,8 @@ export interface GetDeviceCommandOutput extends GetDeviceResponse, __MetadataBea
  * @throws {@link UserNotFoundException} (client fault)
  *  <p>This exception is thrown when a user isn't found.</p>
  *
+ * @throws {@link CognitoIdentityProviderServiceException}
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
  *
  */
 export declare class GetDeviceCommand extends $Command<GetDeviceCommandInput, GetDeviceCommandOutput, CognitoIdentityProviderClientResolvedConfig> {

package/dist-types/commands/GetGroupCommand.d.ts

@@ -33,6 +33,18 @@ export interface GetGroupCommandOutput extends GetGroupResponse, __MetadataBeare
  * };
  * const command = new GetGroupCommand(input);
  * const response = await client.send(command);
+ * // { // GetGroupResponse
+ * //   Group: { // GroupType
+ * //     GroupName: "STRING_VALUE",
+ * //     UserPoolId: "STRING_VALUE",
+ * //     Description: "STRING_VALUE",
+ * //     RoleArn: "STRING_VALUE",
+ * //     Precedence: Number("int"),
+ * //     LastModifiedDate: new Date("TIMESTAMP"),
+ * //     CreationDate: new Date("TIMESTAMP"),
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param GetGroupCommandInput - {@link GetGroupCommandInput}
@@ -59,6 +71,8 @@ export interface GetGroupCommandOutput extends GetGroupResponse, __MetadataBeare
  *  <p>This exception is thrown when the user has made too many requests for a given
  *             operation.</p>
  *
+ * @throws {@link CognitoIdentityProviderServiceException}
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
  *
  */
 export declare class GetGroupCommand extends $Command<GetGroupCommandInput, GetGroupCommandOutput, CognitoIdentityProviderClientResolvedConfig> {

package/dist-types/commands/GetIdentityProviderByIdentifierCommand.d.ts

@@ -32,6 +32,25 @@ export interface GetIdentityProviderByIdentifierCommandOutput extends GetIdentit
  * };
  * const command = new GetIdentityProviderByIdentifierCommand(input);
  * const response = await client.send(command);
+ * // { // GetIdentityProviderByIdentifierResponse
+ * //   IdentityProvider: { // IdentityProviderType
+ * //     UserPoolId: "STRING_VALUE",
+ * //     ProviderName: "STRING_VALUE",
+ * //     ProviderType: "SAML" || "Facebook" || "Google" || "LoginWithAmazon" || "SignInWithApple" || "OIDC",
+ * //     ProviderDetails: { // ProviderDetailsType
+ * //       "<keys>": "STRING_VALUE",
+ * //     },
+ * //     AttributeMapping: { // AttributeMappingType
+ * //       "<keys>": "STRING_VALUE",
+ * //     },
+ * //     IdpIdentifiers: [ // IdpIdentifiersListType
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     LastModifiedDate: new Date("TIMESTAMP"),
+ * //     CreationDate: new Date("TIMESTAMP"),
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param GetIdentityProviderByIdentifierCommandInput - {@link GetIdentityProviderByIdentifierCommandInput}
@@ -58,6 +77,8 @@ export interface GetIdentityProviderByIdentifierCommandOutput extends GetIdentit
  *  <p>This exception is thrown when the user has made too many requests for a given
  *             operation.</p>
  *
+ * @throws {@link CognitoIdentityProviderServiceException}
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
  *
  */
 export declare class GetIdentityProviderByIdentifierCommand extends $Command<GetIdentityProviderByIdentifierCommandInput, GetIdentityProviderByIdentifierCommandOutput, CognitoIdentityProviderClientResolvedConfig> {

package/dist-types/commands/GetSigningCertificateCommand.d.ts

@@ -33,6 +33,10 @@ export interface GetSigningCertificateCommandOutput extends GetSigningCertificat
  * };
  * const command = new GetSigningCertificateCommand(input);
  * const response = await client.send(command);
+ * // { // GetSigningCertificateResponse
+ * //   Certificate: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param GetSigningCertificateCommandInput - {@link GetSigningCertificateCommandInput}
@@ -52,6 +56,8 @@ export interface GetSigningCertificateCommandOutput extends GetSigningCertificat
  *  <p>This exception is thrown when the Amazon Cognito service can't find the requested
  *             resource.</p>
  *
+ * @throws {@link CognitoIdentityProviderServiceException}
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
  *
  */
 export declare class GetSigningCertificateCommand extends $Command<GetSigningCertificateCommandInput, GetSigningCertificateCommandOutput, CognitoIdentityProviderClientResolvedConfig> {

package/dist-types/commands/GetUICustomizationCommand.d.ts

@@ -36,6 +36,18 @@ export interface GetUICustomizationCommandOutput extends GetUICustomizationRespo
  * };
  * const command = new GetUICustomizationCommand(input);
  * const response = await client.send(command);
+ * // { // GetUICustomizationResponse
+ * //   UICustomization: { // UICustomizationType
+ * //     UserPoolId: "STRING_VALUE",
+ * //     ClientId: "STRING_VALUE",
+ * //     ImageUrl: "STRING_VALUE",
+ * //     CSS: "STRING_VALUE",
+ * //     CSSVersion: "STRING_VALUE",
+ * //     LastModifiedDate: new Date("TIMESTAMP"),
+ * //     CreationDate: new Date("TIMESTAMP"),
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param GetUICustomizationCommandInput - {@link GetUICustomizationCommandInput}
@@ -62,6 +74,8 @@ export interface GetUICustomizationCommandOutput extends GetUICustomizationRespo
  *  <p>This exception is thrown when the user has made too many requests for a given
  *             operation.</p>
  *
+ * @throws {@link CognitoIdentityProviderServiceException}
+ * <p>Base exception class for all service exceptions from CognitoIdentityProvider service.</p>
  *
  */
 export declare class GetUICustomizationCommand extends $Command<GetUICustomizationCommandInput, GetUICustomizationCommandOutput, CognitoIdentityProviderClientResolvedConfig> {