@aws-sdk/client-cognito-identity-provider 3.299.0 → 3.300.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (102) hide show
  1. package/dist-types/commands/AddCustomAttributesCommand.d.ts +20 -0
  2. package/dist-types/commands/AdminAddUserToGroupCommand.d.ts +5 -0
  3. package/dist-types/commands/AdminConfirmSignUpCommand.d.ts +7 -0
  4. package/dist-types/commands/AdminCreateUserCommand.d.ts +25 -0
  5. package/dist-types/commands/AdminDeleteUserAttributesCommand.d.ts +7 -0
  6. package/dist-types/commands/AdminDeleteUserCommand.d.ts +4 -0
  7. package/dist-types/commands/AdminDisableProviderForUserCommand.d.ts +8 -0
  8. package/dist-types/commands/AdminDisableUserCommand.d.ts +4 -0
  9. package/dist-types/commands/AdminEnableUserCommand.d.ts +4 -0
  10. package/dist-types/commands/AdminForgetDeviceCommand.d.ts +5 -0
  11. package/dist-types/commands/AdminGetDeviceCommand.d.ts +5 -0
  12. package/dist-types/commands/AdminGetUserCommand.d.ts +4 -0
  13. package/dist-types/commands/AdminInitiateAuthCommand.d.ts +26 -0
  14. package/dist-types/commands/AdminLinkProviderForUserCommand.d.ts +13 -0
  15. package/dist-types/commands/AdminListDevicesCommand.d.ts +6 -0
  16. package/dist-types/commands/AdminListGroupsForUserCommand.d.ts +6 -0
  17. package/dist-types/commands/AdminListUserAuthEventsCommand.d.ts +6 -0
  18. package/dist-types/commands/AdminRemoveUserFromGroupCommand.d.ts +5 -0
  19. package/dist-types/commands/AdminResetUserPasswordCommand.d.ts +7 -0
  20. package/dist-types/commands/AdminRespondToAuthChallengeCommand.d.ts +27 -0
  21. package/dist-types/commands/AdminSetUserMFAPreferenceCommand.d.ts +12 -0
  22. package/dist-types/commands/AdminSetUserPasswordCommand.d.ts +6 -0
  23. package/dist-types/commands/AdminSetUserSettingsCommand.d.ts +10 -0
  24. package/dist-types/commands/AdminUpdateAuthEventFeedbackCommand.d.ts +6 -0
  25. package/dist-types/commands/AdminUpdateDeviceStatusCommand.d.ts +6 -0
  26. package/dist-types/commands/AdminUpdateUserAttributesCommand.d.ts +13 -0
  27. package/dist-types/commands/AdminUserGlobalSignOutCommand.d.ts +4 -0
  28. package/dist-types/commands/AssociateSoftwareTokenCommand.d.ts +4 -0
  29. package/dist-types/commands/ChangePasswordCommand.d.ts +5 -0
  30. package/dist-types/commands/ConfirmDeviceCommand.d.ts +9 -0
  31. package/dist-types/commands/ConfirmForgotPasswordCommand.d.ts +17 -0
  32. package/dist-types/commands/ConfirmSignUpCommand.d.ts +17 -0
  33. package/dist-types/commands/CreateGroupCommand.d.ts +7 -0
  34. package/dist-types/commands/CreateIdentityProviderCommand.d.ts +14 -0
  35. package/dist-types/commands/CreateResourceServerCommand.d.ts +11 -0
  36. package/dist-types/commands/CreateUserImportJobCommand.d.ts +5 -0
  37. package/dist-types/commands/CreateUserPoolClientCommand.d.ts +50 -0
  38. package/dist-types/commands/CreateUserPoolCommand.d.ts +121 -0
  39. package/dist-types/commands/CreateUserPoolDomainCommand.d.ts +7 -0
  40. package/dist-types/commands/DeleteGroupCommand.d.ts +4 -0
  41. package/dist-types/commands/DeleteIdentityProviderCommand.d.ts +4 -0
  42. package/dist-types/commands/DeleteResourceServerCommand.d.ts +4 -0
  43. package/dist-types/commands/DeleteUserAttributesCommand.d.ts +6 -0
  44. package/dist-types/commands/DeleteUserCommand.d.ts +3 -0
  45. package/dist-types/commands/DeleteUserPoolClientCommand.d.ts +4 -0
  46. package/dist-types/commands/DeleteUserPoolCommand.d.ts +3 -0
  47. package/dist-types/commands/DeleteUserPoolDomainCommand.d.ts +4 -0
  48. package/dist-types/commands/DescribeIdentityProviderCommand.d.ts +4 -0
  49. package/dist-types/commands/DescribeResourceServerCommand.d.ts +4 -0
  50. package/dist-types/commands/DescribeRiskConfigurationCommand.d.ts +4 -0
  51. package/dist-types/commands/DescribeUserImportJobCommand.d.ts +4 -0
  52. package/dist-types/commands/DescribeUserPoolClientCommand.d.ts +4 -0
  53. package/dist-types/commands/DescribeUserPoolCommand.d.ts +3 -0
  54. package/dist-types/commands/DescribeUserPoolDomainCommand.d.ts +3 -0
  55. package/dist-types/commands/ForgetDeviceCommand.d.ts +4 -0
  56. package/dist-types/commands/ForgotPasswordCommand.d.ts +15 -0
  57. package/dist-types/commands/GetCSVHeaderCommand.d.ts +3 -0
  58. package/dist-types/commands/GetDeviceCommand.d.ts +4 -0
  59. package/dist-types/commands/GetGroupCommand.d.ts +4 -0
  60. package/dist-types/commands/GetIdentityProviderByIdentifierCommand.d.ts +4 -0
  61. package/dist-types/commands/GetSigningCertificateCommand.d.ts +3 -0
  62. package/dist-types/commands/GetUICustomizationCommand.d.ts +4 -0
  63. package/dist-types/commands/GetUserAttributeVerificationCodeCommand.d.ts +7 -0
  64. package/dist-types/commands/GetUserCommand.d.ts +3 -0
  65. package/dist-types/commands/GetUserPoolMfaConfigCommand.d.ts +3 -0
  66. package/dist-types/commands/GlobalSignOutCommand.d.ts +3 -0
  67. package/dist-types/commands/InitiateAuthCommand.d.ts +17 -0
  68. package/dist-types/commands/ListDevicesCommand.d.ts +5 -0
  69. package/dist-types/commands/ListGroupsCommand.d.ts +5 -0
  70. package/dist-types/commands/ListIdentityProvidersCommand.d.ts +5 -0
  71. package/dist-types/commands/ListResourceServersCommand.d.ts +5 -0
  72. package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -0
  73. package/dist-types/commands/ListUserImportJobsCommand.d.ts +5 -0
  74. package/dist-types/commands/ListUserPoolClientsCommand.d.ts +5 -0
  75. package/dist-types/commands/ListUserPoolsCommand.d.ts +4 -0
  76. package/dist-types/commands/ListUsersCommand.d.ts +9 -0
  77. package/dist-types/commands/ListUsersInGroupCommand.d.ts +6 -0
  78. package/dist-types/commands/ResendConfirmationCodeCommand.d.ts +15 -0
  79. package/dist-types/commands/RespondToAuthChallengeCommand.d.ts +18 -0
  80. package/dist-types/commands/RevokeTokenCommand.d.ts +5 -0
  81. package/dist-types/commands/SetRiskConfigurationCommand.d.ts +56 -0
  82. package/dist-types/commands/SetUICustomizationCommand.d.ts +6 -0
  83. package/dist-types/commands/SetUserMFAPreferenceCommand.d.ts +11 -0
  84. package/dist-types/commands/SetUserPoolMfaConfigCommand.d.ts +15 -0
  85. package/dist-types/commands/SetUserSettingsCommand.d.ts +9 -0
  86. package/dist-types/commands/SignUpCommand.d.ts +28 -0
  87. package/dist-types/commands/StartUserImportJobCommand.d.ts +4 -0
  88. package/dist-types/commands/StopUserImportJobCommand.d.ts +4 -0
  89. package/dist-types/commands/TagResourceCommand.d.ts +6 -0
  90. package/dist-types/commands/UntagResourceCommand.d.ts +6 -0
  91. package/dist-types/commands/UpdateAuthEventFeedbackCommand.d.ts +7 -0
  92. package/dist-types/commands/UpdateDeviceStatusCommand.d.ts +5 -0
  93. package/dist-types/commands/UpdateGroupCommand.d.ts +7 -0
  94. package/dist-types/commands/UpdateIdentityProviderCommand.d.ts +13 -0
  95. package/dist-types/commands/UpdateResourceServerCommand.d.ts +11 -0
  96. package/dist-types/commands/UpdateUserAttributesCommand.d.ts +12 -0
  97. package/dist-types/commands/UpdateUserPoolClientCommand.d.ts +50 -0
  98. package/dist-types/commands/UpdateUserPoolCommand.d.ts +95 -0
  99. package/dist-types/commands/UpdateUserPoolDomainCommand.d.ts +7 -0
  100. package/dist-types/commands/VerifySoftwareTokenCommand.d.ts +6 -0
  101. package/dist-types/commands/VerifyUserAttributeCommand.d.ts +5 -0
  102. package/package.json +8 -8
@@ -28,6 +28,56 @@ export interface CreateUserPoolClientCommandOutput extends CreateUserPoolClientR
28
28
  * import { CognitoIdentityProviderClient, CreateUserPoolClientCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
29
29
  * // const { CognitoIdentityProviderClient, CreateUserPoolClientCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
30
30
  * const client = new CognitoIdentityProviderClient(config);
31
+ * const input = {
32
+ * UserPoolId: "STRING_VALUE", // required
33
+ * ClientName: "STRING_VALUE", // required
34
+ * GenerateSecret: true || false,
35
+ * RefreshTokenValidity: Number("int"),
36
+ * AccessTokenValidity: Number("int"),
37
+ * IdTokenValidity: Number("int"),
38
+ * TokenValidityUnits: {
39
+ * AccessToken: "seconds" || "minutes" || "hours" || "days",
40
+ * IdToken: "seconds" || "minutes" || "hours" || "days",
41
+ * RefreshToken: "seconds" || "minutes" || "hours" || "days",
42
+ * },
43
+ * ReadAttributes: [
44
+ * "STRING_VALUE",
45
+ * ],
46
+ * WriteAttributes: [
47
+ * "STRING_VALUE",
48
+ * ],
49
+ * ExplicitAuthFlows: [
50
+ * "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",
51
+ * ],
52
+ * SupportedIdentityProviders: [
53
+ * "STRING_VALUE",
54
+ * ],
55
+ * CallbackURLs: [
56
+ * "STRING_VALUE",
57
+ * ],
58
+ * LogoutURLs: [
59
+ * "STRING_VALUE",
60
+ * ],
61
+ * DefaultRedirectURI: "STRING_VALUE",
62
+ * AllowedOAuthFlows: [
63
+ * "code" || "implicit" || "client_credentials",
64
+ * ],
65
+ * AllowedOAuthScopes: [
66
+ * "STRING_VALUE",
67
+ * ],
68
+ * AllowedOAuthFlowsUserPoolClient: true || false,
69
+ * AnalyticsConfiguration: {
70
+ * ApplicationId: "STRING_VALUE",
71
+ * ApplicationArn: "STRING_VALUE",
72
+ * RoleArn: "STRING_VALUE",
73
+ * ExternalId: "STRING_VALUE",
74
+ * UserDataShared: true || false,
75
+ * },
76
+ * PreventUserExistenceErrors: "LEGACY" || "ENABLED",
77
+ * EnableTokenRevocation: true || false,
78
+ * EnablePropagateAdditionalUserContextData: true || false,
79
+ * AuthSessionValidity: Number("int"),
80
+ * };
31
81
  * const command = new CreateUserPoolClientCommand(input);
32
82
  * const response = await client.send(command);
33
83
  * ```
@@ -45,6 +45,127 @@ export interface CreateUserPoolCommandOutput extends CreateUserPoolResponse, __M
45
45
  * import { CognitoIdentityProviderClient, CreateUserPoolCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
46
46
  * // const { CognitoIdentityProviderClient, CreateUserPoolCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
47
47
  * const client = new CognitoIdentityProviderClient(config);
48
+ * const input = {
49
+ * PoolName: "STRING_VALUE", // required
50
+ * Policies: {
51
+ * PasswordPolicy: {
52
+ * MinimumLength: Number("int"),
53
+ * RequireUppercase: true || false,
54
+ * RequireLowercase: true || false,
55
+ * RequireNumbers: true || false,
56
+ * RequireSymbols: true || false,
57
+ * TemporaryPasswordValidityDays: Number("int"),
58
+ * },
59
+ * },
60
+ * DeletionProtection: "ACTIVE" || "INACTIVE",
61
+ * LambdaConfig: {
62
+ * PreSignUp: "STRING_VALUE",
63
+ * CustomMessage: "STRING_VALUE",
64
+ * PostConfirmation: "STRING_VALUE",
65
+ * PreAuthentication: "STRING_VALUE",
66
+ * PostAuthentication: "STRING_VALUE",
67
+ * DefineAuthChallenge: "STRING_VALUE",
68
+ * CreateAuthChallenge: "STRING_VALUE",
69
+ * VerifyAuthChallengeResponse: "STRING_VALUE",
70
+ * PreTokenGeneration: "STRING_VALUE",
71
+ * UserMigration: "STRING_VALUE",
72
+ * CustomSMSSender: {
73
+ * LambdaVersion: "V1_0", // required
74
+ * LambdaArn: "STRING_VALUE", // required
75
+ * },
76
+ * CustomEmailSender: {
77
+ * LambdaVersion: "V1_0", // required
78
+ * LambdaArn: "STRING_VALUE", // required
79
+ * },
80
+ * KMSKeyID: "STRING_VALUE",
81
+ * },
82
+ * AutoVerifiedAttributes: [
83
+ * "phone_number" || "email",
84
+ * ],
85
+ * AliasAttributes: [
86
+ * "phone_number" || "email" || "preferred_username",
87
+ * ],
88
+ * UsernameAttributes: [
89
+ * "phone_number" || "email",
90
+ * ],
91
+ * SmsVerificationMessage: "STRING_VALUE",
92
+ * EmailVerificationMessage: "STRING_VALUE",
93
+ * EmailVerificationSubject: "STRING_VALUE",
94
+ * VerificationMessageTemplate: {
95
+ * SmsMessage: "STRING_VALUE",
96
+ * EmailMessage: "STRING_VALUE",
97
+ * EmailSubject: "STRING_VALUE",
98
+ * EmailMessageByLink: "STRING_VALUE",
99
+ * EmailSubjectByLink: "STRING_VALUE",
100
+ * DefaultEmailOption: "CONFIRM_WITH_LINK" || "CONFIRM_WITH_CODE",
101
+ * },
102
+ * SmsAuthenticationMessage: "STRING_VALUE",
103
+ * MfaConfiguration: "OFF" || "ON" || "OPTIONAL",
104
+ * UserAttributeUpdateSettings: {
105
+ * AttributesRequireVerificationBeforeUpdate: [
106
+ * "phone_number" || "email",
107
+ * ],
108
+ * },
109
+ * DeviceConfiguration: {
110
+ * ChallengeRequiredOnNewDevice: true || false,
111
+ * DeviceOnlyRememberedOnUserPrompt: true || false,
112
+ * },
113
+ * EmailConfiguration: {
114
+ * SourceArn: "STRING_VALUE",
115
+ * ReplyToEmailAddress: "STRING_VALUE",
116
+ * EmailSendingAccount: "COGNITO_DEFAULT" || "DEVELOPER",
117
+ * From: "STRING_VALUE",
118
+ * ConfigurationSet: "STRING_VALUE",
119
+ * },
120
+ * SmsConfiguration: {
121
+ * SnsCallerArn: "STRING_VALUE", // required
122
+ * ExternalId: "STRING_VALUE",
123
+ * SnsRegion: "STRING_VALUE",
124
+ * },
125
+ * UserPoolTags: {
126
+ * "<keys>": "STRING_VALUE",
127
+ * },
128
+ * AdminCreateUserConfig: {
129
+ * AllowAdminCreateUserOnly: true || false,
130
+ * UnusedAccountValidityDays: Number("int"),
131
+ * InviteMessageTemplate: {
132
+ * SMSMessage: "STRING_VALUE",
133
+ * EmailMessage: "STRING_VALUE",
134
+ * EmailSubject: "STRING_VALUE",
135
+ * },
136
+ * },
137
+ * Schema: [
138
+ * {
139
+ * Name: "STRING_VALUE",
140
+ * AttributeDataType: "String" || "Number" || "DateTime" || "Boolean",
141
+ * DeveloperOnlyAttribute: true || false,
142
+ * Mutable: true || false,
143
+ * Required: true || false,
144
+ * NumberAttributeConstraints: {
145
+ * MinValue: "STRING_VALUE",
146
+ * MaxValue: "STRING_VALUE",
147
+ * },
148
+ * StringAttributeConstraints: {
149
+ * MinLength: "STRING_VALUE",
150
+ * MaxLength: "STRING_VALUE",
151
+ * },
152
+ * },
153
+ * ],
154
+ * UserPoolAddOns: {
155
+ * AdvancedSecurityMode: "OFF" || "AUDIT" || "ENFORCED", // required
156
+ * },
157
+ * UsernameConfiguration: {
158
+ * CaseSensitive: true || false, // required
159
+ * },
160
+ * AccountRecoverySetting: {
161
+ * RecoveryMechanisms: [
162
+ * {
163
+ * Priority: Number("int"), // required
164
+ * Name: "verified_email" || "verified_phone_number" || "admin_only", // required
165
+ * },
166
+ * ],
167
+ * },
168
+ * };
48
169
  * const command = new CreateUserPoolCommand(input);
49
170
  * const response = await client.send(command);
50
171
  * ```
@@ -26,6 +26,13 @@ export interface CreateUserPoolDomainCommandOutput extends CreateUserPoolDomainR
26
26
  * import { CognitoIdentityProviderClient, CreateUserPoolDomainCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
27
27
  * // const { CognitoIdentityProviderClient, CreateUserPoolDomainCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
28
28
  * const client = new CognitoIdentityProviderClient(config);
29
+ * const input = {
30
+ * Domain: "STRING_VALUE", // required
31
+ * UserPoolId: "STRING_VALUE", // required
32
+ * CustomDomainConfig: {
33
+ * CertificateArn: "STRING_VALUE", // required
34
+ * },
35
+ * };
29
36
  * const command = new CreateUserPoolDomainCommand(input);
30
37
  * const response = await client.send(command);
31
38
  * ```
@@ -27,6 +27,10 @@ export interface DeleteGroupCommandOutput extends __MetadataBearer {
27
27
  * import { CognitoIdentityProviderClient, DeleteGroupCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
28
28
  * // const { CognitoIdentityProviderClient, DeleteGroupCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
29
29
  * const client = new CognitoIdentityProviderClient(config);
30
+ * const input = {
31
+ * GroupName: "STRING_VALUE", // required
32
+ * UserPoolId: "STRING_VALUE", // required
33
+ * };
30
34
  * const command = new DeleteGroupCommand(input);
31
35
  * const response = await client.send(command);
32
36
  * ```
@@ -26,6 +26,10 @@ export interface DeleteIdentityProviderCommandOutput extends __MetadataBearer {
26
26
  * import { CognitoIdentityProviderClient, DeleteIdentityProviderCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
27
27
  * // const { CognitoIdentityProviderClient, DeleteIdentityProviderCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
28
28
  * const client = new CognitoIdentityProviderClient(config);
29
+ * const input = {
30
+ * UserPoolId: "STRING_VALUE", // required
31
+ * ProviderName: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new DeleteIdentityProviderCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,10 @@ export interface DeleteResourceServerCommandOutput extends __MetadataBearer {
26
26
  * import { CognitoIdentityProviderClient, DeleteResourceServerCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
27
27
  * // const { CognitoIdentityProviderClient, DeleteResourceServerCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
28
28
  * const client = new CognitoIdentityProviderClient(config);
29
+ * const input = {
30
+ * UserPoolId: "STRING_VALUE", // required
31
+ * Identifier: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new DeleteResourceServerCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,12 @@ export interface DeleteUserAttributesCommandOutput extends DeleteUserAttributesR
26
26
  * import { CognitoIdentityProviderClient, DeleteUserAttributesCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
27
27
  * // const { CognitoIdentityProviderClient, DeleteUserAttributesCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
28
28
  * const client = new CognitoIdentityProviderClient(config);
29
+ * const input = {
30
+ * UserAttributeNames: [ // required
31
+ * "STRING_VALUE",
32
+ * ],
33
+ * AccessToken: "STRING_VALUE", // required
34
+ * };
29
35
  * const command = new DeleteUserAttributesCommand(input);
30
36
  * const response = await client.send(command);
31
37
  * ```
@@ -26,6 +26,9 @@ export interface DeleteUserCommandOutput extends __MetadataBearer {
26
26
  * import { CognitoIdentityProviderClient, DeleteUserCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
27
27
  * // const { CognitoIdentityProviderClient, DeleteUserCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
28
28
  * const client = new CognitoIdentityProviderClient(config);
29
+ * const input = {
30
+ * AccessToken: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new DeleteUserCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -26,6 +26,10 @@ export interface DeleteUserPoolClientCommandOutput extends __MetadataBearer {
26
26
  * import { CognitoIdentityProviderClient, DeleteUserPoolClientCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
27
27
  * // const { CognitoIdentityProviderClient, DeleteUserPoolClientCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
28
28
  * const client = new CognitoIdentityProviderClient(config);
29
+ * const input = {
30
+ * UserPoolId: "STRING_VALUE", // required
31
+ * ClientId: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new DeleteUserPoolClientCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,9 @@ export interface DeleteUserPoolCommandOutput extends __MetadataBearer {
26
26
  * import { CognitoIdentityProviderClient, DeleteUserPoolCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
27
27
  * // const { CognitoIdentityProviderClient, DeleteUserPoolCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
28
28
  * const client = new CognitoIdentityProviderClient(config);
29
+ * const input = {
30
+ * UserPoolId: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new DeleteUserPoolCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -26,6 +26,10 @@ export interface DeleteUserPoolDomainCommandOutput extends DeleteUserPoolDomainR
26
26
  * import { CognitoIdentityProviderClient, DeleteUserPoolDomainCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
27
27
  * // const { CognitoIdentityProviderClient, DeleteUserPoolDomainCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
28
28
  * const client = new CognitoIdentityProviderClient(config);
29
+ * const input = {
30
+ * Domain: "STRING_VALUE", // required
31
+ * UserPoolId: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new DeleteUserPoolDomainCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,10 @@ export interface DescribeIdentityProviderCommandOutput extends DescribeIdentityP
26
26
  * import { CognitoIdentityProviderClient, DescribeIdentityProviderCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
27
27
  * // const { CognitoIdentityProviderClient, DescribeIdentityProviderCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
28
28
  * const client = new CognitoIdentityProviderClient(config);
29
+ * const input = {
30
+ * UserPoolId: "STRING_VALUE", // required
31
+ * ProviderName: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new DescribeIdentityProviderCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,10 @@ export interface DescribeResourceServerCommandOutput extends DescribeResourceSer
26
26
  * import { CognitoIdentityProviderClient, DescribeResourceServerCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
27
27
  * // const { CognitoIdentityProviderClient, DescribeResourceServerCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
28
28
  * const client = new CognitoIdentityProviderClient(config);
29
+ * const input = {
30
+ * UserPoolId: "STRING_VALUE", // required
31
+ * Identifier: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new DescribeResourceServerCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,10 @@ export interface DescribeRiskConfigurationCommandOutput extends DescribeRiskConf
26
26
  * import { CognitoIdentityProviderClient, DescribeRiskConfigurationCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
27
27
  * // const { CognitoIdentityProviderClient, DescribeRiskConfigurationCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
28
28
  * const client = new CognitoIdentityProviderClient(config);
29
+ * const input = {
30
+ * UserPoolId: "STRING_VALUE", // required
31
+ * ClientId: "STRING_VALUE",
32
+ * };
29
33
  * const command = new DescribeRiskConfigurationCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,10 @@ export interface DescribeUserImportJobCommandOutput extends DescribeUserImportJo
26
26
  * import { CognitoIdentityProviderClient, DescribeUserImportJobCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
27
27
  * // const { CognitoIdentityProviderClient, DescribeUserImportJobCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
28
28
  * const client = new CognitoIdentityProviderClient(config);
29
+ * const input = {
30
+ * UserPoolId: "STRING_VALUE", // required
31
+ * JobId: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new DescribeUserImportJobCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -27,6 +27,10 @@ export interface DescribeUserPoolClientCommandOutput extends DescribeUserPoolCli
27
27
  * import { CognitoIdentityProviderClient, DescribeUserPoolClientCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
28
28
  * // const { CognitoIdentityProviderClient, DescribeUserPoolClientCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
29
29
  * const client = new CognitoIdentityProviderClient(config);
30
+ * const input = {
31
+ * UserPoolId: "STRING_VALUE", // required
32
+ * ClientId: "STRING_VALUE", // required
33
+ * };
30
34
  * const command = new DescribeUserPoolClientCommand(input);
31
35
  * const response = await client.send(command);
32
36
  * ```
@@ -26,6 +26,9 @@ export interface DescribeUserPoolCommandOutput extends DescribeUserPoolResponse,
26
26
  * import { CognitoIdentityProviderClient, DescribeUserPoolCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
27
27
  * // const { CognitoIdentityProviderClient, DescribeUserPoolCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
28
28
  * const client = new CognitoIdentityProviderClient(config);
29
+ * const input = {
30
+ * UserPoolId: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new DescribeUserPoolCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -26,6 +26,9 @@ export interface DescribeUserPoolDomainCommandOutput extends DescribeUserPoolDom
26
26
  * import { CognitoIdentityProviderClient, DescribeUserPoolDomainCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
27
27
  * // const { CognitoIdentityProviderClient, DescribeUserPoolDomainCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
28
28
  * const client = new CognitoIdentityProviderClient(config);
29
+ * const input = {
30
+ * Domain: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new DescribeUserPoolDomainCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -26,6 +26,10 @@ export interface ForgetDeviceCommandOutput extends __MetadataBearer {
26
26
  * import { CognitoIdentityProviderClient, ForgetDeviceCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
27
27
  * // const { CognitoIdentityProviderClient, ForgetDeviceCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
28
28
  * const client = new CognitoIdentityProviderClient(config);
29
+ * const input = {
30
+ * AccessToken: "STRING_VALUE",
31
+ * DeviceKey: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new ForgetDeviceCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -51,6 +51,21 @@ export interface ForgotPasswordCommandOutput extends ForgotPasswordResponse, __M
51
51
  * import { CognitoIdentityProviderClient, ForgotPasswordCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
52
52
  * // const { CognitoIdentityProviderClient, ForgotPasswordCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
53
53
  * const client = new CognitoIdentityProviderClient(config);
54
+ * const input = {
55
+ * ClientId: "STRING_VALUE", // required
56
+ * SecretHash: "STRING_VALUE",
57
+ * UserContextData: {
58
+ * IpAddress: "STRING_VALUE",
59
+ * EncodedData: "STRING_VALUE",
60
+ * },
61
+ * Username: "STRING_VALUE", // required
62
+ * AnalyticsMetadata: {
63
+ * AnalyticsEndpointId: "STRING_VALUE",
64
+ * },
65
+ * ClientMetadata: {
66
+ * "<keys>": "STRING_VALUE",
67
+ * },
68
+ * };
54
69
  * const command = new ForgotPasswordCommand(input);
55
70
  * const response = await client.send(command);
56
71
  * ```
@@ -27,6 +27,9 @@ export interface GetCSVHeaderCommandOutput extends GetCSVHeaderResponse, __Metad
27
27
  * import { CognitoIdentityProviderClient, GetCSVHeaderCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
28
28
  * // const { CognitoIdentityProviderClient, GetCSVHeaderCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
29
29
  * const client = new CognitoIdentityProviderClient(config);
30
+ * const input = {
31
+ * UserPoolId: "STRING_VALUE", // required
32
+ * };
30
33
  * const command = new GetCSVHeaderCommand(input);
31
34
  * const response = await client.send(command);
32
35
  * ```
@@ -26,6 +26,10 @@ export interface GetDeviceCommandOutput extends GetDeviceResponse, __MetadataBea
26
26
  * import { CognitoIdentityProviderClient, GetDeviceCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
27
27
  * // const { CognitoIdentityProviderClient, GetDeviceCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
28
28
  * const client = new CognitoIdentityProviderClient(config);
29
+ * const input = {
30
+ * DeviceKey: "STRING_VALUE", // required
31
+ * AccessToken: "STRING_VALUE",
32
+ * };
29
33
  * const command = new GetDeviceCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -27,6 +27,10 @@ export interface GetGroupCommandOutput extends GetGroupResponse, __MetadataBeare
27
27
  * import { CognitoIdentityProviderClient, GetGroupCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
28
28
  * // const { CognitoIdentityProviderClient, GetGroupCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
29
29
  * const client = new CognitoIdentityProviderClient(config);
30
+ * const input = {
31
+ * GroupName: "STRING_VALUE", // required
32
+ * UserPoolId: "STRING_VALUE", // required
33
+ * };
30
34
  * const command = new GetGroupCommand(input);
31
35
  * const response = await client.send(command);
32
36
  * ```
@@ -26,6 +26,10 @@ export interface GetIdentityProviderByIdentifierCommandOutput extends GetIdentit
26
26
  * import { CognitoIdentityProviderClient, GetIdentityProviderByIdentifierCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
27
27
  * // const { CognitoIdentityProviderClient, GetIdentityProviderByIdentifierCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
28
28
  * const client = new CognitoIdentityProviderClient(config);
29
+ * const input = {
30
+ * UserPoolId: "STRING_VALUE", // required
31
+ * IdpIdentifier: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new GetIdentityProviderByIdentifierCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -28,6 +28,9 @@ export interface GetSigningCertificateCommandOutput extends GetSigningCertificat
28
28
  * import { CognitoIdentityProviderClient, GetSigningCertificateCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
29
29
  * // const { CognitoIdentityProviderClient, GetSigningCertificateCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
30
30
  * const client = new CognitoIdentityProviderClient(config);
31
+ * const input = {
32
+ * UserPoolId: "STRING_VALUE", // required
33
+ * };
31
34
  * const command = new GetSigningCertificateCommand(input);
32
35
  * const response = await client.send(command);
33
36
  * ```
@@ -30,6 +30,10 @@ export interface GetUICustomizationCommandOutput extends GetUICustomizationRespo
30
30
  * import { CognitoIdentityProviderClient, GetUICustomizationCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
31
31
  * // const { CognitoIdentityProviderClient, GetUICustomizationCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
32
32
  * const client = new CognitoIdentityProviderClient(config);
33
+ * const input = {
34
+ * UserPoolId: "STRING_VALUE", // required
35
+ * ClientId: "STRING_VALUE",
36
+ * };
33
37
  * const command = new GetUICustomizationCommand(input);
34
38
  * const response = await client.send(command);
35
39
  * ```
@@ -46,6 +46,13 @@ export interface GetUserAttributeVerificationCodeCommandOutput extends GetUserAt
46
46
  * import { CognitoIdentityProviderClient, GetUserAttributeVerificationCodeCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
47
47
  * // const { CognitoIdentityProviderClient, GetUserAttributeVerificationCodeCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
48
48
  * const client = new CognitoIdentityProviderClient(config);
49
+ * const input = {
50
+ * AccessToken: "STRING_VALUE", // required
51
+ * AttributeName: "STRING_VALUE", // required
52
+ * ClientMetadata: {
53
+ * "<keys>": "STRING_VALUE",
54
+ * },
55
+ * };
49
56
  * const command = new GetUserAttributeVerificationCodeCommand(input);
50
57
  * const response = await client.send(command);
51
58
  * ```
@@ -26,6 +26,9 @@ export interface GetUserCommandOutput extends GetUserResponse, __MetadataBearer
26
26
  * import { CognitoIdentityProviderClient, GetUserCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
27
27
  * // const { CognitoIdentityProviderClient, GetUserCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
28
28
  * const client = new CognitoIdentityProviderClient(config);
29
+ * const input = {
30
+ * AccessToken: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new GetUserCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -26,6 +26,9 @@ export interface GetUserPoolMfaConfigCommandOutput extends GetUserPoolMfaConfigR
26
26
  * import { CognitoIdentityProviderClient, GetUserPoolMfaConfigCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
27
27
  * // const { CognitoIdentityProviderClient, GetUserPoolMfaConfigCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
28
28
  * const client = new CognitoIdentityProviderClient(config);
29
+ * const input = {
30
+ * UserPoolId: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new GetUserPoolMfaConfigCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -28,6 +28,9 @@ export interface GlobalSignOutCommandOutput extends GlobalSignOutResponse, __Met
28
28
  * import { CognitoIdentityProviderClient, GlobalSignOutCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
29
29
  * // const { CognitoIdentityProviderClient, GlobalSignOutCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
30
30
  * const client = new CognitoIdentityProviderClient(config);
31
+ * const input = {
32
+ * AccessToken: "STRING_VALUE", // required
33
+ * };
31
34
  * const command = new GlobalSignOutCommand(input);
32
35
  * const response = await client.send(command);
33
36
  * ```
@@ -45,6 +45,23 @@ export interface InitiateAuthCommandOutput extends InitiateAuthResponse, __Metad
45
45
  * import { CognitoIdentityProviderClient, InitiateAuthCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
46
46
  * // const { CognitoIdentityProviderClient, InitiateAuthCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
47
47
  * const client = new CognitoIdentityProviderClient(config);
48
+ * const input = {
49
+ * AuthFlow: "USER_SRP_AUTH" || "REFRESH_TOKEN_AUTH" || "REFRESH_TOKEN" || "CUSTOM_AUTH" || "ADMIN_NO_SRP_AUTH" || "USER_PASSWORD_AUTH" || "ADMIN_USER_PASSWORD_AUTH", // required
50
+ * AuthParameters: {
51
+ * "<keys>": "STRING_VALUE",
52
+ * },
53
+ * ClientMetadata: {
54
+ * "<keys>": "STRING_VALUE",
55
+ * },
56
+ * ClientId: "STRING_VALUE", // required
57
+ * AnalyticsMetadata: {
58
+ * AnalyticsEndpointId: "STRING_VALUE",
59
+ * },
60
+ * UserContextData: {
61
+ * IpAddress: "STRING_VALUE",
62
+ * EncodedData: "STRING_VALUE",
63
+ * },
64
+ * };
48
65
  * const command = new InitiateAuthCommand(input);
49
66
  * const response = await client.send(command);
50
67
  * ```
@@ -26,6 +26,11 @@ export interface ListDevicesCommandOutput extends ListDevicesResponse, __Metadat
26
26
  * import { CognitoIdentityProviderClient, ListDevicesCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
27
27
  * // const { CognitoIdentityProviderClient, ListDevicesCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
28
28
  * const client = new CognitoIdentityProviderClient(config);
29
+ * const input = {
30
+ * AccessToken: "STRING_VALUE", // required
31
+ * Limit: Number("int"),
32
+ * PaginationToken: "STRING_VALUE",
33
+ * };
29
34
  * const command = new ListDevicesCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -27,6 +27,11 @@ export interface ListGroupsCommandOutput extends ListGroupsResponse, __MetadataB
27
27
  * import { CognitoIdentityProviderClient, ListGroupsCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
28
28
  * // const { CognitoIdentityProviderClient, ListGroupsCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
29
29
  * const client = new CognitoIdentityProviderClient(config);
30
+ * const input = {
31
+ * UserPoolId: "STRING_VALUE", // required
32
+ * Limit: Number("int"),
33
+ * NextToken: "STRING_VALUE",
34
+ * };
30
35
  * const command = new ListGroupsCommand(input);
31
36
  * const response = await client.send(command);
32
37
  * ```
@@ -26,6 +26,11 @@ export interface ListIdentityProvidersCommandOutput extends ListIdentityProvider
26
26
  * import { CognitoIdentityProviderClient, ListIdentityProvidersCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
27
27
  * // const { CognitoIdentityProviderClient, ListIdentityProvidersCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
28
28
  * const client = new CognitoIdentityProviderClient(config);
29
+ * const input = {
30
+ * UserPoolId: "STRING_VALUE", // required
31
+ * MaxResults: Number("int"),
32
+ * NextToken: "STRING_VALUE",
33
+ * };
29
34
  * const command = new ListIdentityProvidersCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -26,6 +26,11 @@ export interface ListResourceServersCommandOutput extends ListResourceServersRes
26
26
  * import { CognitoIdentityProviderClient, ListResourceServersCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
27
27
  * // const { CognitoIdentityProviderClient, ListResourceServersCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
28
28
  * const client = new CognitoIdentityProviderClient(config);
29
+ * const input = {
30
+ * UserPoolId: "STRING_VALUE", // required
31
+ * MaxResults: Number("int"),
32
+ * NextToken: "STRING_VALUE",
33
+ * };
29
34
  * const command = new ListResourceServersCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -29,6 +29,9 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
29
29
  * import { CognitoIdentityProviderClient, ListTagsForResourceCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import
30
30
  * // const { CognitoIdentityProviderClient, ListTagsForResourceCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import
31
31
  * const client = new CognitoIdentityProviderClient(config);
32
+ * const input = {
33
+ * ResourceArn: "STRING_VALUE", // required
34
+ * };
32
35
  * const command = new ListTagsForResourceCommand(input);
33
36
  * const response = await client.send(command);
34
37
  * ```